httplib.h 798 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845128461284712848128491285012851128521285312854128551285612857128581285912860128611286212863128641286512866128671286812869128701287112872128731287412875128761287712878128791288012881128821288312884128851288612887128881288912890128911289212893128941289512896128971289812899129001290112902129031290412905129061290712908129091291012911129121291312914129151291612917129181291912920129211292212923129241292512926129271292812929129301293112932129331293412935129361293712938129391294012941129421294312944129451294612947129481294912950129511295212953129541295512956129571295812959129601296112962129631296412965129661296712968129691297012971129721297312974129751297612977129781297912980129811298212983129841298512986129871298812989129901299112992129931299412995129961299712998129991300013001130021300313004130051300613007130081300913010130111301213013130141301513016130171301813019130201302113022130231302413025130261302713028130291303013031130321303313034130351303613037130381303913040130411304213043130441304513046130471304813049130501305113052130531305413055130561305713058130591306013061130621306313064130651306613067130681306913070130711307213073130741307513076130771307813079130801308113082130831308413085130861308713088130891309013091130921309313094130951309613097130981309913100131011310213103131041310513106131071310813109131101311113112131131311413115131161311713118131191312013121131221312313124131251312613127131281312913130131311313213133131341313513136131371313813139131401314113142131431314413145131461314713148131491315013151131521315313154131551315613157131581315913160131611316213163131641316513166131671316813169131701317113172131731317413175131761317713178131791318013181131821318313184131851318613187131881318913190131911319213193131941319513196131971319813199132001320113202132031320413205132061320713208132091321013211132121321313214132151321613217132181321913220132211322213223132241322513226132271322813229132301323113232132331323413235132361323713238132391324013241132421324313244132451324613247132481324913250132511325213253132541325513256132571325813259132601326113262132631326413265132661326713268132691327013271132721327313274132751327613277132781327913280132811328213283132841328513286132871328813289132901329113292132931329413295132961329713298132991330013301133021330313304133051330613307133081330913310133111331213313133141331513316133171331813319133201332113322133231332413325133261332713328133291333013331133321333313334133351333613337133381333913340133411334213343133441334513346133471334813349133501335113352133531335413355133561335713358133591336013361133621336313364133651336613367133681336913370133711337213373133741337513376133771337813379133801338113382133831338413385133861338713388133891339013391133921339313394133951339613397133981339913400134011340213403134041340513406134071340813409134101341113412134131341413415134161341713418134191342013421134221342313424134251342613427134281342913430134311343213433134341343513436134371343813439134401344113442134431344413445134461344713448134491345013451134521345313454134551345613457134581345913460134611346213463134641346513466134671346813469134701347113472134731347413475134761347713478134791348013481134821348313484134851348613487134881348913490134911349213493134941349513496134971349813499135001350113502135031350413505135061350713508135091351013511135121351313514135151351613517135181351913520135211352213523135241352513526135271352813529135301353113532135331353413535135361353713538135391354013541135421354313544135451354613547135481354913550135511355213553135541355513556135571355813559135601356113562135631356413565135661356713568135691357013571135721357313574135751357613577135781357913580135811358213583135841358513586135871358813589135901359113592135931359413595135961359713598135991360013601136021360313604136051360613607136081360913610136111361213613136141361513616136171361813619136201362113622136231362413625136261362713628136291363013631136321363313634136351363613637136381363913640136411364213643136441364513646136471364813649136501365113652136531365413655136561365713658136591366013661136621366313664136651366613667136681366913670136711367213673136741367513676136771367813679136801368113682136831368413685136861368713688136891369013691136921369313694136951369613697136981369913700137011370213703137041370513706137071370813709137101371113712137131371413715137161371713718137191372013721137221372313724137251372613727137281372913730137311373213733137341373513736137371373813739137401374113742137431374413745137461374713748137491375013751137521375313754137551375613757137581375913760137611376213763137641376513766137671376813769137701377113772137731377413775137761377713778137791378013781137821378313784137851378613787137881378913790137911379213793137941379513796137971379813799138001380113802138031380413805138061380713808138091381013811138121381313814138151381613817138181381913820138211382213823138241382513826138271382813829138301383113832138331383413835138361383713838138391384013841138421384313844138451384613847138481384913850138511385213853138541385513856138571385813859138601386113862138631386413865138661386713868138691387013871138721387313874138751387613877138781387913880138811388213883138841388513886138871388813889138901389113892138931389413895138961389713898138991390013901139021390313904139051390613907139081390913910139111391213913139141391513916139171391813919139201392113922139231392413925139261392713928139291393013931139321393313934139351393613937139381393913940139411394213943139441394513946139471394813949139501395113952139531395413955139561395713958139591396013961139621396313964139651396613967139681396913970139711397213973139741397513976139771397813979139801398113982139831398413985139861398713988139891399013991139921399313994139951399613997139981399914000140011400214003140041400514006140071400814009140101401114012140131401414015140161401714018140191402014021140221402314024140251402614027140281402914030140311403214033140341403514036140371403814039140401404114042140431404414045140461404714048140491405014051140521405314054140551405614057140581405914060140611406214063140641406514066140671406814069140701407114072140731407414075140761407714078140791408014081140821408314084140851408614087140881408914090140911409214093140941409514096140971409814099141001410114102141031410414105141061410714108141091411014111141121411314114141151411614117141181411914120141211412214123141241412514126141271412814129141301413114132141331413414135141361413714138141391414014141141421414314144141451414614147141481414914150141511415214153141541415514156141571415814159141601416114162141631416414165141661416714168141691417014171141721417314174141751417614177141781417914180141811418214183141841418514186141871418814189141901419114192141931419414195141961419714198141991420014201142021420314204142051420614207142081420914210142111421214213142141421514216142171421814219142201422114222142231422414225142261422714228142291423014231142321423314234142351423614237142381423914240142411424214243142441424514246142471424814249142501425114252142531425414255142561425714258142591426014261142621426314264142651426614267142681426914270142711427214273142741427514276142771427814279142801428114282142831428414285142861428714288142891429014291142921429314294142951429614297142981429914300143011430214303143041430514306143071430814309143101431114312143131431414315143161431714318143191432014321143221432314324143251432614327143281432914330143311433214333143341433514336143371433814339143401434114342143431434414345143461434714348143491435014351143521435314354143551435614357143581435914360143611436214363143641436514366143671436814369143701437114372143731437414375143761437714378143791438014381143821438314384143851438614387143881438914390143911439214393143941439514396143971439814399144001440114402144031440414405144061440714408144091441014411144121441314414144151441614417144181441914420144211442214423144241442514426144271442814429144301443114432144331443414435144361443714438144391444014441144421444314444144451444614447144481444914450144511445214453144541445514456144571445814459144601446114462144631446414465144661446714468144691447014471144721447314474144751447614477144781447914480144811448214483144841448514486144871448814489144901449114492144931449414495144961449714498144991450014501145021450314504145051450614507145081450914510145111451214513145141451514516145171451814519145201452114522145231452414525145261452714528145291453014531145321453314534145351453614537145381453914540145411454214543145441454514546145471454814549145501455114552145531455414555145561455714558145591456014561145621456314564145651456614567145681456914570145711457214573145741457514576145771457814579145801458114582145831458414585145861458714588145891459014591145921459314594145951459614597145981459914600146011460214603146041460514606146071460814609146101461114612146131461414615146161461714618146191462014621146221462314624146251462614627146281462914630146311463214633146341463514636146371463814639146401464114642146431464414645146461464714648146491465014651146521465314654146551465614657146581465914660146611466214663146641466514666146671466814669146701467114672146731467414675146761467714678146791468014681146821468314684146851468614687146881468914690146911469214693146941469514696146971469814699147001470114702147031470414705147061470714708147091471014711147121471314714147151471614717147181471914720147211472214723147241472514726147271472814729147301473114732147331473414735147361473714738147391474014741147421474314744147451474614747147481474914750147511475214753147541475514756147571475814759147601476114762147631476414765147661476714768147691477014771147721477314774147751477614777147781477914780147811478214783147841478514786147871478814789147901479114792147931479414795147961479714798147991480014801148021480314804148051480614807148081480914810148111481214813148141481514816148171481814819148201482114822148231482414825148261482714828148291483014831148321483314834148351483614837148381483914840148411484214843148441484514846148471484814849148501485114852148531485414855148561485714858148591486014861148621486314864148651486614867148681486914870148711487214873148741487514876148771487814879148801488114882148831488414885148861488714888148891489014891148921489314894148951489614897148981489914900149011490214903149041490514906149071490814909149101491114912149131491414915149161491714918149191492014921149221492314924149251492614927149281492914930149311493214933149341493514936149371493814939149401494114942149431494414945149461494714948149491495014951149521495314954149551495614957149581495914960149611496214963149641496514966149671496814969149701497114972149731497414975149761497714978149791498014981149821498314984149851498614987149881498914990149911499214993149941499514996149971499814999150001500115002150031500415005150061500715008150091501015011150121501315014150151501615017150181501915020150211502215023150241502515026150271502815029150301503115032150331503415035150361503715038150391504015041150421504315044150451504615047150481504915050150511505215053150541505515056150571505815059150601506115062150631506415065150661506715068150691507015071150721507315074150751507615077150781507915080150811508215083150841508515086150871508815089150901509115092150931509415095150961509715098150991510015101151021510315104151051510615107151081510915110151111511215113151141511515116151171511815119151201512115122151231512415125151261512715128151291513015131151321513315134151351513615137151381513915140151411514215143151441514515146151471514815149151501515115152151531515415155151561515715158151591516015161151621516315164151651516615167151681516915170151711517215173151741517515176151771517815179151801518115182151831518415185151861518715188151891519015191151921519315194151951519615197151981519915200152011520215203152041520515206152071520815209152101521115212152131521415215152161521715218152191522015221152221522315224152251522615227152281522915230152311523215233152341523515236152371523815239152401524115242152431524415245152461524715248152491525015251152521525315254152551525615257152581525915260152611526215263152641526515266152671526815269152701527115272152731527415275152761527715278152791528015281152821528315284152851528615287152881528915290152911529215293152941529515296152971529815299153001530115302153031530415305153061530715308153091531015311153121531315314153151531615317153181531915320153211532215323153241532515326153271532815329153301533115332153331533415335153361533715338153391534015341153421534315344153451534615347153481534915350153511535215353153541535515356153571535815359153601536115362153631536415365153661536715368153691537015371153721537315374153751537615377153781537915380153811538215383153841538515386153871538815389153901539115392153931539415395153961539715398153991540015401154021540315404154051540615407154081540915410154111541215413154141541515416154171541815419154201542115422154231542415425154261542715428154291543015431154321543315434154351543615437154381543915440154411544215443154441544515446154471544815449154501545115452154531545415455154561545715458154591546015461154621546315464154651546615467154681546915470154711547215473154741547515476154771547815479154801548115482154831548415485154861548715488154891549015491154921549315494154951549615497154981549915500155011550215503155041550515506155071550815509155101551115512155131551415515155161551715518155191552015521155221552315524155251552615527155281552915530155311553215533155341553515536155371553815539155401554115542155431554415545155461554715548155491555015551155521555315554155551555615557155581555915560155611556215563155641556515566155671556815569155701557115572155731557415575155761557715578155791558015581155821558315584155851558615587155881558915590155911559215593155941559515596155971559815599156001560115602156031560415605156061560715608156091561015611156121561315614156151561615617156181561915620156211562215623156241562515626156271562815629156301563115632156331563415635156361563715638156391564015641156421564315644156451564615647156481564915650156511565215653156541565515656156571565815659156601566115662156631566415665156661566715668156691567015671156721567315674156751567615677156781567915680156811568215683156841568515686156871568815689156901569115692156931569415695156961569715698156991570015701157021570315704157051570615707157081570915710157111571215713157141571515716157171571815719157201572115722157231572415725157261572715728157291573015731157321573315734157351573615737157381573915740157411574215743157441574515746157471574815749157501575115752157531575415755157561575715758157591576015761157621576315764157651576615767157681576915770157711577215773157741577515776157771577815779157801578115782157831578415785157861578715788157891579015791157921579315794157951579615797157981579915800158011580215803158041580515806158071580815809158101581115812158131581415815158161581715818158191582015821158221582315824158251582615827158281582915830158311583215833158341583515836158371583815839158401584115842158431584415845158461584715848158491585015851158521585315854158551585615857158581585915860158611586215863158641586515866158671586815869158701587115872158731587415875158761587715878158791588015881158821588315884158851588615887158881588915890158911589215893158941589515896158971589815899159001590115902159031590415905159061590715908159091591015911159121591315914159151591615917159181591915920159211592215923159241592515926159271592815929159301593115932159331593415935159361593715938159391594015941159421594315944159451594615947159481594915950159511595215953159541595515956159571595815959159601596115962159631596415965159661596715968159691597015971159721597315974159751597615977159781597915980159811598215983159841598515986159871598815989159901599115992159931599415995159961599715998159991600016001160021600316004160051600616007160081600916010160111601216013160141601516016160171601816019160201602116022160231602416025160261602716028160291603016031160321603316034160351603616037160381603916040160411604216043160441604516046160471604816049160501605116052160531605416055160561605716058160591606016061160621606316064160651606616067160681606916070160711607216073160741607516076160771607816079160801608116082160831608416085160861608716088160891609016091160921609316094160951609616097160981609916100161011610216103161041610516106161071610816109161101611116112161131611416115161161611716118161191612016121161221612316124161251612616127161281612916130161311613216133161341613516136161371613816139161401614116142161431614416145161461614716148161491615016151161521615316154161551615616157161581615916160161611616216163161641616516166161671616816169161701617116172161731617416175161761617716178161791618016181161821618316184161851618616187161881618916190161911619216193161941619516196161971619816199162001620116202162031620416205162061620716208162091621016211162121621316214162151621616217162181621916220162211622216223162241622516226162271622816229162301623116232162331623416235162361623716238162391624016241162421624316244162451624616247162481624916250162511625216253162541625516256162571625816259162601626116262162631626416265162661626716268162691627016271162721627316274162751627616277162781627916280162811628216283162841628516286162871628816289162901629116292162931629416295162961629716298162991630016301163021630316304163051630616307163081630916310163111631216313163141631516316163171631816319163201632116322163231632416325163261632716328163291633016331163321633316334163351633616337163381633916340163411634216343163441634516346163471634816349163501635116352163531635416355163561635716358163591636016361163621636316364163651636616367163681636916370163711637216373163741637516376163771637816379163801638116382163831638416385163861638716388163891639016391163921639316394163951639616397163981639916400164011640216403164041640516406164071640816409164101641116412164131641416415164161641716418164191642016421164221642316424164251642616427164281642916430164311643216433164341643516436164371643816439164401644116442164431644416445164461644716448164491645016451164521645316454164551645616457164581645916460164611646216463164641646516466164671646816469164701647116472164731647416475164761647716478164791648016481164821648316484164851648616487164881648916490164911649216493164941649516496164971649816499165001650116502165031650416505165061650716508165091651016511165121651316514165151651616517165181651916520165211652216523165241652516526165271652816529165301653116532165331653416535165361653716538165391654016541165421654316544165451654616547165481654916550165511655216553165541655516556165571655816559165601656116562165631656416565165661656716568165691657016571165721657316574165751657616577165781657916580165811658216583165841658516586165871658816589165901659116592165931659416595165961659716598165991660016601166021660316604166051660616607166081660916610166111661216613166141661516616166171661816619166201662116622166231662416625166261662716628166291663016631166321663316634166351663616637166381663916640166411664216643166441664516646166471664816649166501665116652166531665416655166561665716658166591666016661166621666316664166651666616667166681666916670166711667216673166741667516676166771667816679166801668116682166831668416685166861668716688166891669016691166921669316694166951669616697166981669916700167011670216703167041670516706167071670816709167101671116712167131671416715167161671716718167191672016721167221672316724167251672616727167281672916730167311673216733167341673516736167371673816739167401674116742167431674416745167461674716748167491675016751167521675316754167551675616757167581675916760167611676216763167641676516766167671676816769167701677116772167731677416775167761677716778167791678016781167821678316784167851678616787167881678916790167911679216793167941679516796167971679816799168001680116802168031680416805168061680716808168091681016811168121681316814168151681616817168181681916820168211682216823168241682516826168271682816829168301683116832168331683416835168361683716838168391684016841168421684316844168451684616847168481684916850168511685216853168541685516856168571685816859168601686116862168631686416865168661686716868168691687016871168721687316874168751687616877168781687916880168811688216883168841688516886168871688816889168901689116892168931689416895168961689716898168991690016901169021690316904169051690616907169081690916910169111691216913169141691516916169171691816919169201692116922169231692416925169261692716928169291693016931169321693316934169351693616937169381693916940169411694216943169441694516946169471694816949169501695116952169531695416955169561695716958169591696016961169621696316964169651696616967169681696916970169711697216973169741697516976169771697816979169801698116982169831698416985169861698716988169891699016991169921699316994169951699616997169981699917000170011700217003170041700517006170071700817009170101701117012170131701417015170161701717018170191702017021170221702317024170251702617027170281702917030170311703217033170341703517036170371703817039170401704117042170431704417045170461704717048170491705017051170521705317054170551705617057170581705917060170611706217063170641706517066170671706817069170701707117072170731707417075170761707717078170791708017081170821708317084170851708617087170881708917090170911709217093170941709517096170971709817099171001710117102171031710417105171061710717108171091711017111171121711317114171151711617117171181711917120171211712217123171241712517126171271712817129171301713117132171331713417135171361713717138171391714017141171421714317144171451714617147171481714917150171511715217153171541715517156171571715817159171601716117162171631716417165171661716717168171691717017171171721717317174171751717617177171781717917180171811718217183171841718517186171871718817189171901719117192171931719417195171961719717198171991720017201172021720317204172051720617207172081720917210172111721217213172141721517216172171721817219172201722117222172231722417225172261722717228172291723017231172321723317234172351723617237172381723917240172411724217243172441724517246172471724817249172501725117252172531725417255172561725717258172591726017261172621726317264172651726617267172681726917270172711727217273172741727517276172771727817279172801728117282172831728417285172861728717288172891729017291172921729317294172951729617297172981729917300173011730217303173041730517306173071730817309173101731117312173131731417315173161731717318173191732017321173221732317324173251732617327173281732917330173311733217333173341733517336173371733817339173401734117342173431734417345173461734717348173491735017351173521735317354173551735617357173581735917360173611736217363173641736517366173671736817369173701737117372173731737417375173761737717378173791738017381173821738317384173851738617387173881738917390173911739217393173941739517396173971739817399174001740117402174031740417405174061740717408174091741017411174121741317414174151741617417174181741917420174211742217423174241742517426174271742817429174301743117432174331743417435174361743717438174391744017441174421744317444174451744617447174481744917450174511745217453174541745517456174571745817459174601746117462174631746417465174661746717468174691747017471174721747317474174751747617477174781747917480174811748217483174841748517486174871748817489174901749117492174931749417495174961749717498174991750017501175021750317504175051750617507175081750917510175111751217513175141751517516175171751817519175201752117522175231752417525175261752717528175291753017531175321753317534175351753617537175381753917540175411754217543175441754517546175471754817549175501755117552175531755417555175561755717558175591756017561175621756317564175651756617567175681756917570175711757217573175741757517576175771757817579175801758117582175831758417585175861758717588175891759017591175921759317594175951759617597175981759917600176011760217603176041760517606176071760817609176101761117612176131761417615176161761717618176191762017621176221762317624176251762617627176281762917630176311763217633176341763517636176371763817639176401764117642176431764417645176461764717648176491765017651176521765317654176551765617657176581765917660176611766217663176641766517666176671766817669176701767117672176731767417675176761767717678176791768017681176821768317684176851768617687176881768917690176911769217693176941769517696176971769817699177001770117702177031770417705177061770717708177091771017711177121771317714177151771617717177181771917720177211772217723177241772517726177271772817729177301773117732177331773417735177361773717738177391774017741177421774317744177451774617747177481774917750177511775217753177541775517756177571775817759177601776117762177631776417765177661776717768177691777017771177721777317774177751777617777177781777917780177811778217783177841778517786177871778817789177901779117792177931779417795177961779717798177991780017801178021780317804178051780617807178081780917810178111781217813178141781517816178171781817819178201782117822178231782417825178261782717828178291783017831178321783317834178351783617837178381783917840178411784217843178441784517846178471784817849178501785117852178531785417855178561785717858178591786017861178621786317864178651786617867178681786917870178711787217873178741787517876178771787817879178801788117882178831788417885178861788717888178891789017891178921789317894178951789617897178981789917900179011790217903179041790517906179071790817909179101791117912179131791417915179161791717918179191792017921179221792317924179251792617927179281792917930179311793217933179341793517936179371793817939179401794117942179431794417945179461794717948179491795017951179521795317954179551795617957179581795917960179611796217963179641796517966179671796817969179701797117972179731797417975179761797717978179791798017981179821798317984179851798617987179881798917990179911799217993179941799517996179971799817999180001800118002180031800418005180061800718008180091801018011180121801318014180151801618017180181801918020180211802218023180241802518026180271802818029180301803118032180331803418035180361803718038180391804018041180421804318044180451804618047180481804918050180511805218053180541805518056180571805818059180601806118062180631806418065180661806718068180691807018071180721807318074180751807618077180781807918080180811808218083180841808518086180871808818089180901809118092180931809418095180961809718098180991810018101181021810318104181051810618107181081810918110181111811218113181141811518116181171811818119181201812118122181231812418125181261812718128181291813018131181321813318134181351813618137181381813918140181411814218143181441814518146181471814818149181501815118152181531815418155181561815718158181591816018161181621816318164181651816618167181681816918170181711817218173181741817518176181771817818179181801818118182181831818418185181861818718188181891819018191181921819318194181951819618197181981819918200182011820218203182041820518206182071820818209182101821118212182131821418215182161821718218182191822018221182221822318224182251822618227182281822918230182311823218233182341823518236182371823818239182401824118242182431824418245182461824718248182491825018251182521825318254182551825618257182581825918260182611826218263182641826518266182671826818269182701827118272182731827418275182761827718278182791828018281182821828318284182851828618287182881828918290182911829218293182941829518296182971829818299183001830118302183031830418305183061830718308183091831018311183121831318314183151831618317183181831918320183211832218323183241832518326183271832818329183301833118332183331833418335183361833718338183391834018341183421834318344183451834618347183481834918350183511835218353183541835518356183571835818359183601836118362183631836418365183661836718368183691837018371183721837318374183751837618377183781837918380183811838218383183841838518386183871838818389183901839118392183931839418395183961839718398183991840018401184021840318404184051840618407184081840918410184111841218413184141841518416184171841818419184201842118422184231842418425184261842718428184291843018431184321843318434184351843618437184381843918440184411844218443184441844518446184471844818449184501845118452184531845418455184561845718458184591846018461184621846318464184651846618467184681846918470184711847218473184741847518476184771847818479184801848118482184831848418485184861848718488184891849018491184921849318494184951849618497184981849918500185011850218503185041850518506185071850818509185101851118512185131851418515185161851718518185191852018521185221852318524185251852618527185281852918530185311853218533185341853518536185371853818539185401854118542185431854418545185461854718548185491855018551185521855318554185551855618557185581855918560185611856218563185641856518566185671856818569185701857118572185731857418575185761857718578185791858018581185821858318584185851858618587185881858918590185911859218593185941859518596185971859818599186001860118602186031860418605186061860718608186091861018611186121861318614186151861618617186181861918620186211862218623186241862518626186271862818629186301863118632186331863418635186361863718638186391864018641186421864318644186451864618647186481864918650186511865218653186541865518656186571865818659186601866118662186631866418665186661866718668186691867018671186721867318674186751867618677186781867918680186811868218683186841868518686186871868818689186901869118692186931869418695186961869718698186991870018701187021870318704187051870618707187081870918710187111871218713187141871518716187171871818719187201872118722187231872418725187261872718728187291873018731187321873318734187351873618737187381873918740187411874218743187441874518746187471874818749187501875118752187531875418755187561875718758187591876018761187621876318764187651876618767187681876918770187711877218773187741877518776187771877818779187801878118782187831878418785187861878718788187891879018791187921879318794187951879618797187981879918800188011880218803188041880518806188071880818809188101881118812188131881418815188161881718818188191882018821188221882318824188251882618827188281882918830188311883218833188341883518836188371883818839188401884118842188431884418845188461884718848188491885018851188521885318854188551885618857188581885918860188611886218863188641886518866188671886818869188701887118872188731887418875188761887718878188791888018881188821888318884188851888618887188881888918890188911889218893188941889518896188971889818899189001890118902189031890418905189061890718908189091891018911189121891318914189151891618917189181891918920189211892218923189241892518926189271892818929189301893118932189331893418935189361893718938189391894018941189421894318944189451894618947189481894918950189511895218953189541895518956189571895818959189601896118962189631896418965189661896718968189691897018971189721897318974189751897618977189781897918980189811898218983189841898518986189871898818989189901899118992189931899418995189961899718998189991900019001190021900319004190051900619007190081900919010190111901219013190141901519016190171901819019190201902119022190231902419025190261902719028190291903019031190321903319034190351903619037190381903919040190411904219043190441904519046190471904819049190501905119052190531905419055190561905719058190591906019061190621906319064190651906619067190681906919070190711907219073190741907519076190771907819079190801908119082190831908419085190861908719088190891909019091190921909319094190951909619097190981909919100191011910219103191041910519106191071910819109191101911119112191131911419115191161911719118191191912019121191221912319124191251912619127191281912919130191311913219133191341913519136191371913819139191401914119142191431914419145191461914719148191491915019151191521915319154191551915619157191581915919160191611916219163191641916519166191671916819169191701917119172191731917419175191761917719178191791918019181191821918319184191851918619187191881918919190191911919219193191941919519196191971919819199192001920119202192031920419205192061920719208192091921019211192121921319214192151921619217192181921919220192211922219223192241922519226192271922819229192301923119232192331923419235192361923719238192391924019241192421924319244192451924619247192481924919250192511925219253192541925519256192571925819259192601926119262192631926419265192661926719268192691927019271192721927319274192751927619277192781927919280192811928219283192841928519286192871928819289192901929119292192931929419295192961929719298192991930019301193021930319304193051930619307193081930919310193111931219313193141931519316193171931819319193201932119322193231932419325193261932719328193291933019331193321933319334193351933619337193381933919340193411934219343193441934519346193471934819349193501935119352193531935419355193561935719358193591936019361193621936319364193651936619367193681936919370193711937219373193741937519376193771937819379193801938119382193831938419385193861938719388193891939019391193921939319394193951939619397193981939919400194011940219403194041940519406194071940819409194101941119412194131941419415194161941719418194191942019421194221942319424194251942619427194281942919430194311943219433194341943519436194371943819439194401944119442194431944419445194461944719448194491945019451194521945319454194551945619457194581945919460194611946219463194641946519466194671946819469194701947119472194731947419475194761947719478194791948019481194821948319484194851948619487194881948919490194911949219493194941949519496194971949819499195001950119502195031950419505195061950719508195091951019511195121951319514195151951619517195181951919520195211952219523195241952519526195271952819529195301953119532195331953419535195361953719538195391954019541195421954319544195451954619547195481954919550195511955219553195541955519556195571955819559195601956119562195631956419565195661956719568195691957019571195721957319574195751957619577195781957919580195811958219583195841958519586195871958819589195901959119592195931959419595195961959719598195991960019601196021960319604196051960619607196081960919610196111961219613196141961519616196171961819619196201962119622196231962419625196261962719628196291963019631196321963319634196351963619637196381963919640196411964219643196441964519646196471964819649196501965119652196531965419655196561965719658196591966019661196621966319664196651966619667196681966919670196711967219673196741967519676196771967819679196801968119682196831968419685196861968719688196891969019691196921969319694196951969619697196981969919700197011970219703197041970519706197071970819709197101971119712197131971419715197161971719718197191972019721197221972319724197251972619727197281972919730197311973219733197341973519736197371973819739197401974119742197431974419745197461974719748197491975019751197521975319754197551975619757197581975919760197611976219763197641976519766197671976819769197701977119772197731977419775197761977719778197791978019781197821978319784197851978619787197881978919790197911979219793197941979519796197971979819799198001980119802198031980419805198061980719808198091981019811198121981319814198151981619817198181981919820198211982219823198241982519826198271982819829198301983119832198331983419835198361983719838198391984019841198421984319844198451984619847198481984919850198511985219853198541985519856198571985819859198601986119862198631986419865198661986719868198691987019871198721987319874198751987619877198781987919880198811988219883198841988519886198871988819889198901989119892198931989419895198961989719898198991990019901199021990319904199051990619907199081990919910199111991219913199141991519916199171991819919199201992119922199231992419925199261992719928199291993019931199321993319934199351993619937199381993919940199411994219943199441994519946199471994819949199501995119952199531995419955199561995719958199591996019961199621996319964199651996619967199681996919970199711997219973199741997519976199771997819979199801998119982199831998419985199861998719988199891999019991199921999319994199951999619997199981999920000200012000220003200042000520006200072000820009200102001120012200132001420015200162001720018200192002020021200222002320024200252002620027200282002920030200312003220033200342003520036200372003820039200402004120042200432004420045200462004720048200492005020051200522005320054200552005620057200582005920060200612006220063200642006520066200672006820069200702007120072200732007420075200762007720078200792008020081200822008320084200852008620087200882008920090200912009220093200942009520096200972009820099201002010120102201032010420105201062010720108201092011020111201122011320114201152011620117201182011920120201212012220123201242012520126201272012820129201302013120132201332013420135201362013720138201392014020141201422014320144201452014620147201482014920150201512015220153201542015520156201572015820159201602016120162201632016420165201662016720168201692017020171201722017320174201752017620177201782017920180201812018220183201842018520186201872018820189201902019120192201932019420195201962019720198201992020020201202022020320204202052020620207202082020920210202112021220213202142021520216202172021820219202202022120222202232022420225202262022720228202292023020231202322023320234202352023620237202382023920240202412024220243202442024520246202472024820249202502025120252202532025420255202562025720258202592026020261202622026320264202652026620267202682026920270202712027220273202742027520276202772027820279202802028120282202832028420285202862028720288202892029020291202922029320294202952029620297202982029920300203012030220303203042030520306203072030820309203102031120312203132031420315203162031720318203192032020321203222032320324203252032620327203282032920330203312033220333203342033520336203372033820339203402034120342203432034420345203462034720348203492035020351203522035320354203552035620357203582035920360203612036220363203642036520366203672036820369203702037120372203732037420375203762037720378203792038020381203822038320384203852038620387203882038920390203912039220393203942039520396203972039820399204002040120402204032040420405204062040720408204092041020411204122041320414204152041620417204182041920420204212042220423204242042520426204272042820429204302043120432204332043420435204362043720438204392044020441204422044320444204452044620447204482044920450204512045220453204542045520456204572045820459204602046120462204632046420465204662046720468204692047020471204722047320474204752047620477204782047920480204812048220483204842048520486204872048820489204902049120492204932049420495204962049720498204992050020501205022050320504205052050620507205082050920510205112051220513205142051520516205172051820519205202052120522205232052420525205262052720528205292053020531205322053320534205352053620537205382053920540205412054220543205442054520546205472054820549205502055120552205532055420555205562055720558205592056020561205622056320564205652056620567205682056920570205712057220573205742057520576205772057820579205802058120582205832058420585205862058720588205892059020591205922059320594205952059620597205982059920600206012060220603206042060520606206072060820609206102061120612206132061420615206162061720618206192062020621206222062320624206252062620627206282062920630206312063220633206342063520636206372063820639206402064120642206432064420645206462064720648206492065020651206522065320654206552065620657206582065920660206612066220663206642066520666206672066820669206702067120672206732067420675206762067720678206792068020681206822068320684206852068620687206882068920690206912069220693206942069520696206972069820699207002070120702207032070420705207062070720708207092071020711207122071320714207152071620717207182071920720207212072220723207242072520726207272072820729207302073120732207332073420735207362073720738207392074020741207422074320744207452074620747207482074920750207512075220753207542075520756207572075820759207602076120762207632076420765207662076720768207692077020771207722077320774207752077620777207782077920780207812078220783207842078520786207872078820789207902079120792207932079420795207962079720798207992080020801208022080320804208052080620807208082080920810208112081220813208142081520816208172081820819208202082120822208232082420825208262082720828208292083020831208322083320834208352083620837208382083920840208412084220843208442084520846208472084820849208502085120852208532085420855208562085720858208592086020861208622086320864208652086620867208682086920870208712087220873208742087520876208772087820879208802088120882208832088420885208862088720888208892089020891208922089320894208952089620897208982089920900209012090220903209042090520906209072090820909209102091120912209132091420915209162091720918209192092020921209222092320924209252092620927209282092920930209312093220933209342093520936209372093820939209402094120942209432094420945209462094720948209492095020951209522095320954209552095620957209582095920960209612096220963209642096520966209672096820969209702097120972209732097420975209762097720978209792098020981209822098320984209852098620987209882098920990209912099220993209942099520996209972099820999210002100121002210032100421005210062100721008210092101021011210122101321014210152101621017210182101921020210212102221023210242102521026210272102821029210302103121032210332103421035210362103721038210392104021041210422104321044210452104621047210482104921050210512105221053210542105521056210572105821059210602106121062210632106421065210662106721068210692107021071210722107321074210752107621077210782107921080210812108221083210842108521086210872108821089210902109121092210932109421095210962109721098210992110021101211022110321104211052110621107211082110921110211112111221113211142111521116211172111821119211202112121122211232112421125211262112721128211292113021131211322113321134211352113621137211382113921140211412114221143211442114521146211472114821149211502115121152211532115421155211562115721158211592116021161211622116321164211652116621167211682116921170211712117221173211742117521176211772117821179211802118121182211832118421185211862118721188211892119021191211922119321194211952119621197211982119921200212012120221203212042120521206212072120821209212102121121212212132121421215212162121721218212192122021221212222122321224212252122621227212282122921230212312123221233212342123521236212372123821239212402124121242212432124421245212462124721248212492125021251212522125321254212552125621257212582125921260212612126221263212642126521266212672126821269212702127121272212732127421275212762127721278212792128021281212822128321284212852128621287212882128921290212912129221293212942129521296212972129821299213002130121302213032130421305213062130721308213092131021311213122131321314213152131621317213182131921320213212132221323213242132521326213272132821329213302133121332213332133421335213362133721338213392134021341213422134321344213452134621347213482134921350213512135221353213542135521356213572135821359213602136121362213632136421365213662136721368213692137021371213722137321374213752137621377213782137921380213812138221383213842138521386213872138821389213902139121392213932139421395213962139721398213992140021401214022140321404214052140621407214082140921410214112141221413214142141521416214172141821419214202142121422214232142421425214262142721428214292143021431214322143321434214352143621437214382143921440214412144221443214442144521446214472144821449214502145121452214532145421455214562145721458214592146021461214622146321464214652146621467214682146921470214712147221473214742147521476214772147821479214802148121482214832148421485214862148721488214892149021491214922149321494214952149621497214982149921500215012150221503215042150521506215072150821509215102151121512215132151421515215162151721518215192152021521215222152321524215252152621527215282152921530215312153221533215342153521536215372153821539215402154121542215432154421545215462154721548215492155021551215522155321554215552155621557215582155921560215612156221563215642156521566215672156821569215702157121572215732157421575215762157721578215792158021581215822158321584215852158621587215882158921590215912159221593215942159521596215972159821599216002160121602216032160421605216062160721608216092161021611216122161321614216152161621617216182161921620216212162221623216242162521626216272162821629216302163121632216332163421635216362163721638216392164021641216422164321644216452164621647216482164921650216512165221653216542165521656216572165821659216602166121662216632166421665216662166721668216692167021671216722167321674216752167621677216782167921680216812168221683216842168521686216872168821689216902169121692216932169421695216962169721698216992170021701217022170321704217052170621707217082170921710217112171221713217142171521716217172171821719217202172121722217232172421725217262172721728217292173021731217322173321734217352173621737217382173921740217412174221743217442174521746217472174821749217502175121752217532175421755217562175721758217592176021761217622176321764217652176621767217682176921770217712177221773217742177521776217772177821779217802178121782217832178421785217862178721788217892179021791217922179321794217952179621797217982179921800218012180221803218042180521806218072180821809218102181121812218132181421815218162181721818218192182021821218222182321824218252182621827218282182921830218312183221833218342183521836218372183821839218402184121842218432184421845218462184721848218492185021851218522185321854218552185621857218582185921860218612186221863218642186521866218672186821869218702187121872218732187421875218762187721878218792188021881218822188321884218852188621887218882188921890218912189221893218942189521896218972189821899219002190121902219032190421905219062190721908219092191021911219122191321914219152191621917219182191921920219212192221923219242192521926219272192821929219302193121932219332193421935219362193721938219392194021941219422194321944219452194621947219482194921950219512195221953219542195521956219572195821959219602196121962219632196421965219662196721968219692197021971219722197321974219752197621977219782197921980219812198221983219842198521986219872198821989219902199121992219932199421995219962199721998219992200022001220022200322004220052200622007220082200922010220112201222013220142201522016220172201822019220202202122022220232202422025220262202722028220292203022031220322203322034220352203622037220382203922040220412204222043220442204522046220472204822049220502205122052220532205422055220562205722058220592206022061220622206322064220652206622067220682206922070220712207222073220742207522076220772207822079220802208122082220832208422085220862208722088220892209022091220922209322094220952209622097220982209922100221012210222103221042210522106221072210822109221102211122112221132211422115221162211722118221192212022121221222212322124221252212622127221282212922130221312213222133221342213522136221372213822139221402214122142221432214422145221462214722148221492215022151221522215322154221552215622157221582215922160221612216222163221642216522166221672216822169221702217122172221732217422175221762217722178221792218022181221822218322184221852218622187221882218922190221912219222193221942219522196221972219822199222002220122202222032220422205222062220722208222092221022211222122221322214222152221622217222182221922220222212222222223222242222522226222272222822229222302223122232222332223422235222362223722238222392224022241222422224322244222452224622247222482224922250222512225222253222542225522256222572225822259222602226122262222632226422265222662226722268222692227022271222722227322274222752227622277222782227922280222812228222283222842228522286222872228822289222902229122292222932229422295222962229722298222992230022301223022230322304223052230622307223082230922310223112231222313223142231522316223172231822319223202232122322223232232422325223262232722328223292233022331223322233322334223352233622337223382233922340223412234222343223442234522346223472234822349223502235122352223532235422355223562235722358223592236022361223622236322364223652236622367223682236922370223712237222373223742237522376223772237822379223802238122382223832238422385223862238722388223892239022391223922239322394223952239622397223982239922400224012240222403224042240522406224072240822409224102241122412224132241422415224162241722418224192242022421224222242322424224252242622427224282242922430224312243222433224342243522436224372243822439224402244122442224432244422445224462244722448224492245022451224522245322454224552245622457224582245922460224612246222463224642246522466224672246822469224702247122472224732247422475224762247722478224792248022481224822248322484224852248622487224882248922490224912249222493224942249522496224972249822499225002250122502225032250422505225062250722508225092251022511225122251322514225152251622517225182251922520225212252222523225242252522526225272252822529225302253122532225332253422535225362253722538225392254022541225422254322544225452254622547225482254922550225512255222553225542255522556225572255822559225602256122562225632256422565225662256722568225692257022571225722257322574225752257622577225782257922580225812258222583225842258522586225872258822589225902259122592225932259422595225962259722598225992260022601226022260322604226052260622607226082260922610226112261222613226142261522616226172261822619226202262122622226232262422625226262262722628226292263022631226322263322634226352263622637226382263922640226412264222643226442264522646226472264822649226502265122652226532265422655226562265722658226592266022661226622266322664226652266622667226682266922670226712267222673226742267522676226772267822679226802268122682226832268422685226862268722688226892269022691226922269322694226952269622697226982269922700227012270222703227042270522706227072270822709227102271122712227132271422715227162271722718227192272022721227222272322724227252272622727227282272922730227312273222733227342273522736227372273822739227402274122742227432274422745227462274722748227492275022751227522275322754227552275622757227582275922760227612276222763227642276522766227672276822769227702277122772227732277422775227762277722778227792278022781227822278322784227852278622787227882278922790227912279222793227942279522796227972279822799228002280122802228032280422805228062280722808228092281022811228122281322814228152281622817228182281922820228212282222823228242282522826228272282822829228302283122832228332283422835228362283722838228392284022841228422284322844228452284622847228482284922850228512285222853228542285522856228572285822859228602286122862228632286422865228662286722868228692287022871228722287322874228752287622877228782287922880228812288222883228842288522886228872288822889228902289122892228932289422895228962289722898228992290022901229022290322904229052290622907229082290922910229112291222913229142291522916229172291822919229202292122922229232292422925229262292722928229292293022931229322293322934229352293622937229382293922940229412294222943229442294522946229472294822949229502295122952229532295422955229562295722958229592296022961229622296322964229652296622967229682296922970229712297222973229742297522976229772297822979229802298122982229832298422985229862298722988229892299022991229922299322994229952299622997229982299923000230012300223003230042300523006230072300823009230102301123012230132301423015230162301723018230192302023021230222302323024230252302623027230282302923030230312303223033230342303523036230372303823039230402304123042230432304423045230462304723048230492305023051230522305323054230552305623057230582305923060230612306223063230642306523066230672306823069230702307123072230732307423075230762307723078230792308023081230822308323084230852308623087230882308923090230912309223093230942309523096230972309823099231002310123102231032310423105231062310723108231092311023111231122311323114231152311623117231182311923120231212312223123231242312523126231272312823129231302313123132231332313423135231362313723138231392314023141231422314323144231452314623147231482314923150231512315223153231542315523156231572315823159231602316123162231632316423165231662316723168231692317023171231722317323174231752317623177231782317923180231812318223183231842318523186231872318823189231902319123192231932319423195231962319723198231992320023201232022320323204232052320623207232082320923210232112321223213232142321523216232172321823219232202322123222232232322423225232262322723228232292323023231232322323323234232352323623237232382323923240232412324223243232442324523246232472324823249232502325123252232532325423255232562325723258232592326023261232622326323264232652326623267232682326923270232712327223273232742327523276232772327823279232802328123282232832328423285232862328723288232892329023291232922329323294232952329623297232982329923300233012330223303233042330523306233072330823309233102331123312233132331423315233162331723318233192332023321233222332323324233252332623327233282332923330233312333223333233342333523336233372333823339233402334123342233432334423345233462334723348233492335023351233522335323354233552335623357233582335923360233612336223363233642336523366
  1. //
  2. // httplib.h
  3. //
  4. // Copyright (c) 2026 Yuji Hirose. All rights reserved.
  5. // MIT License
  6. //
  7. #ifndef CPPHTTPLIB_HTTPLIB_H
  8. #define CPPHTTPLIB_HTTPLIB_H
  9. #define CPPHTTPLIB_VERSION "0.61.0"
  10. #define CPPHTTPLIB_VERSION_NUM "0x003d00"
  11. #ifdef _WIN32
  12. #if defined(_WIN32_WINNT) && _WIN32_WINNT < 0x0A00
  13. #error \
  14. "cpp-httplib doesn't support Windows 8 or lower. Please use Windows 10 or later."
  15. #endif
  16. #endif
  17. #if defined(__SANITIZE_THREAD__)
  18. #define CPPHTTPLIB_THREAD_SANITIZER
  19. #elif defined(__has_feature)
  20. #if __has_feature(thread_sanitizer)
  21. #define CPPHTTPLIB_THREAD_SANITIZER
  22. #endif
  23. #endif
  24. /*
  25. * Configuration
  26. */
  27. #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND
  28. #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND 5
  29. #endif
  30. #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND
  31. #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND 10000
  32. #endif
  33. #ifndef CPPHTTPLIB_KEEPALIVE_MAX_COUNT
  34. #define CPPHTTPLIB_KEEPALIVE_MAX_COUNT 100
  35. #endif
  36. #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND
  37. #define CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND 300
  38. #endif
  39. #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND
  40. #define CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND 0
  41. #endif
  42. #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND
  43. #define CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND 5
  44. #endif
  45. #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND
  46. #define CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND 0
  47. #endif
  48. #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND
  49. #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND 5
  50. #endif
  51. #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND
  52. #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND 0
  53. #endif
  54. #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND
  55. #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND 300
  56. #endif
  57. #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND
  58. #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND 0
  59. #endif
  60. #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND
  61. #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND 5
  62. #endif
  63. #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND
  64. #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND 0
  65. #endif
  66. #ifndef CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND
  67. #define CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND 0
  68. #endif
  69. #ifndef CPPHTTPLIB_EXPECT_100_THRESHOLD
  70. #define CPPHTTPLIB_EXPECT_100_THRESHOLD 1024
  71. #endif
  72. #ifndef CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND
  73. #define CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND 1000
  74. #endif
  75. #ifndef CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD
  76. #define CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD (1024 * 1024)
  77. #endif
  78. #ifndef CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND
  79. #define CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND 50
  80. #endif
  81. #ifndef CPPHTTPLIB_IDLE_INTERVAL_SECOND
  82. #define CPPHTTPLIB_IDLE_INTERVAL_SECOND 0
  83. #endif
  84. #ifndef CPPHTTPLIB_IDLE_INTERVAL_USECOND
  85. #ifdef _WIN32
  86. #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 1000
  87. #else
  88. #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 0
  89. #endif
  90. #endif
  91. #ifndef CPPHTTPLIB_REQUEST_URI_MAX_LENGTH
  92. #define CPPHTTPLIB_REQUEST_URI_MAX_LENGTH 8192
  93. #endif
  94. #ifndef CPPHTTPLIB_HEADER_MAX_LENGTH
  95. #define CPPHTTPLIB_HEADER_MAX_LENGTH 8192
  96. #endif
  97. #ifndef CPPHTTPLIB_HEADER_MAX_COUNT
  98. #define CPPHTTPLIB_HEADER_MAX_COUNT 100
  99. #endif
  100. #ifndef CPPHTTPLIB_REDIRECT_MAX_COUNT
  101. #define CPPHTTPLIB_REDIRECT_MAX_COUNT 20
  102. #endif
  103. #ifndef CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT
  104. #define CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT 1024
  105. #endif
  106. #ifndef CPPHTTPLIB_PAYLOAD_MAX_LENGTH
  107. #define CPPHTTPLIB_PAYLOAD_MAX_LENGTH (100 * 1024 * 1024) // 100MB
  108. #endif
  109. #ifndef CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH
  110. #define CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH 8192
  111. #endif
  112. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH
  113. // 1400 rather than a round number: a body that already fits in one 1500-byte
  114. // MTU gains nothing from being made smaller.
  115. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH 1400
  116. #endif
  117. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH
  118. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH (4 * 1024 * 1024) // 4MB
  119. #endif
  120. #ifndef CPPHTTPLIB_RANGE_MAX_COUNT
  121. #define CPPHTTPLIB_RANGE_MAX_COUNT 1024
  122. #endif
  123. // std::regex_match's backtracking implementation (most acutely on libstdc++)
  124. // recurses roughly once per matched character for quantified patterns such
  125. // as "(.*)", so a long enough path can exhaust the calling thread's stack; on
  126. // a default ~8MB thread stack that has been observed to take on the order of
  127. // a couple thousand characters for a simple pattern. 256 leaves a wide safety
  128. // margin below that (well under the 8192-byte request URI limit) while still
  129. // fitting any realistic route segment; raise it if a route legitimately needs
  130. // longer paths. Regex routes are never applied to paths longer than this.
  131. #ifndef CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH
  132. #define CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH 256
  133. #endif
  134. #ifndef CPPHTTPLIB_TCP_NODELAY
  135. #define CPPHTTPLIB_TCP_NODELAY false
  136. #endif
  137. #ifndef CPPHTTPLIB_IPV6_V6ONLY
  138. #define CPPHTTPLIB_IPV6_V6ONLY false
  139. #endif
  140. #ifndef CPPHTTPLIB_RECV_BUFSIZ
  141. #define CPPHTTPLIB_RECV_BUFSIZ size_t(16384u)
  142. #endif
  143. #ifndef CPPHTTPLIB_SEND_BUFSIZ
  144. #define CPPHTTPLIB_SEND_BUFSIZ size_t(16384u)
  145. #endif
  146. #ifndef CPPHTTPLIB_COMPRESSION_BUFSIZ
  147. #define CPPHTTPLIB_COMPRESSION_BUFSIZ size_t(16384u)
  148. #endif
  149. #ifndef CPPHTTPLIB_THREAD_POOL_COUNT
  150. #define CPPHTTPLIB_THREAD_POOL_COUNT \
  151. ((std::max)(8u, std::thread::hardware_concurrency() > 0 \
  152. ? std::thread::hardware_concurrency() - 1 \
  153. : 0))
  154. #endif
  155. #ifndef CPPHTTPLIB_THREAD_POOL_MAX_COUNT
  156. #define CPPHTTPLIB_THREAD_POOL_MAX_COUNT (CPPHTTPLIB_THREAD_POOL_COUNT * 4)
  157. #endif
  158. #ifndef CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT
  159. #define CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT 3 // seconds
  160. #endif
  161. #ifndef CPPHTTPLIB_RECV_FLAGS
  162. #define CPPHTTPLIB_RECV_FLAGS 0
  163. #endif
  164. #ifndef CPPHTTPLIB_SEND_FLAGS
  165. #define CPPHTTPLIB_SEND_FLAGS 0
  166. #endif
  167. #ifndef CPPHTTPLIB_LISTEN_BACKLOG
  168. #define CPPHTTPLIB_LISTEN_BACKLOG 128
  169. #endif
  170. #ifndef CPPHTTPLIB_MAX_LINE_LENGTH
  171. #define CPPHTTPLIB_MAX_LINE_LENGTH 32768
  172. #endif
  173. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH
  174. #define CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH 16777216
  175. #endif
  176. // One macro used to set the read timeout for both sides. They want different
  177. // defaults: a client's read timeout is the caller's own tool (it waits forever
  178. // until asked not to), while a server keeps a ceiling that reclaims a worker
  179. // from a peer that has gone quiet. The old name still works and sets both.
  180. #ifdef CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  181. #pragma message( \
  182. "CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND is deprecated; define " \
  183. "CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND and/or " \
  184. "CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND instead")
  185. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  186. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND \
  187. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  188. #endif
  189. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  190. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND \
  191. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  192. #endif
  193. #endif
  194. // 0 waits forever. A read timeout is how a caller gets control back to send on
  195. // the same connection; it is not a liveness check (that is ping/pong). Only a
  196. // timeout set at runtime through set_read_timeout() is reported as
  197. // ws::Timeout; when one of these compile-time defaults elapses, read() returns
  198. // ws::Fail and closes the connection.
  199. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  200. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND 0
  201. #endif
  202. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  203. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND 300
  204. #endif
  205. #ifndef CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND
  206. #define CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND 5
  207. #endif
  208. #ifndef CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND
  209. #define CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND 30
  210. #endif
  211. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS
  212. #define CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS 0
  213. #endif
  214. /*
  215. * Headers
  216. */
  217. #ifdef _WIN32
  218. #ifndef _CRT_SECURE_NO_WARNINGS
  219. #define _CRT_SECURE_NO_WARNINGS
  220. #endif //_CRT_SECURE_NO_WARNINGS
  221. #ifndef _CRT_NONSTDC_NO_DEPRECATE
  222. #define _CRT_NONSTDC_NO_DEPRECATE
  223. #endif //_CRT_NONSTDC_NO_DEPRECATE
  224. #if defined(_MSC_VER)
  225. #if _MSC_VER < 1900
  226. #error Sorry, Visual Studio versions prior to 2015 are not supported
  227. #endif
  228. #pragma comment(lib, "ws2_32.lib")
  229. #ifndef _SSIZE_T_DEFINED
  230. using ssize_t = __int64;
  231. #define _SSIZE_T_DEFINED
  232. #endif
  233. #endif // _MSC_VER
  234. #ifndef S_ISREG
  235. #define S_ISREG(m) (((m) & S_IFREG) == S_IFREG)
  236. #endif // S_ISREG
  237. #ifndef S_ISDIR
  238. #define S_ISDIR(m) (((m) & S_IFDIR) == S_IFDIR)
  239. #endif // S_ISDIR
  240. #ifndef NOMINMAX
  241. #define NOMINMAX
  242. #endif // NOMINMAX
  243. #include <io.h>
  244. #include <winsock2.h>
  245. #include <ws2tcpip.h>
  246. #if defined(__has_include)
  247. #if __has_include(<afunix.h>)
  248. // afunix.h uses types declared in winsock2.h, so has to be included after it.
  249. #include <afunix.h>
  250. #define CPPHTTPLIB_HAVE_AFUNIX_H 1
  251. #endif
  252. #endif
  253. #ifndef WSA_FLAG_NO_HANDLE_INHERIT
  254. #define WSA_FLAG_NO_HANDLE_INHERIT 0x80
  255. #endif
  256. using nfds_t = unsigned long;
  257. using socket_t = SOCKET;
  258. using socklen_t = int;
  259. #else // not _WIN32
  260. #include <arpa/inet.h>
  261. #if !defined(_AIX) && !defined(__MVS__)
  262. #include <ifaddrs.h>
  263. #endif
  264. #ifdef __MVS__
  265. #include <strings.h>
  266. #ifndef NI_MAXHOST
  267. #define NI_MAXHOST 1025
  268. #endif
  269. #endif
  270. #include <net/if.h>
  271. #include <netdb.h>
  272. #include <netinet/in.h>
  273. #ifdef __linux__
  274. #include <resolv.h>
  275. #undef _res // Undefine _res macro to avoid conflicts with user code (#2278)
  276. #endif
  277. #include <csignal>
  278. #include <netinet/tcp.h>
  279. #include <poll.h>
  280. #include <pthread.h>
  281. #include <sys/mman.h>
  282. #include <sys/socket.h>
  283. #include <sys/un.h>
  284. #include <unistd.h>
  285. using socket_t = int;
  286. #ifndef INVALID_SOCKET
  287. #define INVALID_SOCKET (-1)
  288. #endif
  289. #endif //_WIN32
  290. #if defined(__APPLE__)
  291. #include <TargetConditionals.h>
  292. #endif
  293. #include <algorithm>
  294. #include <array>
  295. #include <atomic>
  296. #include <cassert>
  297. #include <chrono>
  298. #include <climits>
  299. #include <condition_variable>
  300. #include <cstdlib>
  301. #include <cstring>
  302. #include <errno.h>
  303. #include <exception>
  304. #include <fcntl.h>
  305. #include <fstream>
  306. #include <functional>
  307. #include <iomanip>
  308. #include <iostream>
  309. #include <iterator>
  310. #include <list>
  311. #include <map>
  312. #include <memory>
  313. #include <mutex>
  314. #include <random>
  315. #include <regex>
  316. #include <set>
  317. #include <sstream>
  318. #include <string>
  319. #include <sys/stat.h>
  320. #include <system_error>
  321. #include <thread>
  322. #include <type_traits>
  323. #include <unordered_map>
  324. #include <unordered_set>
  325. #include <utility>
  326. #include <vector>
  327. // On macOS with a TLS backend, enable Keychain root certificates by default
  328. // unless the user explicitly opts out. Not enabled on iOS/tvOS/watchOS since
  329. // the SecTrustSettings APIs used to enumerate anchor certificates are macOS
  330. // only; on those platforms the user must provide a CA bundle explicitly.
  331. #if defined(__APPLE__) && defined(__clang__) && \
  332. !defined(CPPHTTPLIB_DISABLE_MACOSX_AUTOMATIC_ROOT_CERTIFICATES) && \
  333. (defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  334. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || \
  335. defined(CPPHTTPLIB_WOLFSSL_SUPPORT))
  336. #if TARGET_OS_OSX
  337. #ifndef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  338. #define CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  339. #endif
  340. #endif
  341. #endif
  342. #if defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN) && \
  343. defined(__APPLE__) && !TARGET_OS_OSX
  344. #error \
  345. "CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN is only supported on macOS. On iOS/tvOS/watchOS, supply a CA bundle via set_ca_cert_path()."
  346. #endif
  347. // On Windows, enable Schannel certificate verification by default
  348. // unless the user explicitly opts out.
  349. #if defined(_WIN32) && \
  350. !defined(CPPHTTPLIB_DISABLE_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE)
  351. #define CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  352. #endif
  353. #if defined(CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO) || \
  354. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  355. #if TARGET_OS_MAC && defined(__clang__)
  356. #include <CFNetwork/CFHost.h>
  357. #include <CoreFoundation/CoreFoundation.h>
  358. #endif
  359. #endif
  360. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  361. #ifdef _WIN32
  362. #include <wincrypt.h>
  363. // these are defined in wincrypt.h and it breaks compilation if BoringSSL is
  364. // used
  365. #undef X509_NAME
  366. #undef X509_CERT_PAIR
  367. #undef X509_EXTENSIONS
  368. #undef PKCS7_SIGNER_INFO
  369. #ifdef _MSC_VER
  370. #pragma comment(lib, "crypt32.lib")
  371. #endif
  372. #endif // _WIN32
  373. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  374. #if TARGET_OS_OSX
  375. #include <Security/Security.h>
  376. #endif
  377. #endif
  378. #include <openssl/err.h>
  379. #include <openssl/evp.h>
  380. #include <openssl/ssl.h>
  381. #include <openssl/x509v3.h>
  382. #if defined(_WIN32) && defined(OPENSSL_USE_APPLINK)
  383. #include <openssl/applink.c>
  384. #endif
  385. #include <iostream>
  386. #include <sstream>
  387. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  388. #if OPENSSL_VERSION_NUMBER < 0x1010107f
  389. #error Please use OpenSSL or a current version of BoringSSL
  390. #endif
  391. #define SSL_get1_peer_certificate SSL_get_peer_certificate
  392. #elif OPENSSL_VERSION_NUMBER < 0x30000000L
  393. #error Sorry, OpenSSL versions prior to 3.0.0 are not supported
  394. #endif
  395. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  396. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  397. // version.h defines MBEDTLS_VERSION_MAJOR (on 2.x/3.x/4.x alike); it is pulled
  398. // in with this first include group so the version gating below can use it.
  399. #include <mbedtls/error.h>
  400. #include <mbedtls/net_sockets.h>
  401. #include <mbedtls/oid.h>
  402. #include <mbedtls/pk.h>
  403. #include <mbedtls/ssl.h>
  404. #include <mbedtls/version.h>
  405. #include <mbedtls/x509_crt.h>
  406. #if MBEDTLS_VERSION_MAJOR >= 4
  407. // Mbed TLS 4.x moved hashing/RNG to PSA Crypto and removed these headers.
  408. #include <psa/crypto.h>
  409. #else
  410. #include <mbedtls/ctr_drbg.h>
  411. #include <mbedtls/entropy.h>
  412. #include <mbedtls/md5.h>
  413. #include <mbedtls/sha1.h>
  414. #include <mbedtls/sha256.h>
  415. #include <mbedtls/sha512.h>
  416. #endif
  417. #ifdef _WIN32
  418. #include <wincrypt.h>
  419. #ifdef _MSC_VER
  420. #pragma comment(lib, "crypt32.lib")
  421. #endif
  422. #endif // _WIN32
  423. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  424. #if TARGET_OS_OSX
  425. #include <Security/Security.h>
  426. #endif
  427. #endif
  428. // Mbed TLS version API compatibility. Note: V4 implies V3 (both defined on
  429. // 4.x), so version-specific 3.x-only code must check V3 && !V4.
  430. #if MBEDTLS_VERSION_MAJOR >= 4
  431. #define CPPHTTPLIB_MBEDTLS_V4
  432. #endif
  433. #if MBEDTLS_VERSION_MAJOR >= 3
  434. #define CPPHTTPLIB_MBEDTLS_V3
  435. #endif
  436. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  437. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  438. #include <wolfssl/options.h>
  439. #include <wolfssl/openssl/x509v3.h>
  440. // Fallback definitions for older wolfSSL versions (e.g., 5.6.6)
  441. #ifndef WOLFSSL_GEN_EMAIL
  442. #define WOLFSSL_GEN_EMAIL 1
  443. #endif
  444. #ifndef WOLFSSL_GEN_DNS
  445. #define WOLFSSL_GEN_DNS 2
  446. #endif
  447. #ifndef WOLFSSL_GEN_URI
  448. #define WOLFSSL_GEN_URI 6
  449. #endif
  450. #ifndef WOLFSSL_GEN_IPADD
  451. #define WOLFSSL_GEN_IPADD 7
  452. #endif
  453. #include <wolfssl/ssl.h>
  454. #include <wolfssl/wolfcrypt/hash.h>
  455. #include <wolfssl/wolfcrypt/md5.h>
  456. #include <wolfssl/wolfcrypt/sha256.h>
  457. #include <wolfssl/wolfcrypt/sha512.h>
  458. #ifdef _WIN32
  459. #include <wincrypt.h>
  460. #ifdef _MSC_VER
  461. #pragma comment(lib, "crypt32.lib")
  462. #endif
  463. #endif // _WIN32
  464. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  465. #if TARGET_OS_OSX
  466. #include <Security/Security.h>
  467. #endif
  468. #endif
  469. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  470. // Define CPPHTTPLIB_SSL_ENABLED if any SSL backend is available
  471. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  472. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  473. #define CPPHTTPLIB_SSL_ENABLED
  474. #endif
  475. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  476. #include <zlib.h>
  477. #endif
  478. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  479. #include <brotli/decode.h>
  480. #include <brotli/encode.h>
  481. #endif
  482. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  483. #include <zstd.h>
  484. #endif
  485. /*
  486. * Declaration
  487. */
  488. namespace httplib {
  489. namespace ws {
  490. class WebSocket;
  491. } // namespace ws
  492. namespace detail {
  493. /*
  494. * Backport std::make_unique from C++14.
  495. *
  496. * NOTE: This code came up with the following stackoverflow post:
  497. * https://stackoverflow.com/questions/10149840/c-arrays-and-make-unique
  498. *
  499. */
  500. template <class T, class... Args>
  501. typename std::enable_if<!std::is_array<T>::value, std::unique_ptr<T>>::type
  502. make_unique(Args &&...args) {
  503. return std::unique_ptr<T>(new T(std::forward<Args>(args)...));
  504. }
  505. template <class T>
  506. typename std::enable_if<std::is_array<T>::value, std::unique_ptr<T>>::type
  507. make_unique(std::size_t n) {
  508. typedef typename std::remove_extent<T>::type RT;
  509. return std::unique_ptr<T>(new RT[n]);
  510. }
  511. // Locale-independent ASCII character classification. The <cctype>
  512. // counterparts (std::isalnum, std::isdigit, ...) consult the global C locale,
  513. // so e.g. std::isalnum(0xC5) can return true once an embedder calls
  514. // setlocale(). HTTP grammars are defined over ASCII, so raw bytes must be
  515. // classified without regard to the locale.
  516. inline bool is_ascii_digit(char c) { return '0' <= c && c <= '9'; }
  517. inline bool is_ascii_alpha(char c) {
  518. return ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z');
  519. }
  520. inline bool is_ascii_alnum(char c) {
  521. return is_ascii_digit(c) || is_ascii_alpha(c);
  522. }
  523. namespace case_ignore {
  524. inline unsigned char to_lower(int c) {
  525. const static unsigned char table[256] = {
  526. 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14,
  527. 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29,
  528. 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44,
  529. 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59,
  530. 60, 61, 62, 63, 64, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106,
  531. 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121,
  532. 122, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104,
  533. 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119,
  534. 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134,
  535. 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149,
  536. 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164,
  537. 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179,
  538. 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 224, 225, 226,
  539. 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239, 240, 241,
  540. 242, 243, 244, 245, 246, 215, 248, 249, 250, 251, 252, 253, 254, 223, 224,
  541. 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239,
  542. 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254,
  543. 255,
  544. };
  545. return table[(unsigned char)(char)c];
  546. }
  547. inline std::string to_lower(const std::string &s) {
  548. std::string result = s;
  549. std::transform(
  550. result.begin(), result.end(), result.begin(),
  551. [](unsigned char c) { return static_cast<char>(to_lower(c)); });
  552. return result;
  553. }
  554. inline bool equal(const std::string &a, const std::string &b) {
  555. return a.size() == b.size() &&
  556. std::equal(a.begin(), a.end(), b.begin(), [](char ca, char cb) {
  557. return to_lower(ca) == to_lower(cb);
  558. });
  559. }
  560. struct equal_to {
  561. bool operator()(const std::string &a, const std::string &b) const {
  562. return equal(a, b);
  563. }
  564. };
  565. struct hash {
  566. size_t operator()(const std::string &key) const {
  567. size_t h = 0;
  568. for (auto c : key) {
  569. // Unsets the 6 high bits of h, therefore no overflow happens
  570. h = (((std::numeric_limits<size_t>::max)() >> 6) & h * 33) ^
  571. static_cast<unsigned char>(to_lower(c));
  572. }
  573. return h;
  574. }
  575. };
  576. template <typename T>
  577. using unordered_set = std::unordered_set<T, detail::case_ignore::hash,
  578. detail::case_ignore::equal_to>;
  579. } // namespace case_ignore
  580. // This is based on
  581. // "http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2014/n4189".
  582. struct scope_exit {
  583. explicit scope_exit(std::function<void(void)> &&f)
  584. : exit_function(std::move(f)), execute_on_destruction{true} {}
  585. scope_exit(scope_exit &&rhs) noexcept
  586. : exit_function(std::move(rhs.exit_function)),
  587. execute_on_destruction{rhs.execute_on_destruction} {
  588. rhs.release();
  589. }
  590. ~scope_exit() {
  591. if (execute_on_destruction) { this->exit_function(); }
  592. }
  593. void release() { this->execute_on_destruction = false; }
  594. private:
  595. scope_exit(const scope_exit &) = delete;
  596. void operator=(const scope_exit &) = delete;
  597. scope_exit &operator=(scope_exit &&) = delete;
  598. std::function<void(void)> exit_function;
  599. bool execute_on_destruction;
  600. };
  601. // Simple from_chars implementation for integer and double types (C++17
  602. // substitute)
  603. template <typename T> struct from_chars_result {
  604. const char *ptr;
  605. std::errc ec;
  606. };
  607. template <typename T>
  608. inline from_chars_result<T> from_chars(const char *first, const char *last,
  609. T &value, int base = 10) {
  610. value = 0;
  611. const char *p = first;
  612. bool negative = false;
  613. if (p != last && *p == '-') {
  614. negative = true;
  615. ++p;
  616. }
  617. if (p == last) { return {first, std::errc::invalid_argument}; }
  618. T result = 0;
  619. for (; p != last; ++p) {
  620. char c = *p;
  621. int digit = -1;
  622. if (is_ascii_digit(c)) {
  623. digit = c - '0';
  624. } else if ('a' <= c && c <= 'z') {
  625. digit = c - 'a' + 10;
  626. } else if ('A' <= c && c <= 'Z') {
  627. digit = c - 'A' + 10;
  628. } else {
  629. break;
  630. }
  631. if (digit < 0 || digit >= base) { break; }
  632. if (result > ((std::numeric_limits<T>::max)() - digit) / base) {
  633. return {p, std::errc::result_out_of_range};
  634. }
  635. result = result * base + digit;
  636. }
  637. if (p == first || (negative && p == first + 1)) {
  638. return {first, std::errc::invalid_argument};
  639. }
  640. value = negative ? T(0) - result : result;
  641. return {p, std::errc{}};
  642. }
  643. // from_chars for double (hand-written, locale-independent)
  644. //
  645. // The only double consumed by this library is the HTTP quality value, whose
  646. // grammar is (RFC 9110 12.4.2):
  647. // qvalue = ( "0" [ "." 0*3DIGIT ] ) / ( "1" [ "." 0*3("0") ] )
  648. // i.e. a non-negative decimal with no sign, exponent, "inf"/"nan", or wide
  649. // magnitude. So this parser recognizes exactly 1*DIGIT [ "." *DIGIT ] with
  650. // '.' always the decimal separator (std::strtod would instead read it from the
  651. // global C locale, mis-parsing q-values once an embedder calls
  652. // setlocale(LC_ALL, "") into a comma-decimal locale). The caller range-checks
  653. // the result to [0, 1], so inputs outside that range need not be distinguished
  654. // here. Allocation-free, single pass, and free of the overflow/rounding edge
  655. // cases that exponent and wide-range handling would introduce.
  656. inline from_chars_result<double> from_chars(const char *first, const char *last,
  657. double &value) {
  658. value = 0.0;
  659. const char *p = first;
  660. // Each 1eN is exactly representable, so a single final division by the
  661. // matching entry yields a correctly-rounded result.
  662. static const double powers_of_ten[] = {
  663. 1e0, 1e1, 1e2, 1e3, 1e4, 1e5, 1e6, 1e7, 1e8, 1e9,
  664. 1e10, 1e11, 1e12, 1e13, 1e14, 1e15, 1e16, 1e17, 1e18};
  665. const int max_frac_digits =
  666. static_cast<int>(sizeof(powers_of_ten) / sizeof(powers_of_ten[0])) - 1;
  667. // Accumulate digits into a 64-bit integer and remember how many were
  668. // fractional. Two independent caps keep this bounded and safe:
  669. // * accumulation saturates before mantissa could overflow uint64_t, and
  670. // * frac_digits is capped at max_frac_digits so it is always a valid index
  671. // into powers_of_ten (without this an input like "0.000...0" would never
  672. // grow mantissa, so the saturation cap alone would not bound it).
  673. // Both caps only drop digits far beyond the precision a q-value needs; any
  674. // value they would change is well outside [0, 1] and rejected by the caller.
  675. uint64_t mantissa = 0;
  676. int frac_digits = 0;
  677. bool seen_digit = false;
  678. const uint64_t limit = ((std::numeric_limits<uint64_t>::max)() - 9) / 10;
  679. auto accumulate = [&](char c) {
  680. if (mantissa <= limit) {
  681. mantissa = mantissa * 10 + static_cast<uint64_t>(c - '0');
  682. return true;
  683. }
  684. return false;
  685. };
  686. for (; p != last && is_ascii_digit(*p); ++p) {
  687. seen_digit = true;
  688. accumulate(*p);
  689. }
  690. if (p != last && *p == '.') {
  691. ++p;
  692. for (; p != last && is_ascii_digit(*p); ++p) {
  693. seen_digit = true;
  694. if (frac_digits < max_frac_digits && accumulate(*p)) { ++frac_digits; }
  695. }
  696. }
  697. if (!seen_digit) { return {first, std::errc::invalid_argument}; }
  698. value = static_cast<double>(mantissa) / powers_of_ten[frac_digits];
  699. return {p, std::errc{}};
  700. }
  701. inline bool parse_int_in_range(const char *s, size_t len, int lo, int hi,
  702. int &out) {
  703. int val = 0;
  704. auto r = from_chars(s, s + len, val);
  705. if (r.ec != std::errc{} || r.ptr != s + len || val < lo || val > hi) {
  706. return false;
  707. }
  708. out = val;
  709. return true;
  710. }
  711. inline bool parse_port(const char *s, size_t len, int &port) {
  712. return parse_int_in_range(s, len, 1, 65535, port);
  713. }
  714. inline bool parse_port(const std::string &s, int &port) {
  715. return parse_port(s.data(), s.size(), port);
  716. }
  717. struct UrlComponents {
  718. std::string scheme;
  719. std::string host;
  720. std::string port;
  721. std::string path;
  722. std::string query;
  723. };
  724. inline bool parse_url(const std::string &url, UrlComponents &uc) {
  725. uc = {};
  726. size_t pos = 0;
  727. auto sep = url.find("://");
  728. if (sep != std::string::npos) {
  729. uc.scheme = url.substr(0, sep);
  730. // Scheme must be [a-z]+ only
  731. if (uc.scheme.empty()) { return false; }
  732. for (auto c : uc.scheme) {
  733. if (c < 'a' || c > 'z') { return false; }
  734. }
  735. pos = sep + 3;
  736. } else if (url.compare(0, 2, "//") == 0) {
  737. pos = 2;
  738. }
  739. auto has_authority_prefix = pos > 0;
  740. auto has_authority = has_authority_prefix || (!url.empty() && url[0] != '/' &&
  741. url[0] != '?' && url[0] != '#');
  742. if (has_authority) {
  743. if (pos < url.size() && url[pos] == '[') {
  744. auto close = url.find(']', pos);
  745. if (close == std::string::npos) { return false; }
  746. uc.host = url.substr(pos + 1, close - pos - 1);
  747. // IPv6 host must be [a-fA-F0-9:]+ only
  748. if (uc.host.empty()) { return false; }
  749. for (auto c : uc.host) {
  750. if (!(is_ascii_digit(c) || (c >= 'a' && c <= 'f') ||
  751. (c >= 'A' && c <= 'F') || c == ':')) {
  752. return false;
  753. }
  754. }
  755. pos = close + 1;
  756. // The IPv6 literal is the whole host, so ']' must be followed by a port,
  757. // path, query or fragment delimiter (or the end of input). Otherwise the
  758. // trailing bytes would be folded into the path while the connection
  759. // still targets the bracketed address.
  760. if (pos < url.size()) {
  761. auto c = url[pos];
  762. if (c != ':' && c != '/' && c != '?' && c != '#') { return false; }
  763. }
  764. } else {
  765. auto end = url.find_first_of(":/?#", pos);
  766. if (end == std::string::npos) { end = url.size(); }
  767. uc.host = url.substr(pos, end - pos);
  768. pos = end;
  769. }
  770. if (pos < url.size() && url[pos] == ':') {
  771. ++pos;
  772. auto end = url.find_first_of("/?#", pos);
  773. if (end == std::string::npos) { end = url.size(); }
  774. uc.port = url.substr(pos, end - pos);
  775. pos = end;
  776. }
  777. // Without :// or //, the entire input must be consumed as host[:port].
  778. // If there is leftover (path, query, etc.), this is not a valid
  779. // host[:port] string — clear and reparse as a plain path.
  780. if (!has_authority_prefix && pos < url.size()) {
  781. uc.host.clear();
  782. uc.port.clear();
  783. pos = 0;
  784. }
  785. }
  786. if (pos < url.size() && url[pos] != '?' && url[pos] != '#') {
  787. auto end = url.find_first_of("?#", pos);
  788. if (end == std::string::npos) { end = url.size(); }
  789. uc.path = url.substr(pos, end - pos);
  790. pos = end;
  791. }
  792. if (pos < url.size() && url[pos] == '?') {
  793. auto end = url.find('#', pos);
  794. if (end == std::string::npos) { end = url.size(); }
  795. uc.query = url.substr(pos, end - pos);
  796. }
  797. return true;
  798. }
  799. // Resolves a relative-path or query-only Location value against the path of
  800. // the request being redirected (RFC 3986 section 5.2). Absolute URIs and
  801. // references starting with '/' are returned unchanged.
  802. inline std::string resolve_relative_location(const std::string &location,
  803. const std::string &base) {
  804. if (location.empty() || location[0] == '/') { return location; }
  805. // A ':' in the first segment means the value has a scheme.
  806. if (location.find(':') < location.find_first_of("/?#")) { return location; }
  807. if (location[0] == '#') { return base.substr(0, base.find('#')) + location; }
  808. auto base_path = base.substr(0, base.find_first_of("?#"));
  809. if (location[0] == '?') { return base_path + location; }
  810. if (base_path.empty() || base_path[0] != '/') { base_path = "/"; }
  811. auto merged = base_path.substr(0, base_path.rfind('/') + 1) + location;
  812. // Remove "." and ".." segments from the merged path.
  813. auto path_end = (std::min)(merged.find_first_of("?#"), merged.size());
  814. std::string path;
  815. size_t i = 0;
  816. while (i < path_end) {
  817. auto next = (std::min)(merged.find('/', i + 1), path_end);
  818. auto segment = merged.substr(i + 1, next - i - 1);
  819. auto is_last = next == path_end;
  820. if (segment == "." || segment == "..") {
  821. if (segment == "..") {
  822. path.erase((std::min)(path.rfind('/'), path.size()));
  823. }
  824. if (is_last) { path += '/'; }
  825. } else {
  826. path += '/';
  827. path += segment;
  828. }
  829. i = next;
  830. }
  831. if (path.empty()) { path = "/"; }
  832. return path + merged.substr(path_end);
  833. }
  834. } // namespace detail
  835. enum class SSLVerifierResponse {
  836. // no decision has been made, use the built-in certificate verifier
  837. NoDecisionMade,
  838. // connection certificate is verified and accepted
  839. CertificateAccepted,
  840. // connection certificate was processed but is rejected
  841. CertificateRejected
  842. };
  843. // System CA loading policy for SSL clients. Auto (the default) loads system
  844. // CA certs only when no custom CA is configured; enable_system_ca() switches
  845. // to an explicit policy.
  846. enum class SystemCAMode { Auto, Enabled, Disabled };
  847. enum StatusCode {
  848. // Information responses
  849. Continue_100 = 100,
  850. SwitchingProtocol_101 = 101,
  851. Processing_102 = 102,
  852. EarlyHints_103 = 103,
  853. // Successful responses
  854. OK_200 = 200,
  855. Created_201 = 201,
  856. Accepted_202 = 202,
  857. NonAuthoritativeInformation_203 = 203,
  858. NoContent_204 = 204,
  859. ResetContent_205 = 205,
  860. PartialContent_206 = 206,
  861. MultiStatus_207 = 207,
  862. AlreadyReported_208 = 208,
  863. IMUsed_226 = 226,
  864. // Redirection messages
  865. MultipleChoices_300 = 300,
  866. MovedPermanently_301 = 301,
  867. Found_302 = 302,
  868. SeeOther_303 = 303,
  869. NotModified_304 = 304,
  870. UseProxy_305 = 305,
  871. unused_306 = 306,
  872. TemporaryRedirect_307 = 307,
  873. PermanentRedirect_308 = 308,
  874. // Client error responses
  875. BadRequest_400 = 400,
  876. Unauthorized_401 = 401,
  877. PaymentRequired_402 = 402,
  878. Forbidden_403 = 403,
  879. NotFound_404 = 404,
  880. MethodNotAllowed_405 = 405,
  881. NotAcceptable_406 = 406,
  882. ProxyAuthenticationRequired_407 = 407,
  883. RequestTimeout_408 = 408,
  884. Conflict_409 = 409,
  885. Gone_410 = 410,
  886. LengthRequired_411 = 411,
  887. PreconditionFailed_412 = 412,
  888. PayloadTooLarge_413 = 413,
  889. UriTooLong_414 = 414,
  890. UnsupportedMediaType_415 = 415,
  891. RangeNotSatisfiable_416 = 416,
  892. ExpectationFailed_417 = 417,
  893. ImATeapot_418 = 418,
  894. MisdirectedRequest_421 = 421,
  895. UnprocessableContent_422 = 422,
  896. Locked_423 = 423,
  897. FailedDependency_424 = 424,
  898. TooEarly_425 = 425,
  899. UpgradeRequired_426 = 426,
  900. PreconditionRequired_428 = 428,
  901. TooManyRequests_429 = 429,
  902. RequestHeaderFieldsTooLarge_431 = 431,
  903. UnavailableForLegalReasons_451 = 451,
  904. // Server error responses
  905. InternalServerError_500 = 500,
  906. NotImplemented_501 = 501,
  907. BadGateway_502 = 502,
  908. ServiceUnavailable_503 = 503,
  909. GatewayTimeout_504 = 504,
  910. HttpVersionNotSupported_505 = 505,
  911. VariantAlsoNegotiates_506 = 506,
  912. InsufficientStorage_507 = 507,
  913. LoopDetected_508 = 508,
  914. NotExtended_510 = 510,
  915. NetworkAuthenticationRequired_511 = 511,
  916. };
  917. namespace detail {
  918. // A multimap that keeps its entries in the order they were inserted.
  919. //
  920. // HTTP needs that order in two places. RFC 9110 5.3 makes the order of header
  921. // fields sharing a field name significant and forbids a proxy from reordering
  922. // them, and a query string's parameters are meaningful in the order the caller
  923. // wrote them. Neither standard container expresses it: std::unordered_multimap
  924. // gives no ordering guarantee at all for equivalent keys (libstdc++ yields
  925. // reverse insertion order, libc++ insertion order), and std::multimap sorts by
  926. // key, which would drop control data such as Host behind whatever else the
  927. // message carries and alphabetise a query string.
  928. //
  929. // Entries are therefore kept in a flat vector, in order. Lookup is a linear
  930. // scan, which beats hashing for the handful of entries a message carries
  931. // (headers are capped at CPPHTTPLIB_HEADER_MAX_COUNT).
  932. //
  933. // KeyEqual compares keys; it is what makes Headers case-insensitive and
  934. // Params, whose parameter names are case-sensitive, not.
  935. template <typename Mapped, typename KeyEqual> class insertion_ordered_multimap {
  936. public:
  937. using key_type = std::string;
  938. using mapped_type = Mapped;
  939. using value_type = std::pair<std::string, Mapped>;
  940. using size_type = std::size_t;
  941. using difference_type = std::ptrdiff_t;
  942. using reference = value_type &;
  943. using const_reference = const value_type &;
  944. private:
  945. static size_type npos() { return static_cast<size_type>(-1); }
  946. static bool keys_equal(const std::string &a, const std::string &b) {
  947. return KeyEqual()(a, b);
  948. }
  949. // Iterating yields every entry in insertion order, but equal_range() and
  950. // find() have to walk only the entries sharing one key, which are not
  951. // adjacent. Both are the same iterator type: key_idx_ selects between the
  952. // two traversals, and since equality compares only the position, an iterator
  953. // restricted to one key still compares equal to end().
  954. template <typename V> class iterator_t {
  955. public:
  956. using iterator_category = std::bidirectional_iterator_tag;
  957. using value_type = insertion_ordered_multimap::value_type;
  958. using difference_type = insertion_ordered_multimap::difference_type;
  959. using pointer = V *;
  960. using reference = V &;
  961. iterator_t() : data_(nullptr), idx_(0), size_(0), key_idx_(npos()) {}
  962. template <typename U,
  963. typename std::enable_if<std::is_convertible<U *, V *>::value,
  964. int>::type = 0>
  965. iterator_t(const iterator_t<U> &rhs)
  966. : data_(rhs.data_), idx_(rhs.idx_), size_(rhs.size_),
  967. key_idx_(rhs.key_idx_) {}
  968. reference operator*() const { return data_[idx_]; }
  969. pointer operator->() const { return data_ + idx_; }
  970. iterator_t &operator++() {
  971. // Saturating, so that advancing past the last entry of a key stays at
  972. // end() instead of running off the container.
  973. if (idx_ >= size_) { return *this; }
  974. ++idx_;
  975. if (key_idx_ != npos()) {
  976. while (idx_ < size_ && !matches(idx_)) {
  977. ++idx_;
  978. }
  979. }
  980. return *this;
  981. }
  982. iterator_t operator++(int) {
  983. auto tmp = *this;
  984. ++*this;
  985. return tmp;
  986. }
  987. iterator_t &operator--() {
  988. if (idx_ == 0) { return *this; }
  989. --idx_;
  990. if (key_idx_ != npos()) {
  991. while (idx_ > 0 && !matches(idx_)) {
  992. --idx_;
  993. }
  994. }
  995. return *this;
  996. }
  997. iterator_t operator--(int) {
  998. auto tmp = *this;
  999. --*this;
  1000. return tmp;
  1001. }
  1002. template <typename U> bool operator==(const iterator_t<U> &rhs) const {
  1003. return idx_ == rhs.idx_;
  1004. }
  1005. template <typename U> bool operator!=(const iterator_t<U> &rhs) const {
  1006. return idx_ != rhs.idx_;
  1007. }
  1008. private:
  1009. friend class insertion_ordered_multimap;
  1010. template <typename> friend class iterator_t;
  1011. iterator_t(V *data, size_type idx, size_type size, size_type key_idx)
  1012. : data_(data), idx_(idx), size_(size), key_idx_(key_idx) {}
  1013. bool matches(size_type i) const {
  1014. return keys_equal(data_[i].first, data_[key_idx_].first);
  1015. }
  1016. V *data_;
  1017. size_type idx_;
  1018. size_type size_;
  1019. size_type key_idx_;
  1020. };
  1021. public:
  1022. using iterator = iterator_t<value_type>;
  1023. using const_iterator = iterator_t<const value_type>;
  1024. insertion_ordered_multimap() = default;
  1025. insertion_ordered_multimap(std::initializer_list<value_type> il)
  1026. : entries_(il) {}
  1027. template <typename InputIt>
  1028. insertion_ordered_multimap(InputIt first, InputIt last)
  1029. : entries_(first, last) {}
  1030. iterator begin() { return make_iter(0, npos()); }
  1031. iterator end() { return make_iter(entries_.size(), npos()); }
  1032. const_iterator begin() const { return make_citer(0, npos()); }
  1033. const_iterator end() const { return make_citer(entries_.size(), npos()); }
  1034. const_iterator cbegin() const { return begin(); }
  1035. const_iterator cend() const { return end(); }
  1036. bool empty() const { return entries_.empty(); }
  1037. size_type size() const { return entries_.size(); }
  1038. void clear() { entries_.clear(); }
  1039. void swap(insertion_ordered_multimap &rhs) { entries_.swap(rhs.entries_); }
  1040. iterator insert(const value_type &val) {
  1041. entries_.push_back(val);
  1042. return make_iter(entries_.size() - 1, npos());
  1043. }
  1044. iterator insert(value_type &&val) {
  1045. entries_.push_back(std::move(val));
  1046. return make_iter(entries_.size() - 1, npos());
  1047. }
  1048. template <typename... Args> iterator emplace(Args &&...args) {
  1049. entries_.emplace_back(std::forward<Args>(args)...);
  1050. return make_iter(entries_.size() - 1, npos());
  1051. }
  1052. // For entries that have to lead the message, such as the Host header field
  1053. // (RFC 9110 5.3 recommends sending control data first).
  1054. template <typename... Args> iterator emplace_front(Args &&...args) {
  1055. entries_.emplace(entries_.begin(), std::forward<Args>(args)...);
  1056. return make_iter(0, npos());
  1057. }
  1058. iterator find(const std::string &key) {
  1059. auto i = index_of(key);
  1060. return i == npos() ? end() : make_iter(i, i);
  1061. }
  1062. const_iterator find(const std::string &key) const {
  1063. auto i = index_of(key);
  1064. return i == npos() ? end() : make_citer(i, i);
  1065. }
  1066. size_type count(const std::string &key) const {
  1067. size_type n = 0;
  1068. for (const auto &entry : entries_) {
  1069. if (keys_equal(entry.first, key)) { n++; }
  1070. }
  1071. return n;
  1072. }
  1073. std::pair<iterator, iterator> equal_range(const std::string &key) {
  1074. auto i = index_of(key);
  1075. return i == npos() ? std::make_pair(end(), end())
  1076. : std::make_pair(make_iter(i, i), end());
  1077. }
  1078. std::pair<const_iterator, const_iterator>
  1079. equal_range(const std::string &key) const {
  1080. auto i = index_of(key);
  1081. return i == npos() ? std::make_pair(end(), end())
  1082. : std::make_pair(make_citer(i, i), end());
  1083. }
  1084. size_type erase(const std::string &key) {
  1085. auto before = entries_.size();
  1086. entries_.erase(std::remove_if(entries_.begin(), entries_.end(),
  1087. [&](const value_type &entry) {
  1088. return keys_equal(entry.first, key);
  1089. }),
  1090. entries_.end());
  1091. return before - entries_.size();
  1092. }
  1093. iterator erase(const_iterator pos) {
  1094. entries_.erase(entries_.begin() + static_cast<difference_type>(pos.idx_));
  1095. return make_iter(pos.idx_, npos());
  1096. }
  1097. // Erases what iterating [first, last) would actually visit, so erasing an
  1098. // equal_range() removes only the entries with that key, not everything
  1099. // positioned between them.
  1100. iterator erase(const_iterator first, const_iterator last) {
  1101. auto from = first.idx_;
  1102. auto to = last.idx_;
  1103. if (from >= to) { return make_iter(from, npos()); }
  1104. auto begin_it = entries_.begin();
  1105. auto from_it = begin_it + static_cast<difference_type>(from);
  1106. auto to_it = begin_it + static_cast<difference_type>(to);
  1107. if (first.key_idx_ == npos()) {
  1108. entries_.erase(from_it, to_it);
  1109. } else {
  1110. auto key = entries_[first.key_idx_].first;
  1111. auto keep = from_it;
  1112. for (auto it = from_it; it != to_it; ++it) {
  1113. if (!keys_equal(it->first, key)) {
  1114. if (keep != it) { *keep = std::move(*it); }
  1115. ++keep;
  1116. }
  1117. }
  1118. if (keep != to_it) {
  1119. keep = std::move(to_it, entries_.end(), keep);
  1120. } else {
  1121. keep = entries_.end();
  1122. }
  1123. entries_.erase(keep, entries_.end());
  1124. }
  1125. return make_iter(from, npos());
  1126. }
  1127. friend bool operator==(const insertion_ordered_multimap &lhs,
  1128. const insertion_ordered_multimap &rhs) {
  1129. return lhs.entries_ == rhs.entries_;
  1130. }
  1131. friend bool operator!=(const insertion_ordered_multimap &lhs,
  1132. const insertion_ordered_multimap &rhs) {
  1133. return !(lhs == rhs);
  1134. }
  1135. private:
  1136. size_type index_of(const std::string &key) const {
  1137. for (size_type i = 0; i < entries_.size(); i++) {
  1138. if (keys_equal(entries_[i].first, key)) { return i; }
  1139. }
  1140. return npos();
  1141. }
  1142. iterator make_iter(size_type idx, size_type key_idx) {
  1143. return iterator(entries_.data(), idx, entries_.size(), key_idx);
  1144. }
  1145. const_iterator make_citer(size_type idx, size_type key_idx) const {
  1146. return const_iterator(entries_.data(), idx, entries_.size(), key_idx);
  1147. }
  1148. std::vector<value_type> entries_;
  1149. };
  1150. } // namespace detail
  1151. using Headers =
  1152. detail::insertion_ordered_multimap<std::string,
  1153. detail::case_ignore::equal_to>;
  1154. // Query parameter names are case-sensitive, unlike header field names.
  1155. using Params =
  1156. detail::insertion_ordered_multimap<std::string, std::equal_to<std::string>>;
  1157. using Match = std::smatch;
  1158. using DownloadProgress = std::function<bool(size_t current, size_t total)>;
  1159. using UploadProgress = std::function<bool(size_t current, size_t total)>;
  1160. /*
  1161. * detail: type-erased storage used by UserData.
  1162. * ABI-stable regardless of C++ standard — always uses this custom
  1163. * implementation instead of std::any.
  1164. */
  1165. namespace detail {
  1166. using any_type_id = const void *;
  1167. template <typename T> any_type_id any_typeid() noexcept {
  1168. static const char id = 0;
  1169. return &id;
  1170. }
  1171. struct any_storage {
  1172. virtual ~any_storage() = default;
  1173. virtual std::unique_ptr<any_storage> clone() const = 0;
  1174. virtual any_type_id type_id() const noexcept = 0;
  1175. };
  1176. template <typename T> struct any_value final : any_storage {
  1177. T value;
  1178. template <typename U> explicit any_value(U &&v) : value(std::forward<U>(v)) {}
  1179. std::unique_ptr<any_storage> clone() const override {
  1180. return std::unique_ptr<any_storage>(new any_value<T>(value));
  1181. }
  1182. any_type_id type_id() const noexcept override { return any_typeid<T>(); }
  1183. };
  1184. } // namespace detail
  1185. class UserData {
  1186. public:
  1187. UserData() = default;
  1188. UserData(UserData &&) noexcept = default;
  1189. UserData &operator=(UserData &&) noexcept = default;
  1190. UserData(const UserData &o) {
  1191. for (const auto &e : o.entries_) {
  1192. if (e.second) { entries_[e.first] = e.second->clone(); }
  1193. }
  1194. }
  1195. UserData &operator=(const UserData &o) {
  1196. if (this != &o) {
  1197. entries_.clear();
  1198. for (const auto &e : o.entries_) {
  1199. if (e.second) { entries_[e.first] = e.second->clone(); }
  1200. }
  1201. }
  1202. return *this;
  1203. }
  1204. template <typename T> void set(const std::string &key, T &&value) {
  1205. using D = typename std::decay<T>::type;
  1206. entries_[key].reset(new detail::any_value<D>(std::forward<T>(value)));
  1207. }
  1208. template <typename T> T *get(const std::string &key) noexcept {
  1209. auto it = entries_.find(key);
  1210. if (it == entries_.end() || !it->second) { return nullptr; }
  1211. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1212. return &static_cast<detail::any_value<T> *>(it->second.get())->value;
  1213. }
  1214. template <typename T> const T *get(const std::string &key) const noexcept {
  1215. auto it = entries_.find(key);
  1216. if (it == entries_.end() || !it->second) { return nullptr; }
  1217. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1218. return &static_cast<const detail::any_value<T> *>(it->second.get())->value;
  1219. }
  1220. bool has(const std::string &key) const noexcept {
  1221. return entries_.find(key) != entries_.end();
  1222. }
  1223. void erase(const std::string &key) { entries_.erase(key); }
  1224. void clear() noexcept { entries_.clear(); }
  1225. private:
  1226. std::unordered_map<std::string, std::unique_ptr<detail::any_storage>>
  1227. entries_;
  1228. };
  1229. struct Response;
  1230. using ResponseHandler = std::function<bool(const Response &response)>;
  1231. struct FormData {
  1232. std::string name;
  1233. std::string content;
  1234. std::string filename;
  1235. std::string content_type;
  1236. Headers headers;
  1237. };
  1238. struct FormField {
  1239. std::string name;
  1240. std::string content;
  1241. Headers headers;
  1242. };
  1243. // RFC 7578 5.2: a form processor "SHOULD send back results in order" and
  1244. // "Intermediaries MUST NOT reorder the results", so a handler walking these
  1245. // should see the parts as they were sent. A std::multimap sorts by field name
  1246. // and loses that. Field names are case-sensitive, hence std::equal_to rather
  1247. // than the case-insensitive predicate Headers uses.
  1248. using FormFields =
  1249. detail::insertion_ordered_multimap<FormField, std::equal_to<std::string>>;
  1250. using FormFiles =
  1251. detail::insertion_ordered_multimap<FormData, std::equal_to<std::string>>;
  1252. struct MultipartFormData {
  1253. FormFields fields; // Text fields from multipart
  1254. FormFiles files; // Files from multipart
  1255. // Text field access
  1256. std::string get_field(const std::string &key, size_t id = 0) const;
  1257. std::vector<std::string> get_fields(const std::string &key) const;
  1258. bool has_field(const std::string &key) const;
  1259. size_t get_field_count(const std::string &key) const;
  1260. // File access
  1261. FormData get_file(const std::string &key, size_t id = 0) const;
  1262. std::vector<FormData> get_files(const std::string &key) const;
  1263. bool has_file(const std::string &key) const;
  1264. size_t get_file_count(const std::string &key) const;
  1265. };
  1266. struct UploadFormData {
  1267. std::string name;
  1268. std::string content;
  1269. std::string filename;
  1270. std::string content_type;
  1271. };
  1272. using UploadFormDataItems = std::vector<UploadFormData>;
  1273. class DataSink {
  1274. public:
  1275. DataSink() : os(&sb_), sb_(*this) {}
  1276. DataSink(const DataSink &) = delete;
  1277. DataSink &operator=(const DataSink &) = delete;
  1278. DataSink(DataSink &&) = delete;
  1279. DataSink &operator=(DataSink &&) = delete;
  1280. std::function<bool(const char *data, size_t data_len)> write;
  1281. // Only `write` is mandatory. The rest are defaulted so that a provider
  1282. // calling one on a writer that does not set it gets sensible behaviour
  1283. // rather than std::bad_function_call thrown from a worker thread. Capturing
  1284. // `this` is safe: DataSink is neither copyable nor movable.
  1285. std::function<bool()> is_writable = []() { return true; };
  1286. std::function<void()> done = []() {};
  1287. std::function<void(const Headers &trailer)> done_with_trailer =
  1288. [this](const Headers & /*trailer*/) { done(); };
  1289. std::ostream os;
  1290. private:
  1291. class data_sink_streambuf final : public std::streambuf {
  1292. public:
  1293. explicit data_sink_streambuf(DataSink &sink) : sink_(sink) {}
  1294. protected:
  1295. std::streamsize xsputn(const char *s, std::streamsize n) override {
  1296. if (sink_.write(s, static_cast<size_t>(n))) { return n; }
  1297. return 0;
  1298. }
  1299. private:
  1300. DataSink &sink_;
  1301. };
  1302. data_sink_streambuf sb_;
  1303. };
  1304. using ContentProvider =
  1305. std::function<bool(size_t offset, size_t length, DataSink &sink)>;
  1306. using ContentProviderWithoutLength =
  1307. std::function<bool(size_t offset, DataSink &sink)>;
  1308. using ContentProviderResourceReleaser = std::function<void(bool success)>;
  1309. struct FormDataProvider {
  1310. std::string name;
  1311. ContentProviderWithoutLength provider;
  1312. std::string filename;
  1313. std::string content_type;
  1314. };
  1315. using FormDataProviderItems = std::vector<FormDataProvider>;
  1316. inline FormDataProvider
  1317. make_file_provider(const std::string &name, const std::string &filepath,
  1318. const std::string &filename = std::string(),
  1319. const std::string &content_type = std::string()) {
  1320. FormDataProvider fdp;
  1321. fdp.name = name;
  1322. fdp.filename = filename.empty() ? filepath : filename;
  1323. fdp.content_type = content_type;
  1324. fdp.provider = [filepath](size_t offset, DataSink &sink) -> bool {
  1325. std::ifstream f(filepath, std::ios::binary);
  1326. if (!f) { return false; }
  1327. if (offset > 0) {
  1328. f.seekg(static_cast<std::streamoff>(offset));
  1329. if (!f.good()) {
  1330. sink.done();
  1331. return true;
  1332. }
  1333. }
  1334. char buf[8192];
  1335. f.read(buf, sizeof(buf));
  1336. auto n = static_cast<size_t>(f.gcount());
  1337. if (n > 0) { return sink.write(buf, n); }
  1338. sink.done(); // EOF
  1339. return true;
  1340. };
  1341. return fdp;
  1342. }
  1343. inline std::pair<size_t, ContentProvider>
  1344. make_file_body(const std::string &filepath) {
  1345. size_t size = 0;
  1346. {
  1347. std::ifstream f(filepath, std::ios::binary | std::ios::ate);
  1348. if (!f) { return {0, ContentProvider{}}; }
  1349. size = static_cast<size_t>(f.tellg());
  1350. }
  1351. ContentProvider provider = [filepath](size_t offset, size_t length,
  1352. DataSink &sink) -> bool {
  1353. std::ifstream f(filepath, std::ios::binary);
  1354. if (!f) { return false; }
  1355. f.seekg(static_cast<std::streamoff>(offset));
  1356. if (!f.good()) { return false; }
  1357. char buf[8192];
  1358. while (length > 0) {
  1359. auto to_read = (std::min)(sizeof(buf), length);
  1360. f.read(buf, static_cast<std::streamsize>(to_read));
  1361. auto n = static_cast<size_t>(f.gcount());
  1362. // The file is shorter than the size make_file_body() measured, which the
  1363. // caller has already committed to as Content-Length. The body cannot be
  1364. // completed, so fail as every other error here does.
  1365. if (n == 0) { return false; }
  1366. if (!sink.write(buf, n)) { return false; }
  1367. length -= n;
  1368. }
  1369. return true;
  1370. };
  1371. return {size, std::move(provider)};
  1372. }
  1373. using ContentReceiverWithProgress = std::function<bool(
  1374. const char *data, size_t data_length, size_t offset, size_t total_length)>;
  1375. using ContentReceiver =
  1376. std::function<bool(const char *data, size_t data_length)>;
  1377. using FormDataHeader = std::function<bool(const FormData &file)>;
  1378. class ContentReader {
  1379. public:
  1380. using Reader = std::function<bool(ContentReceiver receiver)>;
  1381. using FormDataReader =
  1382. std::function<bool(FormDataHeader header, ContentReceiver receiver)>;
  1383. ContentReader(Reader reader, FormDataReader multipart_reader)
  1384. : reader_(std::move(reader)),
  1385. formdata_reader_(std::move(multipart_reader)) {}
  1386. bool operator()(FormDataHeader header, ContentReceiver receiver) const {
  1387. return formdata_reader_(std::move(header), std::move(receiver));
  1388. }
  1389. bool operator()(ContentReceiver receiver) const {
  1390. return reader_(std::move(receiver));
  1391. }
  1392. Reader reader_;
  1393. FormDataReader formdata_reader_;
  1394. };
  1395. using Range = std::pair<ssize_t, ssize_t>;
  1396. using Ranges = std::vector<Range>;
  1397. #ifdef CPPHTTPLIB_SSL_ENABLED
  1398. // TLS abstraction layer - public type definitions and API
  1399. namespace tls {
  1400. // Opaque handles (defined as void* for abstraction)
  1401. using ctx_t = void *;
  1402. using session_t = void *;
  1403. using const_session_t = const void *; // For read-only session access
  1404. using cert_t = void *;
  1405. using ca_store_t = void *;
  1406. // TLS versions
  1407. enum class Version {
  1408. TLS1_2 = 0x0303,
  1409. TLS1_3 = 0x0304,
  1410. };
  1411. // Subject Alternative Names (SAN) entry types
  1412. enum class SanType { DNS, IP, EMAIL, URI, OTHER };
  1413. // SAN entry structure
  1414. struct SanEntry {
  1415. SanType type;
  1416. std::string value;
  1417. };
  1418. // Verification context for certificate verification callback
  1419. struct VerifyContext {
  1420. session_t session; // TLS session handle
  1421. cert_t cert; // Current certificate being verified
  1422. int depth; // Certificate chain depth (0 = leaf)
  1423. bool preverify_ok; // OpenSSL/Mbed TLS pre-verification result
  1424. long error_code; // Backend-specific error code (0 = no error)
  1425. const char *error_string; // Human-readable error description
  1426. // Certificate introspection methods
  1427. std::string subject_cn() const;
  1428. std::string issuer_name() const;
  1429. bool check_hostname(const char *hostname) const;
  1430. std::vector<SanEntry> sans() const;
  1431. bool validity(time_t &not_before, time_t &not_after) const;
  1432. std::string serial() const;
  1433. };
  1434. using VerifyCallback = std::function<bool(const VerifyContext &ctx)>;
  1435. // TlsError codes for TLS operations (backend-independent)
  1436. enum class ErrorCode : int {
  1437. Success = 0,
  1438. WantRead, // Non-blocking: need to wait for read
  1439. WantWrite, // Non-blocking: need to wait for write
  1440. PeerClosed, // Peer closed the connection
  1441. Fatal, // Unrecoverable error
  1442. SyscallError, // System call error (check sys_errno)
  1443. CertVerifyFailed, // Certificate verification failed
  1444. HostnameMismatch, // Hostname verification failed
  1445. };
  1446. // TLS error information
  1447. struct TlsError {
  1448. ErrorCode code = ErrorCode::Fatal;
  1449. uint64_t backend_code = 0; // OpenSSL: ERR_get_error(), mbedTLS: return value
  1450. int sys_errno = 0; // errno when SyscallError
  1451. // Convert verification error code to human-readable string
  1452. static std::string verify_error_to_string(long error_code);
  1453. };
  1454. // RAII wrapper for peer certificate
  1455. class PeerCert {
  1456. public:
  1457. PeerCert();
  1458. PeerCert(PeerCert &&other) noexcept;
  1459. PeerCert &operator=(PeerCert &&other) noexcept;
  1460. ~PeerCert();
  1461. PeerCert(const PeerCert &) = delete;
  1462. PeerCert &operator=(const PeerCert &) = delete;
  1463. explicit operator bool() const;
  1464. std::string subject_cn() const;
  1465. std::string issuer_name() const;
  1466. bool check_hostname(const char *hostname) const;
  1467. std::vector<SanEntry> sans() const;
  1468. bool validity(time_t &not_before, time_t &not_after) const;
  1469. std::string serial() const;
  1470. private:
  1471. explicit PeerCert(cert_t cert);
  1472. cert_t cert_ = nullptr;
  1473. friend PeerCert get_peer_cert_from_session(const_session_t session);
  1474. };
  1475. // Callback for TLS context setup (used by SSLServer constructor)
  1476. using ContextSetupCallback = std::function<bool(ctx_t ctx)>;
  1477. } // namespace tls
  1478. #endif
  1479. struct Request {
  1480. std::string method;
  1481. std::string path;
  1482. std::string matched_route;
  1483. Params params;
  1484. Headers headers;
  1485. Headers trailers;
  1486. std::string body;
  1487. std::string remote_addr;
  1488. int remote_port = -1;
  1489. std::string local_addr;
  1490. int local_port = -1;
  1491. // for server
  1492. std::string version;
  1493. std::string target;
  1494. MultipartFormData form;
  1495. Ranges ranges;
  1496. Match matches;
  1497. std::unordered_map<std::string, std::string> path_params;
  1498. std::function<bool()> is_connection_closed = []() { return true; };
  1499. // for client
  1500. std::vector<std::string> accept_content_types;
  1501. ResponseHandler response_handler;
  1502. ContentReceiverWithProgress content_receiver;
  1503. DownloadProgress download_progress;
  1504. UploadProgress upload_progress;
  1505. bool has_header(const std::string &key) const;
  1506. std::string get_header_value(const std::string &key, const char *def = "",
  1507. size_t id = 0) const;
  1508. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1509. size_t id = 0) const;
  1510. size_t get_header_value_count(const std::string &key) const;
  1511. void set_header(const std::string &key, const std::string &val);
  1512. bool has_trailer(const std::string &key) const;
  1513. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1514. size_t get_trailer_value_count(const std::string &key) const;
  1515. bool has_param(const std::string &key) const;
  1516. std::string get_param_value(const std::string &key, size_t id = 0) const;
  1517. std::vector<std::string> get_param_values(const std::string &key) const;
  1518. size_t get_param_value_count(const std::string &key) const;
  1519. bool is_multipart_form_data() const;
  1520. // private members...
  1521. bool body_read_started_ = false;
  1522. bool body_consumed_ = false;
  1523. bool expect_100_continue_pending_ = false;
  1524. size_t redirect_count_ = CPPHTTPLIB_REDIRECT_MAX_COUNT;
  1525. size_t content_length_ = 0;
  1526. ContentProvider content_provider_;
  1527. bool is_chunked_content_provider_ = false;
  1528. size_t authorization_count_ = 0;
  1529. std::chrono::time_point<std::chrono::steady_clock> start_time_ =
  1530. (std::chrono::steady_clock::time_point::min)();
  1531. #ifdef CPPHTTPLIB_SSL_ENABLED
  1532. tls::const_session_t ssl = nullptr;
  1533. tls::PeerCert peer_cert() const;
  1534. std::string sni() const;
  1535. #endif
  1536. };
  1537. namespace detail {
  1538. // Declared up here, away from the rest of the compression helpers, because
  1539. // `Response` stores one.
  1540. enum class EncodingType { None = 0, Gzip, Brotli, Zstd };
  1541. } // namespace detail
  1542. struct Response {
  1543. std::string version;
  1544. int status = -1;
  1545. std::string reason;
  1546. Headers headers;
  1547. Headers trailers;
  1548. std::string body;
  1549. std::string location; // Redirect location
  1550. // User-defined context — set by pre-routing/pre-request handlers and read
  1551. // by route handlers to pass arbitrary data (e.g. decoded auth tokens).
  1552. UserData user_data;
  1553. bool has_header(const std::string &key) const;
  1554. std::string get_header_value(const std::string &key, const char *def = "",
  1555. size_t id = 0) const;
  1556. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1557. size_t id = 0) const;
  1558. size_t get_header_value_count(const std::string &key) const;
  1559. void set_header(const std::string &key, const std::string &val);
  1560. bool has_trailer(const std::string &key) const;
  1561. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1562. size_t get_trailer_value_count(const std::string &key) const;
  1563. void set_redirect(const std::string &url, int status = StatusCode::Found_302);
  1564. void set_content(const char *s, size_t n, const std::string &content_type);
  1565. void set_content(const std::string &s, const std::string &content_type);
  1566. void set_content(std::string &&s, const std::string &content_type);
  1567. void set_content_provider(
  1568. size_t length, const std::string &content_type, ContentProvider provider,
  1569. ContentProviderResourceReleaser resource_releaser = nullptr);
  1570. void set_content_provider(
  1571. const std::string &content_type, ContentProviderWithoutLength provider,
  1572. ContentProviderResourceReleaser resource_releaser = nullptr);
  1573. void set_chunked_content_provider(
  1574. const std::string &content_type, ContentProviderWithoutLength provider,
  1575. ContentProviderResourceReleaser resource_releaser = nullptr);
  1576. void set_file_content(const std::string &path,
  1577. const std::string &content_type);
  1578. void set_file_content(const std::string &path);
  1579. Response() = default;
  1580. Response(const Response &) = default;
  1581. Response &operator=(const Response &) = default;
  1582. Response(Response &&) = default;
  1583. Response &operator=(Response &&) = default;
  1584. ~Response() {
  1585. if (content_provider_resource_releaser_) {
  1586. content_provider_resource_releaser_(content_provider_success_);
  1587. }
  1588. }
  1589. // private members...
  1590. size_t content_length_ = 0;
  1591. ContentProvider content_provider_;
  1592. ContentProviderResourceReleaser content_provider_resource_releaser_;
  1593. bool is_chunked_content_provider_ = false;
  1594. bool is_file_content_provider_ = false;
  1595. bool content_provider_success_ = false;
  1596. std::string file_content_path_;
  1597. std::string file_content_content_type_;
  1598. // Content coding chosen for the response body, decided once so that the
  1599. // headers and the body cannot disagree: where the file is opened for a
  1600. // file-backed content provider (keeping the ETag honest), and in
  1601. // `apply_ranges()` for a chunked content provider. `EncodingType::None`
  1602. // for every other kind of response.
  1603. detail::EncodingType content_coding_ = detail::EncodingType::None;
  1604. };
  1605. enum class Error {
  1606. Success = 0,
  1607. Unknown,
  1608. Connection,
  1609. BindIPAddress,
  1610. Read,
  1611. Write,
  1612. ExceedRedirectCount,
  1613. Canceled,
  1614. SSLConnection,
  1615. SSLLoadingCerts,
  1616. SSLServerVerification,
  1617. SSLServerHostnameVerification,
  1618. UnsupportedMultipartBoundaryChars,
  1619. Compression,
  1620. ConnectionTimeout,
  1621. ProxyConnection,
  1622. ConnectionClosed,
  1623. Timeout,
  1624. ResourceExhaustion,
  1625. TooManyFormDataFiles,
  1626. ExceedMaxPayloadSize,
  1627. ExceedUriMaxLength,
  1628. ExceedMaxSocketDescriptorCount,
  1629. InvalidRequestLine,
  1630. InvalidHTTPMethod,
  1631. InvalidHTTPVersion,
  1632. InvalidHeaders,
  1633. MultipartParsing,
  1634. OpenFile,
  1635. Listen,
  1636. GetSockName,
  1637. UnsupportedAddressFamily,
  1638. HTTPParsing,
  1639. InvalidRangeHeader,
  1640. UnsupportedContentEncoding,
  1641. WebSocketHandshake,
  1642. UserCallbackException,
  1643. // For internal use only
  1644. SSLPeerCouldBeClosed_,
  1645. };
  1646. std::string to_string(Error error);
  1647. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1648. class Stream {
  1649. public:
  1650. virtual ~Stream() = default;
  1651. virtual bool is_readable() const = 0;
  1652. virtual bool wait_readable() const = 0;
  1653. virtual bool wait_writable() const = 0;
  1654. virtual bool is_peer_alive() const { return wait_writable(); }
  1655. virtual ssize_t read(char *ptr, size_t size) = 0;
  1656. virtual ssize_t write(const char *ptr, size_t size) = 0;
  1657. virtual void get_remote_ip_and_port(std::string &ip, int &port) const = 0;
  1658. virtual void get_local_ip_and_port(std::string &ip, int &port) const = 0;
  1659. virtual socket_t socket() const = 0;
  1660. virtual time_t duration() const = 0;
  1661. virtual void set_read_timeout(time_t sec, time_t usec = 0) {
  1662. (void)sec;
  1663. (void)usec;
  1664. }
  1665. // Bytes already pulled off the socket and sitting in this stream's own
  1666. // buffer. Exposing them lets a line reader scan for a terminator in one
  1667. // pass instead of asking for a byte at a time. A stream that does no
  1668. // buffering of its own reports none, and readers fall back to read().
  1669. virtual const char *buffered_data(size_t &size) const {
  1670. size = 0;
  1671. return nullptr;
  1672. }
  1673. // Discards `size` bytes previously returned by buffered_data().
  1674. virtual void consume_buffered(size_t size) { (void)size; }
  1675. ssize_t write(const char *ptr);
  1676. ssize_t write(const std::string &s);
  1677. Error get_error() const { return error_; }
  1678. protected:
  1679. Error error_ = Error::Success;
  1680. };
  1681. class TaskQueue {
  1682. public:
  1683. TaskQueue() = default;
  1684. virtual ~TaskQueue() = default;
  1685. virtual bool enqueue(std::function<void()> fn) = 0;
  1686. virtual void shutdown() = 0;
  1687. virtual void on_idle() {}
  1688. };
  1689. class ThreadPool final : public TaskQueue {
  1690. public:
  1691. explicit ThreadPool(
  1692. size_t n, size_t max_n = 0, size_t mqr = 0,
  1693. time_t idle_timeout_sec = CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT);
  1694. ThreadPool(const ThreadPool &) = delete;
  1695. ~ThreadPool() override = default;
  1696. bool enqueue(std::function<void()> fn) override;
  1697. void shutdown() override;
  1698. private:
  1699. void worker(bool is_dynamic);
  1700. void move_to_finished(std::thread::id id);
  1701. void cleanup_finished_threads();
  1702. size_t base_thread_count_;
  1703. size_t max_thread_count_;
  1704. size_t max_queued_requests_;
  1705. time_t idle_timeout_sec_;
  1706. size_t idle_thread_count_;
  1707. bool shutdown_;
  1708. std::list<std::function<void()>> jobs_;
  1709. std::vector<std::thread> threads_; // base threads
  1710. std::list<std::thread> dynamic_threads_; // dynamic threads
  1711. std::vector<std::thread>
  1712. finished_threads_; // exited dynamic threads awaiting join
  1713. std::condition_variable cond_;
  1714. std::mutex mutex_;
  1715. };
  1716. using Logger = std::function<void(const Request &, const Response &)>;
  1717. // Forward declaration for Error type
  1718. enum class Error;
  1719. using ErrorLogger = std::function<void(const Error &, const Request *)>;
  1720. using SocketOptions = std::function<void(socket_t sock)>;
  1721. void default_socket_options(socket_t sock);
  1722. bool set_socket_opt(socket_t sock, int level, int optname, int optval);
  1723. const char *status_message(int status);
  1724. std::string to_string(Error error);
  1725. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1726. std::string get_bearer_token_auth(const Request &req);
  1727. namespace detail {
  1728. class MatcherBase {
  1729. public:
  1730. MatcherBase(std::string pattern) : pattern_(std::move(pattern)) {}
  1731. virtual ~MatcherBase() = default;
  1732. const std::string &pattern() const { return pattern_; }
  1733. // Match request path and populate its matches and
  1734. virtual bool match(Request &request) const = 0;
  1735. private:
  1736. std::string pattern_;
  1737. };
  1738. /**
  1739. * Captures parameters in request path and stores them in Request::path_params
  1740. *
  1741. * Capture name is a substring of a pattern from : to /.
  1742. * The rest of the pattern is matched against the request path directly
  1743. * Parameters are captured starting from the next character after
  1744. * the end of the last matched static pattern fragment until the next /.
  1745. *
  1746. * Example pattern:
  1747. * "/path/fragments/:capture/more/fragments/:second_capture"
  1748. * Static fragments:
  1749. * "/path/fragments/", "more/fragments/"
  1750. *
  1751. * Given the following request path:
  1752. * "/path/fragments/:1/more/fragments/:2"
  1753. * the resulting capture will be
  1754. * {{"capture", "1"}, {"second_capture", "2"}}
  1755. */
  1756. class PathParamsMatcher final : public MatcherBase {
  1757. public:
  1758. PathParamsMatcher(const std::string &pattern);
  1759. bool match(Request &request) const override;
  1760. private:
  1761. // Treat segment separators as the end of path parameter capture
  1762. // Does not need to handle query parameters as they are parsed before path
  1763. // matching
  1764. static constexpr char separator = '/';
  1765. // Contains static path fragments to match against, excluding the '/' after
  1766. // path params
  1767. // Fragments are separated by path params
  1768. std::vector<std::string> static_fragments_;
  1769. // Stores the names of the path parameters to be used as keys in the
  1770. // Request::path_params map
  1771. std::vector<std::string> param_names_;
  1772. };
  1773. /**
  1774. * Performs std::regex_match on request path
  1775. * and stores the result in Request::matches
  1776. *
  1777. * Note that regex match is performed directly on the whole request.
  1778. * This means that wildcard patterns may match multiple path segments with /:
  1779. * "/begin/(.*)/end" will match both "/begin/middle/end" and "/begin/1/2/end".
  1780. */
  1781. class RegexMatcher final : public MatcherBase {
  1782. public:
  1783. RegexMatcher(const std::string &pattern)
  1784. : MatcherBase(pattern), regex_(pattern) {}
  1785. bool match(Request &request) const override;
  1786. private:
  1787. std::regex regex_;
  1788. };
  1789. int close_socket(socket_t sock) noexcept;
  1790. bool is_accept_resource_error();
  1791. bool is_accept_transient_error();
  1792. ssize_t write_headers(Stream &strm, const Headers &headers);
  1793. bool set_socket_opt_time(socket_t sock, int level, int optname, time_t sec,
  1794. time_t usec);
  1795. size_t get_multipart_content_length(const UploadFormDataItems &items,
  1796. const std::string &boundary);
  1797. ContentProvider
  1798. make_multipart_content_provider(const UploadFormDataItems &items,
  1799. const std::string &boundary);
  1800. } // namespace detail
  1801. bool is_valid_multipart_boundary(const std::string &boundary);
  1802. // Serializer for multipart/form-data request bodies. The boundary is owned
  1803. // by the writer so that per-part framing and the final terminator always
  1804. // agree. Field names and filenames are escaped following the WHATWG HTML
  1805. // standard ('"' -> %22, CR -> %0D, LF -> %0A); CR and LF are also escaped
  1806. // in content types.
  1807. class MultipartFormDataWriter {
  1808. public:
  1809. MultipartFormDataWriter();
  1810. // precondition: is_valid_multipart_boundary(boundary)
  1811. explicit MultipartFormDataWriter(std::string boundary);
  1812. const std::string &boundary() const;
  1813. std::string content_type() const;
  1814. // In-memory items -> whole body (known length)
  1815. std::string serialize(const UploadFormDataItems &items) const;
  1816. size_t content_length(const UploadFormDataItems &items) const;
  1817. // Per-part framing for streaming via a content provider
  1818. std::string item_begin(const UploadFormData &item) const;
  1819. static std::string item_end();
  1820. std::string finish() const;
  1821. private:
  1822. std::string boundary_;
  1823. };
  1824. class Server {
  1825. public:
  1826. using Handler = std::function<void(const Request &, Response &)>;
  1827. using ExceptionHandler =
  1828. std::function<void(const Request &, Response &, std::exception_ptr ep)>;
  1829. enum class HandlerResponse {
  1830. Handled,
  1831. Unhandled,
  1832. };
  1833. using HandlerWithResponse =
  1834. std::function<HandlerResponse(const Request &, Response &)>;
  1835. using HandlerWithContentReader = std::function<void(
  1836. const Request &, Response &, const ContentReader &content_reader)>;
  1837. using Expect100ContinueHandler =
  1838. std::function<int(const Request &, Response &)>;
  1839. using StartHandler = std::function<void()>;
  1840. using WebSocketHandler =
  1841. std::function<void(const Request &, ws::WebSocket &)>;
  1842. using SubProtocolSelector =
  1843. std::function<std::string(const std::vector<std::string> &protocols)>;
  1844. Server();
  1845. virtual ~Server();
  1846. virtual bool is_valid() const;
  1847. Server &Get(const std::string &pattern, Handler handler);
  1848. Server &Post(const std::string &pattern, Handler handler);
  1849. Server &Post(const std::string &pattern, HandlerWithContentReader handler);
  1850. Server &Put(const std::string &pattern, Handler handler);
  1851. Server &Put(const std::string &pattern, HandlerWithContentReader handler);
  1852. Server &Patch(const std::string &pattern, Handler handler);
  1853. Server &Patch(const std::string &pattern, HandlerWithContentReader handler);
  1854. Server &Delete(const std::string &pattern, Handler handler);
  1855. Server &Delete(const std::string &pattern, HandlerWithContentReader handler);
  1856. Server &Options(const std::string &pattern, Handler handler);
  1857. // Register a handler for an HTTP method outside the built-in set (e.g. the
  1858. // WebDAV methods from RFC 4918). Registering a method here is what makes the
  1859. // server accept it; an unregistered method is still rejected with 400.
  1860. // `method` must be a valid HTTP method token and must not be one of the
  1861. // built-in methods, which have their own registration functions above. A
  1862. // rejected registration makes is_valid() return false, so listen() fails.
  1863. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1864. Handler handler);
  1865. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1866. HandlerWithContentReader handler);
  1867. Server &WebSocket(const std::string &pattern, WebSocketHandler handler);
  1868. Server &WebSocket(const std::string &pattern, WebSocketHandler handler,
  1869. SubProtocolSelector sub_protocol_selector);
  1870. bool set_base_dir(const std::string &dir,
  1871. const std::string &mount_point = std::string());
  1872. bool set_mount_point(const std::string &mount_point, const std::string &dir,
  1873. Headers headers = Headers());
  1874. bool remove_mount_point(const std::string &mount_point);
  1875. Server &set_file_extension_and_mimetype_mapping(const std::string &ext,
  1876. const std::string &mime);
  1877. Server &set_default_file_mimetype(const std::string &mime);
  1878. Server &set_file_request_handler(Handler handler);
  1879. template <class ErrorHandlerFunc>
  1880. Server &set_error_handler(ErrorHandlerFunc &&handler) {
  1881. return set_error_handler_core(
  1882. std::forward<ErrorHandlerFunc>(handler),
  1883. std::is_convertible<ErrorHandlerFunc, HandlerWithResponse>{});
  1884. }
  1885. Server &set_exception_handler(ExceptionHandler handler);
  1886. Server &set_pre_routing_handler(HandlerWithResponse handler);
  1887. Server &set_post_routing_handler(Handler handler);
  1888. Server &set_pre_request_handler(HandlerWithResponse handler);
  1889. Server &set_expect_100_continue_handler(Expect100ContinueHandler handler);
  1890. Server &set_start_handler(StartHandler handler);
  1891. Server &set_logger(Logger logger);
  1892. Server &set_pre_compression_logger(Logger logger);
  1893. Server &set_error_logger(ErrorLogger error_logger);
  1894. Server &set_address_family(int family);
  1895. Server &set_tcp_nodelay(bool on);
  1896. Server &set_ipv6_v6only(bool on);
  1897. Server &set_socket_options(SocketOptions socket_options);
  1898. Server &set_default_headers(Headers headers);
  1899. Server &
  1900. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  1901. Server &set_trusted_proxies(const std::vector<std::string> &proxies);
  1902. Server &set_keep_alive_max_count(size_t count);
  1903. Server &set_keep_alive_timeout(time_t sec);
  1904. template <class Rep, class Period>
  1905. Server &
  1906. set_keep_alive_timeout(const std::chrono::duration<Rep, Period> &duration);
  1907. Server &set_read_timeout(time_t sec, time_t usec = 0);
  1908. template <class Rep, class Period>
  1909. Server &set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  1910. Server &set_write_timeout(time_t sec, time_t usec = 0);
  1911. template <class Rep, class Period>
  1912. Server &set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  1913. Server &set_idle_interval(time_t sec, time_t usec = 0);
  1914. template <class Rep, class Period>
  1915. Server &set_idle_interval(const std::chrono::duration<Rep, Period> &duration);
  1916. Server &set_payload_max_length(size_t length);
  1917. Server &set_static_file_compression(bool on);
  1918. Server &set_static_file_compression_min_length(size_t length);
  1919. Server &set_static_file_compression_max_length(size_t length);
  1920. Server &set_websocket_ping_interval(time_t sec);
  1921. template <class Rep, class Period>
  1922. Server &set_websocket_ping_interval(
  1923. const std::chrono::duration<Rep, Period> &duration);
  1924. Server &set_websocket_max_missed_pongs(int count);
  1925. bool bind_to_port(const std::string &host, int port, int socket_flags = 0);
  1926. int bind_to_any_port(const std::string &host, int socket_flags = 0);
  1927. bool listen_after_bind();
  1928. bool listen(const std::string &host, int port, int socket_flags = 0);
  1929. bool is_running() const;
  1930. void wait_until_ready() const;
  1931. void stop() noexcept;
  1932. void decommission();
  1933. std::function<TaskQueue *(void)> new_task_queue;
  1934. protected:
  1935. bool process_request(Stream &strm, const std::string &remote_addr,
  1936. int remote_port, const std::string &local_addr,
  1937. int local_port, bool close_connection,
  1938. bool &connection_closed,
  1939. const std::function<void(Request &)> &setup_request,
  1940. bool *websocket_upgraded = nullptr);
  1941. // Runs the per-connection serving loop and stops an exception thrown by a
  1942. // user callback from escaping the worker thread.
  1943. //
  1944. // process_request() wraps only routing() in a try/catch. Content providers,
  1945. // the post-routing, error, logging and expect-100 handlers and WebSocket
  1946. // handlers all run outside it, and the task queue calls the job without a
  1947. // catch, so an exception from any of those would terminate the process.
  1948. //
  1949. // No 500 is possible here: by the time a content provider runs, the status
  1950. // line and headers are already on the wire. Report it through the error
  1951. // logger and drop the connection, which is what the peer observes either
  1952. // way. Other connections are unaffected.
  1953. template <typename Serve> bool serve_guarded(Serve &&serve) const {
  1954. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  1955. return serve();
  1956. #else
  1957. try {
  1958. return serve();
  1959. } catch (...) {
  1960. // The error logger is a user callback too, so it must not be able to
  1961. // throw the guard back open.
  1962. try {
  1963. output_error_log(Error::UserCallbackException, nullptr);
  1964. } catch (...) {}
  1965. return false;
  1966. }
  1967. #endif
  1968. }
  1969. std::atomic<socket_t> svr_sock_{INVALID_SOCKET};
  1970. std::vector<std::string> trusted_proxies_;
  1971. size_t keep_alive_max_count_ = CPPHTTPLIB_KEEPALIVE_MAX_COUNT;
  1972. time_t keep_alive_timeout_sec_ = CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND;
  1973. time_t read_timeout_sec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND;
  1974. time_t read_timeout_usec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND;
  1975. time_t write_timeout_sec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND;
  1976. time_t write_timeout_usec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND;
  1977. time_t idle_interval_sec_ = CPPHTTPLIB_IDLE_INTERVAL_SECOND;
  1978. time_t idle_interval_usec_ = CPPHTTPLIB_IDLE_INTERVAL_USECOND;
  1979. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  1980. bool static_file_compression_ = false;
  1981. size_t static_file_compression_min_length_ =
  1982. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH;
  1983. size_t static_file_compression_max_length_ =
  1984. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH;
  1985. time_t websocket_ping_interval_sec_ =
  1986. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  1987. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  1988. private:
  1989. using Handlers =
  1990. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, Handler>>;
  1991. using HandlersForContentReader =
  1992. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>,
  1993. HandlerWithContentReader>>;
  1994. // Both handler tables for one custom method live in a single entry, so that
  1995. // routing() needs only one map lookup per request to reach either of them.
  1996. struct CustomHandlerEntry {
  1997. Handlers handlers;
  1998. HandlersForContentReader handlers_for_content_reader;
  1999. };
  2000. using CustomHandlers = std::map<std::string, CustomHandlerEntry>;
  2001. static std::unique_ptr<detail::MatcherBase>
  2002. make_matcher(const std::string &pattern);
  2003. static const std::set<std::string> &builtin_methods();
  2004. CustomHandlerEntry *custom_entry_for_registration(const std::string &method);
  2005. const CustomHandlerEntry *find_custom_entry(const std::string &method) const;
  2006. template <typename H>
  2007. Server &add_handler(
  2008. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, H>> &handlers,
  2009. const std::string &pattern, H handler) {
  2010. handlers.emplace_back(make_matcher(pattern), std::move(handler));
  2011. return *this;
  2012. }
  2013. Server &set_error_handler_core(HandlerWithResponse handler, std::true_type);
  2014. Server &set_error_handler_core(Handler handler, std::false_type);
  2015. socket_t create_server_socket(const std::string &host, int port,
  2016. int socket_flags,
  2017. SocketOptions socket_options) const;
  2018. int bind_internal(const std::string &host, int port, int socket_flags);
  2019. bool listen_internal();
  2020. bool routing(Request &req, Response &res, Stream &strm);
  2021. bool handle_file_request(Request &req, Response &res);
  2022. bool check_if_not_modified(const Request &req, Response &res,
  2023. const std::string &etag, time_t mtime) const;
  2024. bool check_if_range(Request &req, const std::string &etag,
  2025. time_t mtime) const;
  2026. bool dispatch_request(Request &req, Response &res, const Handlers &handlers,
  2027. Stream &strm);
  2028. bool dispatch_request_for_content_reader(
  2029. Request &req, Response &res, ContentReader content_reader,
  2030. const HandlersForContentReader &handlers) const;
  2031. bool parse_request_line(const char *s, Request &req) const;
  2032. detail::EncodingType static_file_encoding(const Request &req,
  2033. const Response &res,
  2034. const std::string &content_type,
  2035. size_t length) const;
  2036. bool apply_static_file_compression(const Request &req, Response &res) const;
  2037. void apply_ranges(const Request &req, Response &res,
  2038. std::string &content_type, std::string &boundary) const;
  2039. bool write_response(Stream &strm, bool close_connection, Request &req,
  2040. Response &res);
  2041. bool write_response_with_content(Stream &strm, bool close_connection,
  2042. const Request &req, Response &res);
  2043. bool write_response_core(Stream &strm, bool close_connection,
  2044. const Request &req, Response &res,
  2045. bool need_apply_ranges);
  2046. bool write_content_with_provider(Stream &strm, const Request &req,
  2047. Response &res, const std::string &boundary,
  2048. const std::string &content_type);
  2049. bool read_content(Stream &strm, Request &req, Response &res);
  2050. bool read_content_with_content_receiver(Stream &strm, Request &req,
  2051. Response &res,
  2052. ContentReceiver receiver,
  2053. FormDataHeader multipart_header,
  2054. ContentReceiver multipart_receiver);
  2055. bool read_content_core(Stream &strm, Request &req, Response &res,
  2056. ContentReceiver receiver,
  2057. FormDataHeader multipart_header,
  2058. ContentReceiver multipart_receiver) const;
  2059. virtual bool process_and_close_socket(socket_t sock);
  2060. void output_log(const Request &req, const Response &res) const;
  2061. void output_pre_compression_log(const Request &req,
  2062. const Response &res) const;
  2063. void output_error_log(const Error &err, const Request *req) const;
  2064. std::atomic<bool> is_running_{false};
  2065. std::atomic<bool> is_decommissioned{false};
  2066. // Set when CustomRoute() refuses a registration. Written before listen(),
  2067. // read by is_valid() on the same thread, so it needs no synchronization.
  2068. bool has_invalid_registration_ = false;
  2069. struct MountPointEntry {
  2070. std::string mount_point;
  2071. std::string base_dir;
  2072. std::string resolved_base_dir;
  2073. Headers headers;
  2074. };
  2075. std::vector<MountPointEntry> base_dirs_;
  2076. std::map<std::string, std::string> file_extension_and_mimetype_map_;
  2077. std::string default_file_mimetype_ = "application/octet-stream";
  2078. Handler file_request_handler_;
  2079. Handlers get_handlers_;
  2080. Handlers post_handlers_;
  2081. HandlersForContentReader post_handlers_for_content_reader_;
  2082. Handlers put_handlers_;
  2083. HandlersForContentReader put_handlers_for_content_reader_;
  2084. Handlers patch_handlers_;
  2085. HandlersForContentReader patch_handlers_for_content_reader_;
  2086. Handlers delete_handlers_;
  2087. HandlersForContentReader delete_handlers_for_content_reader_;
  2088. Handlers options_handlers_;
  2089. CustomHandlers custom_handlers_;
  2090. struct WebSocketHandlerEntry {
  2091. std::unique_ptr<detail::MatcherBase> matcher;
  2092. WebSocketHandler handler;
  2093. SubProtocolSelector sub_protocol_selector;
  2094. };
  2095. using WebSocketHandlers = std::vector<WebSocketHandlerEntry>;
  2096. WebSocketHandlers websocket_handlers_;
  2097. HandlerWithResponse error_handler_;
  2098. ExceptionHandler exception_handler_;
  2099. HandlerWithResponse pre_routing_handler_;
  2100. Handler post_routing_handler_;
  2101. HandlerWithResponse pre_request_handler_;
  2102. Expect100ContinueHandler expect_100_continue_handler_;
  2103. StartHandler start_handler_;
  2104. mutable std::mutex logger_mutex_;
  2105. Logger logger_;
  2106. Logger pre_compression_logger_;
  2107. ErrorLogger error_logger_;
  2108. int address_family_ = AF_UNSPEC;
  2109. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2110. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2111. SocketOptions socket_options_ = default_socket_options;
  2112. Headers default_headers_;
  2113. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2114. detail::write_headers;
  2115. };
  2116. class Result {
  2117. public:
  2118. Result() = default;
  2119. Result(std::unique_ptr<Response> &&res, Error err,
  2120. Headers &&request_headers = Headers{})
  2121. : res_(std::move(res)), err_(err),
  2122. request_headers_(std::move(request_headers)) {}
  2123. // Response
  2124. operator bool() const { return res_ != nullptr; }
  2125. bool operator==(std::nullptr_t) const { return res_ == nullptr; }
  2126. bool operator!=(std::nullptr_t) const { return res_ != nullptr; }
  2127. const Response &value() const { return *res_; }
  2128. Response &value() { return *res_; }
  2129. const Response &operator*() const { return *res_; }
  2130. Response &operator*() { return *res_; }
  2131. const Response *operator->() const { return res_.get(); }
  2132. Response *operator->() { return res_.get(); }
  2133. // Error
  2134. Error error() const { return err_; }
  2135. // Request Headers
  2136. bool has_request_header(const std::string &key) const;
  2137. std::string get_request_header_value(const std::string &key,
  2138. const char *def = "",
  2139. size_t id = 0) const;
  2140. size_t get_request_header_value_u64(const std::string &key, size_t def = 0,
  2141. size_t id = 0) const;
  2142. size_t get_request_header_value_count(const std::string &key) const;
  2143. private:
  2144. std::unique_ptr<Response> res_;
  2145. Error err_ = Error::Unknown;
  2146. Headers request_headers_;
  2147. #ifdef CPPHTTPLIB_SSL_ENABLED
  2148. public:
  2149. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2150. int ssl_error)
  2151. : res_(std::move(res)), err_(err),
  2152. request_headers_(std::move(request_headers)), ssl_error_(ssl_error) {}
  2153. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2154. int ssl_error, uint64_t ssl_backend_error)
  2155. : res_(std::move(res)), err_(err),
  2156. request_headers_(std::move(request_headers)), ssl_error_(ssl_error),
  2157. ssl_backend_error_(ssl_backend_error) {}
  2158. int ssl_error() const { return ssl_error_; }
  2159. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  2160. private:
  2161. int ssl_error_ = 0;
  2162. uint64_t ssl_backend_error_ = 0;
  2163. #endif
  2164. };
  2165. struct ClientConnection {
  2166. socket_t sock = INVALID_SOCKET;
  2167. bool is_open() const { return sock != INVALID_SOCKET; }
  2168. ClientConnection() = default;
  2169. ~ClientConnection();
  2170. ClientConnection(const ClientConnection &) = delete;
  2171. ClientConnection &operator=(const ClientConnection &) = delete;
  2172. ClientConnection(ClientConnection &&other) noexcept
  2173. : sock(other.sock)
  2174. #ifdef CPPHTTPLIB_SSL_ENABLED
  2175. ,
  2176. session(other.session)
  2177. #endif
  2178. {
  2179. other.sock = INVALID_SOCKET;
  2180. #ifdef CPPHTTPLIB_SSL_ENABLED
  2181. other.session = nullptr;
  2182. #endif
  2183. }
  2184. ClientConnection &operator=(ClientConnection &&other) noexcept {
  2185. if (this != &other) {
  2186. sock = other.sock;
  2187. other.sock = INVALID_SOCKET;
  2188. #ifdef CPPHTTPLIB_SSL_ENABLED
  2189. session = other.session;
  2190. other.session = nullptr;
  2191. #endif
  2192. }
  2193. return *this;
  2194. }
  2195. #ifdef CPPHTTPLIB_SSL_ENABLED
  2196. tls::session_t session = nullptr;
  2197. #endif
  2198. };
  2199. namespace detail {
  2200. struct ChunkedDecoder;
  2201. struct BodyReader {
  2202. Stream *stream = nullptr;
  2203. bool has_content_length = false;
  2204. size_t content_length = 0;
  2205. size_t payload_max_length = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2206. size_t bytes_read = 0;
  2207. bool chunked = false;
  2208. bool eof = false;
  2209. std::unique_ptr<ChunkedDecoder> chunked_decoder;
  2210. Error last_error = Error::Success;
  2211. ssize_t read(char *buf, size_t len);
  2212. bool has_error() const { return last_error != Error::Success; }
  2213. };
  2214. inline ssize_t read_body_content(Stream *stream, BodyReader &br, char *buf,
  2215. size_t len) {
  2216. (void)stream;
  2217. return br.read(buf, len);
  2218. }
  2219. class decompressor;
  2220. enum class NoProxyKind {
  2221. Wildcard, // "*"
  2222. HostnameSuffix, // "example.com" or ".example.com"
  2223. IPv4Cidr, // "10.0.0.0/8" (or single IP, treated as /32)
  2224. IPv6Cidr, // "fe80::/10" (or single IP, treated as /128)
  2225. };
  2226. // Unified 16-byte buffer holding either a v4 (first 4 bytes) or v6 address.
  2227. // Lets one CIDR matcher cover both families.
  2228. using IPBytes = std::array<uint8_t, 16>;
  2229. struct NoProxyEntry {
  2230. NoProxyKind kind = NoProxyKind::Wildcard;
  2231. std::string hostname_pattern; // lowercased, leading/trailing dot stripped
  2232. IPBytes net{};
  2233. int prefix_bits = 0;
  2234. };
  2235. struct NormalizedTarget {
  2236. std::string hostname; // lowercase; brackets and trailing dot removed
  2237. bool is_ipv4 = false;
  2238. bool is_ipv6 = false;
  2239. IPBytes ip{};
  2240. };
  2241. } // namespace detail
  2242. class ClientImpl {
  2243. public:
  2244. explicit ClientImpl(const std::string &host);
  2245. explicit ClientImpl(const std::string &host, int port);
  2246. explicit ClientImpl(const std::string &host, int port,
  2247. const std::string &client_cert_path,
  2248. const std::string &client_key_path);
  2249. virtual ~ClientImpl();
  2250. virtual bool is_valid() const;
  2251. struct StreamHandle {
  2252. std::unique_ptr<Response> response;
  2253. Error error = Error::Success;
  2254. StreamHandle() = default;
  2255. StreamHandle(const StreamHandle &) = delete;
  2256. StreamHandle &operator=(const StreamHandle &) = delete;
  2257. StreamHandle(StreamHandle &&) = default;
  2258. StreamHandle &operator=(StreamHandle &&) = default;
  2259. ~StreamHandle() = default;
  2260. bool is_valid() const {
  2261. return response != nullptr && error == Error::Success;
  2262. }
  2263. ssize_t read(char *buf, size_t len);
  2264. void parse_trailers_if_needed();
  2265. Error get_read_error() const { return body_reader_.last_error; }
  2266. bool has_read_error() const { return body_reader_.has_error(); }
  2267. bool trailers_parsed_ = false;
  2268. private:
  2269. friend class ClientImpl;
  2270. ssize_t read_with_decompression(char *buf, size_t len);
  2271. std::unique_ptr<ClientConnection> connection_;
  2272. std::unique_ptr<Stream> socket_stream_;
  2273. Stream *stream_ = nullptr;
  2274. detail::BodyReader body_reader_;
  2275. std::unique_ptr<detail::decompressor> decompressor_;
  2276. std::string decompress_buffer_;
  2277. size_t decompress_offset_ = 0;
  2278. size_t decompressed_bytes_read_ = 0;
  2279. };
  2280. // clang-format off
  2281. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2282. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2283. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2284. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2285. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2286. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2287. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2288. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2289. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2290. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2291. Result Head(const std::string &path);
  2292. Result Head(const std::string &path, const Headers &headers);
  2293. Result Post(const std::string &path);
  2294. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2295. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2296. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2297. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2298. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2299. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2300. Result Post(const std::string &path, const Params &params);
  2301. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2302. Result Post(const std::string &path, const Headers &headers);
  2303. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2304. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2305. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2306. 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);
  2307. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2308. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2309. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2310. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2311. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2312. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2313. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2314. Result Put(const std::string &path);
  2315. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2316. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2317. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2318. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2319. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2320. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2321. Result Put(const std::string &path, const Params &params);
  2322. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2323. Result Put(const std::string &path, const Headers &headers);
  2324. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2325. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2326. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2327. 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);
  2328. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2329. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2330. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2331. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2332. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2333. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2334. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2335. Result Patch(const std::string &path);
  2336. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2337. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2338. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2339. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2340. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2341. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2342. Result Patch(const std::string &path, const Params &params);
  2343. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2344. Result Patch(const std::string &path, const Headers &headers, UploadProgress progress = nullptr);
  2345. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2346. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2347. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2348. 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);
  2349. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2350. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2351. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2352. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2353. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2354. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2355. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2356. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2357. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2358. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2359. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2360. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2361. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2362. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2363. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2364. Result Options(const std::string &path);
  2365. Result Options(const std::string &path, const Headers &headers);
  2366. // clang-format on
  2367. // Streaming API: Open a stream for reading response body incrementally
  2368. // Socket ownership is transferred to StreamHandle for true streaming
  2369. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2370. StreamHandle open_stream(const std::string &method, const std::string &path,
  2371. const Params &params = {},
  2372. const Headers &headers = {},
  2373. const std::string &body = {},
  2374. const std::string &content_type = {});
  2375. bool send(Request &req, Response &res, Error &error);
  2376. Result send(const Request &req);
  2377. void stop();
  2378. std::string host() const;
  2379. int port() const;
  2380. size_t is_socket_open() const;
  2381. socket_t socket() const;
  2382. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2383. void set_default_headers(Headers headers);
  2384. void
  2385. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2386. void set_address_family(int family);
  2387. void set_tcp_nodelay(bool on);
  2388. void set_ipv6_v6only(bool on);
  2389. void set_socket_options(SocketOptions socket_options);
  2390. void set_connection_timeout(time_t sec, time_t usec = 0);
  2391. template <class Rep, class Period>
  2392. void
  2393. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2394. void set_read_timeout(time_t sec, time_t usec = 0);
  2395. template <class Rep, class Period>
  2396. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2397. void set_write_timeout(time_t sec, time_t usec = 0);
  2398. template <class Rep, class Period>
  2399. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2400. void set_max_timeout(time_t msec);
  2401. template <class Rep, class Period>
  2402. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2403. void set_basic_auth(const std::string &username, const std::string &password);
  2404. void set_bearer_token_auth(const std::string &token);
  2405. void set_keep_alive(bool on);
  2406. void set_follow_location(bool on);
  2407. void set_path_encode(bool on);
  2408. void set_compress(bool on);
  2409. void set_decompress(bool on);
  2410. void set_payload_max_length(size_t length);
  2411. void set_interface(const std::string &intf);
  2412. void set_proxy(const std::string &host, int port);
  2413. void set_proxy_basic_auth(const std::string &username,
  2414. const std::string &password);
  2415. void set_proxy_bearer_token_auth(const std::string &token);
  2416. void set_no_proxy(const std::vector<std::string> &patterns);
  2417. void set_logger(Logger logger);
  2418. void set_error_logger(ErrorLogger error_logger);
  2419. protected:
  2420. struct Socket {
  2421. socket_t sock = INVALID_SOCKET;
  2422. // For Mbed TLS compatibility: start_time for request timeout tracking
  2423. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  2424. bool is_open() const { return sock != INVALID_SOCKET; }
  2425. #ifdef CPPHTTPLIB_SSL_ENABLED
  2426. tls::session_t ssl = nullptr;
  2427. #endif
  2428. };
  2429. virtual bool create_and_connect_socket(Socket &socket, Error &error);
  2430. virtual bool ensure_socket_connection(Socket &socket, Error &error);
  2431. virtual bool setup_proxy_connection(
  2432. Socket &socket,
  2433. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2434. Response &res, bool &success, Error &error);
  2435. bool is_proxy_enabled_for_host(const std::string &host) const;
  2436. // All of:
  2437. // shutdown_ssl
  2438. // shutdown_socket
  2439. // close_socket
  2440. // disconnect
  2441. // should ONLY be called when socket_mutex_ is locked, and only when
  2442. // no other thread is using the socket.
  2443. virtual void shutdown_ssl(Socket &socket, bool shutdown_gracefully);
  2444. void shutdown_socket(Socket &socket) const;
  2445. void close_socket(Socket &socket);
  2446. void disconnect(bool gracefully);
  2447. bool process_request(Stream &strm, Request &req, Response &res,
  2448. bool close_connection, Error &error);
  2449. bool write_content_with_provider(Stream &strm, const Request &req,
  2450. Error &error) const;
  2451. void output_log(const Request &req, const Response &res) const;
  2452. void output_error_log(const Error &err, const Request *req) const;
  2453. // Socket endpoint information
  2454. const std::string host_;
  2455. const int port_;
  2456. // Current open socket
  2457. Socket socket_;
  2458. mutable std::mutex socket_mutex_;
  2459. std::recursive_mutex request_mutex_;
  2460. // These are all protected under socket_mutex
  2461. size_t socket_requests_in_flight_ = 0;
  2462. std::thread::id socket_requests_are_from_thread_ = std::thread::id();
  2463. bool socket_should_be_closed_when_request_is_done_ = false;
  2464. // Hostname to connection target map. The value is an IP literal or another
  2465. // hostname; only the connection target changes, never the identity.
  2466. std::map<std::string, std::string> addr_map_;
  2467. // Default headers
  2468. Headers default_headers_;
  2469. // Header writer
  2470. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2471. detail::write_headers;
  2472. // Settings
  2473. std::string client_cert_path_;
  2474. std::string client_key_path_;
  2475. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  2476. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  2477. time_t read_timeout_sec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND;
  2478. time_t read_timeout_usec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND;
  2479. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  2480. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  2481. time_t max_timeout_msec_ = CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND;
  2482. std::string basic_auth_username_;
  2483. std::string basic_auth_password_;
  2484. std::string bearer_token_auth_token_;
  2485. bool keep_alive_ = false;
  2486. bool follow_location_ = false;
  2487. bool path_encode_ = true;
  2488. int address_family_ = AF_UNSPEC;
  2489. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2490. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2491. SocketOptions socket_options_ = nullptr;
  2492. bool compress_ = false;
  2493. bool decompress_ = true;
  2494. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2495. bool has_payload_max_length_ = false;
  2496. std::string interface_;
  2497. std::string proxy_host_;
  2498. int proxy_port_ = -1;
  2499. std::string proxy_basic_auth_username_;
  2500. std::string proxy_basic_auth_password_;
  2501. std::string proxy_bearer_token_auth_token_;
  2502. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  2503. mutable detail::NormalizedTarget host_normalized_;
  2504. mutable bool host_normalized_valid_ = false;
  2505. mutable std::mutex logger_mutex_;
  2506. Logger logger_;
  2507. ErrorLogger error_logger_;
  2508. private:
  2509. bool send_(Request &req, Response &res, Error &error);
  2510. Result send_(Request &&req);
  2511. socket_t create_client_socket(Error &error) const;
  2512. bool read_response_line(Stream &strm, const Request &req, Response &res,
  2513. bool skip_100_continue = true) const;
  2514. bool write_request(Stream &strm, Request &req, bool close_connection,
  2515. Error &error, bool skip_body, bool &rejected_locally);
  2516. bool write_request_body(Stream &strm, Request &req, Error &error);
  2517. void prepare_default_headers(Request &r, bool for_stream,
  2518. const std::string &ct);
  2519. bool redirect(Request &req, Response &res, Error &error);
  2520. bool create_redirect_client(const std::string &scheme,
  2521. const std::string &host, int port, Request &req,
  2522. Response &res, const std::string &path,
  2523. const std::string &location, Error &error);
  2524. template <typename ClientType> void setup_redirect_client(ClientType &client);
  2525. bool handle_request(Stream &strm, Request &req, Response &res,
  2526. bool close_connection, Error &error);
  2527. std::unique_ptr<Response> send_with_content_provider_and_receiver(
  2528. Request &req, const char *body, size_t content_length,
  2529. ContentProvider content_provider,
  2530. ContentProviderWithoutLength content_provider_without_length,
  2531. const std::string &content_type, ContentReceiver content_receiver,
  2532. Error &error);
  2533. Result send_with_content_provider_and_receiver(
  2534. const std::string &method, const std::string &path,
  2535. const Headers &headers, const char *body, size_t content_length,
  2536. ContentProvider content_provider,
  2537. ContentProviderWithoutLength content_provider_without_length,
  2538. const std::string &content_type, ContentReceiver content_receiver,
  2539. UploadProgress progress);
  2540. ContentProviderWithoutLength get_multipart_content_provider(
  2541. const std::string &boundary, const UploadFormDataItems &items,
  2542. const FormDataProviderItems &provider_items) const;
  2543. virtual bool
  2544. process_socket(const Socket &socket,
  2545. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2546. std::function<bool(Stream &strm)> callback);
  2547. virtual bool is_ssl() const;
  2548. void transfer_socket_ownership_to_handle(StreamHandle &handle);
  2549. #ifdef CPPHTTPLIB_SSL_ENABLED
  2550. public:
  2551. void set_digest_auth(const std::string &username,
  2552. const std::string &password);
  2553. void set_proxy_digest_auth(const std::string &username,
  2554. const std::string &password);
  2555. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2556. const std::string &ca_cert_dir_path = std::string());
  2557. void enable_server_certificate_verification(bool enabled);
  2558. void enable_server_hostname_verification(bool enabled);
  2559. void enable_system_ca(bool enabled);
  2560. protected:
  2561. std::string digest_auth_username_;
  2562. std::string digest_auth_password_;
  2563. std::string proxy_digest_auth_username_;
  2564. std::string proxy_digest_auth_password_;
  2565. std::string ca_cert_file_path_;
  2566. std::string ca_cert_dir_path_;
  2567. bool server_certificate_verification_ = true;
  2568. bool server_hostname_verification_ = true;
  2569. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  2570. std::string ca_cert_pem_; // Store CA cert PEM for redirect transfer
  2571. int last_ssl_error_ = 0;
  2572. uint64_t last_backend_error_ = 0;
  2573. #endif
  2574. };
  2575. class Client {
  2576. public:
  2577. // Universal interface
  2578. explicit Client(const std::string &scheme_host_port);
  2579. explicit Client(const std::string &scheme_host_port,
  2580. const std::string &client_cert_path,
  2581. const std::string &client_key_path);
  2582. // HTTP only interface
  2583. explicit Client(const std::string &host, int port);
  2584. explicit Client(const std::string &host, int port,
  2585. const std::string &client_cert_path,
  2586. const std::string &client_key_path);
  2587. Client(Client &&) = default;
  2588. Client &operator=(Client &&) = default;
  2589. ~Client();
  2590. bool is_valid() const;
  2591. // clang-format off
  2592. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2593. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2594. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2595. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2596. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2597. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2598. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2599. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2600. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2601. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2602. Result Head(const std::string &path);
  2603. Result Head(const std::string &path, const Headers &headers);
  2604. Result Post(const std::string &path);
  2605. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2606. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2607. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2608. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2609. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2610. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2611. Result Post(const std::string &path, const Params &params);
  2612. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2613. Result Post(const std::string &path, const Headers &headers);
  2614. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2615. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2616. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2617. 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);
  2618. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2619. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2620. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2621. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2622. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2623. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2624. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2625. Result Put(const std::string &path);
  2626. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2627. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2628. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2629. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2630. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2631. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2632. Result Put(const std::string &path, const Params &params);
  2633. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2634. Result Put(const std::string &path, const Headers &headers);
  2635. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2636. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2637. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2638. 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);
  2639. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2640. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2641. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2642. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2643. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2644. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2645. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2646. Result Patch(const std::string &path);
  2647. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2648. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2649. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2650. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2651. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2652. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2653. Result Patch(const std::string &path, const Params &params);
  2654. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2655. Result Patch(const std::string &path, const Headers &headers);
  2656. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2657. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2658. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2659. 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);
  2660. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2661. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2662. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2663. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2664. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2665. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2666. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2667. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2668. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2669. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2670. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2671. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2672. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2673. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2674. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2675. Result Options(const std::string &path);
  2676. Result Options(const std::string &path, const Headers &headers);
  2677. // clang-format on
  2678. // Streaming API: Open a stream for reading response body incrementally
  2679. // Socket ownership is transferred to StreamHandle for true streaming
  2680. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2681. ClientImpl::StreamHandle open_stream(const std::string &method,
  2682. const std::string &path,
  2683. const Params &params = {},
  2684. const Headers &headers = {},
  2685. const std::string &body = {},
  2686. const std::string &content_type = {});
  2687. bool send(Request &req, Response &res, Error &error);
  2688. Result send(const Request &req);
  2689. void stop();
  2690. std::string host() const;
  2691. int port() const;
  2692. size_t is_socket_open() const;
  2693. socket_t socket() const;
  2694. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2695. void set_default_headers(Headers headers);
  2696. void
  2697. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2698. void set_address_family(int family);
  2699. void set_tcp_nodelay(bool on);
  2700. void set_socket_options(SocketOptions socket_options);
  2701. void set_connection_timeout(time_t sec, time_t usec = 0);
  2702. template <class Rep, class Period>
  2703. void
  2704. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2705. void set_read_timeout(time_t sec, time_t usec = 0);
  2706. template <class Rep, class Period>
  2707. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2708. void set_write_timeout(time_t sec, time_t usec = 0);
  2709. template <class Rep, class Period>
  2710. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2711. void set_max_timeout(time_t msec);
  2712. template <class Rep, class Period>
  2713. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2714. void set_basic_auth(const std::string &username, const std::string &password);
  2715. void set_bearer_token_auth(const std::string &token);
  2716. void set_keep_alive(bool on);
  2717. void set_follow_location(bool on);
  2718. void set_path_encode(bool on);
  2719. void set_compress(bool on);
  2720. void set_decompress(bool on);
  2721. void set_payload_max_length(size_t length);
  2722. void set_interface(const std::string &intf);
  2723. void set_proxy(const std::string &host, int port);
  2724. void set_proxy_basic_auth(const std::string &username,
  2725. const std::string &password);
  2726. void set_proxy_bearer_token_auth(const std::string &token);
  2727. void set_no_proxy(const std::vector<std::string> &patterns);
  2728. void set_logger(Logger logger);
  2729. void set_error_logger(ErrorLogger error_logger);
  2730. private:
  2731. std::unique_ptr<ClientImpl> cli_;
  2732. #ifdef CPPHTTPLIB_SSL_ENABLED
  2733. public:
  2734. void set_digest_auth(const std::string &username,
  2735. const std::string &password);
  2736. void set_proxy_digest_auth(const std::string &username,
  2737. const std::string &password);
  2738. void enable_server_certificate_verification(bool enabled);
  2739. void enable_server_hostname_verification(bool enabled);
  2740. void enable_system_ca(bool enabled);
  2741. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2742. const std::string &ca_cert_dir_path = std::string());
  2743. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2744. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2745. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2746. void set_session_verifier(
  2747. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2748. tls::ctx_t tls_context() const;
  2749. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2750. void enable_windows_certificate_verification(bool enabled);
  2751. #endif
  2752. private:
  2753. bool is_ssl_ = false;
  2754. #endif
  2755. };
  2756. #ifdef CPPHTTPLIB_SSL_ENABLED
  2757. class SSLServer : public Server {
  2758. public:
  2759. SSLServer(const char *cert_path, const char *private_key_path,
  2760. const char *client_ca_cert_file_path = nullptr,
  2761. const char *client_ca_cert_dir_path = nullptr,
  2762. const char *private_key_password = nullptr);
  2763. struct PemMemory {
  2764. const char *cert_pem;
  2765. size_t cert_pem_len;
  2766. const char *key_pem;
  2767. size_t key_pem_len;
  2768. const char *client_ca_pem;
  2769. size_t client_ca_pem_len;
  2770. const char *private_key_password;
  2771. };
  2772. explicit SSLServer(const PemMemory &pem);
  2773. // The callback receives the ctx_t handle which can be cast to the
  2774. // appropriate backend type (SSL_CTX* for OpenSSL,
  2775. // tls::impl::MbedTlsContext* for Mbed TLS)
  2776. explicit SSLServer(const tls::ContextSetupCallback &setup_callback);
  2777. ~SSLServer() override;
  2778. bool is_valid() const override;
  2779. bool update_certs_pem(const char *cert_pem, const char *key_pem,
  2780. const char *client_ca_pem = nullptr,
  2781. const char *password = nullptr);
  2782. tls::ctx_t tls_context() const { return ctx_; }
  2783. int ssl_last_error() const { return last_ssl_error_; }
  2784. private:
  2785. bool process_and_close_socket(socket_t sock) override;
  2786. tls::ctx_t ctx_ = nullptr;
  2787. // update_certs_pem() replaces the certificates and CAs that handshakes read
  2788. // from ctx_, so it waits for the handshakes in progress, which their timeout
  2789. // bounds, and new ones wait while it is pending so that they cannot keep it
  2790. // waiting.
  2791. std::mutex ctx_mutex_;
  2792. std::condition_variable ctx_cv_;
  2793. size_t handshakes_in_progress_ = 0;
  2794. size_t updates_pending_ = 0;
  2795. int last_ssl_error_ = 0;
  2796. };
  2797. class SSLClient final : public ClientImpl {
  2798. public:
  2799. explicit SSLClient(const std::string &host);
  2800. explicit SSLClient(const std::string &host, int port);
  2801. explicit SSLClient(const std::string &host, int port,
  2802. const std::string &client_cert_path,
  2803. const std::string &client_key_path,
  2804. const std::string &private_key_password = std::string());
  2805. struct PemMemory {
  2806. const char *cert_pem;
  2807. size_t cert_pem_len;
  2808. const char *key_pem;
  2809. size_t key_pem_len;
  2810. const char *private_key_password;
  2811. };
  2812. explicit SSLClient(const std::string &host, int port, const PemMemory &pem);
  2813. ~SSLClient() override;
  2814. bool is_valid() const override;
  2815. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2816. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2817. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2818. // Post-handshake session verifier (backend-independent)
  2819. void set_session_verifier(
  2820. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2821. tls::ctx_t tls_context() const { return ctx_; }
  2822. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2823. void enable_windows_certificate_verification(bool enabled);
  2824. #endif
  2825. private:
  2826. bool create_and_connect_socket(Socket &socket, Error &error) override;
  2827. bool ensure_socket_connection(Socket &socket, Error &error) override;
  2828. void shutdown_ssl(Socket &socket, bool shutdown_gracefully) override;
  2829. void shutdown_ssl_impl(Socket &socket, bool shutdown_gracefully);
  2830. bool
  2831. process_socket(const Socket &socket,
  2832. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2833. std::function<bool(Stream &strm)> callback) override;
  2834. bool is_ssl() const override;
  2835. bool setup_proxy_connection(
  2836. Socket &socket,
  2837. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2838. Response &res, bool &success, Error &error) override;
  2839. bool connect_with_proxy(
  2840. Socket &sock,
  2841. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2842. Response &res, bool &success, Error &error);
  2843. bool initialize_ssl(Socket &socket, Error &error);
  2844. void init_ctx();
  2845. void reset_ctx_on_error();
  2846. bool load_certs();
  2847. tls::ctx_t ctx_ = nullptr;
  2848. std::mutex ctx_mutex_;
  2849. std::once_flag initialize_cert_;
  2850. // Tracks whether a custom CA store was applied via set_ca_cert_store(),
  2851. // since the store handle itself is owned by ctx_ and leaves no other trace.
  2852. // Used to keep custom CA configuration exclusive with system CA loading.
  2853. bool ca_cert_store_set_ = false;
  2854. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  2855. // Like ca_cert_store_set_, keeps what ctx_ cannot report back: the verifier
  2856. // set_server_certificate_verifier() installed there.
  2857. tls::VerifyCallback server_certificate_verifier_;
  2858. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2859. bool enable_windows_cert_verification_ = true;
  2860. #endif
  2861. friend class ClientImpl;
  2862. };
  2863. #endif // CPPHTTPLIB_SSL_ENABLED
  2864. namespace detail {
  2865. template <typename T, typename U>
  2866. inline void duration_to_sec_and_usec(const T &duration, U callback) {
  2867. auto sec = std::chrono::duration_cast<std::chrono::seconds>(duration).count();
  2868. auto usec = std::chrono::duration_cast<std::chrono::microseconds>(
  2869. duration - std::chrono::seconds(sec))
  2870. .count();
  2871. callback(static_cast<time_t>(sec), static_cast<time_t>(usec));
  2872. }
  2873. template <size_t N> inline constexpr size_t str_len(const char (&)[N]) {
  2874. return N - 1;
  2875. }
  2876. inline bool is_numeric(const std::string &str) {
  2877. return !str.empty() && std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  2878. }
  2879. // std::ranges::next(first, n, last) for C++11
  2880. template <typename It> inline It bounded_next(It first, size_t n, It last) {
  2881. for (; n > 0 && first != last; --n) {
  2882. ++first;
  2883. }
  2884. return first;
  2885. }
  2886. inline size_t get_header_value_u64(const Headers &headers,
  2887. const std::string &key, size_t def,
  2888. size_t id, bool &is_invalid_value) {
  2889. is_invalid_value = false;
  2890. auto rng = headers.equal_range(key);
  2891. auto it = bounded_next(rng.first, id, rng.second);
  2892. if (it != rng.second) {
  2893. if (is_numeric(it->second)) {
  2894. // Parse at size_t width so an out-of-range Content-Length is reported
  2895. // rather than silently saturated/truncated (a value above 2^32 would
  2896. // otherwise wrap to a small framing length on 32-bit builds). Flag it
  2897. // and return SIZE_MAX so the existing oversized-value guards reject it.
  2898. size_t val = 0;
  2899. const auto &s = it->second;
  2900. auto r = from_chars(s.data(), s.data() + s.size(), val);
  2901. if (r.ec == std::errc::result_out_of_range) {
  2902. is_invalid_value = true;
  2903. return (std::numeric_limits<size_t>::max)();
  2904. }
  2905. return val;
  2906. } else {
  2907. is_invalid_value = true;
  2908. }
  2909. }
  2910. return def;
  2911. }
  2912. inline size_t get_header_value_u64(const Headers &headers,
  2913. const std::string &key, size_t def,
  2914. size_t id) {
  2915. auto dummy = false;
  2916. return get_header_value_u64(headers, key, def, id, dummy);
  2917. }
  2918. } // namespace detail
  2919. template <class Rep, class Period>
  2920. inline Server &
  2921. Server::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2922. detail::duration_to_sec_and_usec(
  2923. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  2924. return *this;
  2925. }
  2926. template <class Rep, class Period>
  2927. inline Server &
  2928. Server::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2929. detail::duration_to_sec_and_usec(
  2930. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  2931. return *this;
  2932. }
  2933. template <class Rep, class Period>
  2934. inline Server &
  2935. Server::set_idle_interval(const std::chrono::duration<Rep, Period> &duration) {
  2936. detail::duration_to_sec_and_usec(
  2937. duration, [&](time_t sec, time_t usec) { set_idle_interval(sec, usec); });
  2938. return *this;
  2939. }
  2940. template <class Rep, class Period>
  2941. inline void ClientImpl::set_connection_timeout(
  2942. const std::chrono::duration<Rep, Period> &duration) {
  2943. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  2944. set_connection_timeout(sec, usec);
  2945. });
  2946. }
  2947. template <class Rep, class Period>
  2948. inline void ClientImpl::set_read_timeout(
  2949. const std::chrono::duration<Rep, Period> &duration) {
  2950. detail::duration_to_sec_and_usec(
  2951. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  2952. }
  2953. template <class Rep, class Period>
  2954. inline void ClientImpl::set_write_timeout(
  2955. const std::chrono::duration<Rep, Period> &duration) {
  2956. detail::duration_to_sec_and_usec(
  2957. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  2958. }
  2959. template <class Rep, class Period>
  2960. inline void ClientImpl::set_max_timeout(
  2961. const std::chrono::duration<Rep, Period> &duration) {
  2962. auto msec =
  2963. std::chrono::duration_cast<std::chrono::milliseconds>(duration).count();
  2964. set_max_timeout(msec);
  2965. }
  2966. template <class Rep, class Period>
  2967. inline void Client::set_connection_timeout(
  2968. const std::chrono::duration<Rep, Period> &duration) {
  2969. cli_->set_connection_timeout(duration);
  2970. }
  2971. template <class Rep, class Period>
  2972. inline void
  2973. Client::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2974. cli_->set_read_timeout(duration);
  2975. }
  2976. template <class Rep, class Period>
  2977. inline void
  2978. Client::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2979. cli_->set_write_timeout(duration);
  2980. }
  2981. inline void Client::set_max_timeout(time_t msec) {
  2982. cli_->set_max_timeout(msec);
  2983. }
  2984. template <class Rep, class Period>
  2985. inline void
  2986. Client::set_max_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2987. cli_->set_max_timeout(duration);
  2988. }
  2989. /*
  2990. * Forward declarations and types that will be part of the .h file if split into
  2991. * .h + .cc.
  2992. */
  2993. std::string hosted_at(const std::string &hostname);
  2994. void hosted_at(const std::string &hostname, std::vector<std::string> &addrs);
  2995. // JavaScript-style URL encoding/decoding functions
  2996. std::string encode_uri_component(const std::string &value);
  2997. std::string encode_uri(const std::string &value);
  2998. std::string decode_uri_component(const std::string &value);
  2999. std::string decode_uri(const std::string &value);
  3000. // RFC 3986 compliant URL component encoding/decoding functions
  3001. std::string encode_path_component(const std::string &component);
  3002. std::string decode_path_component(const std::string &component);
  3003. std::string encode_query_component(const std::string &component,
  3004. bool space_as_plus = true);
  3005. std::string decode_query_component(const std::string &component,
  3006. bool plus_as_space = true);
  3007. std::string sanitize_filename(const std::string &filename);
  3008. std::string append_query_params(const std::string &path, const Params &params);
  3009. std::pair<std::string, std::string> make_range_header(const Ranges &ranges);
  3010. std::pair<std::string, std::string>
  3011. make_basic_authentication_header(const std::string &username,
  3012. const std::string &password,
  3013. bool is_proxy = false);
  3014. namespace detail {
  3015. #if defined(_WIN32)
  3016. inline std::wstring u8string_to_wstring(const char *s) {
  3017. if (!s) { return std::wstring(); }
  3018. auto len = static_cast<int>(strlen(s));
  3019. if (!len) { return std::wstring(); }
  3020. auto wlen = ::MultiByteToWideChar(CP_UTF8, 0, s, len, nullptr, 0);
  3021. if (!wlen) { return std::wstring(); }
  3022. std::wstring ws;
  3023. ws.resize(wlen);
  3024. wlen = ::MultiByteToWideChar(
  3025. CP_UTF8, 0, s, len,
  3026. const_cast<LPWSTR>(reinterpret_cast<LPCWSTR>(ws.data())), wlen);
  3027. if (wlen != static_cast<int>(ws.size())) { ws.clear(); }
  3028. return ws;
  3029. }
  3030. #endif
  3031. struct FileStat {
  3032. FileStat(const std::string &path);
  3033. bool is_file() const;
  3034. bool is_dir() const;
  3035. time_t mtime() const;
  3036. size_t size() const;
  3037. private:
  3038. #if defined(_WIN32)
  3039. struct _stat st_;
  3040. #else
  3041. struct stat st_;
  3042. #endif
  3043. int ret_ = -1;
  3044. };
  3045. std::string make_host_and_port_string(const std::string &host, int port,
  3046. bool is_ssl);
  3047. template <typename T>
  3048. bool check_and_write_headers(Stream &strm, Headers &headers, T header_writer,
  3049. Error &error);
  3050. std::string trim_copy(const std::string &s);
  3051. void divide(
  3052. const char *data, std::size_t size, char d,
  3053. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3054. fn);
  3055. void divide(
  3056. const std::string &str, char d,
  3057. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3058. fn);
  3059. void split(const char *b, const char *e, char d,
  3060. std::function<void(const char *, const char *)> fn);
  3061. void split(const char *b, const char *e, char d, size_t m,
  3062. std::function<void(const char *, const char *)> fn);
  3063. bool split_find(const char *b, const char *e, char d,
  3064. std::function<bool(const char *, const char *)> fn);
  3065. bool has_header_token(const Headers &headers, const std::string &key,
  3066. const std::string &token);
  3067. std::string websocket_accept_key(const std::string &client_key);
  3068. bool is_websocket_upgrade(const Request &req);
  3069. bool process_client_socket(
  3070. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  3071. time_t write_timeout_sec, time_t write_timeout_usec,
  3072. time_t max_timeout_msec,
  3073. std::chrono::time_point<std::chrono::steady_clock> start_time,
  3074. std::function<bool(Stream &)> callback);
  3075. socket_t create_client_socket(const std::string &host, const std::string &ip,
  3076. int port, int address_family, bool tcp_nodelay,
  3077. bool ipv6_v6only, SocketOptions socket_options,
  3078. time_t connection_timeout_sec,
  3079. time_t connection_timeout_usec,
  3080. time_t read_timeout_sec, time_t read_timeout_usec,
  3081. time_t write_timeout_sec,
  3082. time_t write_timeout_usec,
  3083. const std::string &intf, Error &error);
  3084. const char *get_header_value(const Headers &headers, const std::string &key,
  3085. const char *def, size_t id);
  3086. std::string get_combined_header_value(const Headers &headers,
  3087. const std::string &key);
  3088. std::string params_to_query_str(const Params &params);
  3089. void parse_query_text(const char *data, std::size_t size, Params &params);
  3090. void parse_query_text(const std::string &s, Params &params);
  3091. bool parse_multipart_boundary(const std::string &content_type,
  3092. std::string &boundary);
  3093. bool parse_range_header(const std::string &s, Ranges &ranges);
  3094. bool parse_accept_header(const std::string &s,
  3095. std::vector<std::string> &content_types);
  3096. void parse_disposition_params(const std::string &s, Params &params);
  3097. ssize_t send_socket(socket_t sock, const void *ptr, size_t size, int flags);
  3098. ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags);
  3099. EncodingType encoding_type(const Request &req, const std::string &content_type);
  3100. EncodingType encoding_type(const Request &req, const Response &res,
  3101. const std::string &content_type);
  3102. EncodingType encoding_type(const Request &req, const Response &res);
  3103. class BufferStream final : public Stream {
  3104. public:
  3105. BufferStream() = default;
  3106. ~BufferStream() override = default;
  3107. bool is_readable() const override;
  3108. bool wait_readable() const override;
  3109. bool wait_writable() const override;
  3110. ssize_t read(char *ptr, size_t size) override;
  3111. ssize_t write(const char *ptr, size_t size) override;
  3112. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  3113. void get_local_ip_and_port(std::string &ip, int &port) const override;
  3114. socket_t socket() const override;
  3115. time_t duration() const override;
  3116. const std::string &get_buffer() const;
  3117. private:
  3118. std::string buffer;
  3119. size_t position = 0;
  3120. };
  3121. class compressor {
  3122. public:
  3123. virtual ~compressor() = default;
  3124. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3125. virtual bool compress(const char *data, size_t data_length, bool last,
  3126. Callback callback) = 0;
  3127. };
  3128. class decompressor {
  3129. public:
  3130. virtual ~decompressor() = default;
  3131. virtual bool is_valid() const = 0;
  3132. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3133. virtual bool decompress(const char *data, size_t data_length,
  3134. Callback callback) = 0;
  3135. };
  3136. class nocompressor final : public compressor {
  3137. public:
  3138. ~nocompressor() override = default;
  3139. bool compress(const char *data, size_t data_length, bool /*last*/,
  3140. Callback callback) override;
  3141. };
  3142. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  3143. class gzip_compressor final : public compressor {
  3144. public:
  3145. gzip_compressor();
  3146. ~gzip_compressor() override;
  3147. bool compress(const char *data, size_t data_length, bool last,
  3148. Callback callback) override;
  3149. private:
  3150. bool is_valid_ = false;
  3151. z_stream strm_;
  3152. };
  3153. class gzip_decompressor final : public decompressor {
  3154. public:
  3155. gzip_decompressor();
  3156. ~gzip_decompressor() override;
  3157. bool is_valid() const override;
  3158. bool decompress(const char *data, size_t data_length,
  3159. Callback callback) override;
  3160. private:
  3161. bool is_valid_ = false;
  3162. z_stream strm_;
  3163. };
  3164. #endif
  3165. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  3166. class brotli_compressor final : public compressor {
  3167. public:
  3168. brotli_compressor();
  3169. ~brotli_compressor();
  3170. bool compress(const char *data, size_t data_length, bool last,
  3171. Callback callback) override;
  3172. private:
  3173. BrotliEncoderState *state_ = nullptr;
  3174. };
  3175. class brotli_decompressor final : public decompressor {
  3176. public:
  3177. brotli_decompressor();
  3178. ~brotli_decompressor();
  3179. bool is_valid() const override;
  3180. bool decompress(const char *data, size_t data_length,
  3181. Callback callback) override;
  3182. private:
  3183. BrotliDecoderResult decoder_r;
  3184. BrotliDecoderState *decoder_s = nullptr;
  3185. };
  3186. #endif
  3187. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  3188. class zstd_compressor : public compressor {
  3189. public:
  3190. zstd_compressor();
  3191. ~zstd_compressor();
  3192. bool compress(const char *data, size_t data_length, bool last,
  3193. Callback callback) override;
  3194. private:
  3195. ZSTD_CCtx *ctx_ = nullptr;
  3196. };
  3197. class zstd_decompressor : public decompressor {
  3198. public:
  3199. zstd_decompressor();
  3200. ~zstd_decompressor();
  3201. bool is_valid() const override;
  3202. bool decompress(const char *data, size_t data_length,
  3203. Callback callback) override;
  3204. private:
  3205. ZSTD_DCtx *ctx_ = nullptr;
  3206. };
  3207. #endif
  3208. // NOTE: until the read size reaches `fixed_buffer_size`, use `fixed_buffer`
  3209. // to store data. The call can set memory on stack for performance.
  3210. class stream_line_reader {
  3211. public:
  3212. stream_line_reader(Stream &strm, char *fixed_buffer,
  3213. size_t fixed_buffer_size);
  3214. const char *ptr() const;
  3215. size_t size() const;
  3216. bool end_with_crlf() const;
  3217. bool getline();
  3218. private:
  3219. void append(char c);
  3220. void append(const char *data, size_t size);
  3221. Stream &strm_;
  3222. char *fixed_buffer_;
  3223. const size_t fixed_buffer_size_;
  3224. size_t fixed_buffer_used_size_ = 0;
  3225. std::string growable_buffer_;
  3226. };
  3227. bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  3228. const Headers &src_headers);
  3229. struct ChunkedDecoder {
  3230. Stream &strm;
  3231. size_t chunk_remaining = 0;
  3232. bool finished = false;
  3233. char line_buf[64];
  3234. size_t last_chunk_total = 0;
  3235. size_t last_chunk_offset = 0;
  3236. explicit ChunkedDecoder(Stream &s);
  3237. ssize_t read_payload(char *buf, size_t len, size_t &out_chunk_offset,
  3238. size_t &out_chunk_total);
  3239. bool parse_trailers_into(Headers &dest, const Headers &src_headers);
  3240. };
  3241. class mmap {
  3242. public:
  3243. mmap(const char *path);
  3244. ~mmap();
  3245. bool open(const char *path);
  3246. void close();
  3247. bool is_open() const;
  3248. size_t size() const;
  3249. const char *data() const;
  3250. private:
  3251. #if defined(_WIN32)
  3252. HANDLE hFile_ = NULL;
  3253. HANDLE hMapping_ = NULL;
  3254. #else
  3255. int fd_ = -1;
  3256. #endif
  3257. size_t size_ = 0;
  3258. void *addr_ = nullptr;
  3259. bool is_open_empty_file = false;
  3260. };
  3261. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  3262. namespace fields {
  3263. bool is_token_char(char c);
  3264. bool is_token(const std::string &s);
  3265. bool is_field_name(const std::string &s);
  3266. bool is_vchar(char c);
  3267. bool is_obs_text(char c);
  3268. bool is_field_vchar(char c);
  3269. bool is_field_content(const std::string &s);
  3270. bool is_field_value(const std::string &s);
  3271. bool is_field_valid(const std::string &name, const std::string &value);
  3272. bool is_request_target(const std::string &s);
  3273. bool is_host(const std::string &s);
  3274. } // namespace fields
  3275. } // namespace detail
  3276. /*
  3277. * TLS Abstraction Layer Declarations
  3278. */
  3279. #ifdef CPPHTTPLIB_SSL_ENABLED
  3280. // TLS abstraction layer - backend-specific type declarations
  3281. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  3282. namespace tls {
  3283. namespace impl {
  3284. // Mbed TLS context wrapper (holds config, entropy, DRBG, CA chain, own
  3285. // cert/key). This struct is accessible via tls::impl for use in SSL context
  3286. // setup callbacks (cast ctx_t to tls::impl::MbedTlsContext*).
  3287. struct MbedTlsContext {
  3288. mbedtls_ssl_config conf;
  3289. #ifndef CPPHTTPLIB_MBEDTLS_V4
  3290. // Mbed TLS 4.x uses PSA Crypto's internal RNG; no explicit entropy/DRBG.
  3291. mbedtls_entropy_context entropy;
  3292. mbedtls_ctr_drbg_context ctr_drbg;
  3293. #endif
  3294. mbedtls_x509_crt ca_chain;
  3295. mbedtls_x509_crt own_cert;
  3296. mbedtls_pk_context own_key;
  3297. bool is_server = false;
  3298. bool verify_client = false;
  3299. VerifyCallback verify_callback;
  3300. MbedTlsContext();
  3301. ~MbedTlsContext();
  3302. MbedTlsContext(const MbedTlsContext &) = delete;
  3303. MbedTlsContext &operator=(const MbedTlsContext &) = delete;
  3304. };
  3305. } // namespace impl
  3306. } // namespace tls
  3307. #endif
  3308. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  3309. namespace tls {
  3310. namespace impl {
  3311. // wolfSSL context wrapper (holds WOLFSSL_CTX and related state).
  3312. // This struct is accessible via tls::impl for use in SSL context
  3313. // setup callbacks (cast ctx_t to tls::impl::WolfSSLContext*).
  3314. struct WolfSSLContext {
  3315. WOLFSSL_CTX *ctx = nullptr;
  3316. bool is_server = false;
  3317. bool verify_client = false;
  3318. VerifyCallback verify_callback;
  3319. std::string ca_pem_data_; // accumulated PEM for get_ca_names/get_ca_certs
  3320. WolfSSLContext();
  3321. ~WolfSSLContext();
  3322. WolfSSLContext(const WolfSSLContext &) = delete;
  3323. WolfSSLContext &operator=(const WolfSSLContext &) = delete;
  3324. };
  3325. // CA store for wolfSSL: holds raw PEM bytes to allow reloading into any ctx
  3326. struct WolfSSLCAStore {
  3327. std::string pem_data;
  3328. };
  3329. } // namespace impl
  3330. } // namespace tls
  3331. #endif
  3332. #endif // CPPHTTPLIB_SSL_ENABLED
  3333. namespace stream {
  3334. class Result {
  3335. public:
  3336. Result();
  3337. explicit Result(ClientImpl::StreamHandle &&handle, size_t chunk_size = 8192);
  3338. Result(Result &&other) noexcept;
  3339. Result &operator=(Result &&other) noexcept;
  3340. Result(const Result &) = delete;
  3341. Result &operator=(const Result &) = delete;
  3342. // Response info
  3343. bool is_valid() const;
  3344. explicit operator bool() const;
  3345. int status() const;
  3346. const Headers &headers() const;
  3347. std::string get_header_value(const std::string &key,
  3348. const char *def = "") const;
  3349. bool has_header(const std::string &key) const;
  3350. Error error() const;
  3351. Error read_error() const;
  3352. bool has_read_error() const;
  3353. // Stream reading
  3354. bool next();
  3355. const char *data() const;
  3356. size_t size() const;
  3357. std::string read_all();
  3358. private:
  3359. ClientImpl::StreamHandle handle_;
  3360. std::string buffer_;
  3361. size_t current_size_ = 0;
  3362. size_t chunk_size_;
  3363. bool finished_ = false;
  3364. };
  3365. // GET
  3366. template <typename ClientType>
  3367. inline Result Get(ClientType &cli, const std::string &path,
  3368. size_t chunk_size = 8192) {
  3369. return Result{cli.open_stream("GET", path), chunk_size};
  3370. }
  3371. template <typename ClientType>
  3372. inline Result Get(ClientType &cli, const std::string &path,
  3373. const Headers &headers, size_t chunk_size = 8192) {
  3374. return Result{cli.open_stream("GET", path, {}, headers), chunk_size};
  3375. }
  3376. template <typename ClientType>
  3377. inline Result Get(ClientType &cli, const std::string &path,
  3378. const Params &params, size_t chunk_size = 8192) {
  3379. return Result{cli.open_stream("GET", path, params), chunk_size};
  3380. }
  3381. template <typename ClientType>
  3382. inline Result Get(ClientType &cli, const std::string &path,
  3383. const Params &params, const Headers &headers,
  3384. size_t chunk_size = 8192) {
  3385. return Result{cli.open_stream("GET", path, params, headers), chunk_size};
  3386. }
  3387. // POST
  3388. template <typename ClientType>
  3389. inline Result Post(ClientType &cli, const std::string &path,
  3390. const std::string &body, const std::string &content_type,
  3391. size_t chunk_size = 8192) {
  3392. return Result{cli.open_stream("POST", path, {}, {}, body, content_type),
  3393. chunk_size};
  3394. }
  3395. template <typename ClientType>
  3396. inline Result Post(ClientType &cli, const std::string &path,
  3397. const Headers &headers, const std::string &body,
  3398. const std::string &content_type, size_t chunk_size = 8192) {
  3399. return Result{cli.open_stream("POST", path, {}, headers, body, content_type),
  3400. chunk_size};
  3401. }
  3402. template <typename ClientType>
  3403. inline Result Post(ClientType &cli, const std::string &path,
  3404. const Params &params, const std::string &body,
  3405. const std::string &content_type, size_t chunk_size = 8192) {
  3406. return Result{cli.open_stream("POST", path, params, {}, body, content_type),
  3407. chunk_size};
  3408. }
  3409. template <typename ClientType>
  3410. inline Result Post(ClientType &cli, const std::string &path,
  3411. const Params &params, const Headers &headers,
  3412. const std::string &body, const std::string &content_type,
  3413. size_t chunk_size = 8192) {
  3414. return Result{
  3415. cli.open_stream("POST", path, params, headers, body, content_type),
  3416. chunk_size};
  3417. }
  3418. // PUT
  3419. template <typename ClientType>
  3420. inline Result Put(ClientType &cli, const std::string &path,
  3421. const std::string &body, const std::string &content_type,
  3422. size_t chunk_size = 8192) {
  3423. return Result{cli.open_stream("PUT", path, {}, {}, body, content_type),
  3424. chunk_size};
  3425. }
  3426. template <typename ClientType>
  3427. inline Result Put(ClientType &cli, const std::string &path,
  3428. const Headers &headers, const std::string &body,
  3429. const std::string &content_type, size_t chunk_size = 8192) {
  3430. return Result{cli.open_stream("PUT", path, {}, headers, body, content_type),
  3431. chunk_size};
  3432. }
  3433. template <typename ClientType>
  3434. inline Result Put(ClientType &cli, const std::string &path,
  3435. const Params &params, const std::string &body,
  3436. const std::string &content_type, size_t chunk_size = 8192) {
  3437. return Result{cli.open_stream("PUT", path, params, {}, body, content_type),
  3438. chunk_size};
  3439. }
  3440. template <typename ClientType>
  3441. inline Result Put(ClientType &cli, const std::string &path,
  3442. const Params &params, const Headers &headers,
  3443. const std::string &body, const std::string &content_type,
  3444. size_t chunk_size = 8192) {
  3445. return Result{
  3446. cli.open_stream("PUT", path, params, headers, body, content_type),
  3447. chunk_size};
  3448. }
  3449. // PATCH
  3450. template <typename ClientType>
  3451. inline Result Patch(ClientType &cli, const std::string &path,
  3452. const std::string &body, const std::string &content_type,
  3453. size_t chunk_size = 8192) {
  3454. return Result{cli.open_stream("PATCH", path, {}, {}, body, content_type),
  3455. chunk_size};
  3456. }
  3457. template <typename ClientType>
  3458. inline Result Patch(ClientType &cli, const std::string &path,
  3459. const Headers &headers, const std::string &body,
  3460. const std::string &content_type, size_t chunk_size = 8192) {
  3461. return Result{cli.open_stream("PATCH", path, {}, headers, body, content_type),
  3462. chunk_size};
  3463. }
  3464. template <typename ClientType>
  3465. inline Result Patch(ClientType &cli, const std::string &path,
  3466. const Params &params, const std::string &body,
  3467. const std::string &content_type, size_t chunk_size = 8192) {
  3468. return Result{cli.open_stream("PATCH", path, params, {}, body, content_type),
  3469. chunk_size};
  3470. }
  3471. template <typename ClientType>
  3472. inline Result Patch(ClientType &cli, const std::string &path,
  3473. const Params &params, const Headers &headers,
  3474. const std::string &body, const std::string &content_type,
  3475. size_t chunk_size = 8192) {
  3476. return Result{
  3477. cli.open_stream("PATCH", path, params, headers, body, content_type),
  3478. chunk_size};
  3479. }
  3480. // DELETE
  3481. template <typename ClientType>
  3482. inline Result Delete(ClientType &cli, const std::string &path,
  3483. size_t chunk_size = 8192) {
  3484. return Result{cli.open_stream("DELETE", path), chunk_size};
  3485. }
  3486. template <typename ClientType>
  3487. inline Result Delete(ClientType &cli, const std::string &path,
  3488. const Headers &headers, size_t chunk_size = 8192) {
  3489. return Result{cli.open_stream("DELETE", path, {}, headers), chunk_size};
  3490. }
  3491. template <typename ClientType>
  3492. inline Result Delete(ClientType &cli, const std::string &path,
  3493. const std::string &body, const std::string &content_type,
  3494. size_t chunk_size = 8192) {
  3495. return Result{cli.open_stream("DELETE", path, {}, {}, body, content_type),
  3496. chunk_size};
  3497. }
  3498. template <typename ClientType>
  3499. inline Result Delete(ClientType &cli, const std::string &path,
  3500. const Headers &headers, const std::string &body,
  3501. const std::string &content_type,
  3502. size_t chunk_size = 8192) {
  3503. return Result{
  3504. cli.open_stream("DELETE", path, {}, headers, body, content_type),
  3505. chunk_size};
  3506. }
  3507. template <typename ClientType>
  3508. inline Result Delete(ClientType &cli, const std::string &path,
  3509. const Params &params, size_t chunk_size = 8192) {
  3510. return Result{cli.open_stream("DELETE", path, params), chunk_size};
  3511. }
  3512. template <typename ClientType>
  3513. inline Result Delete(ClientType &cli, const std::string &path,
  3514. const Params &params, const Headers &headers,
  3515. size_t chunk_size = 8192) {
  3516. return Result{cli.open_stream("DELETE", path, params, headers), chunk_size};
  3517. }
  3518. template <typename ClientType>
  3519. inline Result Delete(ClientType &cli, const std::string &path,
  3520. const Params &params, const std::string &body,
  3521. const std::string &content_type,
  3522. size_t chunk_size = 8192) {
  3523. return Result{cli.open_stream("DELETE", path, params, {}, body, content_type),
  3524. chunk_size};
  3525. }
  3526. template <typename ClientType>
  3527. inline Result Delete(ClientType &cli, const std::string &path,
  3528. const Params &params, const Headers &headers,
  3529. const std::string &body, const std::string &content_type,
  3530. size_t chunk_size = 8192) {
  3531. return Result{
  3532. cli.open_stream("DELETE", path, params, headers, body, content_type),
  3533. chunk_size};
  3534. }
  3535. // HEAD
  3536. template <typename ClientType>
  3537. inline Result Head(ClientType &cli, const std::string &path,
  3538. size_t chunk_size = 8192) {
  3539. return Result{cli.open_stream("HEAD", path), chunk_size};
  3540. }
  3541. template <typename ClientType>
  3542. inline Result Head(ClientType &cli, const std::string &path,
  3543. const Headers &headers, size_t chunk_size = 8192) {
  3544. return Result{cli.open_stream("HEAD", path, {}, headers), chunk_size};
  3545. }
  3546. template <typename ClientType>
  3547. inline Result Head(ClientType &cli, const std::string &path,
  3548. const Params &params, size_t chunk_size = 8192) {
  3549. return Result{cli.open_stream("HEAD", path, params), chunk_size};
  3550. }
  3551. template <typename ClientType>
  3552. inline Result Head(ClientType &cli, const std::string &path,
  3553. const Params &params, const Headers &headers,
  3554. size_t chunk_size = 8192) {
  3555. return Result{cli.open_stream("HEAD", path, params, headers), chunk_size};
  3556. }
  3557. // OPTIONS
  3558. template <typename ClientType>
  3559. inline Result Options(ClientType &cli, const std::string &path,
  3560. size_t chunk_size = 8192) {
  3561. return Result{cli.open_stream("OPTIONS", path), chunk_size};
  3562. }
  3563. template <typename ClientType>
  3564. inline Result Options(ClientType &cli, const std::string &path,
  3565. const Headers &headers, size_t chunk_size = 8192) {
  3566. return Result{cli.open_stream("OPTIONS", path, {}, headers), chunk_size};
  3567. }
  3568. template <typename ClientType>
  3569. inline Result Options(ClientType &cli, const std::string &path,
  3570. const Params &params, size_t chunk_size = 8192) {
  3571. return Result{cli.open_stream("OPTIONS", path, params), chunk_size};
  3572. }
  3573. template <typename ClientType>
  3574. inline Result Options(ClientType &cli, const std::string &path,
  3575. const Params &params, const Headers &headers,
  3576. size_t chunk_size = 8192) {
  3577. return Result{cli.open_stream("OPTIONS", path, params, headers), chunk_size};
  3578. }
  3579. } // namespace stream
  3580. namespace sse {
  3581. struct SSEMessage {
  3582. std::string event; // Event type (default: "message")
  3583. std::string data; // Event payload
  3584. std::string id; // Event ID for Last-Event-ID header
  3585. SSEMessage();
  3586. void clear();
  3587. };
  3588. class SSEClient {
  3589. public:
  3590. using MessageHandler = std::function<void(const SSEMessage &)>;
  3591. using ErrorHandler = std::function<void(Error)>;
  3592. using OpenHandler = std::function<void()>;
  3593. SSEClient(Client &client, const std::string &path);
  3594. SSEClient(Client &client, const std::string &path, const Headers &headers);
  3595. ~SSEClient();
  3596. SSEClient(const SSEClient &) = delete;
  3597. SSEClient &operator=(const SSEClient &) = delete;
  3598. // Event handlers
  3599. SSEClient &on_message(MessageHandler handler);
  3600. SSEClient &on_event(const std::string &type, MessageHandler handler);
  3601. SSEClient &on_open(OpenHandler handler);
  3602. SSEClient &on_error(ErrorHandler handler);
  3603. SSEClient &set_reconnect_interval(int ms);
  3604. SSEClient &set_max_reconnect_attempts(int n);
  3605. // Update headers (thread-safe)
  3606. SSEClient &set_headers(const Headers &headers);
  3607. // State accessors
  3608. bool is_connected() const;
  3609. const std::string &last_event_id() const;
  3610. // Blocking start - runs event loop with auto-reconnect
  3611. void start();
  3612. // Non-blocking start - runs in background thread
  3613. void start_async();
  3614. // Stop the client (thread-safe)
  3615. void stop();
  3616. private:
  3617. bool parse_sse_line(const std::string &line, SSEMessage &msg, int &retry_ms,
  3618. bool &has_data, bool &has_id);
  3619. void run_event_loop();
  3620. void dispatch_event(const SSEMessage &msg);
  3621. bool should_reconnect(int count) const;
  3622. void wait_for_reconnect();
  3623. // Client and path
  3624. Client &client_;
  3625. std::string path_;
  3626. Headers headers_;
  3627. mutable std::mutex headers_mutex_;
  3628. // Callbacks
  3629. MessageHandler on_message_;
  3630. std::map<std::string, MessageHandler> event_handlers_;
  3631. OpenHandler on_open_;
  3632. ErrorHandler on_error_;
  3633. // Configuration
  3634. int reconnect_interval_ms_ = 3000;
  3635. int max_reconnect_attempts_ = 0; // 0 = unlimited
  3636. // State
  3637. std::atomic<bool> running_{false};
  3638. std::atomic<bool> connected_{false};
  3639. std::string last_event_id_;
  3640. // Async support
  3641. std::thread async_thread_;
  3642. };
  3643. } // namespace sse
  3644. namespace ws {
  3645. class WebSocketClient;
  3646. enum class Opcode : uint8_t {
  3647. Continuation = 0x0,
  3648. Text = 0x1,
  3649. Binary = 0x2,
  3650. Close = 0x8,
  3651. Ping = 0x9,
  3652. Pong = 0xA,
  3653. };
  3654. enum class CloseStatus : uint16_t {
  3655. Normal = 1000,
  3656. GoingAway = 1001,
  3657. ProtocolError = 1002,
  3658. UnsupportedData = 1003,
  3659. NoStatus = 1005,
  3660. Abnormal = 1006,
  3661. InvalidPayload = 1007,
  3662. PolicyViolation = 1008,
  3663. MessageTooBig = 1009,
  3664. MandatoryExtension = 1010,
  3665. InternalError = 1011,
  3666. };
  3667. // Timeout is returned only when a read timeout was set and it elapsed before
  3668. // any byte of a frame arrived: nothing was consumed and the connection is
  3669. // still open, so the caller can send on it and read again. `msg` is left
  3670. // untouched, so a `while (ws.read(msg))` loop must not treat it as a message.
  3671. enum ReadResult : int { Fail = 0, Text = 1, Binary = 2, Timeout = 3 };
  3672. // Result of WebSocketClient::connect(). Truthy only when the WebSocket
  3673. // upgrade handshake fully succeeded. On failure error() identifies the
  3674. // failing layer; status()/headers() expose the server's upgrade response
  3675. // when one was received (status() is -1 otherwise).
  3676. class Result {
  3677. public:
  3678. Result() = default;
  3679. Result(Error err, int status, Headers &&headers)
  3680. : err_(err), status_(status), headers_(std::move(headers)) {}
  3681. explicit operator bool() const { return err_ == Error::Success; }
  3682. Error error() const { return err_; }
  3683. // Upgrade response info
  3684. int status() const { return status_; }
  3685. const Headers &headers() const { return headers_; }
  3686. std::string get_header_value(const std::string &key,
  3687. const char *def = "") const {
  3688. return detail::get_header_value(headers_, key, def, 0);
  3689. }
  3690. bool has_header(const std::string &key) const {
  3691. return headers_.find(key) != headers_.end();
  3692. }
  3693. #ifdef CPPHTTPLIB_SSL_ENABLED
  3694. Result(Error err, int status, Headers &&headers, int ssl_error,
  3695. uint64_t ssl_backend_error)
  3696. : err_(err), status_(status), headers_(std::move(headers)),
  3697. ssl_error_(ssl_error), ssl_backend_error_(ssl_backend_error) {}
  3698. int ssl_error() const { return ssl_error_; }
  3699. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  3700. #endif
  3701. private:
  3702. Error err_ = Error::Unknown; // a default-constructed Result is falsy
  3703. int status_ = -1;
  3704. Headers headers_;
  3705. #ifdef CPPHTTPLIB_SSL_ENABLED
  3706. int ssl_error_ = 0;
  3707. uint64_t ssl_backend_error_ = 0;
  3708. #endif
  3709. };
  3710. class WebSocket {
  3711. public:
  3712. WebSocket(const WebSocket &) = delete;
  3713. WebSocket &operator=(const WebSocket &) = delete;
  3714. ~WebSocket();
  3715. ReadResult read(std::string &msg);
  3716. bool send(const std::string &data);
  3717. bool send(const char *data, size_t len);
  3718. void close(CloseStatus status = CloseStatus::Normal,
  3719. const std::string &reason = "");
  3720. const Request &request() const;
  3721. bool is_open() const;
  3722. // Bound how long read() waits before returning Timeout. 0 waits forever.
  3723. // A server handler owns its connection's timeout this way; a client sets it
  3724. // through WebSocketClient. Safe to call while another thread is in read().
  3725. //
  3726. // Only a timeout set here is reported as Timeout. The compile-time default
  3727. // (CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND) is a backstop rather
  3728. // than a request for control, so when it elapses read() returns Fail and
  3729. // closes the connection, and `while (ws.read(msg))` ends as it always has.
  3730. void set_read_timeout(time_t sec, time_t usec = 0);
  3731. template <class Rep, class Period>
  3732. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3733. private:
  3734. friend class httplib::Server;
  3735. friend class httplib::ws::WebSocketClient;
  3736. WebSocket(
  3737. Stream &strm, const Request &req, bool is_server,
  3738. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3739. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3740. : strm_(strm), req_(req), is_server_(is_server),
  3741. ping_interval_sec_(ping_interval_sec),
  3742. max_missed_pongs_(max_missed_pongs) {
  3743. start_heartbeat();
  3744. }
  3745. WebSocket(
  3746. std::unique_ptr<Stream> &&owned_strm, const Request &req, bool is_server,
  3747. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3748. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3749. : strm_(*owned_strm), owned_strm_(std::move(owned_strm)), req_(req),
  3750. is_server_(is_server), ping_interval_sec_(ping_interval_sec),
  3751. max_missed_pongs_(max_missed_pongs) {
  3752. start_heartbeat();
  3753. }
  3754. void start_heartbeat();
  3755. bool send_frame(Opcode op, const char *data, size_t len, bool fin = true);
  3756. Stream &strm_;
  3757. std::unique_ptr<Stream> owned_strm_;
  3758. Request req_;
  3759. bool is_server_;
  3760. time_t ping_interval_sec_;
  3761. int max_missed_pongs_;
  3762. int unacked_pings_ = 0;
  3763. std::atomic<bool> closed_{false};
  3764. // Set once the caller has bounded read() through set_read_timeout(). Until
  3765. // then the timeout in effect is the compile-time default, and elapsing it
  3766. // is a failure that closes the connection, not a Timeout.
  3767. std::atomic<bool> read_timeout_set_{false};
  3768. std::mutex write_mutex_;
  3769. // Owned by whichever thread is parsing frames off strm_. Only one thread
  3770. // may do so: read_websocket_frame() reads a payload until it has the whole
  3771. // declared length, so a second parser stealing bytes silently corrupts the
  3772. // message the first one is assembling.
  3773. std::mutex read_mutex_;
  3774. std::thread ping_thread_;
  3775. std::mutex ping_mutex_;
  3776. std::condition_variable ping_cv_;
  3777. };
  3778. class WebSocketClient {
  3779. public:
  3780. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3781. const Headers &headers = {});
  3782. ~WebSocketClient();
  3783. WebSocketClient(const WebSocketClient &) = delete;
  3784. WebSocketClient &operator=(const WebSocketClient &) = delete;
  3785. bool is_valid() const;
  3786. Result connect();
  3787. ReadResult read(std::string &msg);
  3788. bool send(const std::string &data);
  3789. bool send(const char *data, size_t len);
  3790. void close(CloseStatus status = CloseStatus::Normal,
  3791. const std::string &reason = "");
  3792. bool is_open() const;
  3793. const std::string &subprotocol() const;
  3794. void set_read_timeout(time_t sec, time_t usec = 0);
  3795. template <class Rep, class Period>
  3796. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3797. void set_write_timeout(time_t sec, time_t usec = 0);
  3798. template <class Rep, class Period>
  3799. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  3800. void set_websocket_ping_interval(time_t sec);
  3801. void set_websocket_max_missed_pongs(int count);
  3802. void set_tcp_nodelay(bool on);
  3803. void set_address_family(int family);
  3804. void set_ipv6_v6only(bool on);
  3805. void set_socket_options(SocketOptions socket_options);
  3806. void set_connection_timeout(time_t sec, time_t usec = 0);
  3807. template <class Rep, class Period>
  3808. void
  3809. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  3810. void set_interface(const std::string &intf);
  3811. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  3812. #ifdef CPPHTTPLIB_SSL_ENABLED
  3813. struct PemMemory {
  3814. const char *cert_pem;
  3815. size_t cert_pem_len;
  3816. const char *key_pem;
  3817. size_t key_pem_len;
  3818. const char *private_key_password;
  3819. };
  3820. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3821. const PemMemory &pem, const Headers &headers = {});
  3822. void set_ca_cert_path(const std::string &ca_cert_file_path,
  3823. const std::string &ca_cert_dir_path = std::string());
  3824. void set_ca_cert_store(tls::ca_store_t store);
  3825. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  3826. void enable_server_certificate_verification(bool enabled);
  3827. void enable_server_hostname_verification(bool enabled);
  3828. void enable_system_ca(bool enabled);
  3829. #endif
  3830. private:
  3831. void shutdown_and_close();
  3832. bool create_stream(std::unique_ptr<Stream> &strm, Error &error,
  3833. int &ssl_error, uint64_t &ssl_backend_error);
  3834. void prepare_default_headers(Request &req);
  3835. std::string host_;
  3836. int port_;
  3837. std::string path_;
  3838. Headers headers_;
  3839. std::string subprotocol_;
  3840. bool is_valid_ = false;
  3841. socket_t sock_ = INVALID_SOCKET;
  3842. std::unique_ptr<WebSocket> ws_;
  3843. time_t read_timeout_sec_ = CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND;
  3844. time_t read_timeout_usec_ = 0;
  3845. bool read_timeout_set_ = false; // see WebSocket::read_timeout_set_
  3846. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  3847. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  3848. time_t websocket_ping_interval_sec_ =
  3849. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  3850. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  3851. int address_family_ = AF_UNSPEC;
  3852. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  3853. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  3854. SocketOptions socket_options_ = nullptr;
  3855. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  3856. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  3857. std::string interface_;
  3858. // Hostname to connection target map. The value is an IP literal or another
  3859. // hostname; only the connection target changes, never the identity.
  3860. std::map<std::string, std::string> addr_map_;
  3861. #ifdef CPPHTTPLIB_SSL_ENABLED
  3862. bool is_ssl_ = false;
  3863. tls::ctx_t tls_ctx_ = nullptr;
  3864. tls::session_t tls_session_ = nullptr;
  3865. std::string ca_cert_file_path_;
  3866. std::string ca_cert_dir_path_;
  3867. bool custom_ca_loaded_ = false;
  3868. bool certs_loaded_ = false;
  3869. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  3870. bool server_certificate_verification_ = true;
  3871. bool server_hostname_verification_ = true;
  3872. #endif
  3873. };
  3874. template <class Rep, class Period>
  3875. inline void WebSocket::set_read_timeout(
  3876. const std::chrono::duration<Rep, Period> &duration) {
  3877. detail::duration_to_sec_and_usec(
  3878. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3879. }
  3880. template <class Rep, class Period>
  3881. inline void WebSocketClient::set_read_timeout(
  3882. const std::chrono::duration<Rep, Period> &duration) {
  3883. detail::duration_to_sec_and_usec(
  3884. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3885. }
  3886. template <class Rep, class Period>
  3887. inline void WebSocketClient::set_write_timeout(
  3888. const std::chrono::duration<Rep, Period> &duration) {
  3889. detail::duration_to_sec_and_usec(
  3890. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3891. }
  3892. template <class Rep, class Period>
  3893. inline void WebSocketClient::set_connection_timeout(
  3894. const std::chrono::duration<Rep, Period> &duration) {
  3895. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  3896. set_connection_timeout(sec, usec);
  3897. });
  3898. }
  3899. namespace impl {
  3900. bool is_valid_utf8(const std::string &s);
  3901. // Three states, because a failure that consumed bytes and one that consumed
  3902. // none are not the same thing: the first has left the stream in the middle of
  3903. // a frame and the connection cannot be reused, the second can just be retried.
  3904. enum class FrameRead { Ok, Fail, Timeout };
  3905. FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  3906. std::string &payload, bool &fin,
  3907. bool expect_masked, size_t max_len);
  3908. } // namespace impl
  3909. } // namespace ws
  3910. // ----------------------------------------------------------------------------
  3911. /*
  3912. * Implementation that will be part of the .cc file if split into .h + .cc.
  3913. */
  3914. namespace stream {
  3915. // stream::Result implementations
  3916. inline Result::Result() : chunk_size_(8192) {}
  3917. inline Result::Result(ClientImpl::StreamHandle &&handle, size_t chunk_size)
  3918. : handle_(std::move(handle)), chunk_size_(chunk_size) {}
  3919. inline Result::Result(Result &&other) noexcept
  3920. : handle_(std::move(other.handle_)), buffer_(std::move(other.buffer_)),
  3921. current_size_(other.current_size_), chunk_size_(other.chunk_size_),
  3922. finished_(other.finished_) {
  3923. other.current_size_ = 0;
  3924. other.finished_ = true;
  3925. }
  3926. inline Result &Result::operator=(Result &&other) noexcept {
  3927. if (this != &other) {
  3928. handle_ = std::move(other.handle_);
  3929. buffer_ = std::move(other.buffer_);
  3930. current_size_ = other.current_size_;
  3931. chunk_size_ = other.chunk_size_;
  3932. finished_ = other.finished_;
  3933. other.current_size_ = 0;
  3934. other.finished_ = true;
  3935. }
  3936. return *this;
  3937. }
  3938. inline bool Result::is_valid() const { return handle_.is_valid(); }
  3939. inline Result::operator bool() const { return is_valid(); }
  3940. inline int Result::status() const {
  3941. return handle_.response ? handle_.response->status : -1;
  3942. }
  3943. inline const Headers &Result::headers() const {
  3944. static const Headers empty_headers;
  3945. return handle_.response ? handle_.response->headers : empty_headers;
  3946. }
  3947. inline std::string Result::get_header_value(const std::string &key,
  3948. const char *def) const {
  3949. return handle_.response ? handle_.response->get_header_value(key, def) : def;
  3950. }
  3951. inline bool Result::has_header(const std::string &key) const {
  3952. return handle_.response ? handle_.response->has_header(key) : false;
  3953. }
  3954. inline Error Result::error() const { return handle_.error; }
  3955. inline Error Result::read_error() const { return handle_.get_read_error(); }
  3956. inline bool Result::has_read_error() const { return handle_.has_read_error(); }
  3957. inline bool Result::next() {
  3958. if (!handle_.is_valid() || finished_) { return false; }
  3959. if (buffer_.size() < chunk_size_) { buffer_.resize(chunk_size_); }
  3960. ssize_t n = handle_.read(&buffer_[0], chunk_size_);
  3961. if (n > 0) {
  3962. current_size_ = static_cast<size_t>(n);
  3963. return true;
  3964. }
  3965. current_size_ = 0;
  3966. finished_ = true;
  3967. return false;
  3968. }
  3969. inline const char *Result::data() const { return buffer_.data(); }
  3970. inline size_t Result::size() const { return current_size_; }
  3971. inline std::string Result::read_all() {
  3972. std::string result;
  3973. while (next()) {
  3974. result.append(data(), size());
  3975. }
  3976. return result;
  3977. }
  3978. } // namespace stream
  3979. namespace sse {
  3980. // SSEMessage implementations
  3981. inline SSEMessage::SSEMessage() : event("message") {}
  3982. inline void SSEMessage::clear() {
  3983. event = "message";
  3984. data.clear();
  3985. id.clear();
  3986. }
  3987. // SSEClient implementations
  3988. inline SSEClient::SSEClient(Client &client, const std::string &path)
  3989. : client_(client), path_(path) {}
  3990. inline SSEClient::SSEClient(Client &client, const std::string &path,
  3991. const Headers &headers)
  3992. : client_(client), path_(path), headers_(headers) {}
  3993. inline SSEClient::~SSEClient() { stop(); }
  3994. inline SSEClient &SSEClient::on_message(MessageHandler handler) {
  3995. on_message_ = std::move(handler);
  3996. return *this;
  3997. }
  3998. inline SSEClient &SSEClient::on_event(const std::string &type,
  3999. MessageHandler handler) {
  4000. event_handlers_[type] = std::move(handler);
  4001. return *this;
  4002. }
  4003. inline SSEClient &SSEClient::on_open(OpenHandler handler) {
  4004. on_open_ = std::move(handler);
  4005. return *this;
  4006. }
  4007. inline SSEClient &SSEClient::on_error(ErrorHandler handler) {
  4008. on_error_ = std::move(handler);
  4009. return *this;
  4010. }
  4011. inline SSEClient &SSEClient::set_reconnect_interval(int ms) {
  4012. reconnect_interval_ms_ = ms;
  4013. return *this;
  4014. }
  4015. inline SSEClient &SSEClient::set_max_reconnect_attempts(int n) {
  4016. max_reconnect_attempts_ = n;
  4017. return *this;
  4018. }
  4019. inline SSEClient &SSEClient::set_headers(const Headers &headers) {
  4020. std::lock_guard<std::mutex> lock(headers_mutex_);
  4021. headers_ = headers;
  4022. return *this;
  4023. }
  4024. inline bool SSEClient::is_connected() const { return connected_.load(); }
  4025. inline const std::string &SSEClient::last_event_id() const {
  4026. return last_event_id_;
  4027. }
  4028. inline void SSEClient::start() {
  4029. running_.store(true);
  4030. run_event_loop();
  4031. }
  4032. inline void SSEClient::start_async() {
  4033. running_.store(true);
  4034. async_thread_ = std::thread([this]() { run_event_loop(); });
  4035. }
  4036. inline void SSEClient::stop() {
  4037. running_.store(false);
  4038. client_.stop(); // Cancel any pending operations
  4039. if (async_thread_.joinable()) { async_thread_.join(); }
  4040. }
  4041. inline bool SSEClient::parse_sse_line(const std::string &line, SSEMessage &msg,
  4042. int &retry_ms, bool &has_data,
  4043. bool &has_id) {
  4044. // Blank line signals end of event
  4045. if (line.empty()) { return true; }
  4046. // Lines starting with ':' are comments (ignored)
  4047. if (line[0] == ':') { return false; }
  4048. // Find the colon separator
  4049. auto colon_pos = line.find(':');
  4050. auto field = line.substr(0, colon_pos);
  4051. std::string value;
  4052. // Value starts after colon, skip optional single space
  4053. if (colon_pos != std::string::npos && colon_pos + 1 < line.size()) {
  4054. auto value_start = colon_pos + 1;
  4055. if (line[value_start] == ' ') { value_start++; }
  4056. value = line.substr(value_start);
  4057. }
  4058. // Handle known fields
  4059. if (field == "event") {
  4060. msg.event = value;
  4061. } else if (field == "data") {
  4062. // Multiple data lines are concatenated with newlines
  4063. if (has_data) { msg.data += "\n"; }
  4064. msg.data += value;
  4065. has_data = true;
  4066. } else if (field == "id") {
  4067. // An id that cannot be sent back as Last-Event-ID is ignored. Empty id is
  4068. // valid (clears the last event ID)
  4069. if (detail::fields::is_field_value(value)) {
  4070. msg.id = value;
  4071. has_id = true;
  4072. }
  4073. } else if (field == "retry") {
  4074. // Parse retry interval in milliseconds
  4075. // Per the SSE spec, a value that is not all ASCII digits is ignored.
  4076. if (detail::is_numeric(value)) {
  4077. int v = 0;
  4078. auto res =
  4079. detail::from_chars(value.data(), value.data() + value.size(), v);
  4080. if (res.ec == std::errc{}) { retry_ms = v; }
  4081. }
  4082. }
  4083. // Unknown fields are ignored per SSE spec
  4084. return false;
  4085. }
  4086. inline void SSEClient::run_event_loop() {
  4087. auto reconnect_count = 0;
  4088. while (running_.load()) {
  4089. // Build headers, including Last-Event-ID if we have one
  4090. Headers request_headers;
  4091. {
  4092. std::lock_guard<std::mutex> lock(headers_mutex_);
  4093. request_headers = headers_;
  4094. }
  4095. if (!last_event_id_.empty()) {
  4096. request_headers.emplace("Last-Event-ID", last_event_id_);
  4097. }
  4098. // Open streaming connection
  4099. auto result = stream::Get(client_, path_, request_headers);
  4100. // Connection error handling
  4101. if (!result) {
  4102. connected_.store(false);
  4103. if (on_error_) { on_error_(result.error()); }
  4104. if (!should_reconnect(reconnect_count)) { break; }
  4105. wait_for_reconnect();
  4106. reconnect_count++;
  4107. continue;
  4108. }
  4109. if (result.status() != StatusCode::OK_200) {
  4110. connected_.store(false);
  4111. if (on_error_) { on_error_(Error::Connection); }
  4112. // For certain errors, don't reconnect.
  4113. // Note: 401 is intentionally absent so that handlers can refresh
  4114. // credentials via set_headers() and let the client reconnect.
  4115. if (result.status() == StatusCode::NoContent_204 ||
  4116. result.status() == StatusCode::NotFound_404 ||
  4117. result.status() == StatusCode::Forbidden_403) {
  4118. break;
  4119. }
  4120. if (!should_reconnect(reconnect_count)) { break; }
  4121. wait_for_reconnect();
  4122. reconnect_count++;
  4123. continue;
  4124. }
  4125. // Connection successful
  4126. connected_.store(true);
  4127. reconnect_count = 0;
  4128. if (on_open_) { on_open_(); }
  4129. // Event receiving loop
  4130. std::string buffer;
  4131. SSEMessage current_msg;
  4132. auto has_data = false;
  4133. auto has_id = false;
  4134. auto first_line = true;
  4135. auto after_cr = false;
  4136. while (running_.load() && result.next()) {
  4137. // What is left in the buffer has no line ending
  4138. auto search_pos = buffer.size();
  4139. buffer.append(result.data(), result.size());
  4140. // Process complete lines in the buffer. A line ends with \r\n, \n or \r
  4141. // per the SSE spec
  4142. size_t line_start = 0;
  4143. size_t eol_pos;
  4144. while ((eol_pos = buffer.find_first_of("\r\n", search_pos)) !=
  4145. std::string::npos) {
  4146. auto line = buffer.substr(line_start, eol_pos - line_start);
  4147. line_start = eol_pos + 1;
  4148. search_pos = line_start;
  4149. // The \n of a \r\n may arrive in a later chunk than its \r
  4150. auto is_lf_of_crlf =
  4151. after_cr && line.empty() && buffer[eol_pos] == '\n';
  4152. after_cr = buffer[eol_pos] == '\r';
  4153. if (is_lf_of_crlf) { continue; }
  4154. // A UTF-8 BOM at the start of the stream is ignored per the SSE spec
  4155. if (first_line) {
  4156. first_line = false;
  4157. if (line.compare(0, 3, "\xEF\xBB\xBF") == 0) { line.erase(0, 3); }
  4158. }
  4159. // Parse the line and check if event is complete
  4160. auto event_complete = parse_sse_line(
  4161. line, current_msg, reconnect_interval_ms_, has_data, has_id);
  4162. if (event_complete) {
  4163. // Update last_event_id for reconnection, even for an event that
  4164. // has no data. An empty id clears it.
  4165. if (has_id) { last_event_id_ = current_msg.id; }
  4166. // An event without a data field is not dispatched
  4167. if (has_data) { dispatch_event(current_msg); }
  4168. // Reset the message for the next event either way
  4169. current_msg.clear();
  4170. has_data = false;
  4171. has_id = false;
  4172. }
  4173. }
  4174. // Keep unprocessed data in buffer
  4175. buffer.erase(0, line_start);
  4176. }
  4177. // Connection ended
  4178. connected_.store(false);
  4179. if (!running_.load()) { break; }
  4180. // Check for read errors
  4181. if (result.has_read_error()) {
  4182. if (on_error_) { on_error_(result.read_error()); }
  4183. }
  4184. if (!should_reconnect(reconnect_count)) { break; }
  4185. wait_for_reconnect();
  4186. reconnect_count++;
  4187. }
  4188. connected_.store(false);
  4189. }
  4190. inline void SSEClient::dispatch_event(const SSEMessage &msg) {
  4191. // Check for specific event type handler first
  4192. auto it = event_handlers_.find(msg.event);
  4193. if (it != event_handlers_.end()) {
  4194. it->second(msg);
  4195. return;
  4196. }
  4197. // Fall back to generic message handler
  4198. if (on_message_) { on_message_(msg); }
  4199. }
  4200. inline bool SSEClient::should_reconnect(int count) const {
  4201. if (!running_.load()) { return false; }
  4202. if (max_reconnect_attempts_ == 0) { return true; } // unlimited
  4203. return count < max_reconnect_attempts_;
  4204. }
  4205. inline void SSEClient::wait_for_reconnect() {
  4206. // Use small increments to check running_ flag frequently.
  4207. // Always wait at least one increment, so that a zero interval (e.g.
  4208. // "retry: 0" from the server) cannot cause a busy reconnect loop.
  4209. const auto step_ms = 100;
  4210. auto interval_ms = (std::max)(reconnect_interval_ms_, step_ms);
  4211. auto waited = 0;
  4212. while (running_.load() && waited < interval_ms) {
  4213. std::this_thread::sleep_for(std::chrono::milliseconds(step_ms));
  4214. waited += step_ms;
  4215. }
  4216. }
  4217. } // namespace sse
  4218. #ifdef CPPHTTPLIB_SSL_ENABLED
  4219. /*
  4220. * TLS abstraction layer - internal function declarations
  4221. * These are implementation details and not part of the public API.
  4222. */
  4223. namespace tls {
  4224. // Client context
  4225. ctx_t create_client_context();
  4226. void free_context(ctx_t ctx);
  4227. bool set_min_version(ctx_t ctx, Version version);
  4228. bool load_ca_pem(ctx_t ctx, const char *pem, size_t len);
  4229. bool load_ca_file(ctx_t ctx, const char *file_path);
  4230. bool load_ca_dir(ctx_t ctx, const char *dir_path);
  4231. bool load_system_certs(ctx_t ctx);
  4232. bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4233. const char *password);
  4234. bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  4235. const char *key_path, const char *password);
  4236. // Server context
  4237. ctx_t create_server_context();
  4238. bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4239. const char *password);
  4240. bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  4241. const char *key_path, const char *password);
  4242. bool set_client_ca_file(ctx_t ctx, const char *ca_file, const char *ca_dir);
  4243. void set_verify_client(ctx_t ctx, bool require);
  4244. // Session management
  4245. session_t create_session(ctx_t ctx, socket_t sock);
  4246. void free_session(session_t session);
  4247. bool set_sni(session_t session, const char *hostname, bool verify_hostname);
  4248. // Handshake (non-blocking capable)
  4249. TlsError connect(session_t session);
  4250. TlsError accept(session_t session);
  4251. // Handshake with timeout (blocking until timeout)
  4252. bool connect_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4253. time_t timeout_usec, TlsError *err);
  4254. bool accept_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4255. time_t timeout_usec, TlsError *err);
  4256. // I/O (non-blocking capable)
  4257. ssize_t read(session_t session, void *buf, size_t len, TlsError &err);
  4258. ssize_t write(session_t session, const void *buf, size_t len, TlsError &err);
  4259. int pending(const_session_t session);
  4260. void shutdown(session_t session, bool graceful);
  4261. // Connection state
  4262. bool is_peer_closed(session_t session, socket_t sock);
  4263. // Certificate verification
  4264. cert_t get_peer_cert(const_session_t session);
  4265. // The certificates the peer sent, leaf first. Free each with free_cert(), and
  4266. // do not use them after free_session(), as with get_peer_cert().
  4267. size_t get_peer_certs(const_session_t session, std::vector<cert_t> &certs);
  4268. void free_cert(cert_t cert);
  4269. bool verify_hostname(cert_t cert, const char *hostname);
  4270. uint64_t hostname_mismatch_code();
  4271. long get_verify_result(const_session_t session);
  4272. // Certificate introspection
  4273. std::string get_cert_subject_cn(cert_t cert);
  4274. std::string get_cert_issuer_name(cert_t cert);
  4275. bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans);
  4276. bool get_cert_validity(cert_t cert, time_t &not_before, time_t &not_after);
  4277. std::string get_cert_serial(cert_t cert);
  4278. bool get_cert_der(cert_t cert, std::vector<unsigned char> &der);
  4279. const char *get_sni(const_session_t session);
  4280. // CA store management
  4281. ca_store_t create_ca_store(const char *pem, size_t len);
  4282. void free_ca_store(ca_store_t store);
  4283. bool set_ca_store(ctx_t ctx, ca_store_t store);
  4284. size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs);
  4285. std::vector<std::string> get_ca_names(ctx_t ctx);
  4286. // Dynamic certificate update (for servers)
  4287. bool update_server_cert(ctx_t ctx, const char *cert_pem, const char *key_pem,
  4288. const char *password);
  4289. bool update_server_client_ca(ctx_t ctx, const char *ca_pem);
  4290. // Certificate verification callback
  4291. bool set_verify_callback(ctx_t ctx, VerifyCallback callback);
  4292. long get_verify_error(const_session_t session);
  4293. std::string verify_error_string(long error_code);
  4294. // TlsError information
  4295. uint64_t peek_error();
  4296. uint64_t get_error();
  4297. std::string error_string(uint64_t code);
  4298. } // namespace tls
  4299. #endif // CPPHTTPLIB_SSL_ENABLED
  4300. /*
  4301. * Group 1: detail namespace - Non-SSL utilities
  4302. */
  4303. namespace detail {
  4304. inline bool set_socket_opt_impl(socket_t sock, int level, int optname,
  4305. const void *optval, socklen_t optlen) {
  4306. return setsockopt(sock, level, optname,
  4307. #ifdef _WIN32
  4308. reinterpret_cast<const char *>(optval),
  4309. #else
  4310. optval,
  4311. #endif
  4312. optlen) == 0;
  4313. }
  4314. inline bool set_socket_opt_time(socket_t sock, int level, int optname,
  4315. time_t sec, time_t usec) {
  4316. #ifdef _WIN32
  4317. auto timeout = static_cast<uint32_t>(sec * 1000 + usec / 1000);
  4318. #else
  4319. timeval timeout;
  4320. timeout.tv_sec = static_cast<long>(sec);
  4321. timeout.tv_usec = static_cast<decltype(timeout.tv_usec)>(usec);
  4322. #endif
  4323. return set_socket_opt_impl(sock, level, optname, &timeout, sizeof(timeout));
  4324. }
  4325. inline bool is_hex(char c, int &v) {
  4326. if (is_ascii_digit(c)) {
  4327. v = c - '0';
  4328. return true;
  4329. } else if ('A' <= c && c <= 'F') {
  4330. v = c - 'A' + 10;
  4331. return true;
  4332. } else if ('a' <= c && c <= 'f') {
  4333. v = c - 'a' + 10;
  4334. return true;
  4335. }
  4336. return false;
  4337. }
  4338. inline bool from_hex_to_i(const std::string &s, size_t i, size_t cnt,
  4339. int &val) {
  4340. if (i >= s.size()) { return false; }
  4341. val = 0;
  4342. for (; cnt; i++, cnt--) {
  4343. if (!s[i]) { return false; }
  4344. auto v = 0;
  4345. if (is_hex(s[i], v)) {
  4346. val = val * 16 + v;
  4347. } else {
  4348. return false;
  4349. }
  4350. }
  4351. return true;
  4352. }
  4353. inline std::string from_i_to_hex(size_t n) {
  4354. static const auto charset = "0123456789abcdef";
  4355. std::string ret;
  4356. do {
  4357. ret = charset[n & 15] + ret;
  4358. n >>= 4;
  4359. } while (n > 0);
  4360. return ret;
  4361. }
  4362. inline std::string compute_etag(const FileStat &fs,
  4363. const std::string &suffix = std::string()) {
  4364. if (!fs.is_file()) { return std::string(); }
  4365. // If mtime cannot be determined (negative value indicates an error
  4366. // or sentinel), do not generate an ETag. Returning a neutral / fixed
  4367. // value like 0 could collide with a real file that legitimately has
  4368. // mtime == 0 (epoch) and lead to misleading validators.
  4369. auto mtime_raw = fs.mtime();
  4370. if (mtime_raw < 0) { return std::string(); }
  4371. auto mtime = static_cast<size_t>(mtime_raw);
  4372. auto size = fs.size();
  4373. return std::string("W/\"") + from_i_to_hex(mtime) + "-" +
  4374. from_i_to_hex(size) + suffix + "\"";
  4375. }
  4376. // Format time_t as HTTP-date (RFC 9110 Section 5.6.7): "Sun, 06 Nov 1994
  4377. // 08:49:37 GMT" This implementation is defensive: it validates `mtime`, checks
  4378. // return values from `gmtime_r`/`gmtime_s`, and ensures `strftime` succeeds.
  4379. inline std::string file_mtime_to_http_date(time_t mtime) {
  4380. if (mtime < 0) { return std::string(); }
  4381. struct tm tm_buf;
  4382. #ifdef _WIN32
  4383. if (gmtime_s(&tm_buf, &mtime) != 0) { return std::string(); }
  4384. #else
  4385. if (gmtime_r(&mtime, &tm_buf) == nullptr) { return std::string(); }
  4386. #endif
  4387. char buf[64];
  4388. if (strftime(buf, sizeof(buf), "%a, %d %b %Y %H:%M:%S GMT", &tm_buf) == 0) {
  4389. return std::string();
  4390. }
  4391. return std::string(buf);
  4392. }
  4393. // Parse HTTP-date (RFC 9110 Section 5.6.7) to time_t. Returns -1 on failure.
  4394. inline time_t parse_http_date(const std::string &date_str) {
  4395. struct tm tm_buf;
  4396. // Create a classic locale object once for all parsing attempts
  4397. const std::locale classic_locale = std::locale::classic();
  4398. // Try to parse using std::get_time (C++11, cross-platform)
  4399. auto try_parse = [&](const char *fmt) -> bool {
  4400. std::istringstream ss(date_str);
  4401. ss.imbue(classic_locale);
  4402. memset(&tm_buf, 0, sizeof(tm_buf));
  4403. ss >> std::get_time(&tm_buf, fmt);
  4404. return !ss.fail();
  4405. };
  4406. // RFC 9110 preferred format (HTTP-date): "Sun, 06 Nov 1994 08:49:37 GMT"
  4407. if (!try_parse("%a, %d %b %Y %H:%M:%S")) {
  4408. // RFC 850 format: "Sunday, 06-Nov-94 08:49:37 GMT"
  4409. if (!try_parse("%A, %d-%b-%y %H:%M:%S")) {
  4410. // asctime format: "Sun Nov 6 08:49:37 1994"
  4411. if (!try_parse("%a %b %d %H:%M:%S %Y")) {
  4412. return static_cast<time_t>(-1);
  4413. }
  4414. }
  4415. }
  4416. #ifdef _WIN32
  4417. return _mkgmtime(&tm_buf);
  4418. #elif defined _AIX
  4419. return mktime(&tm_buf);
  4420. #else
  4421. return timegm(&tm_buf);
  4422. #endif
  4423. }
  4424. inline bool is_weak_etag(const std::string &s) {
  4425. // Check if the string is a weak ETag (starts with 'W/"')
  4426. return s.size() > 3 && s[0] == 'W' && s[1] == '/' && s[2] == '"';
  4427. }
  4428. inline bool is_strong_etag(const std::string &s) {
  4429. // Check if the string is a strong ETag (starts and ends with '"', at least 2
  4430. // chars)
  4431. return s.size() >= 2 && s[0] == '"' && s.back() == '"';
  4432. }
  4433. inline size_t to_utf8(int code, char *buff) {
  4434. if (code < 0x0080) {
  4435. buff[0] = static_cast<char>(code & 0x7F);
  4436. return 1;
  4437. } else if (code < 0x0800) {
  4438. buff[0] = static_cast<char>(0xC0 | ((code >> 6) & 0x1F));
  4439. buff[1] = static_cast<char>(0x80 | (code & 0x3F));
  4440. return 2;
  4441. } else if (code < 0xD800) {
  4442. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4443. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4444. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4445. return 3;
  4446. } else if (code < 0xE000) { // D800 - DFFF is invalid...
  4447. return 0;
  4448. } else if (code < 0x10000) {
  4449. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4450. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4451. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4452. return 3;
  4453. } else if (code < 0x110000) {
  4454. buff[0] = static_cast<char>(0xF0 | ((code >> 18) & 0x7));
  4455. buff[1] = static_cast<char>(0x80 | ((code >> 12) & 0x3F));
  4456. buff[2] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4457. buff[3] = static_cast<char>(0x80 | (code & 0x3F));
  4458. return 4;
  4459. }
  4460. // NOTREACHED
  4461. return 0;
  4462. }
  4463. } // namespace detail
  4464. namespace ws {
  4465. namespace impl {
  4466. inline bool is_valid_utf8(const std::string &s) {
  4467. size_t i = 0;
  4468. auto n = s.size();
  4469. while (i < n) {
  4470. auto c = static_cast<unsigned char>(s[i]);
  4471. size_t len;
  4472. uint32_t cp;
  4473. if (c < 0x80) {
  4474. i++;
  4475. continue;
  4476. } else if ((c & 0xE0) == 0xC0) {
  4477. len = 2;
  4478. cp = c & 0x1F;
  4479. } else if ((c & 0xF0) == 0xE0) {
  4480. len = 3;
  4481. cp = c & 0x0F;
  4482. } else if ((c & 0xF8) == 0xF0) {
  4483. len = 4;
  4484. cp = c & 0x07;
  4485. } else {
  4486. return false;
  4487. }
  4488. if (i + len > n) { return false; }
  4489. for (size_t j = 1; j < len; j++) {
  4490. auto b = static_cast<unsigned char>(s[i + j]);
  4491. if ((b & 0xC0) != 0x80) { return false; }
  4492. cp = (cp << 6) | (b & 0x3F);
  4493. }
  4494. // Overlong encoding check
  4495. if (len == 2 && cp < 0x80) { return false; }
  4496. if (len == 3 && cp < 0x800) { return false; }
  4497. if (len == 4 && cp < 0x10000) { return false; }
  4498. // Surrogate halves (U+D800..U+DFFF) and beyond U+10FFFF are invalid
  4499. if (cp >= 0xD800 && cp <= 0xDFFF) { return false; }
  4500. if (cp > 0x10FFFF) { return false; }
  4501. i += len;
  4502. }
  4503. return true;
  4504. }
  4505. } // namespace impl
  4506. } // namespace ws
  4507. namespace detail {
  4508. // NOTE: This code came up with the following stackoverflow post:
  4509. // https://stackoverflow.com/questions/180947/base64-decode-snippet-in-c
  4510. inline std::string base64_encode(const std::string &in) {
  4511. static const auto lookup =
  4512. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4513. std::string out;
  4514. out.reserve(in.size());
  4515. // Unsigned: the accumulator is never masked, so with a signed int the
  4516. // `val << 8` below overflows once enough bytes are folded in (undefined
  4517. // behaviour before C++20). Only the low bits are ever emitted, so the
  4518. // wrap-around of an unsigned accumulator does not affect the output.
  4519. uint32_t val = 0;
  4520. auto valb = -6;
  4521. for (auto c : in) {
  4522. val = (val << 8) + static_cast<uint8_t>(c);
  4523. valb += 8;
  4524. while (valb >= 0) {
  4525. out.push_back(lookup[(val >> valb) & 0x3F]);
  4526. valb -= 6;
  4527. }
  4528. }
  4529. if (valb > -6) { out.push_back(lookup[((val << 8) >> (valb + 8)) & 0x3F]); }
  4530. while (out.size() % 4) {
  4531. out.push_back('=');
  4532. }
  4533. return out;
  4534. }
  4535. inline std::string sha1(const std::string &input) {
  4536. // RFC 3174 SHA-1 implementation
  4537. auto left_rotate = [](uint32_t x, uint32_t n) -> uint32_t {
  4538. return (x << n) | (x >> (32 - n));
  4539. };
  4540. uint32_t h0 = 0x67452301;
  4541. uint32_t h1 = 0xEFCDAB89;
  4542. uint32_t h2 = 0x98BADCFE;
  4543. uint32_t h3 = 0x10325476;
  4544. uint32_t h4 = 0xC3D2E1F0;
  4545. // Pre-processing: adding padding bits
  4546. std::string msg = input;
  4547. uint64_t original_bit_len = static_cast<uint64_t>(msg.size()) * 8;
  4548. msg.push_back(static_cast<char>(0x80u));
  4549. while (msg.size() % 64 != 56) {
  4550. msg.push_back(0);
  4551. }
  4552. // Append original length in bits as 64-bit big-endian
  4553. for (int i = 56; i >= 0; i -= 8) {
  4554. msg.push_back(static_cast<char>((original_bit_len >> i) & 0xFF));
  4555. }
  4556. // Process each 512-bit chunk
  4557. for (size_t offset = 0; offset < msg.size(); offset += 64) {
  4558. uint32_t w[80];
  4559. for (size_t i = 0; i < 16; i++) {
  4560. w[i] =
  4561. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4]))
  4562. << 24) |
  4563. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 1]))
  4564. << 16) |
  4565. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 2]))
  4566. << 8) |
  4567. (static_cast<uint32_t>(
  4568. static_cast<uint8_t>(msg[offset + i * 4 + 3])));
  4569. }
  4570. for (int i = 16; i < 80; i++) {
  4571. w[i] = left_rotate(w[i - 3] ^ w[i - 8] ^ w[i - 14] ^ w[i - 16], 1);
  4572. }
  4573. uint32_t a = h0, b = h1, c = h2, d = h3, e = h4;
  4574. for (int i = 0; i < 80; i++) {
  4575. uint32_t f, k;
  4576. if (i < 20) {
  4577. f = (b & c) | ((~b) & d);
  4578. k = 0x5A827999;
  4579. } else if (i < 40) {
  4580. f = b ^ c ^ d;
  4581. k = 0x6ED9EBA1;
  4582. } else if (i < 60) {
  4583. f = (b & c) | (b & d) | (c & d);
  4584. k = 0x8F1BBCDC;
  4585. } else {
  4586. f = b ^ c ^ d;
  4587. k = 0xCA62C1D6;
  4588. }
  4589. uint32_t temp = left_rotate(a, 5) + f + e + k + w[i];
  4590. e = d;
  4591. d = c;
  4592. c = left_rotate(b, 30);
  4593. b = a;
  4594. a = temp;
  4595. }
  4596. h0 += a;
  4597. h1 += b;
  4598. h2 += c;
  4599. h3 += d;
  4600. h4 += e;
  4601. }
  4602. // Produce the final hash as a 20-byte binary string
  4603. std::string hash(20, '\0');
  4604. for (size_t i = 0; i < 4; i++) {
  4605. hash[i] = static_cast<char>((h0 >> (24 - i * 8)) & 0xFF);
  4606. hash[4 + i] = static_cast<char>((h1 >> (24 - i * 8)) & 0xFF);
  4607. hash[8 + i] = static_cast<char>((h2 >> (24 - i * 8)) & 0xFF);
  4608. hash[12 + i] = static_cast<char>((h3 >> (24 - i * 8)) & 0xFF);
  4609. hash[16 + i] = static_cast<char>((h4 >> (24 - i * 8)) & 0xFF);
  4610. }
  4611. return hash;
  4612. }
  4613. inline std::string websocket_accept_key(const std::string &client_key) {
  4614. const std::string magic = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
  4615. return base64_encode(sha1(client_key + magic));
  4616. }
  4617. inline bool is_websocket_upgrade(const Request &req) {
  4618. if (req.method != "GET") { return false; }
  4619. // Check Upgrade: websocket. RFC 9110 7.8 defines Upgrade as a comma-separated
  4620. // list of protocols and asks recipients to match each name
  4621. // case-insensitively, so look for the token rather than compare the whole
  4622. // field value.
  4623. if (!has_header_token(req.headers, "Upgrade", "websocket")) { return false; }
  4624. // Check Connection: Upgrade
  4625. if (!has_header_token(req.headers, "Connection", "upgrade")) { return false; }
  4626. // Check Sec-WebSocket-Key is a valid base64-encoded 16-byte value (24 chars)
  4627. // RFC 6455 Section 4.2.1
  4628. auto ws_key = req.get_header_value("Sec-WebSocket-Key");
  4629. if (ws_key.size() != 24 || ws_key[22] != '=' || ws_key[23] != '=') {
  4630. return false;
  4631. }
  4632. static const std::string b64chars =
  4633. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4634. for (size_t i = 0; i < 22; i++) {
  4635. if (b64chars.find(ws_key[i]) == std::string::npos) { return false; }
  4636. }
  4637. // Check Sec-WebSocket-Version: 13
  4638. auto version = req.get_header_value("Sec-WebSocket-Version");
  4639. if (version != "13") { return false; }
  4640. return true;
  4641. }
  4642. // Unpredictable bytes for masking keys (RFC 6455 Section 5.3) and nonces
  4643. inline void fill_random_bytes(unsigned char *out, size_t n) {
  4644. thread_local std::random_device rd;
  4645. size_t filled = 0;
  4646. while (filled < n) {
  4647. auto v = rd();
  4648. for (size_t b = 0; b < sizeof(v) && filled < n; ++b, ++filled) {
  4649. out[filled] = static_cast<unsigned char>((v >> (b * 8)) & 0xFFu);
  4650. }
  4651. }
  4652. }
  4653. inline bool write_websocket_frame(Stream &strm, ws::Opcode opcode,
  4654. const char *data, size_t len, bool fin,
  4655. bool mask) {
  4656. // First byte: FIN + opcode
  4657. uint8_t header[2];
  4658. header[0] = static_cast<uint8_t>((fin ? 0x80 : 0x00) |
  4659. (static_cast<uint8_t>(opcode) & 0x0F));
  4660. // Second byte: MASK + payload length
  4661. if (len < 126) {
  4662. header[1] = static_cast<uint8_t>(len);
  4663. if (mask) { header[1] |= 0x80; }
  4664. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4665. } else if (len <= 0xFFFF) {
  4666. header[1] = 126;
  4667. if (mask) { header[1] |= 0x80; }
  4668. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4669. uint8_t ext[2];
  4670. ext[0] = static_cast<uint8_t>((len >> 8) & 0xFF);
  4671. ext[1] = static_cast<uint8_t>(len & 0xFF);
  4672. if (strm.write(reinterpret_cast<char *>(ext), 2) < 0) { return false; }
  4673. } else {
  4674. header[1] = 127;
  4675. if (mask) { header[1] |= 0x80; }
  4676. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4677. uint8_t ext[8];
  4678. for (int i = 7; i >= 0; i--) {
  4679. ext[7 - i] =
  4680. static_cast<uint8_t>((static_cast<uint64_t>(len) >> (i * 8)) & 0xFF);
  4681. }
  4682. if (strm.write(reinterpret_cast<char *>(ext), 8) < 0) { return false; }
  4683. }
  4684. if (mask) {
  4685. // Generate random mask key
  4686. uint8_t mask_key[4];
  4687. fill_random_bytes(mask_key, sizeof(mask_key));
  4688. if (strm.write(reinterpret_cast<char *>(mask_key), 4) < 0) { return false; }
  4689. // Write masked payload in chunks
  4690. const size_t chunk_size = 4096;
  4691. std::vector<char> buf((std::min)(len, chunk_size));
  4692. for (size_t offset = 0; offset < len; offset += chunk_size) {
  4693. size_t n = (std::min)(chunk_size, len - offset);
  4694. for (size_t i = 0; i < n; i++) {
  4695. buf[i] =
  4696. data[offset + i] ^ static_cast<char>(mask_key[(offset + i) % 4]);
  4697. }
  4698. if (strm.write(buf.data(), n) < 0) { return false; }
  4699. }
  4700. } else {
  4701. if (len > 0) {
  4702. if (strm.write(data, len) < 0) { return false; }
  4703. }
  4704. }
  4705. return true;
  4706. }
  4707. } // namespace detail
  4708. namespace ws {
  4709. namespace impl {
  4710. // Read exactly `size` bytes. Stream::read may return less than asked for -- it
  4711. // hands back whatever its buffer already holds -- so every multi-byte field has
  4712. // to loop. Reading a 2-byte header with a single read() fails whenever the
  4713. // header straddles the read buffer's boundary.
  4714. //
  4715. // Timeout is reported only when nothing at all was consumed. Once a byte has
  4716. // been taken the stream sits mid-field and cannot be resumed, so a timeout
  4717. // there is a failure like any other. (When read() fails it always records why,
  4718. // so the error belongs to this call and not to an earlier one.)
  4719. inline FrameRead read_exact(Stream &strm, void *buf, size_t size) {
  4720. auto p = static_cast<char *>(buf);
  4721. size_t total = 0;
  4722. while (total < size) {
  4723. auto n = strm.read(p + total, size - total);
  4724. if (n <= 0) {
  4725. auto timed_out = total == 0 && strm.get_error() == Error::Timeout;
  4726. return timed_out ? FrameRead::Timeout : FrameRead::Fail;
  4727. }
  4728. total += static_cast<size_t>(n);
  4729. }
  4730. return FrameRead::Ok;
  4731. }
  4732. inline FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  4733. std::string &payload, bool &fin,
  4734. bool expect_masked, size_t max_len) {
  4735. // Read first 2 bytes. This is the only read that may report a timeout: it
  4736. // sits on a frame boundary, where nothing has been consumed yet.
  4737. uint8_t header[2];
  4738. FrameRead first = read_exact(strm, header, 2);
  4739. if (first != FrameRead::Ok) { return first; }
  4740. fin = (header[0] & 0x80) != 0;
  4741. // RSV1, RSV2, RSV3 must be 0 when no extension is negotiated
  4742. if (header[0] & 0x70) { return FrameRead::Fail; }
  4743. opcode = static_cast<Opcode>(header[0] & 0x0F);
  4744. bool masked = (header[1] & 0x80) != 0;
  4745. uint64_t payload_len = header[1] & 0x7F;
  4746. // RFC 6455 Section 5.5: control frames MUST NOT be fragmented and
  4747. // MUST have a payload length of 125 bytes or less
  4748. bool is_control = (static_cast<uint8_t>(opcode) & 0x08) != 0;
  4749. if (is_control) {
  4750. if (!fin) { return FrameRead::Fail; }
  4751. if (payload_len > 125) { return FrameRead::Fail; }
  4752. }
  4753. if (masked != expect_masked) { return FrameRead::Fail; }
  4754. // Extended payload length
  4755. if (payload_len == 126) {
  4756. uint8_t ext[2];
  4757. if (read_exact(strm, ext, 2) != FrameRead::Ok) { return FrameRead::Fail; }
  4758. payload_len = (static_cast<uint64_t>(ext[0]) << 8) | ext[1];
  4759. } else if (payload_len == 127) {
  4760. uint8_t ext[8];
  4761. if (read_exact(strm, ext, 8) != FrameRead::Ok) { return FrameRead::Fail; }
  4762. // RFC 6455 Section 5.2: the most significant bit MUST be 0
  4763. if (ext[0] & 0x80) { return FrameRead::Fail; }
  4764. payload_len = 0;
  4765. for (int i = 0; i < 8; i++) {
  4766. payload_len = (payload_len << 8) | ext[i];
  4767. }
  4768. }
  4769. if (payload_len > max_len) { return FrameRead::Fail; }
  4770. // Read mask key if present
  4771. uint8_t mask_key[4] = {0};
  4772. if (masked) {
  4773. if (read_exact(strm, mask_key, 4) != FrameRead::Ok) {
  4774. return FrameRead::Fail;
  4775. }
  4776. }
  4777. // Grow the payload only as it arrives, since a header alone can announce
  4778. // max_len bytes that never come.
  4779. payload.clear();
  4780. auto len = static_cast<size_t>(payload_len);
  4781. while (payload.size() < len) {
  4782. auto offset = payload.size();
  4783. auto n = (std::min)(len - offset, CPPHTTPLIB_RECV_BUFSIZ);
  4784. payload.resize(offset + n);
  4785. if (read_exact(strm, &payload[offset], n) != FrameRead::Ok) {
  4786. return FrameRead::Fail;
  4787. }
  4788. }
  4789. // Unmask if needed
  4790. if (masked) {
  4791. for (size_t i = 0; i < payload.size(); i++) {
  4792. payload[i] ^= static_cast<char>(mask_key[i % 4]);
  4793. }
  4794. }
  4795. return FrameRead::Ok;
  4796. }
  4797. } // namespace impl
  4798. } // namespace ws
  4799. namespace detail {
  4800. inline bool is_valid_path(const std::string &path) {
  4801. size_t level = 0;
  4802. size_t i = 0;
  4803. // Skip slash
  4804. while (i < path.size() && path[i] == '/') {
  4805. i++;
  4806. }
  4807. while (i < path.size()) {
  4808. // Read component
  4809. auto beg = i;
  4810. while (i < path.size() && path[i] != '/') {
  4811. if (path[i] == '\0') {
  4812. return false;
  4813. } else if (path[i] == '\\') {
  4814. return false;
  4815. }
  4816. i++;
  4817. }
  4818. auto len = i - beg;
  4819. assert(len > 0);
  4820. if (!path.compare(beg, len, ".")) {
  4821. ;
  4822. } else if (!path.compare(beg, len, "..")) {
  4823. if (level == 0) { return false; }
  4824. level--;
  4825. } else {
  4826. level++;
  4827. }
  4828. // Skip slash
  4829. while (i < path.size() && path[i] == '/') {
  4830. i++;
  4831. }
  4832. }
  4833. return true;
  4834. }
  4835. inline bool canonicalize_path(const char *path, std::string &resolved) {
  4836. #if defined(_WIN32)
  4837. char buf[_MAX_PATH];
  4838. if (_fullpath(buf, path, _MAX_PATH) == nullptr) { return false; }
  4839. resolved = buf;
  4840. #elif defined(PATH_MAX)
  4841. char buf[PATH_MAX];
  4842. if (realpath(path, buf) == nullptr) { return false; }
  4843. resolved = buf;
  4844. #else
  4845. auto buf = realpath(path, nullptr);
  4846. auto guard = scope_exit([&]() { std::free(buf); });
  4847. if (buf == nullptr) { return false; }
  4848. resolved = buf;
  4849. #endif
  4850. return true;
  4851. }
  4852. inline bool is_path_within_base(const std::string &resolved_path,
  4853. const std::string &resolved_base) {
  4854. #if defined(_WIN32)
  4855. return _strnicmp(resolved_path.c_str(), resolved_base.c_str(),
  4856. resolved_base.size()) == 0;
  4857. #else
  4858. return strncmp(resolved_path.c_str(), resolved_base.c_str(),
  4859. resolved_base.size()) == 0;
  4860. #endif
  4861. }
  4862. inline FileStat::FileStat(const std::string &path) {
  4863. #if defined(_WIN32)
  4864. auto wpath = u8string_to_wstring(path.c_str());
  4865. ret_ = _wstat(wpath.c_str(), &st_);
  4866. #else
  4867. ret_ = stat(path.c_str(), &st_);
  4868. #endif
  4869. }
  4870. inline bool FileStat::is_file() const {
  4871. return ret_ >= 0 && S_ISREG(st_.st_mode);
  4872. }
  4873. inline bool FileStat::is_dir() const {
  4874. return ret_ >= 0 && S_ISDIR(st_.st_mode);
  4875. }
  4876. inline time_t FileStat::mtime() const {
  4877. return ret_ >= 0 ? static_cast<time_t>(st_.st_mtime)
  4878. : static_cast<time_t>(-1);
  4879. }
  4880. inline size_t FileStat::size() const {
  4881. return ret_ >= 0 ? static_cast<size_t>(st_.st_size) : 0;
  4882. }
  4883. inline std::string encode_path(const std::string &s) {
  4884. std::string result;
  4885. result.reserve(s.size());
  4886. for (size_t i = 0; s[i]; i++) {
  4887. switch (s[i]) {
  4888. case ' ': result += "%20"; break;
  4889. case '+': result += "%2B"; break;
  4890. case '\'': result += "%27"; break;
  4891. case ',': result += "%2C"; break;
  4892. // case ':': result += "%3A"; break; // ok? probably...
  4893. case ';': result += "%3B"; break;
  4894. default:
  4895. auto c = static_cast<uint8_t>(s[i]);
  4896. // Control characters (incl. CR/LF) and non-ASCII bytes are not allowed
  4897. // in a request-target as-is.
  4898. if (c < 0x20 || c == 0x7f || c >= 0x80) {
  4899. result += '%';
  4900. char hex[4];
  4901. auto len = snprintf(hex, sizeof(hex) - 1, "%02X", c);
  4902. assert(len == 2);
  4903. result.append(hex, static_cast<size_t>(len));
  4904. } else {
  4905. result += s[i];
  4906. }
  4907. break;
  4908. }
  4909. }
  4910. return result;
  4911. }
  4912. inline std::string file_extension(const std::string &path) {
  4913. auto i = path.size();
  4914. while (i > 0 && is_ascii_alnum(path[i - 1])) {
  4915. i--;
  4916. }
  4917. if (i == path.size() || i == 0 || path[i - 1] != '.') {
  4918. return std::string();
  4919. }
  4920. return path.substr(i);
  4921. }
  4922. inline bool is_space_or_tab(char c) { return c == ' ' || c == '\t'; }
  4923. template <typename T>
  4924. inline bool parse_header(const char *beg, const char *end, T fn);
  4925. template <typename T>
  4926. inline bool parse_header(const char *beg, const char *end, T fn) {
  4927. // Skip trailing spaces and tabs.
  4928. while (beg < end && is_space_or_tab(end[-1])) {
  4929. end--;
  4930. }
  4931. auto p = beg;
  4932. while (p < end && *p != ':') {
  4933. p++;
  4934. }
  4935. auto name = std::string(beg, p);
  4936. if (!detail::fields::is_field_name(name)) { return false; }
  4937. if (p == end) { return false; }
  4938. auto key_end = p;
  4939. if (*p++ != ':') { return false; }
  4940. while (p < end && is_space_or_tab(*p)) {
  4941. p++;
  4942. }
  4943. if (p <= end) {
  4944. auto key_len = key_end - beg;
  4945. if (!key_len) { return false; }
  4946. auto key = std::string(beg, key_end);
  4947. auto val = std::string(p, end);
  4948. if (!detail::fields::is_field_value(val)) { return false; }
  4949. // RFC 9110 §5.5: header field values are opaque octets and MUST NOT be
  4950. // percent-decoded by the recipient. Applications that need to interpret a
  4951. // value as a URI component should call httplib::decode_uri_component()
  4952. // (or decode_path_component()) explicitly.
  4953. fn(key, val);
  4954. return true;
  4955. }
  4956. return false;
  4957. }
  4958. inline bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  4959. const Headers &src_headers) {
  4960. // NOTE: In RFC 9112, '7.1 Chunked Transfer Coding' mentions "The chunked
  4961. // transfer coding is complete when a chunk with a chunk-size of zero is
  4962. // received, possibly followed by a trailer section, and finally terminated by
  4963. // an empty line". https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1
  4964. //
  4965. // In '7.1.3. Decoding Chunked', however, the pseudo-code in the section
  4966. // doesn't care for the existence of the final CRLF. In other words, it seems
  4967. // to be ok whether the final CRLF exists or not in the chunked data.
  4968. // https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1.3
  4969. //
  4970. // According to the reference code in RFC 9112, cpp-httplib now allows
  4971. // chunked transfer coding data without the final CRLF.
  4972. // RFC 7230 Section 4.1.2 - Headers prohibited in trailers
  4973. thread_local case_ignore::unordered_set<std::string> prohibited_trailers = {
  4974. "transfer-encoding",
  4975. "content-length",
  4976. "host",
  4977. "authorization",
  4978. "www-authenticate",
  4979. "proxy-authenticate",
  4980. "proxy-authorization",
  4981. "cookie",
  4982. "set-cookie",
  4983. "cache-control",
  4984. "expect",
  4985. "max-forwards",
  4986. "pragma",
  4987. "range",
  4988. "te",
  4989. "age",
  4990. "expires",
  4991. "date",
  4992. "location",
  4993. "retry-after",
  4994. "vary",
  4995. "warning",
  4996. "content-encoding",
  4997. "content-type",
  4998. "content-range",
  4999. "trailer"};
  5000. case_ignore::unordered_set<std::string> declared_trailers;
  5001. auto trailer_header = get_combined_header_value(src_headers, "Trailer");
  5002. if (!trailer_header.empty()) {
  5003. // split() trims each token and skips empty ones, so the name arrives ready
  5004. // to look up.
  5005. split(trailer_header.data(), trailer_header.data() + trailer_header.size(),
  5006. ',', [&](const char *b, const char *e) {
  5007. // A legitimate message declares only a handful of trailers. Cap the
  5008. // set so a peer cannot grow it without bound: an oversized set only
  5009. // arises from an attempt to force many colliding names into
  5010. // quadratic lookups (case_ignore::hash is unkeyed).
  5011. if (declared_trailers.size() >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  5012. return;
  5013. }
  5014. std::string key(b, e);
  5015. if (prohibited_trailers.find(key) == prohibited_trailers.end()) {
  5016. declared_trailers.insert(key);
  5017. }
  5018. });
  5019. }
  5020. size_t trailer_header_count = 0;
  5021. while (strcmp(line_reader.ptr(), "\r\n") != 0) {
  5022. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  5023. // Count every received trailer field, not only the declared ones stored in
  5024. // dest, so undeclared fields cannot keep this loop running past the limit.
  5025. if (trailer_header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  5026. constexpr auto line_terminator_len = 2;
  5027. auto line_beg = line_reader.ptr();
  5028. auto line_end =
  5029. line_reader.ptr() + line_reader.size() - line_terminator_len;
  5030. if (!parse_header(line_beg, line_end,
  5031. [&](const std::string &key, const std::string &val) {
  5032. if (declared_trailers.find(key) !=
  5033. declared_trailers.end()) {
  5034. dest.emplace(key, val);
  5035. }
  5036. })) {
  5037. return false;
  5038. }
  5039. trailer_header_count++;
  5040. if (!line_reader.getline()) { return false; }
  5041. }
  5042. return true;
  5043. }
  5044. inline std::pair<size_t, size_t> trim(const char *b, const char *e, size_t left,
  5045. size_t right) {
  5046. while (b + left < e && is_space_or_tab(b[left])) {
  5047. left++;
  5048. }
  5049. while (right > 0 && is_space_or_tab(b[right - 1])) {
  5050. right--;
  5051. }
  5052. return std::make_pair(left, right);
  5053. }
  5054. inline std::string trim_copy(const std::string &s) {
  5055. auto r = trim(s.data(), s.data() + s.size(), 0, s.size());
  5056. return s.substr(r.first, r.second - r.first);
  5057. }
  5058. inline std::string trim_double_quotes_copy(const std::string &s) {
  5059. if (s.length() >= 2 && s.front() == '"' && s.back() == '"') {
  5060. return s.substr(1, s.size() - 2);
  5061. }
  5062. return s;
  5063. }
  5064. inline void
  5065. divide(const char *data, std::size_t size, char d,
  5066. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5067. fn) {
  5068. const auto it = std::find(data, data + size, d);
  5069. const auto found = static_cast<std::size_t>(it != data + size);
  5070. const auto lhs_data = data;
  5071. const auto lhs_size = static_cast<std::size_t>(it - data);
  5072. const auto rhs_data = it + found;
  5073. const auto rhs_size = size - lhs_size - found;
  5074. fn(lhs_data, lhs_size, rhs_data, rhs_size);
  5075. }
  5076. inline void
  5077. divide(const std::string &str, char d,
  5078. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5079. fn) {
  5080. divide(str.data(), str.size(), d, std::move(fn));
  5081. }
  5082. inline void split(const char *b, const char *e, char d,
  5083. std::function<void(const char *, const char *)> fn) {
  5084. return split(b, e, d, (std::numeric_limits<size_t>::max)(), std::move(fn));
  5085. }
  5086. inline void split(const char *b, const char *e, char d, size_t m,
  5087. std::function<void(const char *, const char *)> fn) {
  5088. size_t i = 0;
  5089. size_t beg = 0;
  5090. size_t count = 1;
  5091. while (e ? (b + i < e) : (b[i] != '\0')) {
  5092. if (b[i] == d && count < m) {
  5093. auto r = trim(b, e, beg, i);
  5094. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5095. beg = i + 1;
  5096. count++;
  5097. }
  5098. i++;
  5099. }
  5100. if (i) {
  5101. auto r = trim(b, e, beg, i);
  5102. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5103. }
  5104. }
  5105. // Same contract as split(), except that a delimiter inside a quoted-string is
  5106. // not a delimiter. RFC 9110 Section 5.6.6 lets a parameter value be a
  5107. // quoted-string, and ';' and '=' are legal characters inside one.
  5108. inline void split_unquoted(const char *b, const char *e, char d, size_t m,
  5109. std::function<void(const char *, const char *)> fn) {
  5110. size_t i = 0;
  5111. size_t beg = 0;
  5112. size_t count = 1;
  5113. auto in_quotes = false;
  5114. while (e ? (b + i < e) : (b[i] != '\0')) {
  5115. if (b[i] == '"') {
  5116. in_quotes = !in_quotes;
  5117. } else if (b[i] == d && !in_quotes && count < m) {
  5118. auto r = trim(b, e, beg, i);
  5119. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5120. beg = i + 1;
  5121. count++;
  5122. }
  5123. i++;
  5124. }
  5125. if (i) {
  5126. auto r = trim(b, e, beg, i);
  5127. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5128. }
  5129. }
  5130. inline void split_unquoted(const char *b, const char *e, char d,
  5131. std::function<void(const char *, const char *)> fn) {
  5132. return split_unquoted(b, e, d, (std::numeric_limits<size_t>::max)(),
  5133. std::move(fn));
  5134. }
  5135. // Divide a header parameter at its first '='. RFC 9110 Section 5.6.6 makes the
  5136. // key a token, so the first '=' is the separator even when the value is a
  5137. // quoted-string carrying more of them.
  5138. inline void divide_param_pair(const char *b, const char *e, std::string &key,
  5139. std::string &val) {
  5140. divide(
  5141. b, static_cast<std::size_t>(e - b), '=',
  5142. [&](const char *kb, std::size_t klen, const char *vb, std::size_t vlen) {
  5143. const auto kr = trim(kb, kb + klen, 0, klen);
  5144. key.assign(kb + kr.first, kb + kr.second);
  5145. const auto vr = trim(vb, vb + vlen, 0, vlen);
  5146. val.assign(vb + vr.first, vb + vr.second);
  5147. });
  5148. }
  5149. inline bool split_find(const char *b, const char *e, char d, size_t m,
  5150. std::function<bool(const char *, const char *)> fn) {
  5151. size_t i = 0;
  5152. size_t beg = 0;
  5153. size_t count = 1;
  5154. while (e ? (b + i < e) : (b[i] != '\0')) {
  5155. if (b[i] == d && count < m) {
  5156. auto r = trim(b, e, beg, i);
  5157. if (r.first < r.second) {
  5158. auto found = fn(&b[r.first], &b[r.second]);
  5159. if (found) { return true; }
  5160. }
  5161. beg = i + 1;
  5162. count++;
  5163. }
  5164. i++;
  5165. }
  5166. if (i) {
  5167. auto r = trim(b, e, beg, i);
  5168. if (r.first < r.second) {
  5169. auto found = fn(&b[r.first], &b[r.second]);
  5170. if (found) { return true; }
  5171. }
  5172. }
  5173. return false;
  5174. }
  5175. inline bool split_find(const char *b, const char *e, char d,
  5176. std::function<bool(const char *, const char *)> fn) {
  5177. return split_find(b, e, d, (std::numeric_limits<size_t>::max)(),
  5178. std::move(fn));
  5179. }
  5180. inline stream_line_reader::stream_line_reader(Stream &strm, char *fixed_buffer,
  5181. size_t fixed_buffer_size)
  5182. : strm_(strm), fixed_buffer_(fixed_buffer),
  5183. fixed_buffer_size_(fixed_buffer_size) {}
  5184. inline const char *stream_line_reader::ptr() const {
  5185. if (growable_buffer_.empty()) {
  5186. return fixed_buffer_;
  5187. } else {
  5188. return growable_buffer_.data();
  5189. }
  5190. }
  5191. inline size_t stream_line_reader::size() const {
  5192. if (growable_buffer_.empty()) {
  5193. return fixed_buffer_used_size_;
  5194. } else {
  5195. return growable_buffer_.size();
  5196. }
  5197. }
  5198. inline bool stream_line_reader::end_with_crlf() const {
  5199. auto end = ptr() + size();
  5200. return size() >= 2 && end[-2] == '\r' && end[-1] == '\n';
  5201. }
  5202. inline bool stream_line_reader::getline() {
  5203. fixed_buffer_used_size_ = 0;
  5204. growable_buffer_.clear();
  5205. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5206. char prev_byte = 0;
  5207. #endif
  5208. for (size_t i = 0;; i++) {
  5209. // Fast path: whatever the stream has already buffered can be scanned for
  5210. // the terminator in one pass. Asking for a byte at a time costs a virtual
  5211. // call, a bounds check and a one-byte copy per character of the request.
  5212. size_t buffered_size = 0;
  5213. if (auto buffered = strm_.buffered_data(buffered_size)) {
  5214. auto take = buffered_size;
  5215. auto terminated = false;
  5216. for (size_t at = 0; at < buffered_size;) {
  5217. auto nl = static_cast<const char *>(
  5218. memchr(buffered + at, '\n', buffered_size - at));
  5219. if (!nl) { break; }
  5220. auto pos = static_cast<size_t>(nl - buffered);
  5221. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5222. take = pos + 1;
  5223. terminated = true;
  5224. break;
  5225. #else
  5226. // A bare LF does not end the line; keep looking for CRLF. The CR may
  5227. // be the last byte of an earlier chunk, hence prev_byte.
  5228. if ((pos > 0 ? buffered[pos - 1] : prev_byte) == '\r') {
  5229. take = pos + 1;
  5230. terminated = true;
  5231. break;
  5232. }
  5233. at = pos + 1;
  5234. #endif
  5235. }
  5236. if (size() + take > CPPHTTPLIB_MAX_LINE_LENGTH) { return false; }
  5237. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5238. prev_byte = buffered[take - 1];
  5239. #endif
  5240. append(buffered, take);
  5241. strm_.consume_buffered(take);
  5242. i += take;
  5243. if (terminated) { return true; }
  5244. continue;
  5245. }
  5246. if (size() >= CPPHTTPLIB_MAX_LINE_LENGTH) {
  5247. // Treat exceptionally long lines as an error to
  5248. // prevent infinite loops/memory exhaustion
  5249. return false;
  5250. }
  5251. char byte;
  5252. auto n = strm_.read(&byte, 1);
  5253. if (n < 0) {
  5254. return false;
  5255. } else if (n == 0) {
  5256. if (i == 0) {
  5257. return false;
  5258. } else {
  5259. break;
  5260. }
  5261. }
  5262. append(byte);
  5263. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5264. if (byte == '\n') { break; }
  5265. #else
  5266. if (prev_byte == '\r' && byte == '\n') { break; }
  5267. prev_byte = byte;
  5268. #endif
  5269. }
  5270. return true;
  5271. }
  5272. inline void stream_line_reader::append(char c) { append(&c, 1); }
  5273. inline void stream_line_reader::append(const char *data, size_t size) {
  5274. // Once the line has outgrown the fixed buffer everything must keep going to
  5275. // the growable one, even if a later chunk would have fit. Without the
  5276. // emptiness check a short append after a long one would land in the fixed
  5277. // buffer, which ptr() and size() no longer look at, and be lost.
  5278. if (growable_buffer_.empty() &&
  5279. fixed_buffer_used_size_ + size < fixed_buffer_size_) {
  5280. memcpy(fixed_buffer_ + fixed_buffer_used_size_, data, size);
  5281. fixed_buffer_used_size_ += size;
  5282. fixed_buffer_[fixed_buffer_used_size_] = '\0';
  5283. } else {
  5284. // Unlike the per-character overload, this can be the very first append of
  5285. // the line, so the fixed buffer may hold nothing and carry no terminator
  5286. // yet. assign() takes an explicit length and does not need one.
  5287. if (growable_buffer_.empty()) {
  5288. growable_buffer_.assign(fixed_buffer_, fixed_buffer_used_size_);
  5289. }
  5290. growable_buffer_.append(data, size);
  5291. }
  5292. }
  5293. inline mmap::mmap(const char *path) { open(path); }
  5294. inline mmap::~mmap() { close(); }
  5295. inline bool mmap::open(const char *path) {
  5296. close();
  5297. #if defined(_WIN32)
  5298. auto wpath = u8string_to_wstring(path);
  5299. if (wpath.empty()) { return false; }
  5300. hFile_ =
  5301. ::CreateFile2(wpath.c_str(), GENERIC_READ,
  5302. FILE_SHARE_READ | FILE_SHARE_WRITE, OPEN_EXISTING, NULL);
  5303. if (hFile_ == INVALID_HANDLE_VALUE) { return false; }
  5304. LARGE_INTEGER size{};
  5305. if (!::GetFileSizeEx(hFile_, &size)) { return false; }
  5306. // If the following line doesn't compile due to QuadPart, update Windows SDK.
  5307. // See:
  5308. // https://github.com/yhirose/cpp-httplib/issues/1903#issuecomment-2316520721
  5309. if (static_cast<ULONGLONG>(size.QuadPart) >
  5310. (std::numeric_limits<decltype(size_)>::max)()) {
  5311. // `size_t` might be 32-bits, on 32-bits Windows.
  5312. return false;
  5313. }
  5314. size_ = static_cast<size_t>(size.QuadPart);
  5315. hMapping_ =
  5316. ::CreateFileMappingFromApp(hFile_, NULL, PAGE_READONLY, size_, NULL);
  5317. // Special treatment for an empty file...
  5318. if (hMapping_ == NULL && size_ == 0) {
  5319. close();
  5320. is_open_empty_file = true;
  5321. return true;
  5322. }
  5323. if (hMapping_ == NULL) {
  5324. close();
  5325. return false;
  5326. }
  5327. addr_ = ::MapViewOfFileFromApp(hMapping_, FILE_MAP_READ, 0, 0);
  5328. if (addr_ == nullptr) {
  5329. close();
  5330. return false;
  5331. }
  5332. #else
  5333. fd_ = ::open(path, O_RDONLY);
  5334. if (fd_ == -1) { return false; }
  5335. struct stat sb;
  5336. if (fstat(fd_, &sb) == -1) {
  5337. close();
  5338. return false;
  5339. }
  5340. size_ = static_cast<size_t>(sb.st_size);
  5341. addr_ = ::mmap(NULL, size_, PROT_READ, MAP_PRIVATE, fd_, 0);
  5342. // Special treatment for an empty file...
  5343. if (addr_ == MAP_FAILED && size_ == 0) {
  5344. close();
  5345. is_open_empty_file = true;
  5346. return false;
  5347. }
  5348. if (addr_ == MAP_FAILED) {
  5349. // Clear the sentinel before `close()`, since `is_open()` only checks
  5350. // `addr_` against nullptr and `munmap()` must not be called with it.
  5351. addr_ = nullptr;
  5352. close();
  5353. return false;
  5354. }
  5355. #endif
  5356. return true;
  5357. }
  5358. inline bool mmap::is_open() const {
  5359. return is_open_empty_file ? true : addr_ != nullptr;
  5360. }
  5361. inline size_t mmap::size() const { return size_; }
  5362. inline const char *mmap::data() const {
  5363. return is_open_empty_file ? "" : static_cast<const char *>(addr_);
  5364. }
  5365. inline void mmap::close() {
  5366. #if defined(_WIN32)
  5367. if (addr_) {
  5368. ::UnmapViewOfFile(addr_);
  5369. addr_ = nullptr;
  5370. }
  5371. if (hMapping_) {
  5372. ::CloseHandle(hMapping_);
  5373. hMapping_ = NULL;
  5374. }
  5375. if (hFile_ != INVALID_HANDLE_VALUE) {
  5376. ::CloseHandle(hFile_);
  5377. hFile_ = INVALID_HANDLE_VALUE;
  5378. }
  5379. is_open_empty_file = false;
  5380. #else
  5381. if (addr_ != nullptr) {
  5382. munmap(addr_, size_);
  5383. addr_ = nullptr;
  5384. }
  5385. if (fd_ != -1) {
  5386. ::close(fd_);
  5387. fd_ = -1;
  5388. }
  5389. #endif
  5390. size_ = 0;
  5391. }
  5392. inline int close_socket(socket_t sock) noexcept {
  5393. #ifdef _WIN32
  5394. return closesocket(sock);
  5395. #else
  5396. return close(sock);
  5397. #endif
  5398. }
  5399. template <typename T> inline ssize_t handle_EINTR(T fn) {
  5400. ssize_t res = 0;
  5401. while (true) {
  5402. res = fn();
  5403. if (res < 0 && errno == EINTR) {
  5404. std::this_thread::sleep_for(std::chrono::microseconds{1});
  5405. continue;
  5406. }
  5407. break;
  5408. }
  5409. return res;
  5410. }
  5411. inline ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags) {
  5412. return handle_EINTR([&]() {
  5413. return recv(sock,
  5414. #ifdef _WIN32
  5415. static_cast<char *>(ptr), static_cast<int>(size),
  5416. #else
  5417. ptr, size,
  5418. #endif
  5419. flags);
  5420. });
  5421. }
  5422. inline ssize_t send_socket(socket_t sock, const void *ptr, size_t size,
  5423. int flags) {
  5424. return handle_EINTR([&]() {
  5425. return send(sock,
  5426. #ifdef _WIN32
  5427. static_cast<const char *>(ptr), static_cast<int>(size),
  5428. #else
  5429. ptr, size,
  5430. #endif
  5431. flags);
  5432. });
  5433. }
  5434. inline int poll_wrapper(struct pollfd *fds, nfds_t nfds, int timeout) {
  5435. #ifdef _WIN32
  5436. return ::WSAPoll(fds, nfds, timeout);
  5437. #else
  5438. return ::poll(fds, nfds, timeout);
  5439. #endif
  5440. }
  5441. inline ssize_t select_impl(socket_t sock, short events, time_t sec,
  5442. time_t usec) {
  5443. struct pollfd pfd;
  5444. pfd.fd = sock;
  5445. pfd.events = events;
  5446. pfd.revents = 0;
  5447. // A negative timeout waits forever, poll's own convention. 0 keeps meaning
  5448. // "return immediately", which callers here rely on to probe a socket.
  5449. auto timeout = sec < 0 ? -1 : static_cast<int>(sec * 1000 + usec / 1000);
  5450. return handle_EINTR([&]() { return poll_wrapper(&pfd, 1, timeout); });
  5451. }
  5452. inline ssize_t select_read(socket_t sock, time_t sec, time_t usec) {
  5453. return select_impl(sock, POLLIN, sec, usec);
  5454. }
  5455. inline ssize_t select_write(socket_t sock, time_t sec, time_t usec) {
  5456. return select_impl(sock, POLLOUT, sec, usec);
  5457. }
  5458. // The point sec and usec from now, for select_until(). A negative sec never
  5459. // comes, as a negative timeout waits forever in select_impl().
  5460. inline std::chrono::steady_clock::time_point deadline_after(time_t sec,
  5461. time_t usec) {
  5462. if (sec < 0) { return std::chrono::steady_clock::time_point::max(); }
  5463. return std::chrono::steady_clock::now() + std::chrono::seconds(sec) +
  5464. std::chrono::microseconds(usec);
  5465. }
  5466. // Waits only for the time left until deadline, so that all the waits of one
  5467. // TLS handshake come out of a single timeout.
  5468. inline ssize_t select_until(socket_t sock, short events,
  5469. std::chrono::steady_clock::time_point deadline) {
  5470. if (deadline == std::chrono::steady_clock::time_point::max()) {
  5471. return select_impl(sock, events, -1, 0);
  5472. }
  5473. auto left = std::chrono::duration_cast<std::chrono::microseconds>(
  5474. deadline - std::chrono::steady_clock::now())
  5475. .count();
  5476. if (left <= 0) { return 0; }
  5477. return select_impl(sock, events, static_cast<time_t>(left / 1000000),
  5478. static_cast<time_t>(left % 1000000));
  5479. }
  5480. inline Error wait_until_socket_is_ready(socket_t sock, time_t sec,
  5481. time_t usec) {
  5482. struct pollfd pfd_read;
  5483. pfd_read.fd = sock;
  5484. pfd_read.events = POLLIN | POLLOUT;
  5485. pfd_read.revents = 0;
  5486. auto timeout = static_cast<int>(sec * 1000 + usec / 1000);
  5487. auto poll_res =
  5488. handle_EINTR([&]() { return poll_wrapper(&pfd_read, 1, timeout); });
  5489. if (poll_res == 0) { return Error::ConnectionTimeout; }
  5490. if (poll_res > 0 && pfd_read.revents & (POLLIN | POLLOUT)) {
  5491. auto error = 0;
  5492. socklen_t len = sizeof(error);
  5493. auto res = getsockopt(sock, SOL_SOCKET, SO_ERROR,
  5494. reinterpret_cast<char *>(&error), &len);
  5495. auto successful = res >= 0 && !error;
  5496. return successful ? Error::Success : Error::Connection;
  5497. }
  5498. return Error::Connection;
  5499. }
  5500. inline bool is_socket_alive(socket_t sock) {
  5501. const auto val = detail::select_read(sock, 0, 0);
  5502. if (val == 0) {
  5503. return true;
  5504. } else if (val < 0 && errno == EBADF) {
  5505. return false;
  5506. }
  5507. char buf[1];
  5508. return detail::read_socket(sock, &buf[0], sizeof(buf), MSG_PEEK) > 0;
  5509. }
  5510. class SocketStream final : public Stream {
  5511. public:
  5512. SocketStream(socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5513. time_t write_timeout_sec, time_t write_timeout_usec,
  5514. time_t max_timeout_msec = 0,
  5515. std::chrono::time_point<std::chrono::steady_clock> start_time =
  5516. (std::chrono::steady_clock::time_point::min)());
  5517. ~SocketStream() override;
  5518. bool is_readable() const override;
  5519. bool wait_readable() const override;
  5520. bool wait_writable() const override;
  5521. bool is_peer_alive() const override;
  5522. ssize_t read(char *ptr, size_t size) override;
  5523. ssize_t write(const char *ptr, size_t size) override;
  5524. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  5525. void get_local_ip_and_port(std::string &ip, int &port) const override;
  5526. socket_t socket() const override;
  5527. time_t duration() const override;
  5528. void set_read_timeout(time_t sec, time_t usec = 0) override;
  5529. const char *buffered_data(size_t &size) const override;
  5530. void consume_buffered(size_t size) override;
  5531. // The caller has just seen this socket become readable. Lets the next read
  5532. // skip its own readiness wait, which would otherwise ask the kernel a
  5533. // question that was answered a moment ago. Consumed by that read.
  5534. void set_readable_hint() { readable_hint_ = true; }
  5535. private:
  5536. bool ensure_readable();
  5537. socket_t sock_;
  5538. // Atomic because ws::WebSocket::set_read_timeout() reaches this from another
  5539. // thread while a read is in flight -- that is the point of it, for a caller
  5540. // holding one connection and wanting control back to send on it.
  5541. std::atomic<time_t> read_timeout_sec_;
  5542. std::atomic<time_t> read_timeout_usec_;
  5543. time_t write_timeout_sec_;
  5544. time_t write_timeout_usec_;
  5545. time_t max_timeout_msec_;
  5546. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  5547. std::vector<char> read_buff_;
  5548. size_t read_buff_off_ = 0;
  5549. size_t read_buff_content_size_ = 0;
  5550. bool readable_hint_ = false;
  5551. static const size_t read_buff_size_ = 1024l * 4;
  5552. };
  5553. inline bool keep_alive(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5554. time_t keep_alive_timeout_sec) {
  5555. using namespace std::chrono;
  5556. const auto interval_usec =
  5557. CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND;
  5558. // Avoid expensive `steady_clock::now()` call for the first time
  5559. if (select_read(sock, 0, interval_usec) > 0) { return true; }
  5560. const auto start = steady_clock::now() - microseconds{interval_usec};
  5561. const auto timeout = seconds{keep_alive_timeout_sec};
  5562. while (true) {
  5563. if (svr_sock == INVALID_SOCKET) {
  5564. break; // Server socket is closed
  5565. }
  5566. auto val = select_read(sock, 0, interval_usec);
  5567. if (val < 0) {
  5568. break; // Ssocket error
  5569. } else if (val == 0) {
  5570. if (steady_clock::now() - start > timeout) {
  5571. break; // Timeout
  5572. }
  5573. } else {
  5574. return true; // Ready for read
  5575. }
  5576. }
  5577. return false;
  5578. }
  5579. // `has_buffered_request` reports whether the connection's stream already holds
  5580. // bytes of the next request. A client may pipeline its requests (RFC 9112
  5581. // 9.3.2), so reading one request can pull the start of the next one into the
  5582. // stream's buffer; that request must be served without waiting for the socket
  5583. // to become readable again, since its bytes are no longer on the socket.
  5584. // `callback` is told whether keep_alive() has just seen the socket go readable.
  5585. template <typename P, typename T>
  5586. inline bool process_server_socket_core(const std::atomic<socket_t> &svr_sock,
  5587. socket_t sock,
  5588. size_t keep_alive_max_count,
  5589. time_t keep_alive_timeout_sec,
  5590. P has_buffered_request, T callback) {
  5591. assert(keep_alive_max_count > 0);
  5592. auto ret = false;
  5593. auto count = keep_alive_max_count;
  5594. while (count > 0) {
  5595. auto socket_readable = false;
  5596. if (!has_buffered_request()) {
  5597. if (!keep_alive(svr_sock, sock, keep_alive_timeout_sec)) { break; }
  5598. socket_readable = true;
  5599. }
  5600. auto close_connection = count == 1;
  5601. auto connection_closed = false;
  5602. ret = callback(socket_readable, close_connection, connection_closed);
  5603. if (!ret || connection_closed) { break; }
  5604. count--;
  5605. }
  5606. return ret;
  5607. }
  5608. template <typename T>
  5609. inline bool
  5610. process_server_socket(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5611. size_t keep_alive_max_count,
  5612. time_t keep_alive_timeout_sec, time_t read_timeout_sec,
  5613. time_t read_timeout_usec, time_t write_timeout_sec,
  5614. time_t write_timeout_usec, T callback) {
  5615. // One stream per connection: its read buffer can already hold the start of
  5616. // the next, pipelined request.
  5617. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5618. write_timeout_sec, write_timeout_usec);
  5619. return process_server_socket_core(
  5620. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  5621. [&]() { return strm.is_readable(); },
  5622. [&](bool socket_readable, bool close_connection,
  5623. bool &connection_closed) {
  5624. if (socket_readable) { strm.set_readable_hint(); }
  5625. return callback(strm, close_connection, connection_closed);
  5626. });
  5627. }
  5628. inline bool process_client_socket(
  5629. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5630. time_t write_timeout_sec, time_t write_timeout_usec,
  5631. time_t max_timeout_msec,
  5632. std::chrono::time_point<std::chrono::steady_clock> start_time,
  5633. std::function<bool(Stream &)> callback) {
  5634. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5635. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  5636. start_time);
  5637. return callback(strm);
  5638. }
  5639. inline int shutdown_socket(socket_t sock) noexcept {
  5640. #ifdef _WIN32
  5641. return shutdown(sock, SD_BOTH);
  5642. #else
  5643. return shutdown(sock, SHUT_RDWR);
  5644. #endif
  5645. }
  5646. // Half-closes the write side and drains any in-flight/queued bytes before
  5647. // the final shutdown+close. Closing with unread data in the receive queue
  5648. // (or bytes arriving after the receive side is closed) makes the stack send
  5649. // an abortive RST instead of a graceful FIN, which can make the peer see the
  5650. // response as a failed read even though it was fully written.
  5651. inline void drain_and_close_socket(socket_t sock) noexcept {
  5652. #ifdef _WIN32
  5653. shutdown(sock, SD_SEND);
  5654. #else
  5655. shutdown(sock, SHUT_WR);
  5656. #endif
  5657. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  5658. size_t total = 0;
  5659. const auto deadline = std::chrono::steady_clock::now() +
  5660. std::chrono::milliseconds(100); // bound #1
  5661. while (total < size_t(1024u * 1024u)) { // bound #2
  5662. const auto remaining =
  5663. std::chrono::duration_cast<std::chrono::microseconds>(
  5664. deadline - std::chrono::steady_clock::now())
  5665. .count();
  5666. if (remaining <= 0) { break; }
  5667. if (select_read(sock, 0, static_cast<time_t>(remaining)) <= 0) { break; }
  5668. const auto n = read_socket(sock, buf, sizeof(buf), CPPHTTPLIB_RECV_FLAGS);
  5669. if (n <= 0) { break; }
  5670. total += static_cast<size_t>(n);
  5671. }
  5672. shutdown_socket(sock);
  5673. close_socket(sock);
  5674. }
  5675. inline std::string escape_abstract_namespace_unix_domain(const std::string &s) {
  5676. if (s.size() > 1 && s[0] == '\0') {
  5677. auto ret = s;
  5678. ret[0] = '@';
  5679. return ret;
  5680. }
  5681. return s;
  5682. }
  5683. inline std::string
  5684. unescape_abstract_namespace_unix_domain(const std::string &s) {
  5685. if (s.size() > 1 && s[0] == '@') {
  5686. auto ret = s;
  5687. ret[0] = '\0';
  5688. return ret;
  5689. }
  5690. return s;
  5691. }
  5692. inline int getaddrinfo_with_timeout(const char *node, const char *service,
  5693. const struct addrinfo *hints,
  5694. struct addrinfo **res, time_t timeout_sec) {
  5695. #ifdef CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO
  5696. if (timeout_sec <= 0) {
  5697. // No timeout specified, use standard getaddrinfo
  5698. return getaddrinfo(node, service, hints, res);
  5699. }
  5700. #ifdef _WIN32
  5701. // Windows-specific implementation using GetAddrInfoEx with overlapped I/O
  5702. OVERLAPPED overlapped = {};
  5703. HANDLE event = CreateEventW(nullptr, TRUE, FALSE, nullptr);
  5704. if (!event) { return EAI_FAIL; }
  5705. overlapped.hEvent = event;
  5706. PADDRINFOEXW result_addrinfo = nullptr;
  5707. HANDLE cancel_handle = nullptr;
  5708. ADDRINFOEXW hints_ex = {};
  5709. if (hints) {
  5710. hints_ex.ai_flags = hints->ai_flags;
  5711. hints_ex.ai_family = hints->ai_family;
  5712. hints_ex.ai_socktype = hints->ai_socktype;
  5713. hints_ex.ai_protocol = hints->ai_protocol;
  5714. }
  5715. auto wnode = u8string_to_wstring(node);
  5716. auto wservice = u8string_to_wstring(service);
  5717. auto ret = ::GetAddrInfoExW(wnode.data(), wservice.data(), NS_DNS, nullptr,
  5718. hints ? &hints_ex : nullptr, &result_addrinfo,
  5719. nullptr, &overlapped, nullptr, &cancel_handle);
  5720. if (ret == WSA_IO_PENDING) {
  5721. auto wait_result =
  5722. ::WaitForSingleObject(event, static_cast<DWORD>(timeout_sec * 1000));
  5723. if (wait_result == WAIT_TIMEOUT) {
  5724. if (cancel_handle) { ::GetAddrInfoExCancel(&cancel_handle); }
  5725. ::CloseHandle(event);
  5726. return EAI_AGAIN;
  5727. }
  5728. DWORD bytes_returned;
  5729. if (!::GetOverlappedResult((HANDLE)INVALID_SOCKET, &overlapped,
  5730. &bytes_returned, FALSE)) {
  5731. ::CloseHandle(event);
  5732. return ::WSAGetLastError();
  5733. }
  5734. }
  5735. ::CloseHandle(event);
  5736. if (ret == NO_ERROR || ret == WSA_IO_PENDING) {
  5737. *res = reinterpret_cast<struct addrinfo *>(result_addrinfo);
  5738. return 0;
  5739. }
  5740. return ret;
  5741. #elif TARGET_OS_MAC && defined(__clang__)
  5742. if (!node) { return EAI_NONAME; }
  5743. // macOS implementation using CFHost API for asynchronous DNS resolution
  5744. CFStringRef hostname_ref = CFStringCreateWithCString(
  5745. kCFAllocatorDefault, node, kCFStringEncodingUTF8);
  5746. if (!hostname_ref) { return EAI_MEMORY; }
  5747. CFHostRef host_ref = CFHostCreateWithName(kCFAllocatorDefault, hostname_ref);
  5748. CFRelease(hostname_ref);
  5749. if (!host_ref) { return EAI_MEMORY; }
  5750. // Set up context for callback
  5751. struct CFHostContext {
  5752. bool completed = false;
  5753. bool success = false;
  5754. CFArrayRef addresses = nullptr;
  5755. std::mutex mutex;
  5756. std::condition_variable cv;
  5757. } context;
  5758. CFHostClientContext client_context;
  5759. memset(&client_context, 0, sizeof(client_context));
  5760. client_context.info = &context;
  5761. // Set callback
  5762. auto callback = [](CFHostRef theHost, CFHostInfoType /*typeInfo*/,
  5763. const CFStreamError *error, void *info) {
  5764. auto ctx = static_cast<CFHostContext *>(info);
  5765. std::lock_guard<std::mutex> lock(ctx->mutex);
  5766. if (error && error->error != 0) {
  5767. ctx->success = false;
  5768. } else {
  5769. Boolean hasBeenResolved;
  5770. ctx->addresses = CFHostGetAddressing(theHost, &hasBeenResolved);
  5771. if (ctx->addresses && hasBeenResolved) {
  5772. CFRetain(ctx->addresses);
  5773. ctx->success = true;
  5774. } else {
  5775. ctx->success = false;
  5776. }
  5777. }
  5778. ctx->completed = true;
  5779. ctx->cv.notify_one();
  5780. };
  5781. if (!CFHostSetClient(host_ref, callback, &client_context)) {
  5782. CFRelease(host_ref);
  5783. return EAI_SYSTEM;
  5784. }
  5785. // Schedule on run loop
  5786. CFRunLoopRef run_loop = CFRunLoopGetCurrent();
  5787. CFHostScheduleWithRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5788. // Start resolution
  5789. CFStreamError stream_error;
  5790. if (!CFHostStartInfoResolution(host_ref, kCFHostAddresses, &stream_error)) {
  5791. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5792. CFRelease(host_ref);
  5793. return EAI_FAIL;
  5794. }
  5795. // Wait for completion with timeout
  5796. auto timeout_time =
  5797. std::chrono::steady_clock::now() + std::chrono::seconds(timeout_sec);
  5798. bool timed_out = false;
  5799. {
  5800. std::unique_lock<std::mutex> lock(context.mutex);
  5801. while (!context.completed) {
  5802. auto now = std::chrono::steady_clock::now();
  5803. if (now >= timeout_time) {
  5804. timed_out = true;
  5805. break;
  5806. }
  5807. // Run the runloop for a short time
  5808. lock.unlock();
  5809. CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.1, true);
  5810. lock.lock();
  5811. }
  5812. }
  5813. // Clean up
  5814. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5815. CFHostSetClient(host_ref, nullptr, nullptr);
  5816. if (timed_out || !context.completed) {
  5817. CFHostCancelInfoResolution(host_ref, kCFHostAddresses);
  5818. CFRelease(host_ref);
  5819. return EAI_AGAIN;
  5820. }
  5821. if (!context.success || !context.addresses) {
  5822. CFRelease(host_ref);
  5823. return EAI_NODATA;
  5824. }
  5825. // Convert CFArray to addrinfo
  5826. CFIndex count = CFArrayGetCount(context.addresses);
  5827. if (count == 0) {
  5828. CFRelease(context.addresses);
  5829. CFRelease(host_ref);
  5830. return EAI_NODATA;
  5831. }
  5832. struct addrinfo *result_addrinfo = nullptr;
  5833. struct addrinfo **current = &result_addrinfo;
  5834. for (CFIndex i = 0; i < count; i++) {
  5835. CFDataRef addr_data =
  5836. static_cast<CFDataRef>(CFArrayGetValueAtIndex(context.addresses, i));
  5837. if (!addr_data) continue;
  5838. const struct sockaddr *sockaddr_ptr =
  5839. reinterpret_cast<const struct sockaddr *>(CFDataGetBytePtr(addr_data));
  5840. socklen_t sockaddr_len = static_cast<socklen_t>(CFDataGetLength(addr_data));
  5841. // Allocate addrinfo structure
  5842. *current = static_cast<struct addrinfo *>(malloc(sizeof(struct addrinfo)));
  5843. if (!*current) {
  5844. freeaddrinfo(result_addrinfo);
  5845. CFRelease(context.addresses);
  5846. CFRelease(host_ref);
  5847. return EAI_MEMORY;
  5848. }
  5849. memset(*current, 0, sizeof(struct addrinfo));
  5850. // Set up addrinfo fields
  5851. (*current)->ai_family = sockaddr_ptr->sa_family;
  5852. (*current)->ai_socktype = hints ? hints->ai_socktype : SOCK_STREAM;
  5853. (*current)->ai_protocol = hints ? hints->ai_protocol : IPPROTO_TCP;
  5854. (*current)->ai_addrlen = sockaddr_len;
  5855. // Copy sockaddr
  5856. (*current)->ai_addr = static_cast<struct sockaddr *>(malloc(sockaddr_len));
  5857. if (!(*current)->ai_addr) {
  5858. freeaddrinfo(result_addrinfo);
  5859. CFRelease(context.addresses);
  5860. CFRelease(host_ref);
  5861. return EAI_MEMORY;
  5862. }
  5863. memcpy((*current)->ai_addr, sockaddr_ptr, sockaddr_len);
  5864. // Set port if service is specified
  5865. if (service && *service) {
  5866. int port = 0;
  5867. if (parse_port(service, strlen(service), port)) {
  5868. if (sockaddr_ptr->sa_family == AF_INET) {
  5869. reinterpret_cast<struct sockaddr_in *>((*current)->ai_addr)
  5870. ->sin_port = htons(static_cast<uint16_t>(port));
  5871. } else if (sockaddr_ptr->sa_family == AF_INET6) {
  5872. reinterpret_cast<struct sockaddr_in6 *>((*current)->ai_addr)
  5873. ->sin6_port = htons(static_cast<uint16_t>(port));
  5874. }
  5875. }
  5876. }
  5877. current = &((*current)->ai_next);
  5878. }
  5879. CFRelease(context.addresses);
  5880. CFRelease(host_ref);
  5881. *res = result_addrinfo;
  5882. return 0;
  5883. #elif defined(_GNU_SOURCE) && defined(__GLIBC__) && \
  5884. (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 2)) && \
  5885. !defined(CPPHTTPLIB_THREAD_SANITIZER)
  5886. // Skipped under TSan: glibc's internal resolver thread is invisible to it.
  5887. // #2431: gai_cancel() is non-blocking and may return EAI_NOTCANCELED while
  5888. // the resolver worker still references the stack-local gaicb. The cancel
  5889. // path therefore waits (gai_suspend with no timeout) for the worker to
  5890. // actually finish before letting the stack frame go. The trade-off is that
  5891. // a wedged DNS server can hold this thread for the system resolver timeout
  5892. // (~30s by default) past the caller's connection timeout.
  5893. struct gaicb request{};
  5894. struct gaicb *requests[1] = {&request};
  5895. struct sigevent sevp{};
  5896. struct timespec timeout{timeout_sec, 0};
  5897. request.ar_name = node;
  5898. request.ar_service = service;
  5899. request.ar_request = hints;
  5900. sevp.sigev_notify = SIGEV_NONE;
  5901. int rc = getaddrinfo_a(GAI_NOWAIT, requests, 1, &sevp);
  5902. if (rc != 0) { return rc; }
  5903. auto cleanup = scope_exit([&] {
  5904. if (request.ar_result) { freeaddrinfo(request.ar_result); }
  5905. });
  5906. int wait_result = gai_suspend(requests, 1, &timeout);
  5907. if (wait_result == 0 || wait_result == EAI_ALLDONE) {
  5908. int gai_result = gai_error(&request);
  5909. if (gai_result == 0) {
  5910. *res = request.ar_result;
  5911. request.ar_result = nullptr;
  5912. return 0;
  5913. }
  5914. return gai_result;
  5915. }
  5916. gai_cancel(&request);
  5917. while (gai_error(&request) == EAI_INPROGRESS) {
  5918. gai_suspend(requests, 1, nullptr);
  5919. }
  5920. return wait_result;
  5921. #else
  5922. // Fallback implementation using thread-based timeout for other Unix systems.
  5923. struct GetAddrInfoState {
  5924. ~GetAddrInfoState() {
  5925. if (info) { freeaddrinfo(info); }
  5926. }
  5927. std::mutex mutex;
  5928. std::condition_variable result_cv;
  5929. bool completed = false;
  5930. int result = EAI_SYSTEM;
  5931. std::string node;
  5932. std::string service;
  5933. struct addrinfo hints;
  5934. struct addrinfo *info = nullptr;
  5935. };
  5936. // Allocate on the heap, so the resolver thread can keep using the data.
  5937. auto state = std::make_shared<GetAddrInfoState>();
  5938. if (node) { state->node = node; }
  5939. state->service = service;
  5940. state->hints = *hints;
  5941. std::thread resolve_thread([state]() {
  5942. auto thread_result =
  5943. getaddrinfo(state->node.c_str(), state->service.c_str(), &state->hints,
  5944. &state->info);
  5945. std::lock_guard<std::mutex> lock(state->mutex);
  5946. state->result = thread_result;
  5947. state->completed = true;
  5948. state->result_cv.notify_one();
  5949. });
  5950. // Wait for completion or timeout
  5951. std::unique_lock<std::mutex> lock(state->mutex);
  5952. auto finished =
  5953. state->result_cv.wait_for(lock, std::chrono::seconds(timeout_sec),
  5954. [&] { return state->completed; });
  5955. if (finished) {
  5956. // Operation completed within timeout
  5957. resolve_thread.join();
  5958. *res = state->info;
  5959. state->info = nullptr; // Pass ownership to caller
  5960. return state->result;
  5961. } else {
  5962. // Timeout occurred
  5963. resolve_thread.detach(); // Let the thread finish in background
  5964. return EAI_AGAIN; // Return timeout error
  5965. }
  5966. #endif
  5967. #else
  5968. (void)(timeout_sec); // Unused parameter for non-blocking getaddrinfo
  5969. return getaddrinfo(node, service, hints, res);
  5970. #endif
  5971. }
  5972. template <typename BindOrConnect>
  5973. socket_t create_socket(const std::string &host, const std::string &ip, int port,
  5974. int address_family, int socket_flags, bool tcp_nodelay,
  5975. bool ipv6_v6only, SocketOptions socket_options,
  5976. BindOrConnect bind_or_connect, time_t timeout_sec = 0) {
  5977. // Get address info
  5978. const char *node = nullptr;
  5979. struct addrinfo hints;
  5980. struct addrinfo *result;
  5981. memset(&hints, 0, sizeof(struct addrinfo));
  5982. hints.ai_socktype = SOCK_STREAM;
  5983. hints.ai_protocol = IPPROTO_IP;
  5984. if (!ip.empty()) {
  5985. node = ip.c_str();
  5986. // Ask getaddrinfo to convert IP in c-string to address
  5987. hints.ai_family = AF_UNSPEC;
  5988. hints.ai_flags = AI_NUMERICHOST;
  5989. } else {
  5990. if (!host.empty()) { node = host.c_str(); }
  5991. hints.ai_family = address_family;
  5992. hints.ai_flags = socket_flags;
  5993. }
  5994. #if !defined(_WIN32) || defined(CPPHTTPLIB_HAVE_AFUNIX_H)
  5995. if (hints.ai_family == AF_UNIX) {
  5996. const auto addrlen = host.length();
  5997. if (addrlen > sizeof(sockaddr_un::sun_path)) { return INVALID_SOCKET; }
  5998. #ifdef SOCK_CLOEXEC
  5999. auto sock = socket(hints.ai_family, hints.ai_socktype | SOCK_CLOEXEC,
  6000. hints.ai_protocol);
  6001. #else
  6002. auto sock = socket(hints.ai_family, hints.ai_socktype, hints.ai_protocol);
  6003. #endif
  6004. if (sock != INVALID_SOCKET) {
  6005. sockaddr_un addr{};
  6006. addr.sun_family = AF_UNIX;
  6007. auto unescaped_host = unescape_abstract_namespace_unix_domain(host);
  6008. std::copy(unescaped_host.begin(), unescaped_host.end(), addr.sun_path);
  6009. hints.ai_addr = reinterpret_cast<sockaddr *>(&addr);
  6010. hints.ai_addrlen = static_cast<socklen_t>(
  6011. sizeof(addr) - sizeof(addr.sun_path) + addrlen);
  6012. #ifndef SOCK_CLOEXEC
  6013. #ifndef _WIN32
  6014. fcntl(sock, F_SETFD, FD_CLOEXEC);
  6015. #endif
  6016. #endif
  6017. if (socket_options) { socket_options(sock); }
  6018. #ifdef _WIN32
  6019. // Setting SO_REUSEADDR seems not to work well with AF_UNIX on windows, so
  6020. // remove the option.
  6021. set_socket_opt(sock, SOL_SOCKET, SO_REUSEADDR, 0);
  6022. #endif
  6023. bool dummy;
  6024. if (!bind_or_connect(sock, hints, dummy)) {
  6025. close_socket(sock);
  6026. sock = INVALID_SOCKET;
  6027. }
  6028. }
  6029. return sock;
  6030. }
  6031. #endif
  6032. auto service = std::to_string(port);
  6033. if (getaddrinfo_with_timeout(node, service.c_str(), &hints, &result,
  6034. timeout_sec)) {
  6035. #if defined __linux__ && !defined __ANDROID__
  6036. res_init();
  6037. #endif
  6038. return INVALID_SOCKET;
  6039. }
  6040. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6041. for (auto rp = result; rp; rp = rp->ai_next) {
  6042. // Create a socket
  6043. #ifdef _WIN32
  6044. auto sock =
  6045. WSASocketW(rp->ai_family, rp->ai_socktype, rp->ai_protocol, nullptr, 0,
  6046. WSA_FLAG_NO_HANDLE_INHERIT | WSA_FLAG_OVERLAPPED);
  6047. /**
  6048. * Since the WSA_FLAG_NO_HANDLE_INHERIT is only supported on Windows 7 SP1
  6049. * and above the socket creation fails on older Windows Systems.
  6050. *
  6051. * Let's try to create a socket the old way in this case.
  6052. *
  6053. * Reference:
  6054. * https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketa
  6055. *
  6056. * WSA_FLAG_NO_HANDLE_INHERIT:
  6057. * This flag is supported on Windows 7 with SP1, Windows Server 2008 R2 with
  6058. * SP1, and later
  6059. *
  6060. */
  6061. if (sock == INVALID_SOCKET) {
  6062. sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6063. }
  6064. #else
  6065. #ifdef SOCK_CLOEXEC
  6066. auto sock =
  6067. socket(rp->ai_family, rp->ai_socktype | SOCK_CLOEXEC, rp->ai_protocol);
  6068. #else
  6069. auto sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6070. #endif
  6071. #endif
  6072. if (sock == INVALID_SOCKET) { continue; }
  6073. #if !defined _WIN32 && !defined SOCK_CLOEXEC
  6074. if (fcntl(sock, F_SETFD, FD_CLOEXEC) == -1) {
  6075. close_socket(sock);
  6076. continue;
  6077. }
  6078. #endif
  6079. if (tcp_nodelay) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  6080. if (rp->ai_family == AF_INET6) {
  6081. set_socket_opt(sock, IPPROTO_IPV6, IPV6_V6ONLY, ipv6_v6only ? 1 : 0);
  6082. }
  6083. if (socket_options) { socket_options(sock); }
  6084. // bind or connect
  6085. auto quit = false;
  6086. if (bind_or_connect(sock, *rp, quit)) { return sock; }
  6087. close_socket(sock);
  6088. if (quit) { break; }
  6089. }
  6090. return INVALID_SOCKET;
  6091. }
  6092. inline void set_nonblocking(socket_t sock, bool nonblocking) {
  6093. #ifdef _WIN32
  6094. auto flags = nonblocking ? 1UL : 0UL;
  6095. ioctlsocket(sock, FIONBIO, &flags);
  6096. #else
  6097. auto flags = fcntl(sock, F_GETFL, 0);
  6098. fcntl(sock, F_SETFL,
  6099. nonblocking ? (flags | O_NONBLOCK) : (flags & (~O_NONBLOCK)));
  6100. #endif
  6101. }
  6102. inline bool is_connection_error() {
  6103. #ifdef _WIN32
  6104. return WSAGetLastError() != WSAEWOULDBLOCK;
  6105. #else
  6106. return errno != EINPROGRESS;
  6107. #endif
  6108. }
  6109. // accept() failed because the process or the network stack is temporarily out
  6110. // of resources. The listening socket is still usable, so back off briefly and
  6111. // try again.
  6112. inline bool is_accept_resource_error() {
  6113. #ifdef _WIN32
  6114. auto err = WSAGetLastError();
  6115. return err == WSAEMFILE || err == WSAENOBUFS;
  6116. #else
  6117. auto err = errno;
  6118. return err == EMFILE || err == ENFILE || err == ENOBUFS || err == ENOMEM;
  6119. #endif
  6120. }
  6121. // accept() failed for a reason that says nothing about the listening socket:
  6122. // the pending connection went away before it could be accepted, or the call
  6123. // was interrupted. Retry immediately. WSAAccept()'s own documentation omits
  6124. // WSAECONNRESET, but the accept() it wraps reports an aborted pending
  6125. // connection that way.
  6126. inline bool is_accept_transient_error() {
  6127. #ifdef _WIN32
  6128. auto err = WSAGetLastError();
  6129. return err == WSAEINTR || err == WSAEWOULDBLOCK || err == WSAECONNRESET ||
  6130. err == WSAECONNABORTED;
  6131. #else
  6132. auto err = errno;
  6133. return err == EINTR || err == EAGAIN || err == EWOULDBLOCK ||
  6134. err == ECONNABORTED;
  6135. #endif
  6136. }
  6137. inline bool bind_ip_address(socket_t sock, const std::string &host) {
  6138. struct addrinfo hints;
  6139. struct addrinfo *result;
  6140. memset(&hints, 0, sizeof(struct addrinfo));
  6141. hints.ai_family = AF_UNSPEC;
  6142. hints.ai_socktype = SOCK_STREAM;
  6143. hints.ai_protocol = 0;
  6144. if (getaddrinfo_with_timeout(host.c_str(), "0", &hints, &result, 0)) {
  6145. return false;
  6146. }
  6147. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6148. auto ret = false;
  6149. for (auto rp = result; rp; rp = rp->ai_next) {
  6150. const auto &ai = *rp;
  6151. if (!::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  6152. ret = true;
  6153. break;
  6154. }
  6155. }
  6156. return ret;
  6157. }
  6158. #if !defined _WIN32 && !defined ANDROID && !defined _AIX && !defined __MVS__
  6159. #define USE_IF2IP
  6160. #endif
  6161. #ifdef USE_IF2IP
  6162. inline std::string if2ip(int address_family, const std::string &ifn) {
  6163. struct ifaddrs *ifap;
  6164. getifaddrs(&ifap);
  6165. auto se = detail::scope_exit([&] { freeifaddrs(ifap); });
  6166. std::string addr_candidate;
  6167. for (auto ifa = ifap; ifa; ifa = ifa->ifa_next) {
  6168. if (ifa->ifa_addr && ifn == ifa->ifa_name &&
  6169. (AF_UNSPEC == address_family ||
  6170. ifa->ifa_addr->sa_family == address_family)) {
  6171. if (ifa->ifa_addr->sa_family == AF_INET) {
  6172. auto sa = reinterpret_cast<struct sockaddr_in *>(ifa->ifa_addr);
  6173. char buf[INET_ADDRSTRLEN];
  6174. if (inet_ntop(AF_INET, &sa->sin_addr, buf, INET_ADDRSTRLEN)) {
  6175. return std::string(buf, INET_ADDRSTRLEN);
  6176. }
  6177. } else if (ifa->ifa_addr->sa_family == AF_INET6) {
  6178. auto sa = reinterpret_cast<struct sockaddr_in6 *>(ifa->ifa_addr);
  6179. if (!IN6_IS_ADDR_LINKLOCAL(&sa->sin6_addr)) {
  6180. char buf[INET6_ADDRSTRLEN] = {};
  6181. if (inet_ntop(AF_INET6, &sa->sin6_addr, buf, INET6_ADDRSTRLEN)) {
  6182. // equivalent to mac's IN6_IS_ADDR_UNIQUE_LOCAL
  6183. auto s6_addr_head = sa->sin6_addr.s6_addr[0];
  6184. if (s6_addr_head == 0xfc || s6_addr_head == 0xfd) {
  6185. addr_candidate = std::string(buf, INET6_ADDRSTRLEN);
  6186. } else {
  6187. return std::string(buf, INET6_ADDRSTRLEN);
  6188. }
  6189. }
  6190. }
  6191. }
  6192. }
  6193. }
  6194. return addr_candidate;
  6195. }
  6196. #endif
  6197. inline socket_t create_client_socket(
  6198. const std::string &host, const std::string &ip, int port,
  6199. int address_family, bool tcp_nodelay, bool ipv6_v6only,
  6200. SocketOptions socket_options, time_t connection_timeout_sec,
  6201. time_t connection_timeout_usec, time_t read_timeout_sec,
  6202. time_t read_timeout_usec, time_t write_timeout_sec,
  6203. time_t write_timeout_usec, const std::string &intf, Error &error) {
  6204. auto sock = create_socket(
  6205. host, ip, port, address_family, 0, tcp_nodelay, ipv6_v6only,
  6206. std::move(socket_options),
  6207. [&](socket_t sock2, struct addrinfo &ai, bool &quit) -> bool {
  6208. if (!intf.empty()) {
  6209. #ifdef USE_IF2IP
  6210. auto ip_from_if = if2ip(address_family, intf);
  6211. if (ip_from_if.empty()) { ip_from_if = intf; }
  6212. if (!bind_ip_address(sock2, ip_from_if)) {
  6213. error = Error::BindIPAddress;
  6214. return false;
  6215. }
  6216. #endif
  6217. }
  6218. set_nonblocking(sock2, true);
  6219. auto ret =
  6220. ::connect(sock2, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen));
  6221. if (ret < 0) {
  6222. if (is_connection_error()) {
  6223. error = Error::Connection;
  6224. return false;
  6225. }
  6226. error = wait_until_socket_is_ready(sock2, connection_timeout_sec,
  6227. connection_timeout_usec);
  6228. if (error != Error::Success) {
  6229. if (error == Error::ConnectionTimeout) { quit = true; }
  6230. return false;
  6231. }
  6232. }
  6233. set_nonblocking(sock2, false);
  6234. set_socket_opt_time(sock2, SOL_SOCKET, SO_RCVTIMEO, read_timeout_sec,
  6235. read_timeout_usec);
  6236. set_socket_opt_time(sock2, SOL_SOCKET, SO_SNDTIMEO, write_timeout_sec,
  6237. write_timeout_usec);
  6238. error = Error::Success;
  6239. return true;
  6240. },
  6241. connection_timeout_sec); // Pass DNS timeout
  6242. if (sock != INVALID_SOCKET) {
  6243. error = Error::Success;
  6244. } else {
  6245. if (error == Error::Success) { error = Error::Connection; }
  6246. }
  6247. return sock;
  6248. }
  6249. inline bool get_ip_and_port(const struct sockaddr_storage &addr,
  6250. socklen_t addr_len, std::string &ip, int &port) {
  6251. if (addr.ss_family == AF_INET) {
  6252. port = ntohs(reinterpret_cast<const struct sockaddr_in *>(&addr)->sin_port);
  6253. } else if (addr.ss_family == AF_INET6) {
  6254. port =
  6255. ntohs(reinterpret_cast<const struct sockaddr_in6 *>(&addr)->sin6_port);
  6256. } else {
  6257. return false;
  6258. }
  6259. std::array<char, NI_MAXHOST> ipstr{};
  6260. if (getnameinfo(reinterpret_cast<const struct sockaddr *>(&addr), addr_len,
  6261. ipstr.data(), static_cast<socklen_t>(ipstr.size()), nullptr,
  6262. 0, NI_NUMERICHOST)) {
  6263. return false;
  6264. }
  6265. ip = ipstr.data();
  6266. return true;
  6267. }
  6268. inline void get_local_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6269. struct sockaddr_storage addr;
  6270. socklen_t addr_len = sizeof(addr);
  6271. if (!getsockname(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6272. &addr_len)) {
  6273. get_ip_and_port(addr, addr_len, ip, port);
  6274. }
  6275. }
  6276. inline void get_remote_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6277. struct sockaddr_storage addr;
  6278. socklen_t addr_len = sizeof(addr);
  6279. if (!getpeername(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6280. &addr_len)) {
  6281. #ifndef _WIN32
  6282. if (addr.ss_family == AF_UNIX) {
  6283. #if defined(__linux__)
  6284. struct ucred ucred;
  6285. socklen_t len = sizeof(ucred);
  6286. if (getsockopt(sock, SOL_SOCKET, SO_PEERCRED, &ucred, &len) == 0) {
  6287. port = ucred.pid;
  6288. }
  6289. #elif defined(SOL_LOCAL) && defined(SO_PEERPID)
  6290. pid_t pid;
  6291. socklen_t len = sizeof(pid);
  6292. if (getsockopt(sock, SOL_LOCAL, SO_PEERPID, &pid, &len) == 0) {
  6293. port = pid;
  6294. }
  6295. #endif
  6296. return;
  6297. }
  6298. #endif
  6299. get_ip_and_port(addr, addr_len, ip, port);
  6300. }
  6301. }
  6302. inline std::string
  6303. find_content_type(const std::string &path,
  6304. const std::map<std::string, std::string> &user_data,
  6305. const std::string &default_content_type) {
  6306. auto ext = file_extension(path);
  6307. auto it = user_data.find(ext);
  6308. if (it != user_data.end()) { return it->second; }
  6309. static const struct {
  6310. const char *ext;
  6311. const char *type;
  6312. } types[] = {
  6313. {"css", "text/css"},
  6314. {"csv", "text/csv"},
  6315. {"htm", "text/html"},
  6316. {"html", "text/html"},
  6317. {"js", "text/javascript"},
  6318. {"mjs", "text/javascript"},
  6319. {"txt", "text/plain"},
  6320. {"vtt", "text/vtt"},
  6321. {"apng", "image/apng"},
  6322. {"avif", "image/avif"},
  6323. {"bmp", "image/bmp"},
  6324. {"gif", "image/gif"},
  6325. {"png", "image/png"},
  6326. {"svg", "image/svg+xml"},
  6327. {"webp", "image/webp"},
  6328. {"ico", "image/x-icon"},
  6329. {"tif", "image/tiff"},
  6330. {"tiff", "image/tiff"},
  6331. {"jpg", "image/jpeg"},
  6332. {"jpeg", "image/jpeg"},
  6333. {"mp4", "video/mp4"},
  6334. {"mpeg", "video/mpeg"},
  6335. {"webm", "video/webm"},
  6336. {"mp3", "audio/mp3"},
  6337. {"mpga", "audio/mpeg"},
  6338. {"weba", "audio/webm"},
  6339. {"wav", "audio/wave"},
  6340. {"otf", "font/otf"},
  6341. {"ttf", "font/ttf"},
  6342. {"woff", "font/woff"},
  6343. {"woff2", "font/woff2"},
  6344. {"7z", "application/x-7z-compressed"},
  6345. {"atom", "application/atom+xml"},
  6346. {"pdf", "application/pdf"},
  6347. {"json", "application/json"},
  6348. {"rss", "application/rss+xml"},
  6349. {"tar", "application/x-tar"},
  6350. {"xht", "application/xhtml+xml"},
  6351. {"xhtml", "application/xhtml+xml"},
  6352. {"xslt", "application/xslt+xml"},
  6353. {"xml", "application/xml"},
  6354. {"gz", "application/gzip"},
  6355. {"zip", "application/zip"},
  6356. {"wasm", "application/wasm"},
  6357. };
  6358. for (const auto &t : types) {
  6359. if (ext == t.ext) { return t.type; }
  6360. }
  6361. return default_content_type;
  6362. }
  6363. inline std::string
  6364. extract_media_type(const std::string &content_type,
  6365. std::map<std::string, std::string> *params = nullptr) {
  6366. // Extract type/subtype from Content-Type value (RFC 2045)
  6367. // e.g. "application/json; charset=utf-8" -> "application/json"
  6368. auto media_type = content_type;
  6369. auto semicolon_pos = media_type.find(';');
  6370. if (semicolon_pos != std::string::npos) {
  6371. auto param_str = media_type.substr(semicolon_pos + 1);
  6372. media_type = media_type.substr(0, semicolon_pos);
  6373. if (params) {
  6374. // Parse parameters: key=value pairs separated by ';'
  6375. split_unquoted(param_str.data(), param_str.data() + param_str.size(), ';',
  6376. [&](const char *b, const char *e) {
  6377. std::string key;
  6378. std::string val;
  6379. divide_param_pair(b, e, key, val);
  6380. if (!key.empty()) {
  6381. params->emplace(trim_copy(key),
  6382. trim_double_quotes_copy(val));
  6383. }
  6384. });
  6385. }
  6386. }
  6387. // Trim whitespace from media type
  6388. return trim_copy(media_type);
  6389. }
  6390. inline bool can_compress_content_type(const std::string &content_type) {
  6391. auto mime_type = extract_media_type(content_type);
  6392. static const char *const compressible[] = {
  6393. "image/svg+xml",
  6394. "application/javascript",
  6395. "application/x-javascript",
  6396. "application/json",
  6397. "application/ld+json",
  6398. "application/xml",
  6399. "application/xhtml+xml",
  6400. "application/rss+xml",
  6401. "application/atom+xml",
  6402. "application/xslt+xml",
  6403. "application/protobuf",
  6404. };
  6405. for (auto type : compressible) {
  6406. if (mime_type == type) { return true; }
  6407. }
  6408. return mime_type != "text/event-stream" && !mime_type.rfind("text/", 0);
  6409. }
  6410. inline bool parse_quality(const char *b, const char *e, std::string &token,
  6411. double &quality) {
  6412. quality = 1.0;
  6413. token.clear();
  6414. // Split on first ';': left = token name, right = parameters
  6415. const char *params_b = nullptr;
  6416. std::size_t params_len = 0;
  6417. divide(
  6418. b, static_cast<std::size_t>(e - b), ';',
  6419. [&](const char *lb, std::size_t llen, const char *rb, std::size_t rlen) {
  6420. auto r = trim(lb, lb + llen, 0, llen);
  6421. if (r.first < r.second) { token.assign(lb + r.first, lb + r.second); }
  6422. params_b = rb;
  6423. params_len = rlen;
  6424. });
  6425. if (token.empty()) { return false; }
  6426. if (params_len == 0) { return true; }
  6427. // Scan parameters for q= (stops on first match)
  6428. bool invalid = false;
  6429. split_find(params_b, params_b + params_len, ';',
  6430. (std::numeric_limits<size_t>::max)(),
  6431. [&](const char *pb, const char *pe) -> bool {
  6432. // Match exactly "q=" or "Q=" (not "query=" etc.)
  6433. auto len = static_cast<size_t>(pe - pb);
  6434. if (len < 2) { return false; }
  6435. if ((pb[0] != 'q' && pb[0] != 'Q') || pb[1] != '=') {
  6436. return false;
  6437. }
  6438. // Trim the value portion
  6439. auto r = trim(pb, pe, 2, len);
  6440. if (r.first >= r.second) {
  6441. invalid = true;
  6442. return true;
  6443. }
  6444. double v = 0.0;
  6445. auto res = from_chars(pb + r.first, pb + r.second, v);
  6446. if (res.ec != std::errc{} || res.ptr != pb + r.second ||
  6447. v < 0.0 || v > 1.0) {
  6448. invalid = true;
  6449. return true;
  6450. }
  6451. quality = v;
  6452. return true;
  6453. });
  6454. return !invalid;
  6455. }
  6456. inline EncodingType encoding_type(const Request &req,
  6457. const std::string &content_type) {
  6458. if (!can_compress_content_type(content_type)) { return EncodingType::None; }
  6459. auto s = get_combined_header_value(req.headers, "Accept-Encoding");
  6460. if (s.empty()) { return EncodingType::None; }
  6461. // Single-pass: iterate tokens and track the best supported encoding.
  6462. // Server preference breaks ties (br > gzip > zstd).
  6463. EncodingType best = EncodingType::None;
  6464. double best_q = 0.0; // q=0 means "not acceptable"
  6465. // Server preference: Brotli > Gzip > Zstd (lower = more preferred)
  6466. auto priority = [](EncodingType t) -> int {
  6467. switch (t) {
  6468. case EncodingType::Brotli: return 0;
  6469. case EncodingType::Gzip: return 1;
  6470. case EncodingType::Zstd: return 2;
  6471. default: return 3;
  6472. }
  6473. };
  6474. std::string name;
  6475. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  6476. double quality = 1.0;
  6477. if (!parse_quality(b, e, name, quality)) { return; }
  6478. if (quality <= 0.0) { return; }
  6479. EncodingType type = EncodingType::None;
  6480. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6481. if (case_ignore::equal(name, "br")) { type = EncodingType::Brotli; }
  6482. #endif
  6483. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6484. if (type == EncodingType::None && case_ignore::equal(name, "gzip")) {
  6485. type = EncodingType::Gzip;
  6486. }
  6487. #endif
  6488. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6489. if (type == EncodingType::None && case_ignore::equal(name, "zstd")) {
  6490. type = EncodingType::Zstd;
  6491. }
  6492. #endif
  6493. if (type == EncodingType::None) { return; }
  6494. // Higher q-value wins; for equal q, server preference breaks ties
  6495. if (quality > best_q ||
  6496. (quality == best_q && priority(type) < priority(best))) {
  6497. best_q = quality;
  6498. best = type;
  6499. }
  6500. });
  6501. return best;
  6502. }
  6503. // `content_type` is taken separately because a file-backed response has not
  6504. // been given one yet when its coding has to be decided.
  6505. inline EncodingType encoding_type(const Request &req, const Response &res,
  6506. const std::string &content_type) {
  6507. // The response already names a content coding of its own: a handler serving
  6508. // a body it encoded itself (pre-compressed static assets, say), or a mount
  6509. // point whose headers name the coding its files are stored in. Applying one
  6510. // on top of that would double-encode the body and append a second
  6511. // `Content-Encoding` field line.
  6512. if (res.has_header("Content-Encoding")) { return EncodingType::None; }
  6513. return encoding_type(req, content_type);
  6514. }
  6515. inline EncodingType encoding_type(const Request &req, const Response &res) {
  6516. return encoding_type(req, res, res.get_header_value("Content-Type"));
  6517. }
  6518. inline std::unique_ptr<compressor> make_compressor(EncodingType type) {
  6519. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6520. if (type == EncodingType::Gzip) {
  6521. return detail::make_unique<gzip_compressor>();
  6522. }
  6523. #endif
  6524. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6525. if (type == EncodingType::Brotli) {
  6526. return detail::make_unique<brotli_compressor>();
  6527. }
  6528. #endif
  6529. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6530. if (type == EncodingType::Zstd) {
  6531. return detail::make_unique<zstd_compressor>();
  6532. }
  6533. #endif
  6534. (void)type;
  6535. return nullptr;
  6536. }
  6537. inline const char *encoding_name(EncodingType type) {
  6538. switch (type) {
  6539. case EncodingType::Gzip: return "gzip";
  6540. case EncodingType::Brotli: return "br";
  6541. case EncodingType::Zstd: return "zstd";
  6542. default: return "";
  6543. }
  6544. }
  6545. inline bool nocompressor::compress(const char *data, size_t data_length,
  6546. bool /*last*/, Callback callback) {
  6547. if (!data_length) { return true; }
  6548. return callback(data, data_length);
  6549. }
  6550. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6551. inline gzip_compressor::gzip_compressor() {
  6552. std::memset(&strm_, 0, sizeof(strm_));
  6553. strm_.zalloc = Z_NULL;
  6554. strm_.zfree = Z_NULL;
  6555. strm_.opaque = Z_NULL;
  6556. is_valid_ = deflateInit2(&strm_, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 31, 8,
  6557. Z_DEFAULT_STRATEGY) == Z_OK;
  6558. }
  6559. inline gzip_compressor::~gzip_compressor() { deflateEnd(&strm_); }
  6560. inline bool gzip_compressor::compress(const char *data, size_t data_length,
  6561. bool last, Callback callback) {
  6562. assert(is_valid_);
  6563. do {
  6564. constexpr size_t max_avail_in =
  6565. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6566. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6567. (std::min)(data_length, max_avail_in));
  6568. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6569. data_length -= strm_.avail_in;
  6570. data += strm_.avail_in;
  6571. auto flush = (last && data_length == 0) ? Z_FINISH : Z_NO_FLUSH;
  6572. auto ret = Z_OK;
  6573. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6574. do {
  6575. strm_.avail_out = static_cast<uInt>(buff.size());
  6576. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6577. ret = deflate(&strm_, flush);
  6578. if (ret == Z_STREAM_ERROR) { return false; }
  6579. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6580. return false;
  6581. }
  6582. } while (strm_.avail_out == 0);
  6583. assert((flush == Z_FINISH && ret == Z_STREAM_END) ||
  6584. (flush == Z_NO_FLUSH && ret == Z_OK));
  6585. assert(strm_.avail_in == 0);
  6586. } while (data_length > 0);
  6587. return true;
  6588. }
  6589. inline gzip_decompressor::gzip_decompressor() {
  6590. std::memset(&strm_, 0, sizeof(strm_));
  6591. strm_.zalloc = Z_NULL;
  6592. strm_.zfree = Z_NULL;
  6593. strm_.opaque = Z_NULL;
  6594. // 15 is the value of wbits, which should be at the maximum possible value
  6595. // to ensure that any gzip stream can be decoded. The offset of 32 specifies
  6596. // that the stream type should be automatically detected either gzip or
  6597. // deflate.
  6598. is_valid_ = inflateInit2(&strm_, 32 + 15) == Z_OK;
  6599. }
  6600. inline gzip_decompressor::~gzip_decompressor() { inflateEnd(&strm_); }
  6601. inline bool gzip_decompressor::is_valid() const { return is_valid_; }
  6602. inline bool gzip_decompressor::decompress(const char *data, size_t data_length,
  6603. Callback callback) {
  6604. assert(is_valid_);
  6605. auto ret = Z_OK;
  6606. do {
  6607. constexpr size_t max_avail_in =
  6608. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6609. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6610. (std::min)(data_length, max_avail_in));
  6611. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6612. data_length -= strm_.avail_in;
  6613. data += strm_.avail_in;
  6614. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6615. while (strm_.avail_in > 0 && ret == Z_OK) {
  6616. strm_.avail_out = static_cast<uInt>(buff.size());
  6617. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6618. ret = inflate(&strm_, Z_NO_FLUSH);
  6619. assert(ret != Z_STREAM_ERROR);
  6620. switch (ret) {
  6621. case Z_NEED_DICT:
  6622. case Z_DATA_ERROR:
  6623. case Z_MEM_ERROR: inflateEnd(&strm_); return false;
  6624. }
  6625. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6626. return false;
  6627. }
  6628. }
  6629. if (ret != Z_OK && ret != Z_STREAM_END) { return false; }
  6630. } while (data_length > 0);
  6631. return true;
  6632. }
  6633. #endif
  6634. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6635. inline brotli_compressor::brotli_compressor() {
  6636. state_ = BrotliEncoderCreateInstance(nullptr, nullptr, nullptr);
  6637. }
  6638. inline brotli_compressor::~brotli_compressor() {
  6639. BrotliEncoderDestroyInstance(state_);
  6640. }
  6641. inline bool brotli_compressor::compress(const char *data, size_t data_length,
  6642. bool last, Callback callback) {
  6643. std::array<uint8_t, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6644. auto operation = last ? BROTLI_OPERATION_FINISH : BROTLI_OPERATION_PROCESS;
  6645. auto available_in = data_length;
  6646. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6647. for (;;) {
  6648. if (last) {
  6649. if (BrotliEncoderIsFinished(state_)) { break; }
  6650. } else {
  6651. if (!available_in) { break; }
  6652. }
  6653. auto available_out = buff.size();
  6654. auto next_out = buff.data();
  6655. if (!BrotliEncoderCompressStream(state_, operation, &available_in, &next_in,
  6656. &available_out, &next_out, nullptr)) {
  6657. return false;
  6658. }
  6659. auto output_bytes = buff.size() - available_out;
  6660. if (output_bytes) {
  6661. callback(reinterpret_cast<const char *>(buff.data()), output_bytes);
  6662. }
  6663. }
  6664. return true;
  6665. }
  6666. inline brotli_decompressor::brotli_decompressor() {
  6667. decoder_s = BrotliDecoderCreateInstance(0, 0, 0);
  6668. decoder_r = decoder_s ? BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT
  6669. : BROTLI_DECODER_RESULT_ERROR;
  6670. }
  6671. inline brotli_decompressor::~brotli_decompressor() {
  6672. if (decoder_s) { BrotliDecoderDestroyInstance(decoder_s); }
  6673. }
  6674. inline bool brotli_decompressor::is_valid() const { return decoder_s; }
  6675. inline bool brotli_decompressor::decompress(const char *data,
  6676. size_t data_length,
  6677. Callback callback) {
  6678. if (decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6679. decoder_r == BROTLI_DECODER_RESULT_ERROR) {
  6680. return 0;
  6681. }
  6682. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6683. size_t avail_in = data_length;
  6684. size_t total_out;
  6685. decoder_r = BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT;
  6686. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6687. while (decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT) {
  6688. char *next_out = buff.data();
  6689. size_t avail_out = buff.size();
  6690. decoder_r = BrotliDecoderDecompressStream(
  6691. decoder_s, &avail_in, &next_in, &avail_out,
  6692. reinterpret_cast<uint8_t **>(&next_out), &total_out);
  6693. if (decoder_r == BROTLI_DECODER_RESULT_ERROR) { return false; }
  6694. if (!callback(buff.data(), buff.size() - avail_out)) { return false; }
  6695. }
  6696. return decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6697. decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT;
  6698. }
  6699. #endif
  6700. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6701. inline zstd_compressor::zstd_compressor() {
  6702. ctx_ = ZSTD_createCCtx();
  6703. ZSTD_CCtx_setParameter(ctx_, ZSTD_c_compressionLevel, ZSTD_fast);
  6704. }
  6705. inline zstd_compressor::~zstd_compressor() { ZSTD_freeCCtx(ctx_); }
  6706. inline bool zstd_compressor::compress(const char *data, size_t data_length,
  6707. bool last, Callback callback) {
  6708. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6709. ZSTD_EndDirective mode = last ? ZSTD_e_end : ZSTD_e_continue;
  6710. ZSTD_inBuffer input = {data, data_length, 0};
  6711. bool finished;
  6712. do {
  6713. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6714. size_t const remaining = ZSTD_compressStream2(ctx_, &output, &input, mode);
  6715. if (ZSTD_isError(remaining)) { return false; }
  6716. if (!callback(buff.data(), output.pos)) { return false; }
  6717. finished = last ? (remaining == 0) : (input.pos == input.size);
  6718. } while (!finished);
  6719. return true;
  6720. }
  6721. inline zstd_decompressor::zstd_decompressor() { ctx_ = ZSTD_createDCtx(); }
  6722. inline zstd_decompressor::~zstd_decompressor() { ZSTD_freeDCtx(ctx_); }
  6723. inline bool zstd_decompressor::is_valid() const { return ctx_ != nullptr; }
  6724. inline bool zstd_decompressor::decompress(const char *data, size_t data_length,
  6725. Callback callback) {
  6726. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6727. ZSTD_inBuffer input = {data, data_length, 0};
  6728. while (input.pos < input.size) {
  6729. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6730. size_t const remaining = ZSTD_decompressStream(ctx_, &output, &input);
  6731. if (ZSTD_isError(remaining)) { return false; }
  6732. if (!callback(buff.data(), output.pos)) { return false; }
  6733. }
  6734. return true;
  6735. }
  6736. #endif
  6737. // Content codings are case-insensitive (RFC 9110 8.4.1). Matching them
  6738. // case-sensitively would make a response labeled e.g. "GZIP" look like an
  6739. // unknown coding, and its payload would be handed back still compressed.
  6740. inline bool is_zlib_encoding(const std::string &encoding) {
  6741. return case_ignore::equal(encoding, "gzip") ||
  6742. case_ignore::equal(encoding, "deflate");
  6743. }
  6744. inline bool is_brotli_encoding(const std::string &encoding) {
  6745. return case_ignore::equal(encoding, "br");
  6746. }
  6747. inline bool is_zstd_encoding(const std::string &encoding) {
  6748. return case_ignore::equal(encoding, "zstd");
  6749. }
  6750. // Returns true if the content coding is one cpp-httplib is able to decompress
  6751. // when the corresponding support is compiled in.
  6752. inline bool is_known_content_encoding(const std::string &encoding) {
  6753. return is_zlib_encoding(encoding) || is_brotli_encoding(encoding) ||
  6754. is_zstd_encoding(encoding);
  6755. }
  6756. inline std::unique_ptr<decompressor>
  6757. create_decompressor(const std::string &encoding) {
  6758. std::unique_ptr<decompressor> decompressor;
  6759. if (is_zlib_encoding(encoding)) {
  6760. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6761. decompressor = detail::make_unique<gzip_decompressor>();
  6762. #endif
  6763. } else if (is_brotli_encoding(encoding)) {
  6764. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6765. decompressor = detail::make_unique<brotli_decompressor>();
  6766. #endif
  6767. } else if (is_zstd_encoding(encoding)) {
  6768. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6769. decompressor = detail::make_unique<zstd_decompressor>();
  6770. #endif
  6771. }
  6772. return decompressor;
  6773. }
  6774. // Returns the best available compressor and its Content-Encoding name.
  6775. // Priority: Brotli > Gzip > Zstd (matches server-side preference).
  6776. inline std::pair<std::unique_ptr<compressor>, const char *>
  6777. create_compressor() {
  6778. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6779. return {detail::make_unique<brotli_compressor>(), "br"};
  6780. #elif defined(CPPHTTPLIB_ZLIB_SUPPORT)
  6781. return {detail::make_unique<gzip_compressor>(), "gzip"};
  6782. #elif defined(CPPHTTPLIB_ZSTD_SUPPORT)
  6783. return {detail::make_unique<zstd_compressor>(), "zstd"};
  6784. #else
  6785. return {nullptr, nullptr};
  6786. #endif
  6787. }
  6788. // s == lit, comparing the lengths first, which operator== may not do.
  6789. template <size_t N>
  6790. inline bool equals_literal(const std::string &s, const char (&lit)[N]) {
  6791. return s.size() == N - 1 && !s.compare(0, N - 1, lit);
  6792. }
  6793. inline bool is_prohibited_header_name(const std::string &name) {
  6794. // Every header lookup by name runs this.
  6795. return equals_literal(name, "REMOTE_ADDR") ||
  6796. equals_literal(name, "REMOTE_PORT") ||
  6797. equals_literal(name, "LOCAL_ADDR") ||
  6798. equals_literal(name, "LOCAL_PORT");
  6799. }
  6800. inline bool has_header(const Headers &headers, const std::string &key) {
  6801. if (is_prohibited_header_name(key)) { return false; }
  6802. return headers.find(key) != headers.end();
  6803. }
  6804. inline const char *get_header_value(const Headers &headers,
  6805. const std::string &key, const char *def,
  6806. size_t id) {
  6807. if (is_prohibited_header_name(key)) {
  6808. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  6809. std::string msg = "Prohibited header name '" + key + "' is specified.";
  6810. throw std::invalid_argument(msg);
  6811. #else
  6812. return "";
  6813. #endif
  6814. }
  6815. auto rng = headers.equal_range(key);
  6816. auto it = bounded_next(rng.first, id, rng.second);
  6817. if (it != rng.second) { return it->second.c_str(); }
  6818. return def;
  6819. }
  6820. inline size_t get_header_value_count(const Headers &headers,
  6821. const std::string &key) {
  6822. return headers.count(key);
  6823. }
  6824. // RFC 9110 Section 5.2 and 5.3: a field that is defined as a comma-separated
  6825. // list may be sent as several field lines, and the combined field value is
  6826. // those values joined by commas in the order they were received. Callers that
  6827. // parse such a list must work on the combined value; reading only the first
  6828. // occurrence silently drops whatever the later field lines carry.
  6829. inline std::string get_combined_header_value(const Headers &headers,
  6830. const std::string &key) {
  6831. std::string combined;
  6832. auto rng = headers.equal_range(key);
  6833. for (auto it = rng.first; it != rng.second; ++it) {
  6834. // RFC 9110 Section 5.6.1.2: a recipient has to parse and ignore empty list
  6835. // elements, so an empty field line must not contribute a bare comma to the
  6836. // combined value.
  6837. if (it->second.empty()) { continue; }
  6838. if (!combined.empty()) { combined += ", "; }
  6839. combined += it->second;
  6840. }
  6841. return combined;
  6842. }
  6843. inline bool has_header_token(const Headers &headers, const std::string &key,
  6844. const std::string &token) {
  6845. // RFC 9110 7.6.1: a comma-separated token list field such as Connection may
  6846. // carry several tokens, and RFC 9110 5.3 lets that list be split across
  6847. // several lines. Match complete tokens rather than searching the raw value,
  6848. // so that a value such as "notupgrade" is not read as the token "upgrade".
  6849. auto rng = headers.equal_range(key);
  6850. for (auto it = rng.first; it != rng.second; ++it) {
  6851. const auto &value = it->second;
  6852. if (split_find(value.data(), value.data() + value.size(), ',',
  6853. [&](const char *b, const char *e) {
  6854. return case_ignore::equal(std::string(b, e), token);
  6855. })) {
  6856. return true;
  6857. }
  6858. }
  6859. return false;
  6860. }
  6861. template <typename Map>
  6862. inline typename Map::mapped_type
  6863. get_multimap_value(const Map &m, const std::string &key, size_t id) {
  6864. auto rng = m.equal_range(key);
  6865. auto it = bounded_next(rng.first, id, rng.second);
  6866. if (it != rng.second) { return it->second; }
  6867. return typename Map::mapped_type();
  6868. }
  6869. inline void set_header(Headers &headers, const std::string &key,
  6870. const std::string &val) {
  6871. if (fields::is_field_valid(key, val)) { headers.emplace(key, val); }
  6872. }
  6873. inline bool read_headers(Stream &strm, Headers &headers) {
  6874. const auto bufsiz = 2048;
  6875. char buf[bufsiz];
  6876. stream_line_reader line_reader(strm, buf, bufsiz);
  6877. size_t header_count = 0;
  6878. for (;;) {
  6879. if (!line_reader.getline()) { return false; }
  6880. // Check if the line ends with CRLF.
  6881. auto line_terminator_len = 2;
  6882. if (line_reader.end_with_crlf()) {
  6883. // Blank line indicates end of headers.
  6884. if (line_reader.size() == 2) { break; }
  6885. } else {
  6886. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  6887. // Blank line indicates end of headers.
  6888. if (line_reader.size() == 1) { break; }
  6889. line_terminator_len = 1;
  6890. #else
  6891. continue; // Skip invalid line.
  6892. #endif
  6893. }
  6894. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  6895. // Check header count limit
  6896. if (header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  6897. // Exclude line terminator
  6898. auto end = line_reader.ptr() + line_reader.size() - line_terminator_len;
  6899. if (!parse_header(line_reader.ptr(), end,
  6900. [&](const std::string &key, const std::string &val) {
  6901. headers.emplace(key, val);
  6902. })) {
  6903. return false;
  6904. }
  6905. header_count++;
  6906. }
  6907. // RFC 9110 Section 8.6: Reject requests with multiple Content-Length
  6908. // headers that have different values to prevent request smuggling.
  6909. auto cl_range = headers.equal_range("Content-Length");
  6910. if (cl_range.first != cl_range.second) {
  6911. const auto &first_val = cl_range.first->second;
  6912. for (auto it = std::next(cl_range.first); it != cl_range.second; ++it) {
  6913. if (it->second != first_val) { return false; }
  6914. }
  6915. }
  6916. return true;
  6917. }
  6918. // Parsed by hand: std::regex_match recurses once per character of the reason
  6919. // phrase, which a server can make as long as a whole line.
  6920. inline bool parse_status_line(const char *line, std::string &version,
  6921. int &status, std::string &reason) {
  6922. if (std::strncmp(line, "HTTP/1.", 7) != 0 ||
  6923. (line[7] != '0' && line[7] != '1') || line[8] != ' ' ||
  6924. !is_ascii_digit(line[9]) || !is_ascii_digit(line[10]) ||
  6925. !is_ascii_digit(line[11])) {
  6926. return false;
  6927. }
  6928. auto p = line + 12;
  6929. auto reason_begin = p;
  6930. if (*p == ' ') {
  6931. reason_begin = ++p;
  6932. p += std::strcspn(p, "\r\n");
  6933. }
  6934. auto reason_end = p;
  6935. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  6936. if (*p == '\r') { p++; }
  6937. #else
  6938. if (*p++ != '\r') { return false; }
  6939. #endif
  6940. if (*p++ != '\n' || *p != '\0') { return false; }
  6941. version.assign(line, 8);
  6942. status = (line[9] - '0') * 100 + (line[10] - '0') * 10 + (line[11] - '0');
  6943. reason.assign(reason_begin, reason_end);
  6944. return true;
  6945. }
  6946. // Everything WebSocketClient::connect() reports about the upgrade exchange.
  6947. // status stays -1 until a status line is parsed, mirroring stream::Result.
  6948. struct WebSocketUpgradeResponse {
  6949. Error error = Error::Success;
  6950. int status = -1;
  6951. Headers headers;
  6952. std::string selected_subprotocol;
  6953. };
  6954. inline bool
  6955. read_websocket_upgrade_response(Stream &strm,
  6956. const std::string &expected_accept,
  6957. const std::string &offered_subprotocols,
  6958. WebSocketUpgradeResponse &upgrade) {
  6959. // Read status line
  6960. const auto bufsiz = 2048;
  6961. char buf[bufsiz];
  6962. stream_line_reader line_reader(strm, buf, bufsiz);
  6963. if (!line_reader.getline()) {
  6964. upgrade.error = Error::Read;
  6965. return false;
  6966. }
  6967. std::string version;
  6968. std::string reason;
  6969. if (!parse_status_line(line_reader.ptr(), version, upgrade.status, reason)) {
  6970. upgrade.error = Error::WebSocketHandshake;
  6971. return false;
  6972. }
  6973. // Read the headers even for a rejection so the caller can see why the
  6974. // server refused the upgrade. A non-101 response may carry a body; it is
  6975. // deliberately left unread since the caller closes the socket right away.
  6976. if (!read_headers(strm, upgrade.headers)) {
  6977. upgrade.error = Error::Read;
  6978. return false;
  6979. }
  6980. const auto &headers = upgrade.headers;
  6981. if (upgrade.status != StatusCode::SwitchingProtocol_101) {
  6982. upgrade.error = Error::WebSocketHandshake;
  6983. return false;
  6984. }
  6985. // Verify Upgrade: websocket (a comma-separated list, matched per token)
  6986. if (!has_header_token(headers, "Upgrade", "websocket")) {
  6987. upgrade.error = Error::WebSocketHandshake;
  6988. return false;
  6989. }
  6990. // Verify Connection: Upgrade
  6991. if (!has_header_token(headers, "Connection", "upgrade")) {
  6992. upgrade.error = Error::WebSocketHandshake;
  6993. return false;
  6994. }
  6995. // Verify Sec-WebSocket-Accept header value
  6996. auto it = headers.find("Sec-WebSocket-Accept");
  6997. if (it == headers.end() || it->second != expected_accept) {
  6998. upgrade.error = Error::WebSocketHandshake;
  6999. return false;
  7000. }
  7001. // Extract negotiated subprotocol
  7002. auto proto_it = headers.find("Sec-WebSocket-Protocol");
  7003. if (proto_it != headers.end()) {
  7004. upgrade.selected_subprotocol = proto_it->second;
  7005. }
  7006. // Verify the subprotocol is one the client offered (RFC 6455 4.1)
  7007. if (!upgrade.selected_subprotocol.empty()) {
  7008. auto was_offered = false;
  7009. split(offered_subprotocols.data(),
  7010. offered_subprotocols.data() + offered_subprotocols.size(), ',',
  7011. [&](const char *b, const char *e) {
  7012. if (std::string(b, e) == upgrade.selected_subprotocol) {
  7013. was_offered = true;
  7014. }
  7015. });
  7016. if (!was_offered) {
  7017. upgrade.error = Error::WebSocketHandshake;
  7018. return false;
  7019. }
  7020. }
  7021. return true;
  7022. }
  7023. enum class ReadContentResult {
  7024. Success, // Successfully read the content
  7025. PayloadTooLarge, // The content exceeds the specified payload limit
  7026. Error // An error occurred while reading the content
  7027. };
  7028. inline ReadContentResult read_content_with_length(
  7029. Stream &strm, size_t len, DownloadProgress progress,
  7030. ContentReceiverWithProgress out,
  7031. size_t payload_max_length = (std::numeric_limits<size_t>::max)()) {
  7032. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7033. detail::BodyReader br;
  7034. br.stream = &strm;
  7035. br.has_content_length = true;
  7036. br.content_length = len;
  7037. br.payload_max_length = payload_max_length;
  7038. br.chunked = false;
  7039. br.bytes_read = 0;
  7040. br.last_error = Error::Success;
  7041. size_t r = 0;
  7042. while (r < len) {
  7043. auto read_len = static_cast<size_t>(len - r);
  7044. auto to_read = (std::min)(read_len, CPPHTTPLIB_RECV_BUFSIZ);
  7045. auto n = detail::read_body_content(&strm, br, buf, to_read);
  7046. if (n <= 0) {
  7047. // Check if it was a payload size error
  7048. if (br.last_error == Error::ExceedMaxPayloadSize) {
  7049. return ReadContentResult::PayloadTooLarge;
  7050. }
  7051. return ReadContentResult::Error;
  7052. }
  7053. if (!out(buf, static_cast<size_t>(n), r, len)) {
  7054. return ReadContentResult::Error;
  7055. }
  7056. r += static_cast<size_t>(n);
  7057. if (progress) {
  7058. if (!progress(r, len)) { return ReadContentResult::Error; }
  7059. }
  7060. }
  7061. return ReadContentResult::Success;
  7062. }
  7063. inline ReadContentResult
  7064. read_content_without_length(Stream &strm, size_t payload_max_length,
  7065. ContentReceiverWithProgress out) {
  7066. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7067. size_t r = 0;
  7068. for (;;) {
  7069. auto n = strm.read(buf, CPPHTTPLIB_RECV_BUFSIZ);
  7070. if (n == 0) { return ReadContentResult::Success; }
  7071. if (n < 0) { return ReadContentResult::Error; }
  7072. // Check if adding this data would exceed the payload limit
  7073. if (payload_max_length > 0 &&
  7074. (r > payload_max_length ||
  7075. payload_max_length - r < static_cast<size_t>(n))) {
  7076. return ReadContentResult::PayloadTooLarge;
  7077. }
  7078. if (!out(buf, static_cast<size_t>(n), r, 0)) {
  7079. return ReadContentResult::Error;
  7080. }
  7081. r += static_cast<size_t>(n);
  7082. }
  7083. return ReadContentResult::Success;
  7084. }
  7085. template <typename T>
  7086. inline ReadContentResult read_content_chunked(Stream &strm, T &x,
  7087. size_t payload_max_length,
  7088. ContentReceiverWithProgress out) {
  7089. detail::ChunkedDecoder dec(strm);
  7090. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7091. size_t total_len = 0;
  7092. for (;;) {
  7093. size_t chunk_offset = 0;
  7094. size_t chunk_total = 0;
  7095. auto n = dec.read_payload(buf, sizeof(buf), chunk_offset, chunk_total);
  7096. if (n < 0) { return ReadContentResult::Error; }
  7097. if (n == 0) {
  7098. if (!dec.parse_trailers_into(x.trailers, x.headers)) {
  7099. return ReadContentResult::Error;
  7100. }
  7101. return ReadContentResult::Success;
  7102. }
  7103. if (payload_max_length > 0 &&
  7104. (total_len > payload_max_length ||
  7105. payload_max_length - total_len < static_cast<size_t>(n))) {
  7106. return ReadContentResult::PayloadTooLarge;
  7107. }
  7108. if (!out(buf, static_cast<size_t>(n), chunk_offset, chunk_total)) {
  7109. return ReadContentResult::Error;
  7110. }
  7111. total_len += static_cast<size_t>(n);
  7112. }
  7113. }
  7114. inline bool is_chunked_transfer_encoding(const Headers &headers) {
  7115. // RFC 9112 6.1: a message is framed with the chunked coding when "chunked"
  7116. // is the final transfer coding. A single field value may list several
  7117. // codings ("gzip, chunked"), and RFC 9110 5.3 lets that list be split across
  7118. // several Transfer-Encoding lines, which combine into one comma-separated
  7119. // list in the order the lines were received. Headers preserves that order,
  7120. // so the final coding is the last token of the last line. Match it
  7121. // case-insensitively rather than comparing the whole value against
  7122. // "chunked".
  7123. //
  7124. // Security: reading a chunked message as unframed leaves its body in the
  7125. // socket, where a keep-alive connection parses it as a smuggled request.
  7126. // Server::process_request() answers 400 and closes when the final coding is
  7127. // not chunked, so a request whose framing cannot be determined never
  7128. // reaches the "no body" path.
  7129. auto rng = headers.equal_range("Transfer-Encoding");
  7130. if (rng.first == rng.second) { return false; }
  7131. // Cleared per line, so a trailing line carrying no coding at all leaves the
  7132. // combined list ending in nothing rather than inheriting the line before it.
  7133. std::string last_coding;
  7134. for (auto it = rng.first; it != rng.second; ++it) {
  7135. const auto &value = it->second;
  7136. last_coding.clear();
  7137. split(value.data(), value.data() + value.size(), ',',
  7138. [&](const char *b, const char *e) { last_coding.assign(b, e); });
  7139. }
  7140. return case_ignore::equal(last_coding, "chunked");
  7141. }
  7142. inline bool has_conflicting_content_length(const Headers &headers) {
  7143. // RFC 9112 §6.3: a message carrying both Transfer-Encoding and a non-zero
  7144. // Content-Length is framed ambiguously. The body readers here delimit it by
  7145. // the transfer coding and drop Content-Length, while an intermediary may do
  7146. // the reverse, so the two disagree on where the body ends and a reused
  7147. // connection is desynchronised (request/response smuggling). Content-Length:
  7148. // 0 is tolerated for compatibility with existing peers.
  7149. return has_header(headers, "Transfer-Encoding") &&
  7150. get_header_value_u64(headers, "Content-Length", 0, 0) > 0;
  7151. }
  7152. template <typename T, typename U>
  7153. bool prepare_content_receiver(T &x, int &status,
  7154. ContentReceiverWithProgress receiver,
  7155. bool decompress, size_t payload_max_length,
  7156. bool &exceed_payload_max_length, U callback) {
  7157. if (decompress) {
  7158. auto encoding = get_combined_header_value(x.headers, "Content-Encoding");
  7159. std::unique_ptr<decompressor> decompressor;
  7160. if (!encoding.empty()) {
  7161. // A coding we know about but were not built with is an error. An
  7162. // unrecognized coding (including "identity") is left alone and the
  7163. // payload is passed through as-is, since some servers misuse the header,
  7164. // e.g. by sending a character set such as "Content-Encoding: UTF-8".
  7165. decompressor = detail::create_decompressor(encoding);
  7166. if (!decompressor && detail::is_known_content_encoding(encoding)) {
  7167. status = StatusCode::UnsupportedMediaType_415;
  7168. return false;
  7169. }
  7170. }
  7171. if (decompressor) {
  7172. if (decompressor->is_valid()) {
  7173. size_t decompressed_size = 0;
  7174. ContentReceiverWithProgress out = [&](const char *buf, size_t n,
  7175. size_t off, size_t len) {
  7176. return decompressor->decompress(
  7177. buf, n, [&](const char *buf2, size_t n2) {
  7178. // Guard against zip-bomb: check
  7179. // decompressed size against limit.
  7180. if (payload_max_length > 0 &&
  7181. (decompressed_size >= payload_max_length ||
  7182. n2 > payload_max_length - decompressed_size)) {
  7183. exceed_payload_max_length = true;
  7184. return false;
  7185. }
  7186. decompressed_size += n2;
  7187. return receiver(buf2, n2, off, len);
  7188. });
  7189. };
  7190. return callback(std::move(out));
  7191. } else {
  7192. status = StatusCode::InternalServerError_500;
  7193. return false;
  7194. }
  7195. }
  7196. }
  7197. ContentReceiverWithProgress out = [&](const char *buf, size_t n, size_t off,
  7198. size_t len) {
  7199. return receiver(buf, n, off, len);
  7200. };
  7201. return callback(std::move(out));
  7202. }
  7203. template <typename T>
  7204. bool read_content(Stream &strm, T &x, size_t payload_max_length, int &status,
  7205. DownloadProgress progress,
  7206. ContentReceiverWithProgress receiver, bool decompress) {
  7207. bool exceed_payload_max_length = false;
  7208. return prepare_content_receiver(
  7209. x, status, std::move(receiver), decompress, payload_max_length,
  7210. exceed_payload_max_length, [&](const ContentReceiverWithProgress &out) {
  7211. auto ret = true;
  7212. // Note: exceed_payload_max_length may also be set by the decompressor
  7213. // wrapper in prepare_content_receiver when the decompressed payload
  7214. // size exceeds the limit.
  7215. if (is_chunked_transfer_encoding(x.headers)) {
  7216. auto result = read_content_chunked(strm, x, payload_max_length, out);
  7217. if (result == ReadContentResult::Success) {
  7218. ret = true;
  7219. } else if (result == ReadContentResult::PayloadTooLarge) {
  7220. exceed_payload_max_length = true;
  7221. ret = false;
  7222. } else {
  7223. ret = false;
  7224. }
  7225. } else if (!has_header(x.headers, "Content-Length")) {
  7226. auto result =
  7227. read_content_without_length(strm, payload_max_length, out);
  7228. if (result == ReadContentResult::Success) {
  7229. ret = true;
  7230. } else if (result == ReadContentResult::PayloadTooLarge) {
  7231. exceed_payload_max_length = true;
  7232. ret = false;
  7233. } else {
  7234. ret = false;
  7235. }
  7236. } else {
  7237. auto is_invalid_value = false;
  7238. auto len = get_header_value_u64(x.headers, "Content-Length",
  7239. (std::numeric_limits<size_t>::max)(),
  7240. 0, is_invalid_value);
  7241. if (is_invalid_value) {
  7242. ret = false;
  7243. } else if (len > 0) {
  7244. auto result = read_content_with_length(
  7245. strm, len, std::move(progress), out, payload_max_length);
  7246. ret = (result == ReadContentResult::Success);
  7247. if (result == ReadContentResult::PayloadTooLarge) {
  7248. exceed_payload_max_length = true;
  7249. }
  7250. }
  7251. }
  7252. if (!ret) {
  7253. status = exceed_payload_max_length ? StatusCode::PayloadTooLarge_413
  7254. : StatusCode::BadRequest_400;
  7255. }
  7256. return ret;
  7257. });
  7258. }
  7259. inline ssize_t write_request_line(Stream &strm, const std::string &method,
  7260. const std::string &path) {
  7261. // Neither the method nor the request target may carry CR/LF, SP or other
  7262. // control octets; otherwise a value smuggled into either splits the request
  7263. // line and injects headers or a whole request.
  7264. if (!fields::is_token(method)) { return -1; }
  7265. if (!fields::is_request_target(path)) { return -1; }
  7266. std::string s = method;
  7267. s += ' ';
  7268. s += path;
  7269. s += " HTTP/1.1\r\n";
  7270. return strm.write(s.data(), s.size());
  7271. }
  7272. inline ssize_t write_response_line(Stream &strm, int status) {
  7273. std::string s = "HTTP/1.1 ";
  7274. s += std::to_string(status);
  7275. s += ' ';
  7276. s += httplib::status_message(status);
  7277. s += "\r\n";
  7278. return strm.write(s.data(), s.size());
  7279. }
  7280. inline ssize_t write_headers(Stream &strm, const Headers &headers) {
  7281. ssize_t write_len = 0;
  7282. for (const auto &x : headers) {
  7283. // Skip fields with invalid names or values to prevent response splitting
  7284. // via CR/LF injection, matching set_header(). The client validates request
  7285. // headers up front in check_and_write_headers, but the server passes
  7286. // res.headers straight to this writer, and res.headers is a public field
  7287. // an application can populate directly with request-derived values.
  7288. if (!fields::is_field_valid(x.first, x.second)) { continue; }
  7289. std::string s;
  7290. s = x.first;
  7291. s += ": ";
  7292. s += x.second;
  7293. s += "\r\n";
  7294. auto len = strm.write(s.data(), s.size());
  7295. if (len < 0) { return len; }
  7296. write_len += len;
  7297. }
  7298. auto len = strm.write("\r\n");
  7299. if (len < 0) { return len; }
  7300. write_len += len;
  7301. return write_len;
  7302. }
  7303. inline bool write_data(Stream &strm, const char *d, size_t l) {
  7304. size_t offset = 0;
  7305. while (offset < l) {
  7306. auto length = strm.write(d + offset, l - offset);
  7307. if (length < 0) { return false; }
  7308. offset += static_cast<size_t>(length);
  7309. }
  7310. return true;
  7311. }
  7312. template <typename T>
  7313. inline bool write_content_with_progress(Stream &strm,
  7314. const ContentProvider &content_provider,
  7315. size_t offset, size_t length,
  7316. T is_shutting_down,
  7317. const UploadProgress &upload_progress,
  7318. Error &error) {
  7319. size_t end_offset = offset + length;
  7320. size_t start_offset = offset;
  7321. auto ok = true;
  7322. auto finished = false;
  7323. DataSink data_sink;
  7324. data_sink.write = [&](const char *d, size_t l) -> bool {
  7325. if (ok) {
  7326. if (write_data(strm, d, l)) {
  7327. offset += l;
  7328. if (upload_progress && length > 0) {
  7329. size_t current_written = offset - start_offset;
  7330. if (!upload_progress(current_written, length)) {
  7331. ok = false;
  7332. return false;
  7333. }
  7334. }
  7335. } else {
  7336. ok = false;
  7337. }
  7338. }
  7339. return ok;
  7340. };
  7341. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7342. // The body is framed by `length`, so a provider that reports itself done
  7343. // early has truncated it. Record that and let the short-body check below
  7344. // fail the write, rather than calling the provider again forever.
  7345. data_sink.done = [&]() { finished = true; };
  7346. while (offset < end_offset && !finished && !is_shutting_down()) {
  7347. auto last_offset = offset;
  7348. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7349. error = Error::Write;
  7350. return false;
  7351. } else if (!content_provider(offset, end_offset - offset, data_sink)) {
  7352. error = Error::Canceled;
  7353. return false;
  7354. } else if (!ok) {
  7355. error = Error::Write;
  7356. return false;
  7357. }
  7358. // A provider that reports success without writing anything and without
  7359. // reporting itself done gets handed the same offset and length again on
  7360. // the next pass, so it would spin here for as long as the peer stays
  7361. // connected. Treat making no progress as a short body, like done() early.
  7362. if (!finished && offset == last_offset) {
  7363. error = Error::Write;
  7364. return false;
  7365. }
  7366. }
  7367. if (offset < end_offset) { // done() called early, or is_shutting_down()
  7368. error = Error::Write;
  7369. return false;
  7370. }
  7371. error = Error::Success;
  7372. return true;
  7373. }
  7374. template <typename T>
  7375. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7376. size_t offset, size_t length, T is_shutting_down,
  7377. Error &error) {
  7378. return write_content_with_progress<T>(strm, content_provider, offset, length,
  7379. is_shutting_down, nullptr, error);
  7380. }
  7381. template <typename T>
  7382. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7383. size_t offset, size_t length,
  7384. const T &is_shutting_down) {
  7385. auto error = Error::Success;
  7386. return write_content(strm, content_provider, offset, length, is_shutting_down,
  7387. error);
  7388. }
  7389. template <typename T>
  7390. inline bool
  7391. write_content_without_length(Stream &strm,
  7392. const ContentProvider &content_provider,
  7393. const T &is_shutting_down) {
  7394. size_t offset = 0;
  7395. auto data_available = true;
  7396. auto ok = true;
  7397. DataSink data_sink;
  7398. data_sink.write = [&](const char *d, size_t l) -> bool {
  7399. if (ok) {
  7400. offset += l;
  7401. if (!write_data(strm, d, l)) { ok = false; }
  7402. }
  7403. return ok;
  7404. };
  7405. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7406. data_sink.done = [&](void) { data_available = false; };
  7407. while (data_available && !is_shutting_down()) {
  7408. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7409. return false;
  7410. } else if (!content_provider(offset, 0, data_sink)) {
  7411. return false;
  7412. } else if (!ok) {
  7413. return false;
  7414. }
  7415. }
  7416. return !data_available; // true only if done() was called, false if shutting
  7417. // down
  7418. }
  7419. // Runs a known-length content provider to completion and compresses what it
  7420. // writes into `out`. Nothing is buffered in identity form: a provider backed
  7421. // by an mmap hands the compressor a pointer straight into the mapping.
  7422. inline bool compress_content_provider(const ContentProvider &content_provider,
  7423. size_t length, compressor &cmp,
  7424. std::string &out) {
  7425. size_t offset = 0;
  7426. auto ok = true;
  7427. auto finished = false;
  7428. DataSink data_sink;
  7429. auto append = [&](const char *data, size_t data_len) {
  7430. out.append(data, data_len);
  7431. return true;
  7432. };
  7433. data_sink.write = [&](const char *d, size_t l) -> bool {
  7434. if (!ok) { return false; }
  7435. offset += l;
  7436. if (l > 0 && !cmp.compress(d, l, false, append)) { ok = false; }
  7437. return ok;
  7438. };
  7439. // The body is framed by `length`, so a provider that reports itself done
  7440. // early has truncated it; the short-body check below turns that into a
  7441. // failure rather than calling the provider again forever.
  7442. data_sink.done = [&]() { finished = true; };
  7443. while (offset < length && !finished) {
  7444. auto prev_offset = offset;
  7445. if (!content_provider(offset, length - offset, data_sink) || !ok) {
  7446. return false;
  7447. }
  7448. // No Stream to block on here, so a provider that keeps returning true
  7449. // without writing would spin. Treat a pass that made no progress as a
  7450. // failure.
  7451. if (offset == prev_offset) { return false; }
  7452. }
  7453. if (offset != length) { return false; }
  7454. return cmp.compress(nullptr, 0, true, append);
  7455. }
  7456. // Serves `m` as the response body. `set_content_provider()` clears the coding
  7457. // and the file flag, so recording them has to come after; keeping all of it
  7458. // here means a third file-serving path cannot get that order wrong.
  7459. inline void set_file_content_provider(Response &res,
  7460. const std::shared_ptr<mmap> &m,
  7461. const std::string &content_type,
  7462. EncodingType encoding) {
  7463. res.set_content_provider(
  7464. m->size(), content_type,
  7465. [m](size_t offset, size_t length, DataSink &sink) -> bool {
  7466. // Never read past the mapping.
  7467. if (offset >= m->size()) { return false; }
  7468. sink.write(m->data() + offset, (std::min)(length, m->size() - offset));
  7469. return true;
  7470. });
  7471. res.is_file_content_provider_ = true;
  7472. res.content_coding_ = encoding;
  7473. }
  7474. template <typename T, typename U>
  7475. inline bool
  7476. write_content_chunked(Stream &strm, const ContentProvider &content_provider,
  7477. const T &is_shutting_down, U &compressor, Error &error) {
  7478. size_t offset = 0;
  7479. auto data_available = true;
  7480. auto ok = true;
  7481. DataSink data_sink;
  7482. data_sink.write = [&](const char *d, size_t l) -> bool {
  7483. // Only done()/done_with_trailer() end a chunked body. A pass with nothing
  7484. // to hand over is ordinary (an empty buffer popped off a queue), and a
  7485. // zero-length chunk is the terminator, so it must not be emitted here.
  7486. if (ok && l > 0) {
  7487. offset += l;
  7488. std::string payload;
  7489. if (compressor.compress(d, l, false,
  7490. [&](const char *data, size_t data_len) {
  7491. payload.append(data, data_len);
  7492. return true;
  7493. })) {
  7494. if (!payload.empty()) {
  7495. // Emit chunked response header and footer for each chunk
  7496. auto chunk =
  7497. from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7498. if (!write_data(strm, chunk.data(), chunk.size())) { ok = false; }
  7499. }
  7500. } else {
  7501. ok = false;
  7502. }
  7503. }
  7504. return ok;
  7505. };
  7506. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7507. auto done_with_trailer = [&](const Headers *trailer) {
  7508. if (!ok) { return; }
  7509. data_available = false;
  7510. std::string payload;
  7511. if (!compressor.compress(nullptr, 0, true,
  7512. [&](const char *data, size_t data_len) {
  7513. payload.append(data, data_len);
  7514. return true;
  7515. })) {
  7516. ok = false;
  7517. return;
  7518. }
  7519. if (!payload.empty()) {
  7520. // Emit chunked response header and footer for each chunk
  7521. auto chunk = from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7522. if (!write_data(strm, chunk.data(), chunk.size())) {
  7523. ok = false;
  7524. return;
  7525. }
  7526. }
  7527. constexpr const char done_marker[] = "0\r\n";
  7528. if (!write_data(strm, done_marker, str_len(done_marker))) { ok = false; }
  7529. // Trailer
  7530. if (trailer) {
  7531. for (const auto &kv : *trailer) {
  7532. // Skip fields with invalid names or values to prevent response
  7533. // splitting via CR/LF injection, matching set_header().
  7534. if (!fields::is_field_valid(kv.first, kv.second)) { continue; }
  7535. std::string field_line = kv.first + ": " + kv.second + "\r\n";
  7536. if (!write_data(strm, field_line.data(), field_line.size())) {
  7537. ok = false;
  7538. }
  7539. }
  7540. }
  7541. constexpr const char crlf[] = "\r\n";
  7542. if (!write_data(strm, crlf, str_len(crlf))) { ok = false; }
  7543. };
  7544. data_sink.done = [&](void) { done_with_trailer(nullptr); };
  7545. data_sink.done_with_trailer = [&](const Headers &trailer) {
  7546. done_with_trailer(&trailer);
  7547. };
  7548. while (data_available && !is_shutting_down()) {
  7549. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7550. error = Error::Write;
  7551. return false;
  7552. } else if (!content_provider(offset, 0, data_sink)) {
  7553. error = Error::Canceled;
  7554. return false;
  7555. } else if (!ok) {
  7556. error = Error::Write;
  7557. return false;
  7558. }
  7559. }
  7560. if (data_available) { // exited due to is_shutting_down(), not done()
  7561. error = Error::Write;
  7562. return false;
  7563. }
  7564. error = Error::Success;
  7565. return true;
  7566. }
  7567. template <typename T, typename U>
  7568. inline bool write_content_chunked(Stream &strm,
  7569. const ContentProvider &content_provider,
  7570. const T &is_shutting_down, U &compressor) {
  7571. auto error = Error::Success;
  7572. return write_content_chunked(strm, content_provider, is_shutting_down,
  7573. compressor, error);
  7574. }
  7575. template <typename T>
  7576. inline bool redirect(T &cli, Request &req, Response &res,
  7577. const std::string &path, const std::string &location,
  7578. Error &error) {
  7579. Request new_req = req;
  7580. new_req.path = path;
  7581. new_req.redirect_count_ -= 1;
  7582. if (res.status == StatusCode::SeeOther_303 &&
  7583. (req.method != "GET" && req.method != "HEAD")) {
  7584. new_req.method = "GET";
  7585. new_req.body.clear();
  7586. new_req.headers.clear();
  7587. new_req.content_length_ = 0;
  7588. new_req.content_provider_ = nullptr;
  7589. new_req.is_chunked_content_provider_ = false;
  7590. }
  7591. Response new_res;
  7592. auto ret = cli.send(new_req, new_res, error);
  7593. if (ret) {
  7594. req = std::move(new_req);
  7595. res = std::move(new_res);
  7596. if (res.location.empty()) { res.location = location; }
  7597. }
  7598. return ret;
  7599. }
  7600. inline std::string params_to_query_str(const Params &params) {
  7601. std::string query;
  7602. for (auto it = params.begin(); it != params.end(); ++it) {
  7603. if (it != params.begin()) { query += '&'; }
  7604. query += encode_query_component(it->first);
  7605. query += '=';
  7606. query += encode_query_component(it->second);
  7607. }
  7608. return query;
  7609. }
  7610. // Splits one "key=value" span of a query string at its first '='. A span with
  7611. // no '=' at all lands entirely in key, leaving val empty, which is how a bare
  7612. // "?flag" keeps its name.
  7613. inline void divide_query_pair(const char *b, const char *e, std::string &key,
  7614. std::string &val) {
  7615. divide(b, static_cast<std::size_t>(e - b), '=',
  7616. [&](const char *lhs_data, std::size_t lhs_size, const char *rhs_data,
  7617. std::size_t rhs_size) {
  7618. key.assign(lhs_data, lhs_size);
  7619. val.assign(rhs_data, rhs_size);
  7620. });
  7621. }
  7622. inline void parse_query_text(const char *data, std::size_t size,
  7623. Params &params) {
  7624. std::set<std::string> cache;
  7625. split(data, data + size, '&', [&](const char *b, const char *e) {
  7626. std::string kv(b, e);
  7627. if (cache.find(kv) != cache.end()) { return; }
  7628. cache.insert(std::move(kv));
  7629. std::string key;
  7630. std::string val;
  7631. divide_query_pair(b, e, key, val);
  7632. if (!key.empty()) {
  7633. params.emplace(decode_query_component(key), decode_query_component(val));
  7634. }
  7635. });
  7636. }
  7637. inline void parse_query_text(const std::string &s, Params &params) {
  7638. parse_query_text(s.data(), s.size(), params);
  7639. }
  7640. // Normalize a query string by decoding and re-encoding each key/value pair
  7641. // while preserving the original parameter order. This avoids double-encoding
  7642. // and ensures consistent encoding. It works on the raw string rather than
  7643. // parsing into Params and re-serializing, because that round trip cannot
  7644. // reproduce the input: params_to_query_str() always emits '=', so a bare
  7645. // "flag" would come back as "flag=", and parse_query_text() drops exactly
  7646. // duplicated pairs.
  7647. inline std::string normalize_query_string(const std::string &query) {
  7648. std::string result;
  7649. split(query.data(), query.data() + query.size(), '&',
  7650. [&](const char *b, const char *e) {
  7651. std::string key;
  7652. std::string val;
  7653. divide_query_pair(b, e, key, val);
  7654. if (!key.empty()) {
  7655. auto dec_key = decode_query_component(key);
  7656. auto dec_val = decode_query_component(val);
  7657. if (!result.empty()) { result += '&'; }
  7658. result += encode_query_component(dec_key);
  7659. if (!val.empty() || std::find(b, e, '=') != e) {
  7660. result += '=';
  7661. result += encode_query_component(dec_val);
  7662. }
  7663. }
  7664. });
  7665. return result;
  7666. }
  7667. // Build the request target that goes on the wire from a caller-supplied path.
  7668. // Shared by the buffered send path and the streaming API so that both put the
  7669. // same bytes in the request line for the same input.
  7670. inline std::string encode_request_target(const std::string &target,
  7671. bool path_encode) {
  7672. // `substr(0, npos)` yields the whole string, which is what the no-query
  7673. // case needs.
  7674. auto query_pos = target.find('?');
  7675. auto path_part = target.substr(0, query_pos);
  7676. std::string query_part;
  7677. if (query_pos != std::string::npos) {
  7678. query_part = target.substr(query_pos + 1);
  7679. }
  7680. auto result = path_encode ? encode_path(path_part) : std::move(path_part);
  7681. if (!query_part.empty()) {
  7682. // When path encoding is disabled the caller has supplied an already-encoded
  7683. // target and expects the exact bytes to be sent on the wire, so skip
  7684. // normalization for the query too. Normalizing would decode-then-re-encode
  7685. // it and corrupt pre-encoded binary payloads (e.g. turning `%20` into `+`,
  7686. // which a strict RFC 3986 server decodes back as `+`, not a space).
  7687. if (path_encode) {
  7688. auto normalized = normalize_query_string(query_part);
  7689. if (!normalized.empty()) {
  7690. result += '?';
  7691. result += normalized;
  7692. }
  7693. } else {
  7694. result += '?';
  7695. result += query_part;
  7696. }
  7697. }
  7698. return result;
  7699. }
  7700. inline bool parse_multipart_boundary(const std::string &content_type,
  7701. std::string &boundary) {
  7702. std::map<std::string, std::string> params;
  7703. extract_media_type(content_type, &params);
  7704. auto it = params.find("boundary");
  7705. if (it == params.end()) { return false; }
  7706. boundary = it->second;
  7707. // RFC 2046 5.1.1 caps a boundary at 70 characters. The parser scans the body
  7708. // for "--" + boundary, so a body crafted to repeat that delimiter's leading
  7709. // bytes costs a nearly full comparison at nearly every position: the
  7710. // boundary's length multiplies the worst-case cost of scanning a body.
  7711. return !boundary.empty() && boundary.size() <= 70;
  7712. }
  7713. inline void parse_disposition_params(const std::string &s, Params &params) {
  7714. std::set<std::string> cache;
  7715. split_unquoted(s.data(), s.data() + s.size(), ';',
  7716. [&](const char *b, const char *e) {
  7717. std::string kv(b, e);
  7718. if (cache.find(kv) != cache.end()) { return; }
  7719. cache.insert(kv);
  7720. std::string key;
  7721. std::string val;
  7722. divide_param_pair(b, e, key, val);
  7723. if (!key.empty()) {
  7724. params.emplace(trim_double_quotes_copy(key),
  7725. trim_double_quotes_copy(val));
  7726. }
  7727. });
  7728. }
  7729. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7730. inline bool parse_range_header(const std::string &s, Ranges &ranges) {
  7731. #else
  7732. inline bool parse_range_header(const std::string &s, Ranges &ranges) try {
  7733. #endif
  7734. auto is_valid = [](const std::string &str) {
  7735. return std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  7736. };
  7737. if (s.size() > 7 && case_ignore::equal(s.substr(0, 6), "bytes=")) {
  7738. const auto pos = static_cast<size_t>(6);
  7739. const auto len = static_cast<size_t>(s.size() - 6);
  7740. auto all_valid_ranges = true;
  7741. split(&s[pos], &s[pos + len], ',', [&](const char *b, const char *e) {
  7742. if (!all_valid_ranges) { return; }
  7743. const auto it = std::find(b, e, '-');
  7744. if (it == e) {
  7745. all_valid_ranges = false;
  7746. return;
  7747. }
  7748. const auto lhs = std::string(b, it);
  7749. const auto rhs = std::string(it + 1, e);
  7750. if (!is_valid(lhs) || !is_valid(rhs)) {
  7751. all_valid_ranges = false;
  7752. return;
  7753. }
  7754. ssize_t first = -1;
  7755. if (!lhs.empty()) {
  7756. // Reject an overflowing first-byte-pos; treating it as absent (-1)
  7757. // would turn the range into a suffix range.
  7758. auto res =
  7759. detail::from_chars(lhs.data(), lhs.data() + lhs.size(), first);
  7760. if (res.ec != std::errc{}) {
  7761. all_valid_ranges = false;
  7762. return;
  7763. }
  7764. }
  7765. ssize_t last = -1;
  7766. if (!rhs.empty()) {
  7767. // An overflowing last-byte-pos is past any content length, so keeping
  7768. // -1 ("remainder", RFC 9110 14.1.2) is correct here.
  7769. ssize_t v;
  7770. auto res = detail::from_chars(rhs.data(), rhs.data() + rhs.size(), v);
  7771. if (res.ec == std::errc{}) { last = v; }
  7772. }
  7773. if ((first == -1 && last == -1) ||
  7774. (first != -1 && last != -1 && first > last)) {
  7775. all_valid_ranges = false;
  7776. return;
  7777. }
  7778. ranges.emplace_back(first, last);
  7779. });
  7780. return all_valid_ranges && !ranges.empty();
  7781. }
  7782. return false;
  7783. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7784. }
  7785. #else
  7786. } catch (...) { return false; }
  7787. #endif
  7788. // Removes each quoted-string, honoring a quoted-pair (RFC 9110 Section 5.6.4)
  7789. inline std::string remove_quoted_strings(const std::string &s) {
  7790. std::string out;
  7791. auto in_quotes = false;
  7792. for (size_t i = 0; i < s.size(); i++) {
  7793. if (s[i] == '"') {
  7794. in_quotes = !in_quotes;
  7795. } else if (!in_quotes) {
  7796. out += s[i];
  7797. } else if (s[i] == '\\') {
  7798. i++;
  7799. }
  7800. }
  7801. return out;
  7802. }
  7803. inline bool parse_accept_header(const std::string &s,
  7804. std::vector<std::string> &content_types) {
  7805. // Parameter values are not used here, so a quoted-string is dropped rather
  7806. // than parsed: a ',' or ';' inside one must not be read as a delimiter.
  7807. if (s.find('"') != std::string::npos) {
  7808. return parse_accept_header(remove_quoted_strings(s), content_types);
  7809. }
  7810. content_types.clear();
  7811. // Empty string is considered valid (no preference)
  7812. if (s.empty()) { return true; }
  7813. struct AcceptEntry {
  7814. std::string media_type;
  7815. double quality;
  7816. int order;
  7817. };
  7818. std::vector<AcceptEntry> entries;
  7819. int order = 0;
  7820. bool has_invalid_entry = false;
  7821. // Split by comma and parse each entry. RFC 9110 Section 5.6.1.2: a recipient
  7822. // has to parse and ignore empty list elements, so a leading, trailing or
  7823. // doubled comma must not turn a legal Accept value into 400 Bad Request.
  7824. // split() skips them, and the header length limit bounds how many a sender
  7825. // can send, so ignoring all of them cannot be used as a denial-of-service
  7826. // vector.
  7827. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  7828. std::string entry(b, e);
  7829. entry = trim_copy(entry);
  7830. AcceptEntry accept_entry;
  7831. accept_entry.order = order++;
  7832. if (!parse_quality(entry.data(), entry.data() + entry.size(),
  7833. accept_entry.media_type, accept_entry.quality)) {
  7834. has_invalid_entry = true;
  7835. return;
  7836. }
  7837. // Remove additional parameters from media type
  7838. accept_entry.media_type = extract_media_type(accept_entry.media_type);
  7839. // Basic validation of media type format
  7840. if (accept_entry.media_type.empty()) {
  7841. has_invalid_entry = true;
  7842. return;
  7843. }
  7844. // Check for basic media type format (should contain '/' or be '*')
  7845. if (accept_entry.media_type != "*" &&
  7846. accept_entry.media_type.find('/') == std::string::npos) {
  7847. has_invalid_entry = true;
  7848. return;
  7849. }
  7850. entries.push_back(std::move(accept_entry));
  7851. });
  7852. // Return false if any invalid entry was found
  7853. if (has_invalid_entry) { return false; }
  7854. // Sort by quality (descending), then by original order (ascending)
  7855. std::sort(entries.begin(), entries.end(),
  7856. [](const AcceptEntry &a, const AcceptEntry &b) {
  7857. if (a.quality != b.quality) {
  7858. return a.quality > b.quality; // Higher quality first
  7859. }
  7860. return a.order < b.order; // Earlier order first for same quality
  7861. });
  7862. // Extract sorted media types
  7863. content_types.reserve(entries.size());
  7864. for (auto &entry : entries) {
  7865. content_types.push_back(std::move(entry.media_type));
  7866. }
  7867. return true;
  7868. }
  7869. class FormDataParser {
  7870. public:
  7871. FormDataParser() = default;
  7872. void set_boundary(std::string &&boundary) {
  7873. boundary_ = std::move(boundary);
  7874. dash_boundary_crlf_ = dash_ + boundary_ + crlf_;
  7875. crlf_dash_boundary_ = crlf_ + dash_ + boundary_;
  7876. }
  7877. bool is_valid() const { return is_valid_; }
  7878. bool parse(const char *buf, size_t n, const FormDataHeader &header_callback,
  7879. const ContentReceiver &content_callback) {
  7880. // Once the close delimiter has been seen the rest of the body is epilogue
  7881. // to be discarded (RFC 2046). Drop it without buffering so a large epilogue
  7882. // spread across reads is not copied in only to be erased right away.
  7883. if (state_ == 5) { return true; }
  7884. buf_append(buf, n);
  7885. while (buf_size() > 0) {
  7886. switch (state_) {
  7887. case 0: { // Initial boundary
  7888. auto pos = buf_find(dash_boundary_crlf_);
  7889. if (pos == buf_size()) {
  7890. // Not found yet: keep only a possible partial boundary at the tail so
  7891. // that a body which never contains the boundary cannot grow the
  7892. // buffer (and get rescanned from the start) without bound.
  7893. auto keep = dash_boundary_crlf_.size() - 1;
  7894. if (buf_size() > keep) { buf_erase(buf_size() - keep); }
  7895. return true;
  7896. }
  7897. buf_erase(pos + dash_boundary_crlf_.size());
  7898. state_ = 1;
  7899. break;
  7900. }
  7901. case 1: { // New entry
  7902. clear_file_info();
  7903. state_ = 2;
  7904. break;
  7905. }
  7906. case 2: { // Headers
  7907. auto pos = buf_find(crlf_);
  7908. if (pos > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  7909. while (pos < buf_size()) {
  7910. // Empty line
  7911. if (pos == 0) {
  7912. if (!header_callback(file_)) {
  7913. is_valid_ = false;
  7914. return false;
  7915. }
  7916. buf_erase(crlf_.size());
  7917. state_ = 3;
  7918. break;
  7919. }
  7920. // Check header count limit
  7921. if (header_count_ >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  7922. is_valid_ = false;
  7923. return false;
  7924. }
  7925. header_count_++;
  7926. const auto header = buf_head(pos);
  7927. if (!parse_header(header.data(), header.data() + header.size(),
  7928. [&](const std::string &, const std::string &) {})) {
  7929. is_valid_ = false;
  7930. return false;
  7931. }
  7932. // Parse and emplace space trimmed headers into a map
  7933. if (!parse_header(
  7934. header.data(), header.data() + header.size(),
  7935. [&](const std::string &key, const std::string &val) {
  7936. file_.headers.emplace(key, val);
  7937. })) {
  7938. is_valid_ = false;
  7939. return false;
  7940. }
  7941. constexpr const char header_content_type[] = "Content-Type:";
  7942. if (start_with_case_ignore(header, header_content_type)) {
  7943. file_.content_type =
  7944. trim_copy(header.substr(str_len(header_content_type)));
  7945. } else {
  7946. std::string disposition_params;
  7947. if (parse_content_disposition(header, disposition_params)) {
  7948. Params params;
  7949. parse_disposition_params(disposition_params, params);
  7950. auto it = params.find("name");
  7951. if (it != params.end()) {
  7952. file_.name = it->second;
  7953. } else {
  7954. is_valid_ = false;
  7955. return false;
  7956. }
  7957. it = params.find("filename");
  7958. if (it != params.end()) { file_.filename = it->second; }
  7959. it = params.find("filename*");
  7960. if (it != params.end()) {
  7961. // RFC 5987: only UTF-8 encoding is allowed
  7962. const auto &val = it->second;
  7963. constexpr const char utf8_prefix[] = "UTF-8''";
  7964. constexpr size_t prefix_len = str_len(utf8_prefix);
  7965. if (val.size() > prefix_len &&
  7966. start_with_case_ignore(val, utf8_prefix)) {
  7967. file_.filename = decode_path_component(
  7968. val.substr(prefix_len)); // override...
  7969. } else {
  7970. is_valid_ = false;
  7971. return false;
  7972. }
  7973. }
  7974. }
  7975. }
  7976. buf_erase(pos + crlf_.size());
  7977. pos = buf_find(crlf_);
  7978. }
  7979. if (state_ != 3) { return true; }
  7980. break;
  7981. }
  7982. case 3: { // Body
  7983. if (crlf_dash_boundary_.size() > buf_size()) { return true; }
  7984. auto pos = buf_find(crlf_dash_boundary_);
  7985. if (pos < buf_size()) {
  7986. if (!content_callback(buf_data(), pos)) {
  7987. is_valid_ = false;
  7988. return false;
  7989. }
  7990. buf_erase(pos + crlf_dash_boundary_.size());
  7991. state_ = 4;
  7992. } else {
  7993. auto len = buf_size() - crlf_dash_boundary_.size();
  7994. if (len > 0) {
  7995. if (!content_callback(buf_data(), len)) {
  7996. is_valid_ = false;
  7997. return false;
  7998. }
  7999. buf_erase(len);
  8000. }
  8001. return true;
  8002. }
  8003. break;
  8004. }
  8005. case 4: { // Boundary
  8006. if (crlf_.size() > buf_size()) { return true; }
  8007. if (buf_start_with(crlf_)) {
  8008. buf_erase(crlf_.size());
  8009. state_ = 1;
  8010. } else if (buf_start_with(dash_)) {
  8011. buf_erase(dash_.size());
  8012. is_valid_ = true;
  8013. state_ = 5;
  8014. } else {
  8015. // Only CRLF (another part follows) and "--" (close-delimiter) are
  8016. // accepted after a boundary; RFC 2046 allows transport-padding in
  8017. // between, but this parser has never supported it. Either way the
  8018. // body is already destined to be rejected, so fail now instead of
  8019. // buffering the rest of it. Both are two bytes, so the check above
  8020. // already guarantees enough buffered data to decide.
  8021. is_valid_ = false;
  8022. return false;
  8023. }
  8024. break;
  8025. }
  8026. case 5: { // Epilogue
  8027. buf_erase(buf_size());
  8028. break;
  8029. }
  8030. }
  8031. }
  8032. return true;
  8033. }
  8034. private:
  8035. void clear_file_info() {
  8036. file_.name.clear();
  8037. file_.filename.clear();
  8038. file_.content_type.clear();
  8039. file_.headers.clear();
  8040. header_count_ = 0;
  8041. }
  8042. bool start_with_case_ignore(const std::string &a, const char *b,
  8043. size_t offset = 0) const {
  8044. const auto b_len = strlen(b);
  8045. if (a.size() < offset + b_len) { return false; }
  8046. for (size_t i = 0; i < b_len; i++) {
  8047. if (case_ignore::to_lower(a[offset + i]) != case_ignore::to_lower(b[i])) {
  8048. return false;
  8049. }
  8050. }
  8051. return true;
  8052. }
  8053. // Parses "Content-Disposition: form-data; <params>" without std::regex.
  8054. // Returns true if header matches, with the params portion in `params_out`.
  8055. bool parse_content_disposition(const std::string &header,
  8056. std::string &params_out) const {
  8057. constexpr const char prefix[] = "Content-Disposition:";
  8058. constexpr size_t prefix_len = str_len(prefix);
  8059. if (!start_with_case_ignore(header, prefix)) { return false; }
  8060. // Skip whitespace after "Content-Disposition:"
  8061. auto pos = prefix_len;
  8062. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8063. pos++;
  8064. }
  8065. // Match "form-data;" (case-insensitive)
  8066. constexpr const char form_data[] = "form-data;";
  8067. constexpr size_t form_data_len = str_len(form_data);
  8068. if (!start_with_case_ignore(header, form_data, pos)) { return false; }
  8069. pos += form_data_len;
  8070. // Skip whitespace after "form-data;"
  8071. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8072. pos++;
  8073. }
  8074. params_out = header.substr(pos);
  8075. return true;
  8076. }
  8077. const std::string dash_ = "--";
  8078. const std::string crlf_ = "\r\n";
  8079. std::string boundary_;
  8080. std::string dash_boundary_crlf_;
  8081. std::string crlf_dash_boundary_;
  8082. size_t state_ = 0;
  8083. bool is_valid_ = false;
  8084. FormData file_;
  8085. size_t header_count_ = 0;
  8086. // Buffer
  8087. bool start_with(const std::string &a, size_t spos, size_t epos,
  8088. const std::string &b) const {
  8089. if (epos - spos < b.size()) { return false; }
  8090. for (size_t i = 0; i < b.size(); i++) {
  8091. if (a[i + spos] != b[i]) { return false; }
  8092. }
  8093. return true;
  8094. }
  8095. size_t buf_size() const { return buf_epos_ - buf_spos_; }
  8096. const char *buf_data() const { return &buf_[buf_spos_]; }
  8097. std::string buf_head(size_t l) const { return buf_.substr(buf_spos_, l); }
  8098. bool buf_start_with(const std::string &s) const {
  8099. return start_with(buf_, buf_spos_, buf_epos_, s);
  8100. }
  8101. size_t buf_find(const std::string &s) const {
  8102. auto c = s.front();
  8103. size_t off = buf_spos_;
  8104. while (off < buf_epos_) {
  8105. auto pos = off;
  8106. while (true) {
  8107. if (pos == buf_epos_) { return buf_size(); }
  8108. if (buf_[pos] == c) { break; }
  8109. pos++;
  8110. }
  8111. auto remaining_size = buf_epos_ - pos;
  8112. if (s.size() > remaining_size) { return buf_size(); }
  8113. if (start_with(buf_, pos, buf_epos_, s)) { return pos - buf_spos_; }
  8114. off = pos + 1;
  8115. }
  8116. return buf_size();
  8117. }
  8118. void buf_append(const char *data, size_t n) {
  8119. auto remaining_size = buf_size();
  8120. if (remaining_size > 0 && buf_spos_ > 0) {
  8121. for (size_t i = 0; i < remaining_size; i++) {
  8122. buf_[i] = buf_[buf_spos_ + i];
  8123. }
  8124. }
  8125. buf_spos_ = 0;
  8126. buf_epos_ = remaining_size;
  8127. if (remaining_size + n > buf_.size()) { buf_.resize(remaining_size + n); }
  8128. for (size_t i = 0; i < n; i++) {
  8129. buf_[buf_epos_ + i] = data[i];
  8130. }
  8131. buf_epos_ += n;
  8132. }
  8133. void buf_erase(size_t size) { buf_spos_ += size; }
  8134. std::string buf_;
  8135. size_t buf_spos_ = 0;
  8136. size_t buf_epos_ = 0;
  8137. };
  8138. inline std::string random_string(size_t length) {
  8139. constexpr const char data[] =
  8140. "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
  8141. std::string result(length, '\0');
  8142. fill_random_bytes(reinterpret_cast<unsigned char *>(&result[0]), length);
  8143. for (auto &c : result) {
  8144. c = data[static_cast<unsigned char>(c) % (sizeof(data) - 1)];
  8145. }
  8146. return result;
  8147. }
  8148. inline std::string make_multipart_data_boundary() {
  8149. return "--cpp-httplib-multipart-data-" + detail::random_string(16);
  8150. }
  8151. inline bool is_multipart_boundary_chars_valid(const std::string &boundary) {
  8152. auto valid = true;
  8153. for (size_t i = 0; i < boundary.size(); i++) {
  8154. auto c = boundary[i];
  8155. if (!is_ascii_alnum(c) && c != '-' && c != '_') {
  8156. valid = false;
  8157. break;
  8158. }
  8159. }
  8160. return valid;
  8161. }
  8162. // Escape a multipart field name/filename following the WHATWG HTML standard
  8163. // ("escape a multipart form-data name"), which is what browsers send:
  8164. // '"' -> %22, CR -> %0D, LF -> %0A
  8165. // With escape_quote = false, only CR and LF are escaped; this is for header
  8166. // values outside a quoted-string (e.g. Content-Type), where '"' is legal.
  8167. inline std::string escape_multipart_field(const std::string &s,
  8168. bool escape_quote = true) {
  8169. std::string result;
  8170. result.reserve(s.size());
  8171. for (auto c : s) {
  8172. switch (c) {
  8173. case '"':
  8174. if (escape_quote) {
  8175. result += "%22";
  8176. } else {
  8177. result += c;
  8178. }
  8179. break;
  8180. case '\r': result += "%0D"; break;
  8181. case '\n': result += "%0A"; break;
  8182. default: result += c; break;
  8183. }
  8184. }
  8185. return result;
  8186. }
  8187. template <typename T>
  8188. inline std::string
  8189. serialize_multipart_formdata_item_begin(const T &item,
  8190. const std::string &boundary) {
  8191. std::string body = "--" + boundary + "\r\n";
  8192. body += "Content-Disposition: form-data; name=\"" +
  8193. escape_multipart_field(item.name) + "\"";
  8194. if (!item.filename.empty()) {
  8195. body += "; filename=\"" + escape_multipart_field(item.filename) + "\"";
  8196. }
  8197. body += "\r\n";
  8198. if (!item.content_type.empty()) {
  8199. body +=
  8200. "Content-Type: " + escape_multipart_field(item.content_type, false) +
  8201. "\r\n";
  8202. }
  8203. body += "\r\n";
  8204. return body;
  8205. }
  8206. inline std::string serialize_multipart_formdata_item_end() { return "\r\n"; }
  8207. inline std::string
  8208. serialize_multipart_formdata_finish(const std::string &boundary) {
  8209. return "--" + boundary + "--\r\n";
  8210. }
  8211. inline std::string
  8212. serialize_multipart_formdata_get_content_type(const std::string &boundary) {
  8213. return "multipart/form-data; boundary=" + boundary;
  8214. }
  8215. inline std::string
  8216. serialize_multipart_formdata(const UploadFormDataItems &items,
  8217. const std::string &boundary, bool finish = true) {
  8218. std::string body;
  8219. for (const auto &item : items) {
  8220. body += serialize_multipart_formdata_item_begin(item, boundary);
  8221. body += item.content + serialize_multipart_formdata_item_end();
  8222. }
  8223. if (finish) { body += serialize_multipart_formdata_finish(boundary); }
  8224. return body;
  8225. }
  8226. inline size_t get_multipart_content_length(const UploadFormDataItems &items,
  8227. const std::string &boundary) {
  8228. size_t total = 0;
  8229. for (const auto &item : items) {
  8230. total += serialize_multipart_formdata_item_begin(item, boundary).size();
  8231. total += item.content.size();
  8232. total += serialize_multipart_formdata_item_end().size();
  8233. }
  8234. total += serialize_multipart_formdata_finish(boundary).size();
  8235. return total;
  8236. }
  8237. struct MultipartSegment {
  8238. const char *data;
  8239. size_t size;
  8240. };
  8241. // NOTE: items must outlive the returned ContentProvider
  8242. // (safe for synchronous use inside Post/Put/Patch)
  8243. inline ContentProvider
  8244. make_multipart_content_provider(const UploadFormDataItems &items,
  8245. const std::string &boundary) {
  8246. // Own the per-item header strings and the finish string
  8247. std::vector<std::string> owned;
  8248. owned.reserve(items.size() + 1);
  8249. for (const auto &item : items)
  8250. owned.push_back(serialize_multipart_formdata_item_begin(item, boundary));
  8251. owned.push_back(serialize_multipart_formdata_finish(boundary));
  8252. // Flat segment list: [header, content, "\r\n"] * N + [finish]
  8253. std::vector<MultipartSegment> segs;
  8254. segs.reserve(items.size() * 3 + 1);
  8255. static const char crlf[] = "\r\n";
  8256. for (size_t i = 0; i < items.size(); i++) {
  8257. segs.push_back({owned[i].data(), owned[i].size()});
  8258. segs.push_back({items[i].content.data(), items[i].content.size()});
  8259. segs.push_back({crlf, 2});
  8260. }
  8261. segs.push_back({owned.back().data(), owned.back().size()});
  8262. struct MultipartState {
  8263. std::vector<std::string> owned;
  8264. std::vector<MultipartSegment> segs;
  8265. std::vector<char> buf = std::vector<char>(CPPHTTPLIB_SEND_BUFSIZ);
  8266. };
  8267. auto state = std::make_shared<MultipartState>();
  8268. state->owned = std::move(owned);
  8269. // `segs` holds raw pointers into owned strings; std::string move preserves
  8270. // the data pointer, so these pointers remain valid after the move above.
  8271. state->segs = std::move(segs);
  8272. return [state](size_t offset, size_t length, DataSink &sink) -> bool {
  8273. // Buffer multiple small segments into fewer, larger writes to avoid
  8274. // excessive TCP packets when there are many form data items (#2410)
  8275. auto &buf = state->buf;
  8276. auto buf_size = buf.size();
  8277. size_t buf_len = 0;
  8278. size_t remaining = length;
  8279. // Find the first segment containing 'offset'
  8280. size_t pos = 0;
  8281. size_t seg_idx = 0;
  8282. for (; seg_idx < state->segs.size(); seg_idx++) {
  8283. const auto &seg = state->segs[seg_idx];
  8284. if (seg.size > 0 && offset - pos < seg.size) { break; }
  8285. pos += seg.size;
  8286. }
  8287. size_t seg_offset = (seg_idx < state->segs.size()) ? offset - pos : 0;
  8288. for (; seg_idx < state->segs.size() && remaining > 0; seg_idx++) {
  8289. const auto &seg = state->segs[seg_idx];
  8290. size_t available = seg.size - seg_offset;
  8291. size_t to_copy = (std::min)(available, remaining);
  8292. const char *src = seg.data + seg_offset;
  8293. seg_offset = 0; // only the first segment has a non-zero offset
  8294. while (to_copy > 0) {
  8295. size_t space = buf_size - buf_len;
  8296. size_t chunk = (std::min)(to_copy, space);
  8297. std::memcpy(buf.data() + buf_len, src, chunk);
  8298. buf_len += chunk;
  8299. src += chunk;
  8300. to_copy -= chunk;
  8301. remaining -= chunk;
  8302. if (buf_len == buf_size) {
  8303. if (!sink.write(buf.data(), buf_len)) { return false; }
  8304. buf_len = 0;
  8305. }
  8306. }
  8307. }
  8308. if (buf_len > 0) { return sink.write(buf.data(), buf_len); }
  8309. return true;
  8310. };
  8311. }
  8312. inline void coalesce_ranges(Ranges &ranges, size_t content_length) {
  8313. if (ranges.size() <= 1) return;
  8314. // Sort ranges by start position
  8315. std::sort(ranges.begin(), ranges.end(),
  8316. [](const Range &a, const Range &b) { return a.first < b.first; });
  8317. Ranges coalesced;
  8318. coalesced.reserve(ranges.size());
  8319. for (auto &r : ranges) {
  8320. auto first_pos = r.first;
  8321. auto last_pos = r.second;
  8322. // Handle special cases like in range_error
  8323. if (first_pos == -1 && last_pos == -1) {
  8324. first_pos = 0;
  8325. last_pos = static_cast<ssize_t>(content_length);
  8326. }
  8327. if (first_pos == -1) {
  8328. first_pos = static_cast<ssize_t>(content_length) - last_pos;
  8329. last_pos = static_cast<ssize_t>(content_length) - 1;
  8330. }
  8331. if (last_pos == -1 || last_pos >= static_cast<ssize_t>(content_length)) {
  8332. last_pos = static_cast<ssize_t>(content_length) - 1;
  8333. }
  8334. // Skip invalid ranges
  8335. if (!(0 <= first_pos && first_pos <= last_pos &&
  8336. last_pos < static_cast<ssize_t>(content_length))) {
  8337. continue;
  8338. }
  8339. // Coalesce with previous range if overlapping or adjacent (but not
  8340. // identical)
  8341. if (!coalesced.empty()) {
  8342. auto &prev = coalesced.back();
  8343. // Check if current range overlaps or is adjacent to previous range
  8344. // but don't coalesce identical ranges (allow duplicates)
  8345. if (first_pos <= prev.second + 1 &&
  8346. !(first_pos == prev.first && last_pos == prev.second)) {
  8347. // Extend the previous range
  8348. prev.second = (std::max)(prev.second, last_pos);
  8349. continue;
  8350. }
  8351. }
  8352. // Add new range
  8353. coalesced.emplace_back(first_pos, last_pos);
  8354. }
  8355. ranges = std::move(coalesced);
  8356. }
  8357. inline bool range_error(Request &req, Response &res) {
  8358. if (!req.ranges.empty() && 200 <= res.status && res.status < 300) {
  8359. if (res.body.empty() && res.content_provider_ && res.content_length_ == 0) {
  8360. req.ranges.clear();
  8361. if (res.status == StatusCode::PartialContent_206) {
  8362. res.status = StatusCode::OK_200;
  8363. }
  8364. return false;
  8365. }
  8366. ssize_t content_len = static_cast<ssize_t>(
  8367. res.content_length_ ? res.content_length_ : res.body.size());
  8368. std::vector<std::pair<ssize_t, ssize_t>> processed_ranges;
  8369. size_t overwrapping_count = 0;
  8370. // NOTE: The following Range check is based on '14.2. Range' in RFC 9110
  8371. // 'HTTP Semantics' to avoid potential denial-of-service attacks.
  8372. // https://www.rfc-editor.org/rfc/rfc9110#section-14.2
  8373. // Too many ranges
  8374. if (req.ranges.size() > CPPHTTPLIB_RANGE_MAX_COUNT) { return true; }
  8375. for (auto &r : req.ranges) {
  8376. auto &first_pos = r.first;
  8377. auto &last_pos = r.second;
  8378. if (first_pos == -1 && last_pos == -1) {
  8379. first_pos = 0;
  8380. last_pos = content_len;
  8381. }
  8382. // RFC 9110 14.1.2: a suffix-length longer than the representation
  8383. // selects the entire representation.
  8384. if (first_pos == -1) {
  8385. first_pos = (std::max)(static_cast<ssize_t>(0), content_len - last_pos);
  8386. last_pos = content_len - 1;
  8387. }
  8388. // NOTE: RFC-9110 '14.1.2. Byte Ranges':
  8389. // A client can limit the number of bytes requested without knowing the
  8390. // size of the selected representation. If the last-pos value is absent,
  8391. // or if the value is greater than or equal to the current length of the
  8392. // representation data, the byte range is interpreted as the remainder of
  8393. // the representation (i.e., the server replaces the value of last-pos
  8394. // with a value that is one less than the current length of the selected
  8395. // representation).
  8396. // https://www.rfc-editor.org/rfc/rfc9110.html#section-14.1.2-6
  8397. if (last_pos == -1 || last_pos >= content_len) {
  8398. last_pos = content_len - 1;
  8399. }
  8400. // Range must be within content length
  8401. if (!(0 <= first_pos && first_pos <= last_pos &&
  8402. last_pos <= content_len - 1)) {
  8403. return true;
  8404. }
  8405. // Request must not have more than two overlapping ranges
  8406. for (const auto &processed_range : processed_ranges) {
  8407. if (!(last_pos < processed_range.first ||
  8408. first_pos > processed_range.second)) {
  8409. overwrapping_count++;
  8410. if (overwrapping_count > 2) { return true; }
  8411. break; // Only count once per range
  8412. }
  8413. }
  8414. processed_ranges.emplace_back(first_pos, last_pos);
  8415. }
  8416. // After validation, coalesce overlapping ranges as per RFC 9110
  8417. coalesce_ranges(req.ranges, static_cast<size_t>(content_len));
  8418. }
  8419. return false;
  8420. }
  8421. inline std::pair<size_t, size_t>
  8422. get_range_offset_and_length(Range r, size_t content_length) {
  8423. assert(r.first != -1 && r.second != -1);
  8424. assert(0 <= r.first && r.first < static_cast<ssize_t>(content_length));
  8425. assert(r.first <= r.second &&
  8426. r.second < static_cast<ssize_t>(content_length));
  8427. (void)(content_length);
  8428. return std::make_pair(static_cast<size_t>(r.first),
  8429. static_cast<size_t>(r.second - r.first) + 1);
  8430. }
  8431. inline std::string make_content_range_header_field(
  8432. const std::pair<size_t, size_t> &offset_and_length, size_t content_length) {
  8433. auto st = offset_and_length.first;
  8434. auto ed = st + offset_and_length.second - 1;
  8435. std::string field = "bytes ";
  8436. field += std::to_string(st);
  8437. field += '-';
  8438. field += std::to_string(ed);
  8439. field += '/';
  8440. field += std::to_string(content_length);
  8441. return field;
  8442. }
  8443. template <typename SToken, typename CToken, typename Content>
  8444. bool process_multipart_ranges_data(const Request &req,
  8445. const std::string &boundary,
  8446. const std::string &content_type,
  8447. size_t content_length, SToken stoken,
  8448. CToken ctoken, Content content) {
  8449. for (size_t i = 0; i < req.ranges.size(); i++) {
  8450. ctoken("--");
  8451. stoken(boundary);
  8452. ctoken("\r\n");
  8453. if (!content_type.empty()) {
  8454. ctoken("Content-Type: ");
  8455. stoken(content_type);
  8456. ctoken("\r\n");
  8457. }
  8458. auto offset_and_length =
  8459. get_range_offset_and_length(req.ranges[i], content_length);
  8460. ctoken("Content-Range: ");
  8461. stoken(make_content_range_header_field(offset_and_length, content_length));
  8462. ctoken("\r\n");
  8463. ctoken("\r\n");
  8464. if (!content(offset_and_length.first, offset_and_length.second)) {
  8465. return false;
  8466. }
  8467. ctoken("\r\n");
  8468. }
  8469. ctoken("--");
  8470. stoken(boundary);
  8471. ctoken("--");
  8472. return true;
  8473. }
  8474. inline void make_multipart_ranges_data(const Request &req, Response &res,
  8475. const std::string &boundary,
  8476. const std::string &content_type,
  8477. size_t content_length,
  8478. std::string &data) {
  8479. process_multipart_ranges_data(
  8480. req, boundary, content_type, content_length,
  8481. [&](const std::string &token) { data += token; },
  8482. [&](const std::string &token) { data += token; },
  8483. [&](size_t offset, size_t length) {
  8484. assert(offset + length <= content_length);
  8485. data += res.body.substr(offset, length);
  8486. return true;
  8487. });
  8488. }
  8489. inline size_t get_multipart_ranges_data_length(const Request &req,
  8490. const std::string &boundary,
  8491. const std::string &content_type,
  8492. size_t content_length) {
  8493. size_t data_length = 0;
  8494. process_multipart_ranges_data(
  8495. req, boundary, content_type, content_length,
  8496. [&](const std::string &token) { data_length += token.size(); },
  8497. [&](const std::string &token) { data_length += token.size(); },
  8498. [&](size_t /*offset*/, size_t length) {
  8499. data_length += length;
  8500. return true;
  8501. });
  8502. return data_length;
  8503. }
  8504. template <typename T>
  8505. inline bool
  8506. write_multipart_ranges_data(Stream &strm, const Request &req, Response &res,
  8507. const std::string &boundary,
  8508. const std::string &content_type,
  8509. size_t content_length, const T &is_shutting_down) {
  8510. return process_multipart_ranges_data(
  8511. req, boundary, content_type, content_length,
  8512. [&](const std::string &token) { strm.write(token); },
  8513. [&](const std::string &token) { strm.write(token); },
  8514. [&](size_t offset, size_t length) {
  8515. return write_content(strm, res.content_provider_, offset, length,
  8516. is_shutting_down);
  8517. });
  8518. }
  8519. inline bool has_framed_body(const Request &req) {
  8520. return is_chunked_transfer_encoding(req.headers) ||
  8521. req.get_header_value_u64("Content-Length") > 0;
  8522. }
  8523. inline bool is_connection_persistent(const Request &req) {
  8524. if (has_header_token(req.headers, "Connection", "close")) { return false; }
  8525. if (req.version == "HTTP/1.0" &&
  8526. !has_header_token(req.headers, "Connection", "keep-alive")) {
  8527. return false;
  8528. }
  8529. return true;
  8530. }
  8531. inline bool expect_content(const Request &req) {
  8532. if (req.method == "POST" || req.method == "PUT" || req.method == "PATCH" ||
  8533. req.method == "DELETE") {
  8534. return true;
  8535. }
  8536. return has_framed_body(req);
  8537. }
  8538. #ifdef _WIN32
  8539. class WSInit {
  8540. public:
  8541. WSInit() {
  8542. WSADATA wsaData;
  8543. if (WSAStartup(0x0002, &wsaData) == 0) is_valid_ = true;
  8544. }
  8545. ~WSInit() {
  8546. if (is_valid_) WSACleanup();
  8547. }
  8548. bool is_valid_ = false;
  8549. };
  8550. static WSInit wsinit_;
  8551. #endif
  8552. // RFC 9110 Section 11.6.1 defines a challenge list as
  8553. // WWW-Authenticate = #challenge
  8554. // challenge = auth-scheme [ 1*SP ( token68 / [ #auth-param ] ) ]
  8555. // auth-param = token BWS "=" BWS ( token / quoted-string )
  8556. // so a server may offer several schemes, each with its own comma-separated
  8557. // auth-param list, in either order and either as separate field lines or
  8558. // packed into one. Splitting on every comma would break apart a challenge's
  8559. // own param list; splitting only on the first space would miss a Digest
  8560. // challenge that isn't first. Split on commas that aren't inside a
  8561. // quoted-string instead, then track which scheme each resulting segment
  8562. // belongs to: a segment whose text before "=" contains whitespace (or that
  8563. // has no "=" at all) starts a new challenge named by its leading token.
  8564. inline std::vector<std::string> split_challenge_segments(const std::string &s) {
  8565. std::vector<std::string> segments;
  8566. size_t start = 0;
  8567. auto in_quotes = false;
  8568. for (size_t i = 0; i < s.size(); i++) {
  8569. auto c = s[i];
  8570. if (in_quotes) {
  8571. if (c == '\\' && i + 1 < s.size()) {
  8572. i++;
  8573. } else if (c == '"') {
  8574. in_quotes = false;
  8575. }
  8576. } else if (c == '"') {
  8577. in_quotes = true;
  8578. } else if (c == ',') {
  8579. segments.push_back(s.substr(start, i - start));
  8580. start = i + 1;
  8581. }
  8582. }
  8583. segments.push_back(s.substr(start));
  8584. return segments;
  8585. }
  8586. inline std::string unescape_quoted_pairs(const std::string &s) {
  8587. std::string out;
  8588. out.reserve(s.size());
  8589. for (size_t i = 0; i < s.size(); i++) {
  8590. if (s[i] == '\\' && i + 1 < s.size()) {
  8591. out += s[++i];
  8592. } else {
  8593. out += s[i];
  8594. }
  8595. }
  8596. return out;
  8597. }
  8598. // Inverse of unescape_quoted_pairs: prepares a value to sit inside a
  8599. // quoted-string. RFC 9110 §5.6.4 requires a literal '\' or '"' to be sent as a
  8600. // quoted-pair, so the recipient recovers the original value.
  8601. inline std::string escape_quoted_pairs(const std::string &s) {
  8602. std::string out;
  8603. out.reserve(s.size());
  8604. for (auto c : s) {
  8605. if (c == '\\' || c == '"') { out += '\\'; }
  8606. out += c;
  8607. }
  8608. return out;
  8609. }
  8610. inline bool parse_www_authenticate(const Response &res,
  8611. std::map<std::string, std::string> &auth,
  8612. bool is_proxy) {
  8613. auto auth_key = is_proxy ? "Proxy-Authenticate" : "WWW-Authenticate";
  8614. auto combined = get_combined_header_value(res.headers, auth_key);
  8615. if (combined.empty()) { return false; }
  8616. auto found_digest = false;
  8617. auto in_digest_challenge = false;
  8618. for (const auto &raw_segment : split_challenge_segments(combined)) {
  8619. auto segment = trim_copy(raw_segment);
  8620. if (segment.empty()) { continue; }
  8621. auto eq_pos = segment.find('=');
  8622. // BWS is allowed on both sides of "=", so the text naming the key (or,
  8623. // for the first segment of a challenge, "<scheme> <key>") must be
  8624. // trimmed before its boundaries are inspected.
  8625. auto key_part = trim_copy(
  8626. eq_pos == std::string::npos ? segment : segment.substr(0, eq_pos));
  8627. auto space_pos = key_part.find_last_of(" \t");
  8628. if (space_pos != std::string::npos || eq_pos == std::string::npos) {
  8629. // "<scheme>[ <key>]" starts a new challenge.
  8630. auto scheme_end =
  8631. space_pos == std::string::npos ? key_part.size() : space_pos;
  8632. // RFC 7616 Section 3.7: a server may offer more than one Digest
  8633. // challenge (e.g. SHA-256 and MD5); keep only the first so a nonce
  8634. // from one challenge is never paired with another's algorithm.
  8635. in_digest_challenge =
  8636. !found_digest &&
  8637. case_ignore::equal(key_part.substr(0, scheme_end), "Digest");
  8638. if (in_digest_challenge) { found_digest = true; }
  8639. if (space_pos == std::string::npos) {
  8640. // Bare scheme (or a token68), no auth-param on this segment.
  8641. continue;
  8642. }
  8643. key_part = key_part.substr(space_pos + 1);
  8644. }
  8645. if (!in_digest_challenge) { continue; }
  8646. auto val = trim_copy(segment.substr(eq_pos + 1));
  8647. auto unquoted = trim_double_quotes_copy(val);
  8648. if (unquoted.size() != val.size()) {
  8649. unquoted = unescape_quoted_pairs(unquoted);
  8650. }
  8651. auth[std::move(key_part)] = std::move(unquoted);
  8652. }
  8653. // RFC 7616 Section 3.3 requires realm and nonce on every Digest challenge;
  8654. // make_digest_authentication_header() dereferences both unconditionally, so
  8655. // a challenge missing either can't produce a usable Authorization header.
  8656. // Treat it the same as no Digest challenge at all.
  8657. return found_digest && auth.find("realm") != auth.end() &&
  8658. auth.find("nonce") != auth.end();
  8659. }
  8660. class ContentProviderAdapter {
  8661. public:
  8662. explicit ContentProviderAdapter(
  8663. ContentProviderWithoutLength &&content_provider)
  8664. : content_provider_(std::move(content_provider)) {}
  8665. bool operator()(size_t offset, size_t, DataSink &sink) {
  8666. return content_provider_(offset, sink);
  8667. }
  8668. private:
  8669. ContentProviderWithoutLength content_provider_;
  8670. };
  8671. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  8672. namespace fields {
  8673. inline bool is_token_char(char c) {
  8674. return is_ascii_alnum(c) || c == '!' || c == '#' || c == '$' || c == '%' ||
  8675. c == '&' || c == '\'' || c == '*' || c == '+' || c == '-' ||
  8676. c == '.' || c == '^' || c == '_' || c == '`' || c == '|' || c == '~';
  8677. }
  8678. inline bool is_token(const std::string &s) {
  8679. if (s.empty()) { return false; }
  8680. for (auto c : s) {
  8681. if (!is_token_char(c)) { return false; }
  8682. }
  8683. return true;
  8684. }
  8685. inline bool is_field_name(const std::string &s) { return is_token(s); }
  8686. inline bool is_vchar(char c) { return c >= 33 && c <= 126; }
  8687. inline bool is_obs_text(char c) { return 128 <= static_cast<unsigned char>(c); }
  8688. inline bool is_field_vchar(char c) { return is_vchar(c) || is_obs_text(c); }
  8689. inline bool is_field_content(const std::string &s) {
  8690. if (s.empty()) { return true; }
  8691. if (s.size() == 1) {
  8692. return is_field_vchar(s[0]);
  8693. } else if (s.size() == 2) {
  8694. return is_field_vchar(s[0]) && is_field_vchar(s[1]);
  8695. } else {
  8696. size_t i = 0;
  8697. if (!is_field_vchar(s[i])) { return false; }
  8698. i++;
  8699. while (i < s.size() - 1) {
  8700. auto c = s[i++];
  8701. if (c == ' ' || c == '\t' || is_field_vchar(c)) {
  8702. } else {
  8703. return false;
  8704. }
  8705. }
  8706. return is_field_vchar(s[i]);
  8707. }
  8708. }
  8709. inline bool is_field_value(const std::string &s) { return is_field_content(s); }
  8710. inline bool is_field_valid(const std::string &name, const std::string &value) {
  8711. return is_field_name(name) && is_field_value(value);
  8712. }
  8713. // RFC 9112 §2.2/§3.2: the request-target has no SP, HTAB or other control
  8714. // characters (incl. bare CR). obs-text (raw UTF-8) is allowed.
  8715. inline bool is_request_target(const std::string &s) {
  8716. return std::all_of(s.begin(), s.end(), is_field_vchar);
  8717. }
  8718. // RFC 9110 §7.2: the bytes of uri-host [ ":" port ], i.e. unreserved,
  8719. // sub-delims, "%", ":" and the IP-literal brackets. An empty value is valid.
  8720. inline bool is_host(const std::string &s) {
  8721. return std::all_of(s.begin(), s.end(), [](char c) {
  8722. return is_ascii_alnum(c) || c == '-' || c == '.' || c == '_' || c == '~' ||
  8723. c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  8724. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  8725. c == '=' || c == '%' || c == ':' || c == '[' || c == ']';
  8726. });
  8727. }
  8728. } // namespace fields
  8729. inline bool perform_websocket_handshake(Stream &strm, Request &req,
  8730. WebSocketUpgradeResponse &upgrade) {
  8731. // Generate a random 16-byte Sec-WebSocket-Key (RFC 6455 Section 4.1)
  8732. std::string key_bytes(16, '\0');
  8733. fill_random_bytes(reinterpret_cast<unsigned char *>(&key_bytes[0]),
  8734. key_bytes.size());
  8735. auto client_key = base64_encode(key_bytes);
  8736. req.headers.erase("Upgrade");
  8737. req.headers.erase("Connection");
  8738. req.headers.erase("Sec-WebSocket-Key");
  8739. req.headers.erase("Sec-WebSocket-Version");
  8740. req.headers.emplace("Upgrade", "websocket");
  8741. req.headers.emplace("Connection", "Upgrade");
  8742. req.headers.emplace("Sec-WebSocket-Key", client_key);
  8743. req.headers.emplace("Sec-WebSocket-Version", "13");
  8744. // Build the request in memory first, like ClientImpl::write_request does.
  8745. // Writing straight to the socket would leak a request line onto the wire
  8746. // before check_and_write_headers gets a chance to reject an invalid header,
  8747. // and would emit one small write per header.
  8748. BufferStream bstrm;
  8749. if (write_request_line(bstrm, req.method, req.path) < 0) {
  8750. upgrade.error = Error::Write;
  8751. return false;
  8752. }
  8753. auto error = Error::Success;
  8754. if (!check_and_write_headers(bstrm, req.headers, write_headers, error)) {
  8755. upgrade.error = error;
  8756. return false;
  8757. }
  8758. const auto &data = bstrm.get_buffer();
  8759. if (!write_data(strm, data.data(), data.size())) {
  8760. upgrade.error = Error::Write;
  8761. return false;
  8762. }
  8763. // Verify 101 response and Sec-WebSocket-Accept header
  8764. auto expected_accept = websocket_accept_key(client_key);
  8765. auto offered_subprotocols =
  8766. get_combined_header_value(req.headers, "Sec-WebSocket-Protocol");
  8767. return read_websocket_upgrade_response(strm, expected_accept,
  8768. offered_subprotocols, upgrade);
  8769. }
  8770. inline bool is_ip_address(const std::string &host) {
  8771. struct in_addr addr4;
  8772. struct in6_addr addr6;
  8773. return inet_pton(AF_INET, host.c_str(), &addr4) == 1 ||
  8774. inet_pton(AF_INET6, host.c_str(), &addr6) == 1;
  8775. }
  8776. // Resolve where a client should connect for `host`, honoring a user-supplied
  8777. // hostname-to-address map. `host` itself is never rewritten, so it keeps
  8778. // supplying the Host header and SNI; only the connection target changes.
  8779. //
  8780. // A mapped IP literal goes to `ip`, which keeps create_socket's AI_NUMERICHOST
  8781. // path. Anything else goes to `connect_host`, which create_socket resolves as
  8782. // a name, or uses as the socket path when the address family is AF_UNIX. An
  8783. // absent or empty mapping leaves `host` as the connection target; without the
  8784. // empty check the value would reach getaddrinfo as a null node and silently
  8785. // resolve to loopback.
  8786. inline void apply_addr_map(const std::map<std::string, std::string> &addr_map,
  8787. const std::string &host, std::string &connect_host,
  8788. std::string &ip) {
  8789. connect_host = host;
  8790. ip.clear();
  8791. auto it = addr_map.find(host);
  8792. if (it == addr_map.end() || it->second.empty()) { return; }
  8793. if (is_ip_address(it->second)) {
  8794. ip = it->second;
  8795. } else {
  8796. connect_host = it->second;
  8797. }
  8798. }
  8799. } // namespace detail
  8800. /*
  8801. * Group 2: detail namespace - SSL common utilities
  8802. */
  8803. #ifdef CPPHTTPLIB_SSL_ENABLED
  8804. namespace detail {
  8805. class SSLSocketStream final : public Stream {
  8806. public:
  8807. SSLSocketStream(
  8808. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  8809. time_t read_timeout_usec, time_t write_timeout_sec,
  8810. time_t write_timeout_usec, time_t max_timeout_msec = 0,
  8811. std::chrono::time_point<std::chrono::steady_clock> start_time =
  8812. (std::chrono::steady_clock::time_point::min)());
  8813. ~SSLSocketStream() override;
  8814. bool is_readable() const override;
  8815. bool wait_readable() const override;
  8816. bool wait_writable() const override;
  8817. bool is_peer_alive() const override;
  8818. ssize_t read(char *ptr, size_t size) override;
  8819. ssize_t write(const char *ptr, size_t size) override;
  8820. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  8821. void get_local_ip_and_port(std::string &ip, int &port) const override;
  8822. socket_t socket() const override;
  8823. time_t duration() const override;
  8824. void set_read_timeout(time_t sec, time_t usec = 0) override;
  8825. // See SocketStream::set_readable_hint().
  8826. void set_readable_hint() { readable_hint_ = true; }
  8827. private:
  8828. bool ensure_readable();
  8829. socket_t sock_;
  8830. tls::session_t session_;
  8831. time_t read_timeout_sec_;
  8832. time_t read_timeout_usec_;
  8833. time_t write_timeout_sec_;
  8834. time_t write_timeout_usec_;
  8835. time_t max_timeout_msec_;
  8836. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  8837. bool readable_hint_ = false;
  8838. };
  8839. // A TLS stream for WebSocket connections, where the receive path and the
  8840. // send path (application send() plus the heartbeat ping thread) run on
  8841. // different threads. A single TLS session must never be entered
  8842. // concurrently, so every call into the session is serialized by one mutex.
  8843. //
  8844. // Unlike SSLSocketStream, the socket is kept non-blocking for the stream's
  8845. // whole lifetime and each read()/write() performs a single non-blocking TLS
  8846. // call under the lock, then waits for readiness with select() outside the
  8847. // lock. The lock is therefore held only for CPU-bound work, so a reader
  8848. // blocked waiting for data never stalls a concurrent sender.
  8849. //
  8850. // This stream is used only for wss:// connections. Plain ws:// and ordinary
  8851. // HTTP/HTTPS keep using SocketStream/SSLSocketStream unchanged.
  8852. class WebSocketSSLStream final : public Stream {
  8853. public:
  8854. WebSocketSSLStream(socket_t sock, tls::session_t session,
  8855. time_t read_timeout_sec, time_t read_timeout_usec,
  8856. time_t write_timeout_sec, time_t write_timeout_usec);
  8857. ~WebSocketSSLStream() override;
  8858. bool is_readable() const override;
  8859. bool wait_readable() const override;
  8860. bool wait_writable() const override;
  8861. ssize_t read(char *ptr, size_t size) override;
  8862. ssize_t write(const char *ptr, size_t size) override;
  8863. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  8864. void get_local_ip_and_port(std::string &ip, int &port) const override;
  8865. socket_t socket() const override;
  8866. time_t duration() const override;
  8867. void set_read_timeout(time_t sec, time_t usec = 0) override;
  8868. private:
  8869. mutable std::mutex session_mutex_;
  8870. socket_t sock_;
  8871. tls::session_t session_;
  8872. // WebSocket::close() shortens the read timeout from the closing thread
  8873. // while the receive thread is inside wait_readable(), so these two are read
  8874. // and written concurrently. The write timeouts are never mutated.
  8875. std::atomic<time_t> read_timeout_sec_;
  8876. std::atomic<time_t> read_timeout_usec_;
  8877. time_t write_timeout_sec_;
  8878. time_t write_timeout_usec_;
  8879. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  8880. };
  8881. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  8882. inline std::string message_digest(const std::string &s, const EVP_MD *algo) {
  8883. auto context = std::unique_ptr<EVP_MD_CTX, decltype(&EVP_MD_CTX_free)>(
  8884. EVP_MD_CTX_new(), EVP_MD_CTX_free);
  8885. unsigned int hash_length = 0;
  8886. unsigned char hash[EVP_MAX_MD_SIZE];
  8887. EVP_DigestInit_ex(context.get(), algo, nullptr);
  8888. EVP_DigestUpdate(context.get(), s.c_str(), s.size());
  8889. EVP_DigestFinal_ex(context.get(), hash, &hash_length);
  8890. std::stringstream ss;
  8891. for (auto i = 0u; i < hash_length; ++i) {
  8892. ss << std::hex << std::setw(2) << std::setfill('0')
  8893. << static_cast<unsigned int>(hash[i]);
  8894. }
  8895. return ss.str();
  8896. }
  8897. inline std::string MD5(const std::string &s) {
  8898. return message_digest(s, EVP_md5());
  8899. }
  8900. inline std::string SHA_256(const std::string &s) {
  8901. return message_digest(s, EVP_sha256());
  8902. }
  8903. inline std::string SHA_512(const std::string &s) {
  8904. return message_digest(s, EVP_sha512());
  8905. }
  8906. #elif defined(CPPHTTPLIB_MBEDTLS_SUPPORT)
  8907. namespace {
  8908. template <size_t N>
  8909. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  8910. std::stringstream ss;
  8911. for (size_t i = 0; i < N; ++i) {
  8912. ss << std::hex << std::setw(2) << std::setfill('0')
  8913. << static_cast<unsigned int>(hash[i]);
  8914. }
  8915. return ss.str();
  8916. }
  8917. } // namespace
  8918. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8919. // Mbed TLS 4.x provides hashing (and TLS RNG) via PSA Crypto, which must be
  8920. // initialized once. PSA state is process-global; do not free it.
  8921. inline bool ensure_mbedtls_psa_crypto() {
  8922. static std::once_flag once;
  8923. static bool ok = false;
  8924. std::call_once(once, []() { ok = (psa_crypto_init() == PSA_SUCCESS); });
  8925. return ok;
  8926. }
  8927. inline bool psa_hash(psa_algorithm_t alg, const std::string &s,
  8928. unsigned char *out, size_t out_size) {
  8929. if (!ensure_mbedtls_psa_crypto()) { return false; }
  8930. size_t olen = 0;
  8931. return psa_hash_compute(alg, reinterpret_cast<const uint8_t *>(s.data()),
  8932. s.size(), out, out_size, &olen) == PSA_SUCCESS &&
  8933. olen == out_size;
  8934. }
  8935. #endif
  8936. inline std::string MD5(const std::string &s) {
  8937. unsigned char hash[16];
  8938. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8939. if (!psa_hash(PSA_ALG_MD5, s, hash, sizeof(hash))) { return {}; }
  8940. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8941. mbedtls_md5(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8942. hash);
  8943. #else
  8944. mbedtls_md5_ret(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8945. hash);
  8946. #endif
  8947. return hash_to_hex(hash);
  8948. }
  8949. inline std::string SHA_256(const std::string &s) {
  8950. unsigned char hash[32];
  8951. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8952. if (!psa_hash(PSA_ALG_SHA_256, s, hash, sizeof(hash))) { return {}; }
  8953. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8954. mbedtls_sha256(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8955. hash, 0);
  8956. #else
  8957. mbedtls_sha256_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  8958. s.size(), hash, 0);
  8959. #endif
  8960. return hash_to_hex(hash);
  8961. }
  8962. inline std::string SHA_512(const std::string &s) {
  8963. unsigned char hash[64];
  8964. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8965. if (!psa_hash(PSA_ALG_SHA_512, s, hash, sizeof(hash))) { return {}; }
  8966. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8967. mbedtls_sha512(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8968. hash, 0);
  8969. #else
  8970. mbedtls_sha512_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  8971. s.size(), hash, 0);
  8972. #endif
  8973. return hash_to_hex(hash);
  8974. }
  8975. #elif defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  8976. namespace {
  8977. template <size_t N>
  8978. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  8979. std::stringstream ss;
  8980. for (size_t i = 0; i < N; ++i) {
  8981. ss << std::hex << std::setw(2) << std::setfill('0')
  8982. << static_cast<unsigned int>(hash[i]);
  8983. }
  8984. return ss.str();
  8985. }
  8986. } // namespace
  8987. inline std::string MD5(const std::string &s) {
  8988. unsigned char hash[WC_MD5_DIGEST_SIZE];
  8989. wc_Md5Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  8990. static_cast<word32>(s.size()), hash);
  8991. return hash_to_hex(hash);
  8992. }
  8993. inline std::string SHA_256(const std::string &s) {
  8994. unsigned char hash[WC_SHA256_DIGEST_SIZE];
  8995. wc_Sha256Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  8996. static_cast<word32>(s.size()), hash);
  8997. return hash_to_hex(hash);
  8998. }
  8999. inline std::string SHA_512(const std::string &s) {
  9000. unsigned char hash[WC_SHA512_DIGEST_SIZE];
  9001. wc_Sha512Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9002. static_cast<word32>(s.size()), hash);
  9003. return hash_to_hex(hash);
  9004. }
  9005. #endif
  9006. template <typename T>
  9007. inline bool process_server_socket_ssl(
  9008. const std::atomic<socket_t> &svr_sock, tls::session_t session,
  9009. socket_t sock, size_t keep_alive_max_count, time_t keep_alive_timeout_sec,
  9010. time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec,
  9011. time_t write_timeout_usec, T callback) {
  9012. // See process_server_socket(). The TLS library keeps already decrypted bytes
  9013. // of a pipelined request, which keep_alive() cannot see on the socket.
  9014. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9015. write_timeout_sec, write_timeout_usec);
  9016. return process_server_socket_core(
  9017. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  9018. [&]() { return strm.is_readable(); },
  9019. [&](bool socket_readable, bool close_connection,
  9020. bool &connection_closed) {
  9021. if (socket_readable) { strm.set_readable_hint(); }
  9022. return callback(strm, close_connection, connection_closed);
  9023. });
  9024. }
  9025. template <typename T>
  9026. inline bool process_client_socket_ssl(
  9027. tls::session_t session, socket_t sock, time_t read_timeout_sec,
  9028. time_t read_timeout_usec, time_t write_timeout_sec,
  9029. time_t write_timeout_usec, time_t max_timeout_msec,
  9030. std::chrono::time_point<std::chrono::steady_clock> start_time, T callback) {
  9031. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9032. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  9033. start_time);
  9034. return callback(strm);
  9035. }
  9036. inline std::pair<std::string, std::string> make_digest_authentication_header(
  9037. const Request &req, const std::map<std::string, std::string> &auth,
  9038. size_t cnonce_count, const std::string &cnonce, const std::string &username,
  9039. const std::string &password, bool is_proxy = false) {
  9040. std::string nc;
  9041. {
  9042. std::stringstream ss;
  9043. ss << std::setfill('0') << std::setw(8) << std::hex << cnonce_count;
  9044. nc = ss.str();
  9045. }
  9046. std::string qop;
  9047. if (auth.find("qop") != auth.end()) {
  9048. qop = auth.at("qop");
  9049. if (qop.find("auth-int") != std::string::npos) {
  9050. qop = "auth-int";
  9051. } else if (qop.find("auth") != std::string::npos) {
  9052. qop = "auth";
  9053. } else {
  9054. qop.clear();
  9055. }
  9056. }
  9057. std::string algo = "MD5";
  9058. if (auth.find("algorithm") != auth.end()) {
  9059. // algorithm is an unquoted token (RFC 7616 §3.4). A server value that is
  9060. // not a token would otherwise be emitted verbatim and could carry commas
  9061. // or quotes that inject further auth-params into the header below.
  9062. const auto &a = auth.at("algorithm");
  9063. if (fields::is_token(a)) { algo = a; }
  9064. }
  9065. std::string response;
  9066. {
  9067. auto H = algo == "SHA-256" ? detail::SHA_256
  9068. : algo == "SHA-512" ? detail::SHA_512
  9069. : detail::MD5;
  9070. auto A1 = username + ":" + auth.at("realm") + ":" + password;
  9071. auto A2 = req.method + ":" + req.path;
  9072. if (qop == "auth-int") { A2 += ":" + H(req.body); }
  9073. if (qop.empty()) {
  9074. response = H(H(A1) + ":" + auth.at("nonce") + ":" + H(A2));
  9075. } else {
  9076. response = H(H(A1) + ":" + auth.at("nonce") + ":" + nc + ":" + cnonce +
  9077. ":" + qop + ":" + H(A2));
  9078. }
  9079. }
  9080. auto opaque = (auth.find("opaque") != auth.end()) ? auth.at("opaque") : "";
  9081. // Every value placed inside a quoted-string is escaped so a '"' in it cannot
  9082. // close the string early. realm, nonce and opaque come straight from the
  9083. // server's challenge (parse_www_authenticate() already de-escaped them), so
  9084. // without this a crafted challenge injects extra auth-params into the header.
  9085. auto field =
  9086. "Digest username=\"" + detail::escape_quoted_pairs(username) +
  9087. "\", realm=\"" + detail::escape_quoted_pairs(auth.at("realm")) +
  9088. "\", nonce=\"" + detail::escape_quoted_pairs(auth.at("nonce")) +
  9089. "\", uri=\"" + detail::escape_quoted_pairs(req.path) +
  9090. "\", algorithm=" + algo +
  9091. (qop.empty() ? ", response=\""
  9092. : ", qop=" + qop + ", nc=" + nc + ", cnonce=\"" + cnonce +
  9093. "\", response=\"") +
  9094. response + "\"" +
  9095. (opaque.empty()
  9096. ? ""
  9097. : ", opaque=\"" + detail::escape_quoted_pairs(opaque) + "\"");
  9098. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9099. return std::make_pair(key, field);
  9100. }
  9101. inline bool match_hostname(const std::string &pattern,
  9102. const std::string &hostname) {
  9103. // Exact match (case-insensitive)
  9104. if (detail::case_ignore::equal(hostname, pattern)) { return true; }
  9105. // Split both pattern and hostname into components by '.'
  9106. std::vector<std::string> pattern_components;
  9107. if (!pattern.empty()) {
  9108. split(pattern.data(), pattern.data() + pattern.size(), '.',
  9109. [&](const char *b, const char *e) {
  9110. pattern_components.emplace_back(b, e);
  9111. });
  9112. }
  9113. std::vector<std::string> host_components;
  9114. if (!hostname.empty()) {
  9115. split(hostname.data(), hostname.data() + hostname.size(), '.',
  9116. [&](const char *b, const char *e) {
  9117. host_components.emplace_back(b, e);
  9118. });
  9119. }
  9120. // Component count must match
  9121. if (host_components.size() != pattern_components.size()) { return false; }
  9122. // Compare each component with wildcard support
  9123. // Supports: "*" (full wildcard), "prefix*" (partial wildcard)
  9124. // https://bugs.launchpad.net/ubuntu/+source/firefox-3.0/+bug/376484
  9125. // Only the leftmost label may carry a wildcard (RFC 6125 6.4.3)
  9126. auto itr = pattern_components.begin();
  9127. for (const auto &h : host_components) {
  9128. auto &p = *itr;
  9129. auto is_leftmost = itr == pattern_components.begin();
  9130. if (!detail::case_ignore::equal(p, h) && !(is_leftmost && p == "*")) {
  9131. bool partial_match = false;
  9132. if (is_leftmost && !p.empty() && p[p.size() - 1] == '*') {
  9133. const auto prefix_length = p.size() - 1;
  9134. if (prefix_length == 0) {
  9135. partial_match = true;
  9136. } else if (h.size() >= prefix_length) {
  9137. partial_match =
  9138. std::equal(p.begin(),
  9139. p.begin() + static_cast<std::string::difference_type>(
  9140. prefix_length),
  9141. h.begin(), [](const char ca, const char cb) {
  9142. return detail::case_ignore::to_lower(ca) ==
  9143. detail::case_ignore::to_lower(cb);
  9144. });
  9145. }
  9146. }
  9147. if (!partial_match) { return false; }
  9148. }
  9149. ++itr;
  9150. }
  9151. return true;
  9152. }
  9153. #ifdef _WIN32
  9154. // Verify certificate using Windows CertGetCertificateChain API.
  9155. // This provides real-time certificate validation with Windows Update
  9156. // integration, independent of the TLS backend.
  9157. inline bool verify_cert_with_windows_schannel(
  9158. const std::vector<unsigned char> &der_cert, const std::string &hostname,
  9159. bool verify_hostname, uint64_t &out_error, tls::const_session_t session) {
  9160. if (der_cert.empty()) { return false; }
  9161. out_error = 0;
  9162. // Create Windows certificate context from DER data
  9163. auto cert_context = CertCreateCertificateContext(
  9164. X509_ASN_ENCODING | PKCS_7_ASN_ENCODING, der_cert.data(),
  9165. static_cast<DWORD>(der_cert.size()));
  9166. if (!cert_context) {
  9167. out_error = GetLastError();
  9168. return false;
  9169. }
  9170. auto cert_guard =
  9171. scope_exit([&] { CertFreeCertificateContext(cert_context); });
  9172. // Give CryptoAPI the certificates the server sent. Without them it follows
  9173. // the leaf's AIA URL, which may lead to an issuer under an untrusted root.
  9174. std::vector<tls::cert_t> peer_certs;
  9175. tls::get_peer_certs(session, peer_certs);
  9176. auto store = CertOpenStore(CERT_STORE_PROV_MEMORY, 0, 0, 0, nullptr);
  9177. auto store_guard = scope_exit([&] {
  9178. for (auto cert : peer_certs) {
  9179. tls::free_cert(cert);
  9180. }
  9181. if (store) { CertCloseStore(store, 0); }
  9182. });
  9183. for (auto cert : peer_certs) {
  9184. std::vector<unsigned char> der;
  9185. if (store && tls::get_cert_der(cert, der)) {
  9186. CertAddEncodedCertificateToStore(store, X509_ASN_ENCODING, der.data(),
  9187. static_cast<DWORD>(der.size()),
  9188. CERT_STORE_ADD_USE_EXISTING, nullptr);
  9189. }
  9190. }
  9191. // Setup chain parameters
  9192. CERT_CHAIN_PARA chain_para = {};
  9193. chain_para.cbSize = sizeof(chain_para);
  9194. // Require the server authentication usage along the chain, which also
  9195. // rejects roots that Windows trusts only for other purposes.
  9196. LPSTR server_auth = const_cast<LPSTR>(szOID_PKIX_KP_SERVER_AUTH);
  9197. chain_para.RequestedUsage.dwType = USAGE_MATCH_TYPE_AND;
  9198. chain_para.RequestedUsage.Usage.cUsageIdentifier = 1;
  9199. chain_para.RequestedUsage.Usage.rgpszUsageIdentifier = &server_auth;
  9200. // Build certificate chain with revocation checking
  9201. PCCERT_CHAIN_CONTEXT chain_context = nullptr;
  9202. auto chain_result = CertGetCertificateChain(
  9203. nullptr, cert_context, nullptr, store, &chain_para,
  9204. CERT_CHAIN_CACHE_END_CERT | CERT_CHAIN_REVOCATION_CHECK_END_CERT |
  9205. CERT_CHAIN_REVOCATION_ACCUMULATIVE_TIMEOUT,
  9206. nullptr, &chain_context);
  9207. if (!chain_result || !chain_context) {
  9208. out_error = GetLastError();
  9209. return false;
  9210. }
  9211. auto chain_guard =
  9212. scope_exit([&] { CertFreeCertificateChain(chain_context); });
  9213. // Verify SSL policy
  9214. SSL_EXTRA_CERT_CHAIN_POLICY_PARA extra_policy_para = {};
  9215. extra_policy_para.cbSize = sizeof(extra_policy_para);
  9216. #ifdef AUTHTYPE_SERVER
  9217. extra_policy_para.dwAuthType = AUTHTYPE_SERVER;
  9218. #endif
  9219. std::wstring whost;
  9220. if (verify_hostname) {
  9221. whost = u8string_to_wstring(hostname.c_str());
  9222. extra_policy_para.pwszServerName = const_cast<wchar_t *>(whost.c_str());
  9223. }
  9224. CERT_CHAIN_POLICY_PARA policy_para = {};
  9225. policy_para.cbSize = sizeof(policy_para);
  9226. #ifdef CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS
  9227. policy_para.dwFlags = CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS;
  9228. #else
  9229. policy_para.dwFlags = 0;
  9230. #endif
  9231. policy_para.pvExtraPolicyPara = &extra_policy_para;
  9232. CERT_CHAIN_POLICY_STATUS policy_status = {};
  9233. policy_status.cbSize = sizeof(policy_status);
  9234. if (!CertVerifyCertificateChainPolicy(CERT_CHAIN_POLICY_SSL, chain_context,
  9235. &policy_para, &policy_status)) {
  9236. out_error = GetLastError();
  9237. return false;
  9238. }
  9239. if (policy_status.dwError != 0) {
  9240. out_error = policy_status.dwError;
  9241. return false;
  9242. }
  9243. return true;
  9244. }
  9245. #endif // _WIN32
  9246. // Loads CA file/dir configuration and applies the system CA policy to a
  9247. // client TLS context. PEM data and native stores are applied to the context
  9248. // directly at set time; has_custom_store reflects them for the Auto policy
  9249. // decision.
  9250. inline bool load_client_ca_config(tls::ctx_t ctx,
  9251. const std::string &ca_cert_file_path,
  9252. const std::string &ca_cert_dir_path,
  9253. bool has_custom_store, SystemCAMode mode,
  9254. uint64_t &backend_error) {
  9255. auto ret = true;
  9256. if (!ca_cert_file_path.empty()) {
  9257. if (!tls::load_ca_file(ctx, ca_cert_file_path.c_str())) {
  9258. backend_error = tls::get_error();
  9259. ret = false;
  9260. }
  9261. } else if (!ca_cert_dir_path.empty()) {
  9262. if (!tls::load_ca_dir(ctx, ca_cert_dir_path.c_str())) {
  9263. backend_error = tls::get_error();
  9264. ret = false;
  9265. }
  9266. }
  9267. auto has_custom_ca = !ca_cert_file_path.empty() ||
  9268. !ca_cert_dir_path.empty() || has_custom_store;
  9269. if (mode == SystemCAMode::Enabled ||
  9270. (mode == SystemCAMode::Auto && !has_custom_ca)) {
  9271. if (!tls::load_system_certs(ctx)) { backend_error = tls::get_error(); }
  9272. }
  9273. return ret;
  9274. }
  9275. inline std::string ca_certs_to_pem(tls::ctx_t ctx) {
  9276. std::vector<tls::cert_t> certs;
  9277. tls::get_ca_certs(ctx, certs);
  9278. std::string pem;
  9279. for (auto cert : certs) {
  9280. std::vector<unsigned char> der;
  9281. if (tls::get_cert_der(cert, der)) {
  9282. auto b64 = base64_encode(std::string(der.begin(), der.end()));
  9283. pem += "-----BEGIN CERTIFICATE-----\n";
  9284. for (size_t i = 0; i < b64.size(); i += 64) {
  9285. pem += b64.substr(i, 64) + "\n";
  9286. }
  9287. pem += "-----END CERTIFICATE-----\n";
  9288. }
  9289. tls::free_cert(cert);
  9290. }
  9291. return pem;
  9292. }
  9293. // The parts of session setup that only SSLClient needs, plus the handful
  9294. // WebSocketClient also exposes; everything else takes the defaults, which is
  9295. // what keeps the two clients on one implementation.
  9296. struct ClientTlsSessionOptions {
  9297. // Both SSLClient and WebSocketClient expose this independently of
  9298. // certificate verification.
  9299. bool server_hostname_verification = true;
  9300. std::function<SSLVerifierResponse(tls::session_t)> session_verifier;
  9301. // When non-null, guards session creation against concurrent use of the
  9302. // context. A WebSocketClient is not safe to use from several threads to
  9303. // begin with, so it passes nothing.
  9304. std::mutex *ctx_mutex = nullptr;
  9305. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9306. // The caller decides whether Schannel has anything to say about this
  9307. // connection; see SSLClient::initialize_ssl().
  9308. bool windows_cert_verification = false;
  9309. // A server certificate verifier works on the backend's chain verification,
  9310. // so the backend keeps deciding and Schannel only adds its own check.
  9311. bool server_certificate_verifier_set = false;
  9312. #endif
  9313. };
  9314. // Filled in on failure for callers that report error details.
  9315. struct ClientTlsSessionError {
  9316. Error error = Error::Success;
  9317. int ssl_error = 0;
  9318. uint64_t backend_error = 0;
  9319. };
  9320. // Establishes a client TLS session on an already connected socket. On failure
  9321. // the session is left for the caller to free: SSLClient frees it right away,
  9322. // WebSocketClient keeps it in a member that shutdown_and_close() cleans up.
  9323. inline bool setup_client_tls_session(
  9324. const std::string &host, tls::ctx_t ctx, tls::session_t &session,
  9325. socket_t sock, bool server_certificate_verification, time_t timeout_sec,
  9326. time_t timeout_usec, ClientTlsSessionError *out_error = nullptr,
  9327. const ClientTlsSessionOptions &options = ClientTlsSessionOptions()) {
  9328. using namespace tls;
  9329. auto fail = [&](Error error, int ssl_error, uint64_t backend_error) {
  9330. if (out_error) {
  9331. out_error->error = error;
  9332. out_error->ssl_error = ssl_error;
  9333. out_error->backend_error = backend_error;
  9334. }
  9335. return false;
  9336. };
  9337. if (!ctx) {
  9338. session = nullptr;
  9339. return fail(Error::SSLConnection, 0, 0);
  9340. }
  9341. // With Windows verification on and no server certificate verifier set,
  9342. // Schannel is the only chain verifier. The backend's trust store is a
  9343. // snapshot of the Windows stores that lacks the roots Windows fetches on
  9344. // demand, so the backend's verdict is not used.
  9345. auto windows_verifies_chain = false;
  9346. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9347. windows_verifies_chain = options.windows_cert_verification &&
  9348. !options.server_certificate_verifier_set;
  9349. #endif
  9350. #if defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9351. // Mbed TLS and wolfSSL need the verification mode set explicitly; OpenSSL
  9352. // uses SSL_VERIFY_NONE and does all verification post-handshake. Unless
  9353. // Schannel verifies the chain instead, chain verification happens during
  9354. // the handshake even for IP hosts; the certificate identity is verified
  9355. // post-handshake via verify_hostname().
  9356. set_verify_client(ctx,
  9357. server_certificate_verification && !windows_verifies_chain);
  9358. #endif
  9359. {
  9360. std::unique_lock<std::mutex> guard;
  9361. if (options.ctx_mutex) {
  9362. guard = std::unique_lock<std::mutex>(*options.ctx_mutex);
  9363. }
  9364. session = create_session(ctx, sock);
  9365. }
  9366. if (!session) { return fail(Error::SSLConnection, 0, get_error()); }
  9367. // RFC 6066: SNI must not be set for IP addresses; skip it for IP hosts, so
  9368. // their identity is checked post-handshake below instead. On Mbed TLS and
  9369. // wolfSSL, set_sni also drives handshake-time hostname verification, so
  9370. // options.server_hostname_verification is threaded through here.
  9371. if (!is_ip_address(host)) {
  9372. if (!set_sni(session, host.c_str(), options.server_hostname_verification)) {
  9373. return fail(Error::SSLConnection, 0, get_error());
  9374. }
  9375. }
  9376. TlsError tls_err;
  9377. if (!connect_nonblocking(session, sock, timeout_sec, timeout_usec,
  9378. &tls_err)) {
  9379. auto error = Error::SSLConnection;
  9380. if (tls_err.code == ErrorCode::CertVerifyFailed) {
  9381. error = Error::SSLServerVerification;
  9382. } else if (tls_err.code == ErrorCode::HostnameMismatch) {
  9383. error = Error::SSLServerHostnameVerification;
  9384. }
  9385. return fail(error, static_cast<int>(tls_err.code), tls_err.backend_code);
  9386. }
  9387. auto verification_status = SSLVerifierResponse::NoDecisionMade;
  9388. if (options.session_verifier) {
  9389. verification_status = options.session_verifier(session);
  9390. }
  9391. if (verification_status == SSLVerifierResponse::CertificateRejected) {
  9392. return fail(Error::SSLServerVerification, 0, get_error());
  9393. }
  9394. if (verification_status == SSLVerifierResponse::NoDecisionMade &&
  9395. server_certificate_verification) {
  9396. if (!windows_verifies_chain) {
  9397. auto verify_result = get_verify_result(session);
  9398. if (verify_result != 0) {
  9399. return fail(Error::SSLServerVerification, 0,
  9400. static_cast<uint64_t>(verify_result));
  9401. }
  9402. }
  9403. auto server_cert = get_peer_cert(session);
  9404. if (!server_cert) {
  9405. return fail(Error::SSLServerVerification, 0, get_error());
  9406. }
  9407. auto cert_guard = detail::scope_exit([&] { free_cert(server_cert); });
  9408. // Identity check against the peer certificate, post-handshake for all
  9409. // backends. For IP hosts this is the only identity verification, since no
  9410. // hostname is bound during the handshake.
  9411. if (options.server_hostname_verification) {
  9412. if (!verify_hostname(server_cert, host.c_str())) {
  9413. return fail(Error::SSLServerHostnameVerification, 0,
  9414. hostname_mismatch_code());
  9415. }
  9416. }
  9417. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9418. // Windows Schannel verification, which lets Windows fetch missing roots
  9419. // and intermediates on demand. It must not be skipped: unless a server
  9420. // certificate verifier is set, it is the only chain check.
  9421. if (options.windows_cert_verification) {
  9422. std::vector<unsigned char> der;
  9423. uint64_t wincrypt_error = 0;
  9424. if (!get_cert_der(server_cert, der) ||
  9425. !verify_cert_with_windows_schannel(
  9426. der, host, options.server_hostname_verification, wincrypt_error,
  9427. session)) {
  9428. return fail(Error::SSLServerVerification, 0, wincrypt_error);
  9429. }
  9430. }
  9431. #endif
  9432. }
  9433. return true;
  9434. }
  9435. } // namespace detail
  9436. #endif // CPPHTTPLIB_SSL_ENABLED
  9437. /*
  9438. * Group 3: httplib namespace - Non-SSL public API implementations
  9439. */
  9440. inline void default_socket_options(socket_t sock) {
  9441. set_socket_opt(sock, SOL_SOCKET,
  9442. #ifdef SO_REUSEPORT
  9443. SO_REUSEPORT,
  9444. #else
  9445. SO_REUSEADDR,
  9446. #endif
  9447. 1);
  9448. }
  9449. inline bool set_socket_opt(socket_t sock, int level, int optname, int optval) {
  9450. return detail::set_socket_opt_impl(sock, level, optname, &optval,
  9451. sizeof(optval));
  9452. }
  9453. inline std::string get_bearer_token_auth(const Request &req) {
  9454. // The auth scheme is case-insensitive (RFC 9110 11.1), and a value shorter
  9455. // than the prefix carries no token.
  9456. constexpr const char bearer_prefix[] = "Bearer ";
  9457. constexpr auto bearer_prefix_len = detail::str_len(bearer_prefix);
  9458. auto value = req.get_header_value("Authorization");
  9459. if (value.size() >= bearer_prefix_len &&
  9460. detail::case_ignore::equal(value.substr(0, bearer_prefix_len),
  9461. bearer_prefix)) {
  9462. return value.substr(bearer_prefix_len);
  9463. }
  9464. return "";
  9465. }
  9466. inline const char *status_message(int status) {
  9467. switch (status) {
  9468. case StatusCode::Continue_100: return "Continue";
  9469. case StatusCode::SwitchingProtocol_101: return "Switching Protocol";
  9470. case StatusCode::Processing_102: return "Processing";
  9471. case StatusCode::EarlyHints_103: return "Early Hints";
  9472. case StatusCode::OK_200: return "OK";
  9473. case StatusCode::Created_201: return "Created";
  9474. case StatusCode::Accepted_202: return "Accepted";
  9475. case StatusCode::NonAuthoritativeInformation_203:
  9476. return "Non-Authoritative Information";
  9477. case StatusCode::NoContent_204: return "No Content";
  9478. case StatusCode::ResetContent_205: return "Reset Content";
  9479. case StatusCode::PartialContent_206: return "Partial Content";
  9480. case StatusCode::MultiStatus_207: return "Multi-Status";
  9481. case StatusCode::AlreadyReported_208: return "Already Reported";
  9482. case StatusCode::IMUsed_226: return "IM Used";
  9483. case StatusCode::MultipleChoices_300: return "Multiple Choices";
  9484. case StatusCode::MovedPermanently_301: return "Moved Permanently";
  9485. case StatusCode::Found_302: return "Found";
  9486. case StatusCode::SeeOther_303: return "See Other";
  9487. case StatusCode::NotModified_304: return "Not Modified";
  9488. case StatusCode::UseProxy_305: return "Use Proxy";
  9489. case StatusCode::unused_306: return "unused";
  9490. case StatusCode::TemporaryRedirect_307: return "Temporary Redirect";
  9491. case StatusCode::PermanentRedirect_308: return "Permanent Redirect";
  9492. case StatusCode::BadRequest_400: return "Bad Request";
  9493. case StatusCode::Unauthorized_401: return "Unauthorized";
  9494. case StatusCode::PaymentRequired_402: return "Payment Required";
  9495. case StatusCode::Forbidden_403: return "Forbidden";
  9496. case StatusCode::NotFound_404: return "Not Found";
  9497. case StatusCode::MethodNotAllowed_405: return "Method Not Allowed";
  9498. case StatusCode::NotAcceptable_406: return "Not Acceptable";
  9499. case StatusCode::ProxyAuthenticationRequired_407:
  9500. return "Proxy Authentication Required";
  9501. case StatusCode::RequestTimeout_408: return "Request Timeout";
  9502. case StatusCode::Conflict_409: return "Conflict";
  9503. case StatusCode::Gone_410: return "Gone";
  9504. case StatusCode::LengthRequired_411: return "Length Required";
  9505. case StatusCode::PreconditionFailed_412: return "Precondition Failed";
  9506. case StatusCode::PayloadTooLarge_413: return "Payload Too Large";
  9507. case StatusCode::UriTooLong_414: return "URI Too Long";
  9508. case StatusCode::UnsupportedMediaType_415: return "Unsupported Media Type";
  9509. case StatusCode::RangeNotSatisfiable_416: return "Range Not Satisfiable";
  9510. case StatusCode::ExpectationFailed_417: return "Expectation Failed";
  9511. case StatusCode::ImATeapot_418: return "I'm a teapot";
  9512. case StatusCode::MisdirectedRequest_421: return "Misdirected Request";
  9513. case StatusCode::UnprocessableContent_422: return "Unprocessable Content";
  9514. case StatusCode::Locked_423: return "Locked";
  9515. case StatusCode::FailedDependency_424: return "Failed Dependency";
  9516. case StatusCode::TooEarly_425: return "Too Early";
  9517. case StatusCode::UpgradeRequired_426: return "Upgrade Required";
  9518. case StatusCode::PreconditionRequired_428: return "Precondition Required";
  9519. case StatusCode::TooManyRequests_429: return "Too Many Requests";
  9520. case StatusCode::RequestHeaderFieldsTooLarge_431:
  9521. return "Request Header Fields Too Large";
  9522. case StatusCode::UnavailableForLegalReasons_451:
  9523. return "Unavailable For Legal Reasons";
  9524. case StatusCode::NotImplemented_501: return "Not Implemented";
  9525. case StatusCode::BadGateway_502: return "Bad Gateway";
  9526. case StatusCode::ServiceUnavailable_503: return "Service Unavailable";
  9527. case StatusCode::GatewayTimeout_504: return "Gateway Timeout";
  9528. case StatusCode::HttpVersionNotSupported_505:
  9529. return "HTTP Version Not Supported";
  9530. case StatusCode::VariantAlsoNegotiates_506: return "Variant Also Negotiates";
  9531. case StatusCode::InsufficientStorage_507: return "Insufficient Storage";
  9532. case StatusCode::LoopDetected_508: return "Loop Detected";
  9533. case StatusCode::NotExtended_510: return "Not Extended";
  9534. case StatusCode::NetworkAuthenticationRequired_511:
  9535. return "Network Authentication Required";
  9536. default:
  9537. case StatusCode::InternalServerError_500: return "Internal Server Error";
  9538. }
  9539. }
  9540. inline std::string to_string(const Error error) {
  9541. switch (error) {
  9542. case Error::Success: return "Success (no error)";
  9543. case Error::Unknown: return "Unknown";
  9544. case Error::Connection: return "Could not establish connection";
  9545. case Error::BindIPAddress: return "Failed to bind IP address";
  9546. case Error::Read: return "Failed to read connection";
  9547. case Error::Write: return "Failed to write connection";
  9548. case Error::ExceedRedirectCount: return "Maximum redirect count exceeded";
  9549. case Error::Canceled: return "Connection handling canceled";
  9550. case Error::SSLConnection: return "SSL connection failed";
  9551. case Error::SSLLoadingCerts: return "SSL certificate loading failed";
  9552. case Error::SSLServerVerification: return "SSL server verification failed";
  9553. case Error::SSLServerHostnameVerification:
  9554. return "SSL server hostname verification failed";
  9555. case Error::UnsupportedMultipartBoundaryChars:
  9556. return "Unsupported HTTP multipart boundary characters";
  9557. case Error::Compression: return "Compression failed";
  9558. case Error::ConnectionTimeout: return "Connection timed out";
  9559. case Error::ProxyConnection: return "Proxy connection failed";
  9560. case Error::ConnectionClosed: return "Connection closed by server";
  9561. case Error::Timeout: return "Read timeout";
  9562. case Error::ResourceExhaustion: return "Resource exhaustion";
  9563. case Error::TooManyFormDataFiles: return "Too many form data files";
  9564. case Error::ExceedMaxPayloadSize: return "Exceeded maximum payload size";
  9565. case Error::ExceedUriMaxLength: return "Exceeded maximum URI length";
  9566. case Error::ExceedMaxSocketDescriptorCount:
  9567. return "Exceeded maximum socket descriptor count";
  9568. case Error::InvalidRequestLine: return "Invalid request line";
  9569. case Error::InvalidHTTPMethod: return "Invalid HTTP method";
  9570. case Error::InvalidHTTPVersion: return "Invalid HTTP version";
  9571. case Error::InvalidHeaders: return "Invalid headers";
  9572. case Error::MultipartParsing: return "Multipart parsing failed";
  9573. case Error::OpenFile: return "Failed to open file";
  9574. case Error::Listen: return "Failed to listen on socket";
  9575. case Error::GetSockName: return "Failed to get socket name";
  9576. case Error::UnsupportedAddressFamily: return "Unsupported address family";
  9577. case Error::HTTPParsing: return "HTTP parsing failed";
  9578. case Error::InvalidRangeHeader: return "Invalid Range header";
  9579. case Error::UnsupportedContentEncoding: return "Unsupported Content-Encoding";
  9580. case Error::WebSocketHandshake: return "WebSocket handshake failed";
  9581. case Error::UserCallbackException: return "User callback threw an exception";
  9582. default: break;
  9583. }
  9584. return "Invalid";
  9585. }
  9586. inline std::ostream &operator<<(std::ostream &os, const Error &obj) {
  9587. os << to_string(obj);
  9588. os << " (" << static_cast<std::underlying_type<Error>::type>(obj) << ')';
  9589. return os;
  9590. }
  9591. inline std::string hosted_at(const std::string &hostname) {
  9592. std::vector<std::string> addrs;
  9593. hosted_at(hostname, addrs);
  9594. if (addrs.empty()) { return std::string(); }
  9595. return addrs[0];
  9596. }
  9597. inline void hosted_at(const std::string &hostname,
  9598. std::vector<std::string> &addrs) {
  9599. struct addrinfo hints;
  9600. struct addrinfo *result;
  9601. memset(&hints, 0, sizeof(struct addrinfo));
  9602. hints.ai_family = AF_UNSPEC;
  9603. hints.ai_socktype = SOCK_STREAM;
  9604. hints.ai_protocol = 0;
  9605. if (detail::getaddrinfo_with_timeout(hostname.c_str(), nullptr, &hints,
  9606. &result, 0)) {
  9607. #if defined __linux__ && !defined __ANDROID__
  9608. res_init();
  9609. #endif
  9610. return;
  9611. }
  9612. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  9613. for (auto rp = result; rp; rp = rp->ai_next) {
  9614. const auto &addr =
  9615. *reinterpret_cast<struct sockaddr_storage *>(rp->ai_addr);
  9616. std::string ip;
  9617. auto dummy = -1;
  9618. if (detail::get_ip_and_port(addr, sizeof(struct sockaddr_storage), ip,
  9619. dummy)) {
  9620. addrs.emplace_back(std::move(ip));
  9621. }
  9622. }
  9623. }
  9624. inline std::string encode_uri_component(const std::string &value) {
  9625. std::ostringstream escaped;
  9626. escaped.fill('0');
  9627. escaped << std::hex;
  9628. for (auto c : value) {
  9629. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9630. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')') {
  9631. escaped << c;
  9632. } else {
  9633. escaped << std::uppercase;
  9634. escaped << '%' << std::setw(2)
  9635. << static_cast<int>(static_cast<unsigned char>(c));
  9636. escaped << std::nouppercase;
  9637. }
  9638. }
  9639. return escaped.str();
  9640. }
  9641. inline std::string encode_uri(const std::string &value) {
  9642. std::ostringstream escaped;
  9643. escaped.fill('0');
  9644. escaped << std::hex;
  9645. for (auto c : value) {
  9646. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9647. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')' ||
  9648. c == ';' || c == '/' || c == '?' || c == ':' || c == '@' || c == '&' ||
  9649. c == '=' || c == '+' || c == '$' || c == ',' || c == '#') {
  9650. escaped << c;
  9651. } else {
  9652. escaped << std::uppercase;
  9653. escaped << '%' << std::setw(2)
  9654. << static_cast<int>(static_cast<unsigned char>(c));
  9655. escaped << std::nouppercase;
  9656. }
  9657. }
  9658. return escaped.str();
  9659. }
  9660. inline std::string decode_uri_component(const std::string &value) {
  9661. std::string result;
  9662. for (size_t i = 0; i < value.size(); i++) {
  9663. if (value[i] == '%' && i + 2 < value.size()) {
  9664. auto val = 0;
  9665. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9666. result += static_cast<char>(val);
  9667. i += 2;
  9668. } else {
  9669. result += value[i];
  9670. }
  9671. } else {
  9672. result += value[i];
  9673. }
  9674. }
  9675. return result;
  9676. }
  9677. inline std::string decode_uri(const std::string &value) {
  9678. std::string result;
  9679. for (size_t i = 0; i < value.size(); i++) {
  9680. if (value[i] == '%' && i + 2 < value.size()) {
  9681. auto val = 0;
  9682. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9683. auto c = static_cast<char>(val);
  9684. // Keep escapes of the reserved characters that encode_uri leaves
  9685. // literal, so decode_uri is the inverse of encode_uri and an escaped
  9686. // delimiter is not promoted into a real one (as with JS decodeURI).
  9687. if (c == ';' || c == '/' || c == '?' || c == ':' || c == '@' ||
  9688. c == '&' || c == '=' || c == '+' || c == '$' || c == ',' ||
  9689. c == '#') {
  9690. result += value[i];
  9691. result += value[i + 1];
  9692. result += value[i + 2];
  9693. } else {
  9694. result += c;
  9695. }
  9696. i += 2;
  9697. } else {
  9698. result += value[i];
  9699. }
  9700. } else {
  9701. result += value[i];
  9702. }
  9703. }
  9704. return result;
  9705. }
  9706. inline std::string encode_path_component(const std::string &component) {
  9707. std::string result;
  9708. result.reserve(component.size() * 3);
  9709. for (size_t i = 0; i < component.size(); i++) {
  9710. auto c = static_cast<unsigned char>(component[i]);
  9711. // Unreserved characters per RFC 3986: ALPHA / DIGIT / "-" / "." / "_" / "~"
  9712. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9713. c == '_' || c == '~') {
  9714. result += static_cast<char>(c);
  9715. }
  9716. // Path-safe sub-delimiters: "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" /
  9717. // "," / ";" / "="
  9718. else if (c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  9719. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  9720. c == '=') {
  9721. result += static_cast<char>(c);
  9722. }
  9723. // Colon is allowed in path segments except first segment
  9724. else if (c == ':') {
  9725. result += static_cast<char>(c);
  9726. }
  9727. // @ is allowed in path
  9728. else if (c == '@') {
  9729. result += static_cast<char>(c);
  9730. } else {
  9731. result += '%';
  9732. char hex[3];
  9733. snprintf(hex, sizeof(hex), "%02X", c);
  9734. result.append(hex, 2);
  9735. }
  9736. }
  9737. return result;
  9738. }
  9739. inline std::string decode_path_component(const std::string &component) {
  9740. std::string result;
  9741. result.reserve(component.size());
  9742. for (size_t i = 0; i < component.size(); i++) {
  9743. if (component[i] == '%' && i + 1 < component.size()) {
  9744. if (component[i + 1] == 'u') {
  9745. // Unicode %uXXXX encoding
  9746. auto val = 0;
  9747. if (detail::from_hex_to_i(component, i + 2, 4, val)) {
  9748. // 4 digits Unicode codes: val is 0x0000-0xFFFF (from 4 hex digits),
  9749. // so to_utf8 writes at most 3 bytes. buff[4] is safe.
  9750. char buff[4];
  9751. size_t len = detail::to_utf8(val, buff);
  9752. if (len > 0) { result.append(buff, len); }
  9753. i += 5; // 'u0000'
  9754. } else {
  9755. result += component[i];
  9756. }
  9757. } else {
  9758. // Standard %XX encoding
  9759. auto val = 0;
  9760. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9761. // 2 digits hex codes
  9762. result += static_cast<char>(val);
  9763. i += 2; // 'XX'
  9764. } else {
  9765. result += component[i];
  9766. }
  9767. }
  9768. } else {
  9769. result += component[i];
  9770. }
  9771. }
  9772. return result;
  9773. }
  9774. inline std::string encode_query_component(const std::string &component,
  9775. bool space_as_plus) {
  9776. std::string result;
  9777. result.reserve(component.size() * 3);
  9778. for (size_t i = 0; i < component.size(); i++) {
  9779. auto c = static_cast<unsigned char>(component[i]);
  9780. // Unreserved characters per RFC 3986
  9781. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9782. c == '_' || c == '~') {
  9783. result += static_cast<char>(c);
  9784. }
  9785. // Space handling
  9786. else if (c == ' ') {
  9787. if (space_as_plus) {
  9788. result += '+';
  9789. } else {
  9790. result += "%20";
  9791. }
  9792. }
  9793. // Plus sign handling
  9794. else if (c == '+') {
  9795. if (space_as_plus) {
  9796. result += "%2B";
  9797. } else {
  9798. result += static_cast<char>(c);
  9799. }
  9800. }
  9801. // Query-safe sub-delimiters (excluding & and = which are query delimiters)
  9802. else if (c == '!' || c == '$' || c == '\'' || c == '(' || c == ')' ||
  9803. c == '*' || c == ',' || c == ';') {
  9804. result += static_cast<char>(c);
  9805. }
  9806. // Colon and @ are allowed in query
  9807. else if (c == ':' || c == '@') {
  9808. result += static_cast<char>(c);
  9809. }
  9810. // Forward slash is allowed in query values
  9811. else if (c == '/') {
  9812. result += static_cast<char>(c);
  9813. }
  9814. // Question mark is allowed in query values (after first ?)
  9815. else if (c == '?') {
  9816. result += static_cast<char>(c);
  9817. } else {
  9818. result += '%';
  9819. char hex[3];
  9820. snprintf(hex, sizeof(hex), "%02X", c);
  9821. result.append(hex, 2);
  9822. }
  9823. }
  9824. return result;
  9825. }
  9826. inline std::string decode_query_component(const std::string &component,
  9827. bool plus_as_space) {
  9828. std::string result;
  9829. result.reserve(component.size());
  9830. for (size_t i = 0; i < component.size(); i++) {
  9831. if (component[i] == '%' && i + 2 < component.size()) {
  9832. auto val = 0;
  9833. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9834. result += static_cast<char>(val);
  9835. i += 2;
  9836. } else {
  9837. result += component[i];
  9838. }
  9839. } else if (component[i] == '+' && plus_as_space) {
  9840. result += ' '; // + becomes space in form-urlencoded
  9841. } else {
  9842. result += component[i];
  9843. }
  9844. }
  9845. return result;
  9846. }
  9847. inline std::string sanitize_filename(const std::string &filename) {
  9848. // Extract basename: find the last path separator (/ or \)
  9849. auto pos = filename.find_last_of("/\\");
  9850. auto result =
  9851. (pos != std::string::npos) ? filename.substr(pos + 1) : filename;
  9852. // Strip null bytes
  9853. result.erase(std::remove(result.begin(), result.end(), '\0'), result.end());
  9854. // Trim whitespace
  9855. {
  9856. auto start = result.find_first_not_of(" \t");
  9857. auto end = result.find_last_not_of(" \t");
  9858. result = (start == std::string::npos)
  9859. ? ""
  9860. : result.substr(start, end - start + 1);
  9861. }
  9862. // Reject . and ..
  9863. if (result == "." || result == "..") { return ""; }
  9864. return result;
  9865. }
  9866. inline std::string append_query_params(const std::string &path,
  9867. const Params &params) {
  9868. std::string path_with_query = path;
  9869. path_with_query += path.find('?') == std::string::npos ? '?' : '&';
  9870. path_with_query += detail::params_to_query_str(params);
  9871. return path_with_query;
  9872. }
  9873. // Header utilities
  9874. inline std::pair<std::string, std::string>
  9875. make_range_header(const Ranges &ranges) {
  9876. std::string field = "bytes=";
  9877. auto i = 0;
  9878. for (const auto &r : ranges) {
  9879. if (i != 0) { field += ", "; }
  9880. if (r.first != -1) { field += std::to_string(r.first); }
  9881. field += '-';
  9882. if (r.second != -1) { field += std::to_string(r.second); }
  9883. i++;
  9884. }
  9885. return std::make_pair("Range", std::move(field));
  9886. }
  9887. inline std::pair<std::string, std::string>
  9888. make_basic_authentication_header(const std::string &username,
  9889. const std::string &password, bool is_proxy) {
  9890. auto field = "Basic " + detail::base64_encode(username + ":" + password);
  9891. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9892. return std::make_pair(key, std::move(field));
  9893. }
  9894. inline std::pair<std::string, std::string>
  9895. make_bearer_token_authentication_header(const std::string &token,
  9896. bool is_proxy = false) {
  9897. auto field = "Bearer " + token;
  9898. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9899. return std::make_pair(key, std::move(field));
  9900. }
  9901. // Request implementation
  9902. inline size_t Request::get_header_value_u64(const std::string &key, size_t def,
  9903. size_t id) const {
  9904. return detail::get_header_value_u64(headers, key, def, id);
  9905. }
  9906. inline bool Request::has_header(const std::string &key) const {
  9907. return detail::has_header(headers, key);
  9908. }
  9909. inline std::string Request::get_header_value(const std::string &key,
  9910. const char *def, size_t id) const {
  9911. return detail::get_header_value(headers, key, def, id);
  9912. }
  9913. inline size_t Request::get_header_value_count(const std::string &key) const {
  9914. return detail::get_header_value_count(headers, key);
  9915. }
  9916. inline void Request::set_header(const std::string &key,
  9917. const std::string &val) {
  9918. detail::set_header(headers, key, val);
  9919. }
  9920. inline bool Request::has_trailer(const std::string &key) const {
  9921. return trailers.find(key) != trailers.end();
  9922. }
  9923. inline std::string Request::get_trailer_value(const std::string &key,
  9924. size_t id) const {
  9925. return detail::get_multimap_value(trailers, key, id);
  9926. }
  9927. inline size_t Request::get_trailer_value_count(const std::string &key) const {
  9928. return trailers.count(key);
  9929. }
  9930. inline bool Request::has_param(const std::string &key) const {
  9931. return params.find(key) != params.end();
  9932. }
  9933. inline std::string Request::get_param_value(const std::string &key,
  9934. size_t id) const {
  9935. return detail::get_multimap_value(params, key, id);
  9936. }
  9937. inline std::vector<std::string>
  9938. Request::get_param_values(const std::string &key) const {
  9939. auto rng = params.equal_range(key);
  9940. std::vector<std::string> values;
  9941. values.reserve(static_cast<size_t>(std::distance(rng.first, rng.second)));
  9942. for (auto it = rng.first; it != rng.second; ++it) {
  9943. values.push_back(it->second);
  9944. }
  9945. return values;
  9946. }
  9947. inline size_t Request::get_param_value_count(const std::string &key) const {
  9948. return params.count(key);
  9949. }
  9950. inline bool Request::is_multipart_form_data() const {
  9951. const auto &content_type = get_header_value("Content-Type");
  9952. return detail::extract_media_type(content_type) == "multipart/form-data";
  9953. }
  9954. // Multipart FormData implementation
  9955. inline std::string MultipartFormData::get_field(const std::string &key,
  9956. size_t id) const {
  9957. auto rng = fields.equal_range(key);
  9958. auto it = detail::bounded_next(rng.first, id, rng.second);
  9959. if (it != rng.second) { return it->second.content; }
  9960. return std::string();
  9961. }
  9962. inline std::vector<std::string>
  9963. MultipartFormData::get_fields(const std::string &key) const {
  9964. std::vector<std::string> values;
  9965. auto rng = fields.equal_range(key);
  9966. for (auto it = rng.first; it != rng.second; it++) {
  9967. values.push_back(it->second.content);
  9968. }
  9969. return values;
  9970. }
  9971. inline bool MultipartFormData::has_field(const std::string &key) const {
  9972. return fields.find(key) != fields.end();
  9973. }
  9974. inline size_t MultipartFormData::get_field_count(const std::string &key) const {
  9975. return fields.count(key);
  9976. }
  9977. inline FormData MultipartFormData::get_file(const std::string &key,
  9978. size_t id) const {
  9979. return detail::get_multimap_value(files, key, id);
  9980. }
  9981. inline std::vector<FormData>
  9982. MultipartFormData::get_files(const std::string &key) const {
  9983. std::vector<FormData> values;
  9984. auto rng = files.equal_range(key);
  9985. for (auto it = rng.first; it != rng.second; it++) {
  9986. values.push_back(it->second);
  9987. }
  9988. return values;
  9989. }
  9990. inline bool MultipartFormData::has_file(const std::string &key) const {
  9991. return files.find(key) != files.end();
  9992. }
  9993. inline size_t MultipartFormData::get_file_count(const std::string &key) const {
  9994. return files.count(key);
  9995. }
  9996. // Multipart FormData writer implementation
  9997. inline bool is_valid_multipart_boundary(const std::string &boundary) {
  9998. return detail::is_multipart_boundary_chars_valid(boundary);
  9999. }
  10000. inline MultipartFormDataWriter::MultipartFormDataWriter()
  10001. : boundary_(detail::make_multipart_data_boundary()) {}
  10002. inline MultipartFormDataWriter::MultipartFormDataWriter(std::string boundary)
  10003. : boundary_(std::move(boundary)) {}
  10004. inline const std::string &MultipartFormDataWriter::boundary() const {
  10005. return boundary_;
  10006. }
  10007. inline std::string MultipartFormDataWriter::content_type() const {
  10008. return detail::serialize_multipart_formdata_get_content_type(boundary_);
  10009. }
  10010. inline std::string
  10011. MultipartFormDataWriter::serialize(const UploadFormDataItems &items) const {
  10012. return detail::serialize_multipart_formdata(items, boundary_);
  10013. }
  10014. inline size_t MultipartFormDataWriter::content_length(
  10015. const UploadFormDataItems &items) const {
  10016. return detail::get_multipart_content_length(items, boundary_);
  10017. }
  10018. inline std::string
  10019. MultipartFormDataWriter::item_begin(const UploadFormData &item) const {
  10020. return detail::serialize_multipart_formdata_item_begin(item, boundary_);
  10021. }
  10022. inline std::string MultipartFormDataWriter::item_end() {
  10023. return detail::serialize_multipart_formdata_item_end();
  10024. }
  10025. inline std::string MultipartFormDataWriter::finish() const {
  10026. return detail::serialize_multipart_formdata_finish(boundary_);
  10027. }
  10028. // Response implementation
  10029. namespace detail {
  10030. // A response has one content source: `body`, a content provider, or a file.
  10031. // Each content setter calls this so that the one called last wins.
  10032. inline void clear_content_provider(Response &res) {
  10033. auto releaser = std::move(res.content_provider_resource_releaser_);
  10034. auto success = res.content_provider_success_;
  10035. res.content_length_ = 0;
  10036. res.content_provider_ = nullptr;
  10037. res.content_provider_resource_releaser_ = nullptr;
  10038. res.is_chunked_content_provider_ = false;
  10039. res.is_file_content_provider_ = false;
  10040. res.content_provider_success_ = false;
  10041. res.content_coding_ = EncodingType::None;
  10042. res.file_content_path_.clear();
  10043. res.file_content_content_type_.clear();
  10044. if (releaser) { releaser(success); }
  10045. }
  10046. inline void clear_content(Response &res) {
  10047. res.body.clear();
  10048. clear_content_provider(res);
  10049. }
  10050. // `body` is public, so it can be assigned directly after a provider or a file
  10051. // was set. It came last, so it wins.
  10052. inline void prefer_assigned_body(Response &res) {
  10053. if (!res.body.empty() &&
  10054. (res.content_provider_ || !res.file_content_path_.empty())) {
  10055. clear_content_provider(res);
  10056. }
  10057. }
  10058. } // namespace detail
  10059. inline size_t Response::get_header_value_u64(const std::string &key, size_t def,
  10060. size_t id) const {
  10061. return detail::get_header_value_u64(headers, key, def, id);
  10062. }
  10063. inline bool Response::has_header(const std::string &key) const {
  10064. return headers.find(key) != headers.end();
  10065. }
  10066. inline std::string Response::get_header_value(const std::string &key,
  10067. const char *def,
  10068. size_t id) const {
  10069. return detail::get_header_value(headers, key, def, id);
  10070. }
  10071. inline size_t Response::get_header_value_count(const std::string &key) const {
  10072. return detail::get_header_value_count(headers, key);
  10073. }
  10074. inline void Response::set_header(const std::string &key,
  10075. const std::string &val) {
  10076. detail::set_header(headers, key, val);
  10077. }
  10078. inline bool Response::has_trailer(const std::string &key) const {
  10079. return trailers.find(key) != trailers.end();
  10080. }
  10081. inline std::string Response::get_trailer_value(const std::string &key,
  10082. size_t id) const {
  10083. return detail::get_multimap_value(trailers, key, id);
  10084. }
  10085. inline size_t Response::get_trailer_value_count(const std::string &key) const {
  10086. return trailers.count(key);
  10087. }
  10088. inline void Response::set_redirect(const std::string &url, int stat) {
  10089. if (detail::fields::is_field_value(url)) {
  10090. set_header("Location", url);
  10091. if (300 <= stat && stat < 400) {
  10092. this->status = stat;
  10093. } else {
  10094. this->status = StatusCode::Found_302;
  10095. }
  10096. }
  10097. }
  10098. inline void Response::set_content(const char *s, size_t n,
  10099. const std::string &content_type) {
  10100. body.assign(s, n); // Before the releaser runs; it may own `s`.
  10101. detail::clear_content_provider(*this);
  10102. auto rng = headers.equal_range("Content-Type");
  10103. headers.erase(rng.first, rng.second);
  10104. set_header("Content-Type", content_type);
  10105. }
  10106. inline void Response::set_content(const std::string &s,
  10107. const std::string &content_type) {
  10108. set_content(s.data(), s.size(), content_type);
  10109. }
  10110. inline void Response::set_content(std::string &&s,
  10111. const std::string &content_type) {
  10112. body = std::move(s);
  10113. detail::clear_content_provider(*this);
  10114. auto rng = headers.equal_range("Content-Type");
  10115. headers.erase(rng.first, rng.second);
  10116. set_header("Content-Type", content_type);
  10117. }
  10118. inline void Response::set_content_provider(
  10119. size_t in_length, const std::string &content_type, ContentProvider provider,
  10120. ContentProviderResourceReleaser resource_releaser) {
  10121. detail::clear_content(*this);
  10122. set_header("Content-Type", content_type);
  10123. content_length_ = in_length;
  10124. if (in_length > 0) { content_provider_ = std::move(provider); }
  10125. content_provider_resource_releaser_ = std::move(resource_releaser);
  10126. }
  10127. inline void Response::set_content_provider(
  10128. const std::string &content_type, ContentProviderWithoutLength provider,
  10129. ContentProviderResourceReleaser resource_releaser) {
  10130. detail::clear_content(*this);
  10131. set_header("Content-Type", content_type);
  10132. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  10133. content_provider_resource_releaser_ = std::move(resource_releaser);
  10134. }
  10135. inline void Response::set_chunked_content_provider(
  10136. const std::string &content_type, ContentProviderWithoutLength provider,
  10137. ContentProviderResourceReleaser resource_releaser) {
  10138. set_content_provider(content_type, std::move(provider),
  10139. std::move(resource_releaser));
  10140. is_chunked_content_provider_ = true;
  10141. }
  10142. inline void Response::set_file_content(const std::string &path,
  10143. const std::string &content_type) {
  10144. detail::clear_content(*this);
  10145. file_content_path_ = path;
  10146. file_content_content_type_ = content_type;
  10147. }
  10148. inline void Response::set_file_content(const std::string &path) {
  10149. set_file_content(path, std::string());
  10150. }
  10151. // Result implementation
  10152. inline size_t Result::get_request_header_value_u64(const std::string &key,
  10153. size_t def,
  10154. size_t id) const {
  10155. return detail::get_header_value_u64(request_headers_, key, def, id);
  10156. }
  10157. inline bool Result::has_request_header(const std::string &key) const {
  10158. return request_headers_.find(key) != request_headers_.end();
  10159. }
  10160. inline std::string Result::get_request_header_value(const std::string &key,
  10161. const char *def,
  10162. size_t id) const {
  10163. return detail::get_header_value(request_headers_, key, def, id);
  10164. }
  10165. inline size_t
  10166. Result::get_request_header_value_count(const std::string &key) const {
  10167. return request_headers_.count(key);
  10168. }
  10169. // Stream implementation
  10170. inline ssize_t Stream::write(const char *ptr) {
  10171. return write(ptr, strlen(ptr));
  10172. }
  10173. inline ssize_t Stream::write(const std::string &s) {
  10174. return write(s.data(), s.size());
  10175. }
  10176. // BodyReader implementation
  10177. inline ssize_t detail::BodyReader::read(char *buf, size_t len) {
  10178. if (!stream) {
  10179. last_error = Error::Connection;
  10180. return -1;
  10181. }
  10182. if (eof) { return 0; }
  10183. if (!chunked) {
  10184. // Content-Length based reading
  10185. if (has_content_length && bytes_read >= content_length) {
  10186. eof = true;
  10187. return 0;
  10188. }
  10189. auto to_read = len;
  10190. if (has_content_length) {
  10191. auto remaining = content_length - bytes_read;
  10192. to_read = (std::min)(len, remaining);
  10193. }
  10194. auto n = stream->read(buf, to_read);
  10195. if (n < 0) {
  10196. last_error = stream->get_error();
  10197. if (last_error == Error::Success) { last_error = Error::Read; }
  10198. eof = true;
  10199. return n;
  10200. }
  10201. if (n == 0) {
  10202. // Unexpected EOF before content_length
  10203. last_error = stream->get_error();
  10204. if (last_error == Error::Success) { last_error = Error::Read; }
  10205. eof = true;
  10206. return 0;
  10207. }
  10208. bytes_read += static_cast<size_t>(n);
  10209. if (has_content_length && bytes_read >= content_length) { eof = true; }
  10210. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10211. last_error = Error::ExceedMaxPayloadSize;
  10212. eof = true;
  10213. return -1;
  10214. }
  10215. return n;
  10216. }
  10217. // Chunked transfer encoding: delegate to shared decoder instance.
  10218. if (!chunked_decoder) { chunked_decoder.reset(new ChunkedDecoder(*stream)); }
  10219. size_t chunk_offset = 0;
  10220. size_t chunk_total = 0;
  10221. auto n = chunked_decoder->read_payload(buf, len, chunk_offset, chunk_total);
  10222. if (n < 0) {
  10223. last_error = stream->get_error();
  10224. if (last_error == Error::Success) { last_error = Error::Read; }
  10225. eof = true;
  10226. return n;
  10227. }
  10228. if (n == 0) {
  10229. // Final chunk observed. Leave trailer parsing to the caller (StreamHandle).
  10230. eof = true;
  10231. return 0;
  10232. }
  10233. bytes_read += static_cast<size_t>(n);
  10234. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10235. last_error = Error::ExceedMaxPayloadSize;
  10236. eof = true;
  10237. return -1;
  10238. }
  10239. return n;
  10240. }
  10241. // ThreadPool implementation
  10242. inline ThreadPool::ThreadPool(size_t n, size_t max_n, size_t mqr,
  10243. time_t idle_timeout_sec)
  10244. : base_thread_count_(n), max_queued_requests_(mqr),
  10245. idle_timeout_sec_(idle_timeout_sec), idle_thread_count_(0),
  10246. shutdown_(false) {
  10247. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10248. if (max_n != 0 && max_n < n) {
  10249. std::string msg = "max_threads must be >= base_threads";
  10250. throw std::invalid_argument(msg);
  10251. }
  10252. #endif
  10253. max_thread_count_ = max_n == 0 ? n : max_n;
  10254. threads_.reserve(base_thread_count_);
  10255. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10256. try {
  10257. #endif
  10258. for (size_t i = 0; i < base_thread_count_; i++) {
  10259. threads_.emplace_back(std::thread([this]() { worker(false); }));
  10260. }
  10261. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10262. } catch (...) {
  10263. // If thread creation fails partway (e.g., pthread_create returns EAGAIN),
  10264. // signal the workers we already spawned to exit and join them so the
  10265. // vector destructor does not see joinable threads (which would call
  10266. // std::terminate). Then rethrow so the caller learns of the failure.
  10267. {
  10268. std::unique_lock<std::mutex> lock(mutex_);
  10269. shutdown_ = true;
  10270. }
  10271. cond_.notify_all();
  10272. for (auto &t : threads_) {
  10273. if (t.joinable()) { t.join(); }
  10274. }
  10275. throw;
  10276. }
  10277. #endif
  10278. }
  10279. inline bool ThreadPool::enqueue(std::function<void()> fn) {
  10280. {
  10281. std::unique_lock<std::mutex> lock(mutex_);
  10282. if (shutdown_) { return false; }
  10283. if (max_queued_requests_ > 0 && jobs_.size() >= max_queued_requests_) {
  10284. return false;
  10285. }
  10286. jobs_.push_back(std::move(fn));
  10287. // Spawn a dynamic thread if no idle threads and under max
  10288. if (idle_thread_count_ == 0 &&
  10289. threads_.size() + dynamic_threads_.size() < max_thread_count_) {
  10290. cleanup_finished_threads();
  10291. dynamic_threads_.emplace_back(std::thread([this]() { worker(true); }));
  10292. }
  10293. }
  10294. cond_.notify_one();
  10295. return true;
  10296. }
  10297. inline void ThreadPool::shutdown() {
  10298. {
  10299. std::unique_lock<std::mutex> lock(mutex_);
  10300. shutdown_ = true;
  10301. }
  10302. cond_.notify_all();
  10303. for (auto &t : threads_) {
  10304. if (t.joinable()) { t.join(); }
  10305. }
  10306. // Move dynamic_threads_ to a local list under the lock to avoid racing
  10307. // with worker threads that call move_to_finished() concurrently.
  10308. std::list<std::thread> remaining_dynamic;
  10309. {
  10310. std::unique_lock<std::mutex> lock(mutex_);
  10311. remaining_dynamic = std::move(dynamic_threads_);
  10312. }
  10313. for (auto &t : remaining_dynamic) {
  10314. if (t.joinable()) { t.join(); }
  10315. }
  10316. std::unique_lock<std::mutex> lock(mutex_);
  10317. cleanup_finished_threads();
  10318. }
  10319. inline void ThreadPool::move_to_finished(std::thread::id id) {
  10320. // Must be called with mutex_ held
  10321. for (auto it = dynamic_threads_.begin(); it != dynamic_threads_.end(); ++it) {
  10322. if (it->get_id() == id) {
  10323. finished_threads_.push_back(std::move(*it));
  10324. dynamic_threads_.erase(it);
  10325. return;
  10326. }
  10327. }
  10328. }
  10329. inline void ThreadPool::cleanup_finished_threads() {
  10330. // Must be called with mutex_ held
  10331. for (auto &t : finished_threads_) {
  10332. if (t.joinable()) { t.join(); }
  10333. }
  10334. finished_threads_.clear();
  10335. }
  10336. inline void ThreadPool::worker(bool is_dynamic) {
  10337. for (;;) {
  10338. std::function<void()> fn;
  10339. {
  10340. std::unique_lock<std::mutex> lock(mutex_);
  10341. idle_thread_count_++;
  10342. if (is_dynamic) {
  10343. auto has_work =
  10344. cond_.wait_for(lock, std::chrono::seconds(idle_timeout_sec_),
  10345. [&] { return !jobs_.empty() || shutdown_; });
  10346. if (!has_work) {
  10347. // Timed out with no work - exit this dynamic thread
  10348. idle_thread_count_--;
  10349. move_to_finished(std::this_thread::get_id());
  10350. break;
  10351. }
  10352. } else {
  10353. cond_.wait(lock, [&] { return !jobs_.empty() || shutdown_; });
  10354. }
  10355. idle_thread_count_--;
  10356. if (shutdown_ && jobs_.empty()) { break; }
  10357. fn = std::move(jobs_.front());
  10358. jobs_.pop_front();
  10359. }
  10360. assert(true == static_cast<bool>(fn));
  10361. fn();
  10362. }
  10363. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(OPENSSL_IS_BORINGSSL) && \
  10364. !defined(LIBRESSL_VERSION_NUMBER)
  10365. OPENSSL_thread_stop();
  10366. #endif
  10367. }
  10368. /*
  10369. * Group 1 (continued): detail namespace - Stream implementations
  10370. */
  10371. namespace detail {
  10372. inline void calc_actual_timeout(time_t max_timeout_msec, time_t duration_msec,
  10373. time_t timeout_sec, time_t timeout_usec,
  10374. time_t &actual_timeout_sec,
  10375. time_t &actual_timeout_usec) {
  10376. auto timeout_msec = (timeout_sec * 1000) + (timeout_usec / 1000);
  10377. auto actual_timeout_msec =
  10378. (std::min)(max_timeout_msec - duration_msec, timeout_msec);
  10379. if (actual_timeout_msec < 0) { actual_timeout_msec = 0; }
  10380. actual_timeout_sec = actual_timeout_msec / 1000;
  10381. actual_timeout_usec = (actual_timeout_msec % 1000) * 1000;
  10382. }
  10383. // Socket stream implementation
  10384. inline SocketStream::SocketStream(
  10385. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  10386. time_t write_timeout_sec, time_t write_timeout_usec,
  10387. time_t max_timeout_msec,
  10388. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10389. : sock_(sock), read_timeout_sec_(read_timeout_sec),
  10390. read_timeout_usec_(read_timeout_usec),
  10391. write_timeout_sec_(write_timeout_sec),
  10392. write_timeout_usec_(write_timeout_usec),
  10393. max_timeout_msec_(max_timeout_msec), start_time_(start_time),
  10394. read_buff_(read_buff_size_, 0) {}
  10395. inline SocketStream::~SocketStream() = default;
  10396. inline bool SocketStream::is_readable() const {
  10397. return read_buff_off_ < read_buff_content_size_;
  10398. }
  10399. inline bool SocketStream::wait_readable() const {
  10400. if (max_timeout_msec_ <= 0) {
  10401. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10402. }
  10403. time_t read_timeout_sec;
  10404. time_t read_timeout_usec;
  10405. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10406. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10407. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  10408. }
  10409. inline bool SocketStream::wait_writable() const {
  10410. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10411. }
  10412. inline bool SocketStream::ensure_readable() {
  10413. if (readable_hint_) {
  10414. readable_hint_ = false;
  10415. return true;
  10416. }
  10417. return wait_readable();
  10418. }
  10419. inline const char *SocketStream::buffered_data(size_t &size) const {
  10420. size = read_buff_content_size_ - read_buff_off_;
  10421. return size ? read_buff_.data() + read_buff_off_ : nullptr;
  10422. }
  10423. inline void SocketStream::consume_buffered(size_t size) {
  10424. assert(size <= read_buff_content_size_ - read_buff_off_);
  10425. read_buff_off_ += size;
  10426. }
  10427. inline bool SocketStream::is_peer_alive() const {
  10428. return detail::is_socket_alive(sock_);
  10429. }
  10430. inline ssize_t SocketStream::read(char *ptr, size_t size) {
  10431. #ifdef _WIN32
  10432. size =
  10433. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10434. #else
  10435. size = (std::min)(size,
  10436. static_cast<size_t>((std::numeric_limits<ssize_t>::max)()));
  10437. #endif
  10438. if (read_buff_off_ < read_buff_content_size_) {
  10439. auto remaining_size = read_buff_content_size_ - read_buff_off_;
  10440. if (size <= remaining_size) {
  10441. memcpy(ptr, read_buff_.data() + read_buff_off_, size);
  10442. read_buff_off_ += size;
  10443. return static_cast<ssize_t>(size);
  10444. } else {
  10445. memcpy(ptr, read_buff_.data() + read_buff_off_, remaining_size);
  10446. read_buff_off_ += remaining_size;
  10447. return static_cast<ssize_t>(remaining_size);
  10448. }
  10449. }
  10450. if (!ensure_readable()) {
  10451. error_ = Error::Timeout;
  10452. return -1;
  10453. }
  10454. read_buff_off_ = 0;
  10455. read_buff_content_size_ = 0;
  10456. if (size < read_buff_size_) {
  10457. auto n = read_socket(sock_, read_buff_.data(), read_buff_size_,
  10458. CPPHTTPLIB_RECV_FLAGS);
  10459. if (n <= 0) {
  10460. if (n == 0) {
  10461. error_ = Error::ConnectionClosed;
  10462. } else {
  10463. error_ = Error::Read;
  10464. }
  10465. return n;
  10466. } else if (n <= static_cast<ssize_t>(size)) {
  10467. memcpy(ptr, read_buff_.data(), static_cast<size_t>(n));
  10468. return n;
  10469. } else {
  10470. memcpy(ptr, read_buff_.data(), size);
  10471. read_buff_off_ = size;
  10472. read_buff_content_size_ = static_cast<size_t>(n);
  10473. return static_cast<ssize_t>(size);
  10474. }
  10475. } else {
  10476. auto n = read_socket(sock_, ptr, size, CPPHTTPLIB_RECV_FLAGS);
  10477. if (n <= 0) {
  10478. if (n == 0) {
  10479. error_ = Error::ConnectionClosed;
  10480. } else {
  10481. error_ = Error::Read;
  10482. }
  10483. }
  10484. return n;
  10485. }
  10486. }
  10487. inline ssize_t SocketStream::write(const char *ptr, size_t size) {
  10488. if (!wait_writable()) { return -1; }
  10489. #if defined(_WIN32) && !defined(_WIN64)
  10490. size =
  10491. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10492. #endif
  10493. return send_socket(sock_, ptr, size, CPPHTTPLIB_SEND_FLAGS);
  10494. }
  10495. inline void SocketStream::get_remote_ip_and_port(std::string &ip,
  10496. int &port) const {
  10497. return detail::get_remote_ip_and_port(sock_, ip, port);
  10498. }
  10499. inline void SocketStream::get_local_ip_and_port(std::string &ip,
  10500. int &port) const {
  10501. return detail::get_local_ip_and_port(sock_, ip, port);
  10502. }
  10503. inline socket_t SocketStream::socket() const { return sock_; }
  10504. inline time_t SocketStream::duration() const {
  10505. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10506. std::chrono::steady_clock::now() - start_time_)
  10507. .count();
  10508. }
  10509. inline void SocketStream::set_read_timeout(time_t sec, time_t usec) {
  10510. read_timeout_sec_ = sec;
  10511. read_timeout_usec_ = usec;
  10512. }
  10513. // Buffer stream implementation
  10514. inline bool BufferStream::is_readable() const { return true; }
  10515. inline bool BufferStream::wait_readable() const { return true; }
  10516. inline bool BufferStream::wait_writable() const { return true; }
  10517. inline ssize_t BufferStream::read(char *ptr, size_t size) {
  10518. #if defined(_MSC_VER) && _MSC_VER < 1910
  10519. auto len_read = buffer._Copy_s(ptr, size, size, position);
  10520. #else
  10521. auto len_read = buffer.copy(ptr, size, position);
  10522. #endif
  10523. position += static_cast<size_t>(len_read);
  10524. return static_cast<ssize_t>(len_read);
  10525. }
  10526. inline ssize_t BufferStream::write(const char *ptr, size_t size) {
  10527. buffer.append(ptr, size);
  10528. return static_cast<ssize_t>(size);
  10529. }
  10530. inline void BufferStream::get_remote_ip_and_port(std::string & /*ip*/,
  10531. int & /*port*/) const {}
  10532. inline void BufferStream::get_local_ip_and_port(std::string & /*ip*/,
  10533. int & /*port*/) const {}
  10534. inline socket_t BufferStream::socket() const { return 0; }
  10535. inline time_t BufferStream::duration() const { return 0; }
  10536. inline const std::string &BufferStream::get_buffer() const { return buffer; }
  10537. inline PathParamsMatcher::PathParamsMatcher(const std::string &pattern)
  10538. : MatcherBase(pattern) {
  10539. constexpr const char marker[] = "/:";
  10540. // One past the last ending position of a path param substring
  10541. std::size_t last_param_end = 0;
  10542. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10543. // Needed to ensure that parameter names are unique during matcher
  10544. // construction
  10545. // If exceptions are disabled, only last duplicate path
  10546. // parameter will be set
  10547. std::unordered_set<std::string> param_name_set;
  10548. #endif
  10549. while (true) {
  10550. const auto marker_pos = pattern.find(
  10551. marker, last_param_end == 0 ? last_param_end : last_param_end - 1);
  10552. if (marker_pos == std::string::npos) { break; }
  10553. static_fragments_.push_back(
  10554. pattern.substr(last_param_end, marker_pos - last_param_end + 1));
  10555. const auto param_name_start = marker_pos + str_len(marker);
  10556. auto sep_pos = pattern.find(separator, param_name_start);
  10557. if (sep_pos == std::string::npos) { sep_pos = pattern.length(); }
  10558. auto param_name =
  10559. pattern.substr(param_name_start, sep_pos - param_name_start);
  10560. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10561. if (param_name_set.find(param_name) != param_name_set.cend()) {
  10562. std::string msg = "Encountered path parameter '" + param_name +
  10563. "' multiple times in route pattern '" + pattern + "'.";
  10564. throw std::invalid_argument(msg);
  10565. }
  10566. #endif
  10567. param_names_.push_back(std::move(param_name));
  10568. last_param_end = sep_pos + 1;
  10569. }
  10570. if (last_param_end < pattern.length()) {
  10571. static_fragments_.push_back(pattern.substr(last_param_end));
  10572. }
  10573. }
  10574. inline bool PathParamsMatcher::match(Request &request) const {
  10575. request.matches = std::smatch();
  10576. request.path_params.clear();
  10577. // A pattern without parameters is just a literal path to compare against
  10578. if (param_names_.empty()) { return request.path == pattern(); }
  10579. request.path_params.reserve(param_names_.size());
  10580. // One past the position at which the path matched the pattern last time
  10581. std::size_t starting_pos = 0;
  10582. for (size_t i = 0; i < static_fragments_.size(); ++i) {
  10583. const auto &fragment = static_fragments_[i];
  10584. if (starting_pos + fragment.length() > request.path.length()) {
  10585. return false;
  10586. }
  10587. // Avoid unnecessary allocation by using strncmp instead of substr +
  10588. // comparison
  10589. if (std::strncmp(request.path.c_str() + starting_pos, fragment.c_str(),
  10590. fragment.length()) != 0) {
  10591. return false;
  10592. }
  10593. starting_pos += fragment.length();
  10594. // Should only happen when we have a static fragment after a param
  10595. // Example: '/users/:id/subscriptions'
  10596. // The 'subscriptions' fragment here does not have a corresponding param
  10597. if (i >= param_names_.size()) { continue; }
  10598. auto sep_pos = request.path.find(separator, starting_pos);
  10599. if (sep_pos == std::string::npos) { sep_pos = request.path.length(); }
  10600. const auto &param_name = param_names_[i];
  10601. request.path_params.emplace(
  10602. param_name, request.path.substr(starting_pos, sep_pos - starting_pos));
  10603. // Mark everything up to '/' as matched
  10604. starting_pos = sep_pos + 1;
  10605. }
  10606. // Returns false if the path is longer than the pattern
  10607. return starting_pos >= request.path.length();
  10608. }
  10609. inline bool RegexMatcher::match(Request &request) const {
  10610. request.path_params.clear();
  10611. // See CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH: an overlong path is treated as
  10612. // a non-match rather than risking a stack overflow in std::regex_match.
  10613. if (request.path.length() > CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH) {
  10614. return false;
  10615. }
  10616. return std::regex_match(request.path, request.matches, regex_);
  10617. }
  10618. // Enclose IPv6 address in brackets if needed
  10619. inline std::string prepare_host_string(const std::string &host) {
  10620. // Enclose IPv6 address in brackets (but not if already enclosed)
  10621. if (host.find(':') == std::string::npos ||
  10622. (!host.empty() && host[0] == '[')) {
  10623. // IPv4, hostname, or already bracketed IPv6
  10624. return host;
  10625. } else {
  10626. // IPv6 address without brackets
  10627. return "[" + host + "]";
  10628. }
  10629. }
  10630. inline std::string make_host_and_port_string(const std::string &host, int port,
  10631. bool is_ssl) {
  10632. auto result = prepare_host_string(host);
  10633. // Append port if not default
  10634. if ((!is_ssl && port == 80) || (is_ssl && port == 443)) {
  10635. ; // do nothing
  10636. } else {
  10637. result += ":" + std::to_string(port);
  10638. }
  10639. return result;
  10640. }
  10641. // Create "host:port" string always including port number (for CONNECT method)
  10642. inline std::string
  10643. make_host_and_port_string_always_port(const std::string &host, int port) {
  10644. return prepare_host_string(host) + ":" + std::to_string(port);
  10645. }
  10646. // Value for the Host header a client sends when the caller supplied none.
  10647. // Only the value: callers decide where in their header list it goes.
  10648. inline std::string make_default_host_header_value(const std::string &host,
  10649. int port, bool is_ssl,
  10650. int address_family) {
  10651. if (address_family == AF_UNIX) { return "localhost"; }
  10652. return make_host_and_port_string(host, port, is_ssl);
  10653. }
  10654. inline void add_default_user_agent_header(Request &req) {
  10655. #ifndef CPPHTTPLIB_NO_DEFAULT_USER_AGENT
  10656. if (!req.has_header("User-Agent")) {
  10657. req.set_header("User-Agent",
  10658. std::string("cpp-httplib/") + CPPHTTPLIB_VERSION);
  10659. }
  10660. #else
  10661. (void)req;
  10662. #endif
  10663. }
  10664. bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out);
  10665. NormalizedTarget normalize_target(const std::string &host);
  10666. bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits);
  10667. bool host_matches_no_proxy(const NormalizedTarget &target,
  10668. const std::vector<NoProxyEntry> &entries);
  10669. inline bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits) {
  10670. if (prefix_bits < 0 || prefix_bits > 128) { return false; }
  10671. if (prefix_bits == 0) { return true; }
  10672. int full_bytes = prefix_bits / 8;
  10673. int rem_bits = prefix_bits % 8;
  10674. if (full_bytes > 0 && std::memcmp(ip.data(), net.data(),
  10675. static_cast<size_t>(full_bytes)) != 0) {
  10676. return false;
  10677. }
  10678. if (rem_bits == 0) { return true; }
  10679. auto i = static_cast<size_t>(full_bytes);
  10680. auto mask = static_cast<uint8_t>(0xFFu << (8 - rem_bits));
  10681. return (ip[i] & mask) == (net[i] & mask);
  10682. }
  10683. inline bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out) {
  10684. if (token.empty()) { return false; }
  10685. if (token == "*") {
  10686. out.kind = NoProxyKind::Wildcard;
  10687. return true;
  10688. }
  10689. auto slash = token.find('/');
  10690. std::string addr_part =
  10691. (slash == std::string::npos) ? token : token.substr(0, slash);
  10692. std::string prefix_part =
  10693. (slash == std::string::npos) ? std::string() : token.substr(slash + 1);
  10694. // A bare slash or trailing-slash CIDR like "10.0.0.0/" is malformed;
  10695. // don't silently treat it as a /32 (or /128).
  10696. if (slash != std::string::npos && prefix_part.empty()) { return false; }
  10697. // Accept the bracketed IPv6 form ("[::1]", "[fe80::]/10") as well as the
  10698. // bare form. Brackets have no meaning for IPv4, so skip the IPv4 attempt
  10699. // when brackets are present.
  10700. bool bracketed = addr_part.size() >= 2 && addr_part.front() == '[' &&
  10701. addr_part.back() == ']';
  10702. if (bracketed) { addr_part = addr_part.substr(1, addr_part.size() - 2); }
  10703. if (!bracketed) {
  10704. struct in_addr v4;
  10705. if (inet_pton(AF_INET, addr_part.c_str(), &v4) == 1) {
  10706. int prefix = 32;
  10707. if (!prefix_part.empty() &&
  10708. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 32,
  10709. prefix)) {
  10710. return false;
  10711. }
  10712. out.kind = NoProxyKind::IPv4Cidr;
  10713. std::memcpy(out.net.data(), &v4, sizeof(v4));
  10714. out.prefix_bits = prefix;
  10715. return true;
  10716. }
  10717. }
  10718. struct in6_addr v6;
  10719. if (inet_pton(AF_INET6, addr_part.c_str(), &v6) == 1) {
  10720. int prefix = 128;
  10721. if (!prefix_part.empty() &&
  10722. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 128,
  10723. prefix)) {
  10724. return false;
  10725. }
  10726. out.kind = NoProxyKind::IPv6Cidr;
  10727. std::memcpy(out.net.data(), &v6, sizeof(v6));
  10728. out.prefix_bits = prefix;
  10729. return true;
  10730. }
  10731. // Bracketed entries can only be IPv6. If the IPv6 parse above failed,
  10732. // the entry is malformed — don't fall through to the hostname branch.
  10733. if (bracketed) { return false; }
  10734. // A '/' on a non-IP token means a CIDR prefix without an address. Reject.
  10735. if (slash != std::string::npos) { return false; }
  10736. // Port-specific entries (host:port) are not supported.
  10737. if (token.find(':') != std::string::npos) { return false; }
  10738. std::string hostname = case_ignore::to_lower(token);
  10739. while (!hostname.empty() && hostname.front() == '.') {
  10740. hostname.erase(hostname.begin());
  10741. }
  10742. while (!hostname.empty() && hostname.back() == '.') {
  10743. hostname.pop_back();
  10744. }
  10745. if (hostname.empty()) { return false; }
  10746. out.kind = NoProxyKind::HostnameSuffix;
  10747. out.hostname_pattern = std::move(hostname);
  10748. return true;
  10749. }
  10750. inline NormalizedTarget normalize_target(const std::string &host) {
  10751. NormalizedTarget t;
  10752. std::string h = host;
  10753. if (h.size() >= 2 && h.front() == '[' && h.back() == ']') {
  10754. h = h.substr(1, h.size() - 2);
  10755. }
  10756. // Strip a single trailing dot so "example.com." canonicalizes to
  10757. // "example.com".
  10758. if (!h.empty() && h.back() == '.') { h.pop_back(); }
  10759. t.hostname = case_ignore::to_lower(h);
  10760. if (!t.hostname.empty()) {
  10761. struct in_addr v4;
  10762. struct in6_addr v6;
  10763. if (inet_pton(AF_INET, t.hostname.c_str(), &v4) == 1) {
  10764. t.is_ipv4 = true;
  10765. std::memcpy(t.ip.data(), &v4, sizeof(v4));
  10766. } else if (inet_pton(AF_INET6, t.hostname.c_str(), &v6) == 1) {
  10767. t.is_ipv6 = true;
  10768. std::memcpy(t.ip.data(), &v6, sizeof(v6));
  10769. }
  10770. }
  10771. return t;
  10772. }
  10773. inline bool host_matches_no_proxy(const NormalizedTarget &target,
  10774. const std::vector<NoProxyEntry> &entries) {
  10775. if (target.hostname.empty()) { return false; }
  10776. for (const auto &e : entries) {
  10777. switch (e.kind) {
  10778. case NoProxyKind::Wildcard: return true;
  10779. case NoProxyKind::IPv4Cidr:
  10780. if (target.is_ipv4 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  10781. return true;
  10782. }
  10783. break;
  10784. case NoProxyKind::IPv6Cidr:
  10785. if (target.is_ipv6 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  10786. return true;
  10787. }
  10788. break;
  10789. case NoProxyKind::HostnameSuffix:
  10790. if (target.is_ipv4 || target.is_ipv6) { break; }
  10791. if (target.hostname == e.hostname_pattern) { return true; }
  10792. // Dot-boundary suffix match: prevents "evilexample.com" from matching
  10793. // an entry of "example.com".
  10794. if (target.hostname.size() > e.hostname_pattern.size() + 1) {
  10795. auto offset = target.hostname.size() - e.hostname_pattern.size();
  10796. if (target.hostname[offset - 1] == '.' &&
  10797. target.hostname.compare(offset, e.hostname_pattern.size(),
  10798. e.hostname_pattern) == 0) {
  10799. return true;
  10800. }
  10801. }
  10802. break;
  10803. }
  10804. }
  10805. return false;
  10806. }
  10807. template <typename T>
  10808. inline bool check_and_write_headers(Stream &strm, Headers &headers,
  10809. T header_writer, Error &error) {
  10810. for (const auto &h : headers) {
  10811. if (!detail::fields::is_field_valid(h.first, h.second)) {
  10812. error = Error::InvalidHeaders;
  10813. return false;
  10814. }
  10815. }
  10816. if (header_writer(strm, headers) <= 0) {
  10817. error = Error::Write;
  10818. return false;
  10819. }
  10820. return true;
  10821. }
  10822. } // namespace detail
  10823. /*
  10824. * Group 2 (continued): detail namespace - SSLSocketStream implementation
  10825. */
  10826. #ifdef CPPHTTPLIB_SSL_ENABLED
  10827. namespace detail {
  10828. // SSL socket stream implementation
  10829. inline SSLSocketStream::SSLSocketStream(
  10830. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  10831. time_t read_timeout_usec, time_t write_timeout_sec,
  10832. time_t write_timeout_usec, time_t max_timeout_msec,
  10833. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10834. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  10835. read_timeout_usec_(read_timeout_usec),
  10836. write_timeout_sec_(write_timeout_sec),
  10837. write_timeout_usec_(write_timeout_usec),
  10838. max_timeout_msec_(max_timeout_msec), start_time_(start_time) {
  10839. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  10840. // Clear AUTO_RETRY for proper non-blocking I/O timeout handling
  10841. // Note: create_session() also clears this, but SSLClient currently
  10842. // uses ssl_new() which does not. Until full TLS API migration is complete,
  10843. // we need to ensure AUTO_RETRY is cleared here regardless of how the
  10844. // SSL session was created.
  10845. SSL_clear_mode(static_cast<SSL *>(session), SSL_MODE_AUTO_RETRY);
  10846. #endif
  10847. }
  10848. inline SSLSocketStream::~SSLSocketStream() = default;
  10849. inline bool SSLSocketStream::is_readable() const {
  10850. return tls::pending(session_) > 0;
  10851. }
  10852. inline bool SSLSocketStream::wait_readable() const {
  10853. if (max_timeout_msec_ <= 0) {
  10854. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10855. }
  10856. time_t read_timeout_sec;
  10857. time_t read_timeout_usec;
  10858. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10859. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10860. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  10861. }
  10862. inline bool SSLSocketStream::wait_writable() const {
  10863. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0 &&
  10864. !tls::is_peer_closed(session_, sock_);
  10865. }
  10866. inline bool SSLSocketStream::ensure_readable() {
  10867. if (readable_hint_) {
  10868. readable_hint_ = false;
  10869. return true;
  10870. }
  10871. return wait_readable();
  10872. }
  10873. inline bool SSLSocketStream::is_peer_alive() const {
  10874. return !tls::is_peer_closed(session_, sock_);
  10875. }
  10876. inline ssize_t SSLSocketStream::read(char *ptr, size_t size) {
  10877. if (tls::pending(session_) > 0) {
  10878. tls::TlsError err;
  10879. auto ret = tls::read(session_, ptr, size, err);
  10880. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10881. error_ = Error::ConnectionClosed;
  10882. }
  10883. return ret;
  10884. } else if (ensure_readable()) {
  10885. tls::TlsError err;
  10886. auto ret = tls::read(session_, ptr, size, err);
  10887. if (ret < 0) {
  10888. auto n = 1000;
  10889. #ifdef _WIN32
  10890. while (--n >= 0 && (err.code == tls::ErrorCode::WantRead ||
  10891. (err.code == tls::ErrorCode::SyscallError &&
  10892. WSAGetLastError() == WSAETIMEDOUT))) {
  10893. #else
  10894. while (--n >= 0 && err.code == tls::ErrorCode::WantRead) {
  10895. #endif
  10896. if (tls::pending(session_) > 0) {
  10897. return tls::read(session_, ptr, size, err);
  10898. } else if (wait_readable()) {
  10899. std::this_thread::sleep_for(std::chrono::microseconds{10});
  10900. ret = tls::read(session_, ptr, size, err);
  10901. if (ret >= 0) { return ret; }
  10902. } else {
  10903. break;
  10904. }
  10905. }
  10906. assert(ret < 0);
  10907. } else if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10908. error_ = Error::ConnectionClosed;
  10909. }
  10910. return ret;
  10911. } else {
  10912. error_ = Error::Timeout;
  10913. return -1;
  10914. }
  10915. }
  10916. inline ssize_t SSLSocketStream::write(const char *ptr, size_t size) {
  10917. if (wait_writable()) {
  10918. auto handle_size =
  10919. std::min<size_t>(size, (std::numeric_limits<int>::max)());
  10920. tls::TlsError err;
  10921. auto ret = tls::write(session_, ptr, handle_size, err);
  10922. if (ret < 0) {
  10923. auto n = 1000;
  10924. #ifdef _WIN32
  10925. while (--n >= 0 && (err.code == tls::ErrorCode::WantWrite ||
  10926. (err.code == tls::ErrorCode::SyscallError &&
  10927. WSAGetLastError() == WSAETIMEDOUT))) {
  10928. #else
  10929. while (--n >= 0 && err.code == tls::ErrorCode::WantWrite) {
  10930. #endif
  10931. if (wait_writable()) {
  10932. std::this_thread::sleep_for(std::chrono::microseconds{10});
  10933. ret = tls::write(session_, ptr, handle_size, err);
  10934. if (ret >= 0) { return ret; }
  10935. } else {
  10936. break;
  10937. }
  10938. }
  10939. assert(ret < 0);
  10940. }
  10941. return ret;
  10942. }
  10943. return -1;
  10944. }
  10945. inline void SSLSocketStream::get_remote_ip_and_port(std::string &ip,
  10946. int &port) const {
  10947. detail::get_remote_ip_and_port(sock_, ip, port);
  10948. }
  10949. inline void SSLSocketStream::get_local_ip_and_port(std::string &ip,
  10950. int &port) const {
  10951. detail::get_local_ip_and_port(sock_, ip, port);
  10952. }
  10953. inline socket_t SSLSocketStream::socket() const { return sock_; }
  10954. inline time_t SSLSocketStream::duration() const {
  10955. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10956. std::chrono::steady_clock::now() - start_time_)
  10957. .count();
  10958. }
  10959. inline void SSLSocketStream::set_read_timeout(time_t sec, time_t usec) {
  10960. read_timeout_sec_ = sec;
  10961. read_timeout_usec_ = usec;
  10962. }
  10963. inline WebSocketSSLStream::WebSocketSSLStream(socket_t sock,
  10964. tls::session_t session,
  10965. time_t read_timeout_sec,
  10966. time_t read_timeout_usec,
  10967. time_t write_timeout_sec,
  10968. time_t write_timeout_usec)
  10969. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  10970. read_timeout_usec_(read_timeout_usec),
  10971. write_timeout_sec_(write_timeout_sec),
  10972. write_timeout_usec_(write_timeout_usec),
  10973. start_time_(std::chrono::steady_clock::now()) {
  10974. // The receive and send paths run on different threads, so each TLS call is
  10975. // driven in non-blocking mode and readiness is awaited with select()
  10976. // outside the session lock. Set the socket non-blocking once here; it is
  10977. // never flipped back, so no thread races on the flag.
  10978. detail::set_nonblocking(sock_, true);
  10979. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  10980. SSL_clear_mode(static_cast<SSL *>(session_), SSL_MODE_AUTO_RETRY);
  10981. #endif
  10982. }
  10983. inline WebSocketSSLStream::~WebSocketSSLStream() = default;
  10984. inline bool WebSocketSSLStream::is_readable() const {
  10985. std::lock_guard<std::mutex> guard(session_mutex_);
  10986. return tls::pending(session_) > 0;
  10987. }
  10988. inline bool WebSocketSSLStream::wait_readable() const {
  10989. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10990. }
  10991. inline bool WebSocketSSLStream::wait_writable() const {
  10992. // Unlike SSLSocketStream, this deliberately does not call is_peer_closed():
  10993. // that probe toggles the socket's blocking flag, which would race with the
  10994. // concurrent reader on a permanently non-blocking socket.
  10995. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10996. }
  10997. inline ssize_t WebSocketSSLStream::read(char *ptr, size_t size) {
  10998. tls::TlsError err;
  10999. auto n = 1000;
  11000. while (--n >= 0) {
  11001. {
  11002. std::lock_guard<std::mutex> guard(session_mutex_);
  11003. auto ret = tls::read(session_, ptr, size, err);
  11004. if (ret > 0) { return ret; }
  11005. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11006. error_ = Error::ConnectionClosed;
  11007. return ret;
  11008. }
  11009. }
  11010. // ret < 0. On a non-blocking socket a TLS read can stop needing either
  11011. // direction: the send path shares this session, so output it left pending
  11012. // has to be flushed before more input can be decrypted. Anything else is
  11013. // a hard error.
  11014. auto needs_readable = err.code == tls::ErrorCode::WantRead;
  11015. #ifdef _WIN32
  11016. // On Windows a socket timeout surfaces as a syscall error, not WantRead.
  11017. needs_readable =
  11018. needs_readable || (err.code == tls::ErrorCode::SyscallError &&
  11019. WSAGetLastError() == WSAETIMEDOUT);
  11020. #endif
  11021. if (!needs_readable && err.code != tls::ErrorCode::WantWrite) {
  11022. error_ = Error::Read;
  11023. return -1;
  11024. }
  11025. if (!(needs_readable ? wait_readable() : wait_writable())) {
  11026. error_ = Error::Timeout;
  11027. return -1;
  11028. }
  11029. }
  11030. // Out of retries. Recording a reason matters: a caller that reads get_error()
  11031. // to tell a timeout from a close would otherwise see whatever the previous
  11032. // failure left behind (error_ is never cleared on success).
  11033. error_ = Error::Read;
  11034. return -1;
  11035. }
  11036. inline ssize_t WebSocketSSLStream::write(const char *ptr, size_t size) {
  11037. auto handle_size = std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11038. tls::TlsError err;
  11039. auto n = 1000;
  11040. while (--n >= 0) {
  11041. {
  11042. std::lock_guard<std::mutex> guard(session_mutex_);
  11043. auto ret = tls::write(session_, ptr, handle_size, err);
  11044. if (ret >= 0) { return ret; }
  11045. }
  11046. // ret < 0. As in read(), either direction can be needed: a renegotiation
  11047. // or a post-handshake message must be consumed before the record goes
  11048. // out. Anything else is a hard error.
  11049. auto needs_writable = err.code == tls::ErrorCode::WantWrite;
  11050. #ifdef _WIN32
  11051. // On Windows a socket timeout surfaces as a syscall error, not WantWrite.
  11052. needs_writable =
  11053. needs_writable || (err.code == tls::ErrorCode::SyscallError &&
  11054. WSAGetLastError() == WSAETIMEDOUT);
  11055. #endif
  11056. if (!needs_writable && err.code != tls::ErrorCode::WantRead) { return -1; }
  11057. if (!(needs_writable ? wait_writable() : wait_readable())) { return -1; }
  11058. }
  11059. return -1;
  11060. }
  11061. inline void WebSocketSSLStream::get_remote_ip_and_port(std::string &ip,
  11062. int &port) const {
  11063. detail::get_remote_ip_and_port(sock_, ip, port);
  11064. }
  11065. inline void WebSocketSSLStream::get_local_ip_and_port(std::string &ip,
  11066. int &port) const {
  11067. detail::get_local_ip_and_port(sock_, ip, port);
  11068. }
  11069. inline socket_t WebSocketSSLStream::socket() const { return sock_; }
  11070. inline time_t WebSocketSSLStream::duration() const {
  11071. return std::chrono::duration_cast<std::chrono::milliseconds>(
  11072. std::chrono::steady_clock::now() - start_time_)
  11073. .count();
  11074. }
  11075. inline void WebSocketSSLStream::set_read_timeout(time_t sec, time_t usec) {
  11076. read_timeout_sec_ = sec;
  11077. read_timeout_usec_ = usec;
  11078. }
  11079. } // namespace detail
  11080. #endif // CPPHTTPLIB_SSL_ENABLED
  11081. /*
  11082. * Group 4: Server implementation
  11083. */
  11084. // HTTP server implementation
  11085. inline Server::Server()
  11086. : new_task_queue([] {
  11087. return new ThreadPool(CPPHTTPLIB_THREAD_POOL_COUNT,
  11088. CPPHTTPLIB_THREAD_POOL_MAX_COUNT);
  11089. }) {
  11090. #ifndef _WIN32
  11091. signal(SIGPIPE, SIG_IGN);
  11092. #endif
  11093. }
  11094. inline Server::~Server() = default;
  11095. inline std::unique_ptr<detail::MatcherBase>
  11096. Server::make_matcher(const std::string &pattern) {
  11097. // Path params take precedence, so "/users/:id/(.*)" keeps being matched as
  11098. // a path params pattern
  11099. if (pattern.find("/:") != std::string::npos) {
  11100. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11101. }
  11102. // A pattern with no regex metacharacter only has to be compared literally,
  11103. // which is what PathParamsMatcher already does when it captures no
  11104. // parameter, so std::regex is only worth building for the patterns that
  11105. // actually need it
  11106. if (pattern.find_first_of(".^$|()[]{}*+?\\") == std::string::npos) {
  11107. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11108. }
  11109. return detail::make_unique<detail::RegexMatcher>(pattern);
  11110. }
  11111. inline Server &Server::Get(const std::string &pattern, Handler handler) {
  11112. return add_handler(get_handlers_, pattern, std::move(handler));
  11113. }
  11114. inline Server &Server::Post(const std::string &pattern, Handler handler) {
  11115. return add_handler(post_handlers_, pattern, std::move(handler));
  11116. }
  11117. inline Server &Server::Post(const std::string &pattern,
  11118. HandlerWithContentReader handler) {
  11119. return add_handler(post_handlers_for_content_reader_, pattern,
  11120. std::move(handler));
  11121. }
  11122. inline Server &Server::Put(const std::string &pattern, Handler handler) {
  11123. return add_handler(put_handlers_, pattern, std::move(handler));
  11124. }
  11125. inline Server &Server::Put(const std::string &pattern,
  11126. HandlerWithContentReader handler) {
  11127. return add_handler(put_handlers_for_content_reader_, pattern,
  11128. std::move(handler));
  11129. }
  11130. inline Server &Server::Patch(const std::string &pattern, Handler handler) {
  11131. return add_handler(patch_handlers_, pattern, std::move(handler));
  11132. }
  11133. inline Server &Server::Patch(const std::string &pattern,
  11134. HandlerWithContentReader handler) {
  11135. return add_handler(patch_handlers_for_content_reader_, pattern,
  11136. std::move(handler));
  11137. }
  11138. inline Server &Server::Delete(const std::string &pattern, Handler handler) {
  11139. return add_handler(delete_handlers_, pattern, std::move(handler));
  11140. }
  11141. inline Server &Server::Delete(const std::string &pattern,
  11142. HandlerWithContentReader handler) {
  11143. return add_handler(delete_handlers_for_content_reader_, pattern,
  11144. std::move(handler));
  11145. }
  11146. inline Server &Server::Options(const std::string &pattern, Handler handler) {
  11147. return add_handler(options_handlers_, pattern, std::move(handler));
  11148. }
  11149. inline const std::set<std::string> &Server::builtin_methods() {
  11150. thread_local const std::set<std::string> methods{
  11151. "GET", "HEAD", "POST", "PUT", "DELETE",
  11152. "CONNECT", "OPTIONS", "TRACE", "PATCH", "PRI"};
  11153. return methods;
  11154. }
  11155. inline Server::CustomHandlerEntry *
  11156. Server::custom_entry_for_registration(const std::string &method) {
  11157. // Built-in methods are refused for two different reasons. GET, HEAD, POST,
  11158. // PUT, DELETE, OPTIONS and PATCH are dispatched by the if/else chain in
  11159. // routing() before the custom tables are consulted, so a route registered
  11160. // for one of them could never fire. CONNECT, TRACE and PRI have no branch
  11161. // there and would be reachable, but they carry protocol-level meaning
  11162. // (tunnel setup, request echo, the HTTP/2 connection preface) that this
  11163. // library does not route.
  11164. if (!detail::fields::is_token(method) || builtin_methods().count(method)) {
  11165. output_error_log(Error::InvalidHTTPMethod, nullptr);
  11166. has_invalid_registration_ = true;
  11167. return nullptr;
  11168. }
  11169. return &custom_handlers_[method];
  11170. }
  11171. inline Server &Server::CustomRoute(const std::string &method,
  11172. const std::string &pattern,
  11173. Handler handler) {
  11174. auto *entry = custom_entry_for_registration(method);
  11175. if (!entry) { return *this; }
  11176. return add_handler(entry->handlers, pattern, std::move(handler));
  11177. }
  11178. inline Server &Server::CustomRoute(const std::string &method,
  11179. const std::string &pattern,
  11180. HandlerWithContentReader handler) {
  11181. auto *entry = custom_entry_for_registration(method);
  11182. if (!entry) { return *this; }
  11183. return add_handler(entry->handlers_for_content_reader, pattern,
  11184. std::move(handler));
  11185. }
  11186. inline const Server::CustomHandlerEntry *
  11187. Server::find_custom_entry(const std::string &method) const {
  11188. // find() alone would be correct here. The empty() check is what keeps the
  11189. // per-request cost off servers that never call CustomRoute(), which is the
  11190. // overwhelmingly common case; keep it rather than walking into the tree.
  11191. if (custom_handlers_.empty()) { return nullptr; }
  11192. auto it = custom_handlers_.find(method);
  11193. return it == custom_handlers_.end() ? nullptr : &it->second;
  11194. }
  11195. inline Server &Server::WebSocket(const std::string &pattern,
  11196. WebSocketHandler handler) {
  11197. websocket_handlers_.push_back(
  11198. {make_matcher(pattern), std::move(handler), nullptr});
  11199. return *this;
  11200. }
  11201. inline Server &Server::WebSocket(const std::string &pattern,
  11202. WebSocketHandler handler,
  11203. SubProtocolSelector sub_protocol_selector) {
  11204. websocket_handlers_.push_back({make_matcher(pattern), std::move(handler),
  11205. std::move(sub_protocol_selector)});
  11206. return *this;
  11207. }
  11208. inline bool Server::set_base_dir(const std::string &dir,
  11209. const std::string &mount_point) {
  11210. return set_mount_point(mount_point, dir);
  11211. }
  11212. inline bool Server::set_mount_point(const std::string &mount_point,
  11213. const std::string &dir, Headers headers) {
  11214. detail::FileStat stat(dir);
  11215. if (stat.is_dir()) {
  11216. std::string mnt = !mount_point.empty() ? mount_point : "/";
  11217. if (!mnt.empty() && mnt[0] == '/') {
  11218. std::string resolved_base;
  11219. if (detail::canonicalize_path(dir.c_str(), resolved_base)) {
  11220. #if defined(_WIN32)
  11221. if (resolved_base.back() != '\\' && resolved_base.back() != '/') {
  11222. resolved_base += '\\';
  11223. }
  11224. #else
  11225. if (resolved_base.back() != '/') { resolved_base += '/'; }
  11226. #endif
  11227. }
  11228. base_dirs_.push_back(
  11229. {std::move(mnt), dir, std::move(resolved_base), std::move(headers)});
  11230. return true;
  11231. }
  11232. }
  11233. return false;
  11234. }
  11235. inline bool Server::remove_mount_point(const std::string &mount_point) {
  11236. for (auto it = base_dirs_.begin(); it != base_dirs_.end(); ++it) {
  11237. if (it->mount_point == mount_point) {
  11238. base_dirs_.erase(it);
  11239. return true;
  11240. }
  11241. }
  11242. return false;
  11243. }
  11244. inline Server &
  11245. Server::set_file_extension_and_mimetype_mapping(const std::string &ext,
  11246. const std::string &mime) {
  11247. file_extension_and_mimetype_map_[ext] = mime;
  11248. return *this;
  11249. }
  11250. inline Server &Server::set_default_file_mimetype(const std::string &mime) {
  11251. default_file_mimetype_ = mime;
  11252. return *this;
  11253. }
  11254. inline Server &Server::set_file_request_handler(Handler handler) {
  11255. file_request_handler_ = std::move(handler);
  11256. return *this;
  11257. }
  11258. inline Server &Server::set_error_handler_core(HandlerWithResponse handler,
  11259. std::true_type) {
  11260. error_handler_ = std::move(handler);
  11261. return *this;
  11262. }
  11263. inline Server &Server::set_error_handler_core(Handler handler,
  11264. std::false_type) {
  11265. error_handler_ = [handler](const Request &req, Response &res) {
  11266. handler(req, res);
  11267. return HandlerResponse::Handled;
  11268. };
  11269. return *this;
  11270. }
  11271. inline Server &Server::set_exception_handler(ExceptionHandler handler) {
  11272. exception_handler_ = std::move(handler);
  11273. return *this;
  11274. }
  11275. inline Server &Server::set_pre_routing_handler(HandlerWithResponse handler) {
  11276. pre_routing_handler_ = std::move(handler);
  11277. return *this;
  11278. }
  11279. inline Server &Server::set_post_routing_handler(Handler handler) {
  11280. post_routing_handler_ = std::move(handler);
  11281. return *this;
  11282. }
  11283. inline Server &Server::set_pre_request_handler(HandlerWithResponse handler) {
  11284. pre_request_handler_ = std::move(handler);
  11285. return *this;
  11286. }
  11287. inline Server &Server::set_logger(Logger logger) {
  11288. logger_ = std::move(logger);
  11289. return *this;
  11290. }
  11291. inline Server &Server::set_error_logger(ErrorLogger error_logger) {
  11292. error_logger_ = std::move(error_logger);
  11293. return *this;
  11294. }
  11295. inline Server &Server::set_pre_compression_logger(Logger logger) {
  11296. pre_compression_logger_ = std::move(logger);
  11297. return *this;
  11298. }
  11299. inline Server &
  11300. Server::set_expect_100_continue_handler(Expect100ContinueHandler handler) {
  11301. expect_100_continue_handler_ = std::move(handler);
  11302. return *this;
  11303. }
  11304. inline Server &Server::set_start_handler(StartHandler handler) {
  11305. start_handler_ = std::move(handler);
  11306. return *this;
  11307. }
  11308. inline Server &Server::set_address_family(int family) {
  11309. address_family_ = family;
  11310. return *this;
  11311. }
  11312. inline Server &Server::set_tcp_nodelay(bool on) {
  11313. tcp_nodelay_ = on;
  11314. return *this;
  11315. }
  11316. inline Server &Server::set_ipv6_v6only(bool on) {
  11317. ipv6_v6only_ = on;
  11318. return *this;
  11319. }
  11320. inline Server &Server::set_socket_options(SocketOptions socket_options) {
  11321. socket_options_ = std::move(socket_options);
  11322. return *this;
  11323. }
  11324. inline Server &Server::set_default_headers(Headers headers) {
  11325. default_headers_ = std::move(headers);
  11326. return *this;
  11327. }
  11328. inline Server &Server::set_header_writer(
  11329. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  11330. header_writer_ = writer;
  11331. return *this;
  11332. }
  11333. inline Server &
  11334. Server::set_trusted_proxies(const std::vector<std::string> &proxies) {
  11335. trusted_proxies_ = proxies;
  11336. return *this;
  11337. }
  11338. inline Server &Server::set_keep_alive_max_count(size_t count) {
  11339. keep_alive_max_count_ = count;
  11340. return *this;
  11341. }
  11342. inline Server &Server::set_keep_alive_timeout(time_t sec) {
  11343. keep_alive_timeout_sec_ = sec;
  11344. return *this;
  11345. }
  11346. template <class Rep, class Period>
  11347. inline Server &Server::set_keep_alive_timeout(
  11348. const std::chrono::duration<Rep, Period> &duration) {
  11349. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11350. set_keep_alive_timeout(sec);
  11351. });
  11352. return *this;
  11353. }
  11354. inline Server &Server::set_read_timeout(time_t sec, time_t usec) {
  11355. read_timeout_sec_ = sec;
  11356. read_timeout_usec_ = usec;
  11357. return *this;
  11358. }
  11359. inline Server &Server::set_write_timeout(time_t sec, time_t usec) {
  11360. write_timeout_sec_ = sec;
  11361. write_timeout_usec_ = usec;
  11362. return *this;
  11363. }
  11364. inline Server &Server::set_idle_interval(time_t sec, time_t usec) {
  11365. idle_interval_sec_ = sec;
  11366. idle_interval_usec_ = usec;
  11367. return *this;
  11368. }
  11369. inline Server &Server::set_payload_max_length(size_t length) {
  11370. payload_max_length_ = length;
  11371. return *this;
  11372. }
  11373. inline Server &Server::set_static_file_compression(bool on) {
  11374. static_file_compression_ = on;
  11375. return *this;
  11376. }
  11377. inline Server &Server::set_static_file_compression_min_length(size_t length) {
  11378. static_file_compression_min_length_ = length;
  11379. return *this;
  11380. }
  11381. inline Server &Server::set_static_file_compression_max_length(size_t length) {
  11382. static_file_compression_max_length_ = length;
  11383. return *this;
  11384. }
  11385. inline Server &Server::set_websocket_max_missed_pongs(int count) {
  11386. websocket_max_missed_pongs_ = count;
  11387. return *this;
  11388. }
  11389. inline Server &Server::set_websocket_ping_interval(time_t sec) {
  11390. websocket_ping_interval_sec_ = sec;
  11391. return *this;
  11392. }
  11393. template <class Rep, class Period>
  11394. inline Server &Server::set_websocket_ping_interval(
  11395. const std::chrono::duration<Rep, Period> &duration) {
  11396. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11397. set_websocket_ping_interval(sec);
  11398. });
  11399. return *this;
  11400. }
  11401. inline bool Server::bind_to_port(const std::string &host, int port,
  11402. int socket_flags) {
  11403. auto ret = bind_internal(host, port, socket_flags);
  11404. if (ret == -1) { is_decommissioned = true; }
  11405. return ret >= 0;
  11406. }
  11407. inline int Server::bind_to_any_port(const std::string &host, int socket_flags) {
  11408. auto ret = bind_internal(host, 0, socket_flags);
  11409. if (ret == -1) { is_decommissioned = true; }
  11410. return ret;
  11411. }
  11412. inline bool Server::listen_after_bind() { return listen_internal(); }
  11413. inline bool Server::listen(const std::string &host, int port,
  11414. int socket_flags) {
  11415. return bind_to_port(host, port, socket_flags) && listen_internal();
  11416. }
  11417. inline bool Server::is_running() const { return is_running_; }
  11418. inline void Server::wait_until_ready() const {
  11419. while (!is_running_ && !is_decommissioned) {
  11420. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  11421. }
  11422. }
  11423. inline void Server::stop() noexcept {
  11424. // Release the listening socket whether or not the accept loop is running:
  11425. // bind_to_port() without listen_after_bind() still owns the descriptor. The
  11426. // exchange is what makes this safe to call concurrently with the accept loop.
  11427. socket_t sock = svr_sock_.exchange(INVALID_SOCKET);
  11428. if (sock != INVALID_SOCKET) {
  11429. detail::shutdown_socket(sock);
  11430. detail::close_socket(sock);
  11431. }
  11432. is_decommissioned = false;
  11433. }
  11434. inline void Server::decommission() { is_decommissioned = true; }
  11435. inline bool Server::parse_request_line(const char *s, Request &req) const {
  11436. auto len = strlen(s);
  11437. if (len < 2 || s[len - 2] != '\r' || s[len - 1] != '\n') { return false; }
  11438. len -= 2;
  11439. {
  11440. size_t count = 0;
  11441. detail::split(s, s + len, ' ', [&](const char *b, const char *e) {
  11442. switch (count) {
  11443. case 0: req.method = std::string(b, e); break;
  11444. case 1: req.target = std::string(b, e); break;
  11445. case 2: req.version = std::string(b, e); break;
  11446. default: break;
  11447. }
  11448. count++;
  11449. });
  11450. if (count != 3) { return false; }
  11451. }
  11452. // A method outside the built-in set is accepted only when a handler has been
  11453. // registered for it with CustomRoute().
  11454. const auto &methods = builtin_methods();
  11455. if (methods.find(req.method) == methods.end() &&
  11456. !find_custom_entry(req.method)) {
  11457. output_error_log(Error::InvalidHTTPMethod, &req);
  11458. return false;
  11459. }
  11460. if (req.version != "HTTP/1.1" && req.version != "HTTP/1.0") {
  11461. output_error_log(Error::InvalidHTTPVersion, &req);
  11462. return false;
  11463. }
  11464. if (!detail::fields::is_request_target(req.target)) { return false; }
  11465. {
  11466. // Skip URL fragment
  11467. for (size_t i = 0; i < req.target.size(); i++) {
  11468. if (req.target[i] == '#') {
  11469. req.target.erase(i);
  11470. break;
  11471. }
  11472. }
  11473. detail::divide(req.target, '?',
  11474. [&](const char *lhs_data, std::size_t lhs_size,
  11475. const char *rhs_data, std::size_t rhs_size) {
  11476. req.path =
  11477. decode_path_component(std::string(lhs_data, lhs_size));
  11478. detail::parse_query_text(rhs_data, rhs_size, req.params);
  11479. });
  11480. }
  11481. return true;
  11482. }
  11483. inline bool Server::write_response(Stream &strm, bool close_connection,
  11484. Request &req, Response &res) {
  11485. // NOTE: `req.ranges` should be empty, otherwise it will be applied
  11486. // incorrectly to the error content.
  11487. req.ranges.clear();
  11488. return write_response_core(strm, close_connection, req, res, false);
  11489. }
  11490. inline bool Server::write_response_with_content(Stream &strm,
  11491. bool close_connection,
  11492. const Request &req,
  11493. Response &res) {
  11494. return write_response_core(strm, close_connection, req, res, true);
  11495. }
  11496. inline bool Server::write_response_core(Stream &strm, bool close_connection,
  11497. const Request &req, Response &res,
  11498. bool need_apply_ranges) {
  11499. assert(res.status != -1);
  11500. if (400 <= res.status && error_handler_ &&
  11501. error_handler_(req, res) == HandlerResponse::Handled) {
  11502. need_apply_ranges = true;
  11503. }
  11504. detail::prefer_assigned_body(res);
  11505. std::string content_type;
  11506. std::string boundary;
  11507. if (need_apply_ranges) { apply_ranges(req, res, content_type, boundary); }
  11508. // Prepare additional headers
  11509. if (close_connection ||
  11510. detail::has_header_token(req.headers, "Connection", "close") ||
  11511. 400 <= res.status || // Don't leave connections open after errors
  11512. // The client withholds the body until `100 Continue`, which was never
  11513. // sent, so whether and when the body follows is unknown.
  11514. (req.expect_100_continue_pending_ && detail::has_framed_body(req)) ||
  11515. // The body was left partway, e.g. by a content receiver that returned
  11516. // false, so the rest of it cannot be told from the next request.
  11517. (req.body_read_started_ && !req.body_consumed_)) {
  11518. res.set_header("Connection", "close");
  11519. } else {
  11520. std::string s = "timeout=";
  11521. s += std::to_string(keep_alive_timeout_sec_);
  11522. s += ", max=";
  11523. s += std::to_string(keep_alive_max_count_);
  11524. res.set_header("Keep-Alive", s);
  11525. }
  11526. if ((!res.body.empty() || res.content_length_ > 0 || res.content_provider_) &&
  11527. !res.has_header("Content-Type")) {
  11528. res.set_header("Content-Type", "text/plain");
  11529. }
  11530. if (res.body.empty() && !res.content_length_ && !res.content_provider_ &&
  11531. !res.has_header("Content-Length")) {
  11532. res.set_header("Content-Length", "0");
  11533. }
  11534. if (req.method == "HEAD" && !res.has_header("Accept-Ranges")) {
  11535. res.set_header("Accept-Ranges", "bytes");
  11536. }
  11537. if (post_routing_handler_) { post_routing_handler_(req, res); }
  11538. // Response line and headers
  11539. detail::BufferStream bstrm;
  11540. if (!detail::write_response_line(bstrm, res.status)) { return false; }
  11541. if (header_writer_(bstrm, res.headers) <= 0) { return false; }
  11542. // Combine a small body with the headers so the whole response leaves in a
  11543. // single write. A large body is written on its own instead: a copy of it
  11544. // costs more than the extra write saves.
  11545. auto send_body = req.method != "HEAD";
  11546. auto body_is_separate = false;
  11547. auto provider_done = false;
  11548. if (send_body && !res.body.empty() && !res.content_provider_) {
  11549. if (res.body.size() < CPPHTTPLIB_SEND_BUFSIZ) {
  11550. bstrm.write(res.body.data(), res.body.size());
  11551. } else {
  11552. body_is_separate = true;
  11553. }
  11554. } else if (send_body && res.content_provider_ &&
  11555. res.is_file_content_provider_ &&
  11556. res.content_length_ < CPPHTTPLIB_SEND_BUFSIZ) {
  11557. // A small file is read into the same buffer. Other providers may produce
  11558. // their data over time, so they are never held back.
  11559. if (!write_content_with_provider(bstrm, req, res, boundary, content_type)) {
  11560. return false;
  11561. }
  11562. provider_done = true;
  11563. }
  11564. // Log before writing to avoid race condition with client-side code that
  11565. // accesses logger-captured data immediately after receiving the response.
  11566. output_log(req, res);
  11567. // Flush buffer
  11568. auto &data = bstrm.get_buffer();
  11569. if (!detail::write_data(strm, data.data(), data.size())) { return false; }
  11570. if (body_is_separate) {
  11571. return detail::write_data(strm, res.body.data(), res.body.size());
  11572. }
  11573. // Streaming body
  11574. if (send_body && res.content_provider_) {
  11575. if (!provider_done &&
  11576. !write_content_with_provider(strm, req, res, boundary, content_type)) {
  11577. return false;
  11578. }
  11579. res.content_provider_success_ = true;
  11580. }
  11581. return true;
  11582. }
  11583. inline bool
  11584. Server::write_content_with_provider(Stream &strm, const Request &req,
  11585. Response &res, const std::string &boundary,
  11586. const std::string &content_type) {
  11587. auto is_shutting_down = [this]() {
  11588. return this->svr_sock_ == INVALID_SOCKET;
  11589. };
  11590. if (res.content_length_ > 0) {
  11591. // Only a 206 response is served as a partial representation, matching the
  11592. // condition `apply_ranges()` used to decide the Content-Length and the
  11593. // multipart boundary. Since `detail::range_error()` validates `req.ranges`
  11594. // only for a 2xx status, slicing under any other status would write a body
  11595. // that disagrees with the header already sent, from an unchecked offset.
  11596. auto is_partial =
  11597. !req.ranges.empty() && res.status == StatusCode::PartialContent_206;
  11598. if (!is_partial) {
  11599. return detail::write_content(strm, res.content_provider_, 0,
  11600. res.content_length_, is_shutting_down);
  11601. } else if (req.ranges.size() == 1) {
  11602. auto offset_and_length = detail::get_range_offset_and_length(
  11603. req.ranges[0], res.content_length_);
  11604. return detail::write_content(strm, res.content_provider_,
  11605. offset_and_length.first,
  11606. offset_and_length.second, is_shutting_down);
  11607. } else {
  11608. return detail::write_multipart_ranges_data(
  11609. strm, req, res, boundary, content_type, res.content_length_,
  11610. is_shutting_down);
  11611. }
  11612. } else {
  11613. if (res.is_chunked_content_provider_) {
  11614. // Use the coding `apply_ranges()` chose when it wrote the headers;
  11615. // re-negotiating here would disagree with them, e.g. once a handler's
  11616. // own Content-Encoding header suppresses the negotiation.
  11617. auto compressor = detail::make_compressor(res.content_coding_);
  11618. if (!compressor) {
  11619. compressor = detail::make_unique<detail::nocompressor>();
  11620. }
  11621. return detail::write_content_chunked(strm, res.content_provider_,
  11622. is_shutting_down, *compressor);
  11623. } else {
  11624. return detail::write_content_without_length(strm, res.content_provider_,
  11625. is_shutting_down);
  11626. }
  11627. }
  11628. }
  11629. inline bool Server::read_content(Stream &strm, Request &req, Response &res) {
  11630. FormFields::iterator cur_field;
  11631. FormFiles::iterator cur_file;
  11632. auto is_text_field = false;
  11633. size_t count = 0;
  11634. if (read_content_core(
  11635. strm, req, res,
  11636. // Regular
  11637. [&](const char *buf, size_t n) {
  11638. // Prevent arithmetic overflow when checking sizes.
  11639. // Avoid computing (req.body.size() + n) directly because
  11640. // adding two unsigned `size_t` values can wrap around and
  11641. // produce a small result instead of indicating overflow.
  11642. // Instead, check using subtraction: ensure `n` does not
  11643. // exceed the remaining capacity `max_size() - size()`.
  11644. if (req.body.size() >= req.body.max_size() ||
  11645. n > req.body.max_size() - req.body.size()) {
  11646. return false;
  11647. }
  11648. // Limit decompressed body size to payload_max_length_ to protect
  11649. // against "zip bomb" attacks where a small compressed payload
  11650. // decompresses to a massive size.
  11651. if (payload_max_length_ > 0 &&
  11652. (req.body.size() >= payload_max_length_ ||
  11653. n > payload_max_length_ - req.body.size())) {
  11654. return false;
  11655. }
  11656. req.body.append(buf, n);
  11657. return true;
  11658. },
  11659. // Multipart FormData
  11660. [&](const FormData &file) {
  11661. if (count++ == CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT) {
  11662. output_error_log(Error::TooManyFormDataFiles, &req);
  11663. return false;
  11664. }
  11665. if (file.filename.empty()) {
  11666. cur_field = req.form.fields.emplace(
  11667. file.name, FormField{file.name, file.content, file.headers});
  11668. is_text_field = true;
  11669. } else {
  11670. cur_file = req.form.files.emplace(file.name, file);
  11671. is_text_field = false;
  11672. }
  11673. return true;
  11674. },
  11675. [&](const char *buf, size_t n) {
  11676. if (is_text_field) {
  11677. auto &content = cur_field->second.content;
  11678. if (content.size() + n > content.max_size()) { return false; }
  11679. content.append(buf, n);
  11680. } else {
  11681. auto &content = cur_file->second.content;
  11682. if (content.size() + n > content.max_size()) { return false; }
  11683. content.append(buf, n);
  11684. }
  11685. return true;
  11686. })) {
  11687. const auto &content_type = req.get_header_value("Content-Type");
  11688. if (detail::extract_media_type(content_type) ==
  11689. "application/x-www-form-urlencoded") {
  11690. if (req.body.size() > CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH) {
  11691. res.status = StatusCode::PayloadTooLarge_413; // NOTE: should be 414?
  11692. output_error_log(Error::ExceedMaxPayloadSize, &req);
  11693. return false;
  11694. }
  11695. detail::parse_query_text(req.body, req.params);
  11696. }
  11697. return true;
  11698. }
  11699. return false;
  11700. }
  11701. inline bool Server::read_content_with_content_receiver(
  11702. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  11703. FormDataHeader multipart_header, ContentReceiver multipart_receiver) {
  11704. return read_content_core(strm, req, res, std::move(receiver),
  11705. std::move(multipart_header),
  11706. std::move(multipart_receiver));
  11707. }
  11708. inline bool Server::read_content_core(
  11709. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  11710. FormDataHeader multipart_header, ContentReceiver multipart_receiver) const {
  11711. detail::FormDataParser multipart_form_data_parser;
  11712. ContentReceiverWithProgress out;
  11713. if (req.is_multipart_form_data()) {
  11714. const auto &content_type = req.get_header_value("Content-Type");
  11715. std::string boundary;
  11716. if (!detail::parse_multipart_boundary(content_type, boundary)) {
  11717. res.status = StatusCode::BadRequest_400;
  11718. output_error_log(Error::MultipartParsing, &req);
  11719. return false;
  11720. }
  11721. multipart_form_data_parser.set_boundary(std::move(boundary));
  11722. out = [&](const char *buf, size_t n, size_t /*off*/, size_t /*len*/) {
  11723. return multipart_form_data_parser.parse(buf, n, multipart_header,
  11724. multipart_receiver);
  11725. };
  11726. } else {
  11727. out = [receiver](const char *buf, size_t n, size_t /*off*/,
  11728. size_t /*len*/) { return receiver(buf, n); };
  11729. }
  11730. // RFC 9112 §6: no Transfer-Encoding and no Content-Length means no body.
  11731. // For non-SSL builds we still scan non-persistent connections for stray
  11732. // body bytes so the payload limit is enforced (413). On keep-alive,
  11733. // pending bytes may be the next request (issue #2450), so skip.
  11734. #if !defined(CPPHTTPLIB_SSL_ENABLED)
  11735. if (!req.has_header("Content-Length") &&
  11736. !detail::is_chunked_transfer_encoding(req.headers)) {
  11737. if (!detail::is_connection_persistent(req) && payload_max_length_ > 0 &&
  11738. payload_max_length_ < (std::numeric_limits<size_t>::max)()) {
  11739. auto has_data = strm.is_readable();
  11740. if (!has_data) {
  11741. auto s = strm.socket();
  11742. if (s != INVALID_SOCKET) {
  11743. has_data = detail::select_read(s, 0, 0) > 0;
  11744. }
  11745. }
  11746. if (has_data) {
  11747. // Route through the same decompressing reader used by the
  11748. // length-framed and chunked paths below, so payload_max_length_ is
  11749. // enforced on the decompressed size here too instead of only on the
  11750. // compressed wire bytes.
  11751. return detail::read_content(strm, req, payload_max_length_, res.status,
  11752. nullptr, out, true);
  11753. }
  11754. }
  11755. return true;
  11756. }
  11757. #else
  11758. if (!req.has_header("Content-Length") &&
  11759. !detail::is_chunked_transfer_encoding(req.headers)) {
  11760. return true;
  11761. }
  11762. #endif
  11763. // A second read would start where the first one stopped, or in the next
  11764. // request.
  11765. if (req.body_read_started_) { return false; }
  11766. // The client is waiting for this before it sends the body.
  11767. if (req.expect_100_continue_pending_) {
  11768. req.expect_100_continue_pending_ = false;
  11769. detail::write_response_line(strm, StatusCode::Continue_100);
  11770. strm.write("\r\n");
  11771. }
  11772. // Set before reading, since a receiver may also stop by throwing.
  11773. req.body_read_started_ = true;
  11774. if (!detail::read_content(strm, req, payload_max_length_, res.status, nullptr,
  11775. out, true)) {
  11776. return false;
  11777. }
  11778. req.body_consumed_ = true;
  11779. if (req.is_multipart_form_data()) {
  11780. if (!multipart_form_data_parser.is_valid()) {
  11781. res.status = StatusCode::BadRequest_400;
  11782. output_error_log(Error::MultipartParsing, &req);
  11783. return false;
  11784. }
  11785. }
  11786. return true;
  11787. }
  11788. inline bool Server::handle_file_request(Request &req, Response &res) {
  11789. for (const auto &entry : base_dirs_) {
  11790. // Prefix match, on a path segment boundary. A mount point of "/mount"
  11791. // covers "/mount" and "/mount/...", but must not swallow "/mountdir/...".
  11792. // One that already ends in '/' (the root mount among them) carries its own
  11793. // boundary; set_mount_point() guarantees the mount point is not empty.
  11794. if (!req.path.compare(0, entry.mount_point.size(), entry.mount_point) &&
  11795. (entry.mount_point.back() == '/' ||
  11796. req.path.size() == entry.mount_point.size() ||
  11797. req.path[entry.mount_point.size()] == '/')) {
  11798. std::string sub_path = "/" + req.path.substr(entry.mount_point.size());
  11799. if (detail::is_valid_path(sub_path)) {
  11800. auto path = entry.base_dir + sub_path;
  11801. if (path.back() == '/') { path += "index.html"; }
  11802. // Defense-in-depth: is_valid_path blocks ".." traversal in the URL,
  11803. // but symlinks/junctions can still escape the base directory.
  11804. if (!entry.resolved_base_dir.empty()) {
  11805. std::string resolved_path;
  11806. if (detail::canonicalize_path(path.c_str(), resolved_path) &&
  11807. !detail::is_path_within_base(resolved_path,
  11808. entry.resolved_base_dir)) {
  11809. res.status = StatusCode::Forbidden_403;
  11810. return true;
  11811. }
  11812. }
  11813. detail::FileStat stat(path);
  11814. if (stat.is_dir()) {
  11815. // Relative, so "//dir" cannot name another host; "./" keeps a ':'
  11816. // in the name from reading as a scheme.
  11817. auto name = req.path.substr(req.path.rfind('/') + 1);
  11818. res.set_redirect("./" + encode_path_component(name) + "/",
  11819. StatusCode::MovedPermanently_301);
  11820. return true;
  11821. }
  11822. if (stat.is_file()) {
  11823. for (const auto &kv : entry.headers) {
  11824. res.set_header(kv.first, kv.second);
  11825. }
  11826. auto content_type = detail::find_content_type(
  11827. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  11828. auto encoding = detail::EncodingType::None;
  11829. if (static_file_compression_) {
  11830. encoding =
  11831. static_file_encoding(req, res, content_type, stat.size());
  11832. }
  11833. // The ETag names the representation actually sent, so a client that
  11834. // cached the compressed form revalidates against the compressed ETag
  11835. // and still gets a 304, while one that took identity keeps the plain
  11836. // ETag.
  11837. auto etag = detail::compute_etag(
  11838. stat, encoding == detail::EncodingType::None
  11839. ? std::string()
  11840. : std::string("-") + detail::encoding_name(encoding));
  11841. if (!etag.empty()) { res.set_header("ETag", etag); }
  11842. auto mtime = stat.mtime();
  11843. auto last_modified = detail::file_mtime_to_http_date(mtime);
  11844. if (!last_modified.empty()) {
  11845. res.set_header("Last-Modified", last_modified);
  11846. }
  11847. if (check_if_not_modified(req, res, etag, mtime)) { return true; }
  11848. check_if_range(req, etag, mtime);
  11849. auto mm = std::make_shared<detail::mmap>(path.c_str());
  11850. if (!mm->is_open()) {
  11851. output_error_log(Error::OpenFile, &req);
  11852. return false;
  11853. }
  11854. detail::set_file_content_provider(res, mm, content_type, encoding);
  11855. if (req.method != "HEAD" && file_request_handler_) {
  11856. file_request_handler_(req, res);
  11857. }
  11858. return true;
  11859. } else {
  11860. output_error_log(Error::OpenFile, &req);
  11861. }
  11862. }
  11863. }
  11864. }
  11865. return false;
  11866. }
  11867. inline bool Server::check_if_not_modified(const Request &req, Response &res,
  11868. const std::string &etag,
  11869. time_t mtime) const {
  11870. // Handle conditional GET:
  11871. // 1. If-None-Match takes precedence (RFC 9110 Section 13.1.2)
  11872. // 2. If-Modified-Since is checked only when If-None-Match is absent
  11873. if (req.has_header("If-None-Match")) {
  11874. if (!etag.empty()) {
  11875. auto val =
  11876. detail::get_combined_header_value(req.headers, "If-None-Match");
  11877. // NOTE: We use exact string matching here. This works correctly
  11878. // because our server always generates weak ETags (W/"..."), and
  11879. // clients typically send back the same ETag they received.
  11880. // RFC 9110 Section 8.8.3.2 allows weak comparison for
  11881. // If-None-Match, where W/"x" and "x" would match, but this
  11882. // simplified implementation requires exact matches.
  11883. auto ret = detail::split_find(val.data(), val.data() + val.size(), ',',
  11884. [&](const char *b, const char *e) {
  11885. auto seg_len = static_cast<size_t>(e - b);
  11886. return (seg_len == 1 && *b == '*') ||
  11887. (seg_len == etag.size() &&
  11888. std::equal(b, e, etag.begin()));
  11889. });
  11890. if (ret) {
  11891. res.status = StatusCode::NotModified_304;
  11892. return true;
  11893. }
  11894. }
  11895. } else if (req.has_header("If-Modified-Since")) {
  11896. auto val = req.get_header_value("If-Modified-Since");
  11897. auto t = detail::parse_http_date(val);
  11898. if (t != static_cast<time_t>(-1) && mtime <= t) {
  11899. res.status = StatusCode::NotModified_304;
  11900. return true;
  11901. }
  11902. }
  11903. return false;
  11904. }
  11905. inline bool Server::check_if_range(Request &req, const std::string &etag,
  11906. time_t mtime) const {
  11907. // Handle If-Range for partial content requests (RFC 9110
  11908. // Section 13.1.5). If-Range is only evaluated when Range header is
  11909. // present. If the validator matches, serve partial content; otherwise
  11910. // serve full content.
  11911. if (!req.ranges.empty() && req.has_header("If-Range")) {
  11912. auto val = req.get_header_value("If-Range");
  11913. auto is_valid_range = [&]() {
  11914. if (detail::is_strong_etag(val)) {
  11915. // RFC 9110 Section 13.1.5: If-Range requires strong ETag
  11916. // comparison.
  11917. return (!etag.empty() && val == etag);
  11918. } else if (detail::is_weak_etag(val)) {
  11919. // Weak ETags are not valid for If-Range (RFC 9110 Section 13.1.5)
  11920. return false;
  11921. } else {
  11922. // HTTP-date comparison
  11923. auto t = detail::parse_http_date(val);
  11924. return (t != static_cast<time_t>(-1) && mtime <= t);
  11925. }
  11926. };
  11927. if (!is_valid_range()) {
  11928. // Validator doesn't match: ignore Range and serve full content
  11929. req.ranges.clear();
  11930. return false;
  11931. }
  11932. }
  11933. return true;
  11934. }
  11935. inline socket_t
  11936. Server::create_server_socket(const std::string &host, int port,
  11937. int socket_flags,
  11938. SocketOptions socket_options) const {
  11939. return detail::create_socket(
  11940. host, std::string(), port, address_family_, socket_flags, tcp_nodelay_,
  11941. ipv6_v6only_, std::move(socket_options),
  11942. [&](socket_t sock, struct addrinfo &ai, bool & /*quit*/) -> bool {
  11943. if (::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  11944. output_error_log(Error::BindIPAddress, nullptr);
  11945. return false;
  11946. }
  11947. if (::listen(sock, CPPHTTPLIB_LISTEN_BACKLOG)) {
  11948. output_error_log(Error::Listen, nullptr);
  11949. return false;
  11950. }
  11951. return true;
  11952. });
  11953. }
  11954. inline int Server::bind_internal(const std::string &host, int port,
  11955. int socket_flags) {
  11956. if (is_decommissioned) { return -1; }
  11957. if (!is_valid()) { return -1; }
  11958. svr_sock_ = create_server_socket(host, port, socket_flags, socket_options_);
  11959. if (svr_sock_ == INVALID_SOCKET) { return -1; }
  11960. if (port == 0) {
  11961. struct sockaddr_storage addr;
  11962. socklen_t addr_len = sizeof(addr);
  11963. if (getsockname(svr_sock_, reinterpret_cast<struct sockaddr *>(&addr),
  11964. &addr_len) == -1) {
  11965. output_error_log(Error::GetSockName, nullptr);
  11966. return -1;
  11967. }
  11968. if (addr.ss_family == AF_INET) {
  11969. return ntohs(reinterpret_cast<struct sockaddr_in *>(&addr)->sin_port);
  11970. } else if (addr.ss_family == AF_INET6) {
  11971. return ntohs(reinterpret_cast<struct sockaddr_in6 *>(&addr)->sin6_port);
  11972. } else {
  11973. output_error_log(Error::UnsupportedAddressFamily, nullptr);
  11974. return -1;
  11975. }
  11976. } else {
  11977. return port;
  11978. }
  11979. }
  11980. inline bool Server::listen_internal() {
  11981. // A stop() between bind and listen leaves nothing to accept on. Report
  11982. // failure instead of returning success without ever serving, and mark the
  11983. // server decommissioned the way any failed listen does so that a concurrent
  11984. // wait_until_ready() wakes up instead of spinning forever.
  11985. if (is_decommissioned || svr_sock_ == INVALID_SOCKET) {
  11986. is_decommissioned = true;
  11987. return false;
  11988. }
  11989. auto ret = true;
  11990. is_running_ = true;
  11991. auto se = detail::scope_exit([&]() { is_running_ = false; });
  11992. if (start_handler_) { start_handler_(); }
  11993. {
  11994. std::unique_ptr<TaskQueue> task_queue(new_task_queue());
  11995. while (svr_sock_ != INVALID_SOCKET) {
  11996. #ifndef _WIN32
  11997. if (idle_interval_sec_ > 0 || idle_interval_usec_ > 0) {
  11998. #endif
  11999. auto val = detail::select_read(svr_sock_, idle_interval_sec_,
  12000. idle_interval_usec_);
  12001. if (val == 0) { // Timeout
  12002. task_queue->on_idle();
  12003. continue;
  12004. }
  12005. #ifndef _WIN32
  12006. }
  12007. #endif
  12008. #if defined _WIN32
  12009. // sockets connected via WASAccept inherit flags NO_HANDLE_INHERIT,
  12010. // OVERLAPPED
  12011. socket_t sock = WSAAccept(svr_sock_, nullptr, nullptr, nullptr, 0);
  12012. #elif defined SOCK_CLOEXEC
  12013. socket_t sock = accept4(svr_sock_, nullptr, nullptr, SOCK_CLOEXEC);
  12014. #else
  12015. socket_t sock = accept(svr_sock_, nullptr, nullptr);
  12016. #endif
  12017. if (sock == INVALID_SOCKET) {
  12018. // NOTE: Winsock reports failures through WSAGetLastError() and never
  12019. // touches the CRT errno, so the two have to be asked platform by
  12020. // platform rather than by testing errno here.
  12021. if (detail::is_accept_resource_error()) {
  12022. // The per-process descriptor limit or the network stack's buffer
  12023. // space has been reached. Try to accept new connections after a
  12024. // short sleep.
  12025. std::this_thread::sleep_for(std::chrono::microseconds{1});
  12026. continue;
  12027. } else if (detail::is_accept_transient_error()) {
  12028. continue;
  12029. }
  12030. // Take the descriptor out of svr_sock_ before closing it: a later
  12031. // stop() would otherwise shutdown()/close() a value the OS may have
  12032. // reused, and keep_alive() watches svr_sock_ to notice the server is
  12033. // gone. The exchange also settles the race with a concurrent stop(),
  12034. // since whichever side takes the descriptor closes it exactly once.
  12035. auto listen_sock = svr_sock_.exchange(INVALID_SOCKET);
  12036. if (listen_sock != INVALID_SOCKET) {
  12037. detail::close_socket(listen_sock);
  12038. ret = false;
  12039. output_error_log(Error::Connection, nullptr);
  12040. } else {
  12041. ; // The server socket was closed by user.
  12042. }
  12043. break;
  12044. }
  12045. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO,
  12046. read_timeout_sec_, read_timeout_usec_);
  12047. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_SNDTIMEO,
  12048. write_timeout_sec_, write_timeout_usec_);
  12049. if (tcp_nodelay_) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  12050. if (!task_queue->enqueue(
  12051. [this, sock]() { process_and_close_socket(sock); })) {
  12052. output_error_log(Error::ResourceExhaustion, nullptr);
  12053. detail::shutdown_socket(sock);
  12054. detail::close_socket(sock);
  12055. }
  12056. }
  12057. task_queue->shutdown();
  12058. }
  12059. is_decommissioned = !ret;
  12060. return ret;
  12061. }
  12062. inline bool Server::routing(Request &req, Response &res, Stream &strm) {
  12063. if (pre_routing_handler_ &&
  12064. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12065. return true;
  12066. }
  12067. // File handler
  12068. if ((req.method == "GET" || req.method == "HEAD") &&
  12069. handle_file_request(req, res)) {
  12070. return true;
  12071. }
  12072. const auto *custom = find_custom_entry(req.method);
  12073. // The second clause mirrors what expect_content() does unconditionally for
  12074. // POST/PUT/PATCH/DELETE: a content reader route fires even when the request
  12075. // carries no body. Without it a body-less PROPFIND (RFC 4918 treats one as
  12076. // `allprop`) would skip its handler and fall through to 404.
  12077. if (detail::expect_content(req) ||
  12078. (custom && !custom->handlers_for_content_reader.empty())) {
  12079. // Content reader handler
  12080. {
  12081. // Track whether the ContentReader was aborted due to the decompressed
  12082. // payload exceeding `payload_max_length_`.
  12083. // The user handler runs after the lambda returns, so we must restore the
  12084. // 413 status if the handler overwrites it.
  12085. bool content_reader_payload_too_large = false;
  12086. ContentReader reader(
  12087. [&](ContentReceiver receiver) {
  12088. auto result = read_content_with_content_receiver(
  12089. strm, req, res, std::move(receiver), nullptr, nullptr);
  12090. if (!result) {
  12091. output_error_log(Error::Read, &req);
  12092. if (res.status == StatusCode::PayloadTooLarge_413) {
  12093. content_reader_payload_too_large = true;
  12094. }
  12095. }
  12096. return result;
  12097. },
  12098. [&](FormDataHeader header, ContentReceiver receiver) {
  12099. auto result = read_content_with_content_receiver(
  12100. strm, req, res, nullptr, std::move(header),
  12101. std::move(receiver));
  12102. if (!result) {
  12103. output_error_log(Error::Read, &req);
  12104. if (res.status == StatusCode::PayloadTooLarge_413) {
  12105. content_reader_payload_too_large = true;
  12106. }
  12107. }
  12108. return result;
  12109. });
  12110. bool dispatched = false;
  12111. if (req.method == "POST") {
  12112. dispatched = dispatch_request_for_content_reader(
  12113. req, res, std::move(reader), post_handlers_for_content_reader_);
  12114. } else if (req.method == "PUT") {
  12115. dispatched = dispatch_request_for_content_reader(
  12116. req, res, std::move(reader), put_handlers_for_content_reader_);
  12117. } else if (req.method == "PATCH") {
  12118. dispatched = dispatch_request_for_content_reader(
  12119. req, res, std::move(reader), patch_handlers_for_content_reader_);
  12120. } else if (req.method == "DELETE") {
  12121. dispatched = dispatch_request_for_content_reader(
  12122. req, res, std::move(reader), delete_handlers_for_content_reader_);
  12123. } else if (custom) {
  12124. dispatched = dispatch_request_for_content_reader(
  12125. req, res, std::move(reader), custom->handlers_for_content_reader);
  12126. }
  12127. if (dispatched) {
  12128. if (content_reader_payload_too_large) {
  12129. // Enforce the limit: override any status the handler may have set
  12130. // and return false so the error path sends a plain 413 response.
  12131. res.status = StatusCode::PayloadTooLarge_413;
  12132. detail::clear_content(res);
  12133. return false;
  12134. }
  12135. return true;
  12136. }
  12137. }
  12138. // NOTE: `req.body` is not read here. For a regular handler the body is
  12139. // read inside dispatch_request(), after the route has matched and the
  12140. // pre-request handler has approved the request, so that a rejected
  12141. // request (e.g. failed authentication) never forces us to buffer a
  12142. // potentially large body.
  12143. }
  12144. // Regular handler
  12145. if (req.method == "GET" || req.method == "HEAD") {
  12146. return dispatch_request(req, res, get_handlers_, strm);
  12147. } else if (req.method == "POST") {
  12148. return dispatch_request(req, res, post_handlers_, strm);
  12149. } else if (req.method == "PUT") {
  12150. return dispatch_request(req, res, put_handlers_, strm);
  12151. } else if (req.method == "DELETE") {
  12152. return dispatch_request(req, res, delete_handlers_, strm);
  12153. } else if (req.method == "OPTIONS") {
  12154. return dispatch_request(req, res, options_handlers_, strm);
  12155. } else if (req.method == "PATCH") {
  12156. return dispatch_request(req, res, patch_handlers_, strm);
  12157. } else if (custom) {
  12158. return dispatch_request(req, res, custom->handlers, strm);
  12159. }
  12160. res.status = StatusCode::BadRequest_400;
  12161. return false;
  12162. }
  12163. inline bool Server::dispatch_request(Request &req, Response &res,
  12164. const Handlers &handlers, Stream &strm) {
  12165. for (const auto &x : handlers) {
  12166. const auto &matcher = x.first;
  12167. const auto &handler = x.second;
  12168. if (matcher->match(req)) {
  12169. req.matched_route = matcher->pattern();
  12170. // Run the pre-request handler before reading the body so a rejected
  12171. // request (e.g. failed authentication) never forces us to buffer a
  12172. // potentially large body. `req.matched_route` is available here.
  12173. if (pre_request_handler_ &&
  12174. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12175. return true;
  12176. }
  12177. // The route matched and the request was approved; read the body now.
  12178. if (detail::expect_content(req) && !read_content(strm, req, res)) {
  12179. output_error_log(Error::Read, &req);
  12180. return false;
  12181. }
  12182. handler(req, res);
  12183. return true;
  12184. }
  12185. }
  12186. return false;
  12187. }
  12188. // Decides the content coding for a response served straight from a file. Both
  12189. // the ETag, which has to name the representation actually sent, and
  12190. // `apply_static_file_compression()` go through this, so the two cannot drift
  12191. // apart.
  12192. inline detail::EncodingType
  12193. Server::static_file_encoding(const Request &req, const Response &res,
  12194. const std::string &content_type,
  12195. size_t length) const {
  12196. if (!static_file_compression_) { return detail::EncodingType::None; }
  12197. // Nothing to compress, and an empty file already answers with
  12198. // `Content-Length: 0`. Checked on its own so that a zero floor still cannot
  12199. // turn an empty body into a 20-byte gzip stream.
  12200. if (length == 0) { return detail::EncodingType::None; }
  12201. // A file that already fits in a single packet gains nothing from being made
  12202. // smaller, since it still travels in that one segment, and a file of a few
  12203. // bytes comes out larger than it went in.
  12204. if (length < static_file_compression_min_length_) {
  12205. return detail::EncodingType::None;
  12206. }
  12207. // RFC 9110 applies Range to the representation after content coding, so a
  12208. // compressed 206 would mean compressing the whole file and then slicing it.
  12209. // Serve ranges from the identity representation instead.
  12210. if (!req.ranges.empty()) { return detail::EncodingType::None; }
  12211. if (static_file_compression_max_length_ > 0 &&
  12212. length > static_file_compression_max_length_) {
  12213. return detail::EncodingType::None;
  12214. }
  12215. return detail::encoding_type(req, res, content_type);
  12216. }
  12217. // Compresses a file-backed content provider into `res.body` and takes over the
  12218. // framing headers. Returns false when the response is left untouched.
  12219. inline bool Server::apply_static_file_compression(const Request &req,
  12220. Response &res) const {
  12221. auto type = res.content_coding_;
  12222. if (type == detail::EncodingType::None || !res.content_provider_) {
  12223. return false;
  12224. }
  12225. auto compressor = detail::make_compressor(type);
  12226. if (!compressor) { return false; }
  12227. output_pre_compression_log(req, res);
  12228. std::string compressed;
  12229. if (!detail::compress_content_provider(res.content_provider_,
  12230. res.content_length_, *compressor,
  12231. compressed)) {
  12232. return false;
  12233. }
  12234. res.body.swap(compressed);
  12235. // The provider was consumed in full, so its releaser hears about a success.
  12236. res.content_provider_success_ = true;
  12237. detail::clear_content_provider(res);
  12238. res.set_header("Content-Encoding", detail::encoding_name(type));
  12239. res.set_header("Vary", "Accept-Encoding");
  12240. res.set_header("Content-Length", std::to_string(res.body.size()));
  12241. return true;
  12242. }
  12243. inline void Server::apply_ranges(const Request &req, Response &res,
  12244. std::string &content_type,
  12245. std::string &boundary) const {
  12246. // A known-length content provider leaves `res.body` empty, so the compressor
  12247. // at the end of this function never runs for one (issue #2545). A file-backed
  12248. // provider is fully readable right here, so compress it and answer with an
  12249. // ordinary body: `Content-Length` and HEAD keep working, and the response
  12250. // takes the same path as `set_content()` from here on. Range requests never
  12251. // get a content coding, so `Content-Range` still names identity bytes and
  12252. // none of the framing below applies.
  12253. if (apply_static_file_compression(req, res)) { return; }
  12254. if (req.ranges.size() > 1 && res.status == StatusCode::PartialContent_206) {
  12255. auto it = res.headers.find("Content-Type");
  12256. if (it != res.headers.end()) {
  12257. content_type = it->second;
  12258. res.headers.erase(it);
  12259. }
  12260. boundary = detail::make_multipart_data_boundary();
  12261. res.set_header("Content-Type",
  12262. "multipart/byteranges; boundary=" + boundary);
  12263. }
  12264. auto type = detail::encoding_type(req, res);
  12265. if (res.body.empty()) {
  12266. if (res.content_length_ > 0) {
  12267. size_t length = 0;
  12268. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12269. length = res.content_length_;
  12270. } else if (req.ranges.size() == 1) {
  12271. auto offset_and_length = detail::get_range_offset_and_length(
  12272. req.ranges[0], res.content_length_);
  12273. length = offset_and_length.second;
  12274. auto content_range = detail::make_content_range_header_field(
  12275. offset_and_length, res.content_length_);
  12276. res.set_header("Content-Range", content_range);
  12277. } else {
  12278. length = detail::get_multipart_ranges_data_length(
  12279. req, boundary, content_type, res.content_length_);
  12280. }
  12281. res.set_header("Content-Length", std::to_string(length));
  12282. } else {
  12283. if (res.content_provider_) {
  12284. if (res.is_chunked_content_provider_) {
  12285. res.set_header("Transfer-Encoding", "chunked");
  12286. res.content_coding_ = type;
  12287. if (type != detail::EncodingType::None) {
  12288. res.set_header("Content-Encoding", detail::encoding_name(type));
  12289. res.set_header("Vary", "Accept-Encoding");
  12290. }
  12291. }
  12292. }
  12293. }
  12294. } else {
  12295. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12296. ;
  12297. } else if (req.ranges.size() == 1) {
  12298. auto offset_and_length =
  12299. detail::get_range_offset_and_length(req.ranges[0], res.body.size());
  12300. auto offset = offset_and_length.first;
  12301. auto length = offset_and_length.second;
  12302. auto content_range = detail::make_content_range_header_field(
  12303. offset_and_length, res.body.size());
  12304. res.set_header("Content-Range", content_range);
  12305. assert(offset + length <= res.body.size());
  12306. res.body = res.body.substr(offset, length);
  12307. } else {
  12308. std::string data;
  12309. detail::make_multipart_ranges_data(req, res, boundary, content_type,
  12310. res.body.size(), data);
  12311. res.body.swap(data);
  12312. }
  12313. if (type != detail::EncodingType::None) {
  12314. output_pre_compression_log(req, res);
  12315. if (auto compressor = detail::make_compressor(type)) {
  12316. std::string compressed;
  12317. if (compressor->compress(res.body.data(), res.body.size(), true,
  12318. [&](const char *data, size_t data_len) {
  12319. compressed.append(data, data_len);
  12320. return true;
  12321. })) {
  12322. res.body.swap(compressed);
  12323. res.set_header("Content-Encoding", detail::encoding_name(type));
  12324. res.set_header("Vary", "Accept-Encoding");
  12325. }
  12326. }
  12327. }
  12328. res.content_length_ = res.body.size();
  12329. res.set_header("Content-Length", std::to_string(res.content_length_));
  12330. }
  12331. }
  12332. inline bool Server::dispatch_request_for_content_reader(
  12333. Request &req, Response &res, ContentReader content_reader,
  12334. const HandlersForContentReader &handlers) const {
  12335. for (const auto &x : handlers) {
  12336. const auto &matcher = x.first;
  12337. const auto &handler = x.second;
  12338. if (matcher->match(req)) {
  12339. req.matched_route = matcher->pattern();
  12340. if (!pre_request_handler_ ||
  12341. pre_request_handler_(req, res) != HandlerResponse::Handled) {
  12342. handler(req, res, content_reader);
  12343. }
  12344. return true;
  12345. }
  12346. }
  12347. return false;
  12348. }
  12349. inline std::string
  12350. get_client_ip(const std::string &x_forwarded_for,
  12351. const std::vector<std::string> &trusted_proxies) {
  12352. // X-Forwarded-For is a comma-separated list per RFC 7239
  12353. std::vector<std::string> ip_list;
  12354. detail::split(x_forwarded_for.data(),
  12355. x_forwarded_for.data() + x_forwarded_for.size(), ',',
  12356. [&](const char *b, const char *e) {
  12357. auto r = detail::trim(b, e, 0, static_cast<size_t>(e - b));
  12358. ip_list.emplace_back(std::string(b + r.first, b + r.second));
  12359. });
  12360. // A malformed X-Forwarded-For (empty, comma-only, whitespace-only) yields
  12361. // no segments. Signal "no client IP derived" with an empty string so the
  12362. // caller can fall back to the connection-level remote address.
  12363. if (ip_list.empty()) { return std::string(); }
  12364. // Each hop appends the address it received the request from, so the rightmost
  12365. // entries are the ones written by our own infrastructure while the leftmost
  12366. // are whatever the original client chose to send. Walk from the right and
  12367. // skip trusted proxies; the first address that is not a trusted proxy is the
  12368. // furthest point still attributable to a real hop, i.e. the client. Scanning
  12369. // from the left instead lets a client forge an arbitrary address by following
  12370. // it with a trusted proxy's address, which the left-to-right scan then
  12371. // returned as the client.
  12372. for (size_t i = ip_list.size(); i-- > 0;) {
  12373. const auto &ip = ip_list[i];
  12374. auto is_trusted_proxy =
  12375. std::any_of(trusted_proxies.begin(), trusted_proxies.end(),
  12376. [&](const std::string &proxy) { return ip == proxy; });
  12377. if (!is_trusted_proxy) { return ip; }
  12378. }
  12379. // Every hop was a trusted proxy; fall back to the first entry.
  12380. return ip_list.front();
  12381. }
  12382. inline bool
  12383. Server::process_request(Stream &strm, const std::string &remote_addr,
  12384. int remote_port, const std::string &local_addr,
  12385. int local_port, bool close_connection,
  12386. bool &connection_closed,
  12387. const std::function<void(Request &)> &setup_request,
  12388. bool *websocket_upgraded) {
  12389. std::array<char, 2048> buf{};
  12390. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12391. // Connection has been closed on client
  12392. if (!line_reader.getline()) { return false; }
  12393. // RFC 9112 2.2: ignore an empty line received before the request-line. Some
  12394. // clients send an extra CRLF after a request body, which would otherwise be
  12395. // parsed as the next request on a persistent connection.
  12396. if (strcmp(line_reader.ptr(), "\r\n") == 0 && !line_reader.getline()) {
  12397. return false;
  12398. }
  12399. Request req;
  12400. req.start_time_ = std::chrono::steady_clock::now();
  12401. req.remote_addr = remote_addr;
  12402. req.remote_port = remote_port;
  12403. req.local_addr = local_addr;
  12404. req.local_port = local_port;
  12405. Response res;
  12406. res.version = "HTTP/1.1";
  12407. res.headers = default_headers_;
  12408. // RFC 9112 §9.6: a server that sends the "close" connection option must
  12409. // close the connection after that response, whichever path wrote it (an
  12410. // error status, a handler, or a rejected request). Reading on would also
  12411. // parse whatever the client sent next on a connection it considers done.
  12412. auto honor_connection_close = detail::scope_exit([&] {
  12413. if (detail::has_header_token(res.headers, "Connection", "close")) {
  12414. connection_closed = true;
  12415. }
  12416. });
  12417. // Request line and headers. A rejected message leaves the rest of it (and
  12418. // any body) unread, so the connection cannot be reused: the leftover bytes
  12419. // would be parsed as the next request.
  12420. if (!parse_request_line(line_reader.ptr(), req)) {
  12421. connection_closed = true;
  12422. res.status = StatusCode::BadRequest_400;
  12423. output_error_log(Error::InvalidRequestLine, &req);
  12424. return write_response(strm, close_connection, req, res);
  12425. }
  12426. // Request headers
  12427. if (!detail::read_headers(strm, req.headers)) {
  12428. connection_closed = true;
  12429. res.status = StatusCode::BadRequest_400;
  12430. output_error_log(Error::InvalidHeaders, &req);
  12431. return write_response(strm, close_connection, req, res);
  12432. }
  12433. // RFC 9112 §6.3: Reject requests whose framing is invalid or ambiguous,
  12434. // which would otherwise let an intermediary and this parser disagree on
  12435. // where the body ends and enable request smuggling. Three cases: a
  12436. // Content-Length that is not a valid decimal length (e.g. "42, 42", "+42"
  12437. // or empty), which would otherwise be read as "no body"; a non-zero
  12438. // Content-Length alongside any Transfer-Encoding (Content-Length: 0 is
  12439. // tolerated for compatibility with existing clients); and a
  12440. // Transfer-Encoding whose final coding is not chunked, which leaves the body
  12441. // length undeterminable. None of them may fall through to the "no body"
  12442. // path, or the body bytes are parsed as the next request on a persistent
  12443. // connection.
  12444. auto is_invalid_content_length = false;
  12445. detail::get_header_value_u64(req.headers, "Content-Length", 0, 0,
  12446. is_invalid_content_length);
  12447. if (is_invalid_content_length ||
  12448. detail::has_conflicting_content_length(req.headers) ||
  12449. (req.has_header("Transfer-Encoding") &&
  12450. !detail::is_chunked_transfer_encoding(req.headers))) {
  12451. connection_closed = true;
  12452. res.status = StatusCode::BadRequest_400;
  12453. return write_response(strm, close_connection, req, res);
  12454. }
  12455. // RFC 9112 §3.2: Reject more than one Host field line or an invalid Host
  12456. // value, so that every recipient of the request sees the same authority.
  12457. if (req.get_header_value_count("Host") > 1 ||
  12458. !detail::fields::is_host(req.get_header_value("Host"))) {
  12459. connection_closed = true;
  12460. res.status = StatusCode::BadRequest_400;
  12461. output_error_log(Error::InvalidHeaders, &req);
  12462. return write_response(strm, close_connection, req, res);
  12463. }
  12464. // Check if the request URI doesn't exceed the limit
  12465. if (req.target.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  12466. connection_closed = true;
  12467. res.status = StatusCode::UriTooLong_414;
  12468. output_error_log(Error::ExceedUriMaxLength, &req);
  12469. return write_response(strm, close_connection, req, res);
  12470. }
  12471. if (detail::has_header_token(req.headers, "Connection", "close")) {
  12472. connection_closed = true;
  12473. }
  12474. if (req.version == "HTTP/1.0" &&
  12475. !detail::has_header_token(req.headers, "Connection", "keep-alive")) {
  12476. connection_closed = true;
  12477. }
  12478. // Only honor X-Forwarded-For if the peer on the actual TCP connection is
  12479. // itself a trusted proxy. Otherwise any direct client could spoof
  12480. // remote_addr simply by sending an arbitrary X-Forwarded-For header.
  12481. auto is_trusted_peer = std::any_of(
  12482. trusted_proxies_.begin(), trusted_proxies_.end(),
  12483. [&](const std::string &proxy) { return proxy == remote_addr; });
  12484. if (is_trusted_peer && req.has_header("X-Forwarded-For")) {
  12485. // Some proxies append the address they observed as a separate
  12486. // X-Forwarded-For field line instead of extending the one the client sent
  12487. // (e.g. HAProxy's "option forwardfor"), so the whole combined value has to
  12488. // be scanned. Reading only the first occurrence would hand back the
  12489. // client-supplied, and therefore forgeable, value.
  12490. auto x_forwarded_for =
  12491. detail::get_combined_header_value(req.headers, "X-Forwarded-For");
  12492. auto derived = get_client_ip(x_forwarded_for, trusted_proxies_);
  12493. req.remote_addr = derived.empty() ? remote_addr : derived;
  12494. } else {
  12495. req.remote_addr = remote_addr;
  12496. }
  12497. req.remote_port = remote_port;
  12498. req.local_addr = local_addr;
  12499. req.local_port = local_port;
  12500. if (req.has_header("Accept")) {
  12501. auto accept_header =
  12502. detail::get_combined_header_value(req.headers, "Accept");
  12503. if (!detail::parse_accept_header(accept_header, req.accept_content_types)) {
  12504. connection_closed = true;
  12505. res.status = StatusCode::BadRequest_400;
  12506. output_error_log(Error::HTTPParsing, &req);
  12507. return write_response(strm, close_connection, req, res);
  12508. }
  12509. }
  12510. if (req.has_header("Range")) {
  12511. const auto &range_header_value = req.get_header_value("Range");
  12512. if (!detail::parse_range_header(range_header_value, req.ranges)) {
  12513. connection_closed = true;
  12514. res.status = StatusCode::RangeNotSatisfiable_416;
  12515. output_error_log(Error::InvalidRangeHeader, &req);
  12516. return write_response(strm, close_connection, req, res);
  12517. }
  12518. }
  12519. if (setup_request) { setup_request(req); }
  12520. // RFC 9110 10.1.1: Expect is a comma-separated list whose value is
  12521. // case-insensitive, and a 100-continue expectation in an HTTP/1.0 request
  12522. // must be ignored. An expectation we do not recognize is left alone; the
  12523. // 417 the section allows for one is a MAY, not a requirement.
  12524. //
  12525. // `100 Continue` itself is deferred until the body is actually read (see
  12526. // read_content_core), so a request rejected by a later handler never
  12527. // invites the client to send a body nobody will read.
  12528. if (req.version != "HTTP/1.0" &&
  12529. detail::has_header_token(req.headers, "Expect", "100-continue")) {
  12530. int status = StatusCode::Continue_100;
  12531. if (expect_100_continue_handler_) {
  12532. status = expect_100_continue_handler_(req, res);
  12533. }
  12534. if (status == StatusCode::Continue_100) {
  12535. req.expect_100_continue_pending_ = true;
  12536. } else {
  12537. if (res.status == -1) { res.status = status; }
  12538. connection_closed = true;
  12539. return write_response(strm, true, req, res);
  12540. }
  12541. }
  12542. // Setup `is_connection_closed` method
  12543. auto sock = strm.socket();
  12544. req.is_connection_closed = [sock]() {
  12545. return !detail::is_socket_alive(sock);
  12546. };
  12547. // WebSocket upgrade
  12548. // Run pre_routing_handler_ and pre_request_handler_ before upgrading so
  12549. // that authentication and other middleware can reject the request with an
  12550. // HTTP response (e.g., 401) before the protocol switches.
  12551. if (detail::is_websocket_upgrade(req)) {
  12552. if (pre_routing_handler_ &&
  12553. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12554. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12555. return write_response_with_content(strm, close_connection, req, res);
  12556. }
  12557. // Find matching WebSocket handler
  12558. for (const auto &entry : websocket_handlers_) {
  12559. if (entry.matcher->match(req)) {
  12560. req.matched_route = entry.matcher->pattern();
  12561. if (pre_request_handler_ &&
  12562. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12563. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12564. return write_response_with_content(strm, close_connection, req, res);
  12565. }
  12566. // Compute accept key
  12567. auto client_key = req.get_header_value("Sec-WebSocket-Key");
  12568. auto accept_key = detail::websocket_accept_key(client_key);
  12569. // Negotiate subprotocol
  12570. std::string selected_subprotocol;
  12571. if (entry.sub_protocol_selector) {
  12572. auto protocol_header = detail::get_combined_header_value(
  12573. req.headers, "Sec-WebSocket-Protocol");
  12574. if (!protocol_header.empty()) {
  12575. std::vector<std::string> protocols;
  12576. detail::split(protocol_header.data(),
  12577. protocol_header.data() + protocol_header.size(), ',',
  12578. [&](const char *b, const char *e) {
  12579. protocols.emplace_back(b, e);
  12580. });
  12581. selected_subprotocol = entry.sub_protocol_selector(protocols);
  12582. // Ignore a selection the client did not offer (RFC 6455 4.2.2)
  12583. if (std::find(protocols.begin(), protocols.end(),
  12584. selected_subprotocol) == protocols.end()) {
  12585. selected_subprotocol.clear();
  12586. }
  12587. }
  12588. }
  12589. // Send 101 Switching Protocols
  12590. std::string handshake_response = "HTTP/1.1 101 Switching Protocols\r\n"
  12591. "Upgrade: websocket\r\n"
  12592. "Connection: Upgrade\r\n"
  12593. "Sec-WebSocket-Accept: " +
  12594. accept_key + "\r\n";
  12595. if (!selected_subprotocol.empty()) {
  12596. if (!detail::fields::is_field_value(selected_subprotocol)) {
  12597. return false;
  12598. }
  12599. handshake_response +=
  12600. "Sec-WebSocket-Protocol: " + selected_subprotocol + "\r\n";
  12601. }
  12602. handshake_response += "\r\n";
  12603. if (strm.write(handshake_response.data(), handshake_response.size()) <
  12604. 0) {
  12605. return false;
  12606. }
  12607. connection_closed = true;
  12608. if (websocket_upgraded) { *websocket_upgraded = true; }
  12609. {
  12610. #ifdef CPPHTTPLIB_SSL_ENABLED
  12611. if (req.ssl) {
  12612. // wss: the heartbeat ping thread and the read path enter the same
  12613. // TLS session from different threads. Hand the WebSocket a stream
  12614. // that serializes every TLS call, so the shared SSLSocketStream on
  12615. // the plain HTTP/HTTPS paths stays untouched.
  12616. auto ws_strm =
  12617. std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  12618. strm.socket(), const_cast<tls::session_t>(req.ssl),
  12619. CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0,
  12620. write_timeout_sec_, write_timeout_usec_));
  12621. ws::WebSocket ws(std::move(ws_strm), req, true,
  12622. websocket_ping_interval_sec_,
  12623. websocket_max_missed_pongs_);
  12624. entry.handler(req, ws);
  12625. return true;
  12626. }
  12627. #endif
  12628. // Use WebSocket-specific read timeout instead of HTTP timeout
  12629. strm.set_read_timeout(CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND,
  12630. 0);
  12631. ws::WebSocket ws(strm, req, true, websocket_ping_interval_sec_,
  12632. websocket_max_missed_pongs_);
  12633. entry.handler(req, ws);
  12634. }
  12635. return true;
  12636. }
  12637. }
  12638. // No matching handler - fall through to 404
  12639. }
  12640. // Routing
  12641. auto routed = false;
  12642. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  12643. routed = routing(req, res, strm);
  12644. #else
  12645. try {
  12646. routed = routing(req, res, strm);
  12647. } catch (std::exception &) {
  12648. if (exception_handler_) {
  12649. auto ep = std::current_exception();
  12650. exception_handler_(req, res, ep);
  12651. routed = true;
  12652. } else {
  12653. res.status = StatusCode::InternalServerError_500;
  12654. }
  12655. } catch (...) {
  12656. if (exception_handler_) {
  12657. auto ep = std::current_exception();
  12658. exception_handler_(req, res, ep);
  12659. routed = true;
  12660. } else {
  12661. res.status = StatusCode::InternalServerError_500;
  12662. }
  12663. }
  12664. #endif
  12665. auto ret = false;
  12666. if (routed) {
  12667. if (res.status == -1) {
  12668. res.status = req.ranges.empty() ? StatusCode::OK_200
  12669. : StatusCode::PartialContent_206;
  12670. }
  12671. // Before the Range checks below, so they see the body's own length.
  12672. detail::prefer_assigned_body(res);
  12673. // Serve file content by using a content provider
  12674. auto file_open_error = false;
  12675. if (!res.file_content_path_.empty()) {
  12676. const auto &path = res.file_content_path_;
  12677. auto mm = std::make_shared<detail::mmap>(path.c_str());
  12678. if (!mm->is_open()) {
  12679. res.status = StatusCode::NotFound_404;
  12680. output_error_log(Error::OpenFile, &req);
  12681. file_open_error = true;
  12682. } else {
  12683. auto content_type = res.file_content_content_type_;
  12684. if (content_type.empty()) {
  12685. content_type = detail::find_content_type(
  12686. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  12687. }
  12688. detail::set_file_content_provider(
  12689. res, mm, content_type,
  12690. static_file_encoding(req, res, content_type, mm->size()));
  12691. }
  12692. }
  12693. if (file_open_error) {
  12694. ret = write_response(strm, close_connection, req, res);
  12695. } else if (detail::range_error(req, res)) {
  12696. detail::clear_content(res);
  12697. res.status = StatusCode::RangeNotSatisfiable_416;
  12698. ret = write_response(strm, close_connection, req, res);
  12699. } else {
  12700. ret = write_response_with_content(strm, close_connection, req, res);
  12701. }
  12702. } else {
  12703. if (res.status == -1) { res.status = StatusCode::NotFound_404; }
  12704. ret = write_response(strm, close_connection, req, res);
  12705. }
  12706. // Drain any unconsumed framed body to prevent request smuggling on
  12707. // keep-alive. Without framing there is no body to drain — reading would
  12708. // consume the next request (issue #2450). If the response has committed the
  12709. // connection to close, there is no next request to protect. A body read in
  12710. // part cannot be drained from where it stopped, so the connection closes.
  12711. if (!req.body_consumed_ && detail::has_framed_body(req) &&
  12712. !detail::has_header_token(res.headers, "Connection", "close")) {
  12713. int dummy_status;
  12714. if (req.body_read_started_ ||
  12715. !detail::read_content(
  12716. strm, req, payload_max_length_, dummy_status, nullptr,
  12717. [](const char *, size_t, size_t, size_t) { return true; }, false)) {
  12718. connection_closed = true;
  12719. }
  12720. }
  12721. return ret;
  12722. }
  12723. inline bool Server::is_valid() const { return !has_invalid_registration_; }
  12724. inline bool Server::process_and_close_socket(socket_t sock) {
  12725. std::string remote_addr;
  12726. int remote_port = 0;
  12727. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  12728. std::string local_addr;
  12729. int local_port = 0;
  12730. detail::get_local_ip_and_port(sock, local_addr, local_port);
  12731. bool websocket_upgraded = false;
  12732. auto ret = serve_guarded([&]() {
  12733. return detail::process_server_socket(
  12734. svr_sock_, sock, keep_alive_max_count_, keep_alive_timeout_sec_,
  12735. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12736. write_timeout_usec_,
  12737. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  12738. return process_request(strm, remote_addr, remote_port, local_addr,
  12739. local_port, close_connection,
  12740. connection_closed, nullptr,
  12741. &websocket_upgraded);
  12742. });
  12743. });
  12744. detail::drain_and_close_socket(sock);
  12745. return ret;
  12746. }
  12747. inline void Server::output_log(const Request &req, const Response &res) const {
  12748. if (logger_) {
  12749. std::lock_guard<std::mutex> guard(logger_mutex_);
  12750. logger_(req, res);
  12751. }
  12752. }
  12753. inline void Server::output_pre_compression_log(const Request &req,
  12754. const Response &res) const {
  12755. if (pre_compression_logger_) {
  12756. std::lock_guard<std::mutex> guard(logger_mutex_);
  12757. pre_compression_logger_(req, res);
  12758. }
  12759. }
  12760. inline void Server::output_error_log(const Error &err,
  12761. const Request *req) const {
  12762. if (error_logger_) {
  12763. std::lock_guard<std::mutex> guard(logger_mutex_);
  12764. error_logger_(err, req);
  12765. }
  12766. }
  12767. /*
  12768. * Group 5: ClientImpl and Client (Universal) implementation
  12769. */
  12770. // HTTP client implementation
  12771. inline ClientImpl::ClientImpl(const std::string &host)
  12772. : ClientImpl(host, 80, std::string(), std::string()) {}
  12773. inline ClientImpl::ClientImpl(const std::string &host, int port)
  12774. : ClientImpl(host, port, std::string(), std::string()) {}
  12775. inline ClientImpl::ClientImpl(const std::string &host, int port,
  12776. const std::string &client_cert_path,
  12777. const std::string &client_key_path)
  12778. : host_(detail::escape_abstract_namespace_unix_domain(host)), port_(port),
  12779. client_cert_path_(client_cert_path), client_key_path_(client_key_path) {}
  12780. inline ClientImpl::~ClientImpl() {
  12781. // Wait until all the requests in flight are handled.
  12782. size_t retry_count = 10;
  12783. while (retry_count-- > 0) {
  12784. {
  12785. std::lock_guard<std::mutex> guard(socket_mutex_);
  12786. if (socket_requests_in_flight_ == 0) { break; }
  12787. }
  12788. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  12789. }
  12790. std::lock_guard<std::mutex> guard(socket_mutex_);
  12791. shutdown_socket(socket_);
  12792. close_socket(socket_);
  12793. }
  12794. inline bool ClientImpl::is_valid() const { return true; }
  12795. inline bool
  12796. ClientImpl::is_proxy_enabled_for_host(const std::string &host) const {
  12797. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  12798. if (no_proxy_entries_.empty()) { return true; }
  12799. // host_ is const so its normalized form is invariant; cache it. The
  12800. // cross-host path (setup_redirect_client passing next_host) re-normalizes.
  12801. if (host == host_) {
  12802. if (!host_normalized_valid_) {
  12803. host_normalized_ = detail::normalize_target(host_);
  12804. host_normalized_valid_ = true;
  12805. }
  12806. return !detail::host_matches_no_proxy(host_normalized_, no_proxy_entries_);
  12807. }
  12808. auto target = detail::normalize_target(host);
  12809. return !detail::host_matches_no_proxy(target, no_proxy_entries_);
  12810. }
  12811. inline socket_t ClientImpl::create_client_socket(Error &error) const {
  12812. if (is_proxy_enabled_for_host(host_)) {
  12813. return detail::create_client_socket(
  12814. proxy_host_, std::string(), proxy_port_, address_family_, tcp_nodelay_,
  12815. ipv6_v6only_, socket_options_, connection_timeout_sec_,
  12816. connection_timeout_usec_, read_timeout_sec_, read_timeout_usec_,
  12817. write_timeout_sec_, write_timeout_usec_, interface_, error);
  12818. }
  12819. // Check is custom IP or hostname specified for host_
  12820. std::string connect_host;
  12821. std::string ip;
  12822. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  12823. return detail::create_client_socket(
  12824. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  12825. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  12826. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12827. write_timeout_usec_, interface_, error);
  12828. }
  12829. inline bool ClientImpl::create_and_connect_socket(Socket &socket,
  12830. Error &error) {
  12831. auto sock = create_client_socket(error);
  12832. if (sock == INVALID_SOCKET) { return false; }
  12833. socket.sock = sock;
  12834. return true;
  12835. }
  12836. inline bool ClientImpl::ensure_socket_connection(Socket &socket, Error &error) {
  12837. return create_and_connect_socket(socket, error);
  12838. }
  12839. inline bool ClientImpl::setup_proxy_connection(
  12840. Socket & /*socket*/,
  12841. std::chrono::time_point<std::chrono::steady_clock> /*start_time*/,
  12842. Response & /*res*/, bool & /*success*/, Error & /*error*/) {
  12843. return true;
  12844. }
  12845. inline void ClientImpl::shutdown_ssl(Socket & /*socket*/,
  12846. bool /*shutdown_gracefully*/) {
  12847. // If there are any requests in flight from threads other than us, then it's
  12848. // a thread-unsafe race because individual ssl* objects are not thread-safe.
  12849. assert(socket_requests_in_flight_ == 0 ||
  12850. socket_requests_are_from_thread_ == std::this_thread::get_id());
  12851. }
  12852. inline void ClientImpl::shutdown_socket(Socket &socket) const {
  12853. if (socket.sock == INVALID_SOCKET) { return; }
  12854. detail::shutdown_socket(socket.sock);
  12855. }
  12856. inline void ClientImpl::close_socket(Socket &socket) {
  12857. // If there are requests in flight in another thread, usually closing
  12858. // the socket will be fine and they will simply receive an error when
  12859. // using the closed socket, but it is still a bug since rarely the OS
  12860. // may reassign the socket id to be used for a new socket, and then
  12861. // suddenly they will be operating on a live socket that is different
  12862. // than the one they intended!
  12863. assert(socket_requests_in_flight_ == 0 ||
  12864. socket_requests_are_from_thread_ == std::this_thread::get_id());
  12865. // It is also a bug if this happens while SSL is still active
  12866. #ifdef CPPHTTPLIB_SSL_ENABLED
  12867. assert(socket.ssl == nullptr);
  12868. #endif
  12869. if (socket.sock == INVALID_SOCKET) { return; }
  12870. detail::close_socket(socket.sock);
  12871. socket.sock = INVALID_SOCKET;
  12872. }
  12873. inline void ClientImpl::disconnect(bool gracefully) {
  12874. shutdown_ssl(socket_, gracefully);
  12875. shutdown_socket(socket_);
  12876. close_socket(socket_);
  12877. }
  12878. inline bool ClientImpl::read_response_line(Stream &strm, const Request &req,
  12879. Response &res,
  12880. bool skip_100_continue) const {
  12881. std::array<char, 2048> buf{};
  12882. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12883. if (!line_reader.getline()) { return false; }
  12884. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  12885. res.reason)) {
  12886. return req.method == "CONNECT";
  12887. }
  12888. // Ignore '100 Continue' (only when not using Expect: 100-continue explicitly)
  12889. while (skip_100_continue && res.status == StatusCode::Continue_100) {
  12890. if (!line_reader.getline()) { return false; } // CRLF
  12891. if (!line_reader.getline()) { return false; } // next response line
  12892. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  12893. res.reason)) {
  12894. return false;
  12895. }
  12896. }
  12897. return true;
  12898. }
  12899. inline bool ClientImpl::send(Request &req, Response &res, Error &error) {
  12900. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  12901. auto ret = send_(req, res, error);
  12902. if (error == Error::SSLPeerCouldBeClosed_) {
  12903. assert(!ret);
  12904. ret = send_(req, res, error);
  12905. // If still failing with SSLPeerCouldBeClosed_, convert to Read error
  12906. if (error == Error::SSLPeerCouldBeClosed_) { error = Error::Read; }
  12907. }
  12908. return ret;
  12909. }
  12910. inline bool ClientImpl::send_(Request &req, Response &res, Error &error) {
  12911. {
  12912. std::lock_guard<std::mutex> guard(socket_mutex_);
  12913. // Set this to false immediately - if it ever gets set to true by the end
  12914. // of the request, we know another thread instructed us to close the
  12915. // socket.
  12916. socket_should_be_closed_when_request_is_done_ = false;
  12917. auto is_alive = false;
  12918. if (socket_.is_open()) {
  12919. is_alive = detail::is_socket_alive(socket_.sock);
  12920. #ifdef CPPHTTPLIB_SSL_ENABLED
  12921. if (is_alive && is_ssl()) {
  12922. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  12923. is_alive = false;
  12924. }
  12925. }
  12926. #endif
  12927. if (!is_alive) {
  12928. // Peer seems gone — non-graceful shutdown to avoid SIGPIPE.
  12929. disconnect(/*gracefully=*/false);
  12930. }
  12931. }
  12932. if (!is_alive) {
  12933. if (!ensure_socket_connection(socket_, error)) {
  12934. output_error_log(error, &req);
  12935. return false;
  12936. }
  12937. {
  12938. auto success = true;
  12939. if (!setup_proxy_connection(socket_, req.start_time_, res, success,
  12940. error)) {
  12941. if (!success) { output_error_log(error, &req); }
  12942. return success;
  12943. }
  12944. }
  12945. }
  12946. // Mark the current socket as being in use so that it cannot be closed by
  12947. // anyone else while this request is ongoing, even though we will be
  12948. // releasing the mutex.
  12949. if (socket_requests_in_flight_ > 1) {
  12950. assert(socket_requests_are_from_thread_ == std::this_thread::get_id());
  12951. }
  12952. socket_requests_in_flight_ += 1;
  12953. socket_requests_are_from_thread_ = std::this_thread::get_id();
  12954. }
  12955. for (const auto &header : default_headers_) {
  12956. if (req.headers.find(header.first) == req.headers.end()) {
  12957. req.headers.insert(header);
  12958. }
  12959. }
  12960. auto ret = false;
  12961. auto close_connection = !keep_alive_;
  12962. auto se = detail::scope_exit([&]() {
  12963. // Briefly lock mutex in order to mark that a request is no longer ongoing
  12964. std::lock_guard<std::mutex> guard(socket_mutex_);
  12965. socket_requests_in_flight_ -= 1;
  12966. if (socket_requests_in_flight_ <= 0) {
  12967. assert(socket_requests_in_flight_ == 0);
  12968. socket_requests_are_from_thread_ = std::thread::id();
  12969. }
  12970. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  12971. !ret) {
  12972. disconnect(/*gracefully=*/true);
  12973. }
  12974. });
  12975. ret = process_socket(socket_, req.start_time_, [&](Stream &strm) {
  12976. return handle_request(strm, req, res, close_connection, error);
  12977. });
  12978. if (!ret) {
  12979. if (error == Error::Success) {
  12980. error = Error::Unknown;
  12981. output_error_log(error, &req);
  12982. }
  12983. }
  12984. return ret;
  12985. }
  12986. inline Result ClientImpl::send(const Request &req) {
  12987. auto req2 = req;
  12988. return send_(std::move(req2));
  12989. }
  12990. inline Result ClientImpl::send_(Request &&req) {
  12991. auto res = detail::make_unique<Response>();
  12992. auto error = Error::Success;
  12993. auto ret = send(req, *res, error);
  12994. #ifdef CPPHTTPLIB_SSL_ENABLED
  12995. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers),
  12996. last_ssl_error_, last_backend_error_};
  12997. #else
  12998. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers)};
  12999. #endif
  13000. }
  13001. inline void ClientImpl::prepare_default_headers(Request &r, bool for_stream,
  13002. const std::string &ct) {
  13003. (void)for_stream;
  13004. // Default headers are meant for the origin and may carry its credentials, so
  13005. // keep them off the CONNECT request the proxy reads.
  13006. if (r.method != "CONNECT") {
  13007. for (const auto &header : default_headers_) {
  13008. if (!r.has_header(header.first)) { r.headers.insert(header); }
  13009. }
  13010. }
  13011. // RFC 9110 5.3 recommends sending control data such as Host first, so
  13012. // prepend it rather than appending it after the caller's own fields.
  13013. if (!r.has_header("Host")) {
  13014. r.headers.emplace_front(
  13015. "Host", detail::make_default_host_header_value(host_, port_, is_ssl(),
  13016. address_family_));
  13017. }
  13018. if (!r.has_header("Accept")) { r.headers.emplace("Accept", "*/*"); }
  13019. if (!r.content_receiver) {
  13020. if (!r.has_header("Accept-Encoding")) {
  13021. std::string accept_encoding;
  13022. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  13023. accept_encoding = "br";
  13024. #endif
  13025. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  13026. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13027. accept_encoding += "gzip, deflate";
  13028. #endif
  13029. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  13030. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13031. accept_encoding += "zstd";
  13032. #endif
  13033. r.set_header("Accept-Encoding", accept_encoding);
  13034. }
  13035. detail::add_default_user_agent_header(r);
  13036. }
  13037. if (!r.body.empty()) {
  13038. if (!ct.empty() && !r.has_header("Content-Type")) {
  13039. r.headers.emplace("Content-Type", ct);
  13040. }
  13041. if (!r.has_header("Content-Length")) {
  13042. r.headers.emplace("Content-Length", std::to_string(r.body.size()));
  13043. }
  13044. }
  13045. }
  13046. inline ClientImpl::StreamHandle
  13047. ClientImpl::open_stream(const std::string &method, const std::string &path,
  13048. const Params &params, const Headers &headers,
  13049. const std::string &body,
  13050. const std::string &content_type) {
  13051. StreamHandle handle;
  13052. handle.response = detail::make_unique<Response>();
  13053. handle.error = Error::Success;
  13054. // Encode the target exactly like the buffered send path does, so that the
  13055. // same `path` produces the same request line through either API.
  13056. auto raw_query_path =
  13057. params.empty() ? path : append_query_params(path, params);
  13058. auto query_path = detail::encode_request_target(raw_query_path, path_encode_);
  13059. handle.connection_ = detail::make_unique<ClientConnection>();
  13060. {
  13061. std::lock_guard<std::mutex> guard(socket_mutex_);
  13062. auto is_alive = false;
  13063. if (socket_.is_open()) {
  13064. is_alive = detail::is_socket_alive(socket_.sock);
  13065. #ifdef CPPHTTPLIB_SSL_ENABLED
  13066. if (is_alive && is_ssl()) {
  13067. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13068. is_alive = false;
  13069. }
  13070. }
  13071. #endif
  13072. if (!is_alive) { disconnect(/*gracefully=*/false); }
  13073. }
  13074. if (!is_alive) {
  13075. if (!ensure_socket_connection(socket_, handle.error)) {
  13076. handle.response.reset();
  13077. return handle;
  13078. }
  13079. {
  13080. auto success = true;
  13081. auto start_time = std::chrono::steady_clock::now();
  13082. if (!setup_proxy_connection(socket_, start_time, *handle.response,
  13083. success, handle.error)) {
  13084. if (!success) { handle.response.reset(); }
  13085. return handle;
  13086. }
  13087. }
  13088. }
  13089. transfer_socket_ownership_to_handle(handle);
  13090. }
  13091. #ifdef CPPHTTPLIB_SSL_ENABLED
  13092. if (is_ssl() && handle.connection_->session) {
  13093. handle.socket_stream_ = detail::make_unique<detail::SSLSocketStream>(
  13094. handle.connection_->sock, handle.connection_->session,
  13095. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13096. write_timeout_usec_);
  13097. } else {
  13098. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13099. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13100. write_timeout_sec_, write_timeout_usec_);
  13101. }
  13102. #else
  13103. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13104. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13105. write_timeout_sec_, write_timeout_usec_);
  13106. #endif
  13107. handle.stream_ = handle.socket_stream_.get();
  13108. Request req;
  13109. req.method = method;
  13110. req.path = query_path;
  13111. req.headers = headers;
  13112. req.body = body;
  13113. prepare_default_headers(req, true, content_type);
  13114. auto &strm = *handle.stream_;
  13115. // Build the request line and headers in memory first, like write_request()
  13116. // does, so that a rejected header leaves nothing on the wire.
  13117. {
  13118. detail::BufferStream bstrm;
  13119. if (detail::write_request_line(bstrm, req.method, req.path) < 0) {
  13120. handle.error = Error::Write;
  13121. handle.response.reset();
  13122. return handle;
  13123. }
  13124. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13125. handle.error)) {
  13126. handle.response.reset();
  13127. return handle;
  13128. }
  13129. const auto &data = bstrm.get_buffer();
  13130. if (!detail::write_data(strm, data.data(), data.size())) {
  13131. handle.error = Error::Write;
  13132. handle.response.reset();
  13133. return handle;
  13134. }
  13135. }
  13136. if (!body.empty()) {
  13137. if (strm.write(body.data(), body.size()) < 0) {
  13138. handle.error = Error::Write;
  13139. handle.response.reset();
  13140. return handle;
  13141. }
  13142. }
  13143. if (!read_response_line(strm, req, *handle.response) ||
  13144. !detail::read_headers(strm, handle.response->headers)) {
  13145. handle.error = Error::Read;
  13146. handle.response.reset();
  13147. return handle;
  13148. }
  13149. // Same framing check as ClientImpl::process_request(). A HEAD or bodyless
  13150. // (204/304) response legitimately carries framing headers with no body.
  13151. if (method != "HEAD" &&
  13152. handle.response->status != StatusCode::NoContent_204 &&
  13153. handle.response->status != StatusCode::NotModified_304 &&
  13154. detail::has_conflicting_content_length(handle.response->headers)) {
  13155. handle.error = Error::Read;
  13156. handle.response.reset();
  13157. return handle;
  13158. }
  13159. handle.body_reader_.stream = handle.stream_;
  13160. handle.body_reader_.payload_max_length = payload_max_length_;
  13161. if (handle.response->has_header("Content-Length")) {
  13162. bool is_invalid = false;
  13163. auto content_length = detail::get_header_value_u64(
  13164. handle.response->headers, "Content-Length", 0, 0, is_invalid);
  13165. if (is_invalid) {
  13166. handle.error = Error::Read;
  13167. handle.response.reset();
  13168. return handle;
  13169. }
  13170. handle.body_reader_.has_content_length = true;
  13171. handle.body_reader_.content_length = content_length;
  13172. }
  13173. handle.body_reader_.chunked =
  13174. detail::is_chunked_transfer_encoding(handle.response->headers);
  13175. auto content_encoding = detail::get_combined_header_value(
  13176. handle.response->headers, "Content-Encoding");
  13177. if (!content_encoding.empty()) {
  13178. // Same policy as prepare_content_receiver(): reject a coding we know about
  13179. // but were not built with, pass an unrecognized one through as-is.
  13180. handle.decompressor_ = detail::create_decompressor(content_encoding);
  13181. if (!handle.decompressor_) {
  13182. if (detail::is_known_content_encoding(content_encoding)) {
  13183. handle.error = Error::UnsupportedContentEncoding;
  13184. handle.response.reset();
  13185. return handle;
  13186. }
  13187. } else if (!handle.decompressor_->is_valid()) {
  13188. handle.error = Error::Compression;
  13189. handle.response.reset();
  13190. return handle;
  13191. }
  13192. }
  13193. return handle;
  13194. }
  13195. inline ssize_t ClientImpl::StreamHandle::read(char *buf, size_t len) {
  13196. if (!is_valid() || !response) { return -1; }
  13197. if (decompressor_) { return read_with_decompression(buf, len); }
  13198. auto n = detail::read_body_content(stream_, body_reader_, buf, len);
  13199. if (n <= 0 && body_reader_.chunked && !trailers_parsed_ && stream_) {
  13200. trailers_parsed_ = true;
  13201. if (body_reader_.chunked_decoder) {
  13202. if (!body_reader_.chunked_decoder->parse_trailers_into(
  13203. response->trailers, response->headers)) {
  13204. return n;
  13205. }
  13206. } else {
  13207. detail::ChunkedDecoder dec(*stream_);
  13208. if (!dec.parse_trailers_into(response->trailers, response->headers)) {
  13209. return n;
  13210. }
  13211. }
  13212. }
  13213. return n;
  13214. }
  13215. inline ssize_t ClientImpl::StreamHandle::read_with_decompression(char *buf,
  13216. size_t len) {
  13217. if (decompress_offset_ < decompress_buffer_.size()) {
  13218. auto available = decompress_buffer_.size() - decompress_offset_;
  13219. auto to_copy = (std::min)(len, available);
  13220. std::memcpy(buf, decompress_buffer_.data() + decompress_offset_, to_copy);
  13221. decompress_offset_ += to_copy;
  13222. decompressed_bytes_read_ += to_copy;
  13223. return static_cast<ssize_t>(to_copy);
  13224. }
  13225. decompress_buffer_.clear();
  13226. decompress_offset_ = 0;
  13227. constexpr size_t kDecompressionBufferSize = 8192;
  13228. char compressed_buf[kDecompressionBufferSize];
  13229. while (true) {
  13230. auto n = detail::read_body_content(stream_, body_reader_, compressed_buf,
  13231. sizeof(compressed_buf));
  13232. if (n <= 0) { return n; }
  13233. bool decompress_ok = decompressor_->decompress(
  13234. compressed_buf, static_cast<size_t>(n),
  13235. [this](const char *data, size_t data_len) {
  13236. decompress_buffer_.append(data, data_len);
  13237. auto limit = body_reader_.payload_max_length;
  13238. return limit == 0 ||
  13239. decompressed_bytes_read_ + decompress_buffer_.size() <= limit;
  13240. });
  13241. if (!decompress_ok) {
  13242. body_reader_.last_error = Error::Read;
  13243. return -1;
  13244. }
  13245. if (!decompress_buffer_.empty()) { break; }
  13246. }
  13247. auto to_copy = (std::min)(len, decompress_buffer_.size());
  13248. std::memcpy(buf, decompress_buffer_.data(), to_copy);
  13249. decompress_offset_ = to_copy;
  13250. decompressed_bytes_read_ += to_copy;
  13251. return static_cast<ssize_t>(to_copy);
  13252. }
  13253. inline void ClientImpl::StreamHandle::parse_trailers_if_needed() {
  13254. if (!response || !stream_ || !body_reader_.chunked || trailers_parsed_) {
  13255. return;
  13256. }
  13257. trailers_parsed_ = true;
  13258. const auto bufsiz = 128;
  13259. char line_buf[bufsiz];
  13260. detail::stream_line_reader line_reader(*stream_, line_buf, bufsiz);
  13261. if (!line_reader.getline()) { return; }
  13262. if (!detail::parse_trailers(line_reader, response->trailers,
  13263. response->headers)) {
  13264. return;
  13265. }
  13266. }
  13267. namespace detail {
  13268. inline ChunkedDecoder::ChunkedDecoder(Stream &s) : strm(s) {}
  13269. inline ssize_t ChunkedDecoder::read_payload(char *buf, size_t len,
  13270. size_t &out_chunk_offset,
  13271. size_t &out_chunk_total) {
  13272. if (finished) { return 0; }
  13273. if (chunk_remaining == 0) {
  13274. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13275. if (!lr.getline()) { return -1; }
  13276. // Everything below is bounded by eol rather than by the buffer's NUL, so
  13277. // the line terminator is never mistaken for line content.
  13278. const char *eol = lr.ptr() + lr.size();
  13279. if (lr.end_with_crlf()) {
  13280. eol -= 2;
  13281. } else if (eol != lr.ptr() && eol[-1] == '\n') {
  13282. // Only reachable under CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR, where
  13283. // getline() ends the line on a bare LF. That LF is the terminator, so it
  13284. // has to come off here or the check below would reject the line.
  13285. eol -= 1;
  13286. }
  13287. // RFC 9112 §7.1: chunk-size = 1*HEXDIG
  13288. const char *p = lr.ptr();
  13289. int v = 0;
  13290. if (p == eol || !is_hex(*p, v)) { return -1; }
  13291. size_t chunk_len = 0;
  13292. constexpr size_t chunk_len_max = (std::numeric_limits<size_t>::max)();
  13293. for (; p < eol && is_hex(*p, v); ++p) {
  13294. if (chunk_len > (chunk_len_max >> 4)) { return -1; }
  13295. chunk_len = (chunk_len << 4) | static_cast<size_t>(v);
  13296. }
  13297. while (p < eol && is_space_or_tab(*p)) {
  13298. ++p;
  13299. }
  13300. // RFC 9112 §7.1.1: only a chunk-ext may sit between the size and the line
  13301. // terminator, and it is built from tokens and quoted-strings, so it never
  13302. // holds a CR, LF or any other control character. getline() reads up to the
  13303. // CRLF, so a bare LF left in here would be swallowed as extension text
  13304. // while an intermediary that ends the line on it delimits the chunks
  13305. // differently, and the two disagree on where the body ends (request
  13306. // smuggling).
  13307. if (p < eol && *p != ';') { return -1; }
  13308. for (; p < eol; ++p) {
  13309. if (!is_space_or_tab(*p) && !fields::is_field_vchar(*p)) { return -1; }
  13310. }
  13311. if (chunk_len == 0) {
  13312. chunk_remaining = 0;
  13313. finished = true;
  13314. out_chunk_offset = 0;
  13315. out_chunk_total = 0;
  13316. return 0;
  13317. }
  13318. chunk_remaining = chunk_len;
  13319. last_chunk_total = chunk_remaining;
  13320. last_chunk_offset = 0;
  13321. }
  13322. auto to_read = (std::min)(chunk_remaining, len);
  13323. auto n = strm.read(buf, to_read);
  13324. if (n <= 0) { return -1; }
  13325. auto offset_before = last_chunk_offset;
  13326. last_chunk_offset += static_cast<size_t>(n);
  13327. chunk_remaining -= static_cast<size_t>(n);
  13328. out_chunk_offset = offset_before;
  13329. out_chunk_total = last_chunk_total;
  13330. if (chunk_remaining == 0) {
  13331. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13332. if (!lr.getline()) { return -1; }
  13333. if (std::strcmp(lr.ptr(), "\r\n") != 0) { return -1; }
  13334. }
  13335. return n;
  13336. }
  13337. inline bool ChunkedDecoder::parse_trailers_into(Headers &dest,
  13338. const Headers &src_headers) {
  13339. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13340. if (!lr.getline()) { return false; }
  13341. return parse_trailers(lr, dest, src_headers);
  13342. }
  13343. } // namespace detail
  13344. inline void
  13345. ClientImpl::transfer_socket_ownership_to_handle(StreamHandle &handle) {
  13346. handle.connection_->sock = socket_.sock;
  13347. #ifdef CPPHTTPLIB_SSL_ENABLED
  13348. handle.connection_->session = socket_.ssl;
  13349. socket_.ssl = nullptr;
  13350. #endif
  13351. socket_.sock = INVALID_SOCKET;
  13352. }
  13353. inline bool ClientImpl::handle_request(Stream &strm, Request &req,
  13354. Response &res, bool close_connection,
  13355. Error &error) {
  13356. if (req.path.empty()) {
  13357. error = Error::Connection;
  13358. output_error_log(error, &req);
  13359. return false;
  13360. }
  13361. auto req_save = req;
  13362. bool ret;
  13363. if (!is_ssl() && is_proxy_enabled_for_host(host_)) {
  13364. auto req2 = req;
  13365. req2.path = "http://" +
  13366. detail::make_host_and_port_string(host_, port_, false) +
  13367. req.path;
  13368. ret = process_request(strm, req2, res, close_connection, error);
  13369. req = std::move(req2);
  13370. req.path = req_save.path;
  13371. } else {
  13372. ret = process_request(strm, req, res, close_connection, error);
  13373. }
  13374. if (!ret) { return false; }
  13375. if (detail::has_header_token(res.headers, "Connection", "close") ||
  13376. (res.version == "HTTP/1.0" && res.reason != "Connection established")) {
  13377. // NOTE: this requires a not-entirely-obvious chain of calls to be correct
  13378. // for this to be safe.
  13379. // This is safe to call because handle_request is only called by send_
  13380. // which locks the request mutex during the process. It would be a bug
  13381. // to call it from a different thread since it's a thread-safety issue
  13382. // to do these things to the socket if another thread is using the socket.
  13383. std::lock_guard<std::mutex> guard(socket_mutex_);
  13384. disconnect(/*gracefully=*/true);
  13385. }
  13386. if (300 < res.status && res.status < 400 && follow_location_) {
  13387. req = std::move(req_save);
  13388. // The client that followed the redirect has answered any challenge it
  13389. // could. Retrying below would sign another host's challenge and send it
  13390. // here.
  13391. return redirect(req, res, error);
  13392. }
  13393. #ifdef CPPHTTPLIB_SSL_ENABLED
  13394. if ((res.status == StatusCode::Unauthorized_401 ||
  13395. res.status == StatusCode::ProxyAuthenticationRequired_407) &&
  13396. req.authorization_count_ < 5) {
  13397. auto is_proxy = res.status == StatusCode::ProxyAuthenticationRequired_407;
  13398. // Only retry when the 407 actually came from a proxy hop: plain HTTP
  13399. // through an enabled proxy. HTTPS via CONNECT tunnels the 407 from the
  13400. // origin (#2457); direct/bypassed origins have no proxy hop at all.
  13401. if (is_proxy && !(!is_ssl() && is_proxy_enabled_for_host(host_))) {
  13402. return ret;
  13403. }
  13404. const auto &username =
  13405. is_proxy ? proxy_digest_auth_username_ : digest_auth_username_;
  13406. const auto &password =
  13407. is_proxy ? proxy_digest_auth_password_ : digest_auth_password_;
  13408. if (!username.empty() && !password.empty()) {
  13409. std::map<std::string, std::string> auth;
  13410. if (detail::parse_www_authenticate(res, auth, is_proxy)) {
  13411. Request new_req = req;
  13412. new_req.authorization_count_ += 1;
  13413. new_req.headers.erase(is_proxy ? "Proxy-Authorization"
  13414. : "Authorization");
  13415. new_req.headers.insert(detail::make_digest_authentication_header(
  13416. req, auth, new_req.authorization_count_, detail::random_string(10),
  13417. username, password, is_proxy));
  13418. Response new_res;
  13419. ret = send(new_req, new_res, error);
  13420. if (ret) { res = std::move(new_res); }
  13421. }
  13422. }
  13423. }
  13424. #endif
  13425. return ret;
  13426. }
  13427. inline bool ClientImpl::redirect(Request &req, Response &res, Error &error) {
  13428. if (req.redirect_count_ == 0) {
  13429. error = Error::ExceedRedirectCount;
  13430. output_error_log(error, &req);
  13431. return false;
  13432. }
  13433. auto location = res.get_header_value("location");
  13434. if (location.empty()) { return false; }
  13435. detail::UrlComponents uc;
  13436. if (!detail::parse_url(detail::resolve_relative_location(location, req.path),
  13437. uc)) {
  13438. return false;
  13439. }
  13440. // Only follow http/https redirects
  13441. if (!uc.scheme.empty() && uc.scheme != "http" && uc.scheme != "https") {
  13442. return false;
  13443. }
  13444. auto scheme = is_ssl() ? "https" : "http";
  13445. auto next_scheme = std::move(uc.scheme);
  13446. auto next_host = std::move(uc.host);
  13447. auto port_str = std::move(uc.port);
  13448. auto next_path = std::move(uc.path);
  13449. auto next_query = std::move(uc.query);
  13450. auto next_port = port_;
  13451. if (!port_str.empty()) {
  13452. if (!detail::parse_port(port_str, next_port)) { return false; }
  13453. } else if (!next_scheme.empty()) {
  13454. next_port = next_scheme == "https" ? 443 : 80;
  13455. }
  13456. if (next_scheme.empty()) { next_scheme = scheme; }
  13457. if (next_host.empty()) { next_host = host_; }
  13458. if (next_path.empty()) { next_path = "/"; }
  13459. auto path = std::move(next_path) + next_query;
  13460. // Same host redirect - use current client
  13461. if (next_scheme == scheme && next_host == host_ && next_port == port_) {
  13462. return detail::redirect(*this, req, res, path, location, error);
  13463. }
  13464. // Cross-host/scheme redirect - create new client with robust setup
  13465. return create_redirect_client(next_scheme, next_host, next_port, req, res,
  13466. path, location, error);
  13467. }
  13468. // New method for robust redirect client creation
  13469. inline bool ClientImpl::create_redirect_client(
  13470. const std::string &scheme, const std::string &host, int port, Request &req,
  13471. Response &res, const std::string &path, const std::string &location,
  13472. Error &error) {
  13473. // Determine if we need SSL
  13474. auto need_ssl = (scheme == "https");
  13475. // Clean up request headers that are host/client specific
  13476. // Remove headers that should not be carried over to new host
  13477. auto headers_to_remove = std::vector<std::string>{
  13478. "Host", "Proxy-Authorization", "Authorization", "Cookie", "Cookie2"};
  13479. for (const auto &header_name : headers_to_remove) {
  13480. auto it = req.headers.find(header_name);
  13481. while (it != req.headers.end()) {
  13482. it = req.headers.erase(it);
  13483. it = req.headers.find(header_name);
  13484. }
  13485. }
  13486. // Create appropriate client type and handle redirect
  13487. if (need_ssl) {
  13488. #ifdef CPPHTTPLIB_SSL_ENABLED
  13489. // Create SSL client for HTTPS redirect
  13490. SSLClient redirect_client(host, port);
  13491. // Setup basic client configuration first
  13492. setup_redirect_client(redirect_client);
  13493. redirect_client.enable_server_certificate_verification(
  13494. server_certificate_verification_);
  13495. redirect_client.enable_server_hostname_verification(
  13496. server_hostname_verification_);
  13497. redirect_client.system_ca_mode_ = system_ca_mode_;
  13498. // Transfer CA certificate to redirect client
  13499. redirect_client.load_ca_cert_store(ca_cert_pem_.c_str(),
  13500. ca_cert_pem_.size());
  13501. redirect_client.set_ca_cert_path(ca_cert_file_path_, ca_cert_dir_path_);
  13502. if (is_ssl()) {
  13503. auto &self = static_cast<SSLClient &>(*this);
  13504. // A store given to set_ca_cert_store() lives only in this client's
  13505. // context, so pass on the CA certificates the context holds.
  13506. if (self.ca_cert_store_set_) {
  13507. auto pem = detail::ca_certs_to_pem(self.ctx_);
  13508. redirect_client.load_ca_cert_store(pem.data(), pem.size());
  13509. }
  13510. redirect_client.set_session_verifier(self.session_verifier_);
  13511. if (self.server_certificate_verifier_) {
  13512. redirect_client.set_server_certificate_verifier(
  13513. self.server_certificate_verifier_);
  13514. }
  13515. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  13516. redirect_client.enable_windows_cert_verification_ =
  13517. self.enable_windows_cert_verification_;
  13518. #endif
  13519. }
  13520. // Client certificates are set through constructor for SSLClient
  13521. // NOTE: SSLClient constructor already takes client_cert_path and
  13522. // client_key_path so we need to create it properly if client certs are
  13523. // needed
  13524. // Execute the redirect
  13525. return detail::redirect(redirect_client, req, res, path, location, error);
  13526. #else
  13527. // SSL not supported - set appropriate error
  13528. error = Error::SSLConnection;
  13529. output_error_log(error, &req);
  13530. return false;
  13531. #endif
  13532. } else {
  13533. // HTTP redirect
  13534. ClientImpl redirect_client(host, port);
  13535. // Setup client with robust configuration
  13536. setup_redirect_client(redirect_client);
  13537. // Execute the redirect
  13538. return detail::redirect(redirect_client, req, res, path, location, error);
  13539. }
  13540. }
  13541. // New method for robust client setup (based on basic_manual_redirect.cpp
  13542. // logic)
  13543. template <typename ClientType>
  13544. inline void ClientImpl::setup_redirect_client(ClientType &client) {
  13545. // Copy basic settings first
  13546. client.set_connection_timeout(connection_timeout_sec_,
  13547. connection_timeout_usec_);
  13548. client.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  13549. client.set_write_timeout(write_timeout_sec_, write_timeout_usec_);
  13550. client.set_max_timeout(max_timeout_msec_);
  13551. if (has_payload_max_length_) {
  13552. client.set_payload_max_length(payload_max_length_);
  13553. }
  13554. client.set_keep_alive(keep_alive_);
  13555. client.set_follow_location(
  13556. true); // Enable redirects to handle multi-step redirects
  13557. client.set_path_encode(path_encode_);
  13558. client.set_compress(compress_);
  13559. client.set_decompress(decompress_);
  13560. // NOTE: Authentication credentials (basic auth, bearer token, digest auth)
  13561. // are intentionally NOT copied to the redirect client. Per RFC 9110 Section
  13562. // 15.4, credentials must not be forwarded when redirecting to a different
  13563. // host. This function is only called for cross-host redirects; same-host
  13564. // redirects are handled directly in ClientImpl::redirect().
  13565. // Copy the proxy configuration unconditionally; the per-target bypass is
  13566. // re-evaluated at send time, so a later hop to a non-bypassed host can
  13567. // still use the proxy.
  13568. client.no_proxy_entries_ = no_proxy_entries_;
  13569. if (!proxy_host_.empty() && proxy_port_ != -1) {
  13570. client.set_proxy(proxy_host_, proxy_port_);
  13571. if (!proxy_basic_auth_username_.empty() ||
  13572. !proxy_basic_auth_password_.empty()) {
  13573. client.set_proxy_basic_auth(proxy_basic_auth_username_,
  13574. proxy_basic_auth_password_);
  13575. }
  13576. if (!proxy_bearer_token_auth_token_.empty()) {
  13577. client.set_proxy_bearer_token_auth(proxy_bearer_token_auth_token_);
  13578. }
  13579. #ifdef CPPHTTPLIB_SSL_ENABLED
  13580. if (!proxy_digest_auth_username_.empty()) {
  13581. client.set_proxy_digest_auth(proxy_digest_auth_username_,
  13582. proxy_digest_auth_password_);
  13583. }
  13584. #endif
  13585. }
  13586. // Copy network and socket settings
  13587. client.addr_map_ = addr_map_;
  13588. client.set_address_family(address_family_);
  13589. client.set_tcp_nodelay(tcp_nodelay_);
  13590. client.set_ipv6_v6only(ipv6_v6only_);
  13591. if (socket_options_) { client.set_socket_options(socket_options_); }
  13592. if (!interface_.empty()) { client.set_interface(interface_); }
  13593. // Copy logging and headers
  13594. if (logger_) { client.set_logger(logger_); }
  13595. if (error_logger_) { client.set_error_logger(error_logger_); }
  13596. // NOTE: DO NOT copy default_headers_ as they may contain stale Host headers
  13597. // Each new client should generate its own headers based on its target host
  13598. }
  13599. inline bool ClientImpl::write_content_with_provider(Stream &strm,
  13600. const Request &req,
  13601. Error &error) const {
  13602. auto is_shutting_down = []() { return false; };
  13603. if (req.is_chunked_content_provider_) {
  13604. auto compressor = compress_ ? detail::create_compressor().first
  13605. : std::unique_ptr<detail::compressor>();
  13606. if (!compressor) {
  13607. compressor = detail::make_unique<detail::nocompressor>();
  13608. }
  13609. return detail::write_content_chunked(strm, req.content_provider_,
  13610. is_shutting_down, *compressor, error);
  13611. } else {
  13612. return detail::write_content_with_progress(
  13613. strm, req.content_provider_, 0, req.content_length_, is_shutting_down,
  13614. req.upload_progress, error);
  13615. }
  13616. }
  13617. inline bool ClientImpl::write_request(Stream &strm, Request &req,
  13618. bool close_connection, Error &error,
  13619. bool skip_body, bool &rejected_locally) {
  13620. rejected_locally = false;
  13621. // Prepare additional headers
  13622. if (close_connection) {
  13623. if (!req.has_header("Connection")) {
  13624. req.set_header("Connection", "close");
  13625. }
  13626. }
  13627. std::string ct_for_defaults;
  13628. if (!req.has_header("Content-Type") && !req.body.empty()) {
  13629. ct_for_defaults = "text/plain";
  13630. }
  13631. prepare_default_headers(req, false, ct_for_defaults);
  13632. if (req.body.empty()) {
  13633. if (req.content_provider_) {
  13634. if (!req.is_chunked_content_provider_) {
  13635. if (!req.has_header("Content-Length")) {
  13636. auto length = std::to_string(req.content_length_);
  13637. req.set_header("Content-Length", length);
  13638. }
  13639. }
  13640. } else {
  13641. if (req.method == "POST" || req.method == "PUT" ||
  13642. req.method == "PATCH") {
  13643. req.set_header("Content-Length", "0");
  13644. }
  13645. }
  13646. }
  13647. // A CONNECT request is read by the proxy; everything sent through the tunnel
  13648. // it opens is read by the origin. Each credential goes only to its own hop.
  13649. auto is_connect = req.method == "CONNECT";
  13650. if (!is_connect && !req.has_header("Authorization")) {
  13651. if (!basic_auth_password_.empty() || !basic_auth_username_.empty()) {
  13652. req.headers.insert(make_basic_authentication_header(
  13653. basic_auth_username_, basic_auth_password_, false));
  13654. } else if (!bearer_token_auth_token_.empty()) {
  13655. req.headers.insert(make_bearer_token_authentication_header(
  13656. bearer_token_auth_token_, false));
  13657. }
  13658. }
  13659. // Proxy-Authorization is only sent when the proxy reads this message —
  13660. // otherwise NO_PROXY-matched requests, and requests inside a TLS tunnel,
  13661. // would leak proxy credentials to the destination server.
  13662. if (is_proxy_enabled_for_host(host_) && (!is_ssl() || is_connect)) {
  13663. if ((!proxy_basic_auth_username_.empty() ||
  13664. !proxy_basic_auth_password_.empty()) &&
  13665. !req.has_header("Proxy-Authorization")) {
  13666. req.headers.insert(make_basic_authentication_header(
  13667. proxy_basic_auth_username_, proxy_basic_auth_password_, true));
  13668. }
  13669. if (!proxy_bearer_token_auth_token_.empty() &&
  13670. !req.has_header("Proxy-Authorization")) {
  13671. req.headers.insert(make_bearer_token_authentication_header(
  13672. proxy_bearer_token_auth_token_, true));
  13673. }
  13674. }
  13675. // Request line and headers
  13676. {
  13677. detail::BufferStream bstrm;
  13678. // Extract the query from req.path. The encoding itself is delegated to
  13679. // `encode_request_target`; the raw query is still needed here to decide
  13680. // between populating `req.params` from it and falling back to building a
  13681. // query out of caller-supplied `req.params`.
  13682. auto query_pos = req.path.find('?');
  13683. auto query_part = query_pos == std::string::npos
  13684. ? std::string()
  13685. : req.path.substr(query_pos + 1);
  13686. auto path_with_query =
  13687. detail::encode_request_target(req.path, path_encode_);
  13688. if (!query_part.empty()) {
  13689. // The query already came in through `req.path`; still populate
  13690. // `req.params` for handlers/users who read them.
  13691. detail::parse_query_text(query_part, req.params);
  13692. } else if (!req.params.empty()) {
  13693. // No query in `req.path`; build one from `req.params` so existing
  13694. // callers that pass `Params` separately continue to work.
  13695. path_with_query = append_query_params(path_with_query, req.params);
  13696. }
  13697. // Write request line and headers
  13698. if (detail::write_request_line(bstrm, req.method, path_with_query) < 0) {
  13699. // A rejected method (not a token, e.g. carrying CR/LF) or target (e.g.
  13700. // CR/LF in a caller-supplied path under set_path_encode(false)) must
  13701. // fail the request cleanly instead of emitting a request-line-less,
  13702. // header-injecting request.
  13703. error = Error::Write;
  13704. rejected_locally = true;
  13705. output_error_log(error, &req);
  13706. return false;
  13707. }
  13708. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13709. error)) {
  13710. rejected_locally = true;
  13711. output_error_log(error, &req);
  13712. return false;
  13713. }
  13714. // Flush buffer
  13715. auto &data = bstrm.get_buffer();
  13716. if (!detail::write_data(strm, data.data(), data.size())) {
  13717. error = Error::Write;
  13718. output_error_log(error, &req);
  13719. return false;
  13720. }
  13721. }
  13722. // After sending request line and headers, wait briefly for an early server
  13723. // response (e.g. 4xx) and avoid sending a potentially large request body
  13724. // unnecessarily. This workaround is only enabled on Windows because Unix
  13725. // platforms surface write errors (EPIPE) earlier; on Windows kernel send
  13726. // buffering can accept large writes even when the peer already responded.
  13727. // Check the stream first (which covers SSL via `is_readable()`), then
  13728. // fall back to select on the socket. Only perform the wait for very large
  13729. // request bodies to avoid interfering with normal small requests and
  13730. // reduce side-effects. Poll briefly (up to 50ms as default) for an early
  13731. // response. Skip this check when using Expect: 100-continue, as the protocol
  13732. // handles early responses properly.
  13733. #if defined(_WIN32)
  13734. if (!skip_body &&
  13735. req.body.size() > CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD &&
  13736. req.path.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  13737. auto start = std::chrono::high_resolution_clock::now();
  13738. for (;;) {
  13739. // Prefer socket-level readiness to avoid SSL_pending() false-positives
  13740. // from SSL internals. If the underlying socket is readable, assume an
  13741. // early response may be present.
  13742. auto sock = strm.socket();
  13743. if (sock != INVALID_SOCKET && detail::select_read(sock, 0, 0) > 0) {
  13744. return false;
  13745. }
  13746. // Fallback to stream-level check for non-socket streams or when the
  13747. // socket isn't reporting readable. Avoid using `is_readable()` for
  13748. // SSL, since `SSL_pending()` may report buffered records that do not
  13749. // indicate a complete application-level response yet.
  13750. if (!is_ssl() && strm.is_readable()) { return false; }
  13751. auto now = std::chrono::high_resolution_clock::now();
  13752. auto elapsed =
  13753. std::chrono::duration_cast<std::chrono::milliseconds>(now - start)
  13754. .count();
  13755. if (elapsed >= CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND) {
  13756. break;
  13757. }
  13758. std::this_thread::sleep_for(std::chrono::milliseconds(1));
  13759. }
  13760. }
  13761. #endif
  13762. // Body
  13763. if (skip_body) { return true; }
  13764. return write_request_body(strm, req, error);
  13765. }
  13766. inline bool ClientImpl::write_request_body(Stream &strm, Request &req,
  13767. Error &error) {
  13768. if (req.body.empty()) {
  13769. return write_content_with_provider(strm, req, error);
  13770. }
  13771. if (req.upload_progress) {
  13772. auto body_size = req.body.size();
  13773. size_t written = 0;
  13774. auto data = req.body.data();
  13775. while (written < body_size) {
  13776. size_t to_write = (std::min)(CPPHTTPLIB_SEND_BUFSIZ, body_size - written);
  13777. if (!detail::write_data(strm, data + written, to_write)) {
  13778. error = Error::Write;
  13779. output_error_log(error, &req);
  13780. return false;
  13781. }
  13782. written += to_write;
  13783. if (!req.upload_progress(written, body_size)) {
  13784. error = Error::Canceled;
  13785. output_error_log(error, &req);
  13786. return false;
  13787. }
  13788. }
  13789. } else {
  13790. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  13791. error = Error::Write;
  13792. output_error_log(error, &req);
  13793. return false;
  13794. }
  13795. }
  13796. return true;
  13797. }
  13798. inline std::unique_ptr<Response>
  13799. ClientImpl::send_with_content_provider_and_receiver(
  13800. Request &req, const char *body, size_t content_length,
  13801. ContentProvider content_provider,
  13802. ContentProviderWithoutLength content_provider_without_length,
  13803. const std::string &content_type, ContentReceiver content_receiver,
  13804. Error &error) {
  13805. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  13806. auto enc = compress_
  13807. ? detail::create_compressor()
  13808. : std::pair<std::unique_ptr<detail::compressor>, const char *>(
  13809. nullptr, nullptr);
  13810. if (enc.second) { req.set_header("Content-Encoding", enc.second); }
  13811. if (enc.first && !content_provider_without_length) {
  13812. auto &compressor = enc.first;
  13813. if (content_provider) {
  13814. auto ok = true;
  13815. auto finished = false;
  13816. size_t offset = 0;
  13817. DataSink data_sink;
  13818. data_sink.write = [&](const char *data, size_t data_len) -> bool {
  13819. if (ok) {
  13820. auto last = offset + data_len == content_length;
  13821. auto ret = compressor->compress(
  13822. data, data_len, last,
  13823. [&](const char *compressed_data, size_t compressed_data_len) {
  13824. req.body.append(compressed_data, compressed_data_len);
  13825. return true;
  13826. });
  13827. if (ret) {
  13828. offset += data_len;
  13829. } else {
  13830. ok = false;
  13831. }
  13832. }
  13833. return ok;
  13834. };
  13835. // As in detail::write_content_with_progress(): the body is framed by
  13836. // content_length, so a provider that finishes early has truncated it.
  13837. // Stop and report that instead of calling the provider forever.
  13838. data_sink.done = [&]() { finished = true; };
  13839. while (ok && !finished && offset < content_length) {
  13840. if (!content_provider(offset, content_length - offset, data_sink)) {
  13841. error = Error::Canceled;
  13842. output_error_log(error, &req);
  13843. return nullptr;
  13844. }
  13845. }
  13846. // A short body here means either the provider stopped early or the
  13847. // compressor gave up. The branch below reports a failing compressor as
  13848. // Error::Compression, so keep the two distinguishable.
  13849. if (offset < content_length) {
  13850. error = ok ? Error::Write : Error::Compression;
  13851. output_error_log(error, &req);
  13852. return nullptr;
  13853. }
  13854. } else {
  13855. if (!compressor->compress(body, content_length, true,
  13856. [&](const char *data, size_t data_len) {
  13857. req.body.append(data, data_len);
  13858. return true;
  13859. })) {
  13860. error = Error::Compression;
  13861. output_error_log(error, &req);
  13862. return nullptr;
  13863. }
  13864. }
  13865. } else {
  13866. if (content_provider) {
  13867. req.content_length_ = content_length;
  13868. req.content_provider_ = std::move(content_provider);
  13869. req.is_chunked_content_provider_ = false;
  13870. } else if (content_provider_without_length) {
  13871. req.content_length_ = 0;
  13872. req.content_provider_ = detail::ContentProviderAdapter(
  13873. std::move(content_provider_without_length));
  13874. req.is_chunked_content_provider_ = true;
  13875. req.set_header("Transfer-Encoding", "chunked");
  13876. } else {
  13877. req.body.assign(body, content_length);
  13878. }
  13879. }
  13880. if (content_receiver) {
  13881. req.content_receiver =
  13882. [content_receiver](const char *data, size_t data_length,
  13883. size_t /*offset*/, size_t /*total_length*/) {
  13884. return content_receiver(data, data_length);
  13885. };
  13886. }
  13887. auto res = detail::make_unique<Response>();
  13888. return send(req, *res, error) ? std::move(res) : nullptr;
  13889. }
  13890. inline Result ClientImpl::send_with_content_provider_and_receiver(
  13891. const std::string &method, const std::string &path, const Headers &headers,
  13892. const char *body, size_t content_length, ContentProvider content_provider,
  13893. ContentProviderWithoutLength content_provider_without_length,
  13894. const std::string &content_type, ContentReceiver content_receiver,
  13895. UploadProgress progress) {
  13896. Request req;
  13897. req.method = method;
  13898. req.headers = headers;
  13899. req.path = path;
  13900. req.upload_progress = std::move(progress);
  13901. if (max_timeout_msec_ > 0) {
  13902. req.start_time_ = std::chrono::steady_clock::now();
  13903. }
  13904. auto error = Error::Success;
  13905. auto res = send_with_content_provider_and_receiver(
  13906. req, body, content_length, std::move(content_provider),
  13907. std::move(content_provider_without_length), content_type,
  13908. std::move(content_receiver), error);
  13909. #ifdef CPPHTTPLIB_SSL_ENABLED
  13910. return Result{std::move(res), error, std::move(req.headers), last_ssl_error_,
  13911. last_backend_error_};
  13912. #else
  13913. return Result{std::move(res), error, std::move(req.headers)};
  13914. #endif
  13915. }
  13916. inline void ClientImpl::output_log(const Request &req,
  13917. const Response &res) const {
  13918. if (logger_) {
  13919. std::lock_guard<std::mutex> guard(logger_mutex_);
  13920. logger_(req, res);
  13921. }
  13922. }
  13923. inline void ClientImpl::output_error_log(const Error &err,
  13924. const Request *req) const {
  13925. if (error_logger_) {
  13926. std::lock_guard<std::mutex> guard(logger_mutex_);
  13927. error_logger_(err, req);
  13928. }
  13929. }
  13930. inline bool ClientImpl::process_request(Stream &strm, Request &req,
  13931. Response &res, bool close_connection,
  13932. Error &error) {
  13933. // Auto-add Expect: 100-continue for large bodies
  13934. if (CPPHTTPLIB_EXPECT_100_THRESHOLD > 0 && !req.has_header("Expect")) {
  13935. auto body_size = req.body.empty() ? req.content_length_ : req.body.size();
  13936. if (body_size >= CPPHTTPLIB_EXPECT_100_THRESHOLD) {
  13937. req.set_header("Expect", "100-continue");
  13938. }
  13939. }
  13940. // Check for Expect: 100-continue
  13941. auto expect_100_continue =
  13942. detail::has_header_token(req.headers, "Expect", "100-continue");
  13943. // Send request (skip body if using Expect: 100-continue)
  13944. auto rejected_locally = false;
  13945. auto write_request_success =
  13946. write_request(strm, req, close_connection, error, expect_100_continue,
  13947. rejected_locally);
  13948. // A failed write normally still reads the response below, since the server
  13949. // may have answered early (e.g. 413/414) and closed while the body was being
  13950. // sent. A request rejected before any byte reached the socket gets no such
  13951. // response, and waiting for one would block until the read timeout.
  13952. if (rejected_locally) { return false; }
  13953. #ifdef CPPHTTPLIB_SSL_ENABLED
  13954. if (is_ssl() && !expect_100_continue) {
  13955. auto is_proxy_enabled = is_proxy_enabled_for_host(host_);
  13956. if (!is_proxy_enabled) {
  13957. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13958. error = Error::SSLPeerCouldBeClosed_;
  13959. output_error_log(error, &req);
  13960. return false;
  13961. }
  13962. }
  13963. }
  13964. #endif
  13965. // Handle Expect: 100-continue.
  13966. //
  13967. // Wait for an interim/early response by attempting to read the status line
  13968. // under a short timeout, instead of trusting raw socket readability. Over
  13969. // TLS, post-handshake records (e.g. session tickets) make the socket
  13970. // readable without any HTTP response being available; relying on
  13971. // `select_read` there caused the body to be withheld forever and the
  13972. // request to fail with `Read` (#2458). If no status line arrives within the
  13973. // timeout, send the body anyway (matching curl's behavior).
  13974. auto status_line_read = false;
  13975. if (expect_100_continue && write_request_success) {
  13976. if (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND > 0) {
  13977. time_t sec = CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND / 1000;
  13978. time_t usec = (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND % 1000) * 1000;
  13979. strm.set_read_timeout(sec, usec);
  13980. status_line_read = read_response_line(strm, req, res, false);
  13981. strm.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  13982. }
  13983. if (!status_line_read) {
  13984. // No interim response within the timeout: send the body and handle the
  13985. // response as usual.
  13986. if (!write_request_body(strm, req, error)) { return false; }
  13987. expect_100_continue = false; // Switch to normal response handling
  13988. }
  13989. }
  13990. // Receive response and headers
  13991. // When using Expect: 100-continue, don't auto-skip `100 Continue` response
  13992. if ((!status_line_read &&
  13993. !read_response_line(strm, req, res, !expect_100_continue)) ||
  13994. !detail::read_headers(strm, res.headers)) {
  13995. if (write_request_success) { error = Error::Read; }
  13996. output_error_log(error, &req);
  13997. return false;
  13998. }
  13999. if (!write_request_success) { return false; }
  14000. // Handle Expect: 100-continue response
  14001. if (expect_100_continue) {
  14002. if (res.status == StatusCode::Continue_100) {
  14003. // Server accepted, send the body
  14004. if (!write_request_body(strm, req, error)) { return false; }
  14005. // Read the actual response
  14006. res.headers.clear();
  14007. res.body.clear();
  14008. if (!read_response_line(strm, req, res) ||
  14009. !detail::read_headers(strm, res.headers)) {
  14010. error = Error::Read;
  14011. output_error_log(error, &req);
  14012. return false;
  14013. }
  14014. }
  14015. // If not 100 Continue, server returned an error; proceed with that response
  14016. }
  14017. // Body
  14018. if ((res.status != StatusCode::NoContent_204) && req.method != "HEAD" &&
  14019. req.method != "CONNECT") {
  14020. // Reject ambiguous framing (RFC 9112 §6.3). Unlike a request, a response
  14021. // whose final transfer coding is not chunked is not ambiguous: its body
  14022. // runs until the server closes the connection, so it is not rejected.
  14023. // HEAD/204 are excluded above and a 304 carries no body.
  14024. if (res.status != StatusCode::NotModified_304 &&
  14025. detail::has_conflicting_content_length(res.headers)) {
  14026. error = Error::Read;
  14027. output_error_log(error, &req);
  14028. return false;
  14029. }
  14030. auto redirect = 300 < res.status && res.status < 400 &&
  14031. res.status != StatusCode::NotModified_304 &&
  14032. follow_location_;
  14033. if (req.response_handler && !redirect) {
  14034. if (!req.response_handler(res)) {
  14035. error = Error::Canceled;
  14036. output_error_log(error, &req);
  14037. return false;
  14038. }
  14039. }
  14040. auto out =
  14041. req.content_receiver
  14042. ? static_cast<ContentReceiverWithProgress>(
  14043. [&](const char *buf, size_t n, size_t off, size_t len) {
  14044. if (redirect) { return true; }
  14045. auto ret = req.content_receiver(buf, n, off, len);
  14046. if (!ret) {
  14047. error = Error::Canceled;
  14048. output_error_log(error, &req);
  14049. }
  14050. return ret;
  14051. })
  14052. : static_cast<ContentReceiverWithProgress>(
  14053. [&](const char *buf, size_t n, size_t /*off*/,
  14054. size_t /*len*/) {
  14055. assert(res.body.size() + n <= res.body.max_size());
  14056. if (payload_max_length_ > 0 &&
  14057. (res.body.size() >= payload_max_length_ ||
  14058. n > payload_max_length_ - res.body.size())) {
  14059. return false;
  14060. }
  14061. res.body.append(buf, n);
  14062. return true;
  14063. });
  14064. auto progress = [&](size_t current, size_t total) {
  14065. if (!req.download_progress || redirect) { return true; }
  14066. auto ret = req.download_progress(current, total);
  14067. if (!ret) {
  14068. error = Error::Canceled;
  14069. output_error_log(error, &req);
  14070. }
  14071. return ret;
  14072. };
  14073. if (res.has_header("Content-Length")) {
  14074. if (!req.content_receiver) {
  14075. auto len = res.get_header_value_u64("Content-Length");
  14076. if (len > res.body.max_size()) {
  14077. error = Error::Read;
  14078. output_error_log(error, &req);
  14079. return false;
  14080. }
  14081. // Cap the reservation by payload_max_length_ to avoid OOM when a
  14082. // hostile or malformed server sends an enormous Content-Length.
  14083. // The actual body read below is bounded by payload_max_length_,
  14084. // so reserving more than that is never useful.
  14085. auto reserve_len = static_cast<size_t>(len);
  14086. if (payload_max_length_ > 0 && reserve_len > payload_max_length_) {
  14087. reserve_len = payload_max_length_;
  14088. }
  14089. res.body.reserve(reserve_len);
  14090. }
  14091. }
  14092. if (res.status != StatusCode::NotModified_304) {
  14093. auto content_status = 0;
  14094. auto max_length = (!has_payload_max_length_ && req.content_receiver)
  14095. ? (std::numeric_limits<size_t>::max)()
  14096. : payload_max_length_;
  14097. if (!detail::read_content(strm, res, max_length, content_status,
  14098. std::move(progress), std::move(out),
  14099. decompress_)) {
  14100. if (error != Error::Canceled) {
  14101. // Tell the caller apart from a plain read failure when the body could
  14102. // not be decoded because of its Content-Encoding.
  14103. switch (content_status) {
  14104. case StatusCode::UnsupportedMediaType_415:
  14105. error = Error::UnsupportedContentEncoding;
  14106. break;
  14107. case StatusCode::InternalServerError_500:
  14108. error = Error::Compression;
  14109. break;
  14110. default: error = Error::Read; break;
  14111. }
  14112. }
  14113. output_error_log(error, &req);
  14114. return false;
  14115. }
  14116. }
  14117. }
  14118. // Log
  14119. output_log(req, res);
  14120. return true;
  14121. }
  14122. inline ContentProviderWithoutLength ClientImpl::get_multipart_content_provider(
  14123. const std::string &boundary, const UploadFormDataItems &items,
  14124. const FormDataProviderItems &provider_items) const {
  14125. size_t cur_item = 0;
  14126. size_t cur_start = 0;
  14127. // cur_item and cur_start are copied to within the std::function and
  14128. // maintain state between successive calls
  14129. return [&, cur_item, cur_start](size_t offset,
  14130. DataSink &sink) mutable -> bool {
  14131. if (!offset && !items.empty()) {
  14132. sink.os << detail::serialize_multipart_formdata(items, boundary, false);
  14133. return true;
  14134. } else if (cur_item < provider_items.size()) {
  14135. if (!cur_start) {
  14136. const auto &begin = detail::serialize_multipart_formdata_item_begin(
  14137. provider_items[cur_item], boundary);
  14138. offset += begin.size();
  14139. cur_start = offset;
  14140. sink.os << begin;
  14141. }
  14142. DataSink cur_sink;
  14143. auto has_data = true;
  14144. cur_sink.write = sink.write;
  14145. // Forward is_writable so a provider item asking whether it may keep
  14146. // going gets the outer sink's answer rather than the default `true`.
  14147. cur_sink.is_writable = sink.is_writable;
  14148. cur_sink.done = [&]() { has_data = false; };
  14149. if (!provider_items[cur_item].provider(offset - cur_start, cur_sink)) {
  14150. return false;
  14151. }
  14152. if (!has_data) {
  14153. sink.os << detail::serialize_multipart_formdata_item_end();
  14154. cur_item++;
  14155. cur_start = 0;
  14156. }
  14157. return true;
  14158. } else {
  14159. sink.os << detail::serialize_multipart_formdata_finish(boundary);
  14160. sink.done();
  14161. return true;
  14162. }
  14163. };
  14164. }
  14165. inline bool ClientImpl::process_socket(
  14166. const Socket &socket,
  14167. std::chrono::time_point<std::chrono::steady_clock> start_time,
  14168. std::function<bool(Stream &strm)> callback) {
  14169. return detail::process_client_socket(
  14170. socket.sock, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  14171. write_timeout_usec_, max_timeout_msec_, start_time, std::move(callback));
  14172. }
  14173. inline bool ClientImpl::is_ssl() const { return false; }
  14174. inline Result ClientImpl::Get(const std::string &path,
  14175. DownloadProgress progress) {
  14176. return Get(path, Headers(), std::move(progress));
  14177. }
  14178. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14179. DownloadProgress progress) {
  14180. return Get(path, params, Headers(), std::move(progress));
  14181. }
  14182. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14183. const Headers &headers,
  14184. DownloadProgress progress) {
  14185. if (params.empty()) { return Get(path, headers); }
  14186. std::string path_with_query = append_query_params(path, params);
  14187. return Get(path_with_query, headers, std::move(progress));
  14188. }
  14189. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14190. DownloadProgress progress) {
  14191. Request req;
  14192. req.method = "GET";
  14193. req.path = path;
  14194. req.headers = headers;
  14195. req.download_progress = std::move(progress);
  14196. if (max_timeout_msec_ > 0) {
  14197. req.start_time_ = std::chrono::steady_clock::now();
  14198. }
  14199. return send_(std::move(req));
  14200. }
  14201. inline Result ClientImpl::Get(const std::string &path,
  14202. ContentReceiver content_receiver,
  14203. DownloadProgress progress) {
  14204. return Get(path, Headers(), nullptr, std::move(content_receiver),
  14205. std::move(progress));
  14206. }
  14207. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14208. ContentReceiver content_receiver,
  14209. DownloadProgress progress) {
  14210. return Get(path, headers, nullptr, std::move(content_receiver),
  14211. std::move(progress));
  14212. }
  14213. inline Result ClientImpl::Get(const std::string &path,
  14214. ResponseHandler response_handler,
  14215. ContentReceiver content_receiver,
  14216. DownloadProgress progress) {
  14217. return Get(path, Headers(), std::move(response_handler),
  14218. std::move(content_receiver), std::move(progress));
  14219. }
  14220. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14221. ResponseHandler response_handler,
  14222. ContentReceiver content_receiver,
  14223. DownloadProgress progress) {
  14224. Request req;
  14225. req.method = "GET";
  14226. req.path = path;
  14227. req.headers = headers;
  14228. req.response_handler = std::move(response_handler);
  14229. req.content_receiver =
  14230. [content_receiver](const char *data, size_t data_length,
  14231. size_t /*offset*/, size_t /*total_length*/) {
  14232. return content_receiver(data, data_length);
  14233. };
  14234. req.download_progress = std::move(progress);
  14235. if (max_timeout_msec_ > 0) {
  14236. req.start_time_ = std::chrono::steady_clock::now();
  14237. }
  14238. return send_(std::move(req));
  14239. }
  14240. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14241. const Headers &headers,
  14242. ContentReceiver content_receiver,
  14243. DownloadProgress progress) {
  14244. return Get(path, params, headers, nullptr, std::move(content_receiver),
  14245. std::move(progress));
  14246. }
  14247. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14248. const Headers &headers,
  14249. ResponseHandler response_handler,
  14250. ContentReceiver content_receiver,
  14251. DownloadProgress progress) {
  14252. if (params.empty()) {
  14253. return Get(path, headers, std::move(response_handler),
  14254. std::move(content_receiver), std::move(progress));
  14255. }
  14256. std::string path_with_query = append_query_params(path, params);
  14257. return Get(path_with_query, headers, std::move(response_handler),
  14258. std::move(content_receiver), std::move(progress));
  14259. }
  14260. inline Result ClientImpl::Head(const std::string &path) {
  14261. return Head(path, Headers());
  14262. }
  14263. inline Result ClientImpl::Head(const std::string &path,
  14264. const Headers &headers) {
  14265. Request req;
  14266. req.method = "HEAD";
  14267. req.headers = headers;
  14268. req.path = path;
  14269. if (max_timeout_msec_ > 0) {
  14270. req.start_time_ = std::chrono::steady_clock::now();
  14271. }
  14272. return send_(std::move(req));
  14273. }
  14274. inline Result ClientImpl::Post(const std::string &path) {
  14275. return Post(path, std::string(), std::string());
  14276. }
  14277. inline Result ClientImpl::Post(const std::string &path,
  14278. const Headers &headers) {
  14279. return Post(path, headers, nullptr, 0, std::string());
  14280. }
  14281. inline Result ClientImpl::Post(const std::string &path, const char *body,
  14282. size_t content_length,
  14283. const std::string &content_type,
  14284. UploadProgress progress) {
  14285. return Post(path, Headers(), body, content_length, content_type, progress);
  14286. }
  14287. inline Result ClientImpl::Post(const std::string &path, const std::string &body,
  14288. const std::string &content_type,
  14289. UploadProgress progress) {
  14290. return Post(path, Headers(), body, content_type, progress);
  14291. }
  14292. inline Result ClientImpl::Post(const std::string &path, const Params &params) {
  14293. return Post(path, Headers(), params);
  14294. }
  14295. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14296. ContentProvider content_provider,
  14297. const std::string &content_type,
  14298. UploadProgress progress) {
  14299. return Post(path, Headers(), content_length, std::move(content_provider),
  14300. content_type, progress);
  14301. }
  14302. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14303. ContentProvider content_provider,
  14304. const std::string &content_type,
  14305. ContentReceiver content_receiver,
  14306. UploadProgress progress) {
  14307. return Post(path, Headers(), content_length, std::move(content_provider),
  14308. content_type, std::move(content_receiver), progress);
  14309. }
  14310. inline Result ClientImpl::Post(const std::string &path,
  14311. ContentProviderWithoutLength content_provider,
  14312. const std::string &content_type,
  14313. UploadProgress progress) {
  14314. return Post(path, Headers(), std::move(content_provider), content_type,
  14315. progress);
  14316. }
  14317. inline Result ClientImpl::Post(const std::string &path,
  14318. ContentProviderWithoutLength content_provider,
  14319. const std::string &content_type,
  14320. ContentReceiver content_receiver,
  14321. UploadProgress progress) {
  14322. return Post(path, Headers(), std::move(content_provider), content_type,
  14323. std::move(content_receiver), progress);
  14324. }
  14325. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14326. const Params &params) {
  14327. auto query = detail::params_to_query_str(params);
  14328. return Post(path, headers, query, "application/x-www-form-urlencoded");
  14329. }
  14330. inline Result ClientImpl::Post(const std::string &path,
  14331. const UploadFormDataItems &items,
  14332. UploadProgress progress) {
  14333. return Post(path, Headers(), items, progress);
  14334. }
  14335. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14336. const UploadFormDataItems &items,
  14337. UploadProgress progress) {
  14338. const auto &boundary = detail::make_multipart_data_boundary();
  14339. const auto &content_type =
  14340. detail::serialize_multipart_formdata_get_content_type(boundary);
  14341. auto content_length = detail::get_multipart_content_length(items, boundary);
  14342. return Post(path, headers, content_length,
  14343. detail::make_multipart_content_provider(items, boundary),
  14344. content_type, progress);
  14345. }
  14346. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14347. const UploadFormDataItems &items,
  14348. const std::string &boundary,
  14349. UploadProgress progress) {
  14350. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14351. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14352. }
  14353. const auto &content_type =
  14354. detail::serialize_multipart_formdata_get_content_type(boundary);
  14355. auto content_length = detail::get_multipart_content_length(items, boundary);
  14356. return Post(path, headers, content_length,
  14357. detail::make_multipart_content_provider(items, boundary),
  14358. content_type, progress);
  14359. }
  14360. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14361. const char *body, size_t content_length,
  14362. const std::string &content_type,
  14363. UploadProgress progress) {
  14364. return send_with_content_provider_and_receiver(
  14365. "POST", path, headers, body, content_length, nullptr, nullptr,
  14366. content_type, nullptr, progress);
  14367. }
  14368. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14369. const std::string &body,
  14370. const std::string &content_type,
  14371. UploadProgress progress) {
  14372. return send_with_content_provider_and_receiver(
  14373. "POST", path, headers, body.data(), body.size(), nullptr, nullptr,
  14374. content_type, nullptr, progress);
  14375. }
  14376. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14377. size_t content_length,
  14378. ContentProvider content_provider,
  14379. const std::string &content_type,
  14380. UploadProgress progress) {
  14381. return send_with_content_provider_and_receiver(
  14382. "POST", path, headers, nullptr, content_length,
  14383. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14384. }
  14385. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14386. size_t content_length,
  14387. ContentProvider content_provider,
  14388. const std::string &content_type,
  14389. ContentReceiver content_receiver,
  14390. DownloadProgress progress) {
  14391. return send_with_content_provider_and_receiver(
  14392. "POST", path, headers, nullptr, content_length,
  14393. std::move(content_provider), nullptr, content_type,
  14394. std::move(content_receiver), std::move(progress));
  14395. }
  14396. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14397. ContentProviderWithoutLength content_provider,
  14398. const std::string &content_type,
  14399. UploadProgress progress) {
  14400. return send_with_content_provider_and_receiver(
  14401. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14402. content_type, nullptr, progress);
  14403. }
  14404. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14405. ContentProviderWithoutLength content_provider,
  14406. const std::string &content_type,
  14407. ContentReceiver content_receiver,
  14408. DownloadProgress progress) {
  14409. return send_with_content_provider_and_receiver(
  14410. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14411. content_type, std::move(content_receiver), std::move(progress));
  14412. }
  14413. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14414. const UploadFormDataItems &items,
  14415. const FormDataProviderItems &provider_items,
  14416. UploadProgress progress) {
  14417. const auto &boundary = detail::make_multipart_data_boundary();
  14418. const auto &content_type =
  14419. detail::serialize_multipart_formdata_get_content_type(boundary);
  14420. return send_with_content_provider_and_receiver(
  14421. "POST", path, headers, nullptr, 0, nullptr,
  14422. get_multipart_content_provider(boundary, items, provider_items),
  14423. content_type, nullptr, progress);
  14424. }
  14425. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14426. const std::string &body,
  14427. const std::string &content_type,
  14428. ContentReceiver content_receiver,
  14429. DownloadProgress progress) {
  14430. Request req;
  14431. req.method = "POST";
  14432. req.path = path;
  14433. req.headers = headers;
  14434. req.body = body;
  14435. req.content_receiver =
  14436. [content_receiver](const char *data, size_t data_length,
  14437. size_t /*offset*/, size_t /*total_length*/) {
  14438. return content_receiver(data, data_length);
  14439. };
  14440. req.download_progress = std::move(progress);
  14441. if (max_timeout_msec_ > 0) {
  14442. req.start_time_ = std::chrono::steady_clock::now();
  14443. }
  14444. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14445. return send_(std::move(req));
  14446. }
  14447. inline Result ClientImpl::Put(const std::string &path) {
  14448. return Put(path, std::string(), std::string());
  14449. }
  14450. inline Result ClientImpl::Put(const std::string &path, const Headers &headers) {
  14451. return Put(path, headers, nullptr, 0, std::string());
  14452. }
  14453. inline Result ClientImpl::Put(const std::string &path, const char *body,
  14454. size_t content_length,
  14455. const std::string &content_type,
  14456. UploadProgress progress) {
  14457. return Put(path, Headers(), body, content_length, content_type, progress);
  14458. }
  14459. inline Result ClientImpl::Put(const std::string &path, const std::string &body,
  14460. const std::string &content_type,
  14461. UploadProgress progress) {
  14462. return Put(path, Headers(), body, content_type, progress);
  14463. }
  14464. inline Result ClientImpl::Put(const std::string &path, const Params &params) {
  14465. return Put(path, Headers(), params);
  14466. }
  14467. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14468. ContentProvider content_provider,
  14469. const std::string &content_type,
  14470. UploadProgress progress) {
  14471. return Put(path, Headers(), content_length, std::move(content_provider),
  14472. content_type, progress);
  14473. }
  14474. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14475. ContentProvider content_provider,
  14476. const std::string &content_type,
  14477. ContentReceiver content_receiver,
  14478. UploadProgress progress) {
  14479. return Put(path, Headers(), content_length, std::move(content_provider),
  14480. content_type, std::move(content_receiver), progress);
  14481. }
  14482. inline Result ClientImpl::Put(const std::string &path,
  14483. ContentProviderWithoutLength content_provider,
  14484. const std::string &content_type,
  14485. UploadProgress progress) {
  14486. return Put(path, Headers(), std::move(content_provider), content_type,
  14487. progress);
  14488. }
  14489. inline Result ClientImpl::Put(const std::string &path,
  14490. ContentProviderWithoutLength content_provider,
  14491. const std::string &content_type,
  14492. ContentReceiver content_receiver,
  14493. UploadProgress progress) {
  14494. return Put(path, Headers(), std::move(content_provider), content_type,
  14495. std::move(content_receiver), progress);
  14496. }
  14497. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14498. const Params &params) {
  14499. auto query = detail::params_to_query_str(params);
  14500. return Put(path, headers, query, "application/x-www-form-urlencoded");
  14501. }
  14502. inline Result ClientImpl::Put(const std::string &path,
  14503. const UploadFormDataItems &items,
  14504. UploadProgress progress) {
  14505. return Put(path, Headers(), items, progress);
  14506. }
  14507. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14508. const UploadFormDataItems &items,
  14509. UploadProgress progress) {
  14510. const auto &boundary = detail::make_multipart_data_boundary();
  14511. const auto &content_type =
  14512. detail::serialize_multipart_formdata_get_content_type(boundary);
  14513. auto content_length = detail::get_multipart_content_length(items, boundary);
  14514. return Put(path, headers, content_length,
  14515. detail::make_multipart_content_provider(items, boundary),
  14516. content_type, progress);
  14517. }
  14518. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14519. const UploadFormDataItems &items,
  14520. const std::string &boundary,
  14521. UploadProgress progress) {
  14522. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14523. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14524. }
  14525. const auto &content_type =
  14526. detail::serialize_multipart_formdata_get_content_type(boundary);
  14527. auto content_length = detail::get_multipart_content_length(items, boundary);
  14528. return Put(path, headers, content_length,
  14529. detail::make_multipart_content_provider(items, boundary),
  14530. content_type, progress);
  14531. }
  14532. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14533. const char *body, size_t content_length,
  14534. const std::string &content_type,
  14535. UploadProgress progress) {
  14536. return send_with_content_provider_and_receiver(
  14537. "PUT", path, headers, body, content_length, nullptr, nullptr,
  14538. content_type, nullptr, progress);
  14539. }
  14540. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14541. const std::string &body,
  14542. const std::string &content_type,
  14543. UploadProgress progress) {
  14544. return send_with_content_provider_and_receiver(
  14545. "PUT", path, headers, body.data(), body.size(), nullptr, nullptr,
  14546. content_type, nullptr, progress);
  14547. }
  14548. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14549. size_t content_length,
  14550. ContentProvider content_provider,
  14551. const std::string &content_type,
  14552. UploadProgress progress) {
  14553. return send_with_content_provider_and_receiver(
  14554. "PUT", path, headers, nullptr, content_length,
  14555. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14556. }
  14557. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14558. size_t content_length,
  14559. ContentProvider content_provider,
  14560. const std::string &content_type,
  14561. ContentReceiver content_receiver,
  14562. UploadProgress progress) {
  14563. return send_with_content_provider_and_receiver(
  14564. "PUT", path, headers, nullptr, content_length,
  14565. std::move(content_provider), nullptr, content_type,
  14566. std::move(content_receiver), progress);
  14567. }
  14568. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14569. ContentProviderWithoutLength content_provider,
  14570. const std::string &content_type,
  14571. UploadProgress progress) {
  14572. return send_with_content_provider_and_receiver(
  14573. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14574. content_type, nullptr, progress);
  14575. }
  14576. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14577. ContentProviderWithoutLength content_provider,
  14578. const std::string &content_type,
  14579. ContentReceiver content_receiver,
  14580. UploadProgress progress) {
  14581. return send_with_content_provider_and_receiver(
  14582. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14583. content_type, std::move(content_receiver), progress);
  14584. }
  14585. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14586. const UploadFormDataItems &items,
  14587. const FormDataProviderItems &provider_items,
  14588. UploadProgress progress) {
  14589. const auto &boundary = detail::make_multipart_data_boundary();
  14590. const auto &content_type =
  14591. detail::serialize_multipart_formdata_get_content_type(boundary);
  14592. return send_with_content_provider_and_receiver(
  14593. "PUT", path, headers, nullptr, 0, nullptr,
  14594. get_multipart_content_provider(boundary, items, provider_items),
  14595. content_type, nullptr, progress);
  14596. }
  14597. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14598. const std::string &body,
  14599. const std::string &content_type,
  14600. ContentReceiver content_receiver,
  14601. DownloadProgress progress) {
  14602. Request req;
  14603. req.method = "PUT";
  14604. req.path = path;
  14605. req.headers = headers;
  14606. req.body = body;
  14607. req.content_receiver =
  14608. [content_receiver](const char *data, size_t data_length,
  14609. size_t /*offset*/, size_t /*total_length*/) {
  14610. return content_receiver(data, data_length);
  14611. };
  14612. req.download_progress = std::move(progress);
  14613. if (max_timeout_msec_ > 0) {
  14614. req.start_time_ = std::chrono::steady_clock::now();
  14615. }
  14616. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14617. return send_(std::move(req));
  14618. }
  14619. inline Result ClientImpl::Patch(const std::string &path) {
  14620. return Patch(path, std::string(), std::string());
  14621. }
  14622. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14623. UploadProgress progress) {
  14624. return Patch(path, headers, nullptr, 0, std::string(), progress);
  14625. }
  14626. inline Result ClientImpl::Patch(const std::string &path, const char *body,
  14627. size_t content_length,
  14628. const std::string &content_type,
  14629. UploadProgress progress) {
  14630. return Patch(path, Headers(), body, content_length, content_type, progress);
  14631. }
  14632. inline Result ClientImpl::Patch(const std::string &path,
  14633. const std::string &body,
  14634. const std::string &content_type,
  14635. UploadProgress progress) {
  14636. return Patch(path, Headers(), body, content_type, progress);
  14637. }
  14638. inline Result ClientImpl::Patch(const std::string &path, const Params &params) {
  14639. return Patch(path, Headers(), params);
  14640. }
  14641. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  14642. ContentProvider content_provider,
  14643. const std::string &content_type,
  14644. UploadProgress progress) {
  14645. return Patch(path, Headers(), content_length, std::move(content_provider),
  14646. content_type, progress);
  14647. }
  14648. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  14649. ContentProvider content_provider,
  14650. const std::string &content_type,
  14651. ContentReceiver content_receiver,
  14652. UploadProgress progress) {
  14653. return Patch(path, Headers(), content_length, std::move(content_provider),
  14654. content_type, std::move(content_receiver), progress);
  14655. }
  14656. inline Result ClientImpl::Patch(const std::string &path,
  14657. ContentProviderWithoutLength content_provider,
  14658. const std::string &content_type,
  14659. UploadProgress progress) {
  14660. return Patch(path, Headers(), std::move(content_provider), content_type,
  14661. progress);
  14662. }
  14663. inline Result ClientImpl::Patch(const std::string &path,
  14664. ContentProviderWithoutLength content_provider,
  14665. const std::string &content_type,
  14666. ContentReceiver content_receiver,
  14667. UploadProgress progress) {
  14668. return Patch(path, Headers(), std::move(content_provider), content_type,
  14669. std::move(content_receiver), progress);
  14670. }
  14671. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14672. const Params &params) {
  14673. auto query = detail::params_to_query_str(params);
  14674. return Patch(path, headers, query, "application/x-www-form-urlencoded");
  14675. }
  14676. inline Result ClientImpl::Patch(const std::string &path,
  14677. const UploadFormDataItems &items,
  14678. UploadProgress progress) {
  14679. return Patch(path, Headers(), items, progress);
  14680. }
  14681. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14682. const UploadFormDataItems &items,
  14683. UploadProgress progress) {
  14684. const auto &boundary = detail::make_multipart_data_boundary();
  14685. const auto &content_type =
  14686. detail::serialize_multipart_formdata_get_content_type(boundary);
  14687. auto content_length = detail::get_multipart_content_length(items, boundary);
  14688. return Patch(path, headers, content_length,
  14689. detail::make_multipart_content_provider(items, boundary),
  14690. content_type, progress);
  14691. }
  14692. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14693. const UploadFormDataItems &items,
  14694. const std::string &boundary,
  14695. UploadProgress progress) {
  14696. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14697. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14698. }
  14699. const auto &content_type =
  14700. detail::serialize_multipart_formdata_get_content_type(boundary);
  14701. auto content_length = detail::get_multipart_content_length(items, boundary);
  14702. return Patch(path, headers, content_length,
  14703. detail::make_multipart_content_provider(items, boundary),
  14704. content_type, progress);
  14705. }
  14706. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14707. const char *body, size_t content_length,
  14708. const std::string &content_type,
  14709. UploadProgress progress) {
  14710. return send_with_content_provider_and_receiver(
  14711. "PATCH", path, headers, body, content_length, nullptr, nullptr,
  14712. content_type, nullptr, progress);
  14713. }
  14714. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14715. const std::string &body,
  14716. const std::string &content_type,
  14717. UploadProgress progress) {
  14718. return send_with_content_provider_and_receiver(
  14719. "PATCH", path, headers, body.data(), body.size(), nullptr, nullptr,
  14720. content_type, nullptr, progress);
  14721. }
  14722. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14723. size_t content_length,
  14724. ContentProvider content_provider,
  14725. const std::string &content_type,
  14726. UploadProgress progress) {
  14727. return send_with_content_provider_and_receiver(
  14728. "PATCH", path, headers, nullptr, content_length,
  14729. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14730. }
  14731. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14732. size_t content_length,
  14733. ContentProvider content_provider,
  14734. const std::string &content_type,
  14735. ContentReceiver content_receiver,
  14736. UploadProgress progress) {
  14737. return send_with_content_provider_and_receiver(
  14738. "PATCH", path, headers, nullptr, content_length,
  14739. std::move(content_provider), nullptr, content_type,
  14740. std::move(content_receiver), progress);
  14741. }
  14742. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14743. ContentProviderWithoutLength content_provider,
  14744. const std::string &content_type,
  14745. UploadProgress progress) {
  14746. return send_with_content_provider_and_receiver(
  14747. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14748. content_type, nullptr, progress);
  14749. }
  14750. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14751. ContentProviderWithoutLength content_provider,
  14752. const std::string &content_type,
  14753. ContentReceiver content_receiver,
  14754. UploadProgress progress) {
  14755. return send_with_content_provider_and_receiver(
  14756. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14757. content_type, std::move(content_receiver), progress);
  14758. }
  14759. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14760. const UploadFormDataItems &items,
  14761. const FormDataProviderItems &provider_items,
  14762. UploadProgress progress) {
  14763. const auto &boundary = detail::make_multipart_data_boundary();
  14764. const auto &content_type =
  14765. detail::serialize_multipart_formdata_get_content_type(boundary);
  14766. return send_with_content_provider_and_receiver(
  14767. "PATCH", path, headers, nullptr, 0, nullptr,
  14768. get_multipart_content_provider(boundary, items, provider_items),
  14769. content_type, nullptr, progress);
  14770. }
  14771. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14772. const std::string &body,
  14773. const std::string &content_type,
  14774. ContentReceiver content_receiver,
  14775. DownloadProgress progress) {
  14776. Request req;
  14777. req.method = "PATCH";
  14778. req.path = path;
  14779. req.headers = headers;
  14780. req.body = body;
  14781. req.content_receiver =
  14782. [content_receiver](const char *data, size_t data_length,
  14783. size_t /*offset*/, size_t /*total_length*/) {
  14784. return content_receiver(data, data_length);
  14785. };
  14786. req.download_progress = std::move(progress);
  14787. if (max_timeout_msec_ > 0) {
  14788. req.start_time_ = std::chrono::steady_clock::now();
  14789. }
  14790. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14791. return send_(std::move(req));
  14792. }
  14793. inline Result ClientImpl::Delete(const std::string &path,
  14794. DownloadProgress progress) {
  14795. return Delete(path, Headers(), std::string(), std::string(), progress);
  14796. }
  14797. inline Result ClientImpl::Delete(const std::string &path,
  14798. const Headers &headers,
  14799. DownloadProgress progress) {
  14800. return Delete(path, headers, std::string(), std::string(), progress);
  14801. }
  14802. inline Result ClientImpl::Delete(const std::string &path, const char *body,
  14803. size_t content_length,
  14804. const std::string &content_type,
  14805. DownloadProgress progress) {
  14806. return Delete(path, Headers(), body, content_length, content_type, progress);
  14807. }
  14808. inline Result ClientImpl::Delete(const std::string &path,
  14809. const std::string &body,
  14810. const std::string &content_type,
  14811. DownloadProgress progress) {
  14812. return Delete(path, Headers(), body.data(), body.size(), content_type,
  14813. progress);
  14814. }
  14815. inline Result ClientImpl::Delete(const std::string &path,
  14816. const Headers &headers,
  14817. const std::string &body,
  14818. const std::string &content_type,
  14819. DownloadProgress progress) {
  14820. return Delete(path, headers, body.data(), body.size(), content_type,
  14821. progress);
  14822. }
  14823. inline Result ClientImpl::Delete(const std::string &path, const Params &params,
  14824. DownloadProgress progress) {
  14825. return Delete(path, Headers(), params, progress);
  14826. }
  14827. inline Result ClientImpl::Delete(const std::string &path,
  14828. const Headers &headers, const Params &params,
  14829. DownloadProgress progress) {
  14830. auto query = detail::params_to_query_str(params);
  14831. return Delete(path, headers, query, "application/x-www-form-urlencoded",
  14832. progress);
  14833. }
  14834. inline Result ClientImpl::Delete(const std::string &path,
  14835. const Headers &headers, const char *body,
  14836. size_t content_length,
  14837. const std::string &content_type,
  14838. DownloadProgress progress) {
  14839. Request req;
  14840. req.method = "DELETE";
  14841. req.headers = headers;
  14842. req.path = path;
  14843. req.download_progress = std::move(progress);
  14844. if (max_timeout_msec_ > 0) {
  14845. req.start_time_ = std::chrono::steady_clock::now();
  14846. }
  14847. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14848. req.body.assign(body, content_length);
  14849. return send_(std::move(req));
  14850. }
  14851. inline Result ClientImpl::Options(const std::string &path) {
  14852. return Options(path, Headers());
  14853. }
  14854. inline Result ClientImpl::Options(const std::string &path,
  14855. const Headers &headers) {
  14856. Request req;
  14857. req.method = "OPTIONS";
  14858. req.headers = headers;
  14859. req.path = path;
  14860. if (max_timeout_msec_ > 0) {
  14861. req.start_time_ = std::chrono::steady_clock::now();
  14862. }
  14863. return send_(std::move(req));
  14864. }
  14865. inline void ClientImpl::stop() {
  14866. std::lock_guard<std::mutex> guard(socket_mutex_);
  14867. // If there is anything ongoing right now, the ONLY thread-safe thing we can
  14868. // do is to shutdown_socket, so that threads using this socket suddenly
  14869. // discover they can't read/write any more and error out. Everything else
  14870. // (closing the socket, shutting ssl down) is unsafe because these actions
  14871. // are not thread-safe.
  14872. if (socket_requests_in_flight_ > 0) {
  14873. shutdown_socket(socket_);
  14874. // Aside from that, we set a flag for the socket to be closed when we're
  14875. // done.
  14876. socket_should_be_closed_when_request_is_done_ = true;
  14877. return;
  14878. }
  14879. disconnect(/*gracefully=*/true);
  14880. }
  14881. inline std::string ClientImpl::host() const { return host_; }
  14882. inline int ClientImpl::port() const { return port_; }
  14883. inline size_t ClientImpl::is_socket_open() const {
  14884. std::lock_guard<std::mutex> guard(socket_mutex_);
  14885. return socket_.is_open();
  14886. }
  14887. inline socket_t ClientImpl::socket() const { return socket_.sock; }
  14888. inline void ClientImpl::set_connection_timeout(time_t sec, time_t usec) {
  14889. connection_timeout_sec_ = sec;
  14890. connection_timeout_usec_ = usec;
  14891. }
  14892. inline void ClientImpl::set_read_timeout(time_t sec, time_t usec) {
  14893. read_timeout_sec_ = sec;
  14894. read_timeout_usec_ = usec;
  14895. }
  14896. inline void ClientImpl::set_write_timeout(time_t sec, time_t usec) {
  14897. write_timeout_sec_ = sec;
  14898. write_timeout_usec_ = usec;
  14899. }
  14900. inline void ClientImpl::set_max_timeout(time_t msec) {
  14901. max_timeout_msec_ = msec;
  14902. }
  14903. inline void ClientImpl::set_basic_auth(const std::string &username,
  14904. const std::string &password) {
  14905. basic_auth_username_ = username;
  14906. basic_auth_password_ = password;
  14907. }
  14908. inline void ClientImpl::set_bearer_token_auth(const std::string &token) {
  14909. bearer_token_auth_token_ = token;
  14910. }
  14911. inline void ClientImpl::set_keep_alive(bool on) { keep_alive_ = on; }
  14912. inline void ClientImpl::set_follow_location(bool on) { follow_location_ = on; }
  14913. inline void ClientImpl::set_path_encode(bool on) { path_encode_ = on; }
  14914. inline void
  14915. ClientImpl::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  14916. addr_map_ = std::move(addr_map);
  14917. }
  14918. inline void ClientImpl::set_default_headers(Headers headers) {
  14919. default_headers_ = std::move(headers);
  14920. }
  14921. inline void ClientImpl::set_header_writer(
  14922. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  14923. header_writer_ = writer;
  14924. }
  14925. inline void ClientImpl::set_address_family(int family) {
  14926. address_family_ = family;
  14927. }
  14928. inline void ClientImpl::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  14929. inline void ClientImpl::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  14930. inline void ClientImpl::set_socket_options(SocketOptions socket_options) {
  14931. socket_options_ = std::move(socket_options);
  14932. }
  14933. inline void ClientImpl::set_compress(bool on) { compress_ = on; }
  14934. inline void ClientImpl::set_decompress(bool on) { decompress_ = on; }
  14935. inline void ClientImpl::set_payload_max_length(size_t length) {
  14936. payload_max_length_ = length;
  14937. has_payload_max_length_ = true;
  14938. }
  14939. inline void ClientImpl::set_interface(const std::string &intf) {
  14940. interface_ = intf;
  14941. }
  14942. inline void ClientImpl::set_proxy(const std::string &host, int port) {
  14943. proxy_host_ = host;
  14944. proxy_port_ = port;
  14945. std::lock_guard<std::mutex> guard(socket_mutex_);
  14946. disconnect(/*gracefully=*/true);
  14947. }
  14948. inline void ClientImpl::set_proxy_basic_auth(const std::string &username,
  14949. const std::string &password) {
  14950. proxy_basic_auth_username_ = username;
  14951. proxy_basic_auth_password_ = password;
  14952. }
  14953. inline void ClientImpl::set_proxy_bearer_token_auth(const std::string &token) {
  14954. proxy_bearer_token_auth_token_ = token;
  14955. }
  14956. inline void ClientImpl::set_no_proxy(const std::vector<std::string> &patterns) {
  14957. std::vector<detail::NoProxyEntry> parsed;
  14958. parsed.reserve(patterns.size());
  14959. for (const auto &p : patterns) {
  14960. auto trimmed = detail::trim_copy(p);
  14961. if (trimmed.empty()) { continue; }
  14962. detail::NoProxyEntry entry;
  14963. if (detail::parse_no_proxy_entry(trimmed, entry)) {
  14964. parsed.push_back(std::move(entry));
  14965. }
  14966. }
  14967. no_proxy_entries_ = std::move(parsed);
  14968. std::lock_guard<std::mutex> guard(socket_mutex_);
  14969. disconnect(/*gracefully=*/true);
  14970. }
  14971. #ifdef CPPHTTPLIB_SSL_ENABLED
  14972. inline void ClientImpl::set_digest_auth(const std::string &username,
  14973. const std::string &password) {
  14974. digest_auth_username_ = username;
  14975. digest_auth_password_ = password;
  14976. }
  14977. inline void ClientImpl::set_ca_cert_path(const std::string &ca_cert_file_path,
  14978. const std::string &ca_cert_dir_path) {
  14979. ca_cert_file_path_ = ca_cert_file_path;
  14980. ca_cert_dir_path_ = ca_cert_dir_path;
  14981. }
  14982. inline void ClientImpl::set_proxy_digest_auth(const std::string &username,
  14983. const std::string &password) {
  14984. proxy_digest_auth_username_ = username;
  14985. proxy_digest_auth_password_ = password;
  14986. }
  14987. inline void ClientImpl::enable_server_certificate_verification(bool enabled) {
  14988. server_certificate_verification_ = enabled;
  14989. }
  14990. inline void ClientImpl::enable_server_hostname_verification(bool enabled) {
  14991. server_hostname_verification_ = enabled;
  14992. }
  14993. inline void ClientImpl::enable_system_ca(bool enabled) {
  14994. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  14995. }
  14996. #endif
  14997. inline void ClientImpl::set_logger(Logger logger) {
  14998. logger_ = std::move(logger);
  14999. }
  15000. inline void ClientImpl::set_error_logger(ErrorLogger error_logger) {
  15001. error_logger_ = std::move(error_logger);
  15002. }
  15003. /*
  15004. * SSL/TLS Common Implementation
  15005. */
  15006. inline ClientConnection::~ClientConnection() {
  15007. #ifdef CPPHTTPLIB_SSL_ENABLED
  15008. if (session) {
  15009. tls::shutdown(session, true);
  15010. tls::free_session(session);
  15011. session = nullptr;
  15012. }
  15013. #endif
  15014. if (sock != INVALID_SOCKET) {
  15015. detail::close_socket(sock);
  15016. sock = INVALID_SOCKET;
  15017. }
  15018. }
  15019. // Universal client implementation
  15020. inline Client::Client(const std::string &scheme_host_port)
  15021. : Client(scheme_host_port, std::string(), std::string()) {}
  15022. inline Client::Client(const std::string &scheme_host_port,
  15023. const std::string &client_cert_path,
  15024. const std::string &client_key_path) {
  15025. detail::UrlComponents uc;
  15026. if (detail::parse_url(scheme_host_port, uc) && !uc.host.empty()) {
  15027. auto &scheme = uc.scheme;
  15028. #ifdef CPPHTTPLIB_SSL_ENABLED
  15029. if (!scheme.empty() && (scheme != "http" && scheme != "https")) {
  15030. #else
  15031. if (!scheme.empty() && scheme != "http") {
  15032. #endif
  15033. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  15034. std::string msg = "'" + scheme + "' scheme is not supported.";
  15035. throw std::invalid_argument(msg);
  15036. #endif
  15037. return;
  15038. }
  15039. auto is_ssl = scheme == "https";
  15040. auto host = std::move(uc.host);
  15041. auto port = is_ssl ? 443 : 80;
  15042. if (!uc.port.empty() && !detail::parse_port(uc.port, port)) { return; }
  15043. if (is_ssl) {
  15044. #ifdef CPPHTTPLIB_SSL_ENABLED
  15045. cli_ = detail::make_unique<SSLClient>(host, port, client_cert_path,
  15046. client_key_path);
  15047. is_ssl_ = is_ssl;
  15048. #endif
  15049. } else {
  15050. cli_ = detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15051. client_key_path);
  15052. }
  15053. } else {
  15054. // NOTE: Update TEST(UniversalClientImplTest, Ipv6LiteralAddress)
  15055. // if port param below changes.
  15056. cli_ = detail::make_unique<ClientImpl>(scheme_host_port, 80,
  15057. client_cert_path, client_key_path);
  15058. }
  15059. }
  15060. inline Client::Client(const std::string &host, int port)
  15061. : Client(host, port, std::string(), std::string()) {}
  15062. inline Client::Client(const std::string &host, int port,
  15063. const std::string &client_cert_path,
  15064. const std::string &client_key_path)
  15065. : cli_(detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15066. client_key_path)) {}
  15067. inline Client::~Client() = default;
  15068. inline bool Client::is_valid() const {
  15069. return cli_ != nullptr && cli_->is_valid();
  15070. }
  15071. inline Result Client::Get(const std::string &path, DownloadProgress progress) {
  15072. return cli_->Get(path, std::move(progress));
  15073. }
  15074. inline Result Client::Get(const std::string &path, const Headers &headers,
  15075. DownloadProgress progress) {
  15076. return cli_->Get(path, headers, std::move(progress));
  15077. }
  15078. inline Result Client::Get(const std::string &path,
  15079. ContentReceiver content_receiver,
  15080. DownloadProgress progress) {
  15081. return cli_->Get(path, std::move(content_receiver), std::move(progress));
  15082. }
  15083. inline Result Client::Get(const std::string &path, const Headers &headers,
  15084. ContentReceiver content_receiver,
  15085. DownloadProgress progress) {
  15086. return cli_->Get(path, headers, std::move(content_receiver),
  15087. std::move(progress));
  15088. }
  15089. inline Result Client::Get(const std::string &path,
  15090. ResponseHandler response_handler,
  15091. ContentReceiver content_receiver,
  15092. DownloadProgress progress) {
  15093. return cli_->Get(path, std::move(response_handler),
  15094. std::move(content_receiver), std::move(progress));
  15095. }
  15096. inline Result Client::Get(const std::string &path, const Headers &headers,
  15097. ResponseHandler response_handler,
  15098. ContentReceiver content_receiver,
  15099. DownloadProgress progress) {
  15100. return cli_->Get(path, headers, std::move(response_handler),
  15101. std::move(content_receiver), std::move(progress));
  15102. }
  15103. inline Result Client::Get(const std::string &path, const Params &params,
  15104. DownloadProgress progress) {
  15105. return cli_->Get(path, params, std::move(progress));
  15106. }
  15107. inline Result Client::Get(const std::string &path, const Params &params,
  15108. const Headers &headers, DownloadProgress progress) {
  15109. return cli_->Get(path, params, headers, std::move(progress));
  15110. }
  15111. inline Result Client::Get(const std::string &path, const Params &params,
  15112. const Headers &headers,
  15113. ContentReceiver content_receiver,
  15114. DownloadProgress progress) {
  15115. return cli_->Get(path, params, headers, std::move(content_receiver),
  15116. std::move(progress));
  15117. }
  15118. inline Result Client::Get(const std::string &path, const Params &params,
  15119. const Headers &headers,
  15120. ResponseHandler response_handler,
  15121. ContentReceiver content_receiver,
  15122. DownloadProgress progress) {
  15123. return cli_->Get(path, params, headers, std::move(response_handler),
  15124. std::move(content_receiver), std::move(progress));
  15125. }
  15126. inline Result Client::Head(const std::string &path) { return cli_->Head(path); }
  15127. inline Result Client::Head(const std::string &path, const Headers &headers) {
  15128. return cli_->Head(path, headers);
  15129. }
  15130. inline Result Client::Post(const std::string &path) { return cli_->Post(path); }
  15131. inline Result Client::Post(const std::string &path, const Headers &headers) {
  15132. return cli_->Post(path, headers);
  15133. }
  15134. inline Result Client::Post(const std::string &path, const char *body,
  15135. size_t content_length,
  15136. const std::string &content_type,
  15137. UploadProgress progress) {
  15138. return cli_->Post(path, body, content_length, content_type, progress);
  15139. }
  15140. inline Result Client::Post(const std::string &path, const Headers &headers,
  15141. const char *body, size_t content_length,
  15142. const std::string &content_type,
  15143. UploadProgress progress) {
  15144. return cli_->Post(path, headers, body, content_length, content_type,
  15145. progress);
  15146. }
  15147. inline Result Client::Post(const std::string &path, const std::string &body,
  15148. const std::string &content_type,
  15149. UploadProgress progress) {
  15150. return cli_->Post(path, body, content_type, progress);
  15151. }
  15152. inline Result Client::Post(const std::string &path, const Headers &headers,
  15153. const std::string &body,
  15154. const std::string &content_type,
  15155. UploadProgress progress) {
  15156. return cli_->Post(path, headers, body, content_type, progress);
  15157. }
  15158. inline Result Client::Post(const std::string &path, size_t content_length,
  15159. ContentProvider content_provider,
  15160. const std::string &content_type,
  15161. UploadProgress progress) {
  15162. return cli_->Post(path, content_length, std::move(content_provider),
  15163. content_type, progress);
  15164. }
  15165. inline Result Client::Post(const std::string &path, size_t content_length,
  15166. ContentProvider content_provider,
  15167. const std::string &content_type,
  15168. ContentReceiver content_receiver,
  15169. UploadProgress progress) {
  15170. return cli_->Post(path, content_length, std::move(content_provider),
  15171. content_type, std::move(content_receiver), progress);
  15172. }
  15173. inline Result Client::Post(const std::string &path,
  15174. ContentProviderWithoutLength content_provider,
  15175. const std::string &content_type,
  15176. UploadProgress progress) {
  15177. return cli_->Post(path, std::move(content_provider), content_type, progress);
  15178. }
  15179. inline Result Client::Post(const std::string &path,
  15180. ContentProviderWithoutLength content_provider,
  15181. const std::string &content_type,
  15182. ContentReceiver content_receiver,
  15183. UploadProgress progress) {
  15184. return cli_->Post(path, std::move(content_provider), content_type,
  15185. std::move(content_receiver), progress);
  15186. }
  15187. inline Result Client::Post(const std::string &path, const Headers &headers,
  15188. size_t content_length,
  15189. ContentProvider content_provider,
  15190. const std::string &content_type,
  15191. UploadProgress progress) {
  15192. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15193. content_type, progress);
  15194. }
  15195. inline Result Client::Post(const std::string &path, const Headers &headers,
  15196. size_t content_length,
  15197. ContentProvider content_provider,
  15198. const std::string &content_type,
  15199. ContentReceiver content_receiver,
  15200. DownloadProgress progress) {
  15201. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15202. content_type, std::move(content_receiver), progress);
  15203. }
  15204. inline Result Client::Post(const std::string &path, const Headers &headers,
  15205. ContentProviderWithoutLength content_provider,
  15206. const std::string &content_type,
  15207. UploadProgress progress) {
  15208. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15209. progress);
  15210. }
  15211. inline Result Client::Post(const std::string &path, const Headers &headers,
  15212. ContentProviderWithoutLength content_provider,
  15213. const std::string &content_type,
  15214. ContentReceiver content_receiver,
  15215. DownloadProgress progress) {
  15216. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15217. std::move(content_receiver), progress);
  15218. }
  15219. inline Result Client::Post(const std::string &path, const Params &params) {
  15220. return cli_->Post(path, params);
  15221. }
  15222. inline Result Client::Post(const std::string &path, const Headers &headers,
  15223. const Params &params) {
  15224. return cli_->Post(path, headers, params);
  15225. }
  15226. inline Result Client::Post(const std::string &path,
  15227. const UploadFormDataItems &items,
  15228. UploadProgress progress) {
  15229. return cli_->Post(path, items, progress);
  15230. }
  15231. inline Result Client::Post(const std::string &path, const Headers &headers,
  15232. const UploadFormDataItems &items,
  15233. UploadProgress progress) {
  15234. return cli_->Post(path, headers, items, progress);
  15235. }
  15236. inline Result Client::Post(const std::string &path, const Headers &headers,
  15237. const UploadFormDataItems &items,
  15238. const std::string &boundary,
  15239. UploadProgress progress) {
  15240. return cli_->Post(path, headers, items, boundary, progress);
  15241. }
  15242. inline Result Client::Post(const std::string &path, const Headers &headers,
  15243. const UploadFormDataItems &items,
  15244. const FormDataProviderItems &provider_items,
  15245. UploadProgress progress) {
  15246. return cli_->Post(path, headers, items, provider_items, progress);
  15247. }
  15248. inline Result Client::Post(const std::string &path, const Headers &headers,
  15249. const std::string &body,
  15250. const std::string &content_type,
  15251. ContentReceiver content_receiver,
  15252. DownloadProgress progress) {
  15253. return cli_->Post(path, headers, body, content_type,
  15254. std::move(content_receiver), progress);
  15255. }
  15256. inline Result Client::Put(const std::string &path) { return cli_->Put(path); }
  15257. inline Result Client::Put(const std::string &path, const Headers &headers) {
  15258. return cli_->Put(path, headers);
  15259. }
  15260. inline Result Client::Put(const std::string &path, const char *body,
  15261. size_t content_length,
  15262. const std::string &content_type,
  15263. UploadProgress progress) {
  15264. return cli_->Put(path, body, content_length, content_type, progress);
  15265. }
  15266. inline Result Client::Put(const std::string &path, const Headers &headers,
  15267. const char *body, size_t content_length,
  15268. const std::string &content_type,
  15269. UploadProgress progress) {
  15270. return cli_->Put(path, headers, body, content_length, content_type, progress);
  15271. }
  15272. inline Result Client::Put(const std::string &path, const std::string &body,
  15273. const std::string &content_type,
  15274. UploadProgress progress) {
  15275. return cli_->Put(path, body, content_type, progress);
  15276. }
  15277. inline Result Client::Put(const std::string &path, const Headers &headers,
  15278. const std::string &body,
  15279. const std::string &content_type,
  15280. UploadProgress progress) {
  15281. return cli_->Put(path, headers, body, content_type, progress);
  15282. }
  15283. inline Result Client::Put(const std::string &path, size_t content_length,
  15284. ContentProvider content_provider,
  15285. const std::string &content_type,
  15286. UploadProgress progress) {
  15287. return cli_->Put(path, content_length, std::move(content_provider),
  15288. content_type, progress);
  15289. }
  15290. inline Result Client::Put(const std::string &path, size_t content_length,
  15291. ContentProvider content_provider,
  15292. const std::string &content_type,
  15293. ContentReceiver content_receiver,
  15294. UploadProgress progress) {
  15295. return cli_->Put(path, content_length, std::move(content_provider),
  15296. content_type, std::move(content_receiver), progress);
  15297. }
  15298. inline Result Client::Put(const std::string &path,
  15299. ContentProviderWithoutLength content_provider,
  15300. const std::string &content_type,
  15301. UploadProgress progress) {
  15302. return cli_->Put(path, std::move(content_provider), content_type, progress);
  15303. }
  15304. inline Result Client::Put(const std::string &path,
  15305. ContentProviderWithoutLength content_provider,
  15306. const std::string &content_type,
  15307. ContentReceiver content_receiver,
  15308. UploadProgress progress) {
  15309. return cli_->Put(path, std::move(content_provider), content_type,
  15310. std::move(content_receiver), progress);
  15311. }
  15312. inline Result Client::Put(const std::string &path, const Headers &headers,
  15313. size_t content_length,
  15314. ContentProvider content_provider,
  15315. const std::string &content_type,
  15316. UploadProgress progress) {
  15317. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15318. content_type, progress);
  15319. }
  15320. inline Result Client::Put(const std::string &path, const Headers &headers,
  15321. size_t content_length,
  15322. ContentProvider content_provider,
  15323. const std::string &content_type,
  15324. ContentReceiver content_receiver,
  15325. UploadProgress progress) {
  15326. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15327. content_type, std::move(content_receiver), progress);
  15328. }
  15329. inline Result Client::Put(const std::string &path, const Headers &headers,
  15330. ContentProviderWithoutLength content_provider,
  15331. const std::string &content_type,
  15332. UploadProgress progress) {
  15333. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15334. progress);
  15335. }
  15336. inline Result Client::Put(const std::string &path, const Headers &headers,
  15337. ContentProviderWithoutLength content_provider,
  15338. const std::string &content_type,
  15339. ContentReceiver content_receiver,
  15340. UploadProgress progress) {
  15341. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15342. std::move(content_receiver), progress);
  15343. }
  15344. inline Result Client::Put(const std::string &path, const Params &params) {
  15345. return cli_->Put(path, params);
  15346. }
  15347. inline Result Client::Put(const std::string &path, const Headers &headers,
  15348. const Params &params) {
  15349. return cli_->Put(path, headers, params);
  15350. }
  15351. inline Result Client::Put(const std::string &path,
  15352. const UploadFormDataItems &items,
  15353. UploadProgress progress) {
  15354. return cli_->Put(path, items, progress);
  15355. }
  15356. inline Result Client::Put(const std::string &path, const Headers &headers,
  15357. const UploadFormDataItems &items,
  15358. UploadProgress progress) {
  15359. return cli_->Put(path, headers, items, progress);
  15360. }
  15361. inline Result Client::Put(const std::string &path, const Headers &headers,
  15362. const UploadFormDataItems &items,
  15363. const std::string &boundary,
  15364. UploadProgress progress) {
  15365. return cli_->Put(path, headers, items, boundary, progress);
  15366. }
  15367. inline Result Client::Put(const std::string &path, const Headers &headers,
  15368. const UploadFormDataItems &items,
  15369. const FormDataProviderItems &provider_items,
  15370. UploadProgress progress) {
  15371. return cli_->Put(path, headers, items, provider_items, progress);
  15372. }
  15373. inline Result Client::Put(const std::string &path, const Headers &headers,
  15374. const std::string &body,
  15375. const std::string &content_type,
  15376. ContentReceiver content_receiver,
  15377. DownloadProgress progress) {
  15378. return cli_->Put(path, headers, body, content_type, content_receiver,
  15379. progress);
  15380. }
  15381. inline Result Client::Patch(const std::string &path) {
  15382. return cli_->Patch(path);
  15383. }
  15384. inline Result Client::Patch(const std::string &path, const Headers &headers) {
  15385. return cli_->Patch(path, headers);
  15386. }
  15387. inline Result Client::Patch(const std::string &path, const char *body,
  15388. size_t content_length,
  15389. const std::string &content_type,
  15390. UploadProgress progress) {
  15391. return cli_->Patch(path, body, content_length, content_type, progress);
  15392. }
  15393. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15394. const char *body, size_t content_length,
  15395. const std::string &content_type,
  15396. UploadProgress progress) {
  15397. return cli_->Patch(path, headers, body, content_length, content_type,
  15398. progress);
  15399. }
  15400. inline Result Client::Patch(const std::string &path, const std::string &body,
  15401. const std::string &content_type,
  15402. UploadProgress progress) {
  15403. return cli_->Patch(path, body, content_type, progress);
  15404. }
  15405. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15406. const std::string &body,
  15407. const std::string &content_type,
  15408. UploadProgress progress) {
  15409. return cli_->Patch(path, headers, body, content_type, progress);
  15410. }
  15411. inline Result Client::Patch(const std::string &path, size_t content_length,
  15412. ContentProvider content_provider,
  15413. const std::string &content_type,
  15414. UploadProgress progress) {
  15415. return cli_->Patch(path, content_length, std::move(content_provider),
  15416. content_type, progress);
  15417. }
  15418. inline Result Client::Patch(const std::string &path, size_t content_length,
  15419. ContentProvider content_provider,
  15420. const std::string &content_type,
  15421. ContentReceiver content_receiver,
  15422. UploadProgress progress) {
  15423. return cli_->Patch(path, content_length, std::move(content_provider),
  15424. content_type, std::move(content_receiver), progress);
  15425. }
  15426. inline Result Client::Patch(const std::string &path,
  15427. ContentProviderWithoutLength content_provider,
  15428. const std::string &content_type,
  15429. UploadProgress progress) {
  15430. return cli_->Patch(path, std::move(content_provider), content_type, progress);
  15431. }
  15432. inline Result Client::Patch(const std::string &path,
  15433. ContentProviderWithoutLength content_provider,
  15434. const std::string &content_type,
  15435. ContentReceiver content_receiver,
  15436. UploadProgress progress) {
  15437. return cli_->Patch(path, std::move(content_provider), content_type,
  15438. std::move(content_receiver), progress);
  15439. }
  15440. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15441. size_t content_length,
  15442. ContentProvider content_provider,
  15443. const std::string &content_type,
  15444. UploadProgress progress) {
  15445. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15446. content_type, progress);
  15447. }
  15448. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15449. size_t content_length,
  15450. ContentProvider content_provider,
  15451. const std::string &content_type,
  15452. ContentReceiver content_receiver,
  15453. UploadProgress progress) {
  15454. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15455. content_type, std::move(content_receiver), progress);
  15456. }
  15457. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15458. ContentProviderWithoutLength content_provider,
  15459. const std::string &content_type,
  15460. UploadProgress progress) {
  15461. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15462. progress);
  15463. }
  15464. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15465. ContentProviderWithoutLength content_provider,
  15466. const std::string &content_type,
  15467. ContentReceiver content_receiver,
  15468. UploadProgress progress) {
  15469. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15470. std::move(content_receiver), progress);
  15471. }
  15472. inline Result Client::Patch(const std::string &path, const Params &params) {
  15473. return cli_->Patch(path, params);
  15474. }
  15475. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15476. const Params &params) {
  15477. return cli_->Patch(path, headers, params);
  15478. }
  15479. inline Result Client::Patch(const std::string &path,
  15480. const UploadFormDataItems &items,
  15481. UploadProgress progress) {
  15482. return cli_->Patch(path, items, progress);
  15483. }
  15484. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15485. const UploadFormDataItems &items,
  15486. UploadProgress progress) {
  15487. return cli_->Patch(path, headers, items, progress);
  15488. }
  15489. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15490. const UploadFormDataItems &items,
  15491. const std::string &boundary,
  15492. UploadProgress progress) {
  15493. return cli_->Patch(path, headers, items, boundary, progress);
  15494. }
  15495. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15496. const UploadFormDataItems &items,
  15497. const FormDataProviderItems &provider_items,
  15498. UploadProgress progress) {
  15499. return cli_->Patch(path, headers, items, provider_items, progress);
  15500. }
  15501. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15502. const std::string &body,
  15503. const std::string &content_type,
  15504. ContentReceiver content_receiver,
  15505. DownloadProgress progress) {
  15506. return cli_->Patch(path, headers, body, content_type, content_receiver,
  15507. progress);
  15508. }
  15509. inline Result Client::Delete(const std::string &path,
  15510. DownloadProgress progress) {
  15511. return cli_->Delete(path, progress);
  15512. }
  15513. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15514. DownloadProgress progress) {
  15515. return cli_->Delete(path, headers, progress);
  15516. }
  15517. inline Result Client::Delete(const std::string &path, const char *body,
  15518. size_t content_length,
  15519. const std::string &content_type,
  15520. DownloadProgress progress) {
  15521. return cli_->Delete(path, body, content_length, content_type, progress);
  15522. }
  15523. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15524. const char *body, size_t content_length,
  15525. const std::string &content_type,
  15526. DownloadProgress progress) {
  15527. return cli_->Delete(path, headers, body, content_length, content_type,
  15528. progress);
  15529. }
  15530. inline Result Client::Delete(const std::string &path, const std::string &body,
  15531. const std::string &content_type,
  15532. DownloadProgress progress) {
  15533. return cli_->Delete(path, body, content_type, progress);
  15534. }
  15535. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15536. const std::string &body,
  15537. const std::string &content_type,
  15538. DownloadProgress progress) {
  15539. return cli_->Delete(path, headers, body, content_type, progress);
  15540. }
  15541. inline Result Client::Delete(const std::string &path, const Params &params,
  15542. DownloadProgress progress) {
  15543. return cli_->Delete(path, params, progress);
  15544. }
  15545. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15546. const Params &params, DownloadProgress progress) {
  15547. return cli_->Delete(path, headers, params, progress);
  15548. }
  15549. inline Result Client::Options(const std::string &path) {
  15550. return cli_->Options(path);
  15551. }
  15552. inline Result Client::Options(const std::string &path, const Headers &headers) {
  15553. return cli_->Options(path, headers);
  15554. }
  15555. inline ClientImpl::StreamHandle
  15556. Client::open_stream(const std::string &method, const std::string &path,
  15557. const Params &params, const Headers &headers,
  15558. const std::string &body, const std::string &content_type) {
  15559. return cli_->open_stream(method, path, params, headers, body, content_type);
  15560. }
  15561. inline bool Client::send(Request &req, Response &res, Error &error) {
  15562. return cli_->send(req, res, error);
  15563. }
  15564. inline Result Client::send(const Request &req) { return cli_->send(req); }
  15565. inline void Client::stop() { cli_->stop(); }
  15566. inline std::string Client::host() const { return cli_->host(); }
  15567. inline int Client::port() const { return cli_->port(); }
  15568. inline size_t Client::is_socket_open() const { return cli_->is_socket_open(); }
  15569. inline socket_t Client::socket() const { return cli_->socket(); }
  15570. inline void
  15571. Client::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15572. cli_->set_hostname_addr_map(std::move(addr_map));
  15573. }
  15574. inline void Client::set_default_headers(Headers headers) {
  15575. cli_->set_default_headers(std::move(headers));
  15576. }
  15577. inline void Client::set_header_writer(
  15578. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15579. cli_->set_header_writer(writer);
  15580. }
  15581. inline void Client::set_address_family(int family) {
  15582. cli_->set_address_family(family);
  15583. }
  15584. inline void Client::set_tcp_nodelay(bool on) { cli_->set_tcp_nodelay(on); }
  15585. inline void Client::set_socket_options(SocketOptions socket_options) {
  15586. cli_->set_socket_options(std::move(socket_options));
  15587. }
  15588. inline void Client::set_connection_timeout(time_t sec, time_t usec) {
  15589. cli_->set_connection_timeout(sec, usec);
  15590. }
  15591. inline void Client::set_read_timeout(time_t sec, time_t usec) {
  15592. cli_->set_read_timeout(sec, usec);
  15593. }
  15594. inline void Client::set_write_timeout(time_t sec, time_t usec) {
  15595. cli_->set_write_timeout(sec, usec);
  15596. }
  15597. inline void Client::set_basic_auth(const std::string &username,
  15598. const std::string &password) {
  15599. cli_->set_basic_auth(username, password);
  15600. }
  15601. inline void Client::set_bearer_token_auth(const std::string &token) {
  15602. cli_->set_bearer_token_auth(token);
  15603. }
  15604. inline void Client::set_keep_alive(bool on) { cli_->set_keep_alive(on); }
  15605. inline void Client::set_follow_location(bool on) {
  15606. cli_->set_follow_location(on);
  15607. }
  15608. inline void Client::set_path_encode(bool on) { cli_->set_path_encode(on); }
  15609. inline void Client::set_compress(bool on) { cli_->set_compress(on); }
  15610. inline void Client::set_decompress(bool on) { cli_->set_decompress(on); }
  15611. inline void Client::set_payload_max_length(size_t length) {
  15612. cli_->set_payload_max_length(length);
  15613. }
  15614. inline void Client::set_interface(const std::string &intf) {
  15615. cli_->set_interface(intf);
  15616. }
  15617. inline void Client::set_proxy(const std::string &host, int port) {
  15618. cli_->set_proxy(host, port);
  15619. }
  15620. inline void Client::set_proxy_basic_auth(const std::string &username,
  15621. const std::string &password) {
  15622. cli_->set_proxy_basic_auth(username, password);
  15623. }
  15624. inline void Client::set_proxy_bearer_token_auth(const std::string &token) {
  15625. cli_->set_proxy_bearer_token_auth(token);
  15626. }
  15627. inline void Client::set_no_proxy(const std::vector<std::string> &patterns) {
  15628. cli_->set_no_proxy(patterns);
  15629. }
  15630. inline void Client::set_logger(Logger logger) {
  15631. cli_->set_logger(std::move(logger));
  15632. }
  15633. inline void Client::set_error_logger(ErrorLogger error_logger) {
  15634. cli_->set_error_logger(std::move(error_logger));
  15635. }
  15636. /*
  15637. * Group 6: SSL Server and Client implementation
  15638. */
  15639. #ifdef CPPHTTPLIB_SSL_ENABLED
  15640. // SSL HTTP server implementation
  15641. inline SSLServer::SSLServer(const char *cert_path, const char *private_key_path,
  15642. const char *client_ca_cert_file_path,
  15643. const char *client_ca_cert_dir_path,
  15644. const char *private_key_password) {
  15645. using namespace tls;
  15646. ctx_ = create_server_context();
  15647. if (!ctx_) { return; }
  15648. // Load server certificate and private key
  15649. if (!set_server_cert_file(ctx_, cert_path, private_key_path,
  15650. private_key_password)) {
  15651. last_ssl_error_ = static_cast<int>(get_error());
  15652. free_context(ctx_);
  15653. ctx_ = nullptr;
  15654. return;
  15655. }
  15656. // Load client CA certificates for client authentication
  15657. if (client_ca_cert_file_path || client_ca_cert_dir_path) {
  15658. if (!set_client_ca_file(ctx_, client_ca_cert_file_path,
  15659. client_ca_cert_dir_path)) {
  15660. last_ssl_error_ = static_cast<int>(get_error());
  15661. free_context(ctx_);
  15662. ctx_ = nullptr;
  15663. return;
  15664. }
  15665. // Enable client certificate verification
  15666. set_verify_client(ctx_, true);
  15667. }
  15668. }
  15669. inline SSLServer::SSLServer(const PemMemory &pem) {
  15670. using namespace tls;
  15671. ctx_ = create_server_context();
  15672. if (ctx_) {
  15673. if (!set_server_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  15674. pem.private_key_password)) {
  15675. last_ssl_error_ = static_cast<int>(get_error());
  15676. free_context(ctx_);
  15677. ctx_ = nullptr;
  15678. } else if (pem.client_ca_pem && pem.client_ca_pem_len > 0) {
  15679. if (!load_ca_pem(ctx_, pem.client_ca_pem, pem.client_ca_pem_len)) {
  15680. last_ssl_error_ = static_cast<int>(get_error());
  15681. free_context(ctx_);
  15682. ctx_ = nullptr;
  15683. } else {
  15684. set_verify_client(ctx_, true);
  15685. }
  15686. }
  15687. }
  15688. }
  15689. inline SSLServer::SSLServer(const tls::ContextSetupCallback &setup_callback) {
  15690. using namespace tls;
  15691. ctx_ = create_server_context();
  15692. if (ctx_) {
  15693. if (!setup_callback(ctx_)) {
  15694. free_context(ctx_);
  15695. ctx_ = nullptr;
  15696. }
  15697. }
  15698. }
  15699. inline SSLServer::~SSLServer() {
  15700. if (ctx_) { tls::free_context(ctx_); }
  15701. }
  15702. inline bool SSLServer::is_valid() const {
  15703. return ctx_ != nullptr && Server::is_valid();
  15704. }
  15705. inline bool SSLServer::process_and_close_socket(socket_t sock) {
  15706. using namespace tls;
  15707. session_t session = nullptr;
  15708. {
  15709. std::unique_lock<std::mutex> lock(ctx_mutex_);
  15710. ctx_cv_.wait(lock, [&] { return updates_pending_ == 0; });
  15711. session = create_session(static_cast<ctx_t>(ctx_), sock);
  15712. if (session) { handshakes_in_progress_++; }
  15713. }
  15714. if (!session) {
  15715. last_ssl_error_ = static_cast<int>(get_error());
  15716. detail::shutdown_socket(sock);
  15717. detail::close_socket(sock);
  15718. return false;
  15719. }
  15720. // Use scope_exit to ensure cleanup on all paths (including exceptions)
  15721. bool handshake_done = false;
  15722. bool ret = false;
  15723. bool websocket_upgraded = false;
  15724. auto cleanup = detail::scope_exit([&] {
  15725. if (handshake_done) { shutdown(session, !websocket_upgraded && ret); }
  15726. free_session(session);
  15727. detail::shutdown_socket(sock);
  15728. detail::close_socket(sock);
  15729. });
  15730. // Perform TLS accept handshake with timeout
  15731. TlsError tls_err;
  15732. auto accepted = accept_nonblocking(session, sock, read_timeout_sec_,
  15733. read_timeout_usec_, &tls_err);
  15734. {
  15735. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15736. if (--handshakes_in_progress_ == 0) { ctx_cv_.notify_all(); }
  15737. }
  15738. if (!accepted) {
  15739. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  15740. // Map TlsError to legacy ssl_error for backward compatibility
  15741. if (tls_err.code == ErrorCode::WantRead) {
  15742. last_ssl_error_ = SSL_ERROR_WANT_READ;
  15743. } else if (tls_err.code == ErrorCode::WantWrite) {
  15744. last_ssl_error_ = SSL_ERROR_WANT_WRITE;
  15745. } else {
  15746. last_ssl_error_ = SSL_ERROR_SSL;
  15747. }
  15748. #else
  15749. last_ssl_error_ = static_cast<int>(get_error());
  15750. #endif
  15751. return false;
  15752. }
  15753. handshake_done = true;
  15754. std::string remote_addr;
  15755. int remote_port = 0;
  15756. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  15757. std::string local_addr;
  15758. int local_port = 0;
  15759. detail::get_local_ip_and_port(sock, local_addr, local_port);
  15760. ret = serve_guarded([&]() {
  15761. return detail::process_server_socket_ssl(
  15762. svr_sock_, session, sock, keep_alive_max_count_,
  15763. keep_alive_timeout_sec_, read_timeout_sec_, read_timeout_usec_,
  15764. write_timeout_sec_, write_timeout_usec_,
  15765. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  15766. return process_request(
  15767. strm, remote_addr, remote_port, local_addr, local_port,
  15768. close_connection, connection_closed,
  15769. [&](Request &req) { req.ssl = session; }, &websocket_upgraded);
  15770. });
  15771. });
  15772. return ret;
  15773. }
  15774. inline bool SSLServer::update_certs_pem(const char *cert_pem,
  15775. const char *key_pem,
  15776. const char *client_ca_pem,
  15777. const char *password) {
  15778. if (!ctx_) { return false; }
  15779. std::unique_lock<std::mutex> lock(ctx_mutex_);
  15780. updates_pending_++;
  15781. auto se = detail::scope_exit([&] {
  15782. if (--updates_pending_ == 0) { ctx_cv_.notify_all(); }
  15783. });
  15784. ctx_cv_.wait(lock, [&] { return handshakes_in_progress_ == 0; });
  15785. if (!tls::update_server_cert(ctx_, cert_pem, key_pem, password)) {
  15786. return false;
  15787. }
  15788. if (client_ca_pem) {
  15789. return tls::update_server_client_ca(ctx_, client_ca_pem);
  15790. }
  15791. return true;
  15792. }
  15793. // SSL HTTP client implementation
  15794. inline SSLClient::~SSLClient() {
  15795. // Make sure to shut down SSL since shutdown_ssl will resolve to the
  15796. // base function rather than the derived function once we get to the
  15797. // base class destructor, and won't free the SSL (causing a leak).
  15798. // This must happen before the context is freed below: some backends
  15799. // (e.g. mbedTLS) have the SSL session borrow a raw pointer into the
  15800. // context, so freeing the context first leaves close_notify reading
  15801. // freed memory.
  15802. shutdown_ssl_impl(socket_, true);
  15803. if (ctx_) {
  15804. tls::free_context(ctx_);
  15805. ctx_ = nullptr;
  15806. }
  15807. }
  15808. inline bool SSLClient::is_valid() const { return ctx_ != nullptr; }
  15809. inline void SSLClient::shutdown_ssl(Socket &socket, bool shutdown_gracefully) {
  15810. shutdown_ssl_impl(socket, shutdown_gracefully);
  15811. }
  15812. inline void SSLClient::shutdown_ssl_impl(Socket &socket,
  15813. bool shutdown_gracefully) {
  15814. if (socket.sock == INVALID_SOCKET) {
  15815. assert(socket.ssl == nullptr);
  15816. return;
  15817. }
  15818. if (socket.ssl) {
  15819. tls::shutdown(socket.ssl, shutdown_gracefully);
  15820. {
  15821. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15822. tls::free_session(socket.ssl);
  15823. }
  15824. socket.ssl = nullptr;
  15825. }
  15826. assert(socket.ssl == nullptr);
  15827. }
  15828. inline bool SSLClient::process_socket(
  15829. const Socket &socket,
  15830. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15831. std::function<bool(Stream &strm)> callback) {
  15832. assert(socket.ssl);
  15833. return detail::process_client_socket_ssl(
  15834. socket.ssl, socket.sock, read_timeout_sec_, read_timeout_usec_,
  15835. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_, start_time,
  15836. std::move(callback));
  15837. }
  15838. inline bool SSLClient::is_ssl() const { return true; }
  15839. inline bool SSLClient::create_and_connect_socket(Socket &socket, Error &error) {
  15840. if (!is_valid()) {
  15841. error = Error::SSLConnection;
  15842. return false;
  15843. }
  15844. return ClientImpl::create_and_connect_socket(socket, error);
  15845. }
  15846. inline bool SSLClient::setup_proxy_connection(
  15847. Socket &socket,
  15848. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15849. Response &res, bool &success, Error &error) {
  15850. if (!is_proxy_enabled_for_host(host_)) { return true; }
  15851. if (!connect_with_proxy(socket, start_time, res, success, error)) {
  15852. return false;
  15853. }
  15854. if (!initialize_ssl(socket, error)) {
  15855. success = false;
  15856. return false;
  15857. }
  15858. return true;
  15859. }
  15860. // Assumes that socket_mutex_ is locked and that there are no requests in
  15861. // flight
  15862. inline bool SSLClient::connect_with_proxy(
  15863. Socket &socket,
  15864. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15865. Response &res, bool &success, Error &error) {
  15866. success = true;
  15867. Response proxy_res;
  15868. if (!detail::process_client_socket(
  15869. socket.sock, read_timeout_sec_, read_timeout_usec_,
  15870. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  15871. start_time, [&](Stream &strm) {
  15872. Request req2;
  15873. req2.method = "CONNECT";
  15874. req2.path =
  15875. detail::make_host_and_port_string_always_port(host_, port_);
  15876. if (max_timeout_msec_ > 0) {
  15877. req2.start_time_ = std::chrono::steady_clock::now();
  15878. }
  15879. return process_request(strm, req2, proxy_res, false, error);
  15880. })) {
  15881. // Thread-safe to close everything because we are assuming there are no
  15882. // requests in flight
  15883. shutdown_ssl(socket, true);
  15884. shutdown_socket(socket);
  15885. close_socket(socket);
  15886. success = false;
  15887. return false;
  15888. }
  15889. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  15890. if (!proxy_digest_auth_username_.empty() &&
  15891. !proxy_digest_auth_password_.empty()) {
  15892. std::map<std::string, std::string> auth;
  15893. if (detail::parse_www_authenticate(proxy_res, auth, true)) {
  15894. // Close the current socket and create a new one for the authenticated
  15895. // request
  15896. shutdown_ssl(socket, true);
  15897. shutdown_socket(socket);
  15898. close_socket(socket);
  15899. // Create a new socket for the authenticated CONNECT request
  15900. if (!ensure_socket_connection(socket, error)) {
  15901. success = false;
  15902. output_error_log(error, nullptr);
  15903. return false;
  15904. }
  15905. proxy_res = Response();
  15906. if (!detail::process_client_socket(
  15907. socket.sock, read_timeout_sec_, read_timeout_usec_,
  15908. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  15909. start_time, [&](Stream &strm) {
  15910. Request req3;
  15911. req3.method = "CONNECT";
  15912. req3.path = detail::make_host_and_port_string_always_port(
  15913. host_, port_);
  15914. req3.headers.insert(detail::make_digest_authentication_header(
  15915. req3, auth, 1, detail::random_string(10),
  15916. proxy_digest_auth_username_, proxy_digest_auth_password_,
  15917. true));
  15918. if (max_timeout_msec_ > 0) {
  15919. req3.start_time_ = std::chrono::steady_clock::now();
  15920. }
  15921. return process_request(strm, req3, proxy_res, false, error);
  15922. })) {
  15923. // Thread-safe to close everything because we are assuming there are
  15924. // no requests in flight
  15925. shutdown_ssl(socket, true);
  15926. shutdown_socket(socket);
  15927. close_socket(socket);
  15928. success = false;
  15929. return false;
  15930. }
  15931. }
  15932. }
  15933. }
  15934. // If status code is not 200, proxy request is failed.
  15935. // Set error to ProxyConnection and return proxy response
  15936. // as the response of the request
  15937. if (proxy_res.status != StatusCode::OK_200) {
  15938. error = Error::ProxyConnection;
  15939. output_error_log(error, nullptr);
  15940. res = std::move(proxy_res);
  15941. // Thread-safe to close everything because we are assuming there are
  15942. // no requests in flight
  15943. shutdown_ssl(socket, true);
  15944. shutdown_socket(socket);
  15945. close_socket(socket);
  15946. return false;
  15947. }
  15948. return true;
  15949. }
  15950. inline bool SSLClient::ensure_socket_connection(Socket &socket, Error &error) {
  15951. if (!ClientImpl::ensure_socket_connection(socket, error)) { return false; }
  15952. if (is_proxy_enabled_for_host(host_)) { return true; }
  15953. if (!initialize_ssl(socket, error)) {
  15954. shutdown_socket(socket);
  15955. close_socket(socket);
  15956. return false;
  15957. }
  15958. return true;
  15959. }
  15960. // SSL HTTP client implementation
  15961. inline SSLClient::SSLClient(const std::string &host)
  15962. : SSLClient(host, 443, std::string(), std::string()) {}
  15963. inline SSLClient::SSLClient(const std::string &host, int port)
  15964. : SSLClient(host, port, std::string(), std::string()) {}
  15965. inline void SSLClient::init_ctx() {
  15966. ctx_ = tls::create_client_context();
  15967. if (ctx_) { tls::set_min_version(ctx_, tls::Version::TLS1_2); }
  15968. }
  15969. inline void SSLClient::reset_ctx_on_error() {
  15970. last_backend_error_ = tls::get_error();
  15971. tls::free_context(ctx_);
  15972. ctx_ = nullptr;
  15973. }
  15974. inline SSLClient::SSLClient(const std::string &host, int port,
  15975. const std::string &client_cert_path,
  15976. const std::string &client_key_path,
  15977. const std::string &private_key_password)
  15978. : ClientImpl(host, port, client_cert_path, client_key_path) {
  15979. init_ctx();
  15980. if (!ctx_) { return; }
  15981. if (!client_cert_path.empty() && !client_key_path.empty()) {
  15982. const char *password =
  15983. private_key_password.empty() ? nullptr : private_key_password.c_str();
  15984. if (!tls::set_client_cert_file(ctx_, client_cert_path.c_str(),
  15985. client_key_path.c_str(), password)) {
  15986. reset_ctx_on_error();
  15987. }
  15988. }
  15989. }
  15990. inline SSLClient::SSLClient(const std::string &host, int port,
  15991. const PemMemory &pem)
  15992. : ClientImpl(host, port) {
  15993. init_ctx();
  15994. if (!ctx_) { return; }
  15995. if (pem.cert_pem && pem.key_pem) {
  15996. if (!tls::set_client_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  15997. pem.private_key_password)) {
  15998. reset_ctx_on_error();
  15999. }
  16000. }
  16001. }
  16002. inline void SSLClient::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16003. if (ca_cert_store && ctx_) {
  16004. // set_ca_store takes ownership of ca_cert_store
  16005. tls::set_ca_store(ctx_, ca_cert_store);
  16006. ca_cert_store_set_ = true;
  16007. } else if (ca_cert_store) {
  16008. tls::free_ca_store(ca_cert_store);
  16009. }
  16010. }
  16011. inline void
  16012. SSLClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16013. if (!ctx_) { return; }
  16014. server_certificate_verifier_ = verifier;
  16015. tls::set_verify_callback(ctx_, std::move(verifier));
  16016. }
  16017. inline void SSLClient::set_session_verifier(
  16018. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16019. session_verifier_ = std::move(verifier);
  16020. }
  16021. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16022. inline void SSLClient::enable_windows_certificate_verification(bool enabled) {
  16023. enable_windows_cert_verification_ = enabled;
  16024. }
  16025. #endif
  16026. inline void SSLClient::load_ca_cert_store(const char *ca_cert,
  16027. std::size_t size) {
  16028. if (ctx_ && ca_cert && size > 0) {
  16029. ca_cert_pem_.assign(ca_cert, size); // Store for redirect transfer
  16030. tls::load_ca_pem(ctx_, ca_cert, size);
  16031. }
  16032. }
  16033. inline bool SSLClient::load_certs() {
  16034. auto ret = true;
  16035. // call_once rather than the plain flag WebSocketClient::create_stream() uses:
  16036. // one client is shared across concurrent requests here.
  16037. std::call_once(initialize_cert_, [&]() {
  16038. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16039. ret = detail::load_client_ca_config(
  16040. ctx_, ca_cert_file_path_, ca_cert_dir_path_,
  16041. !ca_cert_pem_.empty() || ca_cert_store_set_, system_ca_mode_,
  16042. last_backend_error_);
  16043. });
  16044. return ret;
  16045. }
  16046. inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) {
  16047. // Load CA certificates if server verification is enabled
  16048. if (server_certificate_verification_) {
  16049. if (!load_certs()) {
  16050. error = Error::SSLLoadingCerts;
  16051. output_error_log(error, nullptr);
  16052. return false;
  16053. }
  16054. }
  16055. detail::ClientTlsSessionOptions options;
  16056. options.server_hostname_verification = server_hostname_verification_;
  16057. options.session_verifier = session_verifier_;
  16058. options.ctx_mutex = &ctx_mutex_;
  16059. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16060. // Skip Schannel when a custom CA cert is specified, as the Windows
  16061. // certificate store would not know about user-provided CA certificates.
  16062. // Also skip when system CA trust is explicitly disabled.
  16063. options.windows_cert_verification =
  16064. enable_windows_cert_verification_ &&
  16065. system_ca_mode_ != SystemCAMode::Disabled && ca_cert_file_path_.empty() &&
  16066. ca_cert_dir_path_.empty() && ca_cert_pem_.empty() && !ca_cert_store_set_;
  16067. // Only a verifier set through set_server_certificate_verifier() is seen
  16068. // here, not one installed with tls::set_verify_callback() directly.
  16069. options.server_certificate_verifier_set =
  16070. static_cast<bool>(server_certificate_verifier_);
  16071. #endif
  16072. tls::session_t session = nullptr;
  16073. // Use scope_exit to ensure session is freed on error paths
  16074. bool success = false;
  16075. auto session_guard = detail::scope_exit([&] {
  16076. if (!success) { tls::free_session(session); }
  16077. });
  16078. detail::ClientTlsSessionError tls_error;
  16079. if (!detail::setup_client_tls_session(
  16080. host_, ctx_, session, socket.sock, server_certificate_verification_,
  16081. connection_timeout_sec_, connection_timeout_usec_, &tls_error,
  16082. options)) {
  16083. error = tls_error.error;
  16084. last_ssl_error_ = tls_error.ssl_error;
  16085. last_backend_error_ = tls_error.backend_error;
  16086. output_error_log(error, nullptr);
  16087. return false;
  16088. }
  16089. success = true;
  16090. socket.ssl = session;
  16091. return true;
  16092. }
  16093. inline void Client::set_digest_auth(const std::string &username,
  16094. const std::string &password) {
  16095. cli_->set_digest_auth(username, password);
  16096. }
  16097. inline void Client::set_proxy_digest_auth(const std::string &username,
  16098. const std::string &password) {
  16099. cli_->set_proxy_digest_auth(username, password);
  16100. }
  16101. inline void Client::enable_server_certificate_verification(bool enabled) {
  16102. cli_->enable_server_certificate_verification(enabled);
  16103. }
  16104. inline void Client::enable_server_hostname_verification(bool enabled) {
  16105. cli_->enable_server_hostname_verification(enabled);
  16106. }
  16107. inline void Client::enable_system_ca(bool enabled) {
  16108. cli_->enable_system_ca(enabled);
  16109. }
  16110. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16111. inline void Client::enable_windows_certificate_verification(bool enabled) {
  16112. if (is_ssl_) {
  16113. static_cast<SSLClient &>(*cli_).enable_windows_certificate_verification(
  16114. enabled);
  16115. }
  16116. }
  16117. #endif
  16118. inline void Client::set_ca_cert_path(const std::string &ca_cert_file_path,
  16119. const std::string &ca_cert_dir_path) {
  16120. cli_->set_ca_cert_path(ca_cert_file_path, ca_cert_dir_path);
  16121. }
  16122. inline void Client::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16123. if (is_ssl_) {
  16124. static_cast<SSLClient &>(*cli_).set_ca_cert_store(ca_cert_store);
  16125. } else if (ca_cert_store) {
  16126. tls::free_ca_store(ca_cert_store);
  16127. }
  16128. }
  16129. inline void Client::load_ca_cert_store(const char *ca_cert, std::size_t size) {
  16130. if (is_ssl_) {
  16131. // Use the PEM-based path so the CA data is retained for redirect transfer
  16132. static_cast<SSLClient &>(*cli_).load_ca_cert_store(ca_cert, size);
  16133. }
  16134. }
  16135. inline void
  16136. Client::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16137. if (is_ssl_) {
  16138. static_cast<SSLClient &>(*cli_).set_server_certificate_verifier(
  16139. std::move(verifier));
  16140. }
  16141. }
  16142. inline void Client::set_session_verifier(
  16143. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16144. if (is_ssl_) {
  16145. static_cast<SSLClient &>(*cli_).set_session_verifier(std::move(verifier));
  16146. }
  16147. }
  16148. inline tls::ctx_t Client::tls_context() const {
  16149. if (is_ssl_) { return static_cast<SSLClient &>(*cli_).tls_context(); }
  16150. return nullptr;
  16151. }
  16152. #endif // CPPHTTPLIB_SSL_ENABLED
  16153. /*
  16154. * Group 7: TLS abstraction layer - Common API
  16155. */
  16156. #ifdef CPPHTTPLIB_SSL_ENABLED
  16157. namespace tls {
  16158. // Helper for PeerCert construction
  16159. inline PeerCert get_peer_cert_from_session(const_session_t session) {
  16160. return PeerCert(get_peer_cert(session));
  16161. }
  16162. namespace impl {
  16163. // Check if a string is an IPv4 address
  16164. inline bool is_ipv4_address(const std::string &str) {
  16165. int dots = 0;
  16166. for (char c : str) {
  16167. if (c == '.') {
  16168. dots++;
  16169. } else if (!detail::is_ascii_digit(c)) {
  16170. return false;
  16171. }
  16172. }
  16173. return dots == 3;
  16174. }
  16175. // Parse IPv4 address string to bytes
  16176. inline bool parse_ipv4(const std::string &str, unsigned char *out) {
  16177. const char *p = str.c_str();
  16178. for (int i = 0; i < 4; i++) {
  16179. if (i > 0) {
  16180. if (*p != '.') { return false; }
  16181. p++;
  16182. }
  16183. int val = 0;
  16184. int digits = 0;
  16185. while (detail::is_ascii_digit(*p)) {
  16186. val = val * 10 + (*p - '0');
  16187. if (val > 255) { return false; }
  16188. p++;
  16189. digits++;
  16190. }
  16191. if (digits == 0) { return false; }
  16192. // Reject leading zeros (e.g., "01.002.03.04") to prevent ambiguity
  16193. if (digits > 1 && *(p - digits) == '0') { return false; }
  16194. out[i] = static_cast<unsigned char>(val);
  16195. }
  16196. return *p == '\0';
  16197. }
  16198. // Parse an IP literal (IPv4 or IPv6) into raw network-order bytes.
  16199. // `out` must have room for at least 16 bytes. Returns the address length
  16200. // (4 for IPv4, 16 for IPv6) on success, or 0 if the string is not an IP
  16201. // literal. Used to match a host against iPAddress SANs the same way the
  16202. // OpenSSL backend does via X509_check_ip.
  16203. inline size_t parse_ip_address(const std::string &str, unsigned char *out) {
  16204. if (is_ipv4_address(str)) { return parse_ipv4(str, out) ? 4 : 0; }
  16205. struct in6_addr addr6 = {};
  16206. if (inet_pton(AF_INET6, str.c_str(), &addr6) == 1) {
  16207. memcpy(out, &addr6, 16);
  16208. return 16;
  16209. }
  16210. return 0;
  16211. }
  16212. #ifdef _WIN32
  16213. // Enumerate Windows system certificates and call callback with DER data
  16214. template <typename Callback>
  16215. inline bool enumerate_windows_system_certs(Callback cb) {
  16216. bool loaded = false;
  16217. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16218. for (auto store_name : store_names) {
  16219. HCERTSTORE hStore = CertOpenSystemStoreW(0, store_name);
  16220. if (hStore) {
  16221. PCCERT_CONTEXT pContext = nullptr;
  16222. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16223. nullptr) {
  16224. if (cb(pContext->pbCertEncoded, pContext->cbCertEncoded)) {
  16225. loaded = true;
  16226. }
  16227. }
  16228. CertCloseStore(hStore, 0);
  16229. }
  16230. }
  16231. return loaded;
  16232. }
  16233. #endif
  16234. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16235. // Enumerate macOS Keychain certificates and call callback with DER data
  16236. template <typename Callback>
  16237. inline bool enumerate_macos_keychain_certs(Callback cb) {
  16238. bool loaded = false;
  16239. const SecTrustSettingsDomain domains[] = {
  16240. kSecTrustSettingsDomainSystem,
  16241. kSecTrustSettingsDomainAdmin,
  16242. kSecTrustSettingsDomainUser,
  16243. };
  16244. for (auto domain : domains) {
  16245. CFArrayRef certs = nullptr;
  16246. OSStatus status = SecTrustSettingsCopyCertificates(domain, &certs);
  16247. if (status != errSecSuccess || !certs) {
  16248. if (certs) CFRelease(certs);
  16249. continue;
  16250. }
  16251. CFIndex count = CFArrayGetCount(certs);
  16252. for (CFIndex i = 0; i < count; i++) {
  16253. SecCertificateRef cert =
  16254. (SecCertificateRef)CFArrayGetValueAtIndex(certs, i);
  16255. CFDataRef data = SecCertificateCopyData(cert);
  16256. if (data) {
  16257. if (cb(CFDataGetBytePtr(data),
  16258. static_cast<size_t>(CFDataGetLength(data)))) {
  16259. loaded = true;
  16260. }
  16261. CFRelease(data);
  16262. }
  16263. }
  16264. CFRelease(certs);
  16265. }
  16266. return loaded;
  16267. }
  16268. #endif
  16269. #if !defined(_WIN32) && !(defined(__APPLE__) && \
  16270. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN))
  16271. // Common CA certificate file paths on Linux/Unix
  16272. inline const char **system_ca_paths() {
  16273. static const char *paths[] = {
  16274. "/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu
  16275. "/etc/pki/tls/certs/ca-bundle.crt", // RHEL/CentOS
  16276. "/etc/ssl/ca-bundle.pem", // OpenSUSE
  16277. "/etc/pki/tls/cacert.pem", // OpenELEC
  16278. "/etc/ssl/cert.pem", // Alpine, FreeBSD
  16279. nullptr};
  16280. return paths;
  16281. }
  16282. // Common CA certificate directory paths on Linux/Unix
  16283. inline const char **system_ca_dirs() {
  16284. static const char *dirs[] = {"/etc/ssl/certs", // Debian/Ubuntu
  16285. "/etc/pki/tls/certs", // RHEL/CentOS
  16286. "/usr/share/ca-certificates", // Other
  16287. nullptr};
  16288. return dirs;
  16289. }
  16290. #endif
  16291. } // namespace impl
  16292. inline bool set_client_ca_file(ctx_t ctx, const char *ca_file,
  16293. const char *ca_dir) {
  16294. if (!ctx) { return false; }
  16295. bool success = true;
  16296. if (ca_file && *ca_file) {
  16297. if (!load_ca_file(ctx, ca_file)) { success = false; }
  16298. }
  16299. if (ca_dir && *ca_dir) {
  16300. if (!load_ca_dir(ctx, ca_dir)) { success = false; }
  16301. }
  16302. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16303. // Set CA list for client certificate request (CertificateRequest message)
  16304. if (ca_file && *ca_file) {
  16305. auto list = SSL_load_client_CA_file(ca_file);
  16306. if (list) { SSL_CTX_set_client_CA_list(static_cast<SSL_CTX *>(ctx), list); }
  16307. }
  16308. #endif
  16309. return success;
  16310. }
  16311. inline bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16312. const char *password) {
  16313. return set_client_cert_pem(ctx, cert, key, password);
  16314. }
  16315. inline bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  16316. const char *key_path, const char *password) {
  16317. return set_client_cert_file(ctx, cert_path, key_path, password);
  16318. }
  16319. // PeerCert implementation
  16320. inline PeerCert::PeerCert() = default;
  16321. inline PeerCert::PeerCert(cert_t cert) : cert_(cert) {}
  16322. inline PeerCert::PeerCert(PeerCert &&other) noexcept : cert_(other.cert_) {
  16323. other.cert_ = nullptr;
  16324. }
  16325. inline PeerCert &PeerCert::operator=(PeerCert &&other) noexcept {
  16326. if (this != &other) {
  16327. if (cert_) { free_cert(cert_); }
  16328. cert_ = other.cert_;
  16329. other.cert_ = nullptr;
  16330. }
  16331. return *this;
  16332. }
  16333. inline PeerCert::~PeerCert() {
  16334. if (cert_) { free_cert(cert_); }
  16335. }
  16336. inline PeerCert::operator bool() const { return cert_ != nullptr; }
  16337. inline std::string PeerCert::subject_cn() const {
  16338. return cert_ ? get_cert_subject_cn(cert_) : std::string();
  16339. }
  16340. inline std::string PeerCert::issuer_name() const {
  16341. return cert_ ? get_cert_issuer_name(cert_) : std::string();
  16342. }
  16343. inline bool PeerCert::check_hostname(const char *hostname) const {
  16344. return cert_ ? verify_hostname(cert_, hostname) : false;
  16345. }
  16346. inline std::vector<SanEntry> PeerCert::sans() const {
  16347. std::vector<SanEntry> result;
  16348. if (cert_) { get_cert_sans(cert_, result); }
  16349. return result;
  16350. }
  16351. inline bool PeerCert::validity(time_t &not_before, time_t &not_after) const {
  16352. return cert_ ? get_cert_validity(cert_, not_before, not_after) : false;
  16353. }
  16354. inline std::string PeerCert::serial() const {
  16355. return cert_ ? get_cert_serial(cert_) : std::string();
  16356. }
  16357. // VerifyContext method implementations
  16358. inline std::string VerifyContext::subject_cn() const {
  16359. return cert ? get_cert_subject_cn(cert) : std::string();
  16360. }
  16361. inline std::string VerifyContext::issuer_name() const {
  16362. return cert ? get_cert_issuer_name(cert) : std::string();
  16363. }
  16364. inline bool VerifyContext::check_hostname(const char *hostname) const {
  16365. return cert ? verify_hostname(cert, hostname) : false;
  16366. }
  16367. inline std::vector<SanEntry> VerifyContext::sans() const {
  16368. std::vector<SanEntry> result;
  16369. if (cert) { get_cert_sans(cert, result); }
  16370. return result;
  16371. }
  16372. inline bool VerifyContext::validity(time_t &not_before,
  16373. time_t &not_after) const {
  16374. return cert ? get_cert_validity(cert, not_before, not_after) : false;
  16375. }
  16376. inline std::string VerifyContext::serial() const {
  16377. return cert ? get_cert_serial(cert) : std::string();
  16378. }
  16379. // TlsError static method implementation
  16380. inline std::string TlsError::verify_error_to_string(long error_code) {
  16381. return verify_error_string(error_code);
  16382. }
  16383. } // namespace tls
  16384. // Request::peer_cert() implementation
  16385. inline tls::PeerCert Request::peer_cert() const {
  16386. return tls::get_peer_cert_from_session(ssl);
  16387. }
  16388. // Request::sni() implementation
  16389. inline std::string Request::sni() const {
  16390. if (!ssl) { return std::string(); }
  16391. const char *s = tls::get_sni(ssl);
  16392. return s ? std::string(s) : std::string();
  16393. }
  16394. #endif // CPPHTTPLIB_SSL_ENABLED
  16395. /*
  16396. * Group 8: TLS abstraction layer - OpenSSL backend
  16397. */
  16398. /*
  16399. * OpenSSL Backend Implementation
  16400. */
  16401. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16402. namespace tls {
  16403. namespace impl {
  16404. // Helper to map OpenSSL SSL_get_error to ErrorCode
  16405. inline ErrorCode map_ssl_error(int ssl_error, int &out_errno) {
  16406. switch (ssl_error) {
  16407. case SSL_ERROR_NONE: return ErrorCode::Success;
  16408. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  16409. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  16410. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  16411. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  16412. case SSL_ERROR_SSL:
  16413. default: return ErrorCode::Fatal;
  16414. }
  16415. }
  16416. // Helper: Create client CA list from PEM string
  16417. // Returns a new STACK_OF(X509_NAME)* or nullptr on failure
  16418. // Caller takes ownership of returned list
  16419. inline STACK_OF(X509_NAME) *
  16420. create_client_ca_list_from_pem(const char *ca_pem) {
  16421. if (!ca_pem) { return nullptr; }
  16422. auto ca_list = sk_X509_NAME_new_null();
  16423. if (!ca_list) { return nullptr; }
  16424. BIO *bio = BIO_new_mem_buf(ca_pem, -1);
  16425. if (!bio) {
  16426. sk_X509_NAME_pop_free(ca_list, X509_NAME_free);
  16427. return nullptr;
  16428. }
  16429. X509 *cert = nullptr;
  16430. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16431. nullptr) {
  16432. const X509_NAME *name = X509_get_subject_name(cert);
  16433. if (name) {
  16434. sk_X509_NAME_push(ca_list, X509_NAME_dup(const_cast<X509_NAME *>(name)));
  16435. }
  16436. X509_free(cert);
  16437. }
  16438. BIO_free(bio);
  16439. return ca_list;
  16440. }
  16441. inline void free_verify_callback(void * /*parent*/, void *ptr,
  16442. CRYPTO_EX_DATA * /*ad*/, int /*idx*/,
  16443. long /*argl*/, void * /*argp*/) {
  16444. delete static_cast<VerifyCallback *>(ptr);
  16445. }
  16446. // The SSL_CTX owns its verify callback, so each client or server sees only
  16447. // its own, on whichever thread runs the handshake.
  16448. inline int verify_callback_index() {
  16449. static const auto index = SSL_CTX_get_ex_new_index(
  16450. 0, nullptr, nullptr, nullptr, free_verify_callback);
  16451. return index;
  16452. }
  16453. // OpenSSL verify callback wrapper
  16454. inline int openssl_verify_callback(int preverify_ok, X509_STORE_CTX *ctx) {
  16455. // Get SSL object from X509_STORE_CTX
  16456. auto ssl = static_cast<SSL *>(
  16457. X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
  16458. if (!ssl) { return preverify_ok; }
  16459. auto callback = static_cast<VerifyCallback *>(
  16460. SSL_CTX_get_ex_data(SSL_get_SSL_CTX(ssl), verify_callback_index()));
  16461. if (!callback) { return preverify_ok; }
  16462. // Get current certificate and depth
  16463. auto cert = X509_STORE_CTX_get_current_cert(ctx);
  16464. int depth = X509_STORE_CTX_get_error_depth(ctx);
  16465. int error = X509_STORE_CTX_get_error(ctx);
  16466. // Build context
  16467. VerifyContext verify_ctx;
  16468. verify_ctx.session = static_cast<session_t>(ssl);
  16469. verify_ctx.cert = static_cast<cert_t>(cert);
  16470. verify_ctx.depth = depth;
  16471. verify_ctx.preverify_ok = (preverify_ok != 0);
  16472. verify_ctx.error_code = error;
  16473. verify_ctx.error_string =
  16474. (error != X509_V_OK) ? X509_verify_cert_error_string(error) : nullptr;
  16475. return (*callback)(verify_ctx) ? 1 : 0;
  16476. }
  16477. // X509_STORE_get0_objects is deprecated since OpenSSL 4.0 because it is not
  16478. // thread-safe; X509_STORE_get1_objects (OpenSSL 3.3+) returns a snapshot
  16479. // that must be released with release_store_objects
  16480. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER) && \
  16481. OPENSSL_VERSION_NUMBER >= 0x30300000L
  16482. #define CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16483. #endif
  16484. inline STACK_OF(X509_OBJECT) * get_store_objects(X509_STORE *store) {
  16485. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16486. return X509_STORE_get1_objects(store);
  16487. #else
  16488. return X509_STORE_get0_objects(store);
  16489. #endif
  16490. }
  16491. inline void release_store_objects(STACK_OF(X509_OBJECT) * objs) {
  16492. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16493. sk_X509_OBJECT_pop_free(objs, X509_OBJECT_free);
  16494. #else
  16495. (void)objs; // get0 variant returns an internal pointer; nothing to free
  16496. #endif
  16497. }
  16498. } // namespace impl
  16499. inline ctx_t create_client_context() {
  16500. SSL_CTX *ctx = SSL_CTX_new(TLS_client_method());
  16501. if (ctx) {
  16502. // Disable auto-retry to properly handle non-blocking I/O
  16503. SSL_CTX_clear_mode(ctx, SSL_MODE_AUTO_RETRY);
  16504. // Set minimum TLS version
  16505. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16506. }
  16507. return static_cast<ctx_t>(ctx);
  16508. }
  16509. inline void free_context(ctx_t ctx) {
  16510. if (ctx) { SSL_CTX_free(static_cast<SSL_CTX *>(ctx)); }
  16511. }
  16512. inline bool set_min_version(ctx_t ctx, Version version) {
  16513. if (!ctx) return false;
  16514. return SSL_CTX_set_min_proto_version(static_cast<SSL_CTX *>(ctx),
  16515. static_cast<int>(version)) == 1;
  16516. }
  16517. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  16518. if (!ctx || !pem || len == 0) return false;
  16519. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16520. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16521. if (!store) return false;
  16522. auto bio = BIO_new_mem_buf(pem, static_cast<int>(len));
  16523. if (!bio) return false;
  16524. bool ok = true;
  16525. X509 *cert = nullptr;
  16526. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16527. nullptr) {
  16528. if (X509_STORE_add_cert(store, cert) != 1) {
  16529. // Ignore duplicate errors
  16530. auto err = ERR_peek_last_error();
  16531. if (ERR_GET_REASON(err) != X509_R_CERT_ALREADY_IN_HASH_TABLE) {
  16532. ok = false;
  16533. }
  16534. }
  16535. X509_free(cert);
  16536. if (!ok) break;
  16537. }
  16538. BIO_free(bio);
  16539. // Clear any "no more certificates" errors
  16540. ERR_clear_error();
  16541. return ok;
  16542. }
  16543. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  16544. if (!ctx || !file_path) return false;
  16545. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), file_path,
  16546. nullptr) == 1;
  16547. }
  16548. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  16549. if (!ctx || !dir_path) return false;
  16550. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), nullptr,
  16551. dir_path) == 1;
  16552. }
  16553. inline bool load_system_certs(ctx_t ctx) {
  16554. if (!ctx) return false;
  16555. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16556. #ifdef _WIN32
  16557. // Windows: Load from system certificate store (ROOT and CA)
  16558. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16559. if (!store) return false;
  16560. bool loaded_any = false;
  16561. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16562. for (auto store_name : store_names) {
  16563. auto hStore = CertOpenSystemStoreW(NULL, store_name);
  16564. if (!hStore) continue;
  16565. PCCERT_CONTEXT pContext = nullptr;
  16566. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16567. nullptr) {
  16568. const unsigned char *data = pContext->pbCertEncoded;
  16569. auto x509 = d2i_X509(nullptr, &data, pContext->cbCertEncoded);
  16570. if (x509) {
  16571. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  16572. X509_free(x509);
  16573. }
  16574. }
  16575. CertCloseStore(hStore, 0);
  16576. }
  16577. return loaded_any;
  16578. #elif defined(__APPLE__)
  16579. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16580. // macOS: Load from Keychain
  16581. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16582. if (!store) return false;
  16583. bool loaded_any = false;
  16584. const SecTrustSettingsDomain domains[] = {
  16585. kSecTrustSettingsDomainSystem,
  16586. kSecTrustSettingsDomainAdmin,
  16587. kSecTrustSettingsDomainUser,
  16588. };
  16589. for (auto domain : domains) {
  16590. CFArrayRef certs = nullptr;
  16591. if (SecTrustSettingsCopyCertificates(domain, &certs) != errSecSuccess ||
  16592. !certs) {
  16593. if (certs) CFRelease(certs);
  16594. continue;
  16595. }
  16596. auto count = CFArrayGetCount(certs);
  16597. for (CFIndex i = 0; i < count; i++) {
  16598. auto cert = reinterpret_cast<SecCertificateRef>(
  16599. const_cast<void *>(CFArrayGetValueAtIndex(certs, i)));
  16600. CFDataRef der = SecCertificateCopyData(cert);
  16601. if (der) {
  16602. const unsigned char *data = CFDataGetBytePtr(der);
  16603. auto x509 = d2i_X509(nullptr, &data, CFDataGetLength(der));
  16604. if (x509) {
  16605. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  16606. X509_free(x509);
  16607. }
  16608. CFRelease(der);
  16609. }
  16610. }
  16611. CFRelease(certs);
  16612. }
  16613. return loaded_any || SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16614. #else
  16615. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16616. #endif
  16617. #else
  16618. // Other Unix: use default verify paths
  16619. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16620. #endif
  16621. }
  16622. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16623. const char *password) {
  16624. if (!ctx || !cert || !key) return false;
  16625. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16626. // Load certificate
  16627. auto cert_bio = BIO_new_mem_buf(cert, -1);
  16628. if (!cert_bio) return false;
  16629. auto x509 = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  16630. BIO_free(cert_bio);
  16631. if (!x509) return false;
  16632. auto cert_ok = SSL_CTX_use_certificate(ssl_ctx, x509) == 1;
  16633. X509_free(x509);
  16634. if (!cert_ok) return false;
  16635. // Load private key
  16636. auto key_bio = BIO_new_mem_buf(key, -1);
  16637. if (!key_bio) return false;
  16638. auto pkey = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  16639. password ? const_cast<char *>(password)
  16640. : nullptr);
  16641. BIO_free(key_bio);
  16642. if (!pkey) return false;
  16643. auto key_ok = SSL_CTX_use_PrivateKey(ssl_ctx, pkey) == 1;
  16644. EVP_PKEY_free(pkey);
  16645. return key_ok && SSL_CTX_check_private_key(ssl_ctx) == 1;
  16646. }
  16647. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  16648. const char *key_path, const char *password) {
  16649. if (!ctx || !cert_path || !key_path) return false;
  16650. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16651. if (password && password[0] != '\0') {
  16652. SSL_CTX_set_default_passwd_cb_userdata(
  16653. ssl_ctx, reinterpret_cast<void *>(const_cast<char *>(password)));
  16654. }
  16655. return SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_path) == 1 &&
  16656. SSL_CTX_use_PrivateKey_file(ssl_ctx, key_path, SSL_FILETYPE_PEM) == 1;
  16657. }
  16658. inline ctx_t create_server_context() {
  16659. SSL_CTX *ctx = SSL_CTX_new(TLS_server_method());
  16660. if (ctx) {
  16661. SSL_CTX_set_options(ctx, SSL_OP_NO_COMPRESSION |
  16662. SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION);
  16663. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16664. }
  16665. return static_cast<ctx_t>(ctx);
  16666. }
  16667. inline void set_verify_client(ctx_t ctx, bool require) {
  16668. if (!ctx) return;
  16669. SSL_CTX_set_verify(static_cast<SSL_CTX *>(ctx),
  16670. require
  16671. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  16672. : SSL_VERIFY_NONE,
  16673. nullptr);
  16674. }
  16675. inline session_t create_session(ctx_t ctx, socket_t sock) {
  16676. if (!ctx || sock == INVALID_SOCKET) return nullptr;
  16677. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16678. SSL *ssl = SSL_new(ssl_ctx);
  16679. if (!ssl) return nullptr;
  16680. // Disable auto-retry for proper non-blocking I/O handling
  16681. SSL_clear_mode(ssl, SSL_MODE_AUTO_RETRY);
  16682. auto bio = BIO_new_socket(static_cast<int>(sock), BIO_NOCLOSE);
  16683. if (!bio) {
  16684. SSL_free(ssl);
  16685. return nullptr;
  16686. }
  16687. SSL_set_bio(ssl, bio, bio);
  16688. return static_cast<session_t>(ssl);
  16689. }
  16690. inline void free_session(session_t session) {
  16691. if (session) { SSL_free(static_cast<SSL *>(session)); }
  16692. }
  16693. inline bool set_sni(session_t session, const char *hostname,
  16694. bool /*verify_hostname*/) {
  16695. if (!session || !hostname) return false;
  16696. auto ssl = static_cast<SSL *>(session);
  16697. // Set SNI (Server Name Indication) only - does not enable verification.
  16698. // OpenSSL never binds identity checking to SNI (that happens post-
  16699. // handshake in setup_client_tls_session()), so verify_hostname is unused.
  16700. #if defined(OPENSSL_IS_BORINGSSL)
  16701. return SSL_set_tlsext_host_name(ssl, hostname) == 1;
  16702. #else
  16703. // Direct call instead of macro to suppress -Wold-style-cast warning
  16704. return SSL_ctrl(ssl, SSL_CTRL_SET_TLSEXT_HOSTNAME, TLSEXT_NAMETYPE_host_name,
  16705. static_cast<void *>(const_cast<char *>(hostname))) == 1;
  16706. #endif
  16707. }
  16708. inline TlsError connect(session_t session) {
  16709. if (!session) { return TlsError(); }
  16710. auto ssl = static_cast<SSL *>(session);
  16711. auto ret = SSL_connect(ssl);
  16712. TlsError err;
  16713. if (ret == 1) {
  16714. err.code = ErrorCode::Success;
  16715. } else {
  16716. auto ssl_err = SSL_get_error(ssl, ret);
  16717. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16718. err.backend_code = ERR_get_error();
  16719. }
  16720. return err;
  16721. }
  16722. inline TlsError accept(session_t session) {
  16723. if (!session) { return TlsError(); }
  16724. auto ssl = static_cast<SSL *>(session);
  16725. auto ret = SSL_accept(ssl);
  16726. TlsError err;
  16727. if (ret == 1) {
  16728. err.code = ErrorCode::Success;
  16729. } else {
  16730. auto ssl_err = SSL_get_error(ssl, ret);
  16731. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16732. err.backend_code = ERR_get_error();
  16733. }
  16734. return err;
  16735. }
  16736. inline bool connect_nonblocking(session_t session, socket_t sock,
  16737. time_t timeout_sec, time_t timeout_usec,
  16738. TlsError *err) {
  16739. if (!session) {
  16740. if (err) { err->code = ErrorCode::Fatal; }
  16741. return false;
  16742. }
  16743. auto ssl = static_cast<SSL *>(session);
  16744. auto bio = SSL_get_rbio(ssl);
  16745. // Set non-blocking mode for handshake
  16746. detail::set_nonblocking(sock, true);
  16747. if (bio) { BIO_set_nbio(bio, 1); }
  16748. auto cleanup = detail::scope_exit([&]() {
  16749. // Restore blocking mode after handshake
  16750. if (bio) { BIO_set_nbio(bio, 0); }
  16751. detail::set_nonblocking(sock, false);
  16752. });
  16753. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  16754. auto res = 0;
  16755. while ((res = SSL_connect(ssl)) != 1) {
  16756. auto ssl_err = SSL_get_error(ssl, res);
  16757. switch (ssl_err) {
  16758. case SSL_ERROR_WANT_READ:
  16759. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  16760. break;
  16761. case SSL_ERROR_WANT_WRITE:
  16762. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  16763. break;
  16764. default: break;
  16765. }
  16766. if (err) {
  16767. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  16768. err->backend_code = ERR_get_error();
  16769. }
  16770. return false;
  16771. }
  16772. if (err) { err->code = ErrorCode::Success; }
  16773. return true;
  16774. }
  16775. inline bool accept_nonblocking(session_t session, socket_t sock,
  16776. time_t timeout_sec, time_t timeout_usec,
  16777. TlsError *err) {
  16778. if (!session) {
  16779. if (err) { err->code = ErrorCode::Fatal; }
  16780. return false;
  16781. }
  16782. auto ssl = static_cast<SSL *>(session);
  16783. auto bio = SSL_get_rbio(ssl);
  16784. // Set non-blocking mode for handshake
  16785. detail::set_nonblocking(sock, true);
  16786. if (bio) { BIO_set_nbio(bio, 1); }
  16787. auto cleanup = detail::scope_exit([&]() {
  16788. // Restore blocking mode after handshake
  16789. if (bio) { BIO_set_nbio(bio, 0); }
  16790. detail::set_nonblocking(sock, false);
  16791. });
  16792. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  16793. auto res = 0;
  16794. while ((res = SSL_accept(ssl)) != 1) {
  16795. auto ssl_err = SSL_get_error(ssl, res);
  16796. switch (ssl_err) {
  16797. case SSL_ERROR_WANT_READ:
  16798. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  16799. break;
  16800. case SSL_ERROR_WANT_WRITE:
  16801. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  16802. break;
  16803. default: break;
  16804. }
  16805. if (err) {
  16806. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  16807. err->backend_code = ERR_get_error();
  16808. }
  16809. return false;
  16810. }
  16811. if (err) { err->code = ErrorCode::Success; }
  16812. return true;
  16813. }
  16814. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  16815. if (!session || !buf) {
  16816. err.code = ErrorCode::Fatal;
  16817. return -1;
  16818. }
  16819. auto ssl = static_cast<SSL *>(session);
  16820. constexpr auto max_len =
  16821. static_cast<size_t>((std::numeric_limits<int>::max)());
  16822. if (len > max_len) { len = max_len; }
  16823. auto ret = SSL_read(ssl, buf, static_cast<int>(len));
  16824. if (ret > 0) {
  16825. err.code = ErrorCode::Success;
  16826. return ret;
  16827. }
  16828. auto ssl_err = SSL_get_error(ssl, ret);
  16829. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16830. if (err.code == ErrorCode::PeerClosed) {
  16831. return 0;
  16832. } // Gracefully handle the peer closed state.
  16833. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  16834. return -1;
  16835. }
  16836. inline ssize_t write(session_t session, const void *buf, size_t len,
  16837. TlsError &err) {
  16838. if (!session || !buf) {
  16839. err.code = ErrorCode::Fatal;
  16840. return -1;
  16841. }
  16842. auto ssl = static_cast<SSL *>(session);
  16843. auto ret = SSL_write(ssl, buf, static_cast<int>(len));
  16844. if (ret > 0) {
  16845. err.code = ErrorCode::Success;
  16846. return ret;
  16847. }
  16848. auto ssl_err = SSL_get_error(ssl, ret);
  16849. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16850. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  16851. return -1;
  16852. }
  16853. inline int pending(const_session_t session) {
  16854. if (!session) return 0;
  16855. return SSL_pending(static_cast<SSL *>(const_cast<void *>(session)));
  16856. }
  16857. inline void shutdown(session_t session, bool graceful) {
  16858. if (!session) return;
  16859. auto ssl = static_cast<SSL *>(session);
  16860. if (graceful) {
  16861. // Send close_notify without waiting for the peer's. The connection is
  16862. // closed right after this, so a unidirectional shutdown is enough, and an
  16863. // idle peer that never answers would otherwise hold this thread until the
  16864. // read timeout. The other backends do not wait either.
  16865. SSL_shutdown(ssl);
  16866. }
  16867. }
  16868. inline bool is_peer_closed(session_t session, socket_t sock) {
  16869. if (!session) return true;
  16870. // Temporarily set socket to non-blocking to avoid blocking on SSL_peek
  16871. detail::set_nonblocking(sock, true);
  16872. auto se = detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  16873. auto ssl = static_cast<SSL *>(session);
  16874. char buf;
  16875. auto ret = SSL_peek(ssl, &buf, 1);
  16876. if (ret > 0) return false;
  16877. auto err = SSL_get_error(ssl, ret);
  16878. return err == SSL_ERROR_ZERO_RETURN;
  16879. }
  16880. inline cert_t get_peer_cert(const_session_t session) {
  16881. if (!session) return nullptr;
  16882. return static_cast<cert_t>(SSL_get1_peer_certificate(
  16883. static_cast<SSL *>(const_cast<void *>(session))));
  16884. }
  16885. inline size_t get_peer_certs(const_session_t session,
  16886. std::vector<cert_t> &certs) {
  16887. certs.clear();
  16888. if (!session) { return 0; }
  16889. auto ssl = static_cast<const SSL *>(session);
  16890. // On the server side, the chain leaves out the peer's own certificate
  16891. if (SSL_is_server(ssl)) {
  16892. if (auto leaf = get_peer_cert(session)) { certs.push_back(leaf); }
  16893. }
  16894. auto sk = SSL_get_peer_cert_chain(ssl);
  16895. for (int i = 0; sk && i < sk_X509_num(sk); i++) {
  16896. auto x509 = sk_X509_value(sk, i);
  16897. X509_up_ref(x509);
  16898. certs.push_back(static_cast<cert_t>(x509));
  16899. }
  16900. return certs.size();
  16901. }
  16902. inline void free_cert(cert_t cert) {
  16903. if (cert) { X509_free(static_cast<X509 *>(cert)); }
  16904. }
  16905. inline bool verify_hostname(cert_t cert, const char *hostname) {
  16906. if (!cert || !hostname) return false;
  16907. auto x509 = static_cast<X509 *>(cert);
  16908. // Use X509_check_ip_asc for IP addresses, X509_check_host for DNS names
  16909. if (detail::is_ip_address(hostname)) {
  16910. return X509_check_ip_asc(x509, hostname, 0) == 1;
  16911. }
  16912. return X509_check_host(x509, hostname, strlen(hostname), 0, nullptr) == 1;
  16913. }
  16914. inline uint64_t hostname_mismatch_code() {
  16915. return static_cast<uint64_t>(X509_V_ERR_HOSTNAME_MISMATCH);
  16916. }
  16917. inline long get_verify_result(const_session_t session) {
  16918. if (!session) return X509_V_ERR_UNSPECIFIED;
  16919. return SSL_get_verify_result(static_cast<SSL *>(const_cast<void *>(session)));
  16920. }
  16921. inline std::string get_cert_subject_cn(cert_t cert) {
  16922. if (!cert) return "";
  16923. auto x509 = static_cast<X509 *>(cert);
  16924. auto subject_name = X509_get_subject_name(x509);
  16925. if (!subject_name) return "";
  16926. // X509_NAME_get_text_by_NID is deprecated since OpenSSL 4.0
  16927. auto idx = X509_NAME_get_index_by_NID(subject_name, NID_commonName, -1);
  16928. if (idx < 0) return "";
  16929. auto entry = X509_NAME_get_entry(subject_name, idx);
  16930. if (!entry) return "";
  16931. auto data = X509_NAME_ENTRY_get_data(entry);
  16932. if (!data) return "";
  16933. return std::string(
  16934. reinterpret_cast<const char *>(ASN1_STRING_get0_data(data)),
  16935. static_cast<size_t>(ASN1_STRING_length(data)));
  16936. }
  16937. inline std::string get_cert_issuer_name(cert_t cert) {
  16938. if (!cert) return "";
  16939. auto x509 = static_cast<X509 *>(cert);
  16940. auto issuer_name = X509_get_issuer_name(x509);
  16941. if (!issuer_name) return "";
  16942. char buf[256];
  16943. X509_NAME_oneline(issuer_name, buf, sizeof(buf));
  16944. return std::string(buf);
  16945. }
  16946. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  16947. sans.clear();
  16948. if (!cert) return false;
  16949. auto x509 = static_cast<X509 *>(cert);
  16950. auto names = static_cast<GENERAL_NAMES *>(
  16951. X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  16952. if (!names) return true; // No SANs is valid
  16953. auto count = sk_GENERAL_NAME_num(names);
  16954. for (decltype(count) i = 0; i < count; i++) {
  16955. auto gen = sk_GENERAL_NAME_value(names, i);
  16956. if (!gen) continue;
  16957. SanEntry entry;
  16958. switch (gen->type) {
  16959. case GEN_DNS:
  16960. entry.type = SanType::DNS;
  16961. if (gen->d.dNSName) {
  16962. entry.value = std::string(
  16963. reinterpret_cast<const char *>(
  16964. ASN1_STRING_get0_data(gen->d.dNSName)),
  16965. static_cast<size_t>(ASN1_STRING_length(gen->d.dNSName)));
  16966. }
  16967. break;
  16968. case GEN_IPADD:
  16969. entry.type = SanType::IP;
  16970. if (gen->d.iPAddress) {
  16971. auto data = ASN1_STRING_get0_data(gen->d.iPAddress);
  16972. auto len = ASN1_STRING_length(gen->d.iPAddress);
  16973. if (len == 4) {
  16974. // IPv4
  16975. char buf[INET_ADDRSTRLEN];
  16976. inet_ntop(AF_INET, data, buf, sizeof(buf));
  16977. entry.value = buf;
  16978. } else if (len == 16) {
  16979. // IPv6
  16980. char buf[INET6_ADDRSTRLEN];
  16981. inet_ntop(AF_INET6, data, buf, sizeof(buf));
  16982. entry.value = buf;
  16983. }
  16984. }
  16985. break;
  16986. case GEN_EMAIL:
  16987. entry.type = SanType::EMAIL;
  16988. if (gen->d.rfc822Name) {
  16989. entry.value = std::string(
  16990. reinterpret_cast<const char *>(
  16991. ASN1_STRING_get0_data(gen->d.rfc822Name)),
  16992. static_cast<size_t>(ASN1_STRING_length(gen->d.rfc822Name)));
  16993. }
  16994. break;
  16995. case GEN_URI:
  16996. entry.type = SanType::URI;
  16997. if (gen->d.uniformResourceIdentifier) {
  16998. entry.value = std::string(
  16999. reinterpret_cast<const char *>(
  17000. ASN1_STRING_get0_data(gen->d.uniformResourceIdentifier)),
  17001. static_cast<size_t>(
  17002. ASN1_STRING_length(gen->d.uniformResourceIdentifier)));
  17003. }
  17004. break;
  17005. default: entry.type = SanType::OTHER; break;
  17006. }
  17007. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  17008. }
  17009. GENERAL_NAMES_free(names);
  17010. return true;
  17011. }
  17012. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  17013. time_t &not_after) {
  17014. if (!cert) return false;
  17015. auto x509 = static_cast<X509 *>(cert);
  17016. auto nb = X509_get0_notBefore(x509);
  17017. auto na = X509_get0_notAfter(x509);
  17018. if (!nb || !na) return false;
  17019. ASN1_TIME *epoch = ASN1_TIME_new();
  17020. if (!epoch) return false;
  17021. auto se = detail::scope_exit([&] { ASN1_TIME_free(epoch); });
  17022. if (!ASN1_TIME_set(epoch, 0)) return false;
  17023. int pday, psec;
  17024. if (!ASN1_TIME_diff(&pday, &psec, epoch, nb)) return false;
  17025. not_before = 86400 * (time_t)pday + psec;
  17026. if (!ASN1_TIME_diff(&pday, &psec, epoch, na)) return false;
  17027. not_after = 86400 * (time_t)pday + psec;
  17028. return true;
  17029. }
  17030. inline std::string get_cert_serial(cert_t cert) {
  17031. if (!cert) return "";
  17032. auto x509 = static_cast<X509 *>(cert);
  17033. auto serial = X509_get_serialNumber(x509);
  17034. if (!serial) return "";
  17035. auto bn = ASN1_INTEGER_to_BN(serial, nullptr);
  17036. if (!bn) return "";
  17037. auto hex = BN_bn2hex(bn);
  17038. BN_free(bn);
  17039. if (!hex) return "";
  17040. std::string result(hex);
  17041. OPENSSL_free(hex);
  17042. return result;
  17043. }
  17044. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  17045. if (!cert) return false;
  17046. auto x509 = static_cast<X509 *>(cert);
  17047. auto len = i2d_X509(x509, nullptr);
  17048. if (len < 0) return false;
  17049. der.resize(static_cast<size_t>(len));
  17050. auto p = der.data();
  17051. i2d_X509(x509, &p);
  17052. return true;
  17053. }
  17054. inline const char *get_sni(const_session_t session) {
  17055. if (!session) return nullptr;
  17056. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17057. return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
  17058. }
  17059. inline uint64_t peek_error() { return ERR_peek_last_error(); }
  17060. inline uint64_t get_error() { return ERR_get_error(); }
  17061. inline std::string error_string(uint64_t code) {
  17062. char buf[256];
  17063. ERR_error_string_n(static_cast<unsigned long>(code), buf, sizeof(buf));
  17064. return std::string(buf);
  17065. }
  17066. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  17067. auto mem = BIO_new_mem_buf(pem, static_cast<int>(len));
  17068. if (!mem) { return nullptr; }
  17069. auto mem_guard = detail::scope_exit([&] { BIO_free_all(mem); });
  17070. auto inf = PEM_X509_INFO_read_bio(mem, nullptr, nullptr, nullptr);
  17071. if (!inf) { return nullptr; }
  17072. auto store = X509_STORE_new();
  17073. if (store) {
  17074. for (auto i = 0; i < static_cast<int>(sk_X509_INFO_num(inf)); i++) {
  17075. auto itmp = sk_X509_INFO_value(inf, i);
  17076. if (!itmp) { continue; }
  17077. if (itmp->x509) { X509_STORE_add_cert(store, itmp->x509); }
  17078. if (itmp->crl) { X509_STORE_add_crl(store, itmp->crl); }
  17079. }
  17080. }
  17081. sk_X509_INFO_pop_free(inf, X509_INFO_free);
  17082. return static_cast<ca_store_t>(store);
  17083. }
  17084. inline void free_ca_store(ca_store_t store) {
  17085. if (store) { X509_STORE_free(static_cast<X509_STORE *>(store)); }
  17086. }
  17087. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  17088. if (!ctx || !store) { return false; }
  17089. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17090. auto x509_store = static_cast<X509_STORE *>(store);
  17091. // Check if same store is already set
  17092. if (SSL_CTX_get_cert_store(ssl_ctx) == x509_store) { return true; }
  17093. // SSL_CTX_set_cert_store takes ownership and frees the old store
  17094. SSL_CTX_set_cert_store(ssl_ctx, x509_store);
  17095. return true;
  17096. }
  17097. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  17098. certs.clear();
  17099. if (!ctx) { return 0; }
  17100. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17101. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17102. if (!store) { return 0; }
  17103. auto objs = impl::get_store_objects(store);
  17104. if (!objs) { return 0; }
  17105. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  17106. auto count = sk_X509_OBJECT_num(objs);
  17107. for (decltype(count) i = 0; i < count; i++) {
  17108. auto obj = sk_X509_OBJECT_value(objs, i);
  17109. if (!obj) { continue; }
  17110. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  17111. auto x509 = X509_OBJECT_get0_X509(obj);
  17112. if (x509) {
  17113. // Increment reference count so caller can free it
  17114. X509_up_ref(x509);
  17115. certs.push_back(static_cast<cert_t>(x509));
  17116. }
  17117. }
  17118. }
  17119. return certs.size();
  17120. }
  17121. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  17122. std::vector<std::string> names;
  17123. if (!ctx) { return names; }
  17124. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17125. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17126. if (!store) { return names; }
  17127. auto objs = impl::get_store_objects(store);
  17128. if (!objs) { return names; }
  17129. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  17130. auto count = sk_X509_OBJECT_num(objs);
  17131. for (decltype(count) i = 0; i < count; i++) {
  17132. auto obj = sk_X509_OBJECT_value(objs, i);
  17133. if (!obj) { continue; }
  17134. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  17135. auto x509 = X509_OBJECT_get0_X509(obj);
  17136. if (x509) {
  17137. auto subject = X509_get_subject_name(x509);
  17138. if (subject) {
  17139. char buf[512];
  17140. X509_NAME_oneline(subject, buf, sizeof(buf));
  17141. names.push_back(buf);
  17142. }
  17143. }
  17144. }
  17145. }
  17146. return names;
  17147. }
  17148. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  17149. const char *key_pem, const char *password) {
  17150. if (!ctx || !cert_pem || !key_pem) { return false; }
  17151. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17152. // Load certificate from PEM
  17153. auto cert_bio = BIO_new_mem_buf(cert_pem, -1);
  17154. if (!cert_bio) { return false; }
  17155. auto cert = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  17156. BIO_free(cert_bio);
  17157. if (!cert) { return false; }
  17158. // Load private key from PEM
  17159. auto key_bio = BIO_new_mem_buf(key_pem, -1);
  17160. if (!key_bio) {
  17161. X509_free(cert);
  17162. return false;
  17163. }
  17164. auto key = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  17165. password ? const_cast<char *>(password)
  17166. : nullptr);
  17167. BIO_free(key_bio);
  17168. if (!key) {
  17169. X509_free(cert);
  17170. return false;
  17171. }
  17172. // Update certificate and key
  17173. auto ret = SSL_CTX_use_certificate(ssl_ctx, cert) == 1 &&
  17174. SSL_CTX_use_PrivateKey(ssl_ctx, key) == 1;
  17175. X509_free(cert);
  17176. EVP_PKEY_free(key);
  17177. return ret;
  17178. }
  17179. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  17180. if (!ctx || !ca_pem) { return false; }
  17181. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17182. // Create new X509_STORE from PEM
  17183. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  17184. if (!store) { return false; }
  17185. // SSL_CTX_set_cert_store takes ownership
  17186. SSL_CTX_set_cert_store(ssl_ctx, static_cast<X509_STORE *>(store));
  17187. // Set client CA list for client certificate request
  17188. auto ca_list = impl::create_client_ca_list_from_pem(ca_pem);
  17189. if (ca_list) {
  17190. // SSL_CTX_set_client_CA_list takes ownership of ca_list
  17191. SSL_CTX_set_client_CA_list(ssl_ctx, ca_list);
  17192. }
  17193. return true;
  17194. }
  17195. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  17196. if (!ctx) { return false; }
  17197. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17198. auto index = impl::verify_callback_index();
  17199. if (index < 0) { return false; }
  17200. auto stored = callback ? new VerifyCallback(std::move(callback)) : nullptr;
  17201. delete static_cast<VerifyCallback *>(SSL_CTX_get_ex_data(ssl_ctx, index));
  17202. SSL_CTX_set_ex_data(ssl_ctx, index, stored);
  17203. if (stored) {
  17204. SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, impl::openssl_verify_callback);
  17205. } else {
  17206. SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, nullptr);
  17207. }
  17208. return true;
  17209. }
  17210. inline long get_verify_error(const_session_t session) {
  17211. if (!session) { return -1; }
  17212. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17213. return SSL_get_verify_result(ssl);
  17214. }
  17215. inline std::string verify_error_string(long error_code) {
  17216. if (error_code == X509_V_OK) { return ""; }
  17217. const char *str = X509_verify_cert_error_string(static_cast<int>(error_code));
  17218. return str ? str : "unknown error";
  17219. }
  17220. } // namespace tls
  17221. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  17222. /*
  17223. * Group 9: TLS abstraction layer - Mbed TLS backend
  17224. */
  17225. /*
  17226. * Mbed TLS Backend Implementation
  17227. */
  17228. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  17229. namespace tls {
  17230. namespace impl {
  17231. // Mbed TLS session wrapper
  17232. struct MbedTlsSession {
  17233. mbedtls_ssl_context ssl;
  17234. socket_t sock = INVALID_SOCKET;
  17235. std::string hostname; // For client: set via set_sni
  17236. std::string sni_hostname; // For server: received from client via SNI callback
  17237. // Mbed TLS has no SSL_peek() equivalent, so is_peer_closed() must probe with
  17238. // a real 1-byte mbedtls_ssl_read(). If that probe lands on application data
  17239. // (e.g. a response that arrived while this side was still in its post-write
  17240. // check), the byte is pushed back here and served by the next read().
  17241. unsigned char peeked_byte = 0;
  17242. bool has_peeked_byte = false;
  17243. // Set by set_sni() when the caller disabled hostname verification, so the
  17244. // verify callback can clear the CN/SAN mismatch flag while still enforcing
  17245. // the rest of the chain (Mbed TLS ties SNI and identity checking together;
  17246. // OpenSSL and wolfSSL keep them independent).
  17247. bool suppress_hostname_mismatch = false;
  17248. // Copied from the owning MbedTlsContext at creation, so a handshake only
  17249. // ever runs the callback of its own context.
  17250. VerifyCallback verify_callback;
  17251. MbedTlsSession() { mbedtls_ssl_init(&ssl); }
  17252. ~MbedTlsSession() { mbedtls_ssl_free(&ssl); }
  17253. MbedTlsSession(const MbedTlsSession &) = delete;
  17254. MbedTlsSession &operator=(const MbedTlsSession &) = delete;
  17255. };
  17256. // Thread-local error code accessor for Mbed TLS (since it doesn't have an error
  17257. // queue)
  17258. inline int &mbedtls_last_error() {
  17259. static thread_local int err = 0;
  17260. return err;
  17261. }
  17262. // Helper to map Mbed TLS error to ErrorCode
  17263. inline ErrorCode map_mbedtls_error(int ret, int &out_errno,
  17264. uint32_t verify_flags) {
  17265. if (ret == 0) { return ErrorCode::Success; }
  17266. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return ErrorCode::WantRead; }
  17267. if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) { return ErrorCode::WantWrite; }
  17268. if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
  17269. return ErrorCode::PeerClosed;
  17270. }
  17271. if (ret == MBEDTLS_ERR_NET_CONN_RESET || ret == MBEDTLS_ERR_NET_SEND_FAILED ||
  17272. ret == MBEDTLS_ERR_NET_RECV_FAILED) {
  17273. out_errno = errno;
  17274. return ErrorCode::SyscallError;
  17275. }
  17276. if (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED) {
  17277. // Unlike OpenSSL/wolfSSL, Mbed TLS folds the CN/SAN identity check into
  17278. // the handshake's chain verification (see set_sni()); a mismatch there
  17279. // is reported the same way as any other verify_flags bit. Report it as
  17280. // HostnameMismatch, matching the other backends and the post-handshake
  17281. // identity check below, but only when naming is the sole problem -
  17282. // if the chain itself is also untrusted/expired/etc., that takes
  17283. // priority over the naming detail.
  17284. if (verify_flags == static_cast<uint32_t>(hostname_mismatch_code())) {
  17285. return ErrorCode::HostnameMismatch;
  17286. }
  17287. return ErrorCode::CertVerifyFailed;
  17288. }
  17289. return ErrorCode::Fatal;
  17290. }
  17291. // Populates a TlsError from a failed (non-zero) mbedtls_ssl_handshake()
  17292. // return value, including the verify-flags-dependent HostnameMismatch
  17293. // mapping; shared by connect() and connect_nonblocking() so the
  17294. // backend_code policy for that mapping only lives in one place.
  17295. inline void fill_mbedtls_tls_error(TlsError &err, mbedtls_ssl_context &ssl,
  17296. int ret) {
  17297. auto verify_flags = mbedtls_ssl_get_verify_result(&ssl);
  17298. err.code = map_mbedtls_error(ret, err.sys_errno, verify_flags);
  17299. err.backend_code = err.code == ErrorCode::HostnameMismatch
  17300. ? static_cast<uint64_t>(verify_flags)
  17301. : static_cast<uint64_t>(-ret);
  17302. }
  17303. // A TLS 1.3 NewSessionTicket (signaled by default on Mbed TLS 4.x) is a
  17304. // non-fatal notification delivered between records, not an error and not
  17305. // application data, so I/O calls that see it should just be retried. Kept in
  17306. // one helper so the retry loops keep an intact "do { } while (...)" instead of
  17307. // splitting the closing brace across an #if.
  17308. inline bool mbedtls_is_session_ticket(int ret) {
  17309. #if defined(MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET)
  17310. return ret == MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
  17311. #else
  17312. (void)ret;
  17313. return false;
  17314. #endif
  17315. }
  17316. // BIO-like send callback for Mbed TLS
  17317. inline int mbedtls_net_send_cb(void *ctx, const unsigned char *buf,
  17318. size_t len) {
  17319. auto sock = *static_cast<socket_t *>(ctx);
  17320. #ifdef _WIN32
  17321. auto ret =
  17322. send(sock, reinterpret_cast<const char *>(buf), static_cast<int>(len), 0);
  17323. if (ret == SOCKET_ERROR) {
  17324. int err = WSAGetLastError();
  17325. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_WRITE; }
  17326. return MBEDTLS_ERR_NET_SEND_FAILED;
  17327. }
  17328. #else
  17329. auto ret = send(sock, buf, len, 0);
  17330. if (ret < 0) {
  17331. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17332. return MBEDTLS_ERR_SSL_WANT_WRITE;
  17333. }
  17334. return MBEDTLS_ERR_NET_SEND_FAILED;
  17335. }
  17336. #endif
  17337. return static_cast<int>(ret);
  17338. }
  17339. // BIO-like recv callback for Mbed TLS
  17340. inline int mbedtls_net_recv_cb(void *ctx, unsigned char *buf, size_t len) {
  17341. auto sock = *static_cast<socket_t *>(ctx);
  17342. #ifdef _WIN32
  17343. auto ret =
  17344. recv(sock, reinterpret_cast<char *>(buf), static_cast<int>(len), 0);
  17345. if (ret == SOCKET_ERROR) {
  17346. int err = WSAGetLastError();
  17347. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_READ; }
  17348. return MBEDTLS_ERR_NET_RECV_FAILED;
  17349. }
  17350. #else
  17351. auto ret = recv(sock, buf, len, 0);
  17352. if (ret < 0) {
  17353. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17354. return MBEDTLS_ERR_SSL_WANT_READ;
  17355. }
  17356. return MBEDTLS_ERR_NET_RECV_FAILED;
  17357. }
  17358. #endif
  17359. if (ret == 0) { return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY; }
  17360. return static_cast<int>(ret);
  17361. }
  17362. // MbedTlsContext constructor/destructor implementations
  17363. inline MbedTlsContext::MbedTlsContext() {
  17364. mbedtls_ssl_config_init(&conf);
  17365. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17366. mbedtls_entropy_init(&entropy);
  17367. mbedtls_ctr_drbg_init(&ctr_drbg);
  17368. #endif
  17369. mbedtls_x509_crt_init(&ca_chain);
  17370. mbedtls_x509_crt_init(&own_cert);
  17371. mbedtls_pk_init(&own_key);
  17372. }
  17373. inline MbedTlsContext::~MbedTlsContext() {
  17374. mbedtls_pk_free(&own_key);
  17375. mbedtls_x509_crt_free(&own_cert);
  17376. mbedtls_x509_crt_free(&ca_chain);
  17377. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17378. mbedtls_ctr_drbg_free(&ctr_drbg);
  17379. mbedtls_entropy_free(&entropy);
  17380. #endif
  17381. mbedtls_ssl_config_free(&conf);
  17382. }
  17383. // Thread-local storage for SNI captured during handshake
  17384. // This is needed because the SNI callback doesn't have a way to pass
  17385. // session-specific data before the session is fully set up
  17386. inline std::string &mbedpending_sni() {
  17387. static thread_local std::string sni;
  17388. return sni;
  17389. }
  17390. // SNI callback for Mbed TLS server to capture client's SNI hostname
  17391. inline int mbedtls_sni_callback(void *p_ctx, mbedtls_ssl_context *ssl,
  17392. const unsigned char *name, size_t name_len) {
  17393. (void)p_ctx;
  17394. (void)ssl;
  17395. // Store SNI name in thread-local storage
  17396. // It will be retrieved and stored in the session after handshake
  17397. if (name && name_len > 0) {
  17398. mbedpending_sni().assign(reinterpret_cast<const char *>(name), name_len);
  17399. } else {
  17400. mbedpending_sni().clear();
  17401. }
  17402. return 0; // Accept any SNI
  17403. }
  17404. inline void mbedtls_clear_cn_mismatch(uint32_t *flags) {
  17405. *flags &= ~static_cast<uint32_t>(hostname_mismatch_code());
  17406. }
  17407. // Verify callback used when hostname verification is disabled for a session
  17408. // that has no user-supplied verify callback of its own.
  17409. inline int mbedtls_mask_hostname_mismatch_callback(void *data,
  17410. mbedtls_x509_crt *, int,
  17411. uint32_t *flags) {
  17412. (void)data;
  17413. mbedtls_clear_cn_mismatch(flags);
  17414. return 0;
  17415. }
  17416. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  17417. int cert_depth, uint32_t *flags);
  17418. // MbedTLS verify callback wrapper
  17419. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  17420. int cert_depth, uint32_t *flags) {
  17421. // data points to the MbedTlsSession
  17422. auto *session = static_cast<MbedTlsSession *>(data);
  17423. // set_sni() disabled hostname verification for this session: drop the
  17424. // CN/SAN mismatch flag so it doesn't fail the chain check below, mirroring
  17425. // the OpenSSL/wolfSSL backends where identity checking is independent of
  17426. // SNI. The final pass/fail decision still comes from the remaining flags
  17427. // (or, below, from the user's own verify callback).
  17428. if (session->suppress_hostname_mismatch) { mbedtls_clear_cn_mismatch(flags); }
  17429. // Build context
  17430. VerifyContext verify_ctx;
  17431. verify_ctx.session = static_cast<session_t>(session);
  17432. verify_ctx.cert = static_cast<cert_t>(crt);
  17433. verify_ctx.depth = cert_depth;
  17434. verify_ctx.preverify_ok = (*flags == 0);
  17435. verify_ctx.error_code = static_cast<long>(*flags);
  17436. // Convert Mbed TLS flags to error string
  17437. static thread_local char error_buf[256];
  17438. if (*flags != 0) {
  17439. mbedtls_x509_crt_verify_info(error_buf, sizeof(error_buf), "", *flags);
  17440. verify_ctx.error_string = error_buf;
  17441. } else {
  17442. verify_ctx.error_string = nullptr;
  17443. }
  17444. bool accepted = session->verify_callback(verify_ctx);
  17445. if (accepted) {
  17446. *flags = 0; // Clear all error flags
  17447. return 0;
  17448. }
  17449. return MBEDTLS_ERR_X509_CERT_VERIFY_FAILED;
  17450. }
  17451. } // namespace impl
  17452. inline ctx_t create_client_context() {
  17453. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17454. if (!ctx) { return nullptr; }
  17455. ctx->is_server = false;
  17456. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17457. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17458. if (!detail::ensure_mbedtls_psa_crypto()) {
  17459. delete ctx;
  17460. return nullptr;
  17461. }
  17462. int ret;
  17463. #else
  17464. // Seed the random number generator
  17465. const char *pers = "httplib_client";
  17466. int ret = mbedtls_ctr_drbg_seed(
  17467. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  17468. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  17469. if (ret != 0) {
  17470. impl::mbedtls_last_error() = ret;
  17471. delete ctx;
  17472. return nullptr;
  17473. }
  17474. #endif
  17475. // Set up SSL config for client
  17476. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_CLIENT,
  17477. MBEDTLS_SSL_TRANSPORT_STREAM,
  17478. MBEDTLS_SSL_PRESET_DEFAULT);
  17479. if (ret != 0) {
  17480. impl::mbedtls_last_error() = ret;
  17481. delete ctx;
  17482. return nullptr;
  17483. }
  17484. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17485. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17486. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17487. #endif
  17488. // Default: verify peer certificate
  17489. mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  17490. // Set minimum TLS version to 1.2
  17491. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17492. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17493. #else
  17494. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17495. MBEDTLS_SSL_MINOR_VERSION_3);
  17496. #endif
  17497. return static_cast<ctx_t>(ctx);
  17498. }
  17499. inline ctx_t create_server_context() {
  17500. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17501. if (!ctx) { return nullptr; }
  17502. ctx->is_server = true;
  17503. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17504. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17505. if (!detail::ensure_mbedtls_psa_crypto()) {
  17506. delete ctx;
  17507. return nullptr;
  17508. }
  17509. int ret;
  17510. #else
  17511. // Seed the random number generator
  17512. const char *pers = "httplib_server";
  17513. int ret = mbedtls_ctr_drbg_seed(
  17514. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  17515. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  17516. if (ret != 0) {
  17517. impl::mbedtls_last_error() = ret;
  17518. delete ctx;
  17519. return nullptr;
  17520. }
  17521. #endif
  17522. // Set up SSL config for server
  17523. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_SERVER,
  17524. MBEDTLS_SSL_TRANSPORT_STREAM,
  17525. MBEDTLS_SSL_PRESET_DEFAULT);
  17526. if (ret != 0) {
  17527. impl::mbedtls_last_error() = ret;
  17528. delete ctx;
  17529. return nullptr;
  17530. }
  17531. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17532. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17533. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17534. #endif
  17535. // Default: don't verify client
  17536. mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_NONE);
  17537. // Set minimum TLS version to 1.2
  17538. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17539. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17540. #else
  17541. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17542. MBEDTLS_SSL_MINOR_VERSION_3);
  17543. #endif
  17544. // Set SNI callback to capture client's SNI hostname
  17545. mbedtls_ssl_conf_sni(&ctx->conf, impl::mbedtls_sni_callback, nullptr);
  17546. return static_cast<ctx_t>(ctx);
  17547. }
  17548. inline void free_context(ctx_t ctx) {
  17549. if (ctx) { delete static_cast<impl::MbedTlsContext *>(ctx); }
  17550. }
  17551. inline bool set_min_version(ctx_t ctx, Version version) {
  17552. if (!ctx) { return false; }
  17553. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17554. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17555. // Mbed TLS 3.x uses mbedtls_ssl_protocol_version enum
  17556. mbedtls_ssl_protocol_version min_ver = MBEDTLS_SSL_VERSION_TLS1_2;
  17557. if (version >= Version::TLS1_3) {
  17558. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  17559. min_ver = MBEDTLS_SSL_VERSION_TLS1_3;
  17560. #endif
  17561. }
  17562. mbedtls_ssl_conf_min_tls_version(&mctx->conf, min_ver);
  17563. #else
  17564. // Mbed TLS 2.x uses major/minor version numbers
  17565. int major = MBEDTLS_SSL_MAJOR_VERSION_3;
  17566. int minor = MBEDTLS_SSL_MINOR_VERSION_3; // TLS 1.2
  17567. if (version >= Version::TLS1_3) {
  17568. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  17569. minor = MBEDTLS_SSL_MINOR_VERSION_4; // TLS 1.3
  17570. #else
  17571. minor = MBEDTLS_SSL_MINOR_VERSION_3; // Fall back to TLS 1.2
  17572. #endif
  17573. }
  17574. mbedtls_ssl_conf_min_version(&mctx->conf, major, minor);
  17575. #endif
  17576. return true;
  17577. }
  17578. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  17579. if (!ctx || !pem) { return false; }
  17580. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17581. // mbedtls_x509_crt_parse expects null-terminated string for PEM
  17582. // Add null terminator if not present
  17583. std::string pem_str(pem, len);
  17584. int ret = mbedtls_x509_crt_parse(
  17585. &mctx->ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  17586. pem_str.size() + 1);
  17587. if (ret != 0) {
  17588. impl::mbedtls_last_error() = ret;
  17589. return false;
  17590. }
  17591. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17592. return true;
  17593. }
  17594. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  17595. if (!ctx || !file_path) { return false; }
  17596. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17597. int ret = mbedtls_x509_crt_parse_file(&mctx->ca_chain, file_path);
  17598. if (ret != 0) {
  17599. impl::mbedtls_last_error() = ret;
  17600. return false;
  17601. }
  17602. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17603. return true;
  17604. }
  17605. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  17606. if (!ctx || !dir_path) { return false; }
  17607. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17608. int ret = mbedtls_x509_crt_parse_path(&mctx->ca_chain, dir_path);
  17609. if (ret < 0) { // Returns number of certs on success, negative on error
  17610. impl::mbedtls_last_error() = ret;
  17611. return false;
  17612. }
  17613. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17614. return true;
  17615. }
  17616. inline bool load_system_certs(ctx_t ctx) {
  17617. if (!ctx) { return false; }
  17618. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17619. bool loaded = false;
  17620. #ifdef _WIN32
  17621. loaded = impl::enumerate_windows_system_certs(
  17622. [&](const unsigned char *data, size_t len) {
  17623. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  17624. });
  17625. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  17626. loaded = impl::enumerate_macos_keychain_certs(
  17627. [&](const unsigned char *data, size_t len) {
  17628. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  17629. });
  17630. #else
  17631. for (auto path = impl::system_ca_paths(); *path; ++path) {
  17632. if (mbedtls_x509_crt_parse_file(&mctx->ca_chain, *path) >= 0) {
  17633. loaded = true;
  17634. break;
  17635. }
  17636. }
  17637. if (!loaded) {
  17638. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  17639. if (mbedtls_x509_crt_parse_path(&mctx->ca_chain, *dir) >= 0) {
  17640. loaded = true;
  17641. break;
  17642. }
  17643. }
  17644. }
  17645. #endif
  17646. if (loaded) {
  17647. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17648. }
  17649. return loaded;
  17650. }
  17651. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17652. const char *password) {
  17653. if (!ctx || !cert || !key) { return false; }
  17654. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17655. // Parse certificate
  17656. std::string cert_str(cert);
  17657. int ret = mbedtls_x509_crt_parse(
  17658. &mctx->own_cert,
  17659. reinterpret_cast<const unsigned char *>(cert_str.c_str()),
  17660. cert_str.size() + 1);
  17661. if (ret != 0) {
  17662. impl::mbedtls_last_error() = ret;
  17663. return false;
  17664. }
  17665. // Parse private key
  17666. std::string key_str(key);
  17667. const unsigned char *pwd =
  17668. password ? reinterpret_cast<const unsigned char *>(password) : nullptr;
  17669. size_t pwd_len = password ? strlen(password) : 0;
  17670. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17671. ret = mbedtls_pk_parse_key(
  17672. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  17673. key_str.size() + 1, pwd, pwd_len, mbedtls_ctr_drbg_random,
  17674. &mctx->ctr_drbg);
  17675. #else
  17676. ret = mbedtls_pk_parse_key(
  17677. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  17678. key_str.size() + 1, pwd, pwd_len);
  17679. #endif
  17680. if (ret != 0) {
  17681. impl::mbedtls_last_error() = ret;
  17682. return false;
  17683. }
  17684. // Verify that the certificate and private key match.
  17685. // Mbed TLS 4.x: mbedtls_pk_check_pair() reports a spurious mismatch for
  17686. // PSA-backed keys, so skip it and let the handshake surface a real mismatch.
  17687. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17688. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17689. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  17690. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17691. #else
  17692. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  17693. #endif
  17694. if (ret != 0) {
  17695. impl::mbedtls_last_error() = ret;
  17696. return false;
  17697. }
  17698. #endif
  17699. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  17700. if (ret != 0) {
  17701. impl::mbedtls_last_error() = ret;
  17702. return false;
  17703. }
  17704. return true;
  17705. }
  17706. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  17707. const char *key_path, const char *password) {
  17708. if (!ctx || !cert_path || !key_path) { return false; }
  17709. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17710. // Parse certificate file
  17711. int ret = mbedtls_x509_crt_parse_file(&mctx->own_cert, cert_path);
  17712. if (ret != 0) {
  17713. impl::mbedtls_last_error() = ret;
  17714. return false;
  17715. }
  17716. // Parse private key file
  17717. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17718. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password,
  17719. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17720. #else
  17721. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password);
  17722. #endif
  17723. if (ret != 0) {
  17724. impl::mbedtls_last_error() = ret;
  17725. return false;
  17726. }
  17727. // Verify that the certificate and private key match.
  17728. // Mbed TLS 4.x: see set_client_cert() — skip the spurious check_pair.
  17729. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17730. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17731. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  17732. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17733. #else
  17734. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  17735. #endif
  17736. if (ret != 0) {
  17737. impl::mbedtls_last_error() = ret;
  17738. return false;
  17739. }
  17740. #endif
  17741. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  17742. if (ret != 0) {
  17743. impl::mbedtls_last_error() = ret;
  17744. return false;
  17745. }
  17746. return true;
  17747. }
  17748. inline void set_verify_client(ctx_t ctx, bool require) {
  17749. if (!ctx) { return; }
  17750. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17751. mctx->verify_client = require;
  17752. if (require) {
  17753. mbedtls_ssl_conf_authmode(&mctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  17754. } else {
  17755. // If a verify callback is set, use OPTIONAL mode to ensure the callback
  17756. // is called (matching OpenSSL behavior). Otherwise use NONE.
  17757. mbedtls_ssl_conf_authmode(&mctx->conf, mctx->verify_callback
  17758. ? MBEDTLS_SSL_VERIFY_OPTIONAL
  17759. : MBEDTLS_SSL_VERIFY_NONE);
  17760. }
  17761. }
  17762. inline session_t create_session(ctx_t ctx, socket_t sock) {
  17763. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  17764. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17765. auto session = new (std::nothrow) impl::MbedTlsSession();
  17766. if (!session) { return nullptr; }
  17767. session->sock = sock;
  17768. int ret = mbedtls_ssl_setup(&session->ssl, &mctx->conf);
  17769. if (ret != 0) {
  17770. impl::mbedtls_last_error() = ret;
  17771. delete session;
  17772. return nullptr;
  17773. }
  17774. // Explicitly opt out of in-handshake hostname verification by default;
  17775. // since Mbed TLS 3.6.4 a client handshake with certificate verification
  17776. // fails outright when no hostname was set. set_sni() installs the real
  17777. // hostname for DNS hosts; for IP hosts (where SNI must not be set) the
  17778. // caller verifies the certificate identity post-handshake via
  17779. // verify_hostname().
  17780. mbedtls_ssl_set_hostname(&session->ssl, nullptr);
  17781. // Set BIO callbacks
  17782. mbedtls_ssl_set_bio(&session->ssl, &session->sock, impl::mbedtls_net_send_cb,
  17783. impl::mbedtls_net_recv_cb, nullptr);
  17784. // Set per-session verify callback with session pointer if callback is
  17785. // registered
  17786. session->verify_callback = mctx->verify_callback;
  17787. if (session->verify_callback) {
  17788. mbedtls_ssl_set_verify(&session->ssl, impl::mbedtls_verify_callback,
  17789. session);
  17790. }
  17791. return static_cast<session_t>(session);
  17792. }
  17793. inline void free_session(session_t session) {
  17794. if (session) { delete static_cast<impl::MbedTlsSession *>(session); }
  17795. }
  17796. inline bool set_sni(session_t session, const char *hostname,
  17797. bool verify_hostname) {
  17798. if (!session || !hostname) { return false; }
  17799. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17800. // mbedtls_ssl_set_hostname() both sends the SNI extension and binds the
  17801. // handshake-time CN/SAN check to `hostname`; the two can't be requested
  17802. // independently, so a disabled hostname check is handled below by masking
  17803. // the resulting mismatch flag instead of skipping this call.
  17804. int ret = mbedtls_ssl_set_hostname(&msession->ssl, hostname);
  17805. if (ret != 0) {
  17806. impl::mbedtls_last_error() = ret;
  17807. return false;
  17808. }
  17809. msession->hostname = hostname;
  17810. if (!verify_hostname) {
  17811. msession->suppress_hostname_mismatch = true;
  17812. // If a user verify callback is already wired for this session,
  17813. // mbedtls_verify_callback() masks the mismatch flag itself before
  17814. // consulting it (see suppress_hostname_mismatch above) - reinstalling it
  17815. // here would be redundant. Otherwise install the masking callback alone.
  17816. if (!msession->verify_callback) {
  17817. mbedtls_ssl_set_verify(&msession->ssl,
  17818. impl::mbedtls_mask_hostname_mismatch_callback,
  17819. msession);
  17820. }
  17821. }
  17822. return true;
  17823. }
  17824. inline TlsError connect(session_t session) {
  17825. TlsError err;
  17826. if (!session) {
  17827. err.code = ErrorCode::Fatal;
  17828. return err;
  17829. }
  17830. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17831. int ret;
  17832. do {
  17833. ret = mbedtls_ssl_handshake(&msession->ssl);
  17834. } while (impl::mbedtls_is_session_ticket(ret));
  17835. if (ret == 0) {
  17836. err.code = ErrorCode::Success;
  17837. } else {
  17838. impl::fill_mbedtls_tls_error(err, msession->ssl, ret);
  17839. impl::mbedtls_last_error() = ret;
  17840. }
  17841. return err;
  17842. }
  17843. inline TlsError accept(session_t session) {
  17844. // Same as connect for Mbed TLS - handshake works for both client and server
  17845. auto result = connect(session);
  17846. // After successful handshake, capture SNI from thread-local storage
  17847. if (result.code == ErrorCode::Success && session) {
  17848. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17849. msession->sni_hostname = std::move(impl::mbedpending_sni());
  17850. impl::mbedpending_sni().clear();
  17851. }
  17852. return result;
  17853. }
  17854. inline bool connect_nonblocking(session_t session, socket_t sock,
  17855. time_t timeout_sec, time_t timeout_usec,
  17856. TlsError *err) {
  17857. if (!session) {
  17858. if (err) { err->code = ErrorCode::Fatal; }
  17859. return false;
  17860. }
  17861. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17862. // Set socket to non-blocking mode
  17863. detail::set_nonblocking(sock, true);
  17864. auto cleanup =
  17865. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17866. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  17867. int ret;
  17868. while ((ret = mbedtls_ssl_handshake(&msession->ssl)) != 0) {
  17869. // Non-fatal TLS 1.3 ticket; retry immediately.
  17870. if (impl::mbedtls_is_session_ticket(ret)) { continue; }
  17871. if (ret == MBEDTLS_ERR_SSL_WANT_READ) {
  17872. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  17873. } else if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) {
  17874. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  17875. }
  17876. // TlsError or timeout
  17877. if (err) { impl::fill_mbedtls_tls_error(*err, msession->ssl, ret); }
  17878. impl::mbedtls_last_error() = ret;
  17879. return false;
  17880. }
  17881. if (err) { err->code = ErrorCode::Success; }
  17882. return true;
  17883. }
  17884. inline bool accept_nonblocking(session_t session, socket_t sock,
  17885. time_t timeout_sec, time_t timeout_usec,
  17886. TlsError *err) {
  17887. // Same implementation as connect for Mbed TLS
  17888. bool result =
  17889. connect_nonblocking(session, sock, timeout_sec, timeout_usec, err);
  17890. // After successful handshake, capture SNI from thread-local storage
  17891. if (result && session) {
  17892. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17893. msession->sni_hostname = std::move(impl::mbedpending_sni());
  17894. impl::mbedpending_sni().clear();
  17895. }
  17896. return result;
  17897. }
  17898. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  17899. if (!session || !buf) {
  17900. err.code = ErrorCode::Fatal;
  17901. return -1;
  17902. }
  17903. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17904. // Serve a byte consumed by the is_peer_closed() probe before reading more.
  17905. if (msession->has_peeked_byte) {
  17906. if (len == 0) { return 0; }
  17907. auto p = static_cast<unsigned char *>(buf);
  17908. p[0] = msession->peeked_byte;
  17909. msession->has_peeked_byte = false;
  17910. size_t n = 1;
  17911. // Top up with any already-decrypted bytes without risking a block.
  17912. if (len > 1 && mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  17913. int extra = mbedtls_ssl_read(&msession->ssl, p + 1, len - 1);
  17914. if (extra > 0) { n += static_cast<size_t>(extra); }
  17915. }
  17916. err.code = ErrorCode::Success;
  17917. return static_cast<ssize_t>(n);
  17918. }
  17919. int ret;
  17920. do {
  17921. ret = mbedtls_ssl_read(&msession->ssl, static_cast<unsigned char *>(buf),
  17922. len);
  17923. } while (impl::mbedtls_is_session_ticket(ret));
  17924. if (ret > 0) {
  17925. err.code = ErrorCode::Success;
  17926. return static_cast<ssize_t>(ret);
  17927. }
  17928. if (ret == 0) {
  17929. err.code = ErrorCode::PeerClosed;
  17930. return 0;
  17931. }
  17932. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  17933. err.backend_code = static_cast<uint64_t>(-ret);
  17934. impl::mbedtls_last_error() = ret;
  17935. // mbedTLS signals a clean close_notify via a negative error code rather
  17936. // than 0; surface it as a clean EOF the way OpenSSL/wolfSSL do.
  17937. if (err.code == ErrorCode::PeerClosed) { return 0; }
  17938. return -1;
  17939. }
  17940. inline ssize_t write(session_t session, const void *buf, size_t len,
  17941. TlsError &err) {
  17942. if (!session || !buf) {
  17943. err.code = ErrorCode::Fatal;
  17944. return -1;
  17945. }
  17946. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17947. int ret;
  17948. do {
  17949. ret = mbedtls_ssl_write(&msession->ssl,
  17950. static_cast<const unsigned char *>(buf), len);
  17951. } while (impl::mbedtls_is_session_ticket(ret));
  17952. if (ret > 0) {
  17953. err.code = ErrorCode::Success;
  17954. return static_cast<ssize_t>(ret);
  17955. }
  17956. if (ret == 0) {
  17957. err.code = ErrorCode::PeerClosed;
  17958. return 0;
  17959. }
  17960. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  17961. err.backend_code = static_cast<uint64_t>(-ret);
  17962. impl::mbedtls_last_error() = ret;
  17963. return -1;
  17964. }
  17965. inline int pending(const_session_t session) {
  17966. if (!session) { return 0; }
  17967. auto msession =
  17968. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17969. return static_cast<int>(mbedtls_ssl_get_bytes_avail(&msession->ssl)) +
  17970. (msession->has_peeked_byte ? 1 : 0);
  17971. }
  17972. inline void shutdown(session_t session, bool graceful) {
  17973. if (!session) { return; }
  17974. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17975. if (graceful) {
  17976. // Try to send close_notify, but don't block forever
  17977. int ret;
  17978. int attempts = 0;
  17979. while ((ret = mbedtls_ssl_close_notify(&msession->ssl)) != 0 &&
  17980. attempts < 3) {
  17981. if (ret != MBEDTLS_ERR_SSL_WANT_READ &&
  17982. ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
  17983. break;
  17984. }
  17985. attempts++;
  17986. }
  17987. }
  17988. }
  17989. inline bool is_peer_closed(session_t session, socket_t sock) {
  17990. if (!session || sock == INVALID_SOCKET) { return true; }
  17991. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17992. // Check if there's already decrypted or pushed-back data available.
  17993. // If so, the connection is definitely alive.
  17994. if (msession->has_peeked_byte ||
  17995. mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  17996. return false;
  17997. }
  17998. // Set socket to non-blocking to avoid blocking on read
  17999. detail::set_nonblocking(sock, true);
  18000. auto cleanup =
  18001. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18002. // Probe with a 1-byte read (Mbed TLS has no peek API). If the probe lands
  18003. // on application data — e.g. a response that already arrived — push the
  18004. // byte back so the next read() delivers it instead of losing it.
  18005. unsigned char buf;
  18006. int ret;
  18007. do {
  18008. ret = mbedtls_ssl_read(&msession->ssl, &buf, 1);
  18009. } while (impl::mbedtls_is_session_ticket(ret));
  18010. // If we got data or WANT_READ (would block), connection is alive
  18011. if (ret > 0) {
  18012. msession->peeked_byte = buf;
  18013. msession->has_peeked_byte = true;
  18014. return false;
  18015. }
  18016. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return false; }
  18017. // If we get a peer close notify or a connection reset, the peer is closed
  18018. return ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY ||
  18019. ret == MBEDTLS_ERR_NET_CONN_RESET || ret == 0;
  18020. }
  18021. inline cert_t get_peer_cert(const_session_t session) {
  18022. if (!session) { return nullptr; }
  18023. auto msession =
  18024. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18025. // Mbed TLS returns a pointer to the internal peer cert chain.
  18026. // WARNING: This pointer is only valid while the session is active.
  18027. // Do not use the certificate after calling free_session().
  18028. const mbedtls_x509_crt *cert = mbedtls_ssl_get_peer_cert(&msession->ssl);
  18029. return const_cast<mbedtls_x509_crt *>(cert);
  18030. }
  18031. inline size_t get_peer_certs(const_session_t session,
  18032. std::vector<cert_t> &certs) {
  18033. certs.clear();
  18034. // Mbed TLS parses the whole received chain into a list headed by the peer
  18035. // certificate, owned by the session like get_peer_cert()'s result
  18036. for (auto crt = static_cast<mbedtls_x509_crt *>(get_peer_cert(session));
  18037. crt && crt->raw.len > 0; crt = crt->next) {
  18038. certs.push_back(static_cast<cert_t>(crt));
  18039. }
  18040. return certs.size();
  18041. }
  18042. inline void free_cert(cert_t cert) {
  18043. // Mbed TLS: peer certificate is owned by the SSL context.
  18044. // No-op here, but callers should still call this for cross-backend
  18045. // portability.
  18046. (void)cert;
  18047. }
  18048. inline bool verify_hostname(cert_t cert, const char *hostname) {
  18049. if (!cert || !hostname) { return false; }
  18050. auto mcert = static_cast<const mbedtls_x509_crt *>(cert);
  18051. std::string host_str(hostname);
  18052. // Check if hostname is an IP address (IPv4 or IPv6)
  18053. unsigned char ip_bytes[16];
  18054. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  18055. auto is_ip = ip_len > 0;
  18056. // Check Subject Alternative Names (SAN). Mbed TLS keeps the GeneralName type
  18057. // in buf.tag and the raw value in buf.p / buf.len.
  18058. const mbedtls_x509_sequence *san = &mcert->subject_alt_names;
  18059. while (san != nullptr && san->buf.p != nullptr && san->buf.len > 0) {
  18060. const unsigned char *p = san->buf.p;
  18061. size_t len = san->buf.len;
  18062. auto san_type = san->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK;
  18063. if (is_ip) {
  18064. // For an IP host, only a matching iPAddress SAN of the same family
  18065. // (4 bytes for IPv4, 16 bytes for IPv6) may authenticate it.
  18066. if (san_type == MBEDTLS_X509_SAN_IP_ADDRESS && len == ip_len &&
  18067. memcmp(p, ip_bytes, ip_len) == 0) {
  18068. return true;
  18069. }
  18070. } else if (san_type == MBEDTLS_X509_SAN_DNS_NAME) {
  18071. std::string san_name(reinterpret_cast<const char *>(p), len);
  18072. if (detail::match_hostname(san_name, host_str)) { return true; }
  18073. }
  18074. san = san->next;
  18075. }
  18076. // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
  18077. // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
  18078. // the OpenSSL backend's X509_check_ip behaves the same way).
  18079. if (!is_ip) {
  18080. char cn[256];
  18081. int ret = mbedtls_x509_dn_gets(cn, sizeof(cn), &mcert->subject);
  18082. if (ret > 0) {
  18083. std::string cn_str(cn);
  18084. // Look for "CN=" in the DN string
  18085. size_t cn_pos = cn_str.find("CN=");
  18086. if (cn_pos != std::string::npos) {
  18087. size_t start = cn_pos + 3;
  18088. size_t end = cn_str.find(',', start);
  18089. std::string cn_value =
  18090. cn_str.substr(start, end == std::string::npos ? end : end - start);
  18091. if (detail::match_hostname(cn_value, host_str)) { return true; }
  18092. }
  18093. }
  18094. }
  18095. return false;
  18096. }
  18097. inline uint64_t hostname_mismatch_code() {
  18098. return static_cast<uint64_t>(MBEDTLS_X509_BADCERT_CN_MISMATCH);
  18099. }
  18100. inline long get_verify_result(const_session_t session) {
  18101. if (!session) { return -1; }
  18102. auto msession =
  18103. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18104. uint32_t flags = mbedtls_ssl_get_verify_result(&msession->ssl);
  18105. // Return 0 (X509_V_OK equivalent) if verification passed
  18106. return flags == 0 ? 0 : static_cast<long>(flags);
  18107. }
  18108. inline std::string get_cert_subject_cn(cert_t cert) {
  18109. if (!cert) return "";
  18110. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18111. // Find the CN in the subject
  18112. const mbedtls_x509_name *name = &x509->subject;
  18113. while (name != nullptr) {
  18114. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  18115. return std::string(reinterpret_cast<const char *>(name->val.p),
  18116. name->val.len);
  18117. }
  18118. name = name->next;
  18119. }
  18120. return "";
  18121. }
  18122. inline std::string get_cert_issuer_name(cert_t cert) {
  18123. if (!cert) return "";
  18124. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18125. // Build a human-readable issuer name string
  18126. char buf[512];
  18127. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &x509->issuer);
  18128. if (ret < 0) return "";
  18129. return std::string(buf);
  18130. }
  18131. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  18132. sans.clear();
  18133. if (!cert) return false;
  18134. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18135. // Parse the Subject Alternative Name extension
  18136. const mbedtls_x509_sequence *cur = &x509->subject_alt_names;
  18137. while (cur != nullptr) {
  18138. if (cur->buf.len > 0) {
  18139. const unsigned char *p = cur->buf.p;
  18140. size_t value_len = cur->buf.len;
  18141. SanEntry entry;
  18142. switch (cur->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK) {
  18143. case MBEDTLS_X509_SAN_DNS_NAME:
  18144. entry.type = SanType::DNS;
  18145. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18146. break;
  18147. case MBEDTLS_X509_SAN_IP_ADDRESS:
  18148. entry.type = SanType::IP;
  18149. if (value_len == 4) {
  18150. // IPv4
  18151. char buf[16];
  18152. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", p[0], p[1], p[2], p[3]);
  18153. entry.value = buf;
  18154. } else if (value_len == 16) {
  18155. // IPv6
  18156. char buf[64];
  18157. snprintf(buf, sizeof(buf),
  18158. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  18159. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  18160. p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8], p[9],
  18161. p[10], p[11], p[12], p[13], p[14], p[15]);
  18162. entry.value = buf;
  18163. }
  18164. break;
  18165. case MBEDTLS_X509_SAN_RFC822_NAME:
  18166. entry.type = SanType::EMAIL;
  18167. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18168. break;
  18169. case MBEDTLS_X509_SAN_UNIFORM_RESOURCE_IDENTIFIER:
  18170. entry.type = SanType::URI;
  18171. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18172. break;
  18173. default: entry.type = SanType::OTHER; break;
  18174. }
  18175. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  18176. }
  18177. cur = cur->next;
  18178. }
  18179. return true;
  18180. }
  18181. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  18182. time_t &not_after) {
  18183. if (!cert) return false;
  18184. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18185. // Convert mbedtls_x509_time to time_t
  18186. auto to_time_t = [](const mbedtls_x509_time &t) -> time_t {
  18187. struct tm tm_time = {};
  18188. tm_time.tm_year = t.year - 1900;
  18189. tm_time.tm_mon = t.mon - 1;
  18190. tm_time.tm_mday = t.day;
  18191. tm_time.tm_hour = t.hour;
  18192. tm_time.tm_min = t.min;
  18193. tm_time.tm_sec = t.sec;
  18194. #ifdef _WIN32
  18195. return _mkgmtime(&tm_time);
  18196. #else
  18197. return timegm(&tm_time);
  18198. #endif
  18199. };
  18200. not_before = to_time_t(x509->valid_from);
  18201. not_after = to_time_t(x509->valid_to);
  18202. return true;
  18203. }
  18204. inline std::string get_cert_serial(cert_t cert) {
  18205. if (!cert) return "";
  18206. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18207. // Convert serial number to hex string
  18208. std::string result;
  18209. result.reserve(x509->serial.len * 2);
  18210. for (size_t i = 0; i < x509->serial.len; i++) {
  18211. char hex[3];
  18212. snprintf(hex, sizeof(hex), "%02X", x509->serial.p[i]);
  18213. result += hex;
  18214. }
  18215. return result;
  18216. }
  18217. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  18218. if (!cert) return false;
  18219. auto crt = static_cast<mbedtls_x509_crt *>(cert);
  18220. if (!crt->raw.p || crt->raw.len == 0) return false;
  18221. der.assign(crt->raw.p, crt->raw.p + crt->raw.len);
  18222. return true;
  18223. }
  18224. inline const char *get_sni(const_session_t session) {
  18225. if (!session) return nullptr;
  18226. auto msession = static_cast<const impl::MbedTlsSession *>(session);
  18227. // For server: return SNI received from client during handshake
  18228. if (!msession->sni_hostname.empty()) {
  18229. return msession->sni_hostname.c_str();
  18230. }
  18231. // For client: return the hostname set via set_sni
  18232. if (!msession->hostname.empty()) { return msession->hostname.c_str(); }
  18233. return nullptr;
  18234. }
  18235. inline uint64_t peek_error() {
  18236. // Mbed TLS doesn't have an error queue, return the last error
  18237. return static_cast<uint64_t>(-impl::mbedtls_last_error());
  18238. }
  18239. inline uint64_t get_error() {
  18240. // Mbed TLS doesn't have an error queue, return and clear the last error
  18241. uint64_t err = static_cast<uint64_t>(-impl::mbedtls_last_error());
  18242. impl::mbedtls_last_error() = 0;
  18243. return err;
  18244. }
  18245. inline std::string error_string(uint64_t code) {
  18246. char buf[256];
  18247. mbedtls_strerror(-static_cast<int>(code), buf, sizeof(buf));
  18248. return std::string(buf);
  18249. }
  18250. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  18251. auto *ca_chain = new (std::nothrow) mbedtls_x509_crt;
  18252. if (!ca_chain) { return nullptr; }
  18253. mbedtls_x509_crt_init(ca_chain);
  18254. // mbedtls_x509_crt_parse expects null-terminated PEM
  18255. int ret = mbedtls_x509_crt_parse(ca_chain,
  18256. reinterpret_cast<const unsigned char *>(pem),
  18257. len + 1); // +1 for null terminator
  18258. if (ret != 0) {
  18259. // Try without +1 in case PEM is already null-terminated
  18260. ret = mbedtls_x509_crt_parse(
  18261. ca_chain, reinterpret_cast<const unsigned char *>(pem), len);
  18262. if (ret != 0) {
  18263. mbedtls_x509_crt_free(ca_chain);
  18264. delete ca_chain;
  18265. return nullptr;
  18266. }
  18267. }
  18268. return static_cast<ca_store_t>(ca_chain);
  18269. }
  18270. inline void free_ca_store(ca_store_t store) {
  18271. if (store) {
  18272. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18273. mbedtls_x509_crt_free(ca_chain);
  18274. delete ca_chain;
  18275. }
  18276. }
  18277. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  18278. if (!ctx || !store) { return false; }
  18279. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18280. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18281. // Free existing CA chain
  18282. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  18283. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  18284. // Copy the CA chain (deep copy)
  18285. // Parse from the raw data of the source cert
  18286. mbedtls_x509_crt *src = ca_chain;
  18287. while (src != nullptr) {
  18288. int ret = mbedtls_x509_crt_parse_der(&mbed_ctx->ca_chain, src->raw.p,
  18289. src->raw.len);
  18290. if (ret != 0) {
  18291. free_ca_store(store);
  18292. return false;
  18293. }
  18294. src = src->next;
  18295. }
  18296. // This function takes ownership of the store; the chain was deep-copied
  18297. // above, so release the source
  18298. free_ca_store(store);
  18299. // Update the SSL config to use the new CA chain
  18300. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18301. return true;
  18302. }
  18303. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  18304. certs.clear();
  18305. if (!ctx) { return 0; }
  18306. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18307. // Iterate through the CA chain
  18308. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  18309. while (cert != nullptr && cert->raw.len > 0) {
  18310. // Create a copy of the certificate for the caller
  18311. auto *copy = new mbedtls_x509_crt;
  18312. mbedtls_x509_crt_init(copy);
  18313. int ret = mbedtls_x509_crt_parse_der(copy, cert->raw.p, cert->raw.len);
  18314. if (ret == 0) {
  18315. certs.push_back(static_cast<cert_t>(copy));
  18316. } else {
  18317. mbedtls_x509_crt_free(copy);
  18318. delete copy;
  18319. }
  18320. cert = cert->next;
  18321. }
  18322. return certs.size();
  18323. }
  18324. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  18325. std::vector<std::string> names;
  18326. if (!ctx) { return names; }
  18327. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18328. // Iterate through the CA chain
  18329. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  18330. while (cert != nullptr && cert->raw.len > 0) {
  18331. char buf[512];
  18332. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &cert->subject);
  18333. if (ret > 0) { names.push_back(buf); }
  18334. cert = cert->next;
  18335. }
  18336. return names;
  18337. }
  18338. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  18339. const char *key_pem, const char *password) {
  18340. if (!ctx || !cert_pem || !key_pem) { return false; }
  18341. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18342. // Free existing certificate and key
  18343. mbedtls_x509_crt_free(&mbed_ctx->own_cert);
  18344. mbedtls_pk_free(&mbed_ctx->own_key);
  18345. mbedtls_x509_crt_init(&mbed_ctx->own_cert);
  18346. mbedtls_pk_init(&mbed_ctx->own_key);
  18347. // Parse certificate PEM
  18348. int ret = mbedtls_x509_crt_parse(
  18349. &mbed_ctx->own_cert, reinterpret_cast<const unsigned char *>(cert_pem),
  18350. strlen(cert_pem) + 1);
  18351. if (ret != 0) {
  18352. impl::mbedtls_last_error() = ret;
  18353. return false;
  18354. }
  18355. // Parse private key PEM
  18356. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18357. ret = mbedtls_pk_parse_key(
  18358. &mbed_ctx->own_key, reinterpret_cast<const unsigned char *>(key_pem),
  18359. strlen(key_pem) + 1,
  18360. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18361. password ? strlen(password) : 0, mbedtls_ctr_drbg_random,
  18362. &mbed_ctx->ctr_drbg);
  18363. #else
  18364. ret = mbedtls_pk_parse_key(
  18365. &mbed_ctx->own_key, reinterpret_cast<const unsigned char *>(key_pem),
  18366. strlen(key_pem) + 1,
  18367. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18368. password ? strlen(password) : 0);
  18369. #endif
  18370. if (ret != 0) {
  18371. impl::mbedtls_last_error() = ret;
  18372. return false;
  18373. }
  18374. // Configure SSL to use the new certificate and key
  18375. ret = mbedtls_ssl_conf_own_cert(&mbed_ctx->conf, &mbed_ctx->own_cert,
  18376. &mbed_ctx->own_key);
  18377. if (ret != 0) {
  18378. impl::mbedtls_last_error() = ret;
  18379. return false;
  18380. }
  18381. return true;
  18382. }
  18383. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  18384. if (!ctx || !ca_pem) { return false; }
  18385. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18386. // Free existing CA chain
  18387. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  18388. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  18389. // Parse CA PEM
  18390. int ret = mbedtls_x509_crt_parse(
  18391. &mbed_ctx->ca_chain, reinterpret_cast<const unsigned char *>(ca_pem),
  18392. strlen(ca_pem) + 1);
  18393. if (ret != 0) {
  18394. impl::mbedtls_last_error() = ret;
  18395. return false;
  18396. }
  18397. // Update SSL config to use new CA chain
  18398. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18399. return true;
  18400. }
  18401. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  18402. if (!ctx) { return false; }
  18403. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18404. // create_session() hands each session its own copy to run.
  18405. mbed_ctx->verify_callback = std::move(callback);
  18406. if (mbed_ctx->verify_callback) {
  18407. // Set OPTIONAL mode to ensure callback is called even when verification
  18408. // is disabled (matching OpenSSL behavior where SSL_VERIFY_PEER is set)
  18409. mbedtls_ssl_conf_authmode(&mbed_ctx->conf, MBEDTLS_SSL_VERIFY_OPTIONAL);
  18410. }
  18411. return true;
  18412. }
  18413. inline long get_verify_error(const_session_t session) {
  18414. if (!session) { return -1; }
  18415. auto *msession =
  18416. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18417. return static_cast<long>(mbedtls_ssl_get_verify_result(&msession->ssl));
  18418. }
  18419. inline std::string verify_error_string(long error_code) {
  18420. if (error_code == 0) { return ""; }
  18421. char buf[256];
  18422. mbedtls_x509_crt_verify_info(buf, sizeof(buf), "",
  18423. static_cast<uint32_t>(error_code));
  18424. // Remove trailing newline if present
  18425. std::string result(buf);
  18426. while (!result.empty() && (result.back() == '\n' || result.back() == ' ')) {
  18427. result.pop_back();
  18428. }
  18429. return result;
  18430. }
  18431. } // namespace tls
  18432. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  18433. /*
  18434. * Group 10: TLS abstraction layer - wolfSSL backend
  18435. */
  18436. /*
  18437. * wolfSSL Backend Implementation
  18438. */
  18439. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  18440. namespace tls {
  18441. namespace impl {
  18442. // wolfSSL session wrapper
  18443. struct WolfSSLSession {
  18444. WOLFSSL *ssl = nullptr;
  18445. socket_t sock = INVALID_SOCKET;
  18446. std::string hostname; // For client: set via set_sni
  18447. std::string sni_hostname; // For server: received from client via SNI callback
  18448. WolfSSLSession() = default;
  18449. ~WolfSSLSession() {
  18450. if (ssl) { wolfSSL_free(ssl); }
  18451. }
  18452. WolfSSLSession(const WolfSSLSession &) = delete;
  18453. WolfSSLSession &operator=(const WolfSSLSession &) = delete;
  18454. };
  18455. // Thread-local error code accessor for wolfSSL
  18456. inline uint64_t &wolfssl_last_error() {
  18457. static thread_local uint64_t err = 0;
  18458. return err;
  18459. }
  18460. // Helper to map wolfSSL error to ErrorCode.
  18461. // ssl_error is the value from wolfSSL_get_error().
  18462. // raw_ret is the raw return value from the wolfSSL call (for low-level error).
  18463. inline ErrorCode map_wolfssl_error(WOLFSSL *ssl, int ssl_error,
  18464. int &out_errno) {
  18465. switch (ssl_error) {
  18466. case SSL_ERROR_NONE: return ErrorCode::Success;
  18467. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  18468. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  18469. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  18470. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  18471. default:
  18472. if (ssl) {
  18473. // wolfSSL stores the low-level error code as a negative value.
  18474. // DOMAIN_NAME_MISMATCH (-322) indicates hostname verification failure.
  18475. int low_err = ssl_error; // wolfSSL_get_error returns the low-level code
  18476. if (low_err == DOMAIN_NAME_MISMATCH) {
  18477. return ErrorCode::HostnameMismatch;
  18478. }
  18479. // Check verify result to distinguish cert verification from generic SSL
  18480. // errors.
  18481. long vr = wolfSSL_get_verify_result(ssl);
  18482. if (vr != 0) { return ErrorCode::CertVerifyFailed; }
  18483. }
  18484. return ErrorCode::Fatal;
  18485. }
  18486. }
  18487. // WolfSSLContext constructor/destructor implementations
  18488. inline WolfSSLContext::WolfSSLContext() { wolfSSL_Init(); }
  18489. inline WolfSSLContext::~WolfSSLContext() {
  18490. if (ctx) { wolfSSL_CTX_free(ctx); }
  18491. }
  18492. // Thread-local storage for SNI captured during handshake
  18493. inline std::string &wolfssl_pending_sni() {
  18494. static thread_local std::string sni;
  18495. return sni;
  18496. }
  18497. // SNI callback for wolfSSL server to capture client's SNI hostname
  18498. inline int wolfssl_sni_callback(WOLFSSL *ssl, int *ret, void *exArg) {
  18499. (void)ret;
  18500. (void)exArg;
  18501. void *name_data = nullptr;
  18502. unsigned short name_len =
  18503. wolfSSL_SNI_GetRequest(ssl, WOLFSSL_SNI_HOST_NAME, &name_data);
  18504. if (name_data && name_len > 0) {
  18505. wolfssl_pending_sni().assign(static_cast<const char *>(name_data),
  18506. name_len);
  18507. } else {
  18508. wolfssl_pending_sni().clear();
  18509. }
  18510. return 0; // Continue regardless
  18511. }
  18512. // The WOLFSSL_CTX points back to its WolfSSLContext, so a handshake only ever
  18513. // runs the verify callback of its own context.
  18514. inline int context_ex_data_index() {
  18515. static const auto index =
  18516. wolfSSL_CTX_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  18517. return index;
  18518. }
  18519. // Each WOLFSSL points back to its WolfSSLSession, the session_t that every
  18520. // other tls:: function takes.
  18521. inline int session_ex_data_index() {
  18522. static const auto index =
  18523. wolfSSL_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  18524. return index;
  18525. }
  18526. // wolfSSL verify callback wrapper
  18527. inline int wolfssl_verify_callback(int preverify_ok,
  18528. WOLFSSL_X509_STORE_CTX *x509_ctx) {
  18529. // Get the WOLFSSL object from the X509_STORE_CTX
  18530. WOLFSSL *ssl = static_cast<WOLFSSL *>(wolfSSL_X509_STORE_CTX_get_ex_data(
  18531. x509_ctx, wolfSSL_get_ex_data_X509_STORE_CTX_idx()));
  18532. if (!ssl) { return preverify_ok; }
  18533. auto wctx = static_cast<WolfSSLContext *>(wolfSSL_CTX_get_ex_data(
  18534. wolfSSL_get_SSL_CTX(ssl), context_ex_data_index()));
  18535. if (!wctx || !wctx->verify_callback) { return preverify_ok; }
  18536. WOLFSSL_X509 *cert = wolfSSL_X509_STORE_CTX_get_current_cert(x509_ctx);
  18537. int depth = wolfSSL_X509_STORE_CTX_get_error_depth(x509_ctx);
  18538. int err = wolfSSL_X509_STORE_CTX_get_error(x509_ctx);
  18539. VerifyContext verify_ctx;
  18540. verify_ctx.session = wolfSSL_get_ex_data(ssl, session_ex_data_index());
  18541. verify_ctx.cert = static_cast<cert_t>(cert);
  18542. verify_ctx.depth = depth;
  18543. verify_ctx.preverify_ok = (preverify_ok != 0);
  18544. verify_ctx.error_code = static_cast<long>(err);
  18545. if (err != 0) {
  18546. verify_ctx.error_string = wolfSSL_X509_verify_cert_error_string(err);
  18547. } else {
  18548. verify_ctx.error_string = nullptr;
  18549. }
  18550. bool accepted = wctx->verify_callback(verify_ctx);
  18551. return accepted ? 1 : 0;
  18552. }
  18553. inline void set_wolfssl_password_cb(WOLFSSL_CTX *ctx, const char *password) {
  18554. wolfSSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char *>(password));
  18555. wolfSSL_CTX_set_default_passwd_cb(
  18556. ctx, [](char *buf, int size, int /*rwflag*/, void *userdata) -> int {
  18557. auto *pwd = static_cast<const char *>(userdata);
  18558. if (!pwd) return 0;
  18559. auto len = static_cast<int>(strlen(pwd));
  18560. if (len > size) len = size;
  18561. memcpy(buf, pwd, static_cast<size_t>(len));
  18562. return len;
  18563. });
  18564. }
  18565. } // namespace impl
  18566. inline ctx_t create_client_context() {
  18567. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  18568. if (!ctx) { return nullptr; }
  18569. ctx->is_server = false;
  18570. WOLFSSL_METHOD *method = wolfTLSv1_2_client_method();
  18571. if (!method) {
  18572. delete ctx;
  18573. return nullptr;
  18574. }
  18575. ctx->ctx = wolfSSL_CTX_new(method);
  18576. if (!ctx->ctx ||
  18577. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  18578. WOLFSSL_SUCCESS) {
  18579. delete ctx;
  18580. return nullptr;
  18581. }
  18582. // Default: verify peer certificate
  18583. wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_PEER, nullptr);
  18584. return static_cast<ctx_t>(ctx);
  18585. }
  18586. inline ctx_t create_server_context() {
  18587. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  18588. if (!ctx) { return nullptr; }
  18589. ctx->is_server = true;
  18590. WOLFSSL_METHOD *method = wolfTLSv1_2_server_method();
  18591. if (!method) {
  18592. delete ctx;
  18593. return nullptr;
  18594. }
  18595. ctx->ctx = wolfSSL_CTX_new(method);
  18596. if (!ctx->ctx ||
  18597. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  18598. WOLFSSL_SUCCESS) {
  18599. delete ctx;
  18600. return nullptr;
  18601. }
  18602. // Default: don't verify client
  18603. wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_NONE, nullptr);
  18604. // Enable SNI on server
  18605. wolfSSL_CTX_SNI_SetOptions(ctx->ctx, WOLFSSL_SNI_HOST_NAME,
  18606. WOLFSSL_SNI_CONTINUE_ON_MISMATCH);
  18607. wolfSSL_CTX_set_servername_callback(ctx->ctx, impl::wolfssl_sni_callback);
  18608. return static_cast<ctx_t>(ctx);
  18609. }
  18610. inline void free_context(ctx_t ctx) {
  18611. if (ctx) { delete static_cast<impl::WolfSSLContext *>(ctx); }
  18612. }
  18613. inline bool set_min_version(ctx_t ctx, Version version) {
  18614. if (!ctx) { return false; }
  18615. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18616. int min_ver = WOLFSSL_TLSV1_2;
  18617. if (version >= Version::TLS1_3) { min_ver = WOLFSSL_TLSV1_3; }
  18618. return wolfSSL_CTX_SetMinVersion(wctx->ctx, min_ver) == WOLFSSL_SUCCESS;
  18619. }
  18620. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  18621. if (!ctx || !pem) { return false; }
  18622. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18623. int ret = wolfSSL_CTX_load_verify_buffer(
  18624. wctx->ctx, reinterpret_cast<const unsigned char *>(pem),
  18625. static_cast<long>(len), SSL_FILETYPE_PEM);
  18626. if (ret != SSL_SUCCESS) {
  18627. impl::wolfssl_last_error() =
  18628. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18629. return false;
  18630. }
  18631. wctx->ca_pem_data_.append(pem, len);
  18632. return true;
  18633. }
  18634. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  18635. if (!ctx || !file_path) { return false; }
  18636. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18637. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, file_path, nullptr);
  18638. if (ret != SSL_SUCCESS) {
  18639. impl::wolfssl_last_error() =
  18640. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18641. return false;
  18642. }
  18643. return true;
  18644. }
  18645. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  18646. if (!ctx || !dir_path) { return false; }
  18647. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18648. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, dir_path);
  18649. // wolfSSL may fail if the directory doesn't contain properly hashed certs.
  18650. // Unlike OpenSSL which lazily loads certs from directories, wolfSSL scans
  18651. // immediately. Return true even on failure since the CA file may have
  18652. // already been loaded, matching OpenSSL's lenient behavior.
  18653. (void)ret;
  18654. return true;
  18655. }
  18656. inline bool load_system_certs(ctx_t ctx) {
  18657. if (!ctx) { return false; }
  18658. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18659. bool loaded = false;
  18660. #ifdef _WIN32
  18661. loaded = impl::enumerate_windows_system_certs(
  18662. [&](const unsigned char *data, size_t len) {
  18663. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  18664. static_cast<long>(len),
  18665. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  18666. });
  18667. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  18668. loaded = impl::enumerate_macos_keychain_certs(
  18669. [&](const unsigned char *data, size_t len) {
  18670. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  18671. static_cast<long>(len),
  18672. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  18673. });
  18674. #else
  18675. for (auto path = impl::system_ca_paths(); *path; ++path) {
  18676. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, *path, nullptr) ==
  18677. SSL_SUCCESS) {
  18678. loaded = true;
  18679. break;
  18680. }
  18681. }
  18682. if (!loaded) {
  18683. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  18684. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, *dir) ==
  18685. SSL_SUCCESS) {
  18686. loaded = true;
  18687. break;
  18688. }
  18689. }
  18690. }
  18691. #endif
  18692. return loaded;
  18693. }
  18694. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  18695. const char *password) {
  18696. if (!ctx || !cert || !key) { return false; }
  18697. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18698. // Load certificate
  18699. int ret = wolfSSL_CTX_use_certificate_buffer(
  18700. wctx->ctx, reinterpret_cast<const unsigned char *>(cert),
  18701. static_cast<long>(strlen(cert)), SSL_FILETYPE_PEM);
  18702. if (ret != SSL_SUCCESS) {
  18703. impl::wolfssl_last_error() =
  18704. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18705. return false;
  18706. }
  18707. // Set password callback if password is provided
  18708. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18709. // Load private key
  18710. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  18711. wctx->ctx, reinterpret_cast<const unsigned char *>(key),
  18712. static_cast<long>(strlen(key)), SSL_FILETYPE_PEM);
  18713. if (ret != SSL_SUCCESS) {
  18714. impl::wolfssl_last_error() =
  18715. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18716. return false;
  18717. }
  18718. // Verify that the certificate and private key match
  18719. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  18720. }
  18721. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  18722. const char *key_path, const char *password) {
  18723. if (!ctx || !cert_path || !key_path) { return false; }
  18724. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18725. // Load certificate file
  18726. int ret =
  18727. wolfSSL_CTX_use_certificate_file(wctx->ctx, cert_path, SSL_FILETYPE_PEM);
  18728. if (ret != SSL_SUCCESS) {
  18729. impl::wolfssl_last_error() =
  18730. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18731. return false;
  18732. }
  18733. // Set password callback if password is provided
  18734. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18735. // Load private key file
  18736. ret = wolfSSL_CTX_use_PrivateKey_file(wctx->ctx, key_path, SSL_FILETYPE_PEM);
  18737. if (ret != SSL_SUCCESS) {
  18738. impl::wolfssl_last_error() =
  18739. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18740. return false;
  18741. }
  18742. // Verify that the certificate and private key match
  18743. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  18744. }
  18745. inline void set_verify_client(ctx_t ctx, bool require) {
  18746. if (!ctx) { return; }
  18747. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18748. wctx->verify_client = require;
  18749. if (require) {
  18750. wolfSSL_CTX_set_verify(
  18751. wctx->ctx, SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
  18752. wctx->verify_callback ? impl::wolfssl_verify_callback : nullptr);
  18753. } else {
  18754. if (wctx->verify_callback) {
  18755. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
  18756. impl::wolfssl_verify_callback);
  18757. } else {
  18758. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_NONE, nullptr);
  18759. }
  18760. }
  18761. }
  18762. inline session_t create_session(ctx_t ctx, socket_t sock) {
  18763. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  18764. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18765. auto session = new (std::nothrow) impl::WolfSSLSession();
  18766. if (!session) { return nullptr; }
  18767. session->sock = sock;
  18768. session->ssl = wolfSSL_new(wctx->ctx);
  18769. if (!session->ssl) {
  18770. impl::wolfssl_last_error() =
  18771. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18772. delete session;
  18773. return nullptr;
  18774. }
  18775. if (wolfSSL_set_ex_data(session->ssl, impl::session_ex_data_index(),
  18776. session) != WOLFSSL_SUCCESS) {
  18777. delete session;
  18778. return nullptr;
  18779. }
  18780. wolfSSL_set_fd(session->ssl, static_cast<int>(sock));
  18781. return static_cast<session_t>(session);
  18782. }
  18783. inline void free_session(session_t session) {
  18784. if (session) { delete static_cast<impl::WolfSSLSession *>(session); }
  18785. }
  18786. inline bool set_sni(session_t session, const char *hostname,
  18787. bool verify_hostname) {
  18788. if (!session || !hostname) { return false; }
  18789. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18790. int ret = wolfSSL_UseSNI(wsession->ssl, WOLFSSL_SNI_HOST_NAME, hostname,
  18791. static_cast<word16>(strlen(hostname)));
  18792. if (ret != WOLFSSL_SUCCESS) {
  18793. impl::wolfssl_last_error() =
  18794. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18795. return false;
  18796. }
  18797. // wolfSSL_check_domain_name binds identity checking to the handshake,
  18798. // separately from the SNI extension sent above; skip it when hostname
  18799. // verification is disabled so only the chain is checked, matching OpenSSL.
  18800. if (verify_hostname) { wolfSSL_check_domain_name(wsession->ssl, hostname); }
  18801. wsession->hostname = hostname;
  18802. return true;
  18803. }
  18804. inline TlsError connect(session_t session) {
  18805. TlsError err;
  18806. if (!session) {
  18807. err.code = ErrorCode::Fatal;
  18808. return err;
  18809. }
  18810. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18811. int ret = wolfSSL_connect(wsession->ssl);
  18812. if (ret == SSL_SUCCESS) {
  18813. err.code = ErrorCode::Success;
  18814. } else {
  18815. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18816. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18817. err.backend_code = static_cast<uint64_t>(ssl_error);
  18818. impl::wolfssl_last_error() = err.backend_code;
  18819. }
  18820. return err;
  18821. }
  18822. inline TlsError accept(session_t session) {
  18823. TlsError err;
  18824. if (!session) {
  18825. err.code = ErrorCode::Fatal;
  18826. return err;
  18827. }
  18828. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18829. int ret = wolfSSL_accept(wsession->ssl);
  18830. if (ret == SSL_SUCCESS) {
  18831. err.code = ErrorCode::Success;
  18832. // Capture SNI from thread-local storage after successful handshake
  18833. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  18834. impl::wolfssl_pending_sni().clear();
  18835. } else {
  18836. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18837. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18838. err.backend_code = static_cast<uint64_t>(ssl_error);
  18839. impl::wolfssl_last_error() = err.backend_code;
  18840. }
  18841. return err;
  18842. }
  18843. inline bool connect_nonblocking(session_t session, socket_t sock,
  18844. time_t timeout_sec, time_t timeout_usec,
  18845. TlsError *err) {
  18846. if (!session) {
  18847. if (err) { err->code = ErrorCode::Fatal; }
  18848. return false;
  18849. }
  18850. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18851. // Set socket to non-blocking mode
  18852. detail::set_nonblocking(sock, true);
  18853. auto cleanup =
  18854. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18855. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  18856. int ret;
  18857. while ((ret = wolfSSL_connect(wsession->ssl)) != SSL_SUCCESS) {
  18858. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18859. if (ssl_error == SSL_ERROR_WANT_READ) {
  18860. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  18861. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  18862. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  18863. }
  18864. // Error or timeout
  18865. if (err) {
  18866. err->code =
  18867. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  18868. err->backend_code = static_cast<uint64_t>(ssl_error);
  18869. }
  18870. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  18871. return false;
  18872. }
  18873. if (err) { err->code = ErrorCode::Success; }
  18874. return true;
  18875. }
  18876. inline bool accept_nonblocking(session_t session, socket_t sock,
  18877. time_t timeout_sec, time_t timeout_usec,
  18878. TlsError *err) {
  18879. if (!session) {
  18880. if (err) { err->code = ErrorCode::Fatal; }
  18881. return false;
  18882. }
  18883. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18884. // Set socket to non-blocking mode
  18885. detail::set_nonblocking(sock, true);
  18886. auto cleanup =
  18887. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18888. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  18889. int ret;
  18890. while ((ret = wolfSSL_accept(wsession->ssl)) != SSL_SUCCESS) {
  18891. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18892. if (ssl_error == SSL_ERROR_WANT_READ) {
  18893. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  18894. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  18895. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  18896. }
  18897. // Error or timeout
  18898. if (err) {
  18899. err->code =
  18900. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  18901. err->backend_code = static_cast<uint64_t>(ssl_error);
  18902. }
  18903. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  18904. return false;
  18905. }
  18906. if (err) { err->code = ErrorCode::Success; }
  18907. // Capture SNI from thread-local storage after successful handshake
  18908. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  18909. impl::wolfssl_pending_sni().clear();
  18910. return true;
  18911. }
  18912. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  18913. if (!session || !buf) {
  18914. err.code = ErrorCode::Fatal;
  18915. return -1;
  18916. }
  18917. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18918. int ret = wolfSSL_read(wsession->ssl, buf, static_cast<int>(len));
  18919. if (ret > 0) {
  18920. err.code = ErrorCode::Success;
  18921. return static_cast<ssize_t>(ret);
  18922. }
  18923. if (ret == 0) {
  18924. err.code = ErrorCode::PeerClosed;
  18925. return 0;
  18926. }
  18927. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18928. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18929. err.backend_code = static_cast<uint64_t>(ssl_error);
  18930. impl::wolfssl_last_error() = err.backend_code;
  18931. return -1;
  18932. }
  18933. inline ssize_t write(session_t session, const void *buf, size_t len,
  18934. TlsError &err) {
  18935. if (!session || !buf) {
  18936. err.code = ErrorCode::Fatal;
  18937. return -1;
  18938. }
  18939. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18940. int ret = wolfSSL_write(wsession->ssl, buf, static_cast<int>(len));
  18941. if (ret > 0) {
  18942. err.code = ErrorCode::Success;
  18943. return static_cast<ssize_t>(ret);
  18944. }
  18945. // wolfSSL_write returns 0 when the peer has sent a close_notify.
  18946. // Treat this as an error (return -1) so callers don't spin in a
  18947. // write loop adding zero to the offset.
  18948. if (ret == 0) {
  18949. err.code = ErrorCode::PeerClosed;
  18950. return -1;
  18951. }
  18952. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18953. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18954. err.backend_code = static_cast<uint64_t>(ssl_error);
  18955. impl::wolfssl_last_error() = err.backend_code;
  18956. return -1;
  18957. }
  18958. inline int pending(const_session_t session) {
  18959. if (!session) { return 0; }
  18960. auto wsession =
  18961. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18962. return wolfSSL_pending(wsession->ssl);
  18963. }
  18964. inline void shutdown(session_t session, bool graceful) {
  18965. if (!session) { return; }
  18966. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18967. if (graceful) {
  18968. int ret;
  18969. int attempts = 0;
  18970. while ((ret = wolfSSL_shutdown(wsession->ssl)) != SSL_SUCCESS &&
  18971. attempts < 3) {
  18972. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18973. if (ssl_error != SSL_ERROR_WANT_READ &&
  18974. ssl_error != SSL_ERROR_WANT_WRITE) {
  18975. break;
  18976. }
  18977. attempts++;
  18978. }
  18979. } else {
  18980. wolfSSL_shutdown(wsession->ssl);
  18981. }
  18982. }
  18983. inline bool is_peer_closed(session_t session, socket_t sock) {
  18984. if (!session || sock == INVALID_SOCKET) { return true; }
  18985. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18986. // Check if there's already decrypted data available
  18987. if (wolfSSL_pending(wsession->ssl) > 0) { return false; }
  18988. // Set socket to non-blocking to avoid blocking on read
  18989. detail::set_nonblocking(sock, true);
  18990. auto cleanup =
  18991. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18992. // Peek 1 byte to check connection status without consuming data
  18993. unsigned char buf;
  18994. int ret = wolfSSL_peek(wsession->ssl, &buf, 1);
  18995. // If we got data or WANT_READ (would block), connection is alive
  18996. if (ret > 0) { return false; }
  18997. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18998. if (ssl_error == SSL_ERROR_WANT_READ) { return false; }
  18999. return ssl_error == SSL_ERROR_ZERO_RETURN || ssl_error == SSL_ERROR_SYSCALL ||
  19000. ret == 0;
  19001. }
  19002. inline cert_t get_peer_cert(const_session_t session) {
  19003. if (!session) { return nullptr; }
  19004. auto wsession =
  19005. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19006. WOLFSSL_X509 *cert = wolfSSL_get_peer_certificate(wsession->ssl);
  19007. return static_cast<cert_t>(cert);
  19008. }
  19009. inline size_t get_peer_certs(const_session_t session,
  19010. std::vector<cert_t> &certs) {
  19011. certs.clear();
  19012. if (!session) { return 0; }
  19013. // wolfSSL keeps the received chain only when built with SESSION_CERTS
  19014. #ifdef SESSION_CERTS
  19015. auto wsession =
  19016. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19017. auto chain = wolfSSL_get_peer_chain(wsession->ssl);
  19018. auto count = chain ? wolfSSL_get_chain_count(chain) : 0;
  19019. for (int i = 0; i < count; i++) {
  19020. auto x509 = wolfSSL_get_chain_X509(chain, i);
  19021. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19022. }
  19023. #endif
  19024. return certs.size();
  19025. }
  19026. inline void free_cert(cert_t cert) {
  19027. if (cert) { wolfSSL_X509_free(static_cast<WOLFSSL_X509 *>(cert)); }
  19028. }
  19029. inline bool verify_hostname(cert_t cert, const char *hostname) {
  19030. if (!cert || !hostname) { return false; }
  19031. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19032. std::string host_str(hostname);
  19033. // Check if hostname is an IP address (IPv4 or IPv6)
  19034. unsigned char ip_bytes[16];
  19035. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  19036. auto is_ip = ip_len > 0;
  19037. // Check Subject Alternative Names
  19038. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  19039. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  19040. if (san_names) {
  19041. int san_count = wolfSSL_sk_num(san_names);
  19042. for (int i = 0; i < san_count; i++) {
  19043. auto *names =
  19044. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  19045. if (!names) continue;
  19046. if (!is_ip && names->type == WOLFSSL_GEN_DNS) {
  19047. // DNS name
  19048. unsigned char *dns_name = nullptr;
  19049. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, names->d.dNSName);
  19050. if (dns_name && dns_len > 0) {
  19051. std::string san_name(reinterpret_cast<char *>(dns_name),
  19052. static_cast<size_t>(dns_len));
  19053. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  19054. if (detail::match_hostname(san_name, host_str)) {
  19055. wolfSSL_sk_free(san_names);
  19056. return true;
  19057. }
  19058. }
  19059. } else if (is_ip && names->type == WOLFSSL_GEN_IPADD) {
  19060. // IP address: only an iPAddress SAN of the same family (4 bytes for
  19061. // IPv4, 16 bytes for IPv6) may authenticate the host.
  19062. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(names->d.iPAddress);
  19063. auto san_ip_len = wolfSSL_ASN1_STRING_length(names->d.iPAddress);
  19064. if (ip_data && san_ip_len == static_cast<int>(ip_len) &&
  19065. memcmp(ip_data, ip_bytes, ip_len) == 0) {
  19066. wolfSSL_sk_free(san_names);
  19067. return true;
  19068. }
  19069. }
  19070. }
  19071. wolfSSL_sk_free(san_names);
  19072. }
  19073. // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
  19074. // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
  19075. // the OpenSSL backend's X509_check_ip behaves the same way).
  19076. auto subject = is_ip ? nullptr : wolfSSL_X509_get_subject_name(x509);
  19077. if (subject) {
  19078. char cn[256] = {};
  19079. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  19080. sizeof(cn));
  19081. if (cn_len > 0) {
  19082. std::string cn_str(cn, static_cast<size_t>(cn_len));
  19083. if (detail::match_hostname(cn_str, host_str)) { return true; }
  19084. }
  19085. }
  19086. return false;
  19087. }
  19088. inline uint64_t hostname_mismatch_code() {
  19089. return static_cast<uint64_t>(DOMAIN_NAME_MISMATCH);
  19090. }
  19091. inline long get_verify_result(const_session_t session) {
  19092. if (!session) { return -1; }
  19093. auto wsession =
  19094. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19095. long result = wolfSSL_get_verify_result(wsession->ssl);
  19096. return result;
  19097. }
  19098. inline std::string get_cert_subject_cn(cert_t cert) {
  19099. if (!cert) return "";
  19100. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19101. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19102. if (!subject) return "";
  19103. char cn[256] = {};
  19104. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  19105. sizeof(cn));
  19106. if (cn_len <= 0) return "";
  19107. return std::string(cn, static_cast<size_t>(cn_len));
  19108. }
  19109. inline std::string get_cert_issuer_name(cert_t cert) {
  19110. if (!cert) return "";
  19111. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19112. WOLFSSL_X509_NAME *issuer = wolfSSL_X509_get_issuer_name(x509);
  19113. if (!issuer) return "";
  19114. char *name_str = wolfSSL_X509_NAME_oneline(issuer, nullptr, 0);
  19115. if (!name_str) return "";
  19116. std::string result(name_str);
  19117. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19118. return result;
  19119. }
  19120. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  19121. sans.clear();
  19122. if (!cert) return false;
  19123. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19124. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  19125. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  19126. if (!san_names) return true; // No SANs is not an error
  19127. int count = wolfSSL_sk_num(san_names);
  19128. for (int i = 0; i < count; i++) {
  19129. auto *name =
  19130. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  19131. if (!name) continue;
  19132. SanEntry entry;
  19133. switch (name->type) {
  19134. case WOLFSSL_GEN_DNS: {
  19135. entry.type = SanType::DNS;
  19136. unsigned char *dns_name = nullptr;
  19137. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, name->d.dNSName);
  19138. if (dns_name && dns_len > 0) {
  19139. entry.value = std::string(reinterpret_cast<char *>(dns_name),
  19140. static_cast<size_t>(dns_len));
  19141. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  19142. }
  19143. break;
  19144. }
  19145. case WOLFSSL_GEN_IPADD: {
  19146. entry.type = SanType::IP;
  19147. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(name->d.iPAddress);
  19148. int ip_len = wolfSSL_ASN1_STRING_length(name->d.iPAddress);
  19149. if (ip_data && ip_len == 4) {
  19150. char buf[16];
  19151. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", ip_data[0], ip_data[1],
  19152. ip_data[2], ip_data[3]);
  19153. entry.value = buf;
  19154. } else if (ip_data && ip_len == 16) {
  19155. char buf[64];
  19156. snprintf(buf, sizeof(buf),
  19157. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  19158. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  19159. ip_data[0], ip_data[1], ip_data[2], ip_data[3], ip_data[4],
  19160. ip_data[5], ip_data[6], ip_data[7], ip_data[8], ip_data[9],
  19161. ip_data[10], ip_data[11], ip_data[12], ip_data[13],
  19162. ip_data[14], ip_data[15]);
  19163. entry.value = buf;
  19164. }
  19165. break;
  19166. }
  19167. case WOLFSSL_GEN_EMAIL:
  19168. entry.type = SanType::EMAIL;
  19169. {
  19170. unsigned char *email = nullptr;
  19171. int email_len = wolfSSL_ASN1_STRING_to_UTF8(&email, name->d.rfc822Name);
  19172. if (email && email_len > 0) {
  19173. entry.value = std::string(reinterpret_cast<char *>(email),
  19174. static_cast<size_t>(email_len));
  19175. XFREE(email, nullptr, DYNAMIC_TYPE_OPENSSL);
  19176. }
  19177. }
  19178. break;
  19179. case WOLFSSL_GEN_URI:
  19180. entry.type = SanType::URI;
  19181. {
  19182. unsigned char *uri = nullptr;
  19183. int uri_len = wolfSSL_ASN1_STRING_to_UTF8(
  19184. &uri, name->d.uniformResourceIdentifier);
  19185. if (uri && uri_len > 0) {
  19186. entry.value = std::string(reinterpret_cast<char *>(uri),
  19187. static_cast<size_t>(uri_len));
  19188. XFREE(uri, nullptr, DYNAMIC_TYPE_OPENSSL);
  19189. }
  19190. }
  19191. break;
  19192. default: entry.type = SanType::OTHER; break;
  19193. }
  19194. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  19195. }
  19196. wolfSSL_sk_free(san_names);
  19197. return true;
  19198. }
  19199. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  19200. time_t &not_after) {
  19201. if (!cert) return false;
  19202. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19203. const WOLFSSL_ASN1_TIME *nb = wolfSSL_X509_get_notBefore(x509);
  19204. const WOLFSSL_ASN1_TIME *na = wolfSSL_X509_get_notAfter(x509);
  19205. if (!nb || !na) return false;
  19206. // wolfSSL_ASN1_TIME_to_tm is available
  19207. struct tm tm_nb = {}, tm_na = {};
  19208. if (wolfSSL_ASN1_TIME_to_tm(nb, &tm_nb) != WOLFSSL_SUCCESS) return false;
  19209. if (wolfSSL_ASN1_TIME_to_tm(na, &tm_na) != WOLFSSL_SUCCESS) return false;
  19210. #ifdef _WIN32
  19211. not_before = _mkgmtime(&tm_nb);
  19212. not_after = _mkgmtime(&tm_na);
  19213. #else
  19214. not_before = timegm(&tm_nb);
  19215. not_after = timegm(&tm_na);
  19216. #endif
  19217. return true;
  19218. }
  19219. inline std::string get_cert_serial(cert_t cert) {
  19220. if (!cert) return "";
  19221. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19222. WOLFSSL_ASN1_INTEGER *serial_asn1 = wolfSSL_X509_get_serialNumber(x509);
  19223. if (!serial_asn1) return "";
  19224. // Get the serial number data
  19225. int len = serial_asn1->length;
  19226. unsigned char *data = serial_asn1->data;
  19227. if (!data || len <= 0) return "";
  19228. std::string result;
  19229. result.reserve(static_cast<size_t>(len) * 2);
  19230. for (int i = 0; i < len; i++) {
  19231. char hex[3];
  19232. snprintf(hex, sizeof(hex), "%02X", data[i]);
  19233. result += hex;
  19234. }
  19235. return result;
  19236. }
  19237. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  19238. if (!cert) return false;
  19239. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19240. int der_len = 0;
  19241. const unsigned char *der_data = wolfSSL_X509_get_der(x509, &der_len);
  19242. if (!der_data || der_len <= 0) return false;
  19243. der.assign(der_data, der_data + der_len);
  19244. return true;
  19245. }
  19246. inline const char *get_sni(const_session_t session) {
  19247. if (!session) return nullptr;
  19248. auto wsession = static_cast<const impl::WolfSSLSession *>(session);
  19249. // For server: return SNI received from client during handshake
  19250. if (!wsession->sni_hostname.empty()) {
  19251. return wsession->sni_hostname.c_str();
  19252. }
  19253. // For client: return the hostname set via set_sni
  19254. if (!wsession->hostname.empty()) { return wsession->hostname.c_str(); }
  19255. return nullptr;
  19256. }
  19257. inline uint64_t peek_error() {
  19258. return static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19259. }
  19260. inline uint64_t get_error() {
  19261. uint64_t err = impl::wolfssl_last_error();
  19262. impl::wolfssl_last_error() = 0;
  19263. return err;
  19264. }
  19265. inline std::string error_string(uint64_t code) {
  19266. char buf[256];
  19267. wolfSSL_ERR_error_string(static_cast<unsigned long>(code), buf);
  19268. return std::string(buf);
  19269. }
  19270. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  19271. if (!pem || len == 0) { return nullptr; }
  19272. // Validate by attempting to load into a temporary ctx
  19273. WOLFSSL_CTX *tmp_ctx = wolfSSL_CTX_new(wolfTLSv1_2_client_method());
  19274. if (!tmp_ctx) { return nullptr; }
  19275. int ret = wolfSSL_CTX_load_verify_buffer(
  19276. tmp_ctx, reinterpret_cast<const unsigned char *>(pem),
  19277. static_cast<long>(len), SSL_FILETYPE_PEM);
  19278. wolfSSL_CTX_free(tmp_ctx);
  19279. if (ret != SSL_SUCCESS) { return nullptr; }
  19280. return static_cast<ca_store_t>(
  19281. new impl::WolfSSLCAStore{std::string(pem, len)});
  19282. }
  19283. inline void free_ca_store(ca_store_t store) {
  19284. delete static_cast<impl::WolfSSLCAStore *>(store);
  19285. }
  19286. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  19287. if (!ctx || !store) { return false; }
  19288. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19289. auto *ca = static_cast<impl::WolfSSLCAStore *>(store);
  19290. int ret = wolfSSL_CTX_load_verify_buffer(
  19291. wctx->ctx, reinterpret_cast<const unsigned char *>(ca->pem_data.data()),
  19292. static_cast<long>(ca->pem_data.size()), SSL_FILETYPE_PEM);
  19293. if (ret == SSL_SUCCESS) { wctx->ca_pem_data_ += ca->pem_data; }
  19294. // This function takes ownership of the store; the PEM data was copied into
  19295. // the context, so release the source
  19296. free_ca_store(store);
  19297. return ret == SSL_SUCCESS;
  19298. }
  19299. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  19300. certs.clear();
  19301. if (!ctx) { return 0; }
  19302. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19303. if (wctx->ca_pem_data_.empty()) { return 0; }
  19304. const std::string &pem = wctx->ca_pem_data_;
  19305. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19306. const std::string end_marker = "-----END CERTIFICATE-----";
  19307. size_t pos = 0;
  19308. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19309. size_t end_pos = pem.find(end_marker, pos);
  19310. if (end_pos == std::string::npos) { break; }
  19311. end_pos += end_marker.size();
  19312. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19313. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19314. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19315. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19316. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19317. pos = end_pos;
  19318. }
  19319. return certs.size();
  19320. }
  19321. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  19322. std::vector<std::string> names;
  19323. if (!ctx) { return names; }
  19324. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19325. if (wctx->ca_pem_data_.empty()) { return names; }
  19326. const std::string &pem = wctx->ca_pem_data_;
  19327. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19328. const std::string end_marker = "-----END CERTIFICATE-----";
  19329. size_t pos = 0;
  19330. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19331. size_t end_pos = pem.find(end_marker, pos);
  19332. if (end_pos == std::string::npos) { break; }
  19333. end_pos += end_marker.size();
  19334. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19335. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19336. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19337. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19338. if (x509) {
  19339. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19340. if (subject) {
  19341. char *name_str = wolfSSL_X509_NAME_oneline(subject, nullptr, 0);
  19342. if (name_str) {
  19343. names.push_back(name_str);
  19344. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19345. }
  19346. }
  19347. wolfSSL_X509_free(x509);
  19348. }
  19349. pos = end_pos;
  19350. }
  19351. return names;
  19352. }
  19353. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  19354. const char *key_pem, const char *password) {
  19355. if (!ctx || !cert_pem || !key_pem) { return false; }
  19356. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19357. // Load new certificate
  19358. int ret = wolfSSL_CTX_use_certificate_buffer(
  19359. wctx->ctx, reinterpret_cast<const unsigned char *>(cert_pem),
  19360. static_cast<long>(strlen(cert_pem)), SSL_FILETYPE_PEM);
  19361. if (ret != SSL_SUCCESS) {
  19362. impl::wolfssl_last_error() =
  19363. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19364. return false;
  19365. }
  19366. // Set password if provided
  19367. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19368. // Load new private key
  19369. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  19370. wctx->ctx, reinterpret_cast<const unsigned char *>(key_pem),
  19371. static_cast<long>(strlen(key_pem)), SSL_FILETYPE_PEM);
  19372. if (ret != SSL_SUCCESS) {
  19373. impl::wolfssl_last_error() =
  19374. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19375. return false;
  19376. }
  19377. return true;
  19378. }
  19379. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  19380. if (!ctx || !ca_pem) { return false; }
  19381. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19382. int ret = wolfSSL_CTX_load_verify_buffer(
  19383. wctx->ctx, reinterpret_cast<const unsigned char *>(ca_pem),
  19384. static_cast<long>(strlen(ca_pem)), SSL_FILETYPE_PEM);
  19385. if (ret != SSL_SUCCESS) {
  19386. impl::wolfssl_last_error() =
  19387. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19388. return false;
  19389. }
  19390. return true;
  19391. }
  19392. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  19393. if (!ctx) { return false; }
  19394. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19395. wctx->verify_callback = std::move(callback);
  19396. if (wctx->verify_callback) {
  19397. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
  19398. impl::wolfssl_verify_callback);
  19399. } else {
  19400. wolfSSL_CTX_set_verify(
  19401. wctx->ctx,
  19402. wctx->verify_client
  19403. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  19404. : SSL_VERIFY_NONE,
  19405. nullptr);
  19406. }
  19407. return true;
  19408. }
  19409. inline long get_verify_error(const_session_t session) {
  19410. if (!session) { return -1; }
  19411. auto *wsession =
  19412. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19413. return wolfSSL_get_verify_result(wsession->ssl);
  19414. }
  19415. inline std::string verify_error_string(long error_code) {
  19416. if (error_code == 0) { return ""; }
  19417. const char *str =
  19418. wolfSSL_X509_verify_cert_error_string(static_cast<int>(error_code));
  19419. return str ? std::string(str) : std::string();
  19420. }
  19421. } // namespace tls
  19422. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  19423. // WebSocket implementation
  19424. namespace ws {
  19425. inline bool WebSocket::send_frame(Opcode op, const char *data, size_t len,
  19426. bool fin) {
  19427. std::lock_guard<std::mutex> lock(write_mutex_);
  19428. if (closed_) { return false; }
  19429. return detail::write_websocket_frame(strm_, op, data, len, fin, !is_server_);
  19430. }
  19431. inline ReadResult WebSocket::read(std::string &msg) {
  19432. std::unique_lock<std::mutex> read_lock(read_mutex_);
  19433. while (!closed_) {
  19434. Opcode opcode;
  19435. std::string payload;
  19436. bool fin;
  19437. impl::FrameRead r =
  19438. impl::read_websocket_frame(strm_, opcode, payload, fin, is_server_,
  19439. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH);
  19440. // A timeout landed on a frame boundary: the connection is untouched and
  19441. // still usable, so hand control back without closing it. That is only
  19442. // useful to a caller who asked for the timeout; the compile-time default
  19443. // is a backstop against a peer gone quiet, and elapsing it closes the
  19444. // connection so a plain `while (ws.read(msg))` loop ends.
  19445. if (r == impl::FrameRead::Timeout && read_timeout_set_) { return Timeout; }
  19446. if (r != impl::FrameRead::Ok) {
  19447. closed_ = true;
  19448. return Fail;
  19449. }
  19450. switch (opcode) {
  19451. case Opcode::Ping: {
  19452. std::lock_guard<std::mutex> lock(write_mutex_);
  19453. detail::write_websocket_frame(strm_, Opcode::Pong, payload.data(),
  19454. payload.size(), true, !is_server_);
  19455. continue;
  19456. }
  19457. case Opcode::Pong: {
  19458. std::lock_guard<std::mutex> lock(ping_mutex_);
  19459. unacked_pings_ = 0;
  19460. continue;
  19461. }
  19462. case Opcode::Close: {
  19463. if (!closed_.exchange(true)) {
  19464. // Echo close frame back
  19465. std::lock_guard<std::mutex> lock(write_mutex_);
  19466. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  19467. payload.size(), true, !is_server_);
  19468. }
  19469. return Fail;
  19470. }
  19471. case Opcode::Text:
  19472. case Opcode::Binary: {
  19473. auto result = opcode == Opcode::Text ? Text : Binary;
  19474. msg = std::move(payload);
  19475. // Handle fragmentation
  19476. if (!fin) {
  19477. while (true) {
  19478. Opcode cont_opcode;
  19479. std::string cont_payload;
  19480. bool cont_fin;
  19481. // A timeout is not reportable here: half of a fragmented message is
  19482. // already in `msg` and read() has no way to resume it, so it is a
  19483. // failure like any other. Timeouts are only ever seen on a message
  19484. // boundary.
  19485. if (impl::read_websocket_frame(
  19486. strm_, cont_opcode, cont_payload, cont_fin, is_server_,
  19487. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) !=
  19488. impl::FrameRead::Ok) {
  19489. closed_ = true;
  19490. return Fail;
  19491. }
  19492. if (cont_opcode == Opcode::Ping) {
  19493. std::lock_guard<std::mutex> lock(write_mutex_);
  19494. detail::write_websocket_frame(
  19495. strm_, Opcode::Pong, cont_payload.data(), cont_payload.size(),
  19496. true, !is_server_);
  19497. continue;
  19498. }
  19499. if (cont_opcode == Opcode::Pong) {
  19500. std::lock_guard<std::mutex> lock(ping_mutex_);
  19501. unacked_pings_ = 0;
  19502. continue;
  19503. }
  19504. if (cont_opcode == Opcode::Close) {
  19505. if (!closed_.exchange(true)) {
  19506. std::lock_guard<std::mutex> lock(write_mutex_);
  19507. detail::write_websocket_frame(
  19508. strm_, Opcode::Close, cont_payload.data(),
  19509. cont_payload.size(), true, !is_server_);
  19510. }
  19511. return Fail;
  19512. }
  19513. // RFC 6455: continuation frames must use opcode 0x0
  19514. if (cont_opcode != Opcode::Continuation) {
  19515. closed_ = true;
  19516. return Fail;
  19517. }
  19518. msg += cont_payload;
  19519. if (msg.size() > CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) {
  19520. closed_ = true;
  19521. return Fail;
  19522. }
  19523. if (cont_fin) { break; }
  19524. }
  19525. }
  19526. // RFC 6455 Section 5.6: text frames must contain valid UTF-8
  19527. if (result == Text && !impl::is_valid_utf8(msg)) {
  19528. // close() takes the read lock to wait for the peer's Close reply, so
  19529. // it must not run while this thread still holds it.
  19530. read_lock.unlock();
  19531. close(CloseStatus::InvalidPayload, "invalid UTF-8");
  19532. return Fail;
  19533. }
  19534. return result;
  19535. }
  19536. default: closed_ = true; return Fail;
  19537. }
  19538. }
  19539. return Fail;
  19540. }
  19541. inline bool WebSocket::send(const std::string &data) {
  19542. return send_frame(Opcode::Text, data.data(), data.size());
  19543. }
  19544. inline bool WebSocket::send(const char *data, size_t len) {
  19545. return send_frame(Opcode::Binary, data, len);
  19546. }
  19547. inline void WebSocket::close(CloseStatus status, const std::string &reason) {
  19548. if (closed_.exchange(true)) { return; }
  19549. ping_cv_.notify_all();
  19550. std::string payload;
  19551. auto code = static_cast<uint16_t>(status);
  19552. payload.push_back(static_cast<char>((code >> 8) & 0xFF));
  19553. payload.push_back(static_cast<char>(code & 0xFF));
  19554. // RFC 6455 Section 5.5: control frame payload must not exceed 125 bytes
  19555. // Close frame has 2-byte status code, so reason is limited to 123 bytes
  19556. payload += reason.substr(0, 123);
  19557. {
  19558. std::lock_guard<std::mutex> lock(write_mutex_);
  19559. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  19560. payload.size(), true, !is_server_);
  19561. }
  19562. // RFC 6455 Section 7.1.1: after sending a Close frame, wait for the peer's
  19563. // Close response before closing the TCP connection.
  19564. //
  19565. // Wait only when no other thread is parsing frames. When one is, it is the
  19566. // thread positioned to see the peer's reply, and reading here would take
  19567. // bytes out of the message it is assembling. Bailing out also leaves the
  19568. // stream, including its read timeout, entirely to that thread.
  19569. std::unique_lock<std::mutex> read_lock(read_mutex_, std::try_to_lock);
  19570. if (!read_lock.owns_lock()) { return; }
  19571. // Use a short timeout to avoid hanging if the peer doesn't respond.
  19572. strm_.set_read_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  19573. Opcode op;
  19574. std::string resp;
  19575. bool fin;
  19576. while (impl::read_websocket_frame(strm_, op, resp, fin, is_server_, 125) ==
  19577. impl::FrameRead::Ok) {
  19578. if (op == Opcode::Close) { break; }
  19579. }
  19580. }
  19581. inline WebSocket::~WebSocket() {
  19582. {
  19583. std::lock_guard<std::mutex> lock(ping_mutex_);
  19584. closed_ = true;
  19585. }
  19586. ping_cv_.notify_all();
  19587. if (ping_thread_.joinable()) { ping_thread_.join(); }
  19588. }
  19589. inline void WebSocket::start_heartbeat() {
  19590. if (ping_interval_sec_ == 0) { return; }
  19591. ping_thread_ = std::thread([this]() {
  19592. std::unique_lock<std::mutex> lock(ping_mutex_);
  19593. // The predicate keeps a spurious wakeup from sending a ping early
  19594. while (!ping_cv_.wait_for(lock, std::chrono::seconds(ping_interval_sec_),
  19595. [this]() { return closed_.load(); })) {
  19596. // If the peer has failed to respond to the previous pings, give up.
  19597. // RFC 6455 does not define a pong-timeout mechanism; this is an
  19598. // opt-in liveness check controlled by max_missed_pongs_.
  19599. if (max_missed_pongs_ > 0 && unacked_pings_ >= max_missed_pongs_) {
  19600. lock.unlock();
  19601. close(CloseStatus::GoingAway, "pong timeout");
  19602. // Wake a read() blocked on the unresponsive peer. Only the read side
  19603. // is shut down: a TLS backend answers the EOF with an alert, and
  19604. // writing it to a socket closed for writing raises SIGPIPE.
  19605. #ifdef _WIN32
  19606. shutdown(strm_.socket(), SD_RECEIVE);
  19607. #else
  19608. shutdown(strm_.socket(), SHUT_RD);
  19609. #endif
  19610. return;
  19611. }
  19612. lock.unlock();
  19613. if (!send_frame(Opcode::Ping, nullptr, 0)) {
  19614. lock.lock();
  19615. closed_ = true;
  19616. break;
  19617. }
  19618. lock.lock();
  19619. unacked_pings_++;
  19620. }
  19621. });
  19622. }
  19623. inline const Request &WebSocket::request() const { return req_; }
  19624. inline bool WebSocket::is_open() const { return !closed_; }
  19625. inline void WebSocket::set_read_timeout(time_t sec, time_t usec) {
  19626. // 0 waits forever here, as it does for SO_RCVTIMEO. The stream waits with
  19627. // poll(), where 0 would instead mean "return immediately", so hand it the
  19628. // negative poll uses for an unbounded wait.
  19629. if (sec == 0 && usec == 0) { sec = -1; }
  19630. strm_.set_read_timeout(sec, usec);
  19631. read_timeout_set_ = true;
  19632. }
  19633. // WebSocketClient implementation
  19634. inline WebSocketClient::WebSocketClient(
  19635. const std::string &scheme_host_port_path, const Headers &headers)
  19636. : headers_(headers) {
  19637. detail::UrlComponents uc;
  19638. if (detail::parse_url(scheme_host_port_path, uc) && !uc.scheme.empty() &&
  19639. !uc.host.empty() && !uc.path.empty()) {
  19640. auto &scheme = uc.scheme;
  19641. #ifdef CPPHTTPLIB_SSL_ENABLED
  19642. if (scheme != "ws" && scheme != "wss") {
  19643. #else
  19644. if (scheme != "ws") {
  19645. #endif
  19646. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  19647. std::string msg = "'" + scheme + "' scheme is not supported.";
  19648. throw std::invalid_argument(msg);
  19649. #endif
  19650. return;
  19651. }
  19652. auto is_ssl = scheme == "wss";
  19653. host_ = std::move(uc.host);
  19654. port_ = is_ssl ? 443 : 80;
  19655. if (!uc.port.empty() && !detail::parse_port(uc.port, port_)) { return; }
  19656. path_ = std::move(uc.path);
  19657. if (!uc.query.empty()) { path_ += uc.query; }
  19658. #ifdef CPPHTTPLIB_SSL_ENABLED
  19659. is_ssl_ = is_ssl;
  19660. if (is_ssl_) {
  19661. // The context lives as long as the client so that CA configuration
  19662. // survives reconnects; sessions are created per connection.
  19663. tls_ctx_ = tls::create_client_context();
  19664. if (!tls_ctx_) { return; }
  19665. }
  19666. #else
  19667. if (is_ssl) { return; }
  19668. #endif
  19669. is_valid_ = true;
  19670. }
  19671. }
  19672. #ifdef CPPHTTPLIB_SSL_ENABLED
  19673. inline WebSocketClient::WebSocketClient(
  19674. const std::string &scheme_host_port_path, const PemMemory &pem,
  19675. const Headers &headers)
  19676. : WebSocketClient(scheme_host_port_path, headers) {
  19677. // For ws:// URLs the client certificate is silently ignored, consistent
  19678. // with the TLS-only setters such as set_ca_cert_path().
  19679. if (is_valid_ && is_ssl_ && pem.cert_pem && pem.key_pem) {
  19680. if (!tls::set_client_cert_pem(tls_ctx_, pem.cert_pem, pem.key_pem,
  19681. pem.private_key_password)) {
  19682. tls::free_context(tls_ctx_);
  19683. tls_ctx_ = nullptr;
  19684. is_valid_ = false;
  19685. }
  19686. }
  19687. }
  19688. #endif
  19689. inline WebSocketClient::~WebSocketClient() {
  19690. shutdown_and_close();
  19691. #ifdef CPPHTTPLIB_SSL_ENABLED
  19692. if (tls_ctx_) {
  19693. tls::free_context(tls_ctx_);
  19694. tls_ctx_ = nullptr;
  19695. }
  19696. #endif
  19697. }
  19698. inline bool WebSocketClient::is_valid() const { return is_valid_; }
  19699. inline void WebSocketClient::shutdown_and_close() {
  19700. // Send the close frame while the TLS session is still alive: ws_ holds an
  19701. // SSLSocketStream that keeps a raw pointer to tls_session_, so the session
  19702. // must outlive ws_->close() and ws_.reset() to avoid a use-after-free.
  19703. if (ws_ && ws_->is_open()) { ws_->close(); }
  19704. ws_.reset();
  19705. #ifdef CPPHTTPLIB_SSL_ENABLED
  19706. if (is_ssl_) {
  19707. if (tls_session_) {
  19708. tls::shutdown(tls_session_, true);
  19709. tls::free_session(tls_session_);
  19710. tls_session_ = nullptr;
  19711. }
  19712. }
  19713. #endif
  19714. if (sock_ != INVALID_SOCKET) {
  19715. detail::shutdown_socket(sock_);
  19716. detail::close_socket(sock_);
  19717. sock_ = INVALID_SOCKET;
  19718. }
  19719. }
  19720. inline bool WebSocketClient::create_stream(std::unique_ptr<Stream> &strm,
  19721. Error &error, int &ssl_error,
  19722. uint64_t &ssl_backend_error) {
  19723. // A read timeout of 0 means "wait forever", the way SO_RCVTIMEO reads it.
  19724. // The streams wait with poll(), where 0 instead means "return immediately",
  19725. // so they are given the negative poll uses for an unbounded wait.
  19726. auto unbounded = read_timeout_sec_ == 0 && read_timeout_usec_ == 0;
  19727. time_t strm_read_sec = unbounded ? -1 : read_timeout_sec_;
  19728. time_t strm_read_usec = unbounded ? 0 : read_timeout_usec_;
  19729. // The handshake belongs to establishing the connection, so an unset read
  19730. // timeout leaves it bounded by the connection timeout instead of forever.
  19731. time_t hs_sec = unbounded ? connection_timeout_sec_ : read_timeout_sec_;
  19732. time_t hs_usec = unbounded ? connection_timeout_usec_ : read_timeout_usec_;
  19733. #ifdef CPPHTTPLIB_SSL_ENABLED
  19734. if (is_ssl_) {
  19735. // A plain flag rather than SSLClient::load_certs()'s call_once: connect()
  19736. // is not safe to call concurrently on one client to begin with, since
  19737. // nothing else here is guarded either.
  19738. if (server_certificate_verification_ && !certs_loaded_) {
  19739. uint64_t backend_error = 0;
  19740. detail::load_client_ca_config(tls_ctx_, ca_cert_file_path_,
  19741. ca_cert_dir_path_, custom_ca_loaded_,
  19742. system_ca_mode_, backend_error);
  19743. certs_loaded_ = true;
  19744. }
  19745. detail::ClientTlsSessionOptions options;
  19746. options.server_hostname_verification = server_hostname_verification_;
  19747. detail::ClientTlsSessionError tls_error;
  19748. if (!detail::setup_client_tls_session(host_, tls_ctx_, tls_session_, sock_,
  19749. server_certificate_verification_,
  19750. hs_sec, hs_usec, &tls_error,
  19751. options)) {
  19752. error = tls_error.error;
  19753. ssl_error = tls_error.ssl_error;
  19754. ssl_backend_error = tls_error.backend_error;
  19755. return false;
  19756. }
  19757. strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  19758. sock_, tls_session_, strm_read_sec, strm_read_usec, write_timeout_sec_,
  19759. write_timeout_usec_));
  19760. return true;
  19761. }
  19762. #else
  19763. (void)error;
  19764. (void)ssl_error;
  19765. (void)ssl_backend_error;
  19766. (void)hs_sec;
  19767. (void)hs_usec;
  19768. #endif
  19769. strm = std::unique_ptr<Stream>(
  19770. new detail::SocketStream(sock_, strm_read_sec, strm_read_usec,
  19771. write_timeout_sec_, write_timeout_usec_));
  19772. return true;
  19773. }
  19774. inline void WebSocketClient::prepare_default_headers(Request &req) {
  19775. #ifdef CPPHTTPLIB_SSL_ENABLED
  19776. auto is_ssl = is_ssl_;
  19777. #else
  19778. auto is_ssl = false;
  19779. #endif
  19780. if (!req.has_header("Host")) {
  19781. req.headers.emplace("Host", detail::make_default_host_header_value(
  19782. host_, port_, is_ssl, address_family_));
  19783. }
  19784. detail::add_default_user_agent_header(req);
  19785. }
  19786. inline Result WebSocketClient::connect() {
  19787. if (!is_valid_) { return Result{Error::Connection, -1, Headers{}}; }
  19788. shutdown_and_close();
  19789. // Check is custom IP or hostname specified for host_
  19790. std::string connect_host;
  19791. std::string ip;
  19792. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  19793. auto error = Error::Success;
  19794. sock_ = detail::create_client_socket(
  19795. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  19796. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  19797. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  19798. write_timeout_usec_, interface_, error);
  19799. if (sock_ == INVALID_SOCKET) {
  19800. if (error == Error::Success) { error = Error::Connection; }
  19801. return Result{error, -1, Headers{}};
  19802. }
  19803. std::unique_ptr<Stream> strm;
  19804. auto stream_error = Error::SSLConnection;
  19805. int ssl_error = 0;
  19806. uint64_t ssl_backend_error = 0;
  19807. if (!create_stream(strm, stream_error, ssl_error, ssl_backend_error)) {
  19808. shutdown_and_close();
  19809. #ifdef CPPHTTPLIB_SSL_ENABLED
  19810. return Result{stream_error, -1, Headers{}, ssl_error, ssl_backend_error};
  19811. #else
  19812. return Result{stream_error, -1, Headers{}};
  19813. #endif
  19814. }
  19815. Request req;
  19816. req.method = "GET";
  19817. req.path = path_;
  19818. req.headers = headers_;
  19819. prepare_default_headers(req);
  19820. detail::WebSocketUpgradeResponse upgrade;
  19821. if (!detail::perform_websocket_handshake(*strm, req, upgrade)) {
  19822. shutdown_and_close();
  19823. return Result{upgrade.error, upgrade.status, std::move(upgrade.headers)};
  19824. }
  19825. subprotocol_ = std::move(upgrade.selected_subprotocol);
  19826. ws_ = std::unique_ptr<WebSocket>(new WebSocket(std::move(strm), req, false,
  19827. websocket_ping_interval_sec_,
  19828. websocket_max_missed_pongs_));
  19829. // The stream was created with the timeout already; tell the WebSocket
  19830. // whether it came from the caller, so read() knows to report it as Timeout.
  19831. ws_->read_timeout_set_ = read_timeout_set_;
  19832. return Result{Error::Success, upgrade.status, std::move(upgrade.headers)};
  19833. }
  19834. inline ReadResult WebSocketClient::read(std::string &msg) {
  19835. if (!ws_) { return Fail; }
  19836. return ws_->read(msg);
  19837. }
  19838. inline bool WebSocketClient::send(const std::string &data) {
  19839. if (!ws_) { return false; }
  19840. return ws_->send(data);
  19841. }
  19842. inline bool WebSocketClient::send(const char *data, size_t len) {
  19843. if (!ws_) { return false; }
  19844. return ws_->send(data, len);
  19845. }
  19846. inline void WebSocketClient::close(CloseStatus status,
  19847. const std::string &reason) {
  19848. if (ws_) { ws_->close(status, reason); }
  19849. }
  19850. inline bool WebSocketClient::is_open() const { return ws_ && ws_->is_open(); }
  19851. inline const std::string &WebSocketClient::subprotocol() const {
  19852. return subprotocol_;
  19853. }
  19854. inline void WebSocketClient::set_read_timeout(time_t sec, time_t usec) {
  19855. read_timeout_sec_ = sec;
  19856. read_timeout_usec_ = usec;
  19857. read_timeout_set_ = true;
  19858. // The members above only seed the next connect(); read() consults the
  19859. // stream, so an already-open connection has to be told directly.
  19860. if (ws_) { ws_->set_read_timeout(sec, usec); }
  19861. }
  19862. inline void WebSocketClient::set_write_timeout(time_t sec, time_t usec) {
  19863. write_timeout_sec_ = sec;
  19864. write_timeout_usec_ = usec;
  19865. }
  19866. inline void WebSocketClient::set_websocket_ping_interval(time_t sec) {
  19867. websocket_ping_interval_sec_ = sec;
  19868. }
  19869. inline void WebSocketClient::set_websocket_max_missed_pongs(int count) {
  19870. websocket_max_missed_pongs_ = count;
  19871. }
  19872. inline void WebSocketClient::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  19873. inline void WebSocketClient::set_address_family(int family) {
  19874. address_family_ = family;
  19875. }
  19876. inline void WebSocketClient::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  19877. inline void WebSocketClient::set_socket_options(SocketOptions socket_options) {
  19878. socket_options_ = std::move(socket_options);
  19879. }
  19880. inline void WebSocketClient::set_connection_timeout(time_t sec, time_t usec) {
  19881. connection_timeout_sec_ = sec;
  19882. connection_timeout_usec_ = usec;
  19883. }
  19884. inline void WebSocketClient::set_interface(const std::string &intf) {
  19885. interface_ = intf;
  19886. }
  19887. inline void WebSocketClient::set_hostname_addr_map(
  19888. std::map<std::string, std::string> addr_map) {
  19889. addr_map_ = std::move(addr_map);
  19890. }
  19891. #ifdef CPPHTTPLIB_SSL_ENABLED
  19892. inline void
  19893. WebSocketClient::set_ca_cert_path(const std::string &ca_cert_file_path,
  19894. const std::string &ca_cert_dir_path) {
  19895. ca_cert_file_path_ = ca_cert_file_path;
  19896. ca_cert_dir_path_ = ca_cert_dir_path;
  19897. }
  19898. inline void WebSocketClient::set_ca_cert_store(tls::ca_store_t store) {
  19899. if (store && tls_ctx_) {
  19900. // set_ca_store takes ownership of store
  19901. tls::set_ca_store(tls_ctx_, store);
  19902. custom_ca_loaded_ = true;
  19903. } else if (store) {
  19904. tls::free_ca_store(store);
  19905. }
  19906. }
  19907. inline void WebSocketClient::load_ca_cert_store(const char *ca_cert,
  19908. std::size_t size) {
  19909. if (tls_ctx_ && ca_cert && size > 0) {
  19910. tls::load_ca_pem(tls_ctx_, ca_cert, size);
  19911. custom_ca_loaded_ = true;
  19912. }
  19913. }
  19914. inline void
  19915. WebSocketClient::enable_server_certificate_verification(bool enabled) {
  19916. server_certificate_verification_ = enabled;
  19917. }
  19918. inline void WebSocketClient::enable_server_hostname_verification(bool enabled) {
  19919. server_hostname_verification_ = enabled;
  19920. }
  19921. inline void WebSocketClient::enable_system_ca(bool enabled) {
  19922. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  19923. }
  19924. #endif // CPPHTTPLIB_SSL_ENABLED
  19925. } // namespace ws
  19926. // ----------------------------------------------------------------------------
  19927. } // namespace httplib
  19928. #endif // CPPHTTPLIB_HTTPLIB_H