httplib.h 811 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446144471444814449144501445114452144531445414455144561445714458144591446014461144621446314464144651446614467144681446914470144711447214473144741447514476144771447814479144801448114482144831448414485144861448714488144891449014491144921449314494144951449614497144981449914500145011450214503145041450514506145071450814509145101451114512145131451414515145161451714518145191452014521145221452314524145251452614527145281452914530145311453214533145341453514536145371453814539145401454114542145431454414545145461454714548145491455014551145521455314554145551455614557145581455914560145611456214563145641456514566145671456814569145701457114572145731457414575145761457714578145791458014581145821458314584145851458614587145881458914590145911459214593145941459514596145971459814599146001460114602146031460414605146061460714608146091461014611146121461314614146151461614617146181461914620146211462214623146241462514626146271462814629146301463114632146331463414635146361463714638146391464014641146421464314644146451464614647146481464914650146511465214653146541465514656146571465814659146601466114662146631466414665146661466714668146691467014671146721467314674146751467614677146781467914680146811468214683146841468514686146871468814689146901469114692146931469414695146961469714698146991470014701147021470314704147051470614707147081470914710147111471214713147141471514716147171471814719147201472114722147231472414725147261472714728147291473014731147321473314734147351473614737147381473914740147411474214743147441474514746147471474814749147501475114752147531475414755147561475714758147591476014761147621476314764147651476614767147681476914770147711477214773147741477514776147771477814779147801478114782147831478414785147861478714788147891479014791147921479314794147951479614797147981479914800148011480214803148041480514806148071480814809148101481114812148131481414815148161481714818148191482014821148221482314824148251482614827148281482914830148311483214833148341483514836148371483814839148401484114842148431484414845148461484714848148491485014851148521485314854148551485614857148581485914860148611486214863148641486514866148671486814869148701487114872148731487414875148761487714878148791488014881148821488314884148851488614887148881488914890148911489214893148941489514896148971489814899149001490114902149031490414905149061490714908149091491014911149121491314914149151491614917149181491914920149211492214923149241492514926149271492814929149301493114932149331493414935149361493714938149391494014941149421494314944149451494614947149481494914950149511495214953149541495514956149571495814959149601496114962149631496414965149661496714968149691497014971149721497314974149751497614977149781497914980149811498214983149841498514986149871498814989149901499114992149931499414995149961499714998149991500015001150021500315004150051500615007150081500915010150111501215013150141501515016150171501815019150201502115022150231502415025150261502715028150291503015031150321503315034150351503615037150381503915040150411504215043150441504515046150471504815049150501505115052150531505415055150561505715058150591506015061150621506315064150651506615067150681506915070150711507215073150741507515076150771507815079150801508115082150831508415085150861508715088150891509015091150921509315094150951509615097150981509915100151011510215103151041510515106151071510815109151101511115112151131511415115151161511715118151191512015121151221512315124151251512615127151281512915130151311513215133151341513515136151371513815139151401514115142151431514415145151461514715148151491515015151151521515315154151551515615157151581515915160151611516215163151641516515166151671516815169151701517115172151731517415175151761517715178151791518015181151821518315184151851518615187151881518915190151911519215193151941519515196151971519815199152001520115202152031520415205152061520715208152091521015211152121521315214152151521615217152181521915220152211522215223152241522515226152271522815229152301523115232152331523415235152361523715238152391524015241152421524315244152451524615247152481524915250152511525215253152541525515256152571525815259152601526115262152631526415265152661526715268152691527015271152721527315274152751527615277152781527915280152811528215283152841528515286152871528815289152901529115292152931529415295152961529715298152991530015301153021530315304153051530615307153081530915310153111531215313153141531515316153171531815319153201532115322153231532415325153261532715328153291533015331153321533315334153351533615337153381533915340153411534215343153441534515346153471534815349153501535115352153531535415355153561535715358153591536015361153621536315364153651536615367153681536915370153711537215373153741537515376153771537815379153801538115382153831538415385153861538715388153891539015391153921539315394153951539615397153981539915400154011540215403154041540515406154071540815409154101541115412154131541415415154161541715418154191542015421154221542315424154251542615427154281542915430154311543215433154341543515436154371543815439154401544115442154431544415445154461544715448154491545015451154521545315454154551545615457154581545915460154611546215463154641546515466154671546815469154701547115472154731547415475154761547715478154791548015481154821548315484154851548615487154881548915490154911549215493154941549515496154971549815499155001550115502155031550415505155061550715508155091551015511155121551315514155151551615517155181551915520155211552215523155241552515526155271552815529155301553115532155331553415535155361553715538155391554015541155421554315544155451554615547155481554915550155511555215553155541555515556155571555815559155601556115562155631556415565155661556715568155691557015571155721557315574155751557615577155781557915580155811558215583155841558515586155871558815589155901559115592155931559415595155961559715598155991560015601156021560315604156051560615607156081560915610156111561215613156141561515616156171561815619156201562115622156231562415625156261562715628156291563015631156321563315634156351563615637156381563915640156411564215643156441564515646156471564815649156501565115652156531565415655156561565715658156591566015661156621566315664156651566615667156681566915670156711567215673156741567515676156771567815679156801568115682156831568415685156861568715688156891569015691156921569315694156951569615697156981569915700157011570215703157041570515706157071570815709157101571115712157131571415715157161571715718157191572015721157221572315724157251572615727157281572915730157311573215733157341573515736157371573815739157401574115742157431574415745157461574715748157491575015751157521575315754157551575615757157581575915760157611576215763157641576515766157671576815769157701577115772157731577415775157761577715778157791578015781157821578315784157851578615787157881578915790157911579215793157941579515796157971579815799158001580115802158031580415805158061580715808158091581015811158121581315814158151581615817158181581915820158211582215823158241582515826158271582815829158301583115832158331583415835158361583715838158391584015841158421584315844158451584615847158481584915850158511585215853158541585515856158571585815859158601586115862158631586415865158661586715868158691587015871158721587315874158751587615877158781587915880158811588215883158841588515886158871588815889158901589115892158931589415895158961589715898158991590015901159021590315904159051590615907159081590915910159111591215913159141591515916159171591815919159201592115922159231592415925159261592715928159291593015931159321593315934159351593615937159381593915940159411594215943159441594515946159471594815949159501595115952159531595415955159561595715958159591596015961159621596315964159651596615967159681596915970159711597215973159741597515976159771597815979159801598115982159831598415985159861598715988159891599015991159921599315994159951599615997159981599916000160011600216003160041600516006160071600816009160101601116012160131601416015160161601716018160191602016021160221602316024160251602616027160281602916030160311603216033160341603516036160371603816039160401604116042160431604416045160461604716048160491605016051160521605316054160551605616057160581605916060160611606216063160641606516066160671606816069160701607116072160731607416075160761607716078160791608016081160821608316084160851608616087160881608916090160911609216093160941609516096160971609816099161001610116102161031610416105161061610716108161091611016111161121611316114161151611616117161181611916120161211612216123161241612516126161271612816129161301613116132161331613416135161361613716138161391614016141161421614316144161451614616147161481614916150161511615216153161541615516156161571615816159161601616116162161631616416165161661616716168161691617016171161721617316174161751617616177161781617916180161811618216183161841618516186161871618816189161901619116192161931619416195161961619716198161991620016201162021620316204162051620616207162081620916210162111621216213162141621516216162171621816219162201622116222162231622416225162261622716228162291623016231162321623316234162351623616237162381623916240162411624216243162441624516246162471624816249162501625116252162531625416255162561625716258162591626016261162621626316264162651626616267162681626916270162711627216273162741627516276162771627816279162801628116282162831628416285162861628716288162891629016291162921629316294162951629616297162981629916300163011630216303163041630516306163071630816309163101631116312163131631416315163161631716318163191632016321163221632316324163251632616327163281632916330163311633216333163341633516336163371633816339163401634116342163431634416345163461634716348163491635016351163521635316354163551635616357163581635916360163611636216363163641636516366163671636816369163701637116372163731637416375163761637716378163791638016381163821638316384163851638616387163881638916390163911639216393163941639516396163971639816399164001640116402164031640416405164061640716408164091641016411164121641316414164151641616417164181641916420164211642216423164241642516426164271642816429164301643116432164331643416435164361643716438164391644016441164421644316444164451644616447164481644916450164511645216453164541645516456164571645816459164601646116462164631646416465164661646716468164691647016471164721647316474164751647616477164781647916480164811648216483164841648516486164871648816489164901649116492164931649416495164961649716498164991650016501165021650316504165051650616507165081650916510165111651216513165141651516516165171651816519165201652116522165231652416525165261652716528165291653016531165321653316534165351653616537165381653916540165411654216543165441654516546165471654816549165501655116552165531655416555165561655716558165591656016561165621656316564165651656616567165681656916570165711657216573165741657516576165771657816579165801658116582165831658416585165861658716588165891659016591165921659316594165951659616597165981659916600166011660216603166041660516606166071660816609166101661116612166131661416615166161661716618166191662016621166221662316624166251662616627166281662916630166311663216633166341663516636166371663816639166401664116642166431664416645166461664716648166491665016651166521665316654166551665616657166581665916660166611666216663166641666516666166671666816669166701667116672166731667416675166761667716678166791668016681166821668316684166851668616687166881668916690166911669216693166941669516696166971669816699167001670116702167031670416705167061670716708167091671016711167121671316714167151671616717167181671916720167211672216723167241672516726167271672816729167301673116732167331673416735167361673716738167391674016741167421674316744167451674616747167481674916750167511675216753167541675516756167571675816759167601676116762167631676416765167661676716768167691677016771167721677316774167751677616777167781677916780167811678216783167841678516786167871678816789167901679116792167931679416795167961679716798167991680016801168021680316804168051680616807168081680916810168111681216813168141681516816168171681816819168201682116822168231682416825168261682716828168291683016831168321683316834168351683616837168381683916840168411684216843168441684516846168471684816849168501685116852168531685416855168561685716858168591686016861168621686316864168651686616867168681686916870168711687216873168741687516876168771687816879168801688116882168831688416885168861688716888168891689016891168921689316894168951689616897168981689916900169011690216903169041690516906169071690816909169101691116912169131691416915169161691716918169191692016921169221692316924169251692616927169281692916930169311693216933169341693516936169371693816939169401694116942169431694416945169461694716948169491695016951169521695316954169551695616957169581695916960169611696216963169641696516966169671696816969169701697116972169731697416975169761697716978169791698016981169821698316984169851698616987169881698916990169911699216993169941699516996169971699816999170001700117002170031700417005170061700717008170091701017011170121701317014170151701617017170181701917020170211702217023170241702517026170271702817029170301703117032170331703417035170361703717038170391704017041170421704317044170451704617047170481704917050170511705217053170541705517056170571705817059170601706117062170631706417065170661706717068170691707017071170721707317074170751707617077170781707917080170811708217083170841708517086170871708817089170901709117092170931709417095170961709717098170991710017101171021710317104171051710617107171081710917110171111711217113171141711517116171171711817119171201712117122171231712417125171261712717128171291713017131171321713317134171351713617137171381713917140171411714217143171441714517146171471714817149171501715117152171531715417155171561715717158171591716017161171621716317164171651716617167171681716917170171711717217173171741717517176171771717817179171801718117182171831718417185171861718717188171891719017191171921719317194171951719617197171981719917200172011720217203172041720517206172071720817209172101721117212172131721417215172161721717218172191722017221172221722317224172251722617227172281722917230172311723217233172341723517236172371723817239172401724117242172431724417245172461724717248172491725017251172521725317254172551725617257172581725917260172611726217263172641726517266172671726817269172701727117272172731727417275172761727717278172791728017281172821728317284172851728617287172881728917290172911729217293172941729517296172971729817299173001730117302173031730417305173061730717308173091731017311173121731317314173151731617317173181731917320173211732217323173241732517326173271732817329173301733117332173331733417335173361733717338173391734017341173421734317344173451734617347173481734917350173511735217353173541735517356173571735817359173601736117362173631736417365173661736717368173691737017371173721737317374173751737617377173781737917380173811738217383173841738517386173871738817389173901739117392173931739417395173961739717398173991740017401174021740317404174051740617407174081740917410174111741217413174141741517416174171741817419174201742117422174231742417425174261742717428174291743017431174321743317434174351743617437174381743917440174411744217443174441744517446174471744817449174501745117452174531745417455174561745717458174591746017461174621746317464174651746617467174681746917470174711747217473174741747517476174771747817479174801748117482174831748417485174861748717488174891749017491174921749317494174951749617497174981749917500175011750217503175041750517506175071750817509175101751117512175131751417515175161751717518175191752017521175221752317524175251752617527175281752917530175311753217533175341753517536175371753817539175401754117542175431754417545175461754717548175491755017551175521755317554175551755617557175581755917560175611756217563175641756517566175671756817569175701757117572175731757417575175761757717578175791758017581175821758317584175851758617587175881758917590175911759217593175941759517596175971759817599176001760117602176031760417605176061760717608176091761017611176121761317614176151761617617176181761917620176211762217623176241762517626176271762817629176301763117632176331763417635176361763717638176391764017641176421764317644176451764617647176481764917650176511765217653176541765517656176571765817659176601766117662176631766417665176661766717668176691767017671176721767317674176751767617677176781767917680176811768217683176841768517686176871768817689176901769117692176931769417695176961769717698176991770017701177021770317704177051770617707177081770917710177111771217713177141771517716177171771817719177201772117722177231772417725177261772717728177291773017731177321773317734177351773617737177381773917740177411774217743177441774517746177471774817749177501775117752177531775417755177561775717758177591776017761177621776317764177651776617767177681776917770177711777217773177741777517776177771777817779177801778117782177831778417785177861778717788177891779017791177921779317794177951779617797177981779917800178011780217803178041780517806178071780817809178101781117812178131781417815178161781717818178191782017821178221782317824178251782617827178281782917830178311783217833178341783517836178371783817839178401784117842178431784417845178461784717848178491785017851178521785317854178551785617857178581785917860178611786217863178641786517866178671786817869178701787117872178731787417875178761787717878178791788017881178821788317884178851788617887178881788917890178911789217893178941789517896178971789817899179001790117902179031790417905179061790717908179091791017911179121791317914179151791617917179181791917920179211792217923179241792517926179271792817929179301793117932179331793417935179361793717938179391794017941179421794317944179451794617947179481794917950179511795217953179541795517956179571795817959179601796117962179631796417965179661796717968179691797017971179721797317974179751797617977179781797917980179811798217983179841798517986179871798817989179901799117992179931799417995179961799717998179991800018001180021800318004180051800618007180081800918010180111801218013180141801518016180171801818019180201802118022180231802418025180261802718028180291803018031180321803318034180351803618037180381803918040180411804218043180441804518046180471804818049180501805118052180531805418055180561805718058180591806018061180621806318064180651806618067180681806918070180711807218073180741807518076180771807818079180801808118082180831808418085180861808718088180891809018091180921809318094180951809618097180981809918100181011810218103181041810518106181071810818109181101811118112181131811418115181161811718118181191812018121181221812318124181251812618127181281812918130181311813218133181341813518136181371813818139181401814118142181431814418145181461814718148181491815018151181521815318154181551815618157181581815918160181611816218163181641816518166181671816818169181701817118172181731817418175181761817718178181791818018181181821818318184181851818618187181881818918190181911819218193181941819518196181971819818199182001820118202182031820418205182061820718208182091821018211182121821318214182151821618217182181821918220182211822218223182241822518226182271822818229182301823118232182331823418235182361823718238182391824018241182421824318244182451824618247182481824918250182511825218253182541825518256182571825818259182601826118262182631826418265182661826718268182691827018271182721827318274182751827618277182781827918280182811828218283182841828518286182871828818289182901829118292182931829418295182961829718298182991830018301183021830318304183051830618307183081830918310183111831218313183141831518316183171831818319183201832118322183231832418325183261832718328183291833018331183321833318334183351833618337183381833918340183411834218343183441834518346183471834818349183501835118352183531835418355183561835718358183591836018361183621836318364183651836618367183681836918370183711837218373183741837518376183771837818379183801838118382183831838418385183861838718388183891839018391183921839318394183951839618397183981839918400184011840218403184041840518406184071840818409184101841118412184131841418415184161841718418184191842018421184221842318424184251842618427184281842918430184311843218433184341843518436184371843818439184401844118442184431844418445184461844718448184491845018451184521845318454184551845618457184581845918460184611846218463184641846518466184671846818469184701847118472184731847418475184761847718478184791848018481184821848318484184851848618487184881848918490184911849218493184941849518496184971849818499185001850118502185031850418505185061850718508185091851018511185121851318514185151851618517185181851918520185211852218523185241852518526185271852818529185301853118532185331853418535185361853718538185391854018541185421854318544185451854618547185481854918550185511855218553185541855518556185571855818559185601856118562185631856418565185661856718568185691857018571185721857318574185751857618577185781857918580185811858218583185841858518586185871858818589185901859118592185931859418595185961859718598185991860018601186021860318604186051860618607186081860918610186111861218613186141861518616186171861818619186201862118622186231862418625186261862718628186291863018631186321863318634186351863618637186381863918640186411864218643186441864518646186471864818649186501865118652186531865418655186561865718658186591866018661186621866318664186651866618667186681866918670186711867218673186741867518676186771867818679186801868118682186831868418685186861868718688186891869018691186921869318694186951869618697186981869918700187011870218703187041870518706187071870818709187101871118712187131871418715187161871718718187191872018721187221872318724187251872618727187281872918730187311873218733187341873518736187371873818739187401874118742187431874418745187461874718748187491875018751187521875318754187551875618757187581875918760187611876218763187641876518766187671876818769187701877118772187731877418775187761877718778187791878018781187821878318784187851878618787187881878918790187911879218793187941879518796187971879818799188001880118802188031880418805188061880718808188091881018811188121881318814188151881618817188181881918820188211882218823188241882518826188271882818829188301883118832188331883418835188361883718838188391884018841188421884318844188451884618847188481884918850188511885218853188541885518856188571885818859188601886118862188631886418865188661886718868188691887018871188721887318874188751887618877188781887918880188811888218883188841888518886188871888818889188901889118892188931889418895188961889718898188991890018901189021890318904189051890618907189081890918910189111891218913189141891518916189171891818919189201892118922189231892418925189261892718928189291893018931189321893318934189351893618937189381893918940189411894218943189441894518946189471894818949189501895118952189531895418955189561895718958189591896018961189621896318964189651896618967189681896918970189711897218973189741897518976189771897818979189801898118982189831898418985189861898718988189891899018991189921899318994189951899618997189981899919000190011900219003190041900519006190071900819009190101901119012190131901419015190161901719018190191902019021190221902319024190251902619027190281902919030190311903219033190341903519036190371903819039190401904119042190431904419045190461904719048190491905019051190521905319054190551905619057190581905919060190611906219063190641906519066190671906819069190701907119072190731907419075190761907719078190791908019081190821908319084190851908619087190881908919090190911909219093190941909519096190971909819099191001910119102191031910419105191061910719108191091911019111191121911319114191151911619117191181911919120191211912219123191241912519126191271912819129191301913119132191331913419135191361913719138191391914019141191421914319144191451914619147191481914919150191511915219153191541915519156191571915819159191601916119162191631916419165191661916719168191691917019171191721917319174191751917619177191781917919180191811918219183191841918519186191871918819189191901919119192191931919419195191961919719198191991920019201192021920319204192051920619207192081920919210192111921219213192141921519216192171921819219192201922119222192231922419225192261922719228192291923019231192321923319234192351923619237192381923919240192411924219243192441924519246192471924819249192501925119252192531925419255192561925719258192591926019261192621926319264192651926619267192681926919270192711927219273192741927519276192771927819279192801928119282192831928419285192861928719288192891929019291192921929319294192951929619297192981929919300193011930219303193041930519306193071930819309193101931119312193131931419315193161931719318193191932019321193221932319324193251932619327193281932919330193311933219333193341933519336193371933819339193401934119342193431934419345193461934719348193491935019351193521935319354193551935619357193581935919360193611936219363193641936519366193671936819369193701937119372193731937419375193761937719378193791938019381193821938319384193851938619387193881938919390193911939219393193941939519396193971939819399194001940119402194031940419405194061940719408194091941019411194121941319414194151941619417194181941919420194211942219423194241942519426194271942819429194301943119432194331943419435194361943719438194391944019441194421944319444194451944619447194481944919450194511945219453194541945519456194571945819459194601946119462194631946419465194661946719468194691947019471194721947319474194751947619477194781947919480194811948219483194841948519486194871948819489194901949119492194931949419495194961949719498194991950019501195021950319504195051950619507195081950919510195111951219513195141951519516195171951819519195201952119522195231952419525195261952719528195291953019531195321953319534195351953619537195381953919540195411954219543195441954519546195471954819549195501955119552195531955419555195561955719558195591956019561195621956319564195651956619567195681956919570195711957219573195741957519576195771957819579195801958119582195831958419585195861958719588195891959019591195921959319594195951959619597195981959919600196011960219603196041960519606196071960819609196101961119612196131961419615196161961719618196191962019621196221962319624196251962619627196281962919630196311963219633196341963519636196371963819639196401964119642196431964419645196461964719648196491965019651196521965319654196551965619657196581965919660196611966219663196641966519666196671966819669196701967119672196731967419675196761967719678196791968019681196821968319684196851968619687196881968919690196911969219693196941969519696196971969819699197001970119702197031970419705197061970719708197091971019711197121971319714197151971619717197181971919720197211972219723197241972519726197271972819729197301973119732197331973419735197361973719738197391974019741197421974319744197451974619747197481974919750197511975219753197541975519756197571975819759197601976119762197631976419765197661976719768197691977019771197721977319774197751977619777197781977919780197811978219783197841978519786197871978819789197901979119792197931979419795197961979719798197991980019801198021980319804198051980619807198081980919810198111981219813198141981519816198171981819819198201982119822198231982419825198261982719828198291983019831198321983319834198351983619837198381983919840198411984219843198441984519846198471984819849198501985119852198531985419855198561985719858198591986019861198621986319864198651986619867198681986919870198711987219873198741987519876198771987819879198801988119882198831988419885198861988719888198891989019891198921989319894198951989619897198981989919900199011990219903199041990519906199071990819909199101991119912199131991419915199161991719918199191992019921199221992319924199251992619927199281992919930199311993219933199341993519936199371993819939199401994119942199431994419945199461994719948199491995019951199521995319954199551995619957199581995919960199611996219963199641996519966199671996819969199701997119972199731997419975199761997719978199791998019981199821998319984199851998619987199881998919990199911999219993199941999519996199971999819999200002000120002200032000420005200062000720008200092001020011200122001320014200152001620017200182001920020200212002220023200242002520026200272002820029200302003120032200332003420035200362003720038200392004020041200422004320044200452004620047200482004920050200512005220053200542005520056200572005820059200602006120062200632006420065200662006720068200692007020071200722007320074200752007620077200782007920080200812008220083200842008520086200872008820089200902009120092200932009420095200962009720098200992010020101201022010320104201052010620107201082010920110201112011220113201142011520116201172011820119201202012120122201232012420125201262012720128201292013020131201322013320134201352013620137201382013920140201412014220143201442014520146201472014820149201502015120152201532015420155201562015720158201592016020161201622016320164201652016620167201682016920170201712017220173201742017520176201772017820179201802018120182201832018420185201862018720188201892019020191201922019320194201952019620197201982019920200202012020220203202042020520206202072020820209202102021120212202132021420215202162021720218202192022020221202222022320224202252022620227202282022920230202312023220233202342023520236202372023820239202402024120242202432024420245202462024720248202492025020251202522025320254202552025620257202582025920260202612026220263202642026520266202672026820269202702027120272202732027420275202762027720278202792028020281202822028320284202852028620287202882028920290202912029220293202942029520296202972029820299203002030120302203032030420305203062030720308203092031020311203122031320314203152031620317203182031920320203212032220323203242032520326203272032820329203302033120332203332033420335203362033720338203392034020341203422034320344203452034620347203482034920350203512035220353203542035520356203572035820359203602036120362203632036420365203662036720368203692037020371203722037320374203752037620377203782037920380203812038220383203842038520386203872038820389203902039120392203932039420395203962039720398203992040020401204022040320404204052040620407204082040920410204112041220413204142041520416204172041820419204202042120422204232042420425204262042720428204292043020431204322043320434204352043620437204382043920440204412044220443204442044520446204472044820449204502045120452204532045420455204562045720458204592046020461204622046320464204652046620467204682046920470204712047220473204742047520476204772047820479204802048120482204832048420485204862048720488204892049020491204922049320494204952049620497204982049920500205012050220503205042050520506205072050820509205102051120512205132051420515205162051720518205192052020521205222052320524205252052620527205282052920530205312053220533205342053520536205372053820539205402054120542205432054420545205462054720548205492055020551205522055320554205552055620557205582055920560205612056220563205642056520566205672056820569205702057120572205732057420575205762057720578205792058020581205822058320584205852058620587205882058920590205912059220593205942059520596205972059820599206002060120602206032060420605206062060720608206092061020611206122061320614206152061620617206182061920620206212062220623206242062520626206272062820629206302063120632206332063420635206362063720638206392064020641206422064320644206452064620647206482064920650206512065220653206542065520656206572065820659206602066120662206632066420665206662066720668206692067020671206722067320674206752067620677206782067920680206812068220683206842068520686206872068820689206902069120692206932069420695206962069720698206992070020701207022070320704207052070620707207082070920710207112071220713207142071520716207172071820719207202072120722207232072420725207262072720728207292073020731207322073320734207352073620737207382073920740207412074220743207442074520746207472074820749207502075120752207532075420755207562075720758207592076020761207622076320764207652076620767207682076920770207712077220773207742077520776207772077820779207802078120782207832078420785207862078720788207892079020791207922079320794207952079620797207982079920800208012080220803208042080520806208072080820809208102081120812208132081420815208162081720818208192082020821208222082320824208252082620827208282082920830208312083220833208342083520836208372083820839208402084120842208432084420845208462084720848208492085020851208522085320854208552085620857208582085920860208612086220863208642086520866208672086820869208702087120872208732087420875208762087720878208792088020881208822088320884208852088620887208882088920890208912089220893208942089520896208972089820899209002090120902209032090420905209062090720908209092091020911209122091320914209152091620917209182091920920209212092220923209242092520926209272092820929209302093120932209332093420935209362093720938209392094020941209422094320944209452094620947209482094920950209512095220953209542095520956209572095820959209602096120962209632096420965209662096720968209692097020971209722097320974209752097620977209782097920980209812098220983209842098520986209872098820989209902099120992209932099420995209962099720998209992100021001210022100321004210052100621007210082100921010210112101221013210142101521016210172101821019210202102121022210232102421025210262102721028210292103021031210322103321034210352103621037210382103921040210412104221043210442104521046210472104821049210502105121052210532105421055210562105721058210592106021061210622106321064210652106621067210682106921070210712107221073210742107521076210772107821079210802108121082210832108421085210862108721088210892109021091210922109321094210952109621097210982109921100211012110221103211042110521106211072110821109211102111121112211132111421115211162111721118211192112021121211222112321124211252112621127211282112921130211312113221133211342113521136211372113821139211402114121142211432114421145211462114721148211492115021151211522115321154211552115621157211582115921160211612116221163211642116521166211672116821169211702117121172211732117421175211762117721178211792118021181211822118321184211852118621187211882118921190211912119221193211942119521196211972119821199212002120121202212032120421205212062120721208212092121021211212122121321214212152121621217212182121921220212212122221223212242122521226212272122821229212302123121232212332123421235212362123721238212392124021241212422124321244212452124621247212482124921250212512125221253212542125521256212572125821259212602126121262212632126421265212662126721268212692127021271212722127321274212752127621277212782127921280212812128221283212842128521286212872128821289212902129121292212932129421295212962129721298212992130021301213022130321304213052130621307213082130921310213112131221313213142131521316213172131821319213202132121322213232132421325213262132721328213292133021331213322133321334213352133621337213382133921340213412134221343213442134521346213472134821349213502135121352213532135421355213562135721358213592136021361213622136321364213652136621367213682136921370213712137221373213742137521376213772137821379213802138121382213832138421385213862138721388213892139021391213922139321394213952139621397213982139921400214012140221403214042140521406214072140821409214102141121412214132141421415214162141721418214192142021421214222142321424214252142621427214282142921430214312143221433214342143521436214372143821439214402144121442214432144421445214462144721448214492145021451214522145321454214552145621457214582145921460214612146221463214642146521466214672146821469214702147121472214732147421475214762147721478214792148021481214822148321484214852148621487214882148921490214912149221493214942149521496214972149821499215002150121502215032150421505215062150721508215092151021511215122151321514215152151621517215182151921520215212152221523215242152521526215272152821529215302153121532215332153421535215362153721538215392154021541215422154321544215452154621547215482154921550215512155221553215542155521556215572155821559215602156121562215632156421565215662156721568215692157021571215722157321574215752157621577215782157921580215812158221583215842158521586215872158821589215902159121592215932159421595215962159721598215992160021601216022160321604216052160621607216082160921610216112161221613216142161521616216172161821619216202162121622216232162421625216262162721628216292163021631216322163321634216352163621637216382163921640216412164221643216442164521646216472164821649216502165121652216532165421655216562165721658216592166021661216622166321664216652166621667216682166921670216712167221673216742167521676216772167821679216802168121682216832168421685216862168721688216892169021691216922169321694216952169621697216982169921700217012170221703217042170521706217072170821709217102171121712217132171421715217162171721718217192172021721217222172321724217252172621727217282172921730217312173221733217342173521736217372173821739217402174121742217432174421745217462174721748217492175021751217522175321754217552175621757217582175921760217612176221763217642176521766217672176821769217702177121772217732177421775217762177721778217792178021781217822178321784217852178621787217882178921790217912179221793217942179521796217972179821799218002180121802218032180421805218062180721808218092181021811218122181321814218152181621817218182181921820218212182221823218242182521826218272182821829218302183121832218332183421835218362183721838218392184021841218422184321844218452184621847218482184921850218512185221853218542185521856218572185821859218602186121862218632186421865218662186721868218692187021871218722187321874218752187621877218782187921880218812188221883218842188521886218872188821889218902189121892218932189421895218962189721898218992190021901219022190321904219052190621907219082190921910219112191221913219142191521916219172191821919219202192121922219232192421925219262192721928219292193021931219322193321934219352193621937219382193921940219412194221943219442194521946219472194821949219502195121952219532195421955219562195721958219592196021961219622196321964219652196621967219682196921970219712197221973219742197521976219772197821979219802198121982219832198421985219862198721988219892199021991219922199321994219952199621997219982199922000220012200222003220042200522006220072200822009220102201122012220132201422015220162201722018220192202022021220222202322024220252202622027220282202922030220312203222033220342203522036220372203822039220402204122042220432204422045220462204722048220492205022051220522205322054220552205622057220582205922060220612206222063220642206522066220672206822069220702207122072220732207422075220762207722078220792208022081220822208322084220852208622087220882208922090220912209222093220942209522096220972209822099221002210122102221032210422105221062210722108221092211022111221122211322114221152211622117221182211922120221212212222123221242212522126221272212822129221302213122132221332213422135221362213722138221392214022141221422214322144221452214622147221482214922150221512215222153221542215522156221572215822159221602216122162221632216422165221662216722168221692217022171221722217322174221752217622177221782217922180221812218222183221842218522186221872218822189221902219122192221932219422195221962219722198221992220022201222022220322204222052220622207222082220922210222112221222213222142221522216222172221822219222202222122222222232222422225222262222722228222292223022231222322223322234222352223622237222382223922240222412224222243222442224522246222472224822249222502225122252222532225422255222562225722258222592226022261222622226322264222652226622267222682226922270222712227222273222742227522276222772227822279222802228122282222832228422285222862228722288222892229022291222922229322294222952229622297222982229922300223012230222303223042230522306223072230822309223102231122312223132231422315223162231722318223192232022321223222232322324223252232622327223282232922330223312233222333223342233522336223372233822339223402234122342223432234422345223462234722348223492235022351223522235322354223552235622357223582235922360223612236222363223642236522366223672236822369223702237122372223732237422375223762237722378223792238022381223822238322384223852238622387223882238922390223912239222393223942239522396223972239822399224002240122402224032240422405224062240722408224092241022411224122241322414224152241622417224182241922420224212242222423224242242522426224272242822429224302243122432224332243422435224362243722438224392244022441224422244322444224452244622447224482244922450224512245222453224542245522456224572245822459224602246122462224632246422465224662246722468224692247022471224722247322474224752247622477224782247922480224812248222483224842248522486224872248822489224902249122492224932249422495224962249722498224992250022501225022250322504225052250622507225082250922510225112251222513225142251522516225172251822519225202252122522225232252422525225262252722528225292253022531225322253322534225352253622537225382253922540225412254222543225442254522546225472254822549225502255122552225532255422555225562255722558225592256022561225622256322564225652256622567225682256922570225712257222573225742257522576225772257822579225802258122582225832258422585225862258722588225892259022591225922259322594225952259622597225982259922600226012260222603226042260522606226072260822609226102261122612226132261422615226162261722618226192262022621226222262322624226252262622627226282262922630226312263222633226342263522636226372263822639226402264122642226432264422645226462264722648226492265022651226522265322654226552265622657226582265922660226612266222663226642266522666226672266822669226702267122672226732267422675226762267722678226792268022681226822268322684226852268622687226882268922690226912269222693226942269522696226972269822699227002270122702227032270422705227062270722708227092271022711227122271322714227152271622717227182271922720227212272222723227242272522726227272272822729227302273122732227332273422735227362273722738227392274022741227422274322744227452274622747227482274922750227512275222753227542275522756227572275822759227602276122762227632276422765227662276722768227692277022771227722277322774227752277622777227782277922780227812278222783227842278522786227872278822789227902279122792227932279422795227962279722798227992280022801228022280322804228052280622807228082280922810228112281222813228142281522816228172281822819228202282122822228232282422825228262282722828228292283022831228322283322834228352283622837228382283922840228412284222843228442284522846228472284822849228502285122852228532285422855228562285722858228592286022861228622286322864228652286622867228682286922870228712287222873228742287522876228772287822879228802288122882228832288422885228862288722888228892289022891228922289322894228952289622897228982289922900229012290222903229042290522906229072290822909229102291122912229132291422915229162291722918229192292022921229222292322924229252292622927229282292922930229312293222933229342293522936229372293822939229402294122942229432294422945229462294722948229492295022951229522295322954229552295622957229582295922960229612296222963229642296522966229672296822969229702297122972229732297422975229762297722978229792298022981229822298322984229852298622987229882298922990229912299222993229942299522996229972299822999230002300123002230032300423005230062300723008230092301023011230122301323014230152301623017230182301923020230212302223023230242302523026230272302823029230302303123032230332303423035230362303723038230392304023041230422304323044230452304623047230482304923050230512305223053230542305523056230572305823059230602306123062230632306423065230662306723068230692307023071230722307323074230752307623077230782307923080230812308223083230842308523086230872308823089230902309123092230932309423095230962309723098230992310023101231022310323104231052310623107231082310923110231112311223113231142311523116231172311823119231202312123122231232312423125231262312723128231292313023131231322313323134231352313623137231382313923140231412314223143231442314523146231472314823149231502315123152231532315423155231562315723158231592316023161231622316323164231652316623167231682316923170231712317223173231742317523176231772317823179231802318123182231832318423185231862318723188231892319023191231922319323194231952319623197231982319923200232012320223203232042320523206232072320823209232102321123212232132321423215232162321723218232192322023221232222322323224232252322623227232282322923230232312323223233232342323523236232372323823239232402324123242232432324423245232462324723248232492325023251232522325323254232552325623257232582325923260232612326223263232642326523266232672326823269232702327123272232732327423275232762327723278232792328023281232822328323284232852328623287232882328923290232912329223293232942329523296232972329823299233002330123302233032330423305233062330723308233092331023311233122331323314233152331623317233182331923320233212332223323233242332523326233272332823329233302333123332233332333423335233362333723338233392334023341233422334323344233452334623347233482334923350233512335223353233542335523356233572335823359233602336123362233632336423365233662336723368233692337023371233722337323374233752337623377233782337923380233812338223383233842338523386233872338823389233902339123392233932339423395233962339723398233992340023401234022340323404234052340623407234082340923410234112341223413234142341523416234172341823419234202342123422234232342423425234262342723428234292343023431234322343323434234352343623437234382343923440234412344223443234442344523446234472344823449234502345123452234532345423455234562345723458234592346023461234622346323464234652346623467234682346923470234712347223473234742347523476234772347823479234802348123482234832348423485234862348723488234892349023491234922349323494234952349623497234982349923500235012350223503235042350523506235072350823509235102351123512235132351423515235162351723518235192352023521235222352323524235252352623527235282352923530235312353223533235342353523536235372353823539235402354123542235432354423545235462354723548235492355023551235522355323554235552355623557235582355923560235612356223563235642356523566235672356823569235702357123572235732357423575235762357723578235792358023581235822358323584235852358623587235882358923590235912359223593235942359523596235972359823599236002360123602236032360423605236062360723608236092361023611236122361323614236152361623617236182361923620236212362223623236242362523626236272362823629236302363123632236332363423635236362363723638236392364023641236422364323644236452364623647236482364923650236512365223653236542365523656236572365823659
  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_SSE_MAX_EVENT_LENGTH
  110. #define CPPHTTPLIB_SSE_MAX_EVENT_LENGTH (16 * 1024 * 1024) // 16MB
  111. #endif
  112. #ifndef CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH
  113. #define CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH 8192
  114. #endif
  115. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH
  116. // 1400 rather than a round number: a body that already fits in one 1500-byte
  117. // MTU gains nothing from being made smaller.
  118. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH 1400
  119. #endif
  120. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH
  121. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH (4 * 1024 * 1024) // 4MB
  122. #endif
  123. #ifndef CPPHTTPLIB_RANGE_MAX_COUNT
  124. #define CPPHTTPLIB_RANGE_MAX_COUNT 1024
  125. #endif
  126. // std::regex_match's backtracking implementation (most acutely on libstdc++)
  127. // recurses roughly once per matched character for quantified patterns such
  128. // as "(.*)", so a long enough path can exhaust the calling thread's stack; on
  129. // a default ~8MB thread stack that has been observed to take on the order of
  130. // a couple thousand characters for a simple pattern. 256 leaves a wide safety
  131. // margin below that (well under the 8192-byte request URI limit) while still
  132. // fitting any realistic route segment; raise it if a route legitimately needs
  133. // longer paths. Regex routes are never applied to paths longer than this.
  134. #ifndef CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH
  135. #define CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH 256
  136. #endif
  137. #ifndef CPPHTTPLIB_TCP_NODELAY
  138. #define CPPHTTPLIB_TCP_NODELAY false
  139. #endif
  140. #ifndef CPPHTTPLIB_IPV6_V6ONLY
  141. #define CPPHTTPLIB_IPV6_V6ONLY false
  142. #endif
  143. #ifndef CPPHTTPLIB_RECV_BUFSIZ
  144. #define CPPHTTPLIB_RECV_BUFSIZ size_t(16384u)
  145. #endif
  146. #ifndef CPPHTTPLIB_SEND_BUFSIZ
  147. #define CPPHTTPLIB_SEND_BUFSIZ size_t(16384u)
  148. #endif
  149. #ifndef CPPHTTPLIB_COMPRESSION_BUFSIZ
  150. #define CPPHTTPLIB_COMPRESSION_BUFSIZ size_t(16384u)
  151. #endif
  152. #ifndef CPPHTTPLIB_THREAD_POOL_COUNT
  153. #define CPPHTTPLIB_THREAD_POOL_COUNT \
  154. ((std::max)(8u, std::thread::hardware_concurrency() > 0 \
  155. ? std::thread::hardware_concurrency() - 1 \
  156. : 0))
  157. #endif
  158. #ifndef CPPHTTPLIB_THREAD_POOL_MAX_COUNT
  159. #define CPPHTTPLIB_THREAD_POOL_MAX_COUNT (CPPHTTPLIB_THREAD_POOL_COUNT * 4)
  160. #endif
  161. #ifndef CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT
  162. #define CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT 3 // seconds
  163. #endif
  164. #ifndef CPPHTTPLIB_RECV_FLAGS
  165. #define CPPHTTPLIB_RECV_FLAGS 0
  166. #endif
  167. #ifndef CPPHTTPLIB_SEND_FLAGS
  168. #define CPPHTTPLIB_SEND_FLAGS 0
  169. #endif
  170. #ifndef CPPHTTPLIB_LISTEN_BACKLOG
  171. #define CPPHTTPLIB_LISTEN_BACKLOG 128
  172. #endif
  173. #ifndef CPPHTTPLIB_MAX_LINE_LENGTH
  174. #define CPPHTTPLIB_MAX_LINE_LENGTH 32768
  175. #endif
  176. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH
  177. #define CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH 16777216
  178. #endif
  179. // One macro used to set the read timeout for both sides. They want different
  180. // defaults: a client's read timeout is the caller's own tool (it waits forever
  181. // until asked not to), while a server keeps a ceiling that reclaims a worker
  182. // from a peer that has gone quiet. The old name still works and sets both.
  183. #ifdef CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  184. #pragma message( \
  185. "CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND is deprecated; define " \
  186. "CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND and/or " \
  187. "CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND instead")
  188. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  189. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND \
  190. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  191. #endif
  192. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  193. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND \
  194. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  195. #endif
  196. #endif
  197. // 0 waits forever. A read timeout is how a caller gets control back to send on
  198. // the same connection; it is not a liveness check (that is ping/pong). Only a
  199. // timeout set at runtime through set_read_timeout() is reported as
  200. // ws::Timeout; when one of these compile-time defaults elapses, read() returns
  201. // ws::Fail and closes the connection.
  202. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  203. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND 0
  204. #endif
  205. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  206. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND 300
  207. #endif
  208. #ifndef CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND
  209. #define CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND 5
  210. #endif
  211. #ifndef CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND
  212. #define CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND 30
  213. #endif
  214. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS
  215. #define CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS 0
  216. #endif
  217. /*
  218. * Headers
  219. */
  220. #ifdef _WIN32
  221. #ifndef _CRT_SECURE_NO_WARNINGS
  222. #define _CRT_SECURE_NO_WARNINGS
  223. #endif //_CRT_SECURE_NO_WARNINGS
  224. #ifndef _CRT_NONSTDC_NO_DEPRECATE
  225. #define _CRT_NONSTDC_NO_DEPRECATE
  226. #endif //_CRT_NONSTDC_NO_DEPRECATE
  227. #if defined(_MSC_VER)
  228. #if _MSC_VER < 1900
  229. #error Sorry, Visual Studio versions prior to 2015 are not supported
  230. #endif
  231. #pragma comment(lib, "ws2_32.lib")
  232. #ifndef _SSIZE_T_DEFINED
  233. using ssize_t = __int64;
  234. #define _SSIZE_T_DEFINED
  235. #endif
  236. #endif // _MSC_VER
  237. #ifndef S_ISREG
  238. #define S_ISREG(m) (((m) & S_IFREG) == S_IFREG)
  239. #endif // S_ISREG
  240. #ifndef S_ISDIR
  241. #define S_ISDIR(m) (((m) & S_IFDIR) == S_IFDIR)
  242. #endif // S_ISDIR
  243. #ifndef NOMINMAX
  244. #define NOMINMAX
  245. #endif // NOMINMAX
  246. #include <io.h>
  247. #include <winsock2.h>
  248. #include <ws2tcpip.h>
  249. #if defined(__has_include)
  250. #if __has_include(<afunix.h>)
  251. // afunix.h uses types declared in winsock2.h, so has to be included after it.
  252. #include <afunix.h>
  253. #define CPPHTTPLIB_HAVE_AFUNIX_H 1
  254. #endif
  255. #endif
  256. #ifndef WSA_FLAG_NO_HANDLE_INHERIT
  257. #define WSA_FLAG_NO_HANDLE_INHERIT 0x80
  258. #endif
  259. using nfds_t = unsigned long;
  260. using socket_t = SOCKET;
  261. using socklen_t = int;
  262. #else // not _WIN32
  263. #include <arpa/inet.h>
  264. #if !defined(_AIX) && !defined(__MVS__)
  265. #include <ifaddrs.h>
  266. #endif
  267. #ifdef __MVS__
  268. #include <strings.h>
  269. #ifndef NI_MAXHOST
  270. #define NI_MAXHOST 1025
  271. #endif
  272. #endif
  273. #include <net/if.h>
  274. #include <netdb.h>
  275. #include <netinet/in.h>
  276. #ifdef __linux__
  277. #include <resolv.h>
  278. #undef _res // Undefine _res macro to avoid conflicts with user code (#2278)
  279. #endif
  280. #include <csignal>
  281. #include <netinet/tcp.h>
  282. #include <poll.h>
  283. #include <pthread.h>
  284. #include <sys/mman.h>
  285. #include <sys/socket.h>
  286. #include <sys/un.h>
  287. #include <unistd.h>
  288. using socket_t = int;
  289. #ifndef INVALID_SOCKET
  290. #define INVALID_SOCKET (-1)
  291. #endif
  292. #endif //_WIN32
  293. #if defined(__APPLE__)
  294. #include <TargetConditionals.h>
  295. #endif
  296. #include <algorithm>
  297. #include <array>
  298. #include <atomic>
  299. #include <cassert>
  300. #include <chrono>
  301. #include <climits>
  302. #include <condition_variable>
  303. #include <cstdlib>
  304. #include <cstring>
  305. #include <errno.h>
  306. #include <exception>
  307. #include <fcntl.h>
  308. #include <fstream>
  309. #include <functional>
  310. #include <iomanip>
  311. #include <iostream>
  312. #include <iterator>
  313. #include <list>
  314. #include <map>
  315. #include <memory>
  316. #include <mutex>
  317. #include <random>
  318. #include <regex>
  319. #include <set>
  320. #include <sstream>
  321. #include <string>
  322. #include <sys/stat.h>
  323. #include <system_error>
  324. #include <thread>
  325. #include <type_traits>
  326. #include <unordered_map>
  327. #include <unordered_set>
  328. #include <utility>
  329. #include <vector>
  330. // On macOS with a TLS backend, enable Keychain root certificates by default
  331. // unless the user explicitly opts out. Not enabled on iOS/tvOS/watchOS since
  332. // the SecTrustSettings APIs used to enumerate anchor certificates are macOS
  333. // only; on those platforms the user must provide a CA bundle explicitly.
  334. #if defined(__APPLE__) && defined(__clang__) && \
  335. !defined(CPPHTTPLIB_DISABLE_MACOSX_AUTOMATIC_ROOT_CERTIFICATES) && \
  336. (defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  337. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || \
  338. defined(CPPHTTPLIB_WOLFSSL_SUPPORT))
  339. #if TARGET_OS_OSX
  340. #ifndef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  341. #define CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  342. #endif
  343. #endif
  344. #endif
  345. #if defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN) && \
  346. defined(__APPLE__) && !TARGET_OS_OSX
  347. #error \
  348. "CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN is only supported on macOS. On iOS/tvOS/watchOS, supply a CA bundle via set_ca_cert_path()."
  349. #endif
  350. // On Windows, enable Schannel certificate verification by default
  351. // unless the user explicitly opts out.
  352. #if defined(_WIN32) && \
  353. !defined(CPPHTTPLIB_DISABLE_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE)
  354. #define CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  355. #endif
  356. #if defined(CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO) || \
  357. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  358. #if TARGET_OS_MAC && defined(__clang__)
  359. #include <CFNetwork/CFHost.h>
  360. #include <CoreFoundation/CoreFoundation.h>
  361. #endif
  362. #endif
  363. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  364. #ifdef _WIN32
  365. #include <wincrypt.h>
  366. // these are defined in wincrypt.h and it breaks compilation if BoringSSL is
  367. // used
  368. #undef X509_NAME
  369. #undef X509_CERT_PAIR
  370. #undef X509_EXTENSIONS
  371. #undef PKCS7_SIGNER_INFO
  372. #ifdef _MSC_VER
  373. #pragma comment(lib, "crypt32.lib")
  374. #endif
  375. #endif // _WIN32
  376. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  377. #if TARGET_OS_OSX
  378. #include <Security/Security.h>
  379. #endif
  380. #endif
  381. #include <openssl/err.h>
  382. #include <openssl/evp.h>
  383. #include <openssl/rand.h>
  384. #include <openssl/ssl.h>
  385. #include <openssl/x509v3.h>
  386. #if defined(_WIN32) && defined(OPENSSL_USE_APPLINK)
  387. #include <openssl/applink.c>
  388. #endif
  389. #include <iostream>
  390. #include <sstream>
  391. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  392. #if OPENSSL_VERSION_NUMBER < 0x1010107f
  393. #error Please use OpenSSL or a current version of BoringSSL
  394. #endif
  395. #define SSL_get1_peer_certificate SSL_get_peer_certificate
  396. #elif OPENSSL_VERSION_NUMBER < 0x30000000L
  397. #error Sorry, OpenSSL versions prior to 3.0.0 are not supported
  398. #endif
  399. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  400. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  401. // version.h defines MBEDTLS_VERSION_MAJOR (on 2.x/3.x/4.x alike); it is pulled
  402. // in with this first include group so the version gating below can use it.
  403. #include <mbedtls/error.h>
  404. #include <mbedtls/net_sockets.h>
  405. #include <mbedtls/oid.h>
  406. #include <mbedtls/pk.h>
  407. #include <mbedtls/ssl.h>
  408. #include <mbedtls/version.h>
  409. #include <mbedtls/x509_crt.h>
  410. #if MBEDTLS_VERSION_MAJOR >= 4
  411. // Mbed TLS 4.x moved hashing/RNG to PSA Crypto and removed these headers.
  412. #include <psa/crypto.h>
  413. #else
  414. #include <mbedtls/ctr_drbg.h>
  415. #include <mbedtls/entropy.h>
  416. #include <mbedtls/md5.h>
  417. #include <mbedtls/sha1.h>
  418. #include <mbedtls/sha256.h>
  419. #include <mbedtls/sha512.h>
  420. #endif
  421. #ifdef _WIN32
  422. #include <wincrypt.h>
  423. #ifdef _MSC_VER
  424. #pragma comment(lib, "crypt32.lib")
  425. #endif
  426. #endif // _WIN32
  427. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  428. #if TARGET_OS_OSX
  429. #include <Security/Security.h>
  430. #endif
  431. #endif
  432. // Mbed TLS version API compatibility. Note: V4 implies V3 (both defined on
  433. // 4.x), so version-specific 3.x-only code must check V3 && !V4.
  434. #if MBEDTLS_VERSION_MAJOR >= 4
  435. #define CPPHTTPLIB_MBEDTLS_V4
  436. #endif
  437. #if MBEDTLS_VERSION_MAJOR >= 3
  438. #define CPPHTTPLIB_MBEDTLS_V3
  439. #endif
  440. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  441. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  442. #include <wolfssl/options.h>
  443. #include <wolfssl/openssl/x509v3.h>
  444. // Fallback definitions for older wolfSSL versions (e.g., 5.6.6)
  445. #ifndef WOLFSSL_GEN_EMAIL
  446. #define WOLFSSL_GEN_EMAIL 1
  447. #endif
  448. #ifndef WOLFSSL_GEN_DNS
  449. #define WOLFSSL_GEN_DNS 2
  450. #endif
  451. #ifndef WOLFSSL_GEN_URI
  452. #define WOLFSSL_GEN_URI 6
  453. #endif
  454. #ifndef WOLFSSL_GEN_IPADD
  455. #define WOLFSSL_GEN_IPADD 7
  456. #endif
  457. #include <wolfssl/ssl.h>
  458. #include <wolfssl/wolfcrypt/hash.h>
  459. #include <wolfssl/wolfcrypt/md5.h>
  460. #include <wolfssl/wolfcrypt/sha256.h>
  461. #include <wolfssl/wolfcrypt/sha512.h>
  462. #ifdef _WIN32
  463. #include <wincrypt.h>
  464. #ifdef _MSC_VER
  465. #pragma comment(lib, "crypt32.lib")
  466. #endif
  467. #endif // _WIN32
  468. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  469. #if TARGET_OS_OSX
  470. #include <Security/Security.h>
  471. #endif
  472. #endif
  473. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  474. // Define CPPHTTPLIB_SSL_ENABLED if any SSL backend is available
  475. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  476. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  477. #define CPPHTTPLIB_SSL_ENABLED
  478. #endif
  479. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  480. #include <zlib.h>
  481. #endif
  482. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  483. #include <brotli/decode.h>
  484. #include <brotli/encode.h>
  485. #endif
  486. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  487. #include <zstd.h>
  488. #endif
  489. /*
  490. * Declaration
  491. */
  492. namespace httplib {
  493. namespace ws {
  494. class WebSocket;
  495. } // namespace ws
  496. namespace detail {
  497. /*
  498. * Backport std::make_unique from C++14.
  499. *
  500. * NOTE: This code came up with the following stackoverflow post:
  501. * https://stackoverflow.com/questions/10149840/c-arrays-and-make-unique
  502. *
  503. */
  504. template <class T, class... Args>
  505. typename std::enable_if<!std::is_array<T>::value, std::unique_ptr<T>>::type
  506. make_unique(Args &&...args) {
  507. return std::unique_ptr<T>(new T(std::forward<Args>(args)...));
  508. }
  509. template <class T>
  510. typename std::enable_if<std::is_array<T>::value, std::unique_ptr<T>>::type
  511. make_unique(std::size_t n) {
  512. typedef typename std::remove_extent<T>::type RT;
  513. return std::unique_ptr<T>(new RT[n]);
  514. }
  515. // Locale-independent ASCII character classification. The <cctype>
  516. // counterparts (std::isalnum, std::isdigit, ...) consult the global C locale,
  517. // so e.g. std::isalnum(0xC5) can return true once an embedder calls
  518. // setlocale(). HTTP grammars are defined over ASCII, so raw bytes must be
  519. // classified without regard to the locale.
  520. inline bool is_ascii_digit(char c) { return '0' <= c && c <= '9'; }
  521. inline bool is_ascii_alpha(char c) {
  522. return ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z');
  523. }
  524. inline bool is_ascii_alnum(char c) {
  525. return is_ascii_digit(c) || is_ascii_alpha(c);
  526. }
  527. namespace case_ignore {
  528. inline unsigned char to_lower(int c) {
  529. const static unsigned char table[256] = {
  530. 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14,
  531. 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29,
  532. 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44,
  533. 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59,
  534. 60, 61, 62, 63, 64, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106,
  535. 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121,
  536. 122, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104,
  537. 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119,
  538. 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134,
  539. 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149,
  540. 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164,
  541. 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179,
  542. 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 224, 225, 226,
  543. 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239, 240, 241,
  544. 242, 243, 244, 245, 246, 215, 248, 249, 250, 251, 252, 253, 254, 223, 224,
  545. 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239,
  546. 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254,
  547. 255,
  548. };
  549. return table[(unsigned char)(char)c];
  550. }
  551. inline std::string to_lower(const std::string &s) {
  552. std::string result = s;
  553. std::transform(
  554. result.begin(), result.end(), result.begin(),
  555. [](unsigned char c) { return static_cast<char>(to_lower(c)); });
  556. return result;
  557. }
  558. inline bool equal(const std::string &a, const std::string &b) {
  559. return a.size() == b.size() &&
  560. std::equal(a.begin(), a.end(), b.begin(), [](char ca, char cb) {
  561. return to_lower(ca) == to_lower(cb);
  562. });
  563. }
  564. // For a literal, without building a std::string from it.
  565. template <size_t N>
  566. inline bool equal(const std::string &a, const char (&b)[N]) {
  567. return a.size() == N - 1 &&
  568. std::equal(a.begin(), a.end(), b, [](char ca, char cb) {
  569. return to_lower(ca) == to_lower(cb);
  570. });
  571. }
  572. struct equal_to {
  573. bool operator()(const std::string &a, const std::string &b) const {
  574. return equal(a, b);
  575. }
  576. };
  577. struct hash {
  578. size_t operator()(const std::string &key) const {
  579. size_t h = 0;
  580. for (auto c : key) {
  581. // Unsets the 6 high bits of h, therefore no overflow happens
  582. h = (((std::numeric_limits<size_t>::max)() >> 6) & h * 33) ^
  583. static_cast<unsigned char>(to_lower(c));
  584. }
  585. return h;
  586. }
  587. };
  588. template <typename T>
  589. using unordered_set = std::unordered_set<T, detail::case_ignore::hash,
  590. detail::case_ignore::equal_to>;
  591. } // namespace case_ignore
  592. // This is based on
  593. // "http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2014/n4189".
  594. struct scope_exit {
  595. explicit scope_exit(std::function<void(void)> &&f)
  596. : exit_function(std::move(f)), execute_on_destruction{true} {}
  597. scope_exit(scope_exit &&rhs) noexcept
  598. : exit_function(std::move(rhs.exit_function)),
  599. execute_on_destruction{rhs.execute_on_destruction} {
  600. rhs.release();
  601. }
  602. ~scope_exit() {
  603. if (execute_on_destruction) { this->exit_function(); }
  604. }
  605. void release() { this->execute_on_destruction = false; }
  606. private:
  607. scope_exit(const scope_exit &) = delete;
  608. void operator=(const scope_exit &) = delete;
  609. scope_exit &operator=(scope_exit &&) = delete;
  610. std::function<void(void)> exit_function;
  611. bool execute_on_destruction;
  612. };
  613. // Simple from_chars implementation for integer and double types (C++17
  614. // substitute)
  615. template <typename T> struct from_chars_result {
  616. const char *ptr;
  617. std::errc ec;
  618. };
  619. template <typename T>
  620. inline from_chars_result<T> from_chars(const char *first, const char *last,
  621. T &value, int base = 10) {
  622. value = 0;
  623. const char *p = first;
  624. bool negative = false;
  625. if (p != last && *p == '-') {
  626. negative = true;
  627. ++p;
  628. }
  629. if (p == last) { return {first, std::errc::invalid_argument}; }
  630. T result = 0;
  631. for (; p != last; ++p) {
  632. char c = *p;
  633. int digit = -1;
  634. if (is_ascii_digit(c)) {
  635. digit = c - '0';
  636. } else if ('a' <= c && c <= 'z') {
  637. digit = c - 'a' + 10;
  638. } else if ('A' <= c && c <= 'Z') {
  639. digit = c - 'A' + 10;
  640. } else {
  641. break;
  642. }
  643. if (digit < 0 || digit >= base) { break; }
  644. if (result > ((std::numeric_limits<T>::max)() - digit) / base) {
  645. return {p, std::errc::result_out_of_range};
  646. }
  647. result = result * base + digit;
  648. }
  649. if (p == first || (negative && p == first + 1)) {
  650. return {first, std::errc::invalid_argument};
  651. }
  652. value = negative ? T(0) - result : result;
  653. return {p, std::errc{}};
  654. }
  655. // from_chars for double (hand-written, locale-independent)
  656. //
  657. // The only double consumed by this library is the HTTP quality value, whose
  658. // grammar is (RFC 9110 12.4.2):
  659. // qvalue = ( "0" [ "." 0*3DIGIT ] ) / ( "1" [ "." 0*3("0") ] )
  660. // i.e. a non-negative decimal with no sign, exponent, "inf"/"nan", or wide
  661. // magnitude. So this parser recognizes exactly 1*DIGIT [ "." *DIGIT ] with
  662. // '.' always the decimal separator (std::strtod would instead read it from the
  663. // global C locale, mis-parsing q-values once an embedder calls
  664. // setlocale(LC_ALL, "") into a comma-decimal locale). The caller range-checks
  665. // the result to [0, 1], so inputs outside that range need not be distinguished
  666. // here. Allocation-free, single pass, and free of the overflow/rounding edge
  667. // cases that exponent and wide-range handling would introduce.
  668. inline from_chars_result<double> from_chars(const char *first, const char *last,
  669. double &value) {
  670. value = 0.0;
  671. const char *p = first;
  672. // Each 1eN is exactly representable, so a single final division by the
  673. // matching entry yields a correctly-rounded result.
  674. static const double powers_of_ten[] = {
  675. 1e0, 1e1, 1e2, 1e3, 1e4, 1e5, 1e6, 1e7, 1e8, 1e9,
  676. 1e10, 1e11, 1e12, 1e13, 1e14, 1e15, 1e16, 1e17, 1e18};
  677. const int max_frac_digits =
  678. static_cast<int>(sizeof(powers_of_ten) / sizeof(powers_of_ten[0])) - 1;
  679. // Accumulate digits into a 64-bit integer and remember how many were
  680. // fractional. Two independent caps keep this bounded and safe:
  681. // * accumulation saturates before mantissa could overflow uint64_t, and
  682. // * frac_digits is capped at max_frac_digits so it is always a valid index
  683. // into powers_of_ten (without this an input like "0.000...0" would never
  684. // grow mantissa, so the saturation cap alone would not bound it).
  685. // Both caps only drop digits far beyond the precision a q-value needs; any
  686. // value they would change is well outside [0, 1] and rejected by the caller.
  687. uint64_t mantissa = 0;
  688. int frac_digits = 0;
  689. bool seen_digit = false;
  690. const uint64_t limit = ((std::numeric_limits<uint64_t>::max)() - 9) / 10;
  691. auto accumulate = [&](char c) {
  692. if (mantissa <= limit) {
  693. mantissa = mantissa * 10 + static_cast<uint64_t>(c - '0');
  694. return true;
  695. }
  696. return false;
  697. };
  698. for (; p != last && is_ascii_digit(*p); ++p) {
  699. seen_digit = true;
  700. accumulate(*p);
  701. }
  702. if (p != last && *p == '.') {
  703. ++p;
  704. for (; p != last && is_ascii_digit(*p); ++p) {
  705. seen_digit = true;
  706. if (frac_digits < max_frac_digits && accumulate(*p)) { ++frac_digits; }
  707. }
  708. }
  709. if (!seen_digit) { return {first, std::errc::invalid_argument}; }
  710. value = static_cast<double>(mantissa) / powers_of_ten[frac_digits];
  711. return {p, std::errc{}};
  712. }
  713. inline bool parse_int_in_range(const char *s, size_t len, int lo, int hi,
  714. int &out) {
  715. int val = 0;
  716. auto r = from_chars(s, s + len, val);
  717. if (r.ec != std::errc{} || r.ptr != s + len || val < lo || val > hi) {
  718. return false;
  719. }
  720. out = val;
  721. return true;
  722. }
  723. inline bool parse_port(const char *s, size_t len, int &port) {
  724. return parse_int_in_range(s, len, 1, 65535, port);
  725. }
  726. inline bool parse_port(const std::string &s, int &port) {
  727. return parse_port(s.data(), s.size(), port);
  728. }
  729. struct UrlComponents {
  730. std::string scheme;
  731. std::string host;
  732. std::string port;
  733. std::string path;
  734. std::string query;
  735. };
  736. inline bool parse_url(const std::string &url, UrlComponents &uc) {
  737. uc = {};
  738. size_t pos = 0;
  739. auto sep = url.find("://");
  740. if (sep != std::string::npos) {
  741. uc.scheme = url.substr(0, sep);
  742. // Scheme must be [a-z]+ only
  743. if (uc.scheme.empty()) { return false; }
  744. for (auto c : uc.scheme) {
  745. if (c < 'a' || c > 'z') { return false; }
  746. }
  747. pos = sep + 3;
  748. } else if (url.compare(0, 2, "//") == 0) {
  749. pos = 2;
  750. }
  751. auto has_authority_prefix = pos > 0;
  752. auto has_authority = has_authority_prefix || (!url.empty() && url[0] != '/' &&
  753. url[0] != '?' && url[0] != '#');
  754. if (has_authority) {
  755. // userinfo is not supported, and a backslash that some parsers take for
  756. // '/' would leave them seeing another host than this one.
  757. if (url.find_first_of("@\\", pos) < url.find_first_of("/?#", pos)) {
  758. return false;
  759. }
  760. if (pos < url.size() && url[pos] == '[') {
  761. auto close = url.find(']', pos);
  762. if (close == std::string::npos) { return false; }
  763. uc.host = url.substr(pos + 1, close - pos - 1);
  764. // IPv6 host must be [a-fA-F0-9:]+ only
  765. if (uc.host.empty()) { return false; }
  766. for (auto c : uc.host) {
  767. if (!(is_ascii_digit(c) || (c >= 'a' && c <= 'f') ||
  768. (c >= 'A' && c <= 'F') || c == ':')) {
  769. return false;
  770. }
  771. }
  772. pos = close + 1;
  773. // The IPv6 literal is the whole host, so ']' must be followed by a port,
  774. // path, query or fragment delimiter (or the end of input). Otherwise the
  775. // trailing bytes would be folded into the path while the connection
  776. // still targets the bracketed address.
  777. if (pos < url.size()) {
  778. auto c = url[pos];
  779. if (c != ':' && c != '/' && c != '?' && c != '#') { return false; }
  780. }
  781. } else {
  782. auto end = url.find_first_of(":/?#", pos);
  783. if (end == std::string::npos) { end = url.size(); }
  784. uc.host = url.substr(pos, end - pos);
  785. pos = end;
  786. }
  787. if (pos < url.size() && url[pos] == ':') {
  788. ++pos;
  789. auto end = url.find_first_of("/?#", pos);
  790. if (end == std::string::npos) { end = url.size(); }
  791. uc.port = url.substr(pos, end - pos);
  792. pos = end;
  793. }
  794. // Without :// or //, the entire input must be consumed as host[:port].
  795. // If there is leftover (path, query, etc.), this is not a valid
  796. // host[:port] string — clear and reparse as a plain path.
  797. if (!has_authority_prefix && pos < url.size()) {
  798. uc.host.clear();
  799. uc.port.clear();
  800. pos = 0;
  801. }
  802. }
  803. if (pos < url.size() && url[pos] != '?' && url[pos] != '#') {
  804. auto end = url.find_first_of("?#", pos);
  805. if (end == std::string::npos) { end = url.size(); }
  806. uc.path = url.substr(pos, end - pos);
  807. pos = end;
  808. }
  809. if (pos < url.size() && url[pos] == '?') {
  810. auto end = url.find('#', pos);
  811. if (end == std::string::npos) { end = url.size(); }
  812. uc.query = url.substr(pos, end - pos);
  813. }
  814. return true;
  815. }
  816. // Resolves a relative-path or query-only Location value against the path of
  817. // the request being redirected (RFC 3986 section 5.2). Absolute URIs and
  818. // references starting with '/' are returned unchanged.
  819. inline std::string resolve_relative_location(const std::string &location,
  820. const std::string &base) {
  821. if (location.empty() || location[0] == '/') { return location; }
  822. // A ':' in the first segment means the value has a scheme.
  823. if (location.find(':') < location.find_first_of("/?#")) { return location; }
  824. if (location[0] == '#') { return base.substr(0, base.find('#')) + location; }
  825. auto base_path = base.substr(0, base.find_first_of("?#"));
  826. if (location[0] == '?') { return base_path + location; }
  827. if (base_path.empty() || base_path[0] != '/') { base_path = "/"; }
  828. auto merged = base_path.substr(0, base_path.rfind('/') + 1) + location;
  829. // Remove "." and ".." segments from the merged path.
  830. auto path_end = (std::min)(merged.find_first_of("?#"), merged.size());
  831. std::string path;
  832. size_t i = 0;
  833. while (i < path_end) {
  834. auto next = (std::min)(merged.find('/', i + 1), path_end);
  835. auto segment = merged.substr(i + 1, next - i - 1);
  836. auto is_last = next == path_end;
  837. if (segment == "." || segment == "..") {
  838. if (segment == "..") {
  839. path.erase((std::min)(path.rfind('/'), path.size()));
  840. }
  841. if (is_last) { path += '/'; }
  842. } else {
  843. path += '/';
  844. path += segment;
  845. }
  846. i = next;
  847. }
  848. if (path.empty()) { path = "/"; }
  849. return path + merged.substr(path_end);
  850. }
  851. } // namespace detail
  852. enum class SSLVerifierResponse {
  853. // no decision has been made, use the built-in certificate verifier
  854. NoDecisionMade,
  855. // connection certificate is verified and accepted
  856. CertificateAccepted,
  857. // connection certificate was processed but is rejected
  858. CertificateRejected
  859. };
  860. // System CA loading policy for SSL clients. Auto (the default) loads system
  861. // CA certs only when no custom CA is configured; enable_system_ca() switches
  862. // to an explicit policy.
  863. enum class SystemCAMode { Auto, Enabled, Disabled };
  864. enum StatusCode {
  865. // Information responses
  866. Continue_100 = 100,
  867. SwitchingProtocol_101 = 101,
  868. Processing_102 = 102,
  869. EarlyHints_103 = 103,
  870. // Successful responses
  871. OK_200 = 200,
  872. Created_201 = 201,
  873. Accepted_202 = 202,
  874. NonAuthoritativeInformation_203 = 203,
  875. NoContent_204 = 204,
  876. ResetContent_205 = 205,
  877. PartialContent_206 = 206,
  878. MultiStatus_207 = 207,
  879. AlreadyReported_208 = 208,
  880. IMUsed_226 = 226,
  881. // Redirection messages
  882. MultipleChoices_300 = 300,
  883. MovedPermanently_301 = 301,
  884. Found_302 = 302,
  885. SeeOther_303 = 303,
  886. NotModified_304 = 304,
  887. UseProxy_305 = 305,
  888. unused_306 = 306,
  889. TemporaryRedirect_307 = 307,
  890. PermanentRedirect_308 = 308,
  891. // Client error responses
  892. BadRequest_400 = 400,
  893. Unauthorized_401 = 401,
  894. PaymentRequired_402 = 402,
  895. Forbidden_403 = 403,
  896. NotFound_404 = 404,
  897. MethodNotAllowed_405 = 405,
  898. NotAcceptable_406 = 406,
  899. ProxyAuthenticationRequired_407 = 407,
  900. RequestTimeout_408 = 408,
  901. Conflict_409 = 409,
  902. Gone_410 = 410,
  903. LengthRequired_411 = 411,
  904. PreconditionFailed_412 = 412,
  905. PayloadTooLarge_413 = 413,
  906. UriTooLong_414 = 414,
  907. UnsupportedMediaType_415 = 415,
  908. RangeNotSatisfiable_416 = 416,
  909. ExpectationFailed_417 = 417,
  910. ImATeapot_418 = 418,
  911. MisdirectedRequest_421 = 421,
  912. UnprocessableContent_422 = 422,
  913. Locked_423 = 423,
  914. FailedDependency_424 = 424,
  915. TooEarly_425 = 425,
  916. UpgradeRequired_426 = 426,
  917. PreconditionRequired_428 = 428,
  918. TooManyRequests_429 = 429,
  919. RequestHeaderFieldsTooLarge_431 = 431,
  920. UnavailableForLegalReasons_451 = 451,
  921. // Server error responses
  922. InternalServerError_500 = 500,
  923. NotImplemented_501 = 501,
  924. BadGateway_502 = 502,
  925. ServiceUnavailable_503 = 503,
  926. GatewayTimeout_504 = 504,
  927. HttpVersionNotSupported_505 = 505,
  928. VariantAlsoNegotiates_506 = 506,
  929. InsufficientStorage_507 = 507,
  930. LoopDetected_508 = 508,
  931. NotExtended_510 = 510,
  932. NetworkAuthenticationRequired_511 = 511,
  933. };
  934. namespace detail {
  935. // A multimap that keeps its entries in the order they were inserted.
  936. //
  937. // HTTP needs that order in two places. RFC 9110 5.3 makes the order of header
  938. // fields sharing a field name significant and forbids a proxy from reordering
  939. // them, and a query string's parameters are meaningful in the order the caller
  940. // wrote them. Neither standard container expresses it: std::unordered_multimap
  941. // gives no ordering guarantee at all for equivalent keys (libstdc++ yields
  942. // reverse insertion order, libc++ insertion order), and std::multimap sorts by
  943. // key, which would drop control data such as Host behind whatever else the
  944. // message carries and alphabetise a query string.
  945. //
  946. // Entries are therefore kept in a flat vector, in order. Lookup is a linear
  947. // scan, which beats hashing for the handful of entries a message carries
  948. // (headers are capped at CPPHTTPLIB_HEADER_MAX_COUNT).
  949. //
  950. // KeyEqual compares keys; it is what makes Headers case-insensitive and
  951. // Params, whose parameter names are case-sensitive, not.
  952. template <typename Mapped, typename KeyEqual> class insertion_ordered_multimap {
  953. public:
  954. using key_type = std::string;
  955. using mapped_type = Mapped;
  956. using value_type = std::pair<std::string, Mapped>;
  957. using size_type = std::size_t;
  958. using difference_type = std::ptrdiff_t;
  959. using reference = value_type &;
  960. using const_reference = const value_type &;
  961. private:
  962. static size_type npos() { return static_cast<size_type>(-1); }
  963. static bool keys_equal(const std::string &a, const std::string &b) {
  964. return KeyEqual()(a, b);
  965. }
  966. // Iterating yields every entry in insertion order, but equal_range() and
  967. // find() have to walk only the entries sharing one key, which are not
  968. // adjacent. Both are the same iterator type: key_idx_ selects between the
  969. // two traversals, and since equality compares only the position, an iterator
  970. // restricted to one key still compares equal to end().
  971. template <typename V> class iterator_t {
  972. public:
  973. using iterator_category = std::bidirectional_iterator_tag;
  974. using value_type = insertion_ordered_multimap::value_type;
  975. using difference_type = insertion_ordered_multimap::difference_type;
  976. using pointer = V *;
  977. using reference = V &;
  978. iterator_t() : data_(nullptr), idx_(0), size_(0), key_idx_(npos()) {}
  979. template <typename U,
  980. typename std::enable_if<std::is_convertible<U *, V *>::value,
  981. int>::type = 0>
  982. iterator_t(const iterator_t<U> &rhs)
  983. : data_(rhs.data_), idx_(rhs.idx_), size_(rhs.size_),
  984. key_idx_(rhs.key_idx_) {}
  985. reference operator*() const { return data_[idx_]; }
  986. pointer operator->() const { return data_ + idx_; }
  987. iterator_t &operator++() {
  988. // Saturating, so that advancing past the last entry of a key stays at
  989. // end() instead of running off the container.
  990. if (idx_ >= size_) { return *this; }
  991. ++idx_;
  992. if (key_idx_ != npos()) {
  993. while (idx_ < size_ && !matches(idx_)) {
  994. ++idx_;
  995. }
  996. }
  997. return *this;
  998. }
  999. iterator_t operator++(int) {
  1000. auto tmp = *this;
  1001. ++*this;
  1002. return tmp;
  1003. }
  1004. iterator_t &operator--() {
  1005. if (idx_ == 0) { return *this; }
  1006. --idx_;
  1007. if (key_idx_ != npos()) {
  1008. while (idx_ > 0 && !matches(idx_)) {
  1009. --idx_;
  1010. }
  1011. }
  1012. return *this;
  1013. }
  1014. iterator_t operator--(int) {
  1015. auto tmp = *this;
  1016. --*this;
  1017. return tmp;
  1018. }
  1019. template <typename U> bool operator==(const iterator_t<U> &rhs) const {
  1020. return idx_ == rhs.idx_;
  1021. }
  1022. template <typename U> bool operator!=(const iterator_t<U> &rhs) const {
  1023. return idx_ != rhs.idx_;
  1024. }
  1025. private:
  1026. friend class insertion_ordered_multimap;
  1027. template <typename> friend class iterator_t;
  1028. iterator_t(V *data, size_type idx, size_type size, size_type key_idx)
  1029. : data_(data), idx_(idx), size_(size), key_idx_(key_idx) {}
  1030. bool matches(size_type i) const {
  1031. return keys_equal(data_[i].first, data_[key_idx_].first);
  1032. }
  1033. V *data_;
  1034. size_type idx_;
  1035. size_type size_;
  1036. size_type key_idx_;
  1037. };
  1038. public:
  1039. using iterator = iterator_t<value_type>;
  1040. using const_iterator = iterator_t<const value_type>;
  1041. insertion_ordered_multimap() = default;
  1042. insertion_ordered_multimap(std::initializer_list<value_type> il)
  1043. : entries_(il) {}
  1044. template <typename InputIt>
  1045. insertion_ordered_multimap(InputIt first, InputIt last)
  1046. : entries_(first, last) {}
  1047. iterator begin() { return make_iter(0, npos()); }
  1048. iterator end() { return make_iter(entries_.size(), npos()); }
  1049. const_iterator begin() const { return make_citer(0, npos()); }
  1050. const_iterator end() const { return make_citer(entries_.size(), npos()); }
  1051. const_iterator cbegin() const { return begin(); }
  1052. const_iterator cend() const { return end(); }
  1053. bool empty() const { return entries_.empty(); }
  1054. size_type size() const { return entries_.size(); }
  1055. void clear() { entries_.clear(); }
  1056. void swap(insertion_ordered_multimap &rhs) { entries_.swap(rhs.entries_); }
  1057. iterator insert(const value_type &val) {
  1058. entries_.push_back(val);
  1059. return make_iter(entries_.size() - 1, npos());
  1060. }
  1061. iterator insert(value_type &&val) {
  1062. entries_.push_back(std::move(val));
  1063. return make_iter(entries_.size() - 1, npos());
  1064. }
  1065. template <typename... Args> iterator emplace(Args &&...args) {
  1066. entries_.emplace_back(std::forward<Args>(args)...);
  1067. return make_iter(entries_.size() - 1, npos());
  1068. }
  1069. // For entries that have to lead the message, such as the Host header field
  1070. // (RFC 9110 5.3 recommends sending control data first).
  1071. template <typename... Args> iterator emplace_front(Args &&...args) {
  1072. entries_.emplace(entries_.begin(), std::forward<Args>(args)...);
  1073. return make_iter(0, npos());
  1074. }
  1075. iterator find(const std::string &key) {
  1076. auto i = index_of(key);
  1077. return i == npos() ? end() : make_iter(i, i);
  1078. }
  1079. const_iterator find(const std::string &key) const {
  1080. auto i = index_of(key);
  1081. return i == npos() ? end() : make_citer(i, i);
  1082. }
  1083. size_type count(const std::string &key) const {
  1084. size_type n = 0;
  1085. for (const auto &entry : entries_) {
  1086. if (keys_equal(entry.first, key)) { n++; }
  1087. }
  1088. return n;
  1089. }
  1090. std::pair<iterator, iterator> equal_range(const std::string &key) {
  1091. auto i = index_of(key);
  1092. return i == npos() ? std::make_pair(end(), end())
  1093. : std::make_pair(make_iter(i, i), end());
  1094. }
  1095. std::pair<const_iterator, const_iterator>
  1096. equal_range(const std::string &key) const {
  1097. auto i = index_of(key);
  1098. return i == npos() ? std::make_pair(end(), end())
  1099. : std::make_pair(make_citer(i, i), end());
  1100. }
  1101. size_type erase(const std::string &key) {
  1102. auto before = entries_.size();
  1103. entries_.erase(std::remove_if(entries_.begin(), entries_.end(),
  1104. [&](const value_type &entry) {
  1105. return keys_equal(entry.first, key);
  1106. }),
  1107. entries_.end());
  1108. return before - entries_.size();
  1109. }
  1110. iterator erase(const_iterator pos) {
  1111. entries_.erase(entries_.begin() + static_cast<difference_type>(pos.idx_));
  1112. return make_iter(pos.idx_, npos());
  1113. }
  1114. // Erases what iterating [first, last) would actually visit, so erasing an
  1115. // equal_range() removes only the entries with that key, not everything
  1116. // positioned between them.
  1117. iterator erase(const_iterator first, const_iterator last) {
  1118. auto from = first.idx_;
  1119. auto to = last.idx_;
  1120. if (from >= to) { return make_iter(from, npos()); }
  1121. auto begin_it = entries_.begin();
  1122. auto from_it = begin_it + static_cast<difference_type>(from);
  1123. auto to_it = begin_it + static_cast<difference_type>(to);
  1124. if (first.key_idx_ == npos()) {
  1125. entries_.erase(from_it, to_it);
  1126. } else {
  1127. auto key = entries_[first.key_idx_].first;
  1128. auto keep = from_it;
  1129. for (auto it = from_it; it != to_it; ++it) {
  1130. if (!keys_equal(it->first, key)) {
  1131. if (keep != it) { *keep = std::move(*it); }
  1132. ++keep;
  1133. }
  1134. }
  1135. if (keep != to_it) {
  1136. keep = std::move(to_it, entries_.end(), keep);
  1137. } else {
  1138. keep = entries_.end();
  1139. }
  1140. entries_.erase(keep, entries_.end());
  1141. }
  1142. return make_iter(from, npos());
  1143. }
  1144. friend bool operator==(const insertion_ordered_multimap &lhs,
  1145. const insertion_ordered_multimap &rhs) {
  1146. return lhs.entries_ == rhs.entries_;
  1147. }
  1148. friend bool operator!=(const insertion_ordered_multimap &lhs,
  1149. const insertion_ordered_multimap &rhs) {
  1150. return !(lhs == rhs);
  1151. }
  1152. private:
  1153. size_type index_of(const std::string &key) const {
  1154. for (size_type i = 0; i < entries_.size(); i++) {
  1155. if (keys_equal(entries_[i].first, key)) { return i; }
  1156. }
  1157. return npos();
  1158. }
  1159. iterator make_iter(size_type idx, size_type key_idx) {
  1160. return iterator(entries_.data(), idx, entries_.size(), key_idx);
  1161. }
  1162. const_iterator make_citer(size_type idx, size_type key_idx) const {
  1163. return const_iterator(entries_.data(), idx, entries_.size(), key_idx);
  1164. }
  1165. std::vector<value_type> entries_;
  1166. };
  1167. } // namespace detail
  1168. using Headers =
  1169. detail::insertion_ordered_multimap<std::string,
  1170. detail::case_ignore::equal_to>;
  1171. // Query parameter names are case-sensitive, unlike header field names.
  1172. using Params =
  1173. detail::insertion_ordered_multimap<std::string, std::equal_to<std::string>>;
  1174. using Match = std::smatch;
  1175. using DownloadProgress = std::function<bool(size_t current, size_t total)>;
  1176. using UploadProgress = std::function<bool(size_t current, size_t total)>;
  1177. /*
  1178. * detail: type-erased storage used by UserData.
  1179. * ABI-stable regardless of C++ standard — always uses this custom
  1180. * implementation instead of std::any.
  1181. */
  1182. namespace detail {
  1183. using any_type_id = const void *;
  1184. template <typename T> any_type_id any_typeid() noexcept {
  1185. static const char id = 0;
  1186. return &id;
  1187. }
  1188. struct any_storage {
  1189. virtual ~any_storage() = default;
  1190. virtual std::unique_ptr<any_storage> clone() const = 0;
  1191. virtual any_type_id type_id() const noexcept = 0;
  1192. };
  1193. template <typename T> struct any_value final : any_storage {
  1194. T value;
  1195. template <typename U> explicit any_value(U &&v) : value(std::forward<U>(v)) {}
  1196. std::unique_ptr<any_storage> clone() const override {
  1197. return std::unique_ptr<any_storage>(new any_value<T>(value));
  1198. }
  1199. any_type_id type_id() const noexcept override { return any_typeid<T>(); }
  1200. };
  1201. } // namespace detail
  1202. class UserData {
  1203. public:
  1204. UserData() = default;
  1205. UserData(UserData &&) noexcept = default;
  1206. UserData &operator=(UserData &&) noexcept = default;
  1207. UserData(const UserData &o) {
  1208. for (const auto &e : o.entries_) {
  1209. if (e.second) { entries_[e.first] = e.second->clone(); }
  1210. }
  1211. }
  1212. UserData &operator=(const UserData &o) {
  1213. if (this != &o) {
  1214. entries_.clear();
  1215. for (const auto &e : o.entries_) {
  1216. if (e.second) { entries_[e.first] = e.second->clone(); }
  1217. }
  1218. }
  1219. return *this;
  1220. }
  1221. template <typename T> void set(const std::string &key, T &&value) {
  1222. using D = typename std::decay<T>::type;
  1223. entries_[key].reset(new detail::any_value<D>(std::forward<T>(value)));
  1224. }
  1225. template <typename T> T *get(const std::string &key) noexcept {
  1226. auto it = entries_.find(key);
  1227. if (it == entries_.end() || !it->second) { return nullptr; }
  1228. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1229. return &static_cast<detail::any_value<T> *>(it->second.get())->value;
  1230. }
  1231. template <typename T> const T *get(const std::string &key) const noexcept {
  1232. auto it = entries_.find(key);
  1233. if (it == entries_.end() || !it->second) { return nullptr; }
  1234. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1235. return &static_cast<const detail::any_value<T> *>(it->second.get())->value;
  1236. }
  1237. bool has(const std::string &key) const noexcept {
  1238. return entries_.find(key) != entries_.end();
  1239. }
  1240. void erase(const std::string &key) { entries_.erase(key); }
  1241. void clear() noexcept { entries_.clear(); }
  1242. private:
  1243. std::unordered_map<std::string, std::unique_ptr<detail::any_storage>>
  1244. entries_;
  1245. };
  1246. struct Response;
  1247. using ResponseHandler = std::function<bool(const Response &response)>;
  1248. struct FormData {
  1249. std::string name;
  1250. std::string content;
  1251. std::string filename;
  1252. std::string content_type;
  1253. Headers headers;
  1254. };
  1255. struct FormField {
  1256. std::string name;
  1257. std::string content;
  1258. Headers headers;
  1259. };
  1260. // RFC 7578 5.2: a form processor "SHOULD send back results in order" and
  1261. // "Intermediaries MUST NOT reorder the results", so a handler walking these
  1262. // should see the parts as they were sent. A std::multimap sorts by field name
  1263. // and loses that. Field names are case-sensitive, hence std::equal_to rather
  1264. // than the case-insensitive predicate Headers uses.
  1265. using FormFields =
  1266. detail::insertion_ordered_multimap<FormField, std::equal_to<std::string>>;
  1267. using FormFiles =
  1268. detail::insertion_ordered_multimap<FormData, std::equal_to<std::string>>;
  1269. struct MultipartFormData {
  1270. FormFields fields; // Text fields from multipart
  1271. FormFiles files; // Files from multipart
  1272. // Text field access
  1273. std::string get_field(const std::string &key, size_t id = 0) const;
  1274. std::vector<std::string> get_fields(const std::string &key) const;
  1275. bool has_field(const std::string &key) const;
  1276. size_t get_field_count(const std::string &key) const;
  1277. // File access
  1278. FormData get_file(const std::string &key, size_t id = 0) const;
  1279. std::vector<FormData> get_files(const std::string &key) const;
  1280. bool has_file(const std::string &key) const;
  1281. size_t get_file_count(const std::string &key) const;
  1282. };
  1283. struct UploadFormData {
  1284. std::string name;
  1285. std::string content;
  1286. std::string filename;
  1287. std::string content_type;
  1288. };
  1289. using UploadFormDataItems = std::vector<UploadFormData>;
  1290. class DataSink {
  1291. public:
  1292. DataSink() : os(&sb_), sb_(*this) {}
  1293. DataSink(const DataSink &) = delete;
  1294. DataSink &operator=(const DataSink &) = delete;
  1295. DataSink(DataSink &&) = delete;
  1296. DataSink &operator=(DataSink &&) = delete;
  1297. std::function<bool(const char *data, size_t data_len)> write;
  1298. // Only `write` is mandatory. The rest are defaulted so that a provider
  1299. // calling one on a writer that does not set it gets sensible behaviour
  1300. // rather than std::bad_function_call thrown from a worker thread. Capturing
  1301. // `this` is safe: DataSink is neither copyable nor movable.
  1302. std::function<bool()> is_writable = []() { return true; };
  1303. std::function<void()> done = []() {};
  1304. std::function<void(const Headers &trailer)> done_with_trailer =
  1305. [this](const Headers & /*trailer*/) { done(); };
  1306. std::ostream os;
  1307. private:
  1308. class data_sink_streambuf final : public std::streambuf {
  1309. public:
  1310. explicit data_sink_streambuf(DataSink &sink) : sink_(sink) {}
  1311. protected:
  1312. std::streamsize xsputn(const char *s, std::streamsize n) override {
  1313. if (sink_.write(s, static_cast<size_t>(n))) { return n; }
  1314. return 0;
  1315. }
  1316. private:
  1317. DataSink &sink_;
  1318. };
  1319. data_sink_streambuf sb_;
  1320. };
  1321. using ContentProvider =
  1322. std::function<bool(size_t offset, size_t length, DataSink &sink)>;
  1323. using ContentProviderWithoutLength =
  1324. std::function<bool(size_t offset, DataSink &sink)>;
  1325. using ContentProviderResourceReleaser = std::function<void(bool success)>;
  1326. struct FormDataProvider {
  1327. std::string name;
  1328. ContentProviderWithoutLength provider;
  1329. std::string filename;
  1330. std::string content_type;
  1331. };
  1332. using FormDataProviderItems = std::vector<FormDataProvider>;
  1333. inline FormDataProvider
  1334. make_file_provider(const std::string &name, const std::string &filepath,
  1335. const std::string &filename = std::string(),
  1336. const std::string &content_type = std::string()) {
  1337. FormDataProvider fdp;
  1338. fdp.name = name;
  1339. fdp.filename = filename.empty() ? filepath : filename;
  1340. fdp.content_type = content_type;
  1341. fdp.provider = [filepath](size_t offset, DataSink &sink) -> bool {
  1342. std::ifstream f(filepath, std::ios::binary);
  1343. if (!f) { return false; }
  1344. if (offset > 0) {
  1345. f.seekg(static_cast<std::streamoff>(offset));
  1346. if (!f.good()) {
  1347. sink.done();
  1348. return true;
  1349. }
  1350. }
  1351. char buf[8192];
  1352. f.read(buf, sizeof(buf));
  1353. auto n = static_cast<size_t>(f.gcount());
  1354. if (n > 0) { return sink.write(buf, n); }
  1355. sink.done(); // EOF
  1356. return true;
  1357. };
  1358. return fdp;
  1359. }
  1360. inline std::pair<size_t, ContentProvider>
  1361. make_file_body(const std::string &filepath) {
  1362. size_t size = 0;
  1363. {
  1364. std::ifstream f(filepath, std::ios::binary | std::ios::ate);
  1365. if (!f) { return {0, ContentProvider{}}; }
  1366. size = static_cast<size_t>(f.tellg());
  1367. }
  1368. ContentProvider provider = [filepath](size_t offset, size_t length,
  1369. DataSink &sink) -> bool {
  1370. std::ifstream f(filepath, std::ios::binary);
  1371. if (!f) { return false; }
  1372. f.seekg(static_cast<std::streamoff>(offset));
  1373. if (!f.good()) { return false; }
  1374. char buf[8192];
  1375. while (length > 0) {
  1376. auto to_read = (std::min)(sizeof(buf), length);
  1377. f.read(buf, static_cast<std::streamsize>(to_read));
  1378. auto n = static_cast<size_t>(f.gcount());
  1379. // The file is shorter than the size make_file_body() measured, which the
  1380. // caller has already committed to as Content-Length. The body cannot be
  1381. // completed, so fail as every other error here does.
  1382. if (n == 0) { return false; }
  1383. if (!sink.write(buf, n)) { return false; }
  1384. length -= n;
  1385. }
  1386. return true;
  1387. };
  1388. return {size, std::move(provider)};
  1389. }
  1390. using ContentReceiverWithProgress = std::function<bool(
  1391. const char *data, size_t data_length, size_t offset, size_t total_length)>;
  1392. using ContentReceiver =
  1393. std::function<bool(const char *data, size_t data_length)>;
  1394. using FormDataHeader = std::function<bool(const FormData &file)>;
  1395. class ContentReader {
  1396. public:
  1397. using Reader = std::function<bool(ContentReceiver receiver)>;
  1398. using FormDataReader =
  1399. std::function<bool(FormDataHeader header, ContentReceiver receiver)>;
  1400. ContentReader(Reader reader, FormDataReader multipart_reader)
  1401. : reader_(std::move(reader)),
  1402. formdata_reader_(std::move(multipart_reader)) {}
  1403. bool operator()(FormDataHeader header, ContentReceiver receiver) const {
  1404. return formdata_reader_(std::move(header), std::move(receiver));
  1405. }
  1406. bool operator()(ContentReceiver receiver) const {
  1407. return reader_(std::move(receiver));
  1408. }
  1409. Reader reader_;
  1410. FormDataReader formdata_reader_;
  1411. };
  1412. using Range = std::pair<ssize_t, ssize_t>;
  1413. using Ranges = std::vector<Range>;
  1414. #ifdef CPPHTTPLIB_SSL_ENABLED
  1415. // TLS abstraction layer - public type definitions and API
  1416. namespace tls {
  1417. // Opaque handles (defined as void* for abstraction)
  1418. using ctx_t = void *;
  1419. using session_t = void *;
  1420. using const_session_t = const void *; // For read-only session access
  1421. using cert_t = void *;
  1422. using ca_store_t = void *;
  1423. // TLS versions
  1424. enum class Version {
  1425. TLS1_2 = 0x0303,
  1426. TLS1_3 = 0x0304,
  1427. };
  1428. // Subject Alternative Names (SAN) entry types
  1429. enum class SanType { DNS, IP, EMAIL, URI, OTHER };
  1430. // SAN entry structure
  1431. struct SanEntry {
  1432. SanType type;
  1433. std::string value;
  1434. };
  1435. // Verification context for certificate verification callback
  1436. struct VerifyContext {
  1437. session_t session; // TLS session handle
  1438. cert_t cert; // Current certificate being verified
  1439. int depth; // Certificate chain depth (0 = leaf)
  1440. bool preverify_ok; // OpenSSL/Mbed TLS pre-verification result
  1441. long error_code; // Backend-specific error code (0 = no error)
  1442. const char *error_string; // Human-readable error description
  1443. // Certificate introspection methods
  1444. std::string subject_cn() const;
  1445. std::string issuer_name() const;
  1446. bool check_hostname(const char *hostname) const;
  1447. std::vector<SanEntry> sans() const;
  1448. bool validity(time_t &not_before, time_t &not_after) const;
  1449. std::string serial() const;
  1450. };
  1451. using VerifyCallback = std::function<bool(const VerifyContext &ctx)>;
  1452. // TlsError codes for TLS operations (backend-independent)
  1453. enum class ErrorCode : int {
  1454. Success = 0,
  1455. WantRead, // Non-blocking: need to wait for read
  1456. WantWrite, // Non-blocking: need to wait for write
  1457. PeerClosed, // Peer closed the connection
  1458. Fatal, // Unrecoverable error
  1459. SyscallError, // System call error (check sys_errno)
  1460. CertVerifyFailed, // Certificate verification failed
  1461. HostnameMismatch, // Hostname verification failed
  1462. };
  1463. // TLS error information
  1464. struct TlsError {
  1465. ErrorCode code = ErrorCode::Fatal;
  1466. uint64_t backend_code = 0; // OpenSSL: ERR_get_error(), mbedTLS: return value
  1467. int sys_errno = 0; // errno when SyscallError
  1468. // Convert verification error code to human-readable string
  1469. static std::string verify_error_to_string(long error_code);
  1470. };
  1471. // RAII wrapper for peer certificate
  1472. class PeerCert {
  1473. public:
  1474. PeerCert();
  1475. PeerCert(PeerCert &&other) noexcept;
  1476. PeerCert &operator=(PeerCert &&other) noexcept;
  1477. ~PeerCert();
  1478. PeerCert(const PeerCert &) = delete;
  1479. PeerCert &operator=(const PeerCert &) = delete;
  1480. explicit operator bool() const;
  1481. std::string subject_cn() const;
  1482. std::string issuer_name() const;
  1483. bool check_hostname(const char *hostname) const;
  1484. std::vector<SanEntry> sans() const;
  1485. bool validity(time_t &not_before, time_t &not_after) const;
  1486. std::string serial() const;
  1487. private:
  1488. explicit PeerCert(cert_t cert);
  1489. cert_t cert_ = nullptr;
  1490. friend PeerCert get_peer_cert_from_session(const_session_t session);
  1491. };
  1492. // Callback for TLS context setup (used by SSLServer constructor)
  1493. using ContextSetupCallback = std::function<bool(ctx_t ctx)>;
  1494. } // namespace tls
  1495. #endif
  1496. struct Request {
  1497. std::string method;
  1498. std::string path;
  1499. std::string matched_route;
  1500. Params params;
  1501. Headers headers;
  1502. Headers trailers;
  1503. std::string body;
  1504. std::string remote_addr;
  1505. int remote_port = -1;
  1506. std::string local_addr;
  1507. int local_port = -1;
  1508. // for server
  1509. std::string version;
  1510. std::string target;
  1511. MultipartFormData form;
  1512. Ranges ranges;
  1513. Match matches;
  1514. std::unordered_map<std::string, std::string> path_params;
  1515. std::function<bool()> is_connection_closed = []() { return true; };
  1516. // for client
  1517. std::vector<std::string> accept_content_types;
  1518. ResponseHandler response_handler;
  1519. ContentReceiverWithProgress content_receiver;
  1520. DownloadProgress download_progress;
  1521. UploadProgress upload_progress;
  1522. bool has_header(const std::string &key) const;
  1523. std::string get_header_value(const std::string &key, const char *def = "",
  1524. size_t id = 0) const;
  1525. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1526. size_t id = 0) const;
  1527. size_t get_header_value_count(const std::string &key) const;
  1528. void set_header(const std::string &key, const std::string &val);
  1529. bool has_trailer(const std::string &key) const;
  1530. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1531. size_t get_trailer_value_count(const std::string &key) const;
  1532. bool has_param(const std::string &key) const;
  1533. std::string get_param_value(const std::string &key, size_t id = 0) const;
  1534. std::vector<std::string> get_param_values(const std::string &key) const;
  1535. size_t get_param_value_count(const std::string &key) const;
  1536. bool is_multipart_form_data() const;
  1537. // private members...
  1538. bool body_read_started_ = false;
  1539. bool body_consumed_ = false;
  1540. bool expect_100_continue_pending_ = false;
  1541. size_t redirect_count_ = CPPHTTPLIB_REDIRECT_MAX_COUNT;
  1542. size_t content_length_ = 0;
  1543. ContentProvider content_provider_;
  1544. bool is_chunked_content_provider_ = false;
  1545. size_t authorization_count_ = 0;
  1546. std::chrono::time_point<std::chrono::steady_clock> start_time_ =
  1547. (std::chrono::steady_clock::time_point::min)();
  1548. #ifdef CPPHTTPLIB_SSL_ENABLED
  1549. tls::const_session_t ssl = nullptr;
  1550. tls::PeerCert peer_cert() const;
  1551. std::string sni() const;
  1552. #endif
  1553. };
  1554. namespace detail {
  1555. // Declared up here, away from the rest of the compression helpers, because
  1556. // `Response` stores one.
  1557. enum class EncodingType { None = 0, Gzip, Brotli, Zstd };
  1558. } // namespace detail
  1559. struct Response {
  1560. std::string version;
  1561. int status = -1;
  1562. std::string reason;
  1563. Headers headers;
  1564. Headers trailers;
  1565. std::string body;
  1566. std::string location; // Redirect location
  1567. // User-defined context — set by pre-routing/pre-request handlers and read
  1568. // by route handlers to pass arbitrary data (e.g. decoded auth tokens).
  1569. UserData user_data;
  1570. bool has_header(const std::string &key) const;
  1571. std::string get_header_value(const std::string &key, const char *def = "",
  1572. size_t id = 0) const;
  1573. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1574. size_t id = 0) const;
  1575. size_t get_header_value_count(const std::string &key) const;
  1576. void set_header(const std::string &key, const std::string &val);
  1577. bool has_trailer(const std::string &key) const;
  1578. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1579. size_t get_trailer_value_count(const std::string &key) const;
  1580. void set_redirect(const std::string &url, int status = StatusCode::Found_302);
  1581. void set_content(const char *s, size_t n, const std::string &content_type);
  1582. void set_content(const std::string &s, const std::string &content_type);
  1583. void set_content(std::string &&s, const std::string &content_type);
  1584. void set_content_provider(
  1585. size_t length, const std::string &content_type, ContentProvider provider,
  1586. ContentProviderResourceReleaser resource_releaser = nullptr);
  1587. void set_content_provider(
  1588. const std::string &content_type, ContentProviderWithoutLength provider,
  1589. ContentProviderResourceReleaser resource_releaser = nullptr);
  1590. void set_chunked_content_provider(
  1591. const std::string &content_type, ContentProviderWithoutLength provider,
  1592. ContentProviderResourceReleaser resource_releaser = nullptr);
  1593. void set_file_content(const std::string &path,
  1594. const std::string &content_type);
  1595. void set_file_content(const std::string &path);
  1596. Response() = default;
  1597. Response(const Response &) = default;
  1598. Response &operator=(const Response &) = default;
  1599. Response(Response &&) = default;
  1600. Response &operator=(Response &&) = default;
  1601. ~Response() {
  1602. if (content_provider_resource_releaser_) {
  1603. content_provider_resource_releaser_(content_provider_success_);
  1604. }
  1605. }
  1606. // private members...
  1607. size_t content_length_ = 0;
  1608. ContentProvider content_provider_;
  1609. ContentProviderResourceReleaser content_provider_resource_releaser_;
  1610. bool is_chunked_content_provider_ = false;
  1611. bool is_file_content_provider_ = false;
  1612. bool content_provider_success_ = false;
  1613. std::string file_content_path_;
  1614. std::string file_content_content_type_;
  1615. // Content coding chosen for the response body, decided once so that the
  1616. // headers and the body cannot disagree: where the file is opened for a
  1617. // file-backed content provider (keeping the ETag honest), and in
  1618. // `apply_ranges()` for a chunked content provider. `EncodingType::None`
  1619. // for every other kind of response.
  1620. detail::EncodingType content_coding_ = detail::EncodingType::None;
  1621. };
  1622. enum class Error {
  1623. Success = 0,
  1624. Unknown,
  1625. Connection,
  1626. BindIPAddress,
  1627. Read,
  1628. Write,
  1629. ExceedRedirectCount,
  1630. Canceled,
  1631. SSLConnection,
  1632. SSLLoadingCerts,
  1633. SSLServerVerification,
  1634. SSLServerHostnameVerification,
  1635. UnsupportedMultipartBoundaryChars,
  1636. Compression,
  1637. ConnectionTimeout,
  1638. ProxyConnection,
  1639. ConnectionClosed,
  1640. Timeout,
  1641. ResourceExhaustion,
  1642. TooManyFormDataFiles,
  1643. ExceedMaxPayloadSize,
  1644. ExceedUriMaxLength,
  1645. ExceedMaxSocketDescriptorCount,
  1646. InvalidRequestLine,
  1647. InvalidHTTPMethod,
  1648. InvalidHTTPVersion,
  1649. InvalidHeaders,
  1650. MultipartParsing,
  1651. OpenFile,
  1652. Listen,
  1653. GetSockName,
  1654. UnsupportedAddressFamily,
  1655. HTTPParsing,
  1656. InvalidRangeHeader,
  1657. UnsupportedContentEncoding,
  1658. WebSocketHandshake,
  1659. UserCallbackException,
  1660. // For internal use only
  1661. SSLPeerCouldBeClosed_,
  1662. };
  1663. std::string to_string(Error error);
  1664. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1665. class Stream {
  1666. public:
  1667. virtual ~Stream() = default;
  1668. virtual bool is_readable() const = 0;
  1669. virtual bool wait_readable() const = 0;
  1670. virtual bool wait_writable() const = 0;
  1671. virtual bool is_peer_alive() const { return wait_writable(); }
  1672. virtual ssize_t read(char *ptr, size_t size) = 0;
  1673. virtual ssize_t write(const char *ptr, size_t size) = 0;
  1674. virtual void get_remote_ip_and_port(std::string &ip, int &port) const = 0;
  1675. virtual void get_local_ip_and_port(std::string &ip, int &port) const = 0;
  1676. virtual socket_t socket() const = 0;
  1677. virtual time_t duration() const = 0;
  1678. virtual void set_read_timeout(time_t sec, time_t usec = 0) {
  1679. (void)sec;
  1680. (void)usec;
  1681. }
  1682. // Bounds the reads from now on to `msec` in total, on top of the timeout of
  1683. // each one. 0 lifts the bound.
  1684. virtual void set_max_timeout(time_t msec) { (void)msec; }
  1685. // Bytes already pulled off the socket and sitting in this stream's own
  1686. // buffer. Exposing them lets a line reader scan for a terminator in one
  1687. // pass instead of asking for a byte at a time. A stream that does no
  1688. // buffering of its own reports none, and readers fall back to read().
  1689. virtual const char *buffered_data(size_t &size) const {
  1690. size = 0;
  1691. return nullptr;
  1692. }
  1693. // Discards `size` bytes previously returned by buffered_data().
  1694. virtual void consume_buffered(size_t size) { (void)size; }
  1695. ssize_t write(const char *ptr);
  1696. ssize_t write(const std::string &s);
  1697. Error get_error() const { return error_; }
  1698. protected:
  1699. Error error_ = Error::Success;
  1700. };
  1701. class TaskQueue {
  1702. public:
  1703. TaskQueue() = default;
  1704. virtual ~TaskQueue() = default;
  1705. virtual bool enqueue(std::function<void()> fn) = 0;
  1706. virtual void shutdown() = 0;
  1707. virtual void on_idle() {}
  1708. };
  1709. class ThreadPool final : public TaskQueue {
  1710. public:
  1711. explicit ThreadPool(
  1712. size_t n, size_t max_n = 0, size_t mqr = 0,
  1713. time_t idle_timeout_sec = CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT);
  1714. ThreadPool(const ThreadPool &) = delete;
  1715. ~ThreadPool() override = default;
  1716. bool enqueue(std::function<void()> fn) override;
  1717. void shutdown() override;
  1718. private:
  1719. void worker(bool is_dynamic);
  1720. void move_to_finished(std::thread::id id);
  1721. void cleanup_finished_threads();
  1722. size_t base_thread_count_;
  1723. size_t max_thread_count_;
  1724. size_t max_queued_requests_;
  1725. time_t idle_timeout_sec_;
  1726. size_t idle_thread_count_;
  1727. bool shutdown_;
  1728. std::list<std::function<void()>> jobs_;
  1729. std::vector<std::thread> threads_; // base threads
  1730. std::list<std::thread> dynamic_threads_; // dynamic threads
  1731. std::vector<std::thread>
  1732. finished_threads_; // exited dynamic threads awaiting join
  1733. std::condition_variable cond_;
  1734. std::mutex mutex_;
  1735. };
  1736. using Logger = std::function<void(const Request &, const Response &)>;
  1737. // Forward declaration for Error type
  1738. enum class Error;
  1739. using ErrorLogger = std::function<void(const Error &, const Request *)>;
  1740. using SocketOptions = std::function<void(socket_t sock)>;
  1741. void default_socket_options(socket_t sock);
  1742. bool set_socket_opt(socket_t sock, int level, int optname, int optval);
  1743. const char *status_message(int status);
  1744. std::string to_string(Error error);
  1745. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1746. std::string get_bearer_token_auth(const Request &req);
  1747. namespace detail {
  1748. class MatcherBase {
  1749. public:
  1750. MatcherBase(std::string pattern) : pattern_(std::move(pattern)) {}
  1751. virtual ~MatcherBase() = default;
  1752. const std::string &pattern() const { return pattern_; }
  1753. // Match request path and populate its matches and
  1754. virtual bool match(Request &request) const = 0;
  1755. private:
  1756. std::string pattern_;
  1757. };
  1758. /**
  1759. * Captures parameters in request path and stores them in Request::path_params
  1760. *
  1761. * Capture name is a substring of a pattern from : to /.
  1762. * The rest of the pattern is matched against the request path directly
  1763. * Parameters are captured starting from the next character after
  1764. * the end of the last matched static pattern fragment until the next /.
  1765. *
  1766. * Example pattern:
  1767. * "/path/fragments/:capture/more/fragments/:second_capture"
  1768. * Static fragments:
  1769. * "/path/fragments/", "more/fragments/"
  1770. *
  1771. * Given the following request path:
  1772. * "/path/fragments/:1/more/fragments/:2"
  1773. * the resulting capture will be
  1774. * {{"capture", "1"}, {"second_capture", "2"}}
  1775. */
  1776. class PathParamsMatcher final : public MatcherBase {
  1777. public:
  1778. PathParamsMatcher(const std::string &pattern);
  1779. bool match(Request &request) const override;
  1780. private:
  1781. // Treat segment separators as the end of path parameter capture
  1782. // Does not need to handle query parameters as they are parsed before path
  1783. // matching
  1784. static constexpr char separator = '/';
  1785. // Contains static path fragments to match against, excluding the '/' after
  1786. // path params
  1787. // Fragments are separated by path params
  1788. std::vector<std::string> static_fragments_;
  1789. // Stores the names of the path parameters to be used as keys in the
  1790. // Request::path_params map
  1791. std::vector<std::string> param_names_;
  1792. };
  1793. /**
  1794. * Performs std::regex_match on request path
  1795. * and stores the result in Request::matches
  1796. *
  1797. * Note that regex match is performed directly on the whole request.
  1798. * This means that wildcard patterns may match multiple path segments with /:
  1799. * "/begin/(.*)/end" will match both "/begin/middle/end" and "/begin/1/2/end".
  1800. */
  1801. class RegexMatcher final : public MatcherBase {
  1802. public:
  1803. RegexMatcher(const std::string &pattern)
  1804. : MatcherBase(pattern), regex_(pattern) {}
  1805. bool match(Request &request) const override;
  1806. private:
  1807. std::regex regex_;
  1808. };
  1809. int close_socket(socket_t sock) noexcept;
  1810. bool is_accept_resource_error();
  1811. bool is_accept_transient_error();
  1812. ssize_t write_headers(Stream &strm, const Headers &headers);
  1813. bool set_socket_opt_time(socket_t sock, int level, int optname, time_t sec,
  1814. time_t usec);
  1815. size_t get_multipart_content_length(const UploadFormDataItems &items,
  1816. const std::string &boundary);
  1817. ContentProvider
  1818. make_multipart_content_provider(const UploadFormDataItems &items,
  1819. const std::string &boundary);
  1820. } // namespace detail
  1821. bool is_valid_multipart_boundary(const std::string &boundary);
  1822. // Serializer for multipart/form-data request bodies. The boundary is owned
  1823. // by the writer so that per-part framing and the final terminator always
  1824. // agree. Field names and filenames are escaped following the WHATWG HTML
  1825. // standard ('"' -> %22, CR -> %0D, LF -> %0A); CR and LF are also escaped
  1826. // in content types.
  1827. class MultipartFormDataWriter {
  1828. public:
  1829. MultipartFormDataWriter();
  1830. // precondition: is_valid_multipart_boundary(boundary)
  1831. explicit MultipartFormDataWriter(std::string boundary);
  1832. const std::string &boundary() const;
  1833. std::string content_type() const;
  1834. // In-memory items -> whole body (known length)
  1835. std::string serialize(const UploadFormDataItems &items) const;
  1836. size_t content_length(const UploadFormDataItems &items) const;
  1837. // Per-part framing for streaming via a content provider
  1838. std::string item_begin(const UploadFormData &item) const;
  1839. static std::string item_end();
  1840. std::string finish() const;
  1841. private:
  1842. std::string boundary_;
  1843. };
  1844. class Server {
  1845. public:
  1846. using Handler = std::function<void(const Request &, Response &)>;
  1847. using ExceptionHandler =
  1848. std::function<void(const Request &, Response &, std::exception_ptr ep)>;
  1849. enum class HandlerResponse {
  1850. Handled,
  1851. Unhandled,
  1852. };
  1853. using HandlerWithResponse =
  1854. std::function<HandlerResponse(const Request &, Response &)>;
  1855. using HandlerWithContentReader = std::function<void(
  1856. const Request &, Response &, const ContentReader &content_reader)>;
  1857. using Expect100ContinueHandler =
  1858. std::function<int(const Request &, Response &)>;
  1859. using StartHandler = std::function<void()>;
  1860. using WebSocketHandler =
  1861. std::function<void(const Request &, ws::WebSocket &)>;
  1862. using SubProtocolSelector =
  1863. std::function<std::string(const std::vector<std::string> &protocols)>;
  1864. Server();
  1865. virtual ~Server();
  1866. virtual bool is_valid() const;
  1867. Server &Get(const std::string &pattern, Handler handler);
  1868. Server &Post(const std::string &pattern, Handler handler);
  1869. Server &Post(const std::string &pattern, HandlerWithContentReader handler);
  1870. Server &Put(const std::string &pattern, Handler handler);
  1871. Server &Put(const std::string &pattern, HandlerWithContentReader handler);
  1872. Server &Patch(const std::string &pattern, Handler handler);
  1873. Server &Patch(const std::string &pattern, HandlerWithContentReader handler);
  1874. Server &Delete(const std::string &pattern, Handler handler);
  1875. Server &Delete(const std::string &pattern, HandlerWithContentReader handler);
  1876. Server &Options(const std::string &pattern, Handler handler);
  1877. // Register a handler for an HTTP method outside the built-in set (e.g. the
  1878. // WebDAV methods from RFC 4918). Registering a method here is what makes the
  1879. // server accept it; an unregistered method is still rejected with 400.
  1880. // `method` must be a valid HTTP method token and must not be one of the
  1881. // built-in methods, which have their own registration functions above. A
  1882. // rejected registration makes is_valid() return false, so listen() fails.
  1883. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1884. Handler handler);
  1885. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1886. HandlerWithContentReader handler);
  1887. Server &WebSocket(const std::string &pattern, WebSocketHandler handler);
  1888. Server &WebSocket(const std::string &pattern, WebSocketHandler handler,
  1889. SubProtocolSelector sub_protocol_selector);
  1890. bool set_base_dir(const std::string &dir,
  1891. const std::string &mount_point = std::string());
  1892. bool set_mount_point(const std::string &mount_point, const std::string &dir,
  1893. Headers headers = Headers());
  1894. bool remove_mount_point(const std::string &mount_point);
  1895. Server &set_file_extension_and_mimetype_mapping(const std::string &ext,
  1896. const std::string &mime);
  1897. Server &set_default_file_mimetype(const std::string &mime);
  1898. Server &set_file_request_handler(Handler handler);
  1899. template <class ErrorHandlerFunc>
  1900. Server &set_error_handler(ErrorHandlerFunc &&handler) {
  1901. return set_error_handler_core(
  1902. std::forward<ErrorHandlerFunc>(handler),
  1903. std::is_convertible<ErrorHandlerFunc, HandlerWithResponse>{});
  1904. }
  1905. Server &set_exception_handler(ExceptionHandler handler);
  1906. Server &set_pre_routing_handler(HandlerWithResponse handler);
  1907. Server &set_post_routing_handler(Handler handler);
  1908. Server &set_pre_request_handler(HandlerWithResponse handler);
  1909. Server &set_expect_100_continue_handler(Expect100ContinueHandler handler);
  1910. Server &set_start_handler(StartHandler handler);
  1911. Server &set_logger(Logger logger);
  1912. Server &set_pre_compression_logger(Logger logger);
  1913. Server &set_error_logger(ErrorLogger error_logger);
  1914. Server &set_address_family(int family);
  1915. Server &set_tcp_nodelay(bool on);
  1916. Server &set_ipv6_v6only(bool on);
  1917. Server &set_socket_options(SocketOptions socket_options);
  1918. Server &set_default_headers(Headers headers);
  1919. Server &
  1920. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  1921. Server &set_trusted_proxies(const std::vector<std::string> &proxies);
  1922. Server &set_keep_alive_max_count(size_t count);
  1923. Server &set_keep_alive_timeout(time_t sec);
  1924. template <class Rep, class Period>
  1925. Server &
  1926. set_keep_alive_timeout(const std::chrono::duration<Rep, Period> &duration);
  1927. Server &set_read_timeout(time_t sec, time_t usec = 0);
  1928. template <class Rep, class Period>
  1929. Server &set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  1930. Server &set_write_timeout(time_t sec, time_t usec = 0);
  1931. template <class Rep, class Period>
  1932. Server &set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  1933. Server &set_idle_interval(time_t sec, time_t usec = 0);
  1934. template <class Rep, class Period>
  1935. Server &set_idle_interval(const std::chrono::duration<Rep, Period> &duration);
  1936. Server &set_payload_max_length(size_t length);
  1937. Server &set_static_file_compression(bool on);
  1938. Server &set_static_file_compression_min_length(size_t length);
  1939. Server &set_static_file_compression_max_length(size_t length);
  1940. Server &set_websocket_ping_interval(time_t sec);
  1941. template <class Rep, class Period>
  1942. Server &set_websocket_ping_interval(
  1943. const std::chrono::duration<Rep, Period> &duration);
  1944. Server &set_websocket_max_missed_pongs(int count);
  1945. bool bind_to_port(const std::string &host, int port, int socket_flags = 0);
  1946. int bind_to_any_port(const std::string &host, int socket_flags = 0);
  1947. bool listen_after_bind();
  1948. bool listen(const std::string &host, int port, int socket_flags = 0);
  1949. bool is_running() const;
  1950. void wait_until_ready() const;
  1951. void stop() noexcept;
  1952. void decommission();
  1953. std::function<TaskQueue *(void)> new_task_queue;
  1954. protected:
  1955. bool process_request(Stream &strm, const std::string &remote_addr,
  1956. int remote_port, const std::string &local_addr,
  1957. int local_port, bool close_connection,
  1958. bool &connection_closed,
  1959. const std::function<void(Request &)> &setup_request,
  1960. bool *websocket_upgraded = nullptr);
  1961. // Runs the per-connection serving loop and stops an exception thrown by a
  1962. // user callback from escaping the worker thread.
  1963. //
  1964. // process_request() wraps only routing() in a try/catch. Content providers,
  1965. // the post-routing, error, logging and expect-100 handlers and WebSocket
  1966. // handlers all run outside it, and the task queue calls the job without a
  1967. // catch, so an exception from any of those would terminate the process.
  1968. //
  1969. // No 500 is possible here: by the time a content provider runs, the status
  1970. // line and headers are already on the wire. Report it through the error
  1971. // logger and drop the connection, which is what the peer observes either
  1972. // way. Other connections are unaffected.
  1973. template <typename Serve> bool serve_guarded(Serve &&serve) const {
  1974. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  1975. return serve();
  1976. #else
  1977. try {
  1978. return serve();
  1979. } catch (...) {
  1980. // The error logger is a user callback too, so it must not be able to
  1981. // throw the guard back open.
  1982. try {
  1983. output_error_log(Error::UserCallbackException, nullptr);
  1984. } catch (...) {}
  1985. return false;
  1986. }
  1987. #endif
  1988. }
  1989. std::atomic<socket_t> svr_sock_{INVALID_SOCKET};
  1990. std::vector<std::string> trusted_proxies_;
  1991. size_t keep_alive_max_count_ = CPPHTTPLIB_KEEPALIVE_MAX_COUNT;
  1992. time_t keep_alive_timeout_sec_ = CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND;
  1993. time_t read_timeout_sec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND;
  1994. time_t read_timeout_usec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND;
  1995. time_t write_timeout_sec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND;
  1996. time_t write_timeout_usec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND;
  1997. time_t idle_interval_sec_ = CPPHTTPLIB_IDLE_INTERVAL_SECOND;
  1998. time_t idle_interval_usec_ = CPPHTTPLIB_IDLE_INTERVAL_USECOND;
  1999. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2000. bool static_file_compression_ = false;
  2001. size_t static_file_compression_min_length_ =
  2002. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH;
  2003. size_t static_file_compression_max_length_ =
  2004. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH;
  2005. time_t websocket_ping_interval_sec_ =
  2006. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  2007. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  2008. private:
  2009. using Handlers =
  2010. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, Handler>>;
  2011. using HandlersForContentReader =
  2012. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>,
  2013. HandlerWithContentReader>>;
  2014. // Both handler tables for one custom method live in a single entry, so that
  2015. // routing() needs only one map lookup per request to reach either of them.
  2016. struct CustomHandlerEntry {
  2017. Handlers handlers;
  2018. HandlersForContentReader handlers_for_content_reader;
  2019. };
  2020. using CustomHandlers = std::map<std::string, CustomHandlerEntry>;
  2021. static std::unique_ptr<detail::MatcherBase>
  2022. make_matcher(const std::string &pattern);
  2023. static const std::set<std::string> &builtin_methods();
  2024. CustomHandlerEntry *custom_entry_for_registration(const std::string &method);
  2025. const CustomHandlerEntry *find_custom_entry(const std::string &method) const;
  2026. template <typename H>
  2027. Server &add_handler(
  2028. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, H>> &handlers,
  2029. const std::string &pattern, H handler) {
  2030. handlers.emplace_back(make_matcher(pattern), std::move(handler));
  2031. return *this;
  2032. }
  2033. Server &set_error_handler_core(HandlerWithResponse handler, std::true_type);
  2034. Server &set_error_handler_core(Handler handler, std::false_type);
  2035. socket_t create_server_socket(const std::string &host, int port,
  2036. int socket_flags,
  2037. SocketOptions socket_options) const;
  2038. int bind_internal(const std::string &host, int port, int socket_flags);
  2039. bool listen_internal();
  2040. bool routing(Request &req, Response &res, Stream &strm);
  2041. bool handle_file_request(Request &req, Response &res);
  2042. bool check_if_not_modified(const Request &req, Response &res,
  2043. const std::string &etag, time_t mtime) const;
  2044. bool check_if_range(Request &req, const std::string &etag,
  2045. time_t mtime) const;
  2046. bool dispatch_request(Request &req, Response &res, const Handlers &handlers,
  2047. Stream &strm);
  2048. bool dispatch_request_for_content_reader(
  2049. Request &req, Response &res, ContentReader content_reader,
  2050. const HandlersForContentReader &handlers) const;
  2051. bool parse_request_line(const char *s, Request &req) const;
  2052. detail::EncodingType static_file_encoding(const Request &req,
  2053. const Response &res,
  2054. const std::string &content_type,
  2055. size_t length) const;
  2056. bool apply_static_file_compression(const Request &req, Response &res) const;
  2057. void apply_ranges(const Request &req, Response &res,
  2058. std::string &content_type, std::string &boundary) const;
  2059. bool write_response(Stream &strm, bool close_connection, Request &req,
  2060. Response &res);
  2061. bool write_response_with_content(Stream &strm, bool close_connection,
  2062. const Request &req, Response &res);
  2063. bool write_response_core(Stream &strm, bool close_connection,
  2064. const Request &req, Response &res,
  2065. bool need_apply_ranges);
  2066. bool write_content_with_provider(Stream &strm, const Request &req,
  2067. Response &res, const std::string &boundary,
  2068. const std::string &content_type);
  2069. bool read_content(Stream &strm, Request &req, Response &res);
  2070. bool read_content_with_content_receiver(Stream &strm, Request &req,
  2071. Response &res,
  2072. ContentReceiver receiver,
  2073. FormDataHeader multipart_header,
  2074. ContentReceiver multipart_receiver);
  2075. bool read_content_core(Stream &strm, Request &req, Response &res,
  2076. ContentReceiver receiver,
  2077. FormDataHeader multipart_header,
  2078. ContentReceiver multipart_receiver) const;
  2079. virtual bool process_and_close_socket(socket_t sock);
  2080. void output_log(const Request &req, const Response &res) const;
  2081. void output_pre_compression_log(const Request &req,
  2082. const Response &res) const;
  2083. void output_error_log(const Error &err, const Request *req) const;
  2084. std::atomic<bool> is_running_{false};
  2085. std::atomic<bool> is_decommissioned{false};
  2086. // Set when CustomRoute() refuses a registration. Written before listen(),
  2087. // read by is_valid() on the same thread, so it needs no synchronization.
  2088. bool has_invalid_registration_ = false;
  2089. struct MountPointEntry {
  2090. std::string mount_point;
  2091. std::string base_dir;
  2092. std::string resolved_base_dir;
  2093. Headers headers;
  2094. };
  2095. std::vector<MountPointEntry> base_dirs_;
  2096. std::map<std::string, std::string> file_extension_and_mimetype_map_;
  2097. std::string default_file_mimetype_ = "application/octet-stream";
  2098. Handler file_request_handler_;
  2099. Handlers get_handlers_;
  2100. Handlers post_handlers_;
  2101. HandlersForContentReader post_handlers_for_content_reader_;
  2102. Handlers put_handlers_;
  2103. HandlersForContentReader put_handlers_for_content_reader_;
  2104. Handlers patch_handlers_;
  2105. HandlersForContentReader patch_handlers_for_content_reader_;
  2106. Handlers delete_handlers_;
  2107. HandlersForContentReader delete_handlers_for_content_reader_;
  2108. Handlers options_handlers_;
  2109. CustomHandlers custom_handlers_;
  2110. struct WebSocketHandlerEntry {
  2111. std::unique_ptr<detail::MatcherBase> matcher;
  2112. WebSocketHandler handler;
  2113. SubProtocolSelector sub_protocol_selector;
  2114. };
  2115. using WebSocketHandlers = std::vector<WebSocketHandlerEntry>;
  2116. WebSocketHandlers websocket_handlers_;
  2117. HandlerWithResponse error_handler_;
  2118. ExceptionHandler exception_handler_;
  2119. HandlerWithResponse pre_routing_handler_;
  2120. Handler post_routing_handler_;
  2121. HandlerWithResponse pre_request_handler_;
  2122. Expect100ContinueHandler expect_100_continue_handler_;
  2123. StartHandler start_handler_;
  2124. mutable std::mutex logger_mutex_;
  2125. Logger logger_;
  2126. Logger pre_compression_logger_;
  2127. ErrorLogger error_logger_;
  2128. int address_family_ = AF_UNSPEC;
  2129. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2130. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2131. SocketOptions socket_options_ = default_socket_options;
  2132. Headers default_headers_;
  2133. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2134. detail::write_headers;
  2135. };
  2136. class Result {
  2137. public:
  2138. Result() = default;
  2139. Result(std::unique_ptr<Response> &&res, Error err,
  2140. Headers &&request_headers = Headers{})
  2141. : res_(std::move(res)), err_(err),
  2142. request_headers_(std::move(request_headers)) {}
  2143. // Response
  2144. operator bool() const { return res_ != nullptr; }
  2145. bool operator==(std::nullptr_t) const { return res_ == nullptr; }
  2146. bool operator!=(std::nullptr_t) const { return res_ != nullptr; }
  2147. const Response &value() const { return *res_; }
  2148. Response &value() { return *res_; }
  2149. const Response &operator*() const { return *res_; }
  2150. Response &operator*() { return *res_; }
  2151. const Response *operator->() const { return res_.get(); }
  2152. Response *operator->() { return res_.get(); }
  2153. // Error
  2154. Error error() const { return err_; }
  2155. // Request Headers
  2156. bool has_request_header(const std::string &key) const;
  2157. std::string get_request_header_value(const std::string &key,
  2158. const char *def = "",
  2159. size_t id = 0) const;
  2160. size_t get_request_header_value_u64(const std::string &key, size_t def = 0,
  2161. size_t id = 0) const;
  2162. size_t get_request_header_value_count(const std::string &key) const;
  2163. private:
  2164. std::unique_ptr<Response> res_;
  2165. Error err_ = Error::Unknown;
  2166. Headers request_headers_;
  2167. #ifdef CPPHTTPLIB_SSL_ENABLED
  2168. public:
  2169. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2170. int ssl_error)
  2171. : res_(std::move(res)), err_(err),
  2172. request_headers_(std::move(request_headers)), ssl_error_(ssl_error) {}
  2173. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2174. int ssl_error, uint64_t ssl_backend_error)
  2175. : res_(std::move(res)), err_(err),
  2176. request_headers_(std::move(request_headers)), ssl_error_(ssl_error),
  2177. ssl_backend_error_(ssl_backend_error) {}
  2178. int ssl_error() const { return ssl_error_; }
  2179. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  2180. private:
  2181. int ssl_error_ = 0;
  2182. uint64_t ssl_backend_error_ = 0;
  2183. #endif
  2184. };
  2185. struct ClientConnection {
  2186. socket_t sock = INVALID_SOCKET;
  2187. bool is_open() const { return sock != INVALID_SOCKET; }
  2188. ClientConnection() = default;
  2189. ~ClientConnection();
  2190. ClientConnection(const ClientConnection &) = delete;
  2191. ClientConnection &operator=(const ClientConnection &) = delete;
  2192. ClientConnection(ClientConnection &&other) noexcept
  2193. : sock(other.sock)
  2194. #ifdef CPPHTTPLIB_SSL_ENABLED
  2195. ,
  2196. session(other.session)
  2197. #endif
  2198. {
  2199. other.sock = INVALID_SOCKET;
  2200. #ifdef CPPHTTPLIB_SSL_ENABLED
  2201. other.session = nullptr;
  2202. #endif
  2203. }
  2204. ClientConnection &operator=(ClientConnection &&other) noexcept {
  2205. if (this != &other) {
  2206. sock = other.sock;
  2207. other.sock = INVALID_SOCKET;
  2208. #ifdef CPPHTTPLIB_SSL_ENABLED
  2209. session = other.session;
  2210. other.session = nullptr;
  2211. #endif
  2212. }
  2213. return *this;
  2214. }
  2215. #ifdef CPPHTTPLIB_SSL_ENABLED
  2216. tls::session_t session = nullptr;
  2217. #endif
  2218. };
  2219. namespace detail {
  2220. struct ChunkedDecoder;
  2221. struct BodyReader {
  2222. Stream *stream = nullptr;
  2223. bool has_content_length = false;
  2224. size_t content_length = 0;
  2225. size_t payload_max_length = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2226. size_t bytes_read = 0;
  2227. bool chunked = false;
  2228. bool eof = false;
  2229. std::unique_ptr<ChunkedDecoder> chunked_decoder;
  2230. Error last_error = Error::Success;
  2231. ssize_t read(char *buf, size_t len);
  2232. bool has_error() const { return last_error != Error::Success; }
  2233. };
  2234. inline ssize_t read_body_content(Stream *stream, BodyReader &br, char *buf,
  2235. size_t len) {
  2236. (void)stream;
  2237. return br.read(buf, len);
  2238. }
  2239. class decompressor;
  2240. enum class NoProxyKind {
  2241. Wildcard, // "*"
  2242. HostnameSuffix, // "example.com" or ".example.com"
  2243. IPv4Cidr, // "10.0.0.0/8" (or single IP, treated as /32)
  2244. IPv6Cidr, // "fe80::/10" (or single IP, treated as /128)
  2245. };
  2246. // Unified 16-byte buffer holding either a v4 (first 4 bytes) or v6 address.
  2247. // Lets one CIDR matcher cover both families.
  2248. using IPBytes = std::array<uint8_t, 16>;
  2249. struct NoProxyEntry {
  2250. NoProxyKind kind = NoProxyKind::Wildcard;
  2251. std::string hostname_pattern; // lowercased, leading/trailing dot stripped
  2252. IPBytes net{};
  2253. int prefix_bits = 0;
  2254. };
  2255. struct NormalizedTarget {
  2256. std::string hostname; // lowercase; brackets and trailing dot removed
  2257. bool is_ipv4 = false;
  2258. bool is_ipv6 = false;
  2259. IPBytes ip{};
  2260. };
  2261. } // namespace detail
  2262. class ClientImpl {
  2263. public:
  2264. explicit ClientImpl(const std::string &host);
  2265. explicit ClientImpl(const std::string &host, int port);
  2266. explicit ClientImpl(const std::string &host, int port,
  2267. const std::string &client_cert_path,
  2268. const std::string &client_key_path);
  2269. virtual ~ClientImpl();
  2270. virtual bool is_valid() const;
  2271. struct StreamHandle {
  2272. std::unique_ptr<Response> response;
  2273. Error error = Error::Success;
  2274. StreamHandle() = default;
  2275. StreamHandle(const StreamHandle &) = delete;
  2276. StreamHandle &operator=(const StreamHandle &) = delete;
  2277. StreamHandle(StreamHandle &&) = default;
  2278. StreamHandle &operator=(StreamHandle &&) = default;
  2279. ~StreamHandle() = default;
  2280. bool is_valid() const {
  2281. return response != nullptr && error == Error::Success;
  2282. }
  2283. ssize_t read(char *buf, size_t len);
  2284. void parse_trailers_if_needed();
  2285. Error get_read_error() const { return body_reader_.last_error; }
  2286. bool has_read_error() const { return body_reader_.has_error(); }
  2287. bool trailers_parsed_ = false;
  2288. private:
  2289. friend class ClientImpl;
  2290. ssize_t read_with_decompression(char *buf, size_t len);
  2291. std::unique_ptr<ClientConnection> connection_;
  2292. std::unique_ptr<Stream> socket_stream_;
  2293. Stream *stream_ = nullptr;
  2294. detail::BodyReader body_reader_;
  2295. std::unique_ptr<detail::decompressor> decompressor_;
  2296. std::string decompress_buffer_;
  2297. size_t decompress_offset_ = 0;
  2298. size_t decompressed_bytes_read_ = 0;
  2299. };
  2300. // clang-format off
  2301. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2302. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2303. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2304. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2305. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2306. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2307. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2308. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2309. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2310. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2311. Result Head(const std::string &path);
  2312. Result Head(const std::string &path, const Headers &headers);
  2313. Result Post(const std::string &path);
  2314. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2315. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2316. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2317. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2318. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2319. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2320. Result Post(const std::string &path, const Params &params);
  2321. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2322. Result Post(const std::string &path, const Headers &headers);
  2323. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2324. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2325. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2326. 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);
  2327. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2328. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2329. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2330. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2331. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2332. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2333. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2334. Result Put(const std::string &path);
  2335. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2336. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2337. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2338. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2339. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2340. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2341. Result Put(const std::string &path, const Params &params);
  2342. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2343. Result Put(const std::string &path, const Headers &headers);
  2344. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2345. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2346. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2347. 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);
  2348. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2349. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2350. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2351. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2352. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2353. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2354. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2355. Result Patch(const std::string &path);
  2356. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2357. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2358. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2359. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2360. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2361. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2362. Result Patch(const std::string &path, const Params &params);
  2363. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2364. Result Patch(const std::string &path, const Headers &headers, UploadProgress progress = nullptr);
  2365. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2366. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2367. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2368. 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);
  2369. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2370. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2371. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2372. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2373. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2374. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2375. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2376. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2377. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2378. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2379. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2380. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2381. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2382. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2383. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2384. Result Options(const std::string &path);
  2385. Result Options(const std::string &path, const Headers &headers);
  2386. // clang-format on
  2387. // Streaming API: Open a stream for reading response body incrementally
  2388. // Socket ownership is transferred to StreamHandle for true streaming
  2389. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2390. StreamHandle open_stream(const std::string &method, const std::string &path,
  2391. const Params &params = {},
  2392. const Headers &headers = {},
  2393. const std::string &body = {},
  2394. const std::string &content_type = {});
  2395. bool send(Request &req, Response &res, Error &error);
  2396. Result send(const Request &req);
  2397. void stop();
  2398. std::string host() const;
  2399. int port() const;
  2400. size_t is_socket_open() const;
  2401. socket_t socket() const;
  2402. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2403. void set_default_headers(Headers headers);
  2404. void
  2405. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2406. void set_address_family(int family);
  2407. void set_tcp_nodelay(bool on);
  2408. void set_ipv6_v6only(bool on);
  2409. void set_socket_options(SocketOptions socket_options);
  2410. void set_connection_timeout(time_t sec, time_t usec = 0);
  2411. template <class Rep, class Period>
  2412. void
  2413. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2414. void set_read_timeout(time_t sec, time_t usec = 0);
  2415. template <class Rep, class Period>
  2416. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2417. void set_write_timeout(time_t sec, time_t usec = 0);
  2418. template <class Rep, class Period>
  2419. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2420. void set_max_timeout(time_t msec);
  2421. template <class Rep, class Period>
  2422. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2423. void set_basic_auth(const std::string &username, const std::string &password);
  2424. void set_bearer_token_auth(const std::string &token);
  2425. void set_keep_alive(bool on);
  2426. void set_follow_location(bool on);
  2427. void set_path_encode(bool on);
  2428. void set_compress(bool on);
  2429. void set_decompress(bool on);
  2430. void set_payload_max_length(size_t length);
  2431. void set_interface(const std::string &intf);
  2432. void set_proxy(const std::string &host, int port);
  2433. void set_proxy_basic_auth(const std::string &username,
  2434. const std::string &password);
  2435. void set_proxy_bearer_token_auth(const std::string &token);
  2436. void set_no_proxy(const std::vector<std::string> &patterns);
  2437. void set_logger(Logger logger);
  2438. void set_error_logger(ErrorLogger error_logger);
  2439. protected:
  2440. struct Socket {
  2441. socket_t sock = INVALID_SOCKET;
  2442. // For Mbed TLS compatibility: start_time for request timeout tracking
  2443. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  2444. bool is_open() const { return sock != INVALID_SOCKET; }
  2445. #ifdef CPPHTTPLIB_SSL_ENABLED
  2446. tls::session_t ssl = nullptr;
  2447. #endif
  2448. };
  2449. virtual bool create_and_connect_socket(Socket &socket, Error &error);
  2450. virtual bool ensure_socket_connection(Socket &socket, Error &error);
  2451. virtual bool setup_proxy_connection(
  2452. Socket &socket,
  2453. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2454. Response &res, bool &success, Error &error);
  2455. bool is_proxy_enabled_for_host(const std::string &host) const;
  2456. // All of:
  2457. // shutdown_ssl
  2458. // shutdown_socket
  2459. // close_socket
  2460. // disconnect
  2461. // should ONLY be called when socket_mutex_ is locked, and only when
  2462. // no other thread is using the socket.
  2463. virtual void shutdown_ssl(Socket &socket, bool shutdown_gracefully);
  2464. void shutdown_socket(Socket &socket) const;
  2465. void close_socket(Socket &socket);
  2466. void disconnect(bool gracefully);
  2467. bool process_request(Stream &strm, Request &req, Response &res,
  2468. bool close_connection, Error &error);
  2469. bool write_content_with_provider(Stream &strm, const Request &req,
  2470. Error &error) const;
  2471. void output_log(const Request &req, const Response &res) const;
  2472. void output_error_log(const Error &err, const Request *req) const;
  2473. // Socket endpoint information
  2474. const std::string host_;
  2475. const int port_;
  2476. // Current open socket
  2477. Socket socket_;
  2478. mutable std::mutex socket_mutex_;
  2479. std::recursive_mutex request_mutex_;
  2480. // These are all protected under socket_mutex
  2481. size_t socket_requests_in_flight_ = 0;
  2482. std::thread::id socket_requests_are_from_thread_ = std::thread::id();
  2483. bool socket_should_be_closed_when_request_is_done_ = false;
  2484. // Hostname to connection target map. The value is an IP literal or another
  2485. // hostname; only the connection target changes, never the identity.
  2486. std::map<std::string, std::string> addr_map_;
  2487. // Default headers
  2488. Headers default_headers_;
  2489. // Header writer
  2490. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2491. detail::write_headers;
  2492. // Settings
  2493. std::string client_cert_path_;
  2494. std::string client_key_path_;
  2495. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  2496. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  2497. time_t read_timeout_sec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND;
  2498. time_t read_timeout_usec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND;
  2499. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  2500. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  2501. time_t max_timeout_msec_ = CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND;
  2502. std::string basic_auth_username_;
  2503. std::string basic_auth_password_;
  2504. std::string bearer_token_auth_token_;
  2505. bool keep_alive_ = false;
  2506. bool follow_location_ = false;
  2507. bool path_encode_ = true;
  2508. int address_family_ = AF_UNSPEC;
  2509. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2510. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2511. SocketOptions socket_options_ = nullptr;
  2512. bool compress_ = false;
  2513. bool decompress_ = true;
  2514. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2515. bool has_payload_max_length_ = false;
  2516. std::string interface_;
  2517. std::string proxy_host_;
  2518. int proxy_port_ = -1;
  2519. std::string proxy_basic_auth_username_;
  2520. std::string proxy_basic_auth_password_;
  2521. std::string proxy_bearer_token_auth_token_;
  2522. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  2523. mutable detail::NormalizedTarget host_normalized_;
  2524. mutable bool host_normalized_valid_ = false;
  2525. mutable std::mutex logger_mutex_;
  2526. Logger logger_;
  2527. ErrorLogger error_logger_;
  2528. private:
  2529. bool send_(Request &req, Response &res, Error &error);
  2530. Result send_(Request &&req);
  2531. socket_t create_client_socket(Error &error) const;
  2532. bool read_response_line(Stream &strm, const Request &req, Response &res,
  2533. bool skip_100_continue = true) const;
  2534. bool write_request(Stream &strm, Request &req, bool close_connection,
  2535. Error &error, bool skip_body, bool &rejected_locally);
  2536. bool write_request_body(Stream &strm, Request &req, Error &error);
  2537. void prepare_default_headers(Request &r, bool for_stream,
  2538. const std::string &ct);
  2539. bool redirect(Request &req, Response &res, Error &error);
  2540. bool create_redirect_client(const std::string &scheme,
  2541. const std::string &host, int port, Request &req,
  2542. Response &res, const std::string &path,
  2543. const std::string &location, Error &error);
  2544. template <typename ClientType> void setup_redirect_client(ClientType &client);
  2545. bool handle_request(Stream &strm, Request &req, Response &res,
  2546. bool close_connection, Error &error);
  2547. std::unique_ptr<Response> send_with_content_provider_and_receiver(
  2548. Request &req, const char *body, size_t content_length,
  2549. ContentProvider content_provider,
  2550. ContentProviderWithoutLength content_provider_without_length,
  2551. const std::string &content_type, ContentReceiver content_receiver,
  2552. Error &error);
  2553. Result send_with_content_provider_and_receiver(
  2554. const std::string &method, const std::string &path,
  2555. const Headers &headers, const char *body, size_t content_length,
  2556. ContentProvider content_provider,
  2557. ContentProviderWithoutLength content_provider_without_length,
  2558. const std::string &content_type, ContentReceiver content_receiver,
  2559. UploadProgress progress);
  2560. ContentProviderWithoutLength get_multipart_content_provider(
  2561. const std::string &boundary, const UploadFormDataItems &items,
  2562. const FormDataProviderItems &provider_items) const;
  2563. virtual bool
  2564. process_socket(const Socket &socket,
  2565. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2566. std::function<bool(Stream &strm)> callback);
  2567. virtual bool is_ssl() const;
  2568. void transfer_socket_ownership_to_handle(StreamHandle &handle);
  2569. #ifdef CPPHTTPLIB_SSL_ENABLED
  2570. public:
  2571. void set_digest_auth(const std::string &username,
  2572. const std::string &password);
  2573. void set_proxy_digest_auth(const std::string &username,
  2574. const std::string &password);
  2575. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2576. const std::string &ca_cert_dir_path = std::string());
  2577. void enable_server_certificate_verification(bool enabled);
  2578. void enable_server_hostname_verification(bool enabled);
  2579. void enable_system_ca(bool enabled);
  2580. protected:
  2581. std::string digest_auth_username_;
  2582. std::string digest_auth_password_;
  2583. std::string proxy_digest_auth_username_;
  2584. std::string proxy_digest_auth_password_;
  2585. std::string ca_cert_file_path_;
  2586. std::string ca_cert_dir_path_;
  2587. bool server_certificate_verification_ = true;
  2588. bool server_hostname_verification_ = true;
  2589. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  2590. std::string ca_cert_pem_; // Store CA cert PEM for redirect transfer
  2591. int last_ssl_error_ = 0;
  2592. uint64_t last_backend_error_ = 0;
  2593. #endif
  2594. };
  2595. namespace detail {
  2596. // Stands in for a client that Client could not make from its arguments, so a
  2597. // request fails rather than going through a null pointer.
  2598. class InvalidClientImpl final : public ClientImpl {
  2599. public:
  2600. InvalidClientImpl() : ClientImpl(std::string(), 0) {}
  2601. bool is_valid() const override { return false; }
  2602. private:
  2603. bool create_and_connect_socket(Socket &, Error &error) override {
  2604. error = Error::Connection;
  2605. return false;
  2606. }
  2607. };
  2608. } // namespace detail
  2609. class Client {
  2610. public:
  2611. // Universal interface
  2612. explicit Client(const std::string &scheme_host_port);
  2613. explicit Client(const std::string &scheme_host_port,
  2614. const std::string &client_cert_path,
  2615. const std::string &client_key_path);
  2616. // HTTP only interface
  2617. explicit Client(const std::string &host, int port);
  2618. explicit Client(const std::string &host, int port,
  2619. const std::string &client_cert_path,
  2620. const std::string &client_key_path);
  2621. Client(Client &&) = default;
  2622. Client &operator=(Client &&) = default;
  2623. ~Client();
  2624. bool is_valid() const;
  2625. // clang-format off
  2626. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2627. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2628. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2629. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2630. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2631. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2632. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2633. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2634. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2635. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2636. Result Head(const std::string &path);
  2637. Result Head(const std::string &path, const Headers &headers);
  2638. Result Post(const std::string &path);
  2639. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2640. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2641. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2642. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2643. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2644. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2645. Result Post(const std::string &path, const Params &params);
  2646. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2647. Result Post(const std::string &path, const Headers &headers);
  2648. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2649. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2650. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2651. 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);
  2652. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2653. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2654. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2655. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2656. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2657. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2658. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2659. Result Put(const std::string &path);
  2660. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2661. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2662. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2663. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2664. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2665. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2666. Result Put(const std::string &path, const Params &params);
  2667. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2668. Result Put(const std::string &path, const Headers &headers);
  2669. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2670. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2671. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2672. 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);
  2673. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2674. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2675. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2676. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2677. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2678. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2679. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2680. Result Patch(const std::string &path);
  2681. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2682. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2683. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2684. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2685. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2686. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2687. Result Patch(const std::string &path, const Params &params);
  2688. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2689. Result Patch(const std::string &path, const Headers &headers);
  2690. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2691. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2692. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2693. 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);
  2694. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2695. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2696. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2697. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2698. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2699. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2700. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2701. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2702. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2703. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2704. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2705. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2706. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2707. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2708. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2709. Result Options(const std::string &path);
  2710. Result Options(const std::string &path, const Headers &headers);
  2711. // clang-format on
  2712. // Streaming API: Open a stream for reading response body incrementally
  2713. // Socket ownership is transferred to StreamHandle for true streaming
  2714. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2715. ClientImpl::StreamHandle open_stream(const std::string &method,
  2716. const std::string &path,
  2717. const Params &params = {},
  2718. const Headers &headers = {},
  2719. const std::string &body = {},
  2720. const std::string &content_type = {});
  2721. bool send(Request &req, Response &res, Error &error);
  2722. Result send(const Request &req);
  2723. void stop();
  2724. std::string host() const;
  2725. int port() const;
  2726. size_t is_socket_open() const;
  2727. socket_t socket() const;
  2728. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2729. void set_default_headers(Headers headers);
  2730. void
  2731. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2732. void set_address_family(int family);
  2733. void set_tcp_nodelay(bool on);
  2734. void set_socket_options(SocketOptions socket_options);
  2735. void set_connection_timeout(time_t sec, time_t usec = 0);
  2736. template <class Rep, class Period>
  2737. void
  2738. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2739. void set_read_timeout(time_t sec, time_t usec = 0);
  2740. template <class Rep, class Period>
  2741. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2742. void set_write_timeout(time_t sec, time_t usec = 0);
  2743. template <class Rep, class Period>
  2744. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2745. void set_max_timeout(time_t msec);
  2746. template <class Rep, class Period>
  2747. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2748. void set_basic_auth(const std::string &username, const std::string &password);
  2749. void set_bearer_token_auth(const std::string &token);
  2750. void set_keep_alive(bool on);
  2751. void set_follow_location(bool on);
  2752. void set_path_encode(bool on);
  2753. void set_compress(bool on);
  2754. void set_decompress(bool on);
  2755. void set_payload_max_length(size_t length);
  2756. void set_interface(const std::string &intf);
  2757. void set_proxy(const std::string &host, int port);
  2758. void set_proxy_basic_auth(const std::string &username,
  2759. const std::string &password);
  2760. void set_proxy_bearer_token_auth(const std::string &token);
  2761. void set_no_proxy(const std::vector<std::string> &patterns);
  2762. void set_logger(Logger logger);
  2763. void set_error_logger(ErrorLogger error_logger);
  2764. private:
  2765. std::unique_ptr<ClientImpl> cli_;
  2766. #ifdef CPPHTTPLIB_SSL_ENABLED
  2767. public:
  2768. void set_digest_auth(const std::string &username,
  2769. const std::string &password);
  2770. void set_proxy_digest_auth(const std::string &username,
  2771. const std::string &password);
  2772. void enable_server_certificate_verification(bool enabled);
  2773. void enable_server_hostname_verification(bool enabled);
  2774. void enable_system_ca(bool enabled);
  2775. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2776. const std::string &ca_cert_dir_path = std::string());
  2777. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2778. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2779. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2780. void set_session_verifier(
  2781. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2782. tls::ctx_t tls_context() const;
  2783. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2784. void enable_windows_certificate_verification(bool enabled);
  2785. #endif
  2786. private:
  2787. bool is_ssl_ = false;
  2788. #endif
  2789. };
  2790. #ifdef CPPHTTPLIB_SSL_ENABLED
  2791. class SSLServer : public Server {
  2792. public:
  2793. SSLServer(const char *cert_path, const char *private_key_path,
  2794. const char *client_ca_cert_file_path = nullptr,
  2795. const char *client_ca_cert_dir_path = nullptr,
  2796. const char *private_key_password = nullptr);
  2797. struct PemMemory {
  2798. const char *cert_pem;
  2799. size_t cert_pem_len;
  2800. const char *key_pem;
  2801. size_t key_pem_len;
  2802. const char *client_ca_pem;
  2803. size_t client_ca_pem_len;
  2804. const char *private_key_password;
  2805. };
  2806. explicit SSLServer(const PemMemory &pem);
  2807. // The callback receives the ctx_t handle which can be cast to the
  2808. // appropriate backend type (SSL_CTX* for OpenSSL,
  2809. // tls::impl::MbedTlsContext* for Mbed TLS)
  2810. explicit SSLServer(const tls::ContextSetupCallback &setup_callback);
  2811. ~SSLServer() override;
  2812. bool is_valid() const override;
  2813. bool update_certs_pem(const char *cert_pem, const char *key_pem,
  2814. const char *client_ca_pem = nullptr,
  2815. const char *password = nullptr);
  2816. tls::ctx_t tls_context() const { return ctx_; }
  2817. int ssl_last_error() const { return last_ssl_error_; }
  2818. private:
  2819. bool process_and_close_socket(socket_t sock) override;
  2820. tls::ctx_t ctx_ = nullptr;
  2821. // update_certs_pem() replaces the certificates and CAs that handshakes read
  2822. // from ctx_, so it waits for the handshakes in progress, which their timeout
  2823. // bounds, and new ones wait while it is pending so that they cannot keep it
  2824. // waiting.
  2825. std::mutex ctx_mutex_;
  2826. std::condition_variable ctx_cv_;
  2827. size_t handshakes_in_progress_ = 0;
  2828. size_t updates_pending_ = 0;
  2829. int last_ssl_error_ = 0;
  2830. };
  2831. class SSLClient final : public ClientImpl {
  2832. public:
  2833. explicit SSLClient(const std::string &host);
  2834. explicit SSLClient(const std::string &host, int port);
  2835. explicit SSLClient(const std::string &host, int port,
  2836. const std::string &client_cert_path,
  2837. const std::string &client_key_path,
  2838. const std::string &private_key_password = std::string());
  2839. struct PemMemory {
  2840. const char *cert_pem;
  2841. size_t cert_pem_len;
  2842. const char *key_pem;
  2843. size_t key_pem_len;
  2844. const char *private_key_password;
  2845. };
  2846. explicit SSLClient(const std::string &host, int port, const PemMemory &pem);
  2847. ~SSLClient() override;
  2848. bool is_valid() const override;
  2849. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2850. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2851. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2852. // Post-handshake session verifier (backend-independent)
  2853. void set_session_verifier(
  2854. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2855. tls::ctx_t tls_context() const { return ctx_; }
  2856. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2857. void enable_windows_certificate_verification(bool enabled);
  2858. #endif
  2859. private:
  2860. bool create_and_connect_socket(Socket &socket, Error &error) override;
  2861. bool ensure_socket_connection(Socket &socket, Error &error) override;
  2862. void shutdown_ssl(Socket &socket, bool shutdown_gracefully) override;
  2863. void shutdown_ssl_impl(Socket &socket, bool shutdown_gracefully);
  2864. bool
  2865. process_socket(const Socket &socket,
  2866. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2867. std::function<bool(Stream &strm)> callback) override;
  2868. bool is_ssl() const override;
  2869. bool setup_proxy_connection(
  2870. Socket &socket,
  2871. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2872. Response &res, bool &success, Error &error) override;
  2873. bool connect_with_proxy(
  2874. Socket &sock,
  2875. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2876. Response &res, bool &success, Error &error);
  2877. bool initialize_ssl(Socket &socket, Error &error);
  2878. void init_ctx();
  2879. void reset_ctx_on_error();
  2880. bool load_certs();
  2881. tls::ctx_t ctx_ = nullptr;
  2882. std::mutex ctx_mutex_;
  2883. std::once_flag initialize_cert_;
  2884. // Tracks whether a custom CA store was applied via set_ca_cert_store(),
  2885. // since the store handle itself is owned by ctx_ and leaves no other trace.
  2886. // Used to keep custom CA configuration exclusive with system CA loading.
  2887. bool ca_cert_store_set_ = false;
  2888. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  2889. // Like ca_cert_store_set_, keeps what ctx_ cannot report back: the verifier
  2890. // set_server_certificate_verifier() installed there.
  2891. tls::VerifyCallback server_certificate_verifier_;
  2892. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2893. bool enable_windows_cert_verification_ = true;
  2894. #endif
  2895. friend class ClientImpl;
  2896. };
  2897. #endif // CPPHTTPLIB_SSL_ENABLED
  2898. namespace detail {
  2899. template <typename T, typename U>
  2900. inline void duration_to_sec_and_usec(const T &duration, U callback) {
  2901. auto sec = std::chrono::duration_cast<std::chrono::seconds>(duration).count();
  2902. auto usec = std::chrono::duration_cast<std::chrono::microseconds>(
  2903. duration - std::chrono::seconds(sec))
  2904. .count();
  2905. callback(static_cast<time_t>(sec), static_cast<time_t>(usec));
  2906. }
  2907. template <size_t N> inline constexpr size_t str_len(const char (&)[N]) {
  2908. return N - 1;
  2909. }
  2910. inline bool is_numeric(const std::string &str) {
  2911. return !str.empty() && std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  2912. }
  2913. // std::ranges::next(first, n, last) for C++11
  2914. template <typename It> inline It bounded_next(It first, size_t n, It last) {
  2915. for (; n > 0 && first != last; --n) {
  2916. ++first;
  2917. }
  2918. return first;
  2919. }
  2920. inline size_t get_header_value_u64(const Headers &headers,
  2921. const std::string &key, size_t def,
  2922. size_t id, bool &is_invalid_value) {
  2923. is_invalid_value = false;
  2924. auto rng = headers.equal_range(key);
  2925. auto it = bounded_next(rng.first, id, rng.second);
  2926. if (it != rng.second) {
  2927. if (is_numeric(it->second)) {
  2928. // Parse at size_t width so an out-of-range Content-Length is reported
  2929. // rather than silently saturated/truncated (a value above 2^32 would
  2930. // otherwise wrap to a small framing length on 32-bit builds). Flag it
  2931. // and return SIZE_MAX so the existing oversized-value guards reject it.
  2932. size_t val = 0;
  2933. const auto &s = it->second;
  2934. auto r = from_chars(s.data(), s.data() + s.size(), val);
  2935. if (r.ec == std::errc::result_out_of_range) {
  2936. is_invalid_value = true;
  2937. return (std::numeric_limits<size_t>::max)();
  2938. }
  2939. return val;
  2940. } else {
  2941. is_invalid_value = true;
  2942. }
  2943. }
  2944. return def;
  2945. }
  2946. inline size_t get_header_value_u64(const Headers &headers,
  2947. const std::string &key, size_t def,
  2948. size_t id) {
  2949. auto dummy = false;
  2950. return get_header_value_u64(headers, key, def, id, dummy);
  2951. }
  2952. } // namespace detail
  2953. template <class Rep, class Period>
  2954. inline Server &
  2955. Server::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2956. detail::duration_to_sec_and_usec(
  2957. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  2958. return *this;
  2959. }
  2960. template <class Rep, class Period>
  2961. inline Server &
  2962. Server::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2963. detail::duration_to_sec_and_usec(
  2964. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  2965. return *this;
  2966. }
  2967. template <class Rep, class Period>
  2968. inline Server &
  2969. Server::set_idle_interval(const std::chrono::duration<Rep, Period> &duration) {
  2970. detail::duration_to_sec_and_usec(
  2971. duration, [&](time_t sec, time_t usec) { set_idle_interval(sec, usec); });
  2972. return *this;
  2973. }
  2974. template <class Rep, class Period>
  2975. inline void ClientImpl::set_connection_timeout(
  2976. const std::chrono::duration<Rep, Period> &duration) {
  2977. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  2978. set_connection_timeout(sec, usec);
  2979. });
  2980. }
  2981. template <class Rep, class Period>
  2982. inline void ClientImpl::set_read_timeout(
  2983. const std::chrono::duration<Rep, Period> &duration) {
  2984. detail::duration_to_sec_and_usec(
  2985. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  2986. }
  2987. template <class Rep, class Period>
  2988. inline void ClientImpl::set_write_timeout(
  2989. const std::chrono::duration<Rep, Period> &duration) {
  2990. detail::duration_to_sec_and_usec(
  2991. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  2992. }
  2993. template <class Rep, class Period>
  2994. inline void ClientImpl::set_max_timeout(
  2995. const std::chrono::duration<Rep, Period> &duration) {
  2996. auto msec =
  2997. std::chrono::duration_cast<std::chrono::milliseconds>(duration).count();
  2998. set_max_timeout(msec);
  2999. }
  3000. template <class Rep, class Period>
  3001. inline void Client::set_connection_timeout(
  3002. const std::chrono::duration<Rep, Period> &duration) {
  3003. cli_->set_connection_timeout(duration);
  3004. }
  3005. template <class Rep, class Period>
  3006. inline void
  3007. Client::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3008. cli_->set_read_timeout(duration);
  3009. }
  3010. template <class Rep, class Period>
  3011. inline void
  3012. Client::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3013. cli_->set_write_timeout(duration);
  3014. }
  3015. inline void Client::set_max_timeout(time_t msec) {
  3016. cli_->set_max_timeout(msec);
  3017. }
  3018. template <class Rep, class Period>
  3019. inline void
  3020. Client::set_max_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3021. cli_->set_max_timeout(duration);
  3022. }
  3023. /*
  3024. * Forward declarations and types that will be part of the .h file if split into
  3025. * .h + .cc.
  3026. */
  3027. std::string hosted_at(const std::string &hostname);
  3028. void hosted_at(const std::string &hostname, std::vector<std::string> &addrs);
  3029. // JavaScript-style URL encoding/decoding functions
  3030. std::string encode_uri_component(const std::string &value);
  3031. std::string encode_uri(const std::string &value);
  3032. std::string decode_uri_component(const std::string &value);
  3033. std::string decode_uri(const std::string &value);
  3034. // RFC 3986 compliant URL component encoding/decoding functions
  3035. std::string encode_path_component(const std::string &component);
  3036. std::string decode_path_component(const std::string &component);
  3037. std::string encode_query_component(const std::string &component,
  3038. bool space_as_plus = true);
  3039. std::string decode_query_component(const std::string &component,
  3040. bool plus_as_space = true);
  3041. std::string sanitize_filename(const std::string &filename);
  3042. std::string append_query_params(const std::string &path, const Params &params);
  3043. std::pair<std::string, std::string> make_range_header(const Ranges &ranges);
  3044. std::pair<std::string, std::string>
  3045. make_basic_authentication_header(const std::string &username,
  3046. const std::string &password,
  3047. bool is_proxy = false);
  3048. namespace detail {
  3049. #if defined(_WIN32)
  3050. inline std::wstring u8string_to_wstring(const char *s) {
  3051. if (!s) { return std::wstring(); }
  3052. auto len = static_cast<int>(strlen(s));
  3053. if (!len) { return std::wstring(); }
  3054. auto wlen = ::MultiByteToWideChar(CP_UTF8, 0, s, len, nullptr, 0);
  3055. if (!wlen) { return std::wstring(); }
  3056. std::wstring ws;
  3057. ws.resize(wlen);
  3058. wlen = ::MultiByteToWideChar(
  3059. CP_UTF8, 0, s, len,
  3060. const_cast<LPWSTR>(reinterpret_cast<LPCWSTR>(ws.data())), wlen);
  3061. if (wlen != static_cast<int>(ws.size())) { ws.clear(); }
  3062. return ws;
  3063. }
  3064. #endif
  3065. struct FileStat {
  3066. FileStat(const std::string &path);
  3067. bool is_file() const;
  3068. bool is_dir() const;
  3069. time_t mtime() const;
  3070. size_t size() const;
  3071. private:
  3072. #if defined(_WIN32)
  3073. struct _stat st_;
  3074. #else
  3075. struct stat st_;
  3076. #endif
  3077. int ret_ = -1;
  3078. };
  3079. std::string make_host_and_port_string(const std::string &host, int port,
  3080. bool is_ssl);
  3081. template <typename T>
  3082. bool check_and_write_headers(Stream &strm, Headers &headers, T header_writer,
  3083. Error &error);
  3084. std::string trim_copy(const std::string &s);
  3085. void divide(
  3086. const char *data, std::size_t size, char d,
  3087. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3088. fn);
  3089. void divide(
  3090. const std::string &str, char d,
  3091. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3092. fn);
  3093. void split(const char *b, const char *e, char d,
  3094. std::function<void(const char *, const char *)> fn);
  3095. void split(const char *b, const char *e, char d, size_t m,
  3096. std::function<void(const char *, const char *)> fn);
  3097. bool split_find(const char *b, const char *e, char d,
  3098. std::function<bool(const char *, const char *)> fn);
  3099. bool has_header_token(const Headers &headers, const std::string &key,
  3100. const std::string &token);
  3101. std::string websocket_accept_key(const std::string &client_key);
  3102. bool is_websocket_upgrade(const Request &req);
  3103. bool process_client_socket(
  3104. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  3105. time_t write_timeout_sec, time_t write_timeout_usec,
  3106. time_t max_timeout_msec,
  3107. std::chrono::time_point<std::chrono::steady_clock> start_time,
  3108. std::function<bool(Stream &)> callback);
  3109. socket_t create_client_socket(const std::string &host, const std::string &ip,
  3110. int port, int address_family, bool tcp_nodelay,
  3111. bool ipv6_v6only, SocketOptions socket_options,
  3112. time_t connection_timeout_sec,
  3113. time_t connection_timeout_usec,
  3114. time_t read_timeout_sec, time_t read_timeout_usec,
  3115. time_t write_timeout_sec,
  3116. time_t write_timeout_usec,
  3117. const std::string &intf, Error &error);
  3118. const char *get_header_value(const Headers &headers, const std::string &key,
  3119. const char *def, size_t id);
  3120. std::string get_combined_header_value(const Headers &headers,
  3121. const std::string &key);
  3122. std::string params_to_query_str(const Params &params);
  3123. void parse_query_text(const char *data, std::size_t size, Params &params);
  3124. void parse_query_text(const std::string &s, Params &params);
  3125. bool parse_multipart_boundary(const std::string &content_type,
  3126. std::string &boundary);
  3127. bool parse_range_header(const std::string &s, Ranges &ranges);
  3128. bool parse_accept_header(const std::string &s,
  3129. std::vector<std::string> &content_types);
  3130. void parse_disposition_params(const std::string &s, Params &params);
  3131. ssize_t send_socket(socket_t sock, const void *ptr, size_t size, int flags);
  3132. ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags);
  3133. EncodingType encoding_type(const Request &req, const std::string &content_type);
  3134. EncodingType encoding_type(const Request &req, const Response &res,
  3135. const std::string &content_type);
  3136. EncodingType encoding_type(const Request &req, const Response &res);
  3137. class BufferStream final : public Stream {
  3138. public:
  3139. BufferStream() = default;
  3140. ~BufferStream() override = default;
  3141. bool is_readable() const override;
  3142. bool wait_readable() const override;
  3143. bool wait_writable() const override;
  3144. ssize_t read(char *ptr, size_t size) override;
  3145. ssize_t write(const char *ptr, size_t size) override;
  3146. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  3147. void get_local_ip_and_port(std::string &ip, int &port) const override;
  3148. socket_t socket() const override;
  3149. time_t duration() const override;
  3150. const std::string &get_buffer() const;
  3151. private:
  3152. std::string buffer;
  3153. size_t position = 0;
  3154. };
  3155. class compressor {
  3156. public:
  3157. virtual ~compressor() = default;
  3158. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3159. virtual bool compress(const char *data, size_t data_length, bool last,
  3160. Callback callback) = 0;
  3161. };
  3162. class decompressor {
  3163. public:
  3164. virtual ~decompressor() = default;
  3165. virtual bool is_valid() const = 0;
  3166. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3167. virtual bool decompress(const char *data, size_t data_length,
  3168. Callback callback) = 0;
  3169. };
  3170. class nocompressor final : public compressor {
  3171. public:
  3172. ~nocompressor() override = default;
  3173. bool compress(const char *data, size_t data_length, bool /*last*/,
  3174. Callback callback) override;
  3175. };
  3176. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  3177. class gzip_compressor final : public compressor {
  3178. public:
  3179. gzip_compressor();
  3180. ~gzip_compressor() override;
  3181. bool compress(const char *data, size_t data_length, bool last,
  3182. Callback callback) override;
  3183. private:
  3184. bool is_valid_ = false;
  3185. z_stream strm_;
  3186. };
  3187. class gzip_decompressor final : public decompressor {
  3188. public:
  3189. gzip_decompressor();
  3190. ~gzip_decompressor() override;
  3191. bool is_valid() const override;
  3192. bool decompress(const char *data, size_t data_length,
  3193. Callback callback) override;
  3194. private:
  3195. bool is_valid_ = false;
  3196. z_stream strm_;
  3197. };
  3198. #endif
  3199. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  3200. class brotli_compressor final : public compressor {
  3201. public:
  3202. brotli_compressor();
  3203. ~brotli_compressor();
  3204. bool compress(const char *data, size_t data_length, bool last,
  3205. Callback callback) override;
  3206. private:
  3207. BrotliEncoderState *state_ = nullptr;
  3208. };
  3209. class brotli_decompressor final : public decompressor {
  3210. public:
  3211. brotli_decompressor();
  3212. ~brotli_decompressor();
  3213. bool is_valid() const override;
  3214. bool decompress(const char *data, size_t data_length,
  3215. Callback callback) override;
  3216. private:
  3217. BrotliDecoderResult decoder_r;
  3218. BrotliDecoderState *decoder_s = nullptr;
  3219. };
  3220. #endif
  3221. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  3222. class zstd_compressor : public compressor {
  3223. public:
  3224. zstd_compressor();
  3225. ~zstd_compressor();
  3226. bool compress(const char *data, size_t data_length, bool last,
  3227. Callback callback) override;
  3228. private:
  3229. ZSTD_CCtx *ctx_ = nullptr;
  3230. };
  3231. class zstd_decompressor : public decompressor {
  3232. public:
  3233. zstd_decompressor();
  3234. ~zstd_decompressor();
  3235. bool is_valid() const override;
  3236. bool decompress(const char *data, size_t data_length,
  3237. Callback callback) override;
  3238. private:
  3239. ZSTD_DCtx *ctx_ = nullptr;
  3240. };
  3241. #endif
  3242. // NOTE: until the read size reaches `fixed_buffer_size`, use `fixed_buffer`
  3243. // to store data. The call can set memory on stack for performance.
  3244. class stream_line_reader {
  3245. public:
  3246. stream_line_reader(Stream &strm, char *fixed_buffer,
  3247. size_t fixed_buffer_size);
  3248. const char *ptr() const;
  3249. size_t size() const;
  3250. bool end_with_crlf() const;
  3251. bool getline();
  3252. private:
  3253. void append(char c);
  3254. void append(const char *data, size_t size);
  3255. Stream &strm_;
  3256. char *fixed_buffer_;
  3257. const size_t fixed_buffer_size_;
  3258. size_t fixed_buffer_used_size_ = 0;
  3259. std::string growable_buffer_;
  3260. };
  3261. bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  3262. const Headers &src_headers);
  3263. struct ChunkedDecoder {
  3264. Stream &strm;
  3265. size_t chunk_remaining = 0;
  3266. bool finished = false;
  3267. char line_buf[64];
  3268. size_t last_chunk_total = 0;
  3269. size_t last_chunk_offset = 0;
  3270. explicit ChunkedDecoder(Stream &s);
  3271. ssize_t read_payload(char *buf, size_t len, size_t &out_chunk_offset,
  3272. size_t &out_chunk_total);
  3273. bool parse_trailers_into(Headers &dest, const Headers &src_headers);
  3274. };
  3275. class mmap {
  3276. public:
  3277. mmap(const char *path);
  3278. ~mmap();
  3279. bool open(const char *path);
  3280. void close();
  3281. bool is_open() const;
  3282. size_t size() const;
  3283. const char *data() const;
  3284. // Copies up to len bytes from offset into buf and returns how many: fewer,
  3285. // down to 0, if the file has shrunk since it was opened, where reading
  3286. // data() would raise SIGBUS.
  3287. size_t read(size_t offset, char *buf, size_t len) const;
  3288. private:
  3289. #if defined(_WIN32)
  3290. HANDLE hFile_ = NULL;
  3291. HANDLE hMapping_ = NULL;
  3292. #else
  3293. int fd_ = -1;
  3294. #endif
  3295. size_t size_ = 0;
  3296. void *addr_ = nullptr;
  3297. bool is_open_empty_file = false;
  3298. };
  3299. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  3300. namespace fields {
  3301. bool is_token_char(char c);
  3302. bool is_token(const std::string &s);
  3303. bool is_field_name(const std::string &s);
  3304. bool is_vchar(char c);
  3305. bool is_obs_text(char c);
  3306. bool is_field_vchar(char c);
  3307. bool is_field_content(const std::string &s);
  3308. bool is_field_value(const std::string &s);
  3309. bool is_field_valid(const std::string &name, const std::string &value);
  3310. bool is_request_target(const std::string &s);
  3311. bool is_host(const std::string &s);
  3312. } // namespace fields
  3313. } // namespace detail
  3314. /*
  3315. * TLS Abstraction Layer Declarations
  3316. */
  3317. #ifdef CPPHTTPLIB_SSL_ENABLED
  3318. // TLS abstraction layer - backend-specific type declarations
  3319. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  3320. namespace tls {
  3321. namespace impl {
  3322. // Mbed TLS context wrapper (holds config, entropy, DRBG, CA chain, own
  3323. // cert/key). This struct is accessible via tls::impl for use in SSL context
  3324. // setup callbacks (cast ctx_t to tls::impl::MbedTlsContext*).
  3325. struct MbedTlsContext {
  3326. mbedtls_ssl_config conf;
  3327. #ifndef CPPHTTPLIB_MBEDTLS_V4
  3328. // Mbed TLS 4.x uses PSA Crypto's internal RNG; no explicit entropy/DRBG.
  3329. mbedtls_entropy_context entropy;
  3330. mbedtls_ctr_drbg_context ctr_drbg;
  3331. #endif
  3332. mbedtls_x509_crt ca_chain;
  3333. mbedtls_x509_crt own_cert;
  3334. mbedtls_pk_context own_key;
  3335. bool is_server = false;
  3336. bool verify_client = false;
  3337. VerifyCallback verify_callback;
  3338. MbedTlsContext();
  3339. ~MbedTlsContext();
  3340. MbedTlsContext(const MbedTlsContext &) = delete;
  3341. MbedTlsContext &operator=(const MbedTlsContext &) = delete;
  3342. };
  3343. } // namespace impl
  3344. } // namespace tls
  3345. #endif
  3346. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  3347. namespace tls {
  3348. namespace impl {
  3349. // wolfSSL context wrapper (holds WOLFSSL_CTX and related state).
  3350. // This struct is accessible via tls::impl for use in SSL context
  3351. // setup callbacks (cast ctx_t to tls::impl::WolfSSLContext*).
  3352. struct WolfSSLContext {
  3353. WOLFSSL_CTX *ctx = nullptr;
  3354. bool is_server = false;
  3355. bool verify_client = false;
  3356. VerifyCallback verify_callback;
  3357. std::string ca_pem_data_; // accumulated PEM for get_ca_names/get_ca_certs
  3358. WolfSSLContext();
  3359. ~WolfSSLContext();
  3360. WolfSSLContext(const WolfSSLContext &) = delete;
  3361. WolfSSLContext &operator=(const WolfSSLContext &) = delete;
  3362. };
  3363. // CA store for wolfSSL: holds raw PEM bytes to allow reloading into any ctx
  3364. struct WolfSSLCAStore {
  3365. std::string pem_data;
  3366. };
  3367. } // namespace impl
  3368. } // namespace tls
  3369. #endif
  3370. #endif // CPPHTTPLIB_SSL_ENABLED
  3371. namespace stream {
  3372. class Result {
  3373. public:
  3374. Result();
  3375. explicit Result(ClientImpl::StreamHandle &&handle, size_t chunk_size = 8192);
  3376. Result(Result &&other) noexcept;
  3377. Result &operator=(Result &&other) noexcept;
  3378. Result(const Result &) = delete;
  3379. Result &operator=(const Result &) = delete;
  3380. // Response info
  3381. bool is_valid() const;
  3382. explicit operator bool() const;
  3383. int status() const;
  3384. const Headers &headers() const;
  3385. std::string get_header_value(const std::string &key,
  3386. const char *def = "") const;
  3387. bool has_header(const std::string &key) const;
  3388. Error error() const;
  3389. Error read_error() const;
  3390. bool has_read_error() const;
  3391. // Stream reading
  3392. bool next();
  3393. const char *data() const;
  3394. size_t size() const;
  3395. std::string read_all();
  3396. private:
  3397. ClientImpl::StreamHandle handle_;
  3398. std::string buffer_;
  3399. size_t current_size_ = 0;
  3400. size_t chunk_size_;
  3401. bool finished_ = false;
  3402. };
  3403. // GET
  3404. template <typename ClientType>
  3405. inline Result Get(ClientType &cli, const std::string &path,
  3406. size_t chunk_size = 8192) {
  3407. return Result{cli.open_stream("GET", path), chunk_size};
  3408. }
  3409. template <typename ClientType>
  3410. inline Result Get(ClientType &cli, const std::string &path,
  3411. const Headers &headers, size_t chunk_size = 8192) {
  3412. return Result{cli.open_stream("GET", path, {}, headers), chunk_size};
  3413. }
  3414. template <typename ClientType>
  3415. inline Result Get(ClientType &cli, const std::string &path,
  3416. const Params &params, size_t chunk_size = 8192) {
  3417. return Result{cli.open_stream("GET", path, params), chunk_size};
  3418. }
  3419. template <typename ClientType>
  3420. inline Result Get(ClientType &cli, const std::string &path,
  3421. const Params &params, const Headers &headers,
  3422. size_t chunk_size = 8192) {
  3423. return Result{cli.open_stream("GET", path, params, headers), chunk_size};
  3424. }
  3425. // POST
  3426. template <typename ClientType>
  3427. inline Result Post(ClientType &cli, const std::string &path,
  3428. const std::string &body, const std::string &content_type,
  3429. size_t chunk_size = 8192) {
  3430. return Result{cli.open_stream("POST", path, {}, {}, body, content_type),
  3431. chunk_size};
  3432. }
  3433. template <typename ClientType>
  3434. inline Result Post(ClientType &cli, const std::string &path,
  3435. const Headers &headers, const std::string &body,
  3436. const std::string &content_type, size_t chunk_size = 8192) {
  3437. return Result{cli.open_stream("POST", path, {}, headers, body, content_type),
  3438. chunk_size};
  3439. }
  3440. template <typename ClientType>
  3441. inline Result Post(ClientType &cli, const std::string &path,
  3442. const Params &params, const std::string &body,
  3443. const std::string &content_type, size_t chunk_size = 8192) {
  3444. return Result{cli.open_stream("POST", path, params, {}, body, content_type),
  3445. chunk_size};
  3446. }
  3447. template <typename ClientType>
  3448. inline Result Post(ClientType &cli, const std::string &path,
  3449. const Params &params, const Headers &headers,
  3450. const std::string &body, const std::string &content_type,
  3451. size_t chunk_size = 8192) {
  3452. return Result{
  3453. cli.open_stream("POST", path, params, headers, body, content_type),
  3454. chunk_size};
  3455. }
  3456. // PUT
  3457. template <typename ClientType>
  3458. inline Result Put(ClientType &cli, const std::string &path,
  3459. const std::string &body, const std::string &content_type,
  3460. size_t chunk_size = 8192) {
  3461. return Result{cli.open_stream("PUT", path, {}, {}, body, content_type),
  3462. chunk_size};
  3463. }
  3464. template <typename ClientType>
  3465. inline Result Put(ClientType &cli, const std::string &path,
  3466. const Headers &headers, const std::string &body,
  3467. const std::string &content_type, size_t chunk_size = 8192) {
  3468. return Result{cli.open_stream("PUT", path, {}, headers, body, content_type),
  3469. chunk_size};
  3470. }
  3471. template <typename ClientType>
  3472. inline Result Put(ClientType &cli, const std::string &path,
  3473. const Params &params, const std::string &body,
  3474. const std::string &content_type, size_t chunk_size = 8192) {
  3475. return Result{cli.open_stream("PUT", path, params, {}, body, content_type),
  3476. chunk_size};
  3477. }
  3478. template <typename ClientType>
  3479. inline Result Put(ClientType &cli, const std::string &path,
  3480. const Params &params, const Headers &headers,
  3481. const std::string &body, const std::string &content_type,
  3482. size_t chunk_size = 8192) {
  3483. return Result{
  3484. cli.open_stream("PUT", path, params, headers, body, content_type),
  3485. chunk_size};
  3486. }
  3487. // PATCH
  3488. template <typename ClientType>
  3489. inline Result Patch(ClientType &cli, const std::string &path,
  3490. const std::string &body, const std::string &content_type,
  3491. size_t chunk_size = 8192) {
  3492. return Result{cli.open_stream("PATCH", path, {}, {}, body, content_type),
  3493. chunk_size};
  3494. }
  3495. template <typename ClientType>
  3496. inline Result Patch(ClientType &cli, const std::string &path,
  3497. const Headers &headers, const std::string &body,
  3498. const std::string &content_type, size_t chunk_size = 8192) {
  3499. return Result{cli.open_stream("PATCH", path, {}, headers, body, content_type),
  3500. chunk_size};
  3501. }
  3502. template <typename ClientType>
  3503. inline Result Patch(ClientType &cli, const std::string &path,
  3504. const Params &params, const std::string &body,
  3505. const std::string &content_type, size_t chunk_size = 8192) {
  3506. return Result{cli.open_stream("PATCH", path, params, {}, body, content_type),
  3507. chunk_size};
  3508. }
  3509. template <typename ClientType>
  3510. inline Result Patch(ClientType &cli, const std::string &path,
  3511. const Params &params, const Headers &headers,
  3512. const std::string &body, const std::string &content_type,
  3513. size_t chunk_size = 8192) {
  3514. return Result{
  3515. cli.open_stream("PATCH", path, params, headers, body, content_type),
  3516. chunk_size};
  3517. }
  3518. // DELETE
  3519. template <typename ClientType>
  3520. inline Result Delete(ClientType &cli, const std::string &path,
  3521. size_t chunk_size = 8192) {
  3522. return Result{cli.open_stream("DELETE", path), chunk_size};
  3523. }
  3524. template <typename ClientType>
  3525. inline Result Delete(ClientType &cli, const std::string &path,
  3526. const Headers &headers, size_t chunk_size = 8192) {
  3527. return Result{cli.open_stream("DELETE", path, {}, headers), chunk_size};
  3528. }
  3529. template <typename ClientType>
  3530. inline Result Delete(ClientType &cli, const std::string &path,
  3531. const std::string &body, const std::string &content_type,
  3532. size_t chunk_size = 8192) {
  3533. return Result{cli.open_stream("DELETE", path, {}, {}, body, content_type),
  3534. chunk_size};
  3535. }
  3536. template <typename ClientType>
  3537. inline Result Delete(ClientType &cli, const std::string &path,
  3538. const Headers &headers, const std::string &body,
  3539. const std::string &content_type,
  3540. size_t chunk_size = 8192) {
  3541. return Result{
  3542. cli.open_stream("DELETE", path, {}, headers, body, content_type),
  3543. chunk_size};
  3544. }
  3545. template <typename ClientType>
  3546. inline Result Delete(ClientType &cli, const std::string &path,
  3547. const Params &params, size_t chunk_size = 8192) {
  3548. return Result{cli.open_stream("DELETE", path, params), chunk_size};
  3549. }
  3550. template <typename ClientType>
  3551. inline Result Delete(ClientType &cli, const std::string &path,
  3552. const Params &params, const Headers &headers,
  3553. size_t chunk_size = 8192) {
  3554. return Result{cli.open_stream("DELETE", path, params, headers), chunk_size};
  3555. }
  3556. template <typename ClientType>
  3557. inline Result Delete(ClientType &cli, const std::string &path,
  3558. const Params &params, const std::string &body,
  3559. const std::string &content_type,
  3560. size_t chunk_size = 8192) {
  3561. return Result{cli.open_stream("DELETE", path, params, {}, body, content_type),
  3562. chunk_size};
  3563. }
  3564. template <typename ClientType>
  3565. inline Result Delete(ClientType &cli, const std::string &path,
  3566. const Params &params, const Headers &headers,
  3567. const std::string &body, const std::string &content_type,
  3568. size_t chunk_size = 8192) {
  3569. return Result{
  3570. cli.open_stream("DELETE", path, params, headers, body, content_type),
  3571. chunk_size};
  3572. }
  3573. // HEAD
  3574. template <typename ClientType>
  3575. inline Result Head(ClientType &cli, const std::string &path,
  3576. size_t chunk_size = 8192) {
  3577. return Result{cli.open_stream("HEAD", path), chunk_size};
  3578. }
  3579. template <typename ClientType>
  3580. inline Result Head(ClientType &cli, const std::string &path,
  3581. const Headers &headers, size_t chunk_size = 8192) {
  3582. return Result{cli.open_stream("HEAD", path, {}, headers), chunk_size};
  3583. }
  3584. template <typename ClientType>
  3585. inline Result Head(ClientType &cli, const std::string &path,
  3586. const Params &params, size_t chunk_size = 8192) {
  3587. return Result{cli.open_stream("HEAD", path, params), chunk_size};
  3588. }
  3589. template <typename ClientType>
  3590. inline Result Head(ClientType &cli, const std::string &path,
  3591. const Params &params, const Headers &headers,
  3592. size_t chunk_size = 8192) {
  3593. return Result{cli.open_stream("HEAD", path, params, headers), chunk_size};
  3594. }
  3595. // OPTIONS
  3596. template <typename ClientType>
  3597. inline Result Options(ClientType &cli, const std::string &path,
  3598. size_t chunk_size = 8192) {
  3599. return Result{cli.open_stream("OPTIONS", path), chunk_size};
  3600. }
  3601. template <typename ClientType>
  3602. inline Result Options(ClientType &cli, const std::string &path,
  3603. const Headers &headers, size_t chunk_size = 8192) {
  3604. return Result{cli.open_stream("OPTIONS", path, {}, headers), chunk_size};
  3605. }
  3606. template <typename ClientType>
  3607. inline Result Options(ClientType &cli, const std::string &path,
  3608. const Params &params, size_t chunk_size = 8192) {
  3609. return Result{cli.open_stream("OPTIONS", path, params), chunk_size};
  3610. }
  3611. template <typename ClientType>
  3612. inline Result Options(ClientType &cli, const std::string &path,
  3613. const Params &params, const Headers &headers,
  3614. size_t chunk_size = 8192) {
  3615. return Result{cli.open_stream("OPTIONS", path, params, headers), chunk_size};
  3616. }
  3617. } // namespace stream
  3618. namespace sse {
  3619. struct SSEMessage {
  3620. std::string event; // Event type (default: "message")
  3621. std::string data; // Event payload
  3622. std::string id; // Event ID for Last-Event-ID header
  3623. SSEMessage();
  3624. void clear();
  3625. };
  3626. class SSEClient {
  3627. public:
  3628. using MessageHandler = std::function<void(const SSEMessage &)>;
  3629. using ErrorHandler = std::function<void(Error)>;
  3630. using OpenHandler = std::function<void()>;
  3631. SSEClient(Client &client, const std::string &path);
  3632. SSEClient(Client &client, const std::string &path, const Headers &headers);
  3633. ~SSEClient();
  3634. SSEClient(const SSEClient &) = delete;
  3635. SSEClient &operator=(const SSEClient &) = delete;
  3636. // Event handlers
  3637. SSEClient &on_message(MessageHandler handler);
  3638. SSEClient &on_event(const std::string &type, MessageHandler handler);
  3639. SSEClient &on_open(OpenHandler handler);
  3640. SSEClient &on_error(ErrorHandler handler);
  3641. SSEClient &set_reconnect_interval(int ms);
  3642. SSEClient &set_max_reconnect_attempts(int n);
  3643. // Update headers (thread-safe)
  3644. SSEClient &set_headers(const Headers &headers);
  3645. // State accessors
  3646. bool is_connected() const;
  3647. const std::string &last_event_id() const;
  3648. // Blocking start - runs event loop with auto-reconnect
  3649. void start();
  3650. // Non-blocking start - runs in background thread
  3651. void start_async();
  3652. // Stop the client (thread-safe)
  3653. void stop();
  3654. private:
  3655. bool parse_sse_line(const std::string &line, SSEMessage &msg, int &retry_ms,
  3656. bool &has_data, bool &has_id);
  3657. void run_event_loop();
  3658. void dispatch_event(const SSEMessage &msg);
  3659. bool should_reconnect(int count) const;
  3660. void wait_for_reconnect();
  3661. // Client and path
  3662. Client &client_;
  3663. std::string path_;
  3664. Headers headers_;
  3665. mutable std::mutex headers_mutex_;
  3666. // Callbacks
  3667. MessageHandler on_message_;
  3668. std::map<std::string, MessageHandler> event_handlers_;
  3669. OpenHandler on_open_;
  3670. ErrorHandler on_error_;
  3671. // Configuration
  3672. int reconnect_interval_ms_ = 3000;
  3673. int max_reconnect_attempts_ = 0; // 0 = unlimited
  3674. // State
  3675. std::atomic<bool> running_{false};
  3676. std::atomic<bool> connected_{false};
  3677. std::string last_event_id_;
  3678. // Async support
  3679. std::thread async_thread_;
  3680. };
  3681. } // namespace sse
  3682. namespace ws {
  3683. class WebSocketClient;
  3684. enum class Opcode : uint8_t {
  3685. Continuation = 0x0,
  3686. Text = 0x1,
  3687. Binary = 0x2,
  3688. Close = 0x8,
  3689. Ping = 0x9,
  3690. Pong = 0xA,
  3691. };
  3692. enum class CloseStatus : uint16_t {
  3693. Normal = 1000,
  3694. GoingAway = 1001,
  3695. ProtocolError = 1002,
  3696. UnsupportedData = 1003,
  3697. NoStatus = 1005,
  3698. Abnormal = 1006,
  3699. InvalidPayload = 1007,
  3700. PolicyViolation = 1008,
  3701. MessageTooBig = 1009,
  3702. MandatoryExtension = 1010,
  3703. InternalError = 1011,
  3704. };
  3705. // Timeout is returned only when a read timeout was set and it elapsed before
  3706. // any byte of a frame arrived: nothing was consumed and the connection is
  3707. // still open, so the caller can send on it and read again. `msg` is left
  3708. // untouched, so a `while (ws.read(msg))` loop must not treat it as a message.
  3709. enum ReadResult : int { Fail = 0, Text = 1, Binary = 2, Timeout = 3 };
  3710. // Result of WebSocketClient::connect(). Truthy only when the WebSocket
  3711. // upgrade handshake fully succeeded. On failure error() identifies the
  3712. // failing layer; status()/headers() expose the server's upgrade response
  3713. // when one was received (status() is -1 otherwise).
  3714. class Result {
  3715. public:
  3716. Result() = default;
  3717. Result(Error err, int status, Headers &&headers)
  3718. : err_(err), status_(status), headers_(std::move(headers)) {}
  3719. explicit operator bool() const { return err_ == Error::Success; }
  3720. Error error() const { return err_; }
  3721. // Upgrade response info
  3722. int status() const { return status_; }
  3723. const Headers &headers() const { return headers_; }
  3724. std::string get_header_value(const std::string &key,
  3725. const char *def = "") const {
  3726. return detail::get_header_value(headers_, key, def, 0);
  3727. }
  3728. bool has_header(const std::string &key) const {
  3729. return headers_.find(key) != headers_.end();
  3730. }
  3731. #ifdef CPPHTTPLIB_SSL_ENABLED
  3732. Result(Error err, int status, Headers &&headers, int ssl_error,
  3733. uint64_t ssl_backend_error)
  3734. : err_(err), status_(status), headers_(std::move(headers)),
  3735. ssl_error_(ssl_error), ssl_backend_error_(ssl_backend_error) {}
  3736. int ssl_error() const { return ssl_error_; }
  3737. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  3738. #endif
  3739. private:
  3740. Error err_ = Error::Unknown; // a default-constructed Result is falsy
  3741. int status_ = -1;
  3742. Headers headers_;
  3743. #ifdef CPPHTTPLIB_SSL_ENABLED
  3744. int ssl_error_ = 0;
  3745. uint64_t ssl_backend_error_ = 0;
  3746. #endif
  3747. };
  3748. class WebSocket {
  3749. public:
  3750. WebSocket(const WebSocket &) = delete;
  3751. WebSocket &operator=(const WebSocket &) = delete;
  3752. ~WebSocket();
  3753. ReadResult read(std::string &msg);
  3754. bool send(const std::string &data);
  3755. bool send(const char *data, size_t len);
  3756. void close(CloseStatus status = CloseStatus::Normal,
  3757. const std::string &reason = "");
  3758. const Request &request() const;
  3759. bool is_open() const;
  3760. // Bound how long read() waits before returning Timeout. 0 waits forever.
  3761. // A server handler owns its connection's timeout this way; a client sets it
  3762. // through WebSocketClient. Safe to call while another thread is in read().
  3763. //
  3764. // Only a timeout set here is reported as Timeout. The compile-time default
  3765. // (CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND) is a backstop rather
  3766. // than a request for control, so when it elapses read() returns Fail and
  3767. // closes the connection, and `while (ws.read(msg))` ends as it always has.
  3768. void set_read_timeout(time_t sec, time_t usec = 0);
  3769. template <class Rep, class Period>
  3770. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3771. private:
  3772. friend class httplib::Server;
  3773. friend class httplib::ws::WebSocketClient;
  3774. WebSocket(
  3775. Stream &strm, const Request &req, bool is_server,
  3776. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3777. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3778. : strm_(strm), req_(req), is_server_(is_server),
  3779. ping_interval_sec_(ping_interval_sec),
  3780. max_missed_pongs_(max_missed_pongs) {
  3781. start_heartbeat();
  3782. }
  3783. WebSocket(
  3784. std::unique_ptr<Stream> &&owned_strm, const Request &req, bool is_server,
  3785. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3786. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3787. : strm_(*owned_strm), owned_strm_(std::move(owned_strm)), req_(req),
  3788. is_server_(is_server), ping_interval_sec_(ping_interval_sec),
  3789. max_missed_pongs_(max_missed_pongs) {
  3790. start_heartbeat();
  3791. }
  3792. void start_heartbeat();
  3793. bool send_frame(Opcode op, const char *data, size_t len, bool fin = true);
  3794. Stream &strm_;
  3795. std::unique_ptr<Stream> owned_strm_;
  3796. Request req_;
  3797. bool is_server_;
  3798. time_t ping_interval_sec_;
  3799. int max_missed_pongs_;
  3800. int unacked_pings_ = 0;
  3801. std::atomic<bool> closed_{false};
  3802. // Set once the caller has bounded read() through set_read_timeout(). Until
  3803. // then the timeout in effect is the compile-time default, and elapsing it
  3804. // is a failure that closes the connection, not a Timeout.
  3805. std::atomic<bool> read_timeout_set_{false};
  3806. std::mutex write_mutex_;
  3807. // Owned by whichever thread is parsing frames off strm_. Only one thread
  3808. // may do so: read_websocket_frame() reads a payload until it has the whole
  3809. // declared length, so a second parser stealing bytes silently corrupts the
  3810. // message the first one is assembling.
  3811. std::mutex read_mutex_;
  3812. std::thread ping_thread_;
  3813. std::mutex ping_mutex_;
  3814. std::condition_variable ping_cv_;
  3815. };
  3816. class WebSocketClient {
  3817. public:
  3818. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3819. const Headers &headers = {});
  3820. ~WebSocketClient();
  3821. WebSocketClient(const WebSocketClient &) = delete;
  3822. WebSocketClient &operator=(const WebSocketClient &) = delete;
  3823. bool is_valid() const;
  3824. Result connect();
  3825. ReadResult read(std::string &msg);
  3826. bool send(const std::string &data);
  3827. bool send(const char *data, size_t len);
  3828. void close(CloseStatus status = CloseStatus::Normal,
  3829. const std::string &reason = "");
  3830. bool is_open() const;
  3831. const std::string &subprotocol() const;
  3832. void set_read_timeout(time_t sec, time_t usec = 0);
  3833. template <class Rep, class Period>
  3834. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3835. void set_write_timeout(time_t sec, time_t usec = 0);
  3836. template <class Rep, class Period>
  3837. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  3838. void set_websocket_ping_interval(time_t sec);
  3839. void set_websocket_max_missed_pongs(int count);
  3840. void set_tcp_nodelay(bool on);
  3841. void set_address_family(int family);
  3842. void set_ipv6_v6only(bool on);
  3843. void set_socket_options(SocketOptions socket_options);
  3844. void set_connection_timeout(time_t sec, time_t usec = 0);
  3845. template <class Rep, class Period>
  3846. void
  3847. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  3848. void set_interface(const std::string &intf);
  3849. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  3850. #ifdef CPPHTTPLIB_SSL_ENABLED
  3851. struct PemMemory {
  3852. const char *cert_pem;
  3853. size_t cert_pem_len;
  3854. const char *key_pem;
  3855. size_t key_pem_len;
  3856. const char *private_key_password;
  3857. };
  3858. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3859. const PemMemory &pem, const Headers &headers = {});
  3860. void set_ca_cert_path(const std::string &ca_cert_file_path,
  3861. const std::string &ca_cert_dir_path = std::string());
  3862. void set_ca_cert_store(tls::ca_store_t store);
  3863. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  3864. void enable_server_certificate_verification(bool enabled);
  3865. void enable_server_hostname_verification(bool enabled);
  3866. void enable_system_ca(bool enabled);
  3867. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  3868. void set_session_verifier(
  3869. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  3870. #endif
  3871. private:
  3872. void shutdown_and_close();
  3873. bool create_stream(std::unique_ptr<Stream> &strm, Error &error,
  3874. int &ssl_error, uint64_t &ssl_backend_error);
  3875. void prepare_default_headers(Request &req);
  3876. std::string host_;
  3877. int port_;
  3878. std::string path_;
  3879. Headers headers_;
  3880. std::string subprotocol_;
  3881. bool is_valid_ = false;
  3882. socket_t sock_ = INVALID_SOCKET;
  3883. std::unique_ptr<WebSocket> ws_;
  3884. time_t read_timeout_sec_ = CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND;
  3885. time_t read_timeout_usec_ = 0;
  3886. bool read_timeout_set_ = false; // see WebSocket::read_timeout_set_
  3887. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  3888. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  3889. time_t websocket_ping_interval_sec_ =
  3890. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  3891. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  3892. int address_family_ = AF_UNSPEC;
  3893. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  3894. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  3895. SocketOptions socket_options_ = nullptr;
  3896. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  3897. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  3898. std::string interface_;
  3899. // Hostname to connection target map. The value is an IP literal or another
  3900. // hostname; only the connection target changes, never the identity.
  3901. std::map<std::string, std::string> addr_map_;
  3902. #ifdef CPPHTTPLIB_SSL_ENABLED
  3903. bool is_ssl_ = false;
  3904. tls::ctx_t tls_ctx_ = nullptr;
  3905. tls::session_t tls_session_ = nullptr;
  3906. std::string ca_cert_file_path_;
  3907. std::string ca_cert_dir_path_;
  3908. bool custom_ca_loaded_ = false;
  3909. bool certs_loaded_ = false;
  3910. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  3911. bool server_certificate_verification_ = true;
  3912. bool server_hostname_verification_ = true;
  3913. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  3914. #endif
  3915. };
  3916. template <class Rep, class Period>
  3917. inline void WebSocket::set_read_timeout(
  3918. const std::chrono::duration<Rep, Period> &duration) {
  3919. detail::duration_to_sec_and_usec(
  3920. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3921. }
  3922. template <class Rep, class Period>
  3923. inline void WebSocketClient::set_read_timeout(
  3924. const std::chrono::duration<Rep, Period> &duration) {
  3925. detail::duration_to_sec_and_usec(
  3926. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3927. }
  3928. template <class Rep, class Period>
  3929. inline void WebSocketClient::set_write_timeout(
  3930. const std::chrono::duration<Rep, Period> &duration) {
  3931. detail::duration_to_sec_and_usec(
  3932. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3933. }
  3934. template <class Rep, class Period>
  3935. inline void WebSocketClient::set_connection_timeout(
  3936. const std::chrono::duration<Rep, Period> &duration) {
  3937. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  3938. set_connection_timeout(sec, usec);
  3939. });
  3940. }
  3941. namespace impl {
  3942. bool is_valid_utf8(const std::string &s);
  3943. // Three states, because a failure that consumed bytes and one that consumed
  3944. // none are not the same thing: the first has left the stream in the middle of
  3945. // a frame and the connection cannot be reused, the second can just be retried.
  3946. enum class FrameRead { Ok, Fail, Timeout };
  3947. FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  3948. std::string &payload, bool &fin,
  3949. bool expect_masked, size_t max_len);
  3950. } // namespace impl
  3951. } // namespace ws
  3952. // ----------------------------------------------------------------------------
  3953. /*
  3954. * Implementation that will be part of the .cc file if split into .h + .cc.
  3955. */
  3956. namespace stream {
  3957. // stream::Result implementations
  3958. inline Result::Result() : chunk_size_(8192) {}
  3959. inline Result::Result(ClientImpl::StreamHandle &&handle, size_t chunk_size)
  3960. : handle_(std::move(handle)), chunk_size_(chunk_size) {}
  3961. inline Result::Result(Result &&other) noexcept
  3962. : handle_(std::move(other.handle_)), buffer_(std::move(other.buffer_)),
  3963. current_size_(other.current_size_), chunk_size_(other.chunk_size_),
  3964. finished_(other.finished_) {
  3965. other.current_size_ = 0;
  3966. other.finished_ = true;
  3967. }
  3968. inline Result &Result::operator=(Result &&other) noexcept {
  3969. if (this != &other) {
  3970. handle_ = std::move(other.handle_);
  3971. buffer_ = std::move(other.buffer_);
  3972. current_size_ = other.current_size_;
  3973. chunk_size_ = other.chunk_size_;
  3974. finished_ = other.finished_;
  3975. other.current_size_ = 0;
  3976. other.finished_ = true;
  3977. }
  3978. return *this;
  3979. }
  3980. inline bool Result::is_valid() const { return handle_.is_valid(); }
  3981. inline Result::operator bool() const { return is_valid(); }
  3982. inline int Result::status() const {
  3983. return handle_.response ? handle_.response->status : -1;
  3984. }
  3985. inline const Headers &Result::headers() const {
  3986. static const Headers empty_headers;
  3987. return handle_.response ? handle_.response->headers : empty_headers;
  3988. }
  3989. inline std::string Result::get_header_value(const std::string &key,
  3990. const char *def) const {
  3991. return handle_.response ? handle_.response->get_header_value(key, def) : def;
  3992. }
  3993. inline bool Result::has_header(const std::string &key) const {
  3994. return handle_.response ? handle_.response->has_header(key) : false;
  3995. }
  3996. inline Error Result::error() const { return handle_.error; }
  3997. inline Error Result::read_error() const { return handle_.get_read_error(); }
  3998. inline bool Result::has_read_error() const { return handle_.has_read_error(); }
  3999. inline bool Result::next() {
  4000. if (!handle_.is_valid() || finished_) { return false; }
  4001. if (buffer_.size() < chunk_size_) { buffer_.resize(chunk_size_); }
  4002. ssize_t n = handle_.read(&buffer_[0], chunk_size_);
  4003. if (n > 0) {
  4004. current_size_ = static_cast<size_t>(n);
  4005. return true;
  4006. }
  4007. current_size_ = 0;
  4008. finished_ = true;
  4009. return false;
  4010. }
  4011. inline const char *Result::data() const { return buffer_.data(); }
  4012. inline size_t Result::size() const { return current_size_; }
  4013. inline std::string Result::read_all() {
  4014. std::string result;
  4015. while (next()) {
  4016. result.append(data(), size());
  4017. }
  4018. return result;
  4019. }
  4020. } // namespace stream
  4021. namespace sse {
  4022. // SSEMessage implementations
  4023. inline SSEMessage::SSEMessage() : event("message") {}
  4024. inline void SSEMessage::clear() {
  4025. event = "message";
  4026. data.clear();
  4027. id.clear();
  4028. }
  4029. // SSEClient implementations
  4030. inline SSEClient::SSEClient(Client &client, const std::string &path)
  4031. : client_(client), path_(path) {}
  4032. inline SSEClient::SSEClient(Client &client, const std::string &path,
  4033. const Headers &headers)
  4034. : client_(client), path_(path), headers_(headers) {}
  4035. inline SSEClient::~SSEClient() { stop(); }
  4036. inline SSEClient &SSEClient::on_message(MessageHandler handler) {
  4037. on_message_ = std::move(handler);
  4038. return *this;
  4039. }
  4040. inline SSEClient &SSEClient::on_event(const std::string &type,
  4041. MessageHandler handler) {
  4042. event_handlers_[type] = std::move(handler);
  4043. return *this;
  4044. }
  4045. inline SSEClient &SSEClient::on_open(OpenHandler handler) {
  4046. on_open_ = std::move(handler);
  4047. return *this;
  4048. }
  4049. inline SSEClient &SSEClient::on_error(ErrorHandler handler) {
  4050. on_error_ = std::move(handler);
  4051. return *this;
  4052. }
  4053. inline SSEClient &SSEClient::set_reconnect_interval(int ms) {
  4054. reconnect_interval_ms_ = ms;
  4055. return *this;
  4056. }
  4057. inline SSEClient &SSEClient::set_max_reconnect_attempts(int n) {
  4058. max_reconnect_attempts_ = n;
  4059. return *this;
  4060. }
  4061. inline SSEClient &SSEClient::set_headers(const Headers &headers) {
  4062. std::lock_guard<std::mutex> lock(headers_mutex_);
  4063. headers_ = headers;
  4064. return *this;
  4065. }
  4066. inline bool SSEClient::is_connected() const { return connected_.load(); }
  4067. inline const std::string &SSEClient::last_event_id() const {
  4068. return last_event_id_;
  4069. }
  4070. inline void SSEClient::start() {
  4071. running_.store(true);
  4072. run_event_loop();
  4073. }
  4074. inline void SSEClient::start_async() {
  4075. running_.store(true);
  4076. async_thread_ = std::thread([this]() { run_event_loop(); });
  4077. }
  4078. inline void SSEClient::stop() {
  4079. running_.store(false);
  4080. client_.stop(); // Cancel any pending operations
  4081. if (async_thread_.joinable()) { async_thread_.join(); }
  4082. }
  4083. inline bool SSEClient::parse_sse_line(const std::string &line, SSEMessage &msg,
  4084. int &retry_ms, bool &has_data,
  4085. bool &has_id) {
  4086. // Blank line signals end of event
  4087. if (line.empty()) { return true; }
  4088. // Lines starting with ':' are comments (ignored)
  4089. if (line[0] == ':') { return false; }
  4090. // Find the colon separator
  4091. auto colon_pos = line.find(':');
  4092. auto field = line.substr(0, colon_pos);
  4093. std::string value;
  4094. // Value starts after colon, skip optional single space
  4095. if (colon_pos != std::string::npos && colon_pos + 1 < line.size()) {
  4096. auto value_start = colon_pos + 1;
  4097. if (line[value_start] == ' ') { value_start++; }
  4098. value = line.substr(value_start);
  4099. }
  4100. // Handle known fields
  4101. if (field == "event") {
  4102. msg.event = value;
  4103. } else if (field == "data") {
  4104. // Multiple data lines are concatenated with newlines
  4105. if (has_data) { msg.data += "\n"; }
  4106. msg.data += value;
  4107. has_data = true;
  4108. } else if (field == "id") {
  4109. // An id that cannot be sent back as Last-Event-ID is ignored. Empty id is
  4110. // valid (clears the last event ID)
  4111. if (detail::fields::is_field_value(value)) {
  4112. msg.id = value;
  4113. has_id = true;
  4114. }
  4115. } else if (field == "retry") {
  4116. // Parse retry interval in milliseconds
  4117. // Per the SSE spec, a value that is not all ASCII digits is ignored.
  4118. if (detail::is_numeric(value)) {
  4119. int v = 0;
  4120. auto res =
  4121. detail::from_chars(value.data(), value.data() + value.size(), v);
  4122. if (res.ec == std::errc{}) { retry_ms = v; }
  4123. }
  4124. }
  4125. // Unknown fields are ignored per SSE spec
  4126. return false;
  4127. }
  4128. inline void SSEClient::run_event_loop() {
  4129. auto reconnect_count = 0;
  4130. while (running_.load()) {
  4131. // Build headers, including Last-Event-ID if we have one
  4132. Headers request_headers;
  4133. {
  4134. std::lock_guard<std::mutex> lock(headers_mutex_);
  4135. request_headers = headers_;
  4136. }
  4137. if (!last_event_id_.empty()) {
  4138. request_headers.emplace("Last-Event-ID", last_event_id_);
  4139. }
  4140. // Open streaming connection
  4141. auto result = stream::Get(client_, path_, request_headers);
  4142. // Connection error handling
  4143. if (!result) {
  4144. connected_.store(false);
  4145. if (on_error_) { on_error_(result.error()); }
  4146. if (!should_reconnect(reconnect_count)) { break; }
  4147. wait_for_reconnect();
  4148. reconnect_count++;
  4149. continue;
  4150. }
  4151. if (result.status() != StatusCode::OK_200) {
  4152. connected_.store(false);
  4153. if (on_error_) { on_error_(Error::Connection); }
  4154. // For certain errors, don't reconnect.
  4155. // Note: 401 is intentionally absent so that handlers can refresh
  4156. // credentials via set_headers() and let the client reconnect.
  4157. if (result.status() == StatusCode::NoContent_204 ||
  4158. result.status() == StatusCode::NotFound_404 ||
  4159. result.status() == StatusCode::Forbidden_403) {
  4160. break;
  4161. }
  4162. if (!should_reconnect(reconnect_count)) { break; }
  4163. wait_for_reconnect();
  4164. reconnect_count++;
  4165. continue;
  4166. }
  4167. // Connection successful
  4168. connected_.store(true);
  4169. reconnect_count = 0;
  4170. if (on_open_) { on_open_(); }
  4171. // Event receiving loop
  4172. std::string buffer;
  4173. SSEMessage current_msg;
  4174. auto has_data = false;
  4175. auto has_id = false;
  4176. auto first_line = true;
  4177. auto after_cr = false;
  4178. auto event_too_long = false;
  4179. while (running_.load() && result.next()) {
  4180. // What is left in the buffer has no line ending
  4181. auto search_pos = buffer.size();
  4182. buffer.append(result.data(), result.size());
  4183. // Process complete lines in the buffer. A line ends with \r\n, \n or \r
  4184. // per the SSE spec
  4185. size_t line_start = 0;
  4186. size_t eol_pos;
  4187. while ((eol_pos = buffer.find_first_of("\r\n", search_pos)) !=
  4188. std::string::npos) {
  4189. auto line = buffer.substr(line_start, eol_pos - line_start);
  4190. line_start = eol_pos + 1;
  4191. search_pos = line_start;
  4192. // The \n of a \r\n may arrive in a later chunk than its \r
  4193. auto is_lf_of_crlf =
  4194. after_cr && line.empty() && buffer[eol_pos] == '\n';
  4195. after_cr = buffer[eol_pos] == '\r';
  4196. if (is_lf_of_crlf) { continue; }
  4197. // A UTF-8 BOM at the start of the stream is ignored per the SSE spec
  4198. if (first_line) {
  4199. first_line = false;
  4200. if (line.compare(0, 3, "\xEF\xBB\xBF") == 0) { line.erase(0, 3); }
  4201. }
  4202. // Parse the line and check if event is complete
  4203. auto event_complete = parse_sse_line(
  4204. line, current_msg, reconnect_interval_ms_, has_data, has_id);
  4205. if (event_complete) {
  4206. // Update last_event_id for reconnection, even for an event that
  4207. // has no data. An empty id clears it.
  4208. if (has_id) { last_event_id_ = current_msg.id; }
  4209. // An event without a data field is not dispatched
  4210. if (has_data) { dispatch_event(current_msg); }
  4211. // Reset the message for the next event either way
  4212. current_msg.clear();
  4213. has_data = false;
  4214. has_id = false;
  4215. }
  4216. }
  4217. // Keep unprocessed data in buffer
  4218. buffer.erase(0, line_start);
  4219. // Neither an event nor a line still waiting for its end may grow
  4220. // without bound. 0 means no limit.
  4221. if (CPPHTTPLIB_SSE_MAX_EVENT_LENGTH > 0 &&
  4222. buffer.size() + current_msg.data.size() >
  4223. CPPHTTPLIB_SSE_MAX_EVENT_LENGTH) {
  4224. if (on_error_) { on_error_(Error::ExceedMaxPayloadSize); }
  4225. event_too_long = true;
  4226. break;
  4227. }
  4228. }
  4229. // Connection ended
  4230. connected_.store(false);
  4231. // Reconnecting would only get the same event again
  4232. if (!running_.load() || event_too_long) { break; }
  4233. // Check for read errors
  4234. if (result.has_read_error()) {
  4235. if (on_error_) { on_error_(result.read_error()); }
  4236. }
  4237. if (!should_reconnect(reconnect_count)) { break; }
  4238. wait_for_reconnect();
  4239. reconnect_count++;
  4240. }
  4241. connected_.store(false);
  4242. }
  4243. inline void SSEClient::dispatch_event(const SSEMessage &msg) {
  4244. // Check for specific event type handler first
  4245. auto it = event_handlers_.find(msg.event);
  4246. if (it != event_handlers_.end()) {
  4247. it->second(msg);
  4248. return;
  4249. }
  4250. // Fall back to generic message handler
  4251. if (on_message_) { on_message_(msg); }
  4252. }
  4253. inline bool SSEClient::should_reconnect(int count) const {
  4254. if (!running_.load()) { return false; }
  4255. if (max_reconnect_attempts_ == 0) { return true; } // unlimited
  4256. return count < max_reconnect_attempts_;
  4257. }
  4258. inline void SSEClient::wait_for_reconnect() {
  4259. // Use small increments to check running_ flag frequently.
  4260. // Always wait at least one increment, so that a zero interval (e.g.
  4261. // "retry: 0" from the server) cannot cause a busy reconnect loop.
  4262. const auto step_ms = 100;
  4263. auto interval_ms = (std::max)(reconnect_interval_ms_, step_ms);
  4264. auto waited = 0;
  4265. while (running_.load() && waited < interval_ms) {
  4266. std::this_thread::sleep_for(std::chrono::milliseconds(step_ms));
  4267. waited += step_ms;
  4268. }
  4269. }
  4270. } // namespace sse
  4271. #ifdef CPPHTTPLIB_SSL_ENABLED
  4272. /*
  4273. * TLS abstraction layer - internal function declarations
  4274. * These are implementation details and not part of the public API.
  4275. */
  4276. namespace tls {
  4277. // Client context
  4278. ctx_t create_client_context();
  4279. void free_context(ctx_t ctx);
  4280. bool set_min_version(ctx_t ctx, Version version);
  4281. bool load_ca_pem(ctx_t ctx, const char *pem, size_t len);
  4282. bool load_ca_file(ctx_t ctx, const char *file_path);
  4283. bool load_ca_dir(ctx_t ctx, const char *dir_path);
  4284. bool load_system_certs(ctx_t ctx);
  4285. bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4286. const char *password);
  4287. bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  4288. const char *key_path, const char *password);
  4289. // Server context
  4290. ctx_t create_server_context();
  4291. bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4292. const char *password);
  4293. bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  4294. const char *key_path, const char *password);
  4295. bool set_client_ca_file(ctx_t ctx, const char *ca_file, const char *ca_dir);
  4296. void set_verify_client(ctx_t ctx, bool require);
  4297. // Session management
  4298. session_t create_session(ctx_t ctx, socket_t sock);
  4299. void free_session(session_t session);
  4300. bool set_sni(session_t session, const char *hostname, bool verify_hostname);
  4301. // Handshake (non-blocking capable)
  4302. TlsError connect(session_t session);
  4303. TlsError accept(session_t session);
  4304. // Handshake with timeout (blocking until timeout)
  4305. bool connect_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4306. time_t timeout_usec, TlsError *err);
  4307. bool accept_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4308. time_t timeout_usec, TlsError *err);
  4309. // I/O (non-blocking capable)
  4310. ssize_t read(session_t session, void *buf, size_t len, TlsError &err);
  4311. ssize_t write(session_t session, const void *buf, size_t len, TlsError &err);
  4312. int pending(const_session_t session);
  4313. void shutdown(session_t session, bool graceful);
  4314. // Connection state
  4315. bool is_peer_closed(session_t session, socket_t sock);
  4316. // Certificate verification
  4317. cert_t get_peer_cert(const_session_t session);
  4318. // The certificates the peer sent, leaf first. Free each with free_cert(), and
  4319. // do not use them after free_session(), as with get_peer_cert().
  4320. size_t get_peer_certs(const_session_t session, std::vector<cert_t> &certs);
  4321. void free_cert(cert_t cert);
  4322. bool verify_hostname(cert_t cert, const char *hostname);
  4323. uint64_t hostname_mismatch_code();
  4324. long get_verify_result(const_session_t session);
  4325. // Certificate introspection
  4326. std::string get_cert_subject_cn(cert_t cert);
  4327. std::string get_cert_issuer_name(cert_t cert);
  4328. bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans);
  4329. bool get_cert_validity(cert_t cert, time_t &not_before, time_t &not_after);
  4330. std::string get_cert_serial(cert_t cert);
  4331. bool get_cert_der(cert_t cert, std::vector<unsigned char> &der);
  4332. const char *get_sni(const_session_t session);
  4333. // CA store management
  4334. ca_store_t create_ca_store(const char *pem, size_t len);
  4335. void free_ca_store(ca_store_t store);
  4336. bool set_ca_store(ctx_t ctx, ca_store_t store);
  4337. size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs);
  4338. std::vector<std::string> get_ca_names(ctx_t ctx);
  4339. // Dynamic certificate update (for servers)
  4340. bool update_server_cert(ctx_t ctx, const char *cert_pem, const char *key_pem,
  4341. const char *password);
  4342. bool update_server_client_ca(ctx_t ctx, const char *ca_pem);
  4343. // Certificate verification callback
  4344. bool set_verify_callback(ctx_t ctx, VerifyCallback callback);
  4345. long get_verify_error(const_session_t session);
  4346. std::string verify_error_string(long error_code);
  4347. // TlsError information
  4348. uint64_t peek_error();
  4349. uint64_t get_error();
  4350. std::string error_string(uint64_t code);
  4351. } // namespace tls
  4352. #endif // CPPHTTPLIB_SSL_ENABLED
  4353. /*
  4354. * Group 1: detail namespace - Non-SSL utilities
  4355. */
  4356. namespace detail {
  4357. inline bool set_socket_opt_impl(socket_t sock, int level, int optname,
  4358. const void *optval, socklen_t optlen) {
  4359. return setsockopt(sock, level, optname,
  4360. #ifdef _WIN32
  4361. reinterpret_cast<const char *>(optval),
  4362. #else
  4363. optval,
  4364. #endif
  4365. optlen) == 0;
  4366. }
  4367. inline bool set_socket_opt_time(socket_t sock, int level, int optname,
  4368. time_t sec, time_t usec) {
  4369. #ifdef _WIN32
  4370. auto timeout = static_cast<uint32_t>(sec * 1000 + usec / 1000);
  4371. #else
  4372. timeval timeout;
  4373. timeout.tv_sec = static_cast<long>(sec);
  4374. timeout.tv_usec = static_cast<decltype(timeout.tv_usec)>(usec);
  4375. #endif
  4376. return set_socket_opt_impl(sock, level, optname, &timeout, sizeof(timeout));
  4377. }
  4378. inline bool is_hex(char c, int &v) {
  4379. if (is_ascii_digit(c)) {
  4380. v = c - '0';
  4381. return true;
  4382. } else if ('A' <= c && c <= 'F') {
  4383. v = c - 'A' + 10;
  4384. return true;
  4385. } else if ('a' <= c && c <= 'f') {
  4386. v = c - 'a' + 10;
  4387. return true;
  4388. }
  4389. return false;
  4390. }
  4391. inline bool from_hex_to_i(const std::string &s, size_t i, size_t cnt,
  4392. int &val) {
  4393. if (i >= s.size()) { return false; }
  4394. val = 0;
  4395. for (; cnt; i++, cnt--) {
  4396. if (!s[i]) { return false; }
  4397. auto v = 0;
  4398. if (is_hex(s[i], v)) {
  4399. val = val * 16 + v;
  4400. } else {
  4401. return false;
  4402. }
  4403. }
  4404. return true;
  4405. }
  4406. inline std::string from_i_to_hex(size_t n) {
  4407. static const auto charset = "0123456789abcdef";
  4408. std::string ret;
  4409. do {
  4410. ret = charset[n & 15] + ret;
  4411. n >>= 4;
  4412. } while (n > 0);
  4413. return ret;
  4414. }
  4415. inline std::string compute_etag(const FileStat &fs,
  4416. const std::string &suffix = std::string()) {
  4417. if (!fs.is_file()) { return std::string(); }
  4418. // If mtime cannot be determined (negative value indicates an error
  4419. // or sentinel), do not generate an ETag. Returning a neutral / fixed
  4420. // value like 0 could collide with a real file that legitimately has
  4421. // mtime == 0 (epoch) and lead to misleading validators.
  4422. auto mtime_raw = fs.mtime();
  4423. if (mtime_raw < 0) { return std::string(); }
  4424. auto mtime = static_cast<size_t>(mtime_raw);
  4425. auto size = fs.size();
  4426. return std::string("W/\"") + from_i_to_hex(mtime) + "-" +
  4427. from_i_to_hex(size) + suffix + "\"";
  4428. }
  4429. // Format time_t as HTTP-date (RFC 9110 Section 5.6.7): "Sun, 06 Nov 1994
  4430. // 08:49:37 GMT" This implementation is defensive: it validates `mtime`, checks
  4431. // return values from `gmtime_r`/`gmtime_s`, and ensures `strftime` succeeds.
  4432. inline std::string file_mtime_to_http_date(time_t mtime) {
  4433. if (mtime < 0) { return std::string(); }
  4434. struct tm tm_buf;
  4435. #ifdef _WIN32
  4436. if (gmtime_s(&tm_buf, &mtime) != 0) { return std::string(); }
  4437. #else
  4438. if (gmtime_r(&mtime, &tm_buf) == nullptr) { return std::string(); }
  4439. #endif
  4440. char buf[64];
  4441. if (strftime(buf, sizeof(buf), "%a, %d %b %Y %H:%M:%S GMT", &tm_buf) == 0) {
  4442. return std::string();
  4443. }
  4444. return std::string(buf);
  4445. }
  4446. // Parse HTTP-date (RFC 9110 Section 5.6.7) to time_t. Returns -1 on failure.
  4447. inline time_t parse_http_date(const std::string &date_str) {
  4448. struct tm tm_buf;
  4449. // Create a classic locale object once for all parsing attempts
  4450. const std::locale classic_locale = std::locale::classic();
  4451. // Try to parse using std::get_time (C++11, cross-platform)
  4452. auto try_parse = [&](const char *fmt) -> bool {
  4453. std::istringstream ss(date_str);
  4454. ss.imbue(classic_locale);
  4455. memset(&tm_buf, 0, sizeof(tm_buf));
  4456. ss >> std::get_time(&tm_buf, fmt);
  4457. return !ss.fail();
  4458. };
  4459. // RFC 9110 preferred format (HTTP-date): "Sun, 06 Nov 1994 08:49:37 GMT"
  4460. if (!try_parse("%a, %d %b %Y %H:%M:%S")) {
  4461. // RFC 850 format: "Sunday, 06-Nov-94 08:49:37 GMT"
  4462. if (!try_parse("%A, %d-%b-%y %H:%M:%S")) {
  4463. // asctime format: "Sun Nov 6 08:49:37 1994"
  4464. if (!try_parse("%a %b %d %H:%M:%S %Y")) {
  4465. return static_cast<time_t>(-1);
  4466. }
  4467. }
  4468. }
  4469. #ifdef _WIN32
  4470. return _mkgmtime(&tm_buf);
  4471. #elif defined _AIX
  4472. return mktime(&tm_buf);
  4473. #else
  4474. return timegm(&tm_buf);
  4475. #endif
  4476. }
  4477. inline bool is_weak_etag(const std::string &s) {
  4478. // Check if the string is a weak ETag (starts with 'W/"')
  4479. return s.size() > 3 && s[0] == 'W' && s[1] == '/' && s[2] == '"';
  4480. }
  4481. inline bool is_strong_etag(const std::string &s) {
  4482. // Check if the string is a strong ETag (starts and ends with '"', at least 2
  4483. // chars)
  4484. return s.size() >= 2 && s[0] == '"' && s.back() == '"';
  4485. }
  4486. inline size_t to_utf8(int code, char *buff) {
  4487. if (code < 0x0080) {
  4488. buff[0] = static_cast<char>(code & 0x7F);
  4489. return 1;
  4490. } else if (code < 0x0800) {
  4491. buff[0] = static_cast<char>(0xC0 | ((code >> 6) & 0x1F));
  4492. buff[1] = static_cast<char>(0x80 | (code & 0x3F));
  4493. return 2;
  4494. } else if (code < 0xD800) {
  4495. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4496. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4497. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4498. return 3;
  4499. } else if (code < 0xE000) { // D800 - DFFF is invalid...
  4500. return 0;
  4501. } else if (code < 0x10000) {
  4502. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4503. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4504. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4505. return 3;
  4506. } else if (code < 0x110000) {
  4507. buff[0] = static_cast<char>(0xF0 | ((code >> 18) & 0x7));
  4508. buff[1] = static_cast<char>(0x80 | ((code >> 12) & 0x3F));
  4509. buff[2] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4510. buff[3] = static_cast<char>(0x80 | (code & 0x3F));
  4511. return 4;
  4512. }
  4513. // NOTREACHED
  4514. return 0;
  4515. }
  4516. } // namespace detail
  4517. namespace ws {
  4518. namespace impl {
  4519. inline bool is_valid_utf8(const std::string &s) {
  4520. size_t i = 0;
  4521. auto n = s.size();
  4522. while (i < n) {
  4523. auto c = static_cast<unsigned char>(s[i]);
  4524. size_t len;
  4525. uint32_t cp;
  4526. if (c < 0x80) {
  4527. i++;
  4528. continue;
  4529. } else if ((c & 0xE0) == 0xC0) {
  4530. len = 2;
  4531. cp = c & 0x1F;
  4532. } else if ((c & 0xF0) == 0xE0) {
  4533. len = 3;
  4534. cp = c & 0x0F;
  4535. } else if ((c & 0xF8) == 0xF0) {
  4536. len = 4;
  4537. cp = c & 0x07;
  4538. } else {
  4539. return false;
  4540. }
  4541. if (i + len > n) { return false; }
  4542. for (size_t j = 1; j < len; j++) {
  4543. auto b = static_cast<unsigned char>(s[i + j]);
  4544. if ((b & 0xC0) != 0x80) { return false; }
  4545. cp = (cp << 6) | (b & 0x3F);
  4546. }
  4547. // Overlong encoding check
  4548. if (len == 2 && cp < 0x80) { return false; }
  4549. if (len == 3 && cp < 0x800) { return false; }
  4550. if (len == 4 && cp < 0x10000) { return false; }
  4551. // Surrogate halves (U+D800..U+DFFF) and beyond U+10FFFF are invalid
  4552. if (cp >= 0xD800 && cp <= 0xDFFF) { return false; }
  4553. if (cp > 0x10FFFF) { return false; }
  4554. i += len;
  4555. }
  4556. return true;
  4557. }
  4558. } // namespace impl
  4559. } // namespace ws
  4560. namespace detail {
  4561. // NOTE: This code came up with the following stackoverflow post:
  4562. // https://stackoverflow.com/questions/180947/base64-decode-snippet-in-c
  4563. inline std::string base64_encode(const std::string &in) {
  4564. static const auto lookup =
  4565. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4566. std::string out;
  4567. out.reserve(in.size());
  4568. // Unsigned: the accumulator is never masked, so with a signed int the
  4569. // `val << 8` below overflows once enough bytes are folded in (undefined
  4570. // behaviour before C++20). Only the low bits are ever emitted, so the
  4571. // wrap-around of an unsigned accumulator does not affect the output.
  4572. uint32_t val = 0;
  4573. auto valb = -6;
  4574. for (auto c : in) {
  4575. val = (val << 8) + static_cast<uint8_t>(c);
  4576. valb += 8;
  4577. while (valb >= 0) {
  4578. out.push_back(lookup[(val >> valb) & 0x3F]);
  4579. valb -= 6;
  4580. }
  4581. }
  4582. if (valb > -6) { out.push_back(lookup[((val << 8) >> (valb + 8)) & 0x3F]); }
  4583. while (out.size() % 4) {
  4584. out.push_back('=');
  4585. }
  4586. return out;
  4587. }
  4588. inline std::string sha1(const std::string &input) {
  4589. // RFC 3174 SHA-1 implementation
  4590. auto left_rotate = [](uint32_t x, uint32_t n) -> uint32_t {
  4591. return (x << n) | (x >> (32 - n));
  4592. };
  4593. uint32_t h0 = 0x67452301;
  4594. uint32_t h1 = 0xEFCDAB89;
  4595. uint32_t h2 = 0x98BADCFE;
  4596. uint32_t h3 = 0x10325476;
  4597. uint32_t h4 = 0xC3D2E1F0;
  4598. // Pre-processing: adding padding bits
  4599. std::string msg = input;
  4600. uint64_t original_bit_len = static_cast<uint64_t>(msg.size()) * 8;
  4601. msg.push_back(static_cast<char>(0x80u));
  4602. while (msg.size() % 64 != 56) {
  4603. msg.push_back(0);
  4604. }
  4605. // Append original length in bits as 64-bit big-endian
  4606. for (int i = 56; i >= 0; i -= 8) {
  4607. msg.push_back(static_cast<char>((original_bit_len >> i) & 0xFF));
  4608. }
  4609. // Process each 512-bit chunk
  4610. for (size_t offset = 0; offset < msg.size(); offset += 64) {
  4611. uint32_t w[80];
  4612. for (size_t i = 0; i < 16; i++) {
  4613. w[i] =
  4614. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4]))
  4615. << 24) |
  4616. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 1]))
  4617. << 16) |
  4618. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 2]))
  4619. << 8) |
  4620. (static_cast<uint32_t>(
  4621. static_cast<uint8_t>(msg[offset + i * 4 + 3])));
  4622. }
  4623. for (int i = 16; i < 80; i++) {
  4624. w[i] = left_rotate(w[i - 3] ^ w[i - 8] ^ w[i - 14] ^ w[i - 16], 1);
  4625. }
  4626. uint32_t a = h0, b = h1, c = h2, d = h3, e = h4;
  4627. for (int i = 0; i < 80; i++) {
  4628. uint32_t f, k;
  4629. if (i < 20) {
  4630. f = (b & c) | ((~b) & d);
  4631. k = 0x5A827999;
  4632. } else if (i < 40) {
  4633. f = b ^ c ^ d;
  4634. k = 0x6ED9EBA1;
  4635. } else if (i < 60) {
  4636. f = (b & c) | (b & d) | (c & d);
  4637. k = 0x8F1BBCDC;
  4638. } else {
  4639. f = b ^ c ^ d;
  4640. k = 0xCA62C1D6;
  4641. }
  4642. uint32_t temp = left_rotate(a, 5) + f + e + k + w[i];
  4643. e = d;
  4644. d = c;
  4645. c = left_rotate(b, 30);
  4646. b = a;
  4647. a = temp;
  4648. }
  4649. h0 += a;
  4650. h1 += b;
  4651. h2 += c;
  4652. h3 += d;
  4653. h4 += e;
  4654. }
  4655. // Produce the final hash as a 20-byte binary string
  4656. std::string hash(20, '\0');
  4657. for (size_t i = 0; i < 4; i++) {
  4658. hash[i] = static_cast<char>((h0 >> (24 - i * 8)) & 0xFF);
  4659. hash[4 + i] = static_cast<char>((h1 >> (24 - i * 8)) & 0xFF);
  4660. hash[8 + i] = static_cast<char>((h2 >> (24 - i * 8)) & 0xFF);
  4661. hash[12 + i] = static_cast<char>((h3 >> (24 - i * 8)) & 0xFF);
  4662. hash[16 + i] = static_cast<char>((h4 >> (24 - i * 8)) & 0xFF);
  4663. }
  4664. return hash;
  4665. }
  4666. inline std::string websocket_accept_key(const std::string &client_key) {
  4667. const std::string magic = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
  4668. return base64_encode(sha1(client_key + magic));
  4669. }
  4670. inline bool is_websocket_upgrade(const Request &req) {
  4671. if (req.method != "GET") { return false; }
  4672. // Check Upgrade: websocket. RFC 9110 7.8 defines Upgrade as a comma-separated
  4673. // list of protocols and asks recipients to match each name
  4674. // case-insensitively, so look for the token rather than compare the whole
  4675. // field value.
  4676. if (!has_header_token(req.headers, "Upgrade", "websocket")) { return false; }
  4677. // Check Connection: Upgrade
  4678. if (!has_header_token(req.headers, "Connection", "upgrade")) { return false; }
  4679. // Check Sec-WebSocket-Key is a valid base64-encoded 16-byte value (24 chars)
  4680. // RFC 6455 Section 4.2.1
  4681. auto ws_key = req.get_header_value("Sec-WebSocket-Key");
  4682. if (ws_key.size() != 24 || ws_key[22] != '=' || ws_key[23] != '=') {
  4683. return false;
  4684. }
  4685. static const std::string b64chars =
  4686. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4687. for (size_t i = 0; i < 22; i++) {
  4688. if (b64chars.find(ws_key[i]) == std::string::npos) { return false; }
  4689. }
  4690. // Check Sec-WebSocket-Version: 13
  4691. auto version = req.get_header_value("Sec-WebSocket-Version");
  4692. if (version != "13") { return false; }
  4693. return true;
  4694. }
  4695. // Unpredictable bytes for masking keys (RFC 6455 Section 5.3) and nonces
  4696. inline void fill_random_bytes(unsigned char *out, size_t n) {
  4697. thread_local std::random_device rd;
  4698. size_t filled = 0;
  4699. while (filled < n) {
  4700. auto v = rd();
  4701. for (size_t b = 0; b < sizeof(v) && filled < n; ++b, ++filled) {
  4702. out[filled] = static_cast<unsigned char>((v >> (b * 8)) & 0xFFu);
  4703. }
  4704. }
  4705. }
  4706. inline bool write_websocket_frame(Stream &strm, ws::Opcode opcode,
  4707. const char *data, size_t len, bool fin,
  4708. bool mask) {
  4709. // First byte: FIN + opcode
  4710. uint8_t header[2];
  4711. header[0] = static_cast<uint8_t>((fin ? 0x80 : 0x00) |
  4712. (static_cast<uint8_t>(opcode) & 0x0F));
  4713. // Second byte: MASK + payload length
  4714. if (len < 126) {
  4715. header[1] = static_cast<uint8_t>(len);
  4716. if (mask) { header[1] |= 0x80; }
  4717. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4718. } else if (len <= 0xFFFF) {
  4719. header[1] = 126;
  4720. if (mask) { header[1] |= 0x80; }
  4721. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4722. uint8_t ext[2];
  4723. ext[0] = static_cast<uint8_t>((len >> 8) & 0xFF);
  4724. ext[1] = static_cast<uint8_t>(len & 0xFF);
  4725. if (strm.write(reinterpret_cast<char *>(ext), 2) < 0) { return false; }
  4726. } else {
  4727. header[1] = 127;
  4728. if (mask) { header[1] |= 0x80; }
  4729. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4730. uint8_t ext[8];
  4731. for (int i = 7; i >= 0; i--) {
  4732. ext[7 - i] =
  4733. static_cast<uint8_t>((static_cast<uint64_t>(len) >> (i * 8)) & 0xFF);
  4734. }
  4735. if (strm.write(reinterpret_cast<char *>(ext), 8) < 0) { return false; }
  4736. }
  4737. if (mask) {
  4738. // Generate random mask key
  4739. uint8_t mask_key[4];
  4740. fill_random_bytes(mask_key, sizeof(mask_key));
  4741. if (strm.write(reinterpret_cast<char *>(mask_key), 4) < 0) { return false; }
  4742. // Write masked payload in chunks
  4743. const size_t chunk_size = 4096;
  4744. std::vector<char> buf((std::min)(len, chunk_size));
  4745. for (size_t offset = 0; offset < len; offset += chunk_size) {
  4746. size_t n = (std::min)(chunk_size, len - offset);
  4747. for (size_t i = 0; i < n; i++) {
  4748. buf[i] =
  4749. data[offset + i] ^ static_cast<char>(mask_key[(offset + i) % 4]);
  4750. }
  4751. if (strm.write(buf.data(), n) < 0) { return false; }
  4752. }
  4753. } else {
  4754. if (len > 0) {
  4755. if (strm.write(data, len) < 0) { return false; }
  4756. }
  4757. }
  4758. return true;
  4759. }
  4760. } // namespace detail
  4761. namespace ws {
  4762. namespace impl {
  4763. // Read exactly `size` bytes. Stream::read may return less than asked for -- it
  4764. // hands back whatever its buffer already holds -- so every multi-byte field has
  4765. // to loop. Reading a 2-byte header with a single read() fails whenever the
  4766. // header straddles the read buffer's boundary.
  4767. //
  4768. // Timeout is reported only when nothing at all was consumed. Once a byte has
  4769. // been taken the stream sits mid-field and cannot be resumed, so a timeout
  4770. // there is a failure like any other. (When read() fails it always records why,
  4771. // so the error belongs to this call and not to an earlier one.)
  4772. inline FrameRead read_exact(Stream &strm, void *buf, size_t size) {
  4773. auto p = static_cast<char *>(buf);
  4774. size_t total = 0;
  4775. while (total < size) {
  4776. auto n = strm.read(p + total, size - total);
  4777. if (n <= 0) {
  4778. auto timed_out = total == 0 && strm.get_error() == Error::Timeout;
  4779. return timed_out ? FrameRead::Timeout : FrameRead::Fail;
  4780. }
  4781. total += static_cast<size_t>(n);
  4782. }
  4783. return FrameRead::Ok;
  4784. }
  4785. inline FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  4786. std::string &payload, bool &fin,
  4787. bool expect_masked, size_t max_len) {
  4788. // Read first 2 bytes. This is the only read that may report a timeout: it
  4789. // sits on a frame boundary, where nothing has been consumed yet.
  4790. uint8_t header[2];
  4791. FrameRead first = read_exact(strm, header, 2);
  4792. if (first != FrameRead::Ok) { return first; }
  4793. fin = (header[0] & 0x80) != 0;
  4794. // RSV1, RSV2, RSV3 must be 0 when no extension is negotiated
  4795. if (header[0] & 0x70) { return FrameRead::Fail; }
  4796. opcode = static_cast<Opcode>(header[0] & 0x0F);
  4797. bool masked = (header[1] & 0x80) != 0;
  4798. uint64_t payload_len = header[1] & 0x7F;
  4799. // RFC 6455 Section 5.5: control frames MUST NOT be fragmented and
  4800. // MUST have a payload length of 125 bytes or less
  4801. bool is_control = (static_cast<uint8_t>(opcode) & 0x08) != 0;
  4802. if (is_control) {
  4803. if (!fin) { return FrameRead::Fail; }
  4804. if (payload_len > 125) { return FrameRead::Fail; }
  4805. }
  4806. if (masked != expect_masked) { return FrameRead::Fail; }
  4807. // Extended payload length
  4808. if (payload_len == 126) {
  4809. uint8_t ext[2];
  4810. if (read_exact(strm, ext, 2) != FrameRead::Ok) { return FrameRead::Fail; }
  4811. payload_len = (static_cast<uint64_t>(ext[0]) << 8) | ext[1];
  4812. } else if (payload_len == 127) {
  4813. uint8_t ext[8];
  4814. if (read_exact(strm, ext, 8) != FrameRead::Ok) { return FrameRead::Fail; }
  4815. // RFC 6455 Section 5.2: the most significant bit MUST be 0
  4816. if (ext[0] & 0x80) { return FrameRead::Fail; }
  4817. payload_len = 0;
  4818. for (int i = 0; i < 8; i++) {
  4819. payload_len = (payload_len << 8) | ext[i];
  4820. }
  4821. }
  4822. // A max_len of 0 means no limit, as payload_max_length does, and a length
  4823. // size_t cannot hold (32-bit builds) is refused either way.
  4824. if ((max_len > 0 && payload_len > max_len) ||
  4825. payload_len > (std::numeric_limits<size_t>::max)()) {
  4826. return FrameRead::Fail;
  4827. }
  4828. // Read mask key if present
  4829. uint8_t mask_key[4] = {0};
  4830. if (masked) {
  4831. if (read_exact(strm, mask_key, 4) != FrameRead::Ok) {
  4832. return FrameRead::Fail;
  4833. }
  4834. }
  4835. // Grow the payload only as it arrives, since a header alone can announce
  4836. // max_len bytes that never come.
  4837. payload.clear();
  4838. auto len = static_cast<size_t>(payload_len);
  4839. while (payload.size() < len) {
  4840. auto offset = payload.size();
  4841. auto n = (std::min)(len - offset, CPPHTTPLIB_RECV_BUFSIZ);
  4842. payload.resize(offset + n);
  4843. if (read_exact(strm, &payload[offset], n) != FrameRead::Ok) {
  4844. return FrameRead::Fail;
  4845. }
  4846. }
  4847. // Unmask if needed
  4848. if (masked) {
  4849. for (size_t i = 0; i < payload.size(); i++) {
  4850. payload[i] ^= static_cast<char>(mask_key[i % 4]);
  4851. }
  4852. }
  4853. return FrameRead::Ok;
  4854. }
  4855. // RFC 6455 §5.5.1, §7.4: a Close payload is empty, or a status code that may
  4856. // be sent followed by a UTF-8 reason.
  4857. inline bool is_valid_close_payload(const std::string &payload) {
  4858. if (payload.empty()) { return true; }
  4859. if (payload.size() < 2) { return false; }
  4860. auto code = (static_cast<uint8_t>(payload[0]) << 8) |
  4861. static_cast<uint8_t>(payload[1]);
  4862. auto may_be_sent = (1000 <= code && code <= 1003) ||
  4863. (1007 <= code && code <= 1014) ||
  4864. (3000 <= code && code <= 4999);
  4865. return may_be_sent && is_valid_utf8(payload.substr(2));
  4866. }
  4867. } // namespace impl
  4868. } // namespace ws
  4869. namespace detail {
  4870. inline bool is_valid_path(const std::string &path) {
  4871. size_t level = 0;
  4872. size_t i = 0;
  4873. // Skip slash
  4874. while (i < path.size() && path[i] == '/') {
  4875. i++;
  4876. }
  4877. while (i < path.size()) {
  4878. // Read component
  4879. auto beg = i;
  4880. while (i < path.size() && path[i] != '/') {
  4881. if (path[i] == '\0') {
  4882. return false;
  4883. } else if (path[i] == '\\') {
  4884. return false;
  4885. }
  4886. i++;
  4887. }
  4888. auto len = i - beg;
  4889. assert(len > 0);
  4890. if (!path.compare(beg, len, ".")) {
  4891. ;
  4892. } else if (!path.compare(beg, len, "..")) {
  4893. if (level == 0) { return false; }
  4894. level--;
  4895. } else {
  4896. level++;
  4897. }
  4898. // Skip slash
  4899. while (i < path.size() && path[i] == '/') {
  4900. i++;
  4901. }
  4902. }
  4903. return true;
  4904. }
  4905. inline bool canonicalize_path(const char *path, std::string &resolved) {
  4906. #if defined(_WIN32)
  4907. char buf[_MAX_PATH];
  4908. if (_fullpath(buf, path, _MAX_PATH) == nullptr) { return false; }
  4909. resolved = buf;
  4910. #elif defined(PATH_MAX)
  4911. char buf[PATH_MAX];
  4912. if (realpath(path, buf) == nullptr) { return false; }
  4913. resolved = buf;
  4914. #else
  4915. auto buf = realpath(path, nullptr);
  4916. auto guard = scope_exit([&]() { std::free(buf); });
  4917. if (buf == nullptr) { return false; }
  4918. resolved = buf;
  4919. #endif
  4920. return true;
  4921. }
  4922. inline bool is_path_within_base(const std::string &resolved_path,
  4923. const std::string &resolved_base) {
  4924. #if defined(_WIN32)
  4925. return _strnicmp(resolved_path.c_str(), resolved_base.c_str(),
  4926. resolved_base.size()) == 0;
  4927. #else
  4928. return strncmp(resolved_path.c_str(), resolved_base.c_str(),
  4929. resolved_base.size()) == 0;
  4930. #endif
  4931. }
  4932. inline FileStat::FileStat(const std::string &path) {
  4933. #if defined(_WIN32)
  4934. auto wpath = u8string_to_wstring(path.c_str());
  4935. ret_ = _wstat(wpath.c_str(), &st_);
  4936. #else
  4937. ret_ = stat(path.c_str(), &st_);
  4938. #endif
  4939. }
  4940. inline bool FileStat::is_file() const {
  4941. return ret_ >= 0 && S_ISREG(st_.st_mode);
  4942. }
  4943. inline bool FileStat::is_dir() const {
  4944. return ret_ >= 0 && S_ISDIR(st_.st_mode);
  4945. }
  4946. inline time_t FileStat::mtime() const {
  4947. return ret_ >= 0 ? static_cast<time_t>(st_.st_mtime)
  4948. : static_cast<time_t>(-1);
  4949. }
  4950. inline size_t FileStat::size() const {
  4951. return ret_ >= 0 ? static_cast<size_t>(st_.st_size) : 0;
  4952. }
  4953. inline std::string encode_path(const std::string &s) {
  4954. std::string result;
  4955. result.reserve(s.size());
  4956. for (size_t i = 0; s[i]; i++) {
  4957. switch (s[i]) {
  4958. case ' ': result += "%20"; break;
  4959. case '+': result += "%2B"; break;
  4960. case '\'': result += "%27"; break;
  4961. case ',': result += "%2C"; break;
  4962. // case ':': result += "%3A"; break; // ok? probably...
  4963. case ';': result += "%3B"; break;
  4964. default:
  4965. auto c = static_cast<uint8_t>(s[i]);
  4966. // Control characters (incl. CR/LF) and non-ASCII bytes are not allowed
  4967. // in a request-target as-is.
  4968. if (c < 0x20 || c == 0x7f || c >= 0x80) {
  4969. result += '%';
  4970. char hex[4];
  4971. auto len = snprintf(hex, sizeof(hex) - 1, "%02X", c);
  4972. assert(len == 2);
  4973. result.append(hex, static_cast<size_t>(len));
  4974. } else {
  4975. result += s[i];
  4976. }
  4977. break;
  4978. }
  4979. }
  4980. return result;
  4981. }
  4982. inline std::string file_extension(const std::string &path) {
  4983. auto i = path.size();
  4984. while (i > 0 && is_ascii_alnum(path[i - 1])) {
  4985. i--;
  4986. }
  4987. if (i == path.size() || i == 0 || path[i - 1] != '.') {
  4988. return std::string();
  4989. }
  4990. return path.substr(i);
  4991. }
  4992. inline bool is_space_or_tab(char c) { return c == ' ' || c == '\t'; }
  4993. template <typename T>
  4994. inline bool parse_header(const char *beg, const char *end, T fn);
  4995. template <typename T>
  4996. inline bool parse_header(const char *beg, const char *end, T fn) {
  4997. // Skip trailing spaces and tabs.
  4998. while (beg < end && is_space_or_tab(end[-1])) {
  4999. end--;
  5000. }
  5001. auto p = beg;
  5002. while (p < end && *p != ':') {
  5003. p++;
  5004. }
  5005. auto name = std::string(beg, p);
  5006. if (!detail::fields::is_field_name(name)) { return false; }
  5007. if (p == end) { return false; }
  5008. auto key_end = p;
  5009. if (*p++ != ':') { return false; }
  5010. while (p < end && is_space_or_tab(*p)) {
  5011. p++;
  5012. }
  5013. if (p <= end) {
  5014. auto key_len = key_end - beg;
  5015. if (!key_len) { return false; }
  5016. auto key = std::string(beg, key_end);
  5017. auto val = std::string(p, end);
  5018. if (!detail::fields::is_field_value(val)) { return false; }
  5019. // RFC 9110 §5.5: header field values are opaque octets and MUST NOT be
  5020. // percent-decoded by the recipient. Applications that need to interpret a
  5021. // value as a URI component should call httplib::decode_uri_component()
  5022. // (or decode_path_component()) explicitly.
  5023. fn(key, val);
  5024. return true;
  5025. }
  5026. return false;
  5027. }
  5028. inline bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  5029. const Headers &src_headers) {
  5030. // NOTE: In RFC 9112, '7.1 Chunked Transfer Coding' mentions "The chunked
  5031. // transfer coding is complete when a chunk with a chunk-size of zero is
  5032. // received, possibly followed by a trailer section, and finally terminated by
  5033. // an empty line". https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1
  5034. //
  5035. // In '7.1.3. Decoding Chunked', however, the pseudo-code in the section
  5036. // doesn't care for the existence of the final CRLF. In other words, it seems
  5037. // to be ok whether the final CRLF exists or not in the chunked data.
  5038. // https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1.3
  5039. //
  5040. // According to the reference code in RFC 9112, cpp-httplib now allows
  5041. // chunked transfer coding data without the final CRLF.
  5042. // RFC 7230 Section 4.1.2 - Headers prohibited in trailers
  5043. thread_local case_ignore::unordered_set<std::string> prohibited_trailers = {
  5044. "transfer-encoding",
  5045. "content-length",
  5046. "host",
  5047. "authorization",
  5048. "www-authenticate",
  5049. "proxy-authenticate",
  5050. "proxy-authorization",
  5051. "cookie",
  5052. "set-cookie",
  5053. "cache-control",
  5054. "expect",
  5055. "max-forwards",
  5056. "pragma",
  5057. "range",
  5058. "te",
  5059. "age",
  5060. "expires",
  5061. "date",
  5062. "location",
  5063. "retry-after",
  5064. "vary",
  5065. "warning",
  5066. "content-encoding",
  5067. "content-type",
  5068. "content-range",
  5069. "trailer"};
  5070. case_ignore::unordered_set<std::string> declared_trailers;
  5071. auto trailer_header = get_combined_header_value(src_headers, "Trailer");
  5072. if (!trailer_header.empty()) {
  5073. // split() trims each token and skips empty ones, so the name arrives ready
  5074. // to look up.
  5075. split(trailer_header.data(), trailer_header.data() + trailer_header.size(),
  5076. ',', [&](const char *b, const char *e) {
  5077. // A legitimate message declares only a handful of trailers. Cap the
  5078. // set so a peer cannot grow it without bound: an oversized set only
  5079. // arises from an attempt to force many colliding names into
  5080. // quadratic lookups (case_ignore::hash is unkeyed).
  5081. if (declared_trailers.size() >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  5082. return;
  5083. }
  5084. std::string key(b, e);
  5085. if (prohibited_trailers.find(key) == prohibited_trailers.end()) {
  5086. declared_trailers.insert(key);
  5087. }
  5088. });
  5089. }
  5090. size_t trailer_header_count = 0;
  5091. while (strcmp(line_reader.ptr(), "\r\n") != 0) {
  5092. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  5093. // Count every received trailer field, not only the declared ones stored in
  5094. // dest, so undeclared fields cannot keep this loop running past the limit.
  5095. if (trailer_header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  5096. constexpr auto line_terminator_len = 2;
  5097. auto line_beg = line_reader.ptr();
  5098. auto line_end =
  5099. line_reader.ptr() + line_reader.size() - line_terminator_len;
  5100. if (!parse_header(line_beg, line_end,
  5101. [&](const std::string &key, const std::string &val) {
  5102. if (declared_trailers.find(key) !=
  5103. declared_trailers.end()) {
  5104. dest.emplace(key, val);
  5105. }
  5106. })) {
  5107. return false;
  5108. }
  5109. trailer_header_count++;
  5110. if (!line_reader.getline()) { return false; }
  5111. }
  5112. return true;
  5113. }
  5114. inline std::pair<size_t, size_t> trim(const char *b, const char *e, size_t left,
  5115. size_t right) {
  5116. while (b + left < e && is_space_or_tab(b[left])) {
  5117. left++;
  5118. }
  5119. while (right > 0 && is_space_or_tab(b[right - 1])) {
  5120. right--;
  5121. }
  5122. return std::make_pair(left, right);
  5123. }
  5124. inline std::string trim_copy(const std::string &s) {
  5125. auto r = trim(s.data(), s.data() + s.size(), 0, s.size());
  5126. return s.substr(r.first, r.second - r.first);
  5127. }
  5128. inline std::string trim_double_quotes_copy(const std::string &s) {
  5129. if (s.length() >= 2 && s.front() == '"' && s.back() == '"') {
  5130. return s.substr(1, s.size() - 2);
  5131. }
  5132. return s;
  5133. }
  5134. inline void
  5135. divide(const char *data, std::size_t size, char d,
  5136. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5137. fn) {
  5138. const auto it = std::find(data, data + size, d);
  5139. const auto found = static_cast<std::size_t>(it != data + size);
  5140. const auto lhs_data = data;
  5141. const auto lhs_size = static_cast<std::size_t>(it - data);
  5142. const auto rhs_data = it + found;
  5143. const auto rhs_size = size - lhs_size - found;
  5144. fn(lhs_data, lhs_size, rhs_data, rhs_size);
  5145. }
  5146. inline void
  5147. divide(const std::string &str, char d,
  5148. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5149. fn) {
  5150. divide(str.data(), str.size(), d, std::move(fn));
  5151. }
  5152. inline void split(const char *b, const char *e, char d,
  5153. std::function<void(const char *, const char *)> fn) {
  5154. return split(b, e, d, (std::numeric_limits<size_t>::max)(), std::move(fn));
  5155. }
  5156. inline void split(const char *b, const char *e, char d, size_t m,
  5157. std::function<void(const char *, const char *)> fn) {
  5158. size_t i = 0;
  5159. size_t beg = 0;
  5160. size_t count = 1;
  5161. while (e ? (b + i < e) : (b[i] != '\0')) {
  5162. if (b[i] == d && count < m) {
  5163. auto r = trim(b, e, beg, i);
  5164. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5165. beg = i + 1;
  5166. count++;
  5167. }
  5168. i++;
  5169. }
  5170. if (i) {
  5171. auto r = trim(b, e, beg, i);
  5172. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5173. }
  5174. }
  5175. // Same contract as split(), except that a delimiter inside a quoted-string is
  5176. // not a delimiter. RFC 9110 Section 5.6.6 lets a parameter value be a
  5177. // quoted-string, and ';' and '=' are legal characters inside one.
  5178. inline void split_unquoted(const char *b, const char *e, char d, size_t m,
  5179. std::function<void(const char *, const char *)> fn) {
  5180. size_t i = 0;
  5181. size_t beg = 0;
  5182. size_t count = 1;
  5183. auto in_quotes = false;
  5184. auto has = [&](size_t j) { return e ? (b + j < e) : (b[j] != '\0'); };
  5185. while (has(i)) {
  5186. if (in_quotes && b[i] == '\\' && has(i + 1)) {
  5187. // A quoted-pair, whose second character does not end the string.
  5188. i++;
  5189. } else if (b[i] == '"') {
  5190. in_quotes = !in_quotes;
  5191. } else if (b[i] == d && !in_quotes && count < m) {
  5192. auto r = trim(b, e, beg, i);
  5193. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5194. beg = i + 1;
  5195. count++;
  5196. }
  5197. i++;
  5198. }
  5199. if (i) {
  5200. auto r = trim(b, e, beg, i);
  5201. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5202. }
  5203. }
  5204. inline void split_unquoted(const char *b, const char *e, char d,
  5205. std::function<void(const char *, const char *)> fn) {
  5206. return split_unquoted(b, e, d, (std::numeric_limits<size_t>::max)(),
  5207. std::move(fn));
  5208. }
  5209. // Divide a header parameter at its first '='. RFC 9110 Section 5.6.6 makes the
  5210. // key a token, so the first '=' is the separator even when the value is a
  5211. // quoted-string carrying more of them.
  5212. inline void divide_param_pair(const char *b, const char *e, std::string &key,
  5213. std::string &val) {
  5214. divide(
  5215. b, static_cast<std::size_t>(e - b), '=',
  5216. [&](const char *kb, std::size_t klen, const char *vb, std::size_t vlen) {
  5217. const auto kr = trim(kb, kb + klen, 0, klen);
  5218. key.assign(kb + kr.first, kb + kr.second);
  5219. const auto vr = trim(vb, vb + vlen, 0, vlen);
  5220. val.assign(vb + vr.first, vb + vr.second);
  5221. });
  5222. }
  5223. inline bool split_find(const char *b, const char *e, char d, size_t m,
  5224. std::function<bool(const char *, const char *)> fn) {
  5225. size_t i = 0;
  5226. size_t beg = 0;
  5227. size_t count = 1;
  5228. while (e ? (b + i < e) : (b[i] != '\0')) {
  5229. if (b[i] == d && count < m) {
  5230. auto r = trim(b, e, beg, i);
  5231. if (r.first < r.second) {
  5232. auto found = fn(&b[r.first], &b[r.second]);
  5233. if (found) { return true; }
  5234. }
  5235. beg = i + 1;
  5236. count++;
  5237. }
  5238. i++;
  5239. }
  5240. if (i) {
  5241. auto r = trim(b, e, beg, i);
  5242. if (r.first < r.second) {
  5243. auto found = fn(&b[r.first], &b[r.second]);
  5244. if (found) { return true; }
  5245. }
  5246. }
  5247. return false;
  5248. }
  5249. inline bool split_find(const char *b, const char *e, char d,
  5250. std::function<bool(const char *, const char *)> fn) {
  5251. return split_find(b, e, d, (std::numeric_limits<size_t>::max)(),
  5252. std::move(fn));
  5253. }
  5254. inline stream_line_reader::stream_line_reader(Stream &strm, char *fixed_buffer,
  5255. size_t fixed_buffer_size)
  5256. : strm_(strm), fixed_buffer_(fixed_buffer),
  5257. fixed_buffer_size_(fixed_buffer_size) {}
  5258. inline const char *stream_line_reader::ptr() const {
  5259. if (growable_buffer_.empty()) {
  5260. return fixed_buffer_;
  5261. } else {
  5262. return growable_buffer_.data();
  5263. }
  5264. }
  5265. inline size_t stream_line_reader::size() const {
  5266. if (growable_buffer_.empty()) {
  5267. return fixed_buffer_used_size_;
  5268. } else {
  5269. return growable_buffer_.size();
  5270. }
  5271. }
  5272. inline bool stream_line_reader::end_with_crlf() const {
  5273. auto end = ptr() + size();
  5274. return size() >= 2 && end[-2] == '\r' && end[-1] == '\n';
  5275. }
  5276. inline bool stream_line_reader::getline() {
  5277. fixed_buffer_used_size_ = 0;
  5278. growable_buffer_.clear();
  5279. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5280. char prev_byte = 0;
  5281. #endif
  5282. for (size_t i = 0;; i++) {
  5283. // Fast path: whatever the stream has already buffered can be scanned for
  5284. // the terminator in one pass. Asking for a byte at a time costs a virtual
  5285. // call, a bounds check and a one-byte copy per character of the request.
  5286. size_t buffered_size = 0;
  5287. if (auto buffered = strm_.buffered_data(buffered_size)) {
  5288. auto take = buffered_size;
  5289. auto terminated = false;
  5290. for (size_t at = 0; at < buffered_size;) {
  5291. auto nl = static_cast<const char *>(
  5292. memchr(buffered + at, '\n', buffered_size - at));
  5293. if (!nl) { break; }
  5294. auto pos = static_cast<size_t>(nl - buffered);
  5295. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5296. take = pos + 1;
  5297. terminated = true;
  5298. break;
  5299. #else
  5300. // A bare LF does not end the line; keep looking for CRLF. The CR may
  5301. // be the last byte of an earlier chunk, hence prev_byte.
  5302. if ((pos > 0 ? buffered[pos - 1] : prev_byte) == '\r') {
  5303. take = pos + 1;
  5304. terminated = true;
  5305. break;
  5306. }
  5307. at = pos + 1;
  5308. #endif
  5309. }
  5310. if (size() + take > CPPHTTPLIB_MAX_LINE_LENGTH) { return false; }
  5311. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5312. prev_byte = buffered[take - 1];
  5313. #endif
  5314. append(buffered, take);
  5315. strm_.consume_buffered(take);
  5316. i += take;
  5317. if (terminated) { return true; }
  5318. continue;
  5319. }
  5320. if (size() >= CPPHTTPLIB_MAX_LINE_LENGTH) {
  5321. // Treat exceptionally long lines as an error to
  5322. // prevent infinite loops/memory exhaustion
  5323. return false;
  5324. }
  5325. char byte;
  5326. auto n = strm_.read(&byte, 1);
  5327. if (n < 0) {
  5328. return false;
  5329. } else if (n == 0) {
  5330. if (i == 0) {
  5331. return false;
  5332. } else {
  5333. break;
  5334. }
  5335. }
  5336. append(byte);
  5337. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5338. if (byte == '\n') { break; }
  5339. #else
  5340. if (prev_byte == '\r' && byte == '\n') { break; }
  5341. prev_byte = byte;
  5342. #endif
  5343. }
  5344. return true;
  5345. }
  5346. inline void stream_line_reader::append(char c) { append(&c, 1); }
  5347. inline void stream_line_reader::append(const char *data, size_t size) {
  5348. // Once the line has outgrown the fixed buffer everything must keep going to
  5349. // the growable one, even if a later chunk would have fit. Without the
  5350. // emptiness check a short append after a long one would land in the fixed
  5351. // buffer, which ptr() and size() no longer look at, and be lost.
  5352. if (growable_buffer_.empty() &&
  5353. fixed_buffer_used_size_ + size < fixed_buffer_size_) {
  5354. memcpy(fixed_buffer_ + fixed_buffer_used_size_, data, size);
  5355. fixed_buffer_used_size_ += size;
  5356. fixed_buffer_[fixed_buffer_used_size_] = '\0';
  5357. } else {
  5358. // Unlike the per-character overload, this can be the very first append of
  5359. // the line, so the fixed buffer may hold nothing and carry no terminator
  5360. // yet. assign() takes an explicit length and does not need one.
  5361. if (growable_buffer_.empty()) {
  5362. growable_buffer_.assign(fixed_buffer_, fixed_buffer_used_size_);
  5363. }
  5364. growable_buffer_.append(data, size);
  5365. }
  5366. }
  5367. inline mmap::mmap(const char *path) { open(path); }
  5368. inline mmap::~mmap() { close(); }
  5369. inline bool mmap::open(const char *path) {
  5370. close();
  5371. #if defined(_WIN32)
  5372. auto wpath = u8string_to_wstring(path);
  5373. if (wpath.empty()) { return false; }
  5374. hFile_ =
  5375. ::CreateFile2(wpath.c_str(), GENERIC_READ,
  5376. FILE_SHARE_READ | FILE_SHARE_WRITE, OPEN_EXISTING, NULL);
  5377. if (hFile_ == INVALID_HANDLE_VALUE) { return false; }
  5378. LARGE_INTEGER size{};
  5379. if (!::GetFileSizeEx(hFile_, &size)) { return false; }
  5380. // If the following line doesn't compile due to QuadPart, update Windows SDK.
  5381. // See:
  5382. // https://github.com/yhirose/cpp-httplib/issues/1903#issuecomment-2316520721
  5383. if (static_cast<ULONGLONG>(size.QuadPart) >
  5384. (std::numeric_limits<decltype(size_)>::max)()) {
  5385. // `size_t` might be 32-bits, on 32-bits Windows.
  5386. return false;
  5387. }
  5388. size_ = static_cast<size_t>(size.QuadPart);
  5389. hMapping_ =
  5390. ::CreateFileMappingFromApp(hFile_, NULL, PAGE_READONLY, size_, NULL);
  5391. // Special treatment for an empty file...
  5392. if (hMapping_ == NULL && size_ == 0) {
  5393. close();
  5394. is_open_empty_file = true;
  5395. return true;
  5396. }
  5397. if (hMapping_ == NULL) {
  5398. close();
  5399. return false;
  5400. }
  5401. addr_ = ::MapViewOfFileFromApp(hMapping_, FILE_MAP_READ, 0, 0);
  5402. if (addr_ == nullptr) {
  5403. close();
  5404. return false;
  5405. }
  5406. #else
  5407. fd_ = ::open(path, O_RDONLY);
  5408. if (fd_ == -1) { return false; }
  5409. struct stat sb;
  5410. if (fstat(fd_, &sb) == -1) {
  5411. close();
  5412. return false;
  5413. }
  5414. size_ = static_cast<size_t>(sb.st_size);
  5415. addr_ = ::mmap(NULL, size_, PROT_READ, MAP_PRIVATE, fd_, 0);
  5416. // Special treatment for an empty file...
  5417. if (addr_ == MAP_FAILED && size_ == 0) {
  5418. close();
  5419. is_open_empty_file = true;
  5420. return false;
  5421. }
  5422. if (addr_ == MAP_FAILED) {
  5423. // Clear the sentinel before `close()`, since `is_open()` only checks
  5424. // `addr_` against nullptr and `munmap()` must not be called with it.
  5425. addr_ = nullptr;
  5426. close();
  5427. return false;
  5428. }
  5429. #endif
  5430. return true;
  5431. }
  5432. inline bool mmap::is_open() const {
  5433. return is_open_empty_file ? true : addr_ != nullptr;
  5434. }
  5435. inline size_t mmap::size() const { return size_; }
  5436. inline const char *mmap::data() const {
  5437. return is_open_empty_file ? "" : static_cast<const char *>(addr_);
  5438. }
  5439. inline void mmap::close() {
  5440. #if defined(_WIN32)
  5441. if (addr_) {
  5442. ::UnmapViewOfFile(addr_);
  5443. addr_ = nullptr;
  5444. }
  5445. if (hMapping_) {
  5446. ::CloseHandle(hMapping_);
  5447. hMapping_ = NULL;
  5448. }
  5449. if (hFile_ != INVALID_HANDLE_VALUE) {
  5450. ::CloseHandle(hFile_);
  5451. hFile_ = INVALID_HANDLE_VALUE;
  5452. }
  5453. is_open_empty_file = false;
  5454. #else
  5455. if (addr_ != nullptr) {
  5456. munmap(addr_, size_);
  5457. addr_ = nullptr;
  5458. }
  5459. if (fd_ != -1) {
  5460. ::close(fd_);
  5461. fd_ = -1;
  5462. }
  5463. #endif
  5464. size_ = 0;
  5465. }
  5466. inline int close_socket(socket_t sock) noexcept {
  5467. #ifdef _WIN32
  5468. return closesocket(sock);
  5469. #else
  5470. return close(sock);
  5471. #endif
  5472. }
  5473. template <typename T> inline ssize_t handle_EINTR(T fn) {
  5474. ssize_t res = 0;
  5475. while (true) {
  5476. res = fn();
  5477. if (res < 0 && errno == EINTR) {
  5478. std::this_thread::sleep_for(std::chrono::microseconds{1});
  5479. continue;
  5480. }
  5481. break;
  5482. }
  5483. return res;
  5484. }
  5485. inline size_t mmap::read(size_t offset, char *buf, size_t len) const {
  5486. if (offset >= size_) { return 0; }
  5487. len = (std::min)(len, size_ - offset);
  5488. #if defined(_WIN32)
  5489. // Windows does not let a mapped file be truncated.
  5490. std::memcpy(buf, static_cast<const char *>(addr_) + offset, len);
  5491. return len;
  5492. #else
  5493. auto n = handle_EINTR(
  5494. [&]() { return ::pread(fd_, buf, len, static_cast<off_t>(offset)); });
  5495. return n > 0 ? static_cast<size_t>(n) : 0;
  5496. #endif
  5497. }
  5498. inline ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags) {
  5499. return handle_EINTR([&]() {
  5500. return recv(sock,
  5501. #ifdef _WIN32
  5502. static_cast<char *>(ptr), static_cast<int>(size),
  5503. #else
  5504. ptr, size,
  5505. #endif
  5506. flags);
  5507. });
  5508. }
  5509. inline ssize_t send_socket(socket_t sock, const void *ptr, size_t size,
  5510. int flags) {
  5511. return handle_EINTR([&]() {
  5512. return send(sock,
  5513. #ifdef _WIN32
  5514. static_cast<const char *>(ptr), static_cast<int>(size),
  5515. #else
  5516. ptr, size,
  5517. #endif
  5518. flags);
  5519. });
  5520. }
  5521. inline int poll_wrapper(struct pollfd *fds, nfds_t nfds, int timeout) {
  5522. #ifdef _WIN32
  5523. return ::WSAPoll(fds, nfds, timeout);
  5524. #else
  5525. return ::poll(fds, nfds, timeout);
  5526. #endif
  5527. }
  5528. inline ssize_t select_impl(socket_t sock, short events, time_t sec,
  5529. time_t usec) {
  5530. struct pollfd pfd;
  5531. pfd.fd = sock;
  5532. pfd.events = events;
  5533. pfd.revents = 0;
  5534. // A negative timeout waits forever, poll's own convention. 0 keeps meaning
  5535. // "return immediately", which callers here rely on to probe a socket.
  5536. auto timeout = sec < 0 ? -1 : static_cast<int>(sec * 1000 + usec / 1000);
  5537. return handle_EINTR([&]() { return poll_wrapper(&pfd, 1, timeout); });
  5538. }
  5539. inline ssize_t select_read(socket_t sock, time_t sec, time_t usec) {
  5540. return select_impl(sock, POLLIN, sec, usec);
  5541. }
  5542. inline ssize_t select_write(socket_t sock, time_t sec, time_t usec) {
  5543. return select_impl(sock, POLLOUT, sec, usec);
  5544. }
  5545. // The point sec and usec from now, for select_until(). A negative sec never
  5546. // comes, as a negative timeout waits forever in select_impl().
  5547. inline std::chrono::steady_clock::time_point deadline_after(time_t sec,
  5548. time_t usec) {
  5549. if (sec < 0) { return std::chrono::steady_clock::time_point::max(); }
  5550. return std::chrono::steady_clock::now() + std::chrono::seconds(sec) +
  5551. std::chrono::microseconds(usec);
  5552. }
  5553. // Waits only for the time left until deadline, so that all the waits of one
  5554. // TLS handshake come out of a single timeout.
  5555. inline ssize_t select_until(socket_t sock, short events,
  5556. std::chrono::steady_clock::time_point deadline) {
  5557. if (deadline == std::chrono::steady_clock::time_point::max()) {
  5558. return select_impl(sock, events, -1, 0);
  5559. }
  5560. auto left = std::chrono::duration_cast<std::chrono::microseconds>(
  5561. deadline - std::chrono::steady_clock::now())
  5562. .count();
  5563. if (left <= 0) { return 0; }
  5564. return select_impl(sock, events, static_cast<time_t>(left / 1000000),
  5565. static_cast<time_t>(left % 1000000));
  5566. }
  5567. inline Error wait_until_socket_is_ready(socket_t sock, time_t sec,
  5568. time_t usec) {
  5569. struct pollfd pfd_read;
  5570. pfd_read.fd = sock;
  5571. pfd_read.events = POLLIN | POLLOUT;
  5572. pfd_read.revents = 0;
  5573. auto timeout = static_cast<int>(sec * 1000 + usec / 1000);
  5574. auto poll_res =
  5575. handle_EINTR([&]() { return poll_wrapper(&pfd_read, 1, timeout); });
  5576. if (poll_res == 0) { return Error::ConnectionTimeout; }
  5577. if (poll_res > 0 && pfd_read.revents & (POLLIN | POLLOUT)) {
  5578. auto error = 0;
  5579. socklen_t len = sizeof(error);
  5580. auto res = getsockopt(sock, SOL_SOCKET, SO_ERROR,
  5581. reinterpret_cast<char *>(&error), &len);
  5582. auto successful = res >= 0 && !error;
  5583. return successful ? Error::Success : Error::Connection;
  5584. }
  5585. return Error::Connection;
  5586. }
  5587. inline bool is_socket_alive(socket_t sock) {
  5588. const auto val = detail::select_read(sock, 0, 0);
  5589. if (val == 0) {
  5590. return true;
  5591. } else if (val < 0 && errno == EBADF) {
  5592. return false;
  5593. }
  5594. char buf[1];
  5595. return detail::read_socket(sock, &buf[0], sizeof(buf), MSG_PEEK) > 0;
  5596. }
  5597. class SocketStream final : public Stream {
  5598. public:
  5599. SocketStream(socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5600. time_t write_timeout_sec, time_t write_timeout_usec,
  5601. time_t max_timeout_msec = 0,
  5602. std::chrono::time_point<std::chrono::steady_clock> start_time =
  5603. (std::chrono::steady_clock::time_point::min)());
  5604. ~SocketStream() override;
  5605. bool is_readable() const override;
  5606. bool wait_readable() const override;
  5607. bool wait_writable() const override;
  5608. bool is_peer_alive() const override;
  5609. ssize_t read(char *ptr, size_t size) override;
  5610. ssize_t write(const char *ptr, size_t size) override;
  5611. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  5612. void get_local_ip_and_port(std::string &ip, int &port) const override;
  5613. socket_t socket() const override;
  5614. time_t duration() const override;
  5615. void set_read_timeout(time_t sec, time_t usec = 0) override;
  5616. void set_max_timeout(time_t msec) override;
  5617. const char *buffered_data(size_t &size) const override;
  5618. void consume_buffered(size_t size) override;
  5619. // The caller has just seen this socket become readable. Lets the next read
  5620. // skip its own readiness wait, which would otherwise ask the kernel a
  5621. // question that was answered a moment ago. Consumed by that read.
  5622. void set_readable_hint() { readable_hint_ = true; }
  5623. private:
  5624. bool ensure_readable();
  5625. socket_t sock_;
  5626. // Atomic because ws::WebSocket::set_read_timeout() reaches this from another
  5627. // thread while a read is in flight -- that is the point of it, for a caller
  5628. // holding one connection and wanting control back to send on it.
  5629. std::atomic<time_t> read_timeout_sec_;
  5630. std::atomic<time_t> read_timeout_usec_;
  5631. time_t write_timeout_sec_;
  5632. time_t write_timeout_usec_;
  5633. time_t max_timeout_msec_;
  5634. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  5635. std::vector<char> read_buff_;
  5636. size_t read_buff_off_ = 0;
  5637. size_t read_buff_content_size_ = 0;
  5638. bool readable_hint_ = false;
  5639. static const size_t read_buff_size_ = 1024l * 4;
  5640. };
  5641. inline bool keep_alive(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5642. time_t keep_alive_timeout_sec) {
  5643. using namespace std::chrono;
  5644. const auto interval_usec =
  5645. CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND;
  5646. // Avoid expensive `steady_clock::now()` call for the first time
  5647. if (select_read(sock, 0, interval_usec) > 0) { return true; }
  5648. const auto start = steady_clock::now() - microseconds{interval_usec};
  5649. const auto timeout = seconds{keep_alive_timeout_sec};
  5650. while (true) {
  5651. if (svr_sock == INVALID_SOCKET) {
  5652. break; // Server socket is closed
  5653. }
  5654. auto val = select_read(sock, 0, interval_usec);
  5655. if (val < 0) {
  5656. break; // Ssocket error
  5657. } else if (val == 0) {
  5658. if (steady_clock::now() - start > timeout) {
  5659. break; // Timeout
  5660. }
  5661. } else {
  5662. return true; // Ready for read
  5663. }
  5664. }
  5665. return false;
  5666. }
  5667. // `has_buffered_request` reports whether the connection's stream already holds
  5668. // bytes of the next request. A client may pipeline its requests (RFC 9112
  5669. // 9.3.2), so reading one request can pull the start of the next one into the
  5670. // stream's buffer; that request must be served without waiting for the socket
  5671. // to become readable again, since its bytes are no longer on the socket.
  5672. // `callback` is told whether keep_alive() has just seen the socket go readable.
  5673. template <typename P, typename T>
  5674. inline bool process_server_socket_core(const std::atomic<socket_t> &svr_sock,
  5675. socket_t sock,
  5676. size_t keep_alive_max_count,
  5677. time_t keep_alive_timeout_sec,
  5678. P has_buffered_request, T callback) {
  5679. assert(keep_alive_max_count > 0);
  5680. auto ret = false;
  5681. auto count = keep_alive_max_count;
  5682. while (count > 0) {
  5683. auto socket_readable = false;
  5684. if (!has_buffered_request()) {
  5685. if (!keep_alive(svr_sock, sock, keep_alive_timeout_sec)) { break; }
  5686. socket_readable = true;
  5687. }
  5688. auto close_connection = count == 1;
  5689. auto connection_closed = false;
  5690. ret = callback(socket_readable, close_connection, connection_closed);
  5691. if (!ret || connection_closed) { break; }
  5692. count--;
  5693. }
  5694. return ret;
  5695. }
  5696. template <typename T>
  5697. inline bool
  5698. process_server_socket(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5699. size_t keep_alive_max_count,
  5700. time_t keep_alive_timeout_sec, time_t read_timeout_sec,
  5701. time_t read_timeout_usec, time_t write_timeout_sec,
  5702. time_t write_timeout_usec, T callback) {
  5703. // One stream per connection: its read buffer can already hold the start of
  5704. // the next, pipelined request.
  5705. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5706. write_timeout_sec, write_timeout_usec);
  5707. return process_server_socket_core(
  5708. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  5709. [&]() { return strm.is_readable(); },
  5710. [&](bool socket_readable, bool close_connection,
  5711. bool &connection_closed) {
  5712. if (socket_readable) { strm.set_readable_hint(); }
  5713. return callback(strm, close_connection, connection_closed);
  5714. });
  5715. }
  5716. inline bool process_client_socket(
  5717. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5718. time_t write_timeout_sec, time_t write_timeout_usec,
  5719. time_t max_timeout_msec,
  5720. std::chrono::time_point<std::chrono::steady_clock> start_time,
  5721. std::function<bool(Stream &)> callback) {
  5722. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5723. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  5724. start_time);
  5725. return callback(strm);
  5726. }
  5727. inline int shutdown_socket(socket_t sock) noexcept {
  5728. #ifdef _WIN32
  5729. return shutdown(sock, SD_BOTH);
  5730. #else
  5731. return shutdown(sock, SHUT_RDWR);
  5732. #endif
  5733. }
  5734. // Half-closes the write side and drains any in-flight/queued bytes before
  5735. // the final shutdown+close. Closing with unread data in the receive queue
  5736. // (or bytes arriving after the receive side is closed) makes the stack send
  5737. // an abortive RST instead of a graceful FIN, which can make the peer see the
  5738. // response as a failed read even though it was fully written.
  5739. inline void drain_and_close_socket(socket_t sock) noexcept {
  5740. #ifdef _WIN32
  5741. shutdown(sock, SD_SEND);
  5742. #else
  5743. shutdown(sock, SHUT_WR);
  5744. #endif
  5745. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  5746. size_t total = 0;
  5747. const auto deadline = std::chrono::steady_clock::now() +
  5748. std::chrono::milliseconds(100); // bound #1
  5749. while (total < size_t(1024u * 1024u)) { // bound #2
  5750. const auto remaining =
  5751. std::chrono::duration_cast<std::chrono::microseconds>(
  5752. deadline - std::chrono::steady_clock::now())
  5753. .count();
  5754. if (remaining <= 0) { break; }
  5755. if (select_read(sock, 0, static_cast<time_t>(remaining)) <= 0) { break; }
  5756. const auto n = read_socket(sock, buf, sizeof(buf), CPPHTTPLIB_RECV_FLAGS);
  5757. if (n <= 0) { break; }
  5758. total += static_cast<size_t>(n);
  5759. }
  5760. shutdown_socket(sock);
  5761. close_socket(sock);
  5762. }
  5763. inline std::string escape_abstract_namespace_unix_domain(const std::string &s) {
  5764. if (s.size() > 1 && s[0] == '\0') {
  5765. auto ret = s;
  5766. ret[0] = '@';
  5767. return ret;
  5768. }
  5769. return s;
  5770. }
  5771. inline std::string
  5772. unescape_abstract_namespace_unix_domain(const std::string &s) {
  5773. if (s.size() > 1 && s[0] == '@') {
  5774. auto ret = s;
  5775. ret[0] = '\0';
  5776. return ret;
  5777. }
  5778. return s;
  5779. }
  5780. inline int getaddrinfo_with_timeout(const char *node, const char *service,
  5781. const struct addrinfo *hints,
  5782. struct addrinfo **res, time_t timeout_sec) {
  5783. #ifdef CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO
  5784. if (timeout_sec <= 0) {
  5785. // No timeout specified, use standard getaddrinfo
  5786. return getaddrinfo(node, service, hints, res);
  5787. }
  5788. #ifdef _WIN32
  5789. // Windows-specific implementation using GetAddrInfoEx with overlapped I/O
  5790. OVERLAPPED overlapped = {};
  5791. HANDLE event = CreateEventW(nullptr, TRUE, FALSE, nullptr);
  5792. if (!event) { return EAI_FAIL; }
  5793. overlapped.hEvent = event;
  5794. PADDRINFOEXW result_addrinfo = nullptr;
  5795. HANDLE cancel_handle = nullptr;
  5796. ADDRINFOEXW hints_ex = {};
  5797. if (hints) {
  5798. hints_ex.ai_flags = hints->ai_flags;
  5799. hints_ex.ai_family = hints->ai_family;
  5800. hints_ex.ai_socktype = hints->ai_socktype;
  5801. hints_ex.ai_protocol = hints->ai_protocol;
  5802. }
  5803. auto wnode = u8string_to_wstring(node);
  5804. auto wservice = u8string_to_wstring(service);
  5805. auto ret = ::GetAddrInfoExW(wnode.data(), wservice.data(), NS_DNS, nullptr,
  5806. hints ? &hints_ex : nullptr, &result_addrinfo,
  5807. nullptr, &overlapped, nullptr, &cancel_handle);
  5808. if (ret == WSA_IO_PENDING) {
  5809. auto wait_result =
  5810. ::WaitForSingleObject(event, static_cast<DWORD>(timeout_sec * 1000));
  5811. if (wait_result == WAIT_TIMEOUT) {
  5812. if (cancel_handle) { ::GetAddrInfoExCancel(&cancel_handle); }
  5813. ::CloseHandle(event);
  5814. return EAI_AGAIN;
  5815. }
  5816. DWORD bytes_returned;
  5817. if (!::GetOverlappedResult((HANDLE)INVALID_SOCKET, &overlapped,
  5818. &bytes_returned, FALSE)) {
  5819. ::CloseHandle(event);
  5820. return ::WSAGetLastError();
  5821. }
  5822. }
  5823. ::CloseHandle(event);
  5824. if (ret == NO_ERROR || ret == WSA_IO_PENDING) {
  5825. *res = reinterpret_cast<struct addrinfo *>(result_addrinfo);
  5826. return 0;
  5827. }
  5828. return ret;
  5829. #elif TARGET_OS_MAC && defined(__clang__)
  5830. if (!node) { return EAI_NONAME; }
  5831. // macOS implementation using CFHost API for asynchronous DNS resolution
  5832. CFStringRef hostname_ref = CFStringCreateWithCString(
  5833. kCFAllocatorDefault, node, kCFStringEncodingUTF8);
  5834. if (!hostname_ref) { return EAI_MEMORY; }
  5835. CFHostRef host_ref = CFHostCreateWithName(kCFAllocatorDefault, hostname_ref);
  5836. CFRelease(hostname_ref);
  5837. if (!host_ref) { return EAI_MEMORY; }
  5838. // Set up context for callback
  5839. struct CFHostContext {
  5840. bool completed = false;
  5841. bool success = false;
  5842. CFArrayRef addresses = nullptr;
  5843. std::mutex mutex;
  5844. std::condition_variable cv;
  5845. } context;
  5846. CFHostClientContext client_context;
  5847. memset(&client_context, 0, sizeof(client_context));
  5848. client_context.info = &context;
  5849. // Set callback
  5850. auto callback = [](CFHostRef theHost, CFHostInfoType /*typeInfo*/,
  5851. const CFStreamError *error, void *info) {
  5852. auto ctx = static_cast<CFHostContext *>(info);
  5853. std::lock_guard<std::mutex> lock(ctx->mutex);
  5854. if (error && error->error != 0) {
  5855. ctx->success = false;
  5856. } else {
  5857. Boolean hasBeenResolved;
  5858. ctx->addresses = CFHostGetAddressing(theHost, &hasBeenResolved);
  5859. if (ctx->addresses && hasBeenResolved) {
  5860. CFRetain(ctx->addresses);
  5861. ctx->success = true;
  5862. } else {
  5863. ctx->success = false;
  5864. }
  5865. }
  5866. ctx->completed = true;
  5867. ctx->cv.notify_one();
  5868. };
  5869. if (!CFHostSetClient(host_ref, callback, &client_context)) {
  5870. CFRelease(host_ref);
  5871. return EAI_SYSTEM;
  5872. }
  5873. // Schedule on run loop
  5874. CFRunLoopRef run_loop = CFRunLoopGetCurrent();
  5875. CFHostScheduleWithRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5876. // Start resolution
  5877. CFStreamError stream_error;
  5878. if (!CFHostStartInfoResolution(host_ref, kCFHostAddresses, &stream_error)) {
  5879. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5880. CFRelease(host_ref);
  5881. return EAI_FAIL;
  5882. }
  5883. // Wait for completion with timeout
  5884. auto timeout_time =
  5885. std::chrono::steady_clock::now() + std::chrono::seconds(timeout_sec);
  5886. bool timed_out = false;
  5887. {
  5888. std::unique_lock<std::mutex> lock(context.mutex);
  5889. while (!context.completed) {
  5890. auto now = std::chrono::steady_clock::now();
  5891. if (now >= timeout_time) {
  5892. timed_out = true;
  5893. break;
  5894. }
  5895. // Run the runloop for a short time
  5896. lock.unlock();
  5897. CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.1, true);
  5898. lock.lock();
  5899. }
  5900. }
  5901. // Clean up
  5902. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5903. CFHostSetClient(host_ref, nullptr, nullptr);
  5904. if (timed_out || !context.completed) {
  5905. CFHostCancelInfoResolution(host_ref, kCFHostAddresses);
  5906. CFRelease(host_ref);
  5907. return EAI_AGAIN;
  5908. }
  5909. if (!context.success || !context.addresses) {
  5910. CFRelease(host_ref);
  5911. return EAI_NODATA;
  5912. }
  5913. // Convert CFArray to addrinfo
  5914. CFIndex count = CFArrayGetCount(context.addresses);
  5915. if (count == 0) {
  5916. CFRelease(context.addresses);
  5917. CFRelease(host_ref);
  5918. return EAI_NODATA;
  5919. }
  5920. struct addrinfo *result_addrinfo = nullptr;
  5921. struct addrinfo **current = &result_addrinfo;
  5922. for (CFIndex i = 0; i < count; i++) {
  5923. CFDataRef addr_data =
  5924. static_cast<CFDataRef>(CFArrayGetValueAtIndex(context.addresses, i));
  5925. if (!addr_data) continue;
  5926. const struct sockaddr *sockaddr_ptr =
  5927. reinterpret_cast<const struct sockaddr *>(CFDataGetBytePtr(addr_data));
  5928. socklen_t sockaddr_len = static_cast<socklen_t>(CFDataGetLength(addr_data));
  5929. // Allocate addrinfo structure
  5930. *current = static_cast<struct addrinfo *>(malloc(sizeof(struct addrinfo)));
  5931. if (!*current) {
  5932. freeaddrinfo(result_addrinfo);
  5933. CFRelease(context.addresses);
  5934. CFRelease(host_ref);
  5935. return EAI_MEMORY;
  5936. }
  5937. memset(*current, 0, sizeof(struct addrinfo));
  5938. // Set up addrinfo fields
  5939. (*current)->ai_family = sockaddr_ptr->sa_family;
  5940. (*current)->ai_socktype = hints ? hints->ai_socktype : SOCK_STREAM;
  5941. (*current)->ai_protocol = hints ? hints->ai_protocol : IPPROTO_TCP;
  5942. (*current)->ai_addrlen = sockaddr_len;
  5943. // Copy sockaddr
  5944. (*current)->ai_addr = static_cast<struct sockaddr *>(malloc(sockaddr_len));
  5945. if (!(*current)->ai_addr) {
  5946. freeaddrinfo(result_addrinfo);
  5947. CFRelease(context.addresses);
  5948. CFRelease(host_ref);
  5949. return EAI_MEMORY;
  5950. }
  5951. memcpy((*current)->ai_addr, sockaddr_ptr, sockaddr_len);
  5952. // Set port if service is specified
  5953. if (service && *service) {
  5954. int port = 0;
  5955. if (parse_port(service, strlen(service), port)) {
  5956. if (sockaddr_ptr->sa_family == AF_INET) {
  5957. reinterpret_cast<struct sockaddr_in *>((*current)->ai_addr)
  5958. ->sin_port = htons(static_cast<uint16_t>(port));
  5959. } else if (sockaddr_ptr->sa_family == AF_INET6) {
  5960. reinterpret_cast<struct sockaddr_in6 *>((*current)->ai_addr)
  5961. ->sin6_port = htons(static_cast<uint16_t>(port));
  5962. }
  5963. }
  5964. }
  5965. current = &((*current)->ai_next);
  5966. }
  5967. CFRelease(context.addresses);
  5968. CFRelease(host_ref);
  5969. *res = result_addrinfo;
  5970. return 0;
  5971. #elif defined(_GNU_SOURCE) && defined(__GLIBC__) && \
  5972. (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 2)) && \
  5973. !defined(CPPHTTPLIB_THREAD_SANITIZER)
  5974. // Skipped under TSan: glibc's internal resolver thread is invisible to it.
  5975. // #2431: gai_cancel() is non-blocking and may return EAI_NOTCANCELED while
  5976. // the resolver worker still references the stack-local gaicb. The cancel
  5977. // path therefore waits (gai_suspend with no timeout) for the worker to
  5978. // actually finish before letting the stack frame go. The trade-off is that
  5979. // a wedged DNS server can hold this thread for the system resolver timeout
  5980. // (~30s by default) past the caller's connection timeout.
  5981. struct gaicb request{};
  5982. struct gaicb *requests[1] = {&request};
  5983. struct sigevent sevp{};
  5984. struct timespec timeout{timeout_sec, 0};
  5985. request.ar_name = node;
  5986. request.ar_service = service;
  5987. request.ar_request = hints;
  5988. sevp.sigev_notify = SIGEV_NONE;
  5989. int rc = getaddrinfo_a(GAI_NOWAIT, requests, 1, &sevp);
  5990. if (rc != 0) { return rc; }
  5991. auto cleanup = scope_exit([&] {
  5992. if (request.ar_result) { freeaddrinfo(request.ar_result); }
  5993. });
  5994. int wait_result = gai_suspend(requests, 1, &timeout);
  5995. if (wait_result == 0 || wait_result == EAI_ALLDONE) {
  5996. int gai_result = gai_error(&request);
  5997. if (gai_result == 0) {
  5998. *res = request.ar_result;
  5999. request.ar_result = nullptr;
  6000. return 0;
  6001. }
  6002. return gai_result;
  6003. }
  6004. gai_cancel(&request);
  6005. while (gai_error(&request) == EAI_INPROGRESS) {
  6006. gai_suspend(requests, 1, nullptr);
  6007. }
  6008. return wait_result;
  6009. #else
  6010. // Fallback implementation using thread-based timeout for other Unix systems.
  6011. struct GetAddrInfoState {
  6012. ~GetAddrInfoState() {
  6013. if (info) { freeaddrinfo(info); }
  6014. }
  6015. std::mutex mutex;
  6016. std::condition_variable result_cv;
  6017. bool completed = false;
  6018. int result = EAI_SYSTEM;
  6019. std::string node;
  6020. std::string service;
  6021. struct addrinfo hints;
  6022. struct addrinfo *info = nullptr;
  6023. };
  6024. // Allocate on the heap, so the resolver thread can keep using the data.
  6025. auto state = std::make_shared<GetAddrInfoState>();
  6026. if (node) { state->node = node; }
  6027. state->service = service;
  6028. state->hints = *hints;
  6029. std::thread resolve_thread([state]() {
  6030. auto thread_result =
  6031. getaddrinfo(state->node.c_str(), state->service.c_str(), &state->hints,
  6032. &state->info);
  6033. std::lock_guard<std::mutex> lock(state->mutex);
  6034. state->result = thread_result;
  6035. state->completed = true;
  6036. state->result_cv.notify_one();
  6037. });
  6038. // Wait for completion or timeout
  6039. std::unique_lock<std::mutex> lock(state->mutex);
  6040. auto finished =
  6041. state->result_cv.wait_for(lock, std::chrono::seconds(timeout_sec),
  6042. [&] { return state->completed; });
  6043. if (finished) {
  6044. // Operation completed within timeout
  6045. resolve_thread.join();
  6046. *res = state->info;
  6047. state->info = nullptr; // Pass ownership to caller
  6048. return state->result;
  6049. } else {
  6050. // Timeout occurred
  6051. resolve_thread.detach(); // Let the thread finish in background
  6052. return EAI_AGAIN; // Return timeout error
  6053. }
  6054. #endif
  6055. #else
  6056. (void)(timeout_sec); // Unused parameter for non-blocking getaddrinfo
  6057. return getaddrinfo(node, service, hints, res);
  6058. #endif
  6059. }
  6060. template <typename BindOrConnect>
  6061. socket_t create_socket(const std::string &host, const std::string &ip, int port,
  6062. int address_family, int socket_flags, bool tcp_nodelay,
  6063. bool ipv6_v6only, SocketOptions socket_options,
  6064. BindOrConnect bind_or_connect, time_t timeout_sec = 0) {
  6065. // Get address info
  6066. const char *node = nullptr;
  6067. struct addrinfo hints;
  6068. struct addrinfo *result;
  6069. memset(&hints, 0, sizeof(struct addrinfo));
  6070. hints.ai_socktype = SOCK_STREAM;
  6071. hints.ai_protocol = IPPROTO_IP;
  6072. if (!ip.empty()) {
  6073. node = ip.c_str();
  6074. // Ask getaddrinfo to convert IP in c-string to address
  6075. hints.ai_family = AF_UNSPEC;
  6076. hints.ai_flags = AI_NUMERICHOST;
  6077. } else {
  6078. if (!host.empty()) { node = host.c_str(); }
  6079. hints.ai_family = address_family;
  6080. hints.ai_flags = socket_flags;
  6081. }
  6082. #if !defined(_WIN32) || defined(CPPHTTPLIB_HAVE_AFUNIX_H)
  6083. if (hints.ai_family == AF_UNIX) {
  6084. const auto addrlen = host.length();
  6085. if (addrlen > sizeof(sockaddr_un::sun_path)) { return INVALID_SOCKET; }
  6086. #ifdef SOCK_CLOEXEC
  6087. auto sock = socket(hints.ai_family, hints.ai_socktype | SOCK_CLOEXEC,
  6088. hints.ai_protocol);
  6089. #else
  6090. auto sock = socket(hints.ai_family, hints.ai_socktype, hints.ai_protocol);
  6091. #endif
  6092. if (sock != INVALID_SOCKET) {
  6093. sockaddr_un addr{};
  6094. addr.sun_family = AF_UNIX;
  6095. auto unescaped_host = unescape_abstract_namespace_unix_domain(host);
  6096. std::copy(unescaped_host.begin(), unescaped_host.end(), addr.sun_path);
  6097. hints.ai_addr = reinterpret_cast<sockaddr *>(&addr);
  6098. hints.ai_addrlen = static_cast<socklen_t>(
  6099. sizeof(addr) - sizeof(addr.sun_path) + addrlen);
  6100. #ifndef SOCK_CLOEXEC
  6101. #ifndef _WIN32
  6102. fcntl(sock, F_SETFD, FD_CLOEXEC);
  6103. #endif
  6104. #endif
  6105. if (socket_options) { socket_options(sock); }
  6106. #ifdef _WIN32
  6107. // Setting SO_REUSEADDR seems not to work well with AF_UNIX on windows, so
  6108. // remove the option.
  6109. set_socket_opt(sock, SOL_SOCKET, SO_REUSEADDR, 0);
  6110. #endif
  6111. bool dummy;
  6112. if (!bind_or_connect(sock, hints, dummy)) {
  6113. close_socket(sock);
  6114. sock = INVALID_SOCKET;
  6115. }
  6116. }
  6117. return sock;
  6118. }
  6119. #endif
  6120. auto service = std::to_string(port);
  6121. if (getaddrinfo_with_timeout(node, service.c_str(), &hints, &result,
  6122. timeout_sec)) {
  6123. #if defined __linux__ && !defined __ANDROID__
  6124. res_init();
  6125. #endif
  6126. return INVALID_SOCKET;
  6127. }
  6128. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6129. for (auto rp = result; rp; rp = rp->ai_next) {
  6130. // Create a socket
  6131. #ifdef _WIN32
  6132. auto sock =
  6133. WSASocketW(rp->ai_family, rp->ai_socktype, rp->ai_protocol, nullptr, 0,
  6134. WSA_FLAG_NO_HANDLE_INHERIT | WSA_FLAG_OVERLAPPED);
  6135. /**
  6136. * Since the WSA_FLAG_NO_HANDLE_INHERIT is only supported on Windows 7 SP1
  6137. * and above the socket creation fails on older Windows Systems.
  6138. *
  6139. * Let's try to create a socket the old way in this case.
  6140. *
  6141. * Reference:
  6142. * https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketa
  6143. *
  6144. * WSA_FLAG_NO_HANDLE_INHERIT:
  6145. * This flag is supported on Windows 7 with SP1, Windows Server 2008 R2 with
  6146. * SP1, and later
  6147. *
  6148. */
  6149. if (sock == INVALID_SOCKET) {
  6150. sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6151. }
  6152. #else
  6153. #ifdef SOCK_CLOEXEC
  6154. auto sock =
  6155. socket(rp->ai_family, rp->ai_socktype | SOCK_CLOEXEC, rp->ai_protocol);
  6156. #else
  6157. auto sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6158. #endif
  6159. #endif
  6160. if (sock == INVALID_SOCKET) { continue; }
  6161. #if !defined _WIN32 && !defined SOCK_CLOEXEC
  6162. if (fcntl(sock, F_SETFD, FD_CLOEXEC) == -1) {
  6163. close_socket(sock);
  6164. continue;
  6165. }
  6166. #endif
  6167. if (tcp_nodelay) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  6168. if (rp->ai_family == AF_INET6) {
  6169. set_socket_opt(sock, IPPROTO_IPV6, IPV6_V6ONLY, ipv6_v6only ? 1 : 0);
  6170. }
  6171. if (socket_options) { socket_options(sock); }
  6172. // bind or connect
  6173. auto quit = false;
  6174. if (bind_or_connect(sock, *rp, quit)) { return sock; }
  6175. close_socket(sock);
  6176. if (quit) { break; }
  6177. }
  6178. return INVALID_SOCKET;
  6179. }
  6180. inline void set_nonblocking(socket_t sock, bool nonblocking) {
  6181. #ifdef _WIN32
  6182. auto flags = nonblocking ? 1UL : 0UL;
  6183. ioctlsocket(sock, FIONBIO, &flags);
  6184. #else
  6185. auto flags = fcntl(sock, F_GETFL, 0);
  6186. fcntl(sock, F_SETFL,
  6187. nonblocking ? (flags | O_NONBLOCK) : (flags & (~O_NONBLOCK)));
  6188. #endif
  6189. }
  6190. inline bool is_connection_error() {
  6191. #ifdef _WIN32
  6192. return WSAGetLastError() != WSAEWOULDBLOCK;
  6193. #else
  6194. return errno != EINPROGRESS;
  6195. #endif
  6196. }
  6197. // accept() failed because the process or the network stack is temporarily out
  6198. // of resources. The listening socket is still usable, so back off briefly and
  6199. // try again.
  6200. inline bool is_accept_resource_error() {
  6201. #ifdef _WIN32
  6202. auto err = WSAGetLastError();
  6203. return err == WSAEMFILE || err == WSAENOBUFS;
  6204. #else
  6205. auto err = errno;
  6206. return err == EMFILE || err == ENFILE || err == ENOBUFS || err == ENOMEM;
  6207. #endif
  6208. }
  6209. // accept() failed for a reason that says nothing about the listening socket:
  6210. // the pending connection went away before it could be accepted, or the call
  6211. // was interrupted. Retry immediately. WSAAccept()'s own documentation omits
  6212. // WSAECONNRESET, but the accept() it wraps reports an aborted pending
  6213. // connection that way.
  6214. inline bool is_accept_transient_error() {
  6215. #ifdef _WIN32
  6216. auto err = WSAGetLastError();
  6217. return err == WSAEINTR || err == WSAEWOULDBLOCK || err == WSAECONNRESET ||
  6218. err == WSAECONNABORTED;
  6219. #else
  6220. auto err = errno;
  6221. return err == EINTR || err == EAGAIN || err == EWOULDBLOCK ||
  6222. err == ECONNABORTED;
  6223. #endif
  6224. }
  6225. inline bool bind_ip_address(socket_t sock, const std::string &host) {
  6226. struct addrinfo hints;
  6227. struct addrinfo *result;
  6228. memset(&hints, 0, sizeof(struct addrinfo));
  6229. hints.ai_family = AF_UNSPEC;
  6230. hints.ai_socktype = SOCK_STREAM;
  6231. hints.ai_protocol = 0;
  6232. if (getaddrinfo_with_timeout(host.c_str(), "0", &hints, &result, 0)) {
  6233. return false;
  6234. }
  6235. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6236. auto ret = false;
  6237. for (auto rp = result; rp; rp = rp->ai_next) {
  6238. const auto &ai = *rp;
  6239. if (!::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  6240. ret = true;
  6241. break;
  6242. }
  6243. }
  6244. return ret;
  6245. }
  6246. #if !defined _WIN32 && !defined ANDROID && !defined _AIX && !defined __MVS__
  6247. #define USE_IF2IP
  6248. #endif
  6249. #ifdef USE_IF2IP
  6250. inline std::string if2ip(int address_family, const std::string &ifn) {
  6251. struct ifaddrs *ifap;
  6252. getifaddrs(&ifap);
  6253. auto se = detail::scope_exit([&] { freeifaddrs(ifap); });
  6254. std::string addr_candidate;
  6255. for (auto ifa = ifap; ifa; ifa = ifa->ifa_next) {
  6256. if (ifa->ifa_addr && ifn == ifa->ifa_name &&
  6257. (AF_UNSPEC == address_family ||
  6258. ifa->ifa_addr->sa_family == address_family)) {
  6259. if (ifa->ifa_addr->sa_family == AF_INET) {
  6260. auto sa = reinterpret_cast<struct sockaddr_in *>(ifa->ifa_addr);
  6261. char buf[INET_ADDRSTRLEN];
  6262. if (inet_ntop(AF_INET, &sa->sin_addr, buf, INET_ADDRSTRLEN)) {
  6263. return std::string(buf, INET_ADDRSTRLEN);
  6264. }
  6265. } else if (ifa->ifa_addr->sa_family == AF_INET6) {
  6266. auto sa = reinterpret_cast<struct sockaddr_in6 *>(ifa->ifa_addr);
  6267. if (!IN6_IS_ADDR_LINKLOCAL(&sa->sin6_addr)) {
  6268. char buf[INET6_ADDRSTRLEN] = {};
  6269. if (inet_ntop(AF_INET6, &sa->sin6_addr, buf, INET6_ADDRSTRLEN)) {
  6270. // equivalent to mac's IN6_IS_ADDR_UNIQUE_LOCAL
  6271. auto s6_addr_head = sa->sin6_addr.s6_addr[0];
  6272. if (s6_addr_head == 0xfc || s6_addr_head == 0xfd) {
  6273. addr_candidate = std::string(buf, INET6_ADDRSTRLEN);
  6274. } else {
  6275. return std::string(buf, INET6_ADDRSTRLEN);
  6276. }
  6277. }
  6278. }
  6279. }
  6280. }
  6281. }
  6282. return addr_candidate;
  6283. }
  6284. #endif
  6285. inline socket_t create_client_socket(
  6286. const std::string &host, const std::string &ip, int port,
  6287. int address_family, bool tcp_nodelay, bool ipv6_v6only,
  6288. SocketOptions socket_options, time_t connection_timeout_sec,
  6289. time_t connection_timeout_usec, time_t read_timeout_sec,
  6290. time_t read_timeout_usec, time_t write_timeout_sec,
  6291. time_t write_timeout_usec, const std::string &intf, Error &error) {
  6292. auto sock = create_socket(
  6293. host, ip, port, address_family, 0, tcp_nodelay, ipv6_v6only,
  6294. std::move(socket_options),
  6295. [&](socket_t sock2, struct addrinfo &ai, bool &quit) -> bool {
  6296. if (!intf.empty()) {
  6297. #ifdef USE_IF2IP
  6298. auto ip_from_if = if2ip(address_family, intf);
  6299. if (ip_from_if.empty()) { ip_from_if = intf; }
  6300. if (!bind_ip_address(sock2, ip_from_if)) {
  6301. error = Error::BindIPAddress;
  6302. return false;
  6303. }
  6304. #endif
  6305. }
  6306. set_nonblocking(sock2, true);
  6307. auto ret =
  6308. ::connect(sock2, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen));
  6309. if (ret < 0) {
  6310. if (is_connection_error()) {
  6311. error = Error::Connection;
  6312. return false;
  6313. }
  6314. error = wait_until_socket_is_ready(sock2, connection_timeout_sec,
  6315. connection_timeout_usec);
  6316. if (error != Error::Success) {
  6317. if (error == Error::ConnectionTimeout) { quit = true; }
  6318. return false;
  6319. }
  6320. }
  6321. set_nonblocking(sock2, false);
  6322. set_socket_opt_time(sock2, SOL_SOCKET, SO_RCVTIMEO, read_timeout_sec,
  6323. read_timeout_usec);
  6324. set_socket_opt_time(sock2, SOL_SOCKET, SO_SNDTIMEO, write_timeout_sec,
  6325. write_timeout_usec);
  6326. error = Error::Success;
  6327. return true;
  6328. },
  6329. connection_timeout_sec); // Pass DNS timeout
  6330. if (sock != INVALID_SOCKET) {
  6331. error = Error::Success;
  6332. } else {
  6333. if (error == Error::Success) { error = Error::Connection; }
  6334. }
  6335. return sock;
  6336. }
  6337. inline bool get_ip_and_port(const struct sockaddr_storage &addr,
  6338. socklen_t addr_len, std::string &ip, int &port) {
  6339. if (addr.ss_family == AF_INET) {
  6340. port = ntohs(reinterpret_cast<const struct sockaddr_in *>(&addr)->sin_port);
  6341. } else if (addr.ss_family == AF_INET6) {
  6342. port =
  6343. ntohs(reinterpret_cast<const struct sockaddr_in6 *>(&addr)->sin6_port);
  6344. } else {
  6345. return false;
  6346. }
  6347. std::array<char, NI_MAXHOST> ipstr{};
  6348. if (getnameinfo(reinterpret_cast<const struct sockaddr *>(&addr), addr_len,
  6349. ipstr.data(), static_cast<socklen_t>(ipstr.size()), nullptr,
  6350. 0, NI_NUMERICHOST)) {
  6351. return false;
  6352. }
  6353. ip = ipstr.data();
  6354. return true;
  6355. }
  6356. inline void get_local_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6357. struct sockaddr_storage addr;
  6358. socklen_t addr_len = sizeof(addr);
  6359. if (!getsockname(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6360. &addr_len)) {
  6361. get_ip_and_port(addr, addr_len, ip, port);
  6362. }
  6363. }
  6364. inline void get_remote_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6365. struct sockaddr_storage addr;
  6366. socklen_t addr_len = sizeof(addr);
  6367. if (!getpeername(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6368. &addr_len)) {
  6369. #ifndef _WIN32
  6370. if (addr.ss_family == AF_UNIX) {
  6371. #if defined(__linux__)
  6372. struct ucred ucred;
  6373. socklen_t len = sizeof(ucred);
  6374. if (getsockopt(sock, SOL_SOCKET, SO_PEERCRED, &ucred, &len) == 0) {
  6375. port = ucred.pid;
  6376. }
  6377. #elif defined(SOL_LOCAL) && defined(SO_PEERPID)
  6378. pid_t pid;
  6379. socklen_t len = sizeof(pid);
  6380. if (getsockopt(sock, SOL_LOCAL, SO_PEERPID, &pid, &len) == 0) {
  6381. port = pid;
  6382. }
  6383. #endif
  6384. return;
  6385. }
  6386. #endif
  6387. get_ip_and_port(addr, addr_len, ip, port);
  6388. }
  6389. }
  6390. inline std::string
  6391. find_content_type(const std::string &path,
  6392. const std::map<std::string, std::string> &user_data,
  6393. const std::string &default_content_type) {
  6394. auto ext = file_extension(path);
  6395. // Extensions are matched regardless of case, as web servers do, with an
  6396. // exact match to a user mapping first
  6397. auto lower_ext = case_ignore::to_lower(ext);
  6398. auto it = user_data.find(ext);
  6399. if (it == user_data.end()) { it = user_data.find(lower_ext); }
  6400. if (it != user_data.end()) { return it->second; }
  6401. static const struct {
  6402. const char *ext;
  6403. const char *type;
  6404. } types[] = {
  6405. {"css", "text/css"},
  6406. {"csv", "text/csv"},
  6407. {"htm", "text/html"},
  6408. {"html", "text/html"},
  6409. {"js", "text/javascript"},
  6410. {"mjs", "text/javascript"},
  6411. {"txt", "text/plain"},
  6412. {"vtt", "text/vtt"},
  6413. {"apng", "image/apng"},
  6414. {"avif", "image/avif"},
  6415. {"bmp", "image/bmp"},
  6416. {"gif", "image/gif"},
  6417. {"png", "image/png"},
  6418. {"svg", "image/svg+xml"},
  6419. {"webp", "image/webp"},
  6420. {"ico", "image/x-icon"},
  6421. {"tif", "image/tiff"},
  6422. {"tiff", "image/tiff"},
  6423. {"jpg", "image/jpeg"},
  6424. {"jpeg", "image/jpeg"},
  6425. {"mp4", "video/mp4"},
  6426. {"mpeg", "video/mpeg"},
  6427. {"webm", "video/webm"},
  6428. {"mp3", "audio/mp3"},
  6429. {"mpga", "audio/mpeg"},
  6430. {"weba", "audio/webm"},
  6431. {"wav", "audio/wave"},
  6432. {"otf", "font/otf"},
  6433. {"ttf", "font/ttf"},
  6434. {"woff", "font/woff"},
  6435. {"woff2", "font/woff2"},
  6436. {"7z", "application/x-7z-compressed"},
  6437. {"atom", "application/atom+xml"},
  6438. {"pdf", "application/pdf"},
  6439. {"json", "application/json"},
  6440. {"rss", "application/rss+xml"},
  6441. {"tar", "application/x-tar"},
  6442. {"xht", "application/xhtml+xml"},
  6443. {"xhtml", "application/xhtml+xml"},
  6444. {"xslt", "application/xslt+xml"},
  6445. {"xml", "application/xml"},
  6446. {"gz", "application/gzip"},
  6447. {"zip", "application/zip"},
  6448. {"wasm", "application/wasm"},
  6449. };
  6450. for (const auto &t : types) {
  6451. if (lower_ext == t.ext) { return t.type; }
  6452. }
  6453. return default_content_type;
  6454. }
  6455. inline std::string
  6456. extract_media_type(const std::string &content_type,
  6457. std::map<std::string, std::string> *params = nullptr) {
  6458. // Extract type/subtype from Content-Type value (RFC 2045)
  6459. // e.g. "application/json; charset=utf-8" -> "application/json"
  6460. auto media_type = content_type;
  6461. auto semicolon_pos = media_type.find(';');
  6462. if (semicolon_pos != std::string::npos) {
  6463. auto param_str = media_type.substr(semicolon_pos + 1);
  6464. media_type = media_type.substr(0, semicolon_pos);
  6465. if (params) {
  6466. // Parse parameters: key=value pairs separated by ';'
  6467. split_unquoted(param_str.data(), param_str.data() + param_str.size(), ';',
  6468. [&](const char *b, const char *e) {
  6469. std::string key;
  6470. std::string val;
  6471. divide_param_pair(b, e, key, val);
  6472. // Parameter names are case-insensitive (RFC 9110
  6473. // §5.6.6)
  6474. if (!key.empty()) {
  6475. params->emplace(case_ignore::to_lower(trim_copy(key)),
  6476. trim_double_quotes_copy(val));
  6477. }
  6478. });
  6479. }
  6480. }
  6481. // Trim whitespace from media type
  6482. return trim_copy(media_type);
  6483. }
  6484. inline bool can_compress_content_type(const std::string &content_type) {
  6485. // Media types are case-insensitive (RFC 9110 §8.3.1)
  6486. auto mime_type = case_ignore::to_lower(extract_media_type(content_type));
  6487. static const char *const compressible[] = {
  6488. "image/svg+xml",
  6489. "application/javascript",
  6490. "application/x-javascript",
  6491. "application/json",
  6492. "application/ld+json",
  6493. "application/xml",
  6494. "application/xhtml+xml",
  6495. "application/rss+xml",
  6496. "application/atom+xml",
  6497. "application/xslt+xml",
  6498. "application/protobuf",
  6499. };
  6500. for (auto type : compressible) {
  6501. if (mime_type == type) { return true; }
  6502. }
  6503. return mime_type != "text/event-stream" && !mime_type.rfind("text/", 0);
  6504. }
  6505. inline bool parse_quality(const char *b, const char *e, std::string &token,
  6506. double &quality) {
  6507. quality = 1.0;
  6508. token.clear();
  6509. // Split on first ';': left = token name, right = parameters
  6510. const char *params_b = nullptr;
  6511. std::size_t params_len = 0;
  6512. divide(
  6513. b, static_cast<std::size_t>(e - b), ';',
  6514. [&](const char *lb, std::size_t llen, const char *rb, std::size_t rlen) {
  6515. auto r = trim(lb, lb + llen, 0, llen);
  6516. if (r.first < r.second) { token.assign(lb + r.first, lb + r.second); }
  6517. params_b = rb;
  6518. params_len = rlen;
  6519. });
  6520. if (token.empty()) { return false; }
  6521. if (params_len == 0) { return true; }
  6522. // Scan parameters for q= (stops on first match)
  6523. bool invalid = false;
  6524. split_find(params_b, params_b + params_len, ';',
  6525. (std::numeric_limits<size_t>::max)(),
  6526. [&](const char *pb, const char *pe) -> bool {
  6527. // Match exactly "q=" or "Q=" (not "query=" etc.)
  6528. auto len = static_cast<size_t>(pe - pb);
  6529. if (len < 2) { return false; }
  6530. if ((pb[0] != 'q' && pb[0] != 'Q') || pb[1] != '=') {
  6531. return false;
  6532. }
  6533. // Trim the value portion
  6534. auto r = trim(pb, pe, 2, len);
  6535. if (r.first >= r.second) {
  6536. invalid = true;
  6537. return true;
  6538. }
  6539. double v = 0.0;
  6540. auto res = from_chars(pb + r.first, pb + r.second, v);
  6541. if (res.ec != std::errc{} || res.ptr != pb + r.second ||
  6542. v < 0.0 || v > 1.0) {
  6543. invalid = true;
  6544. return true;
  6545. }
  6546. quality = v;
  6547. return true;
  6548. });
  6549. return !invalid;
  6550. }
  6551. inline EncodingType encoding_type(const Request &req,
  6552. const std::string &content_type) {
  6553. if (!can_compress_content_type(content_type)) { return EncodingType::None; }
  6554. auto s = get_combined_header_value(req.headers, "Accept-Encoding");
  6555. if (s.empty()) { return EncodingType::None; }
  6556. // Single-pass: iterate tokens and track the best supported encoding.
  6557. // Server preference breaks ties (br > gzip > zstd).
  6558. EncodingType best = EncodingType::None;
  6559. double best_q = 0.0; // q=0 means "not acceptable"
  6560. // Server preference: Brotli > Gzip > Zstd (lower = more preferred)
  6561. auto priority = [](EncodingType t) -> int {
  6562. switch (t) {
  6563. case EncodingType::Brotli: return 0;
  6564. case EncodingType::Gzip: return 1;
  6565. case EncodingType::Zstd: return 2;
  6566. default: return 3;
  6567. }
  6568. };
  6569. std::string name;
  6570. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  6571. double quality = 1.0;
  6572. if (!parse_quality(b, e, name, quality)) { return; }
  6573. if (quality <= 0.0) { return; }
  6574. EncodingType type = EncodingType::None;
  6575. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6576. if (case_ignore::equal(name, "br")) { type = EncodingType::Brotli; }
  6577. #endif
  6578. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6579. if (type == EncodingType::None && case_ignore::equal(name, "gzip")) {
  6580. type = EncodingType::Gzip;
  6581. }
  6582. #endif
  6583. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6584. if (type == EncodingType::None && case_ignore::equal(name, "zstd")) {
  6585. type = EncodingType::Zstd;
  6586. }
  6587. #endif
  6588. if (type == EncodingType::None) { return; }
  6589. // Higher q-value wins; for equal q, server preference breaks ties
  6590. if (quality > best_q ||
  6591. (quality == best_q && priority(type) < priority(best))) {
  6592. best_q = quality;
  6593. best = type;
  6594. }
  6595. });
  6596. return best;
  6597. }
  6598. // `content_type` is taken separately because a file-backed response has not
  6599. // been given one yet when its coding has to be decided.
  6600. inline EncodingType encoding_type(const Request &req, const Response &res,
  6601. const std::string &content_type) {
  6602. // The response already names a content coding of its own: a handler serving
  6603. // a body it encoded itself (pre-compressed static assets, say), or a mount
  6604. // point whose headers name the coding its files are stored in. Applying one
  6605. // on top of that would double-encode the body and append a second
  6606. // `Content-Encoding` field line.
  6607. if (res.has_header("Content-Encoding")) { return EncodingType::None; }
  6608. return encoding_type(req, content_type);
  6609. }
  6610. inline EncodingType encoding_type(const Request &req, const Response &res) {
  6611. return encoding_type(req, res, res.get_header_value("Content-Type"));
  6612. }
  6613. inline std::unique_ptr<compressor> make_compressor(EncodingType type) {
  6614. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6615. if (type == EncodingType::Gzip) {
  6616. return detail::make_unique<gzip_compressor>();
  6617. }
  6618. #endif
  6619. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6620. if (type == EncodingType::Brotli) {
  6621. return detail::make_unique<brotli_compressor>();
  6622. }
  6623. #endif
  6624. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6625. if (type == EncodingType::Zstd) {
  6626. return detail::make_unique<zstd_compressor>();
  6627. }
  6628. #endif
  6629. (void)type;
  6630. return nullptr;
  6631. }
  6632. inline const char *encoding_name(EncodingType type) {
  6633. switch (type) {
  6634. case EncodingType::Gzip: return "gzip";
  6635. case EncodingType::Brotli: return "br";
  6636. case EncodingType::Zstd: return "zstd";
  6637. default: return "";
  6638. }
  6639. }
  6640. inline bool nocompressor::compress(const char *data, size_t data_length,
  6641. bool /*last*/, Callback callback) {
  6642. if (!data_length) { return true; }
  6643. return callback(data, data_length);
  6644. }
  6645. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6646. inline gzip_compressor::gzip_compressor() {
  6647. std::memset(&strm_, 0, sizeof(strm_));
  6648. strm_.zalloc = Z_NULL;
  6649. strm_.zfree = Z_NULL;
  6650. strm_.opaque = Z_NULL;
  6651. is_valid_ = deflateInit2(&strm_, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 31, 8,
  6652. Z_DEFAULT_STRATEGY) == Z_OK;
  6653. }
  6654. inline gzip_compressor::~gzip_compressor() { deflateEnd(&strm_); }
  6655. inline bool gzip_compressor::compress(const char *data, size_t data_length,
  6656. bool last, Callback callback) {
  6657. assert(is_valid_);
  6658. do {
  6659. constexpr size_t max_avail_in =
  6660. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6661. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6662. (std::min)(data_length, max_avail_in));
  6663. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6664. data_length -= strm_.avail_in;
  6665. data += strm_.avail_in;
  6666. auto flush = (last && data_length == 0) ? Z_FINISH : Z_NO_FLUSH;
  6667. auto ret = Z_OK;
  6668. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6669. do {
  6670. strm_.avail_out = static_cast<uInt>(buff.size());
  6671. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6672. ret = deflate(&strm_, flush);
  6673. if (ret == Z_STREAM_ERROR) { return false; }
  6674. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6675. return false;
  6676. }
  6677. } while (strm_.avail_out == 0);
  6678. assert((flush == Z_FINISH && ret == Z_STREAM_END) ||
  6679. (flush == Z_NO_FLUSH && ret == Z_OK));
  6680. assert(strm_.avail_in == 0);
  6681. } while (data_length > 0);
  6682. return true;
  6683. }
  6684. inline gzip_decompressor::gzip_decompressor() {
  6685. std::memset(&strm_, 0, sizeof(strm_));
  6686. strm_.zalloc = Z_NULL;
  6687. strm_.zfree = Z_NULL;
  6688. strm_.opaque = Z_NULL;
  6689. // 15 is the value of wbits, which should be at the maximum possible value
  6690. // to ensure that any gzip stream can be decoded. The offset of 32 specifies
  6691. // that the stream type should be automatically detected either gzip or
  6692. // deflate.
  6693. is_valid_ = inflateInit2(&strm_, 32 + 15) == Z_OK;
  6694. }
  6695. inline gzip_decompressor::~gzip_decompressor() { inflateEnd(&strm_); }
  6696. inline bool gzip_decompressor::is_valid() const { return is_valid_; }
  6697. inline bool gzip_decompressor::decompress(const char *data, size_t data_length,
  6698. Callback callback) {
  6699. assert(is_valid_);
  6700. auto ret = Z_OK;
  6701. do {
  6702. constexpr size_t max_avail_in =
  6703. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6704. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6705. (std::min)(data_length, max_avail_in));
  6706. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6707. data_length -= strm_.avail_in;
  6708. data += strm_.avail_in;
  6709. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6710. while (strm_.avail_in > 0 && ret == Z_OK) {
  6711. strm_.avail_out = static_cast<uInt>(buff.size());
  6712. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6713. ret = inflate(&strm_, Z_NO_FLUSH);
  6714. assert(ret != Z_STREAM_ERROR);
  6715. switch (ret) {
  6716. case Z_NEED_DICT:
  6717. case Z_DATA_ERROR:
  6718. case Z_MEM_ERROR: inflateEnd(&strm_); return false;
  6719. }
  6720. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6721. return false;
  6722. }
  6723. }
  6724. if (ret != Z_OK && ret != Z_STREAM_END) { return false; }
  6725. } while (data_length > 0);
  6726. return true;
  6727. }
  6728. #endif
  6729. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6730. inline brotli_compressor::brotli_compressor() {
  6731. state_ = BrotliEncoderCreateInstance(nullptr, nullptr, nullptr);
  6732. }
  6733. inline brotli_compressor::~brotli_compressor() {
  6734. BrotliEncoderDestroyInstance(state_);
  6735. }
  6736. inline bool brotli_compressor::compress(const char *data, size_t data_length,
  6737. bool last, Callback callback) {
  6738. std::array<uint8_t, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6739. auto operation = last ? BROTLI_OPERATION_FINISH : BROTLI_OPERATION_PROCESS;
  6740. auto available_in = data_length;
  6741. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6742. for (;;) {
  6743. if (last) {
  6744. if (BrotliEncoderIsFinished(state_)) { break; }
  6745. } else {
  6746. if (!available_in) { break; }
  6747. }
  6748. auto available_out = buff.size();
  6749. auto next_out = buff.data();
  6750. if (!BrotliEncoderCompressStream(state_, operation, &available_in, &next_in,
  6751. &available_out, &next_out, nullptr)) {
  6752. return false;
  6753. }
  6754. auto output_bytes = buff.size() - available_out;
  6755. if (output_bytes) {
  6756. callback(reinterpret_cast<const char *>(buff.data()), output_bytes);
  6757. }
  6758. }
  6759. return true;
  6760. }
  6761. inline brotli_decompressor::brotli_decompressor() {
  6762. decoder_s = BrotliDecoderCreateInstance(0, 0, 0);
  6763. decoder_r = decoder_s ? BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT
  6764. : BROTLI_DECODER_RESULT_ERROR;
  6765. }
  6766. inline brotli_decompressor::~brotli_decompressor() {
  6767. if (decoder_s) { BrotliDecoderDestroyInstance(decoder_s); }
  6768. }
  6769. inline bool brotli_decompressor::is_valid() const { return decoder_s; }
  6770. inline bool brotli_decompressor::decompress(const char *data,
  6771. size_t data_length,
  6772. Callback callback) {
  6773. if (decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6774. decoder_r == BROTLI_DECODER_RESULT_ERROR) {
  6775. return 0;
  6776. }
  6777. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6778. size_t avail_in = data_length;
  6779. size_t total_out;
  6780. decoder_r = BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT;
  6781. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6782. while (decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT) {
  6783. char *next_out = buff.data();
  6784. size_t avail_out = buff.size();
  6785. decoder_r = BrotliDecoderDecompressStream(
  6786. decoder_s, &avail_in, &next_in, &avail_out,
  6787. reinterpret_cast<uint8_t **>(&next_out), &total_out);
  6788. if (decoder_r == BROTLI_DECODER_RESULT_ERROR) { return false; }
  6789. if (!callback(buff.data(), buff.size() - avail_out)) { return false; }
  6790. }
  6791. return decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6792. decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT;
  6793. }
  6794. #endif
  6795. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6796. inline zstd_compressor::zstd_compressor() {
  6797. ctx_ = ZSTD_createCCtx();
  6798. ZSTD_CCtx_setParameter(ctx_, ZSTD_c_compressionLevel, ZSTD_fast);
  6799. }
  6800. inline zstd_compressor::~zstd_compressor() { ZSTD_freeCCtx(ctx_); }
  6801. inline bool zstd_compressor::compress(const char *data, size_t data_length,
  6802. bool last, Callback callback) {
  6803. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6804. ZSTD_EndDirective mode = last ? ZSTD_e_end : ZSTD_e_continue;
  6805. ZSTD_inBuffer input = {data, data_length, 0};
  6806. bool finished;
  6807. do {
  6808. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6809. size_t const remaining = ZSTD_compressStream2(ctx_, &output, &input, mode);
  6810. if (ZSTD_isError(remaining)) { return false; }
  6811. if (!callback(buff.data(), output.pos)) { return false; }
  6812. finished = last ? (remaining == 0) : (input.pos == input.size);
  6813. } while (!finished);
  6814. return true;
  6815. }
  6816. inline zstd_decompressor::zstd_decompressor() { ctx_ = ZSTD_createDCtx(); }
  6817. inline zstd_decompressor::~zstd_decompressor() { ZSTD_freeDCtx(ctx_); }
  6818. inline bool zstd_decompressor::is_valid() const { return ctx_ != nullptr; }
  6819. inline bool zstd_decompressor::decompress(const char *data, size_t data_length,
  6820. Callback callback) {
  6821. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6822. ZSTD_inBuffer input = {data, data_length, 0};
  6823. while (input.pos < input.size) {
  6824. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6825. size_t const remaining = ZSTD_decompressStream(ctx_, &output, &input);
  6826. if (ZSTD_isError(remaining)) { return false; }
  6827. if (!callback(buff.data(), output.pos)) { return false; }
  6828. }
  6829. return true;
  6830. }
  6831. #endif
  6832. // Content codings are case-insensitive (RFC 9110 8.4.1). Matching them
  6833. // case-sensitively would make a response labeled e.g. "GZIP" look like an
  6834. // unknown coding, and its payload would be handed back still compressed.
  6835. inline bool is_zlib_encoding(const std::string &encoding) {
  6836. return case_ignore::equal(encoding, "gzip") ||
  6837. case_ignore::equal(encoding, "deflate");
  6838. }
  6839. inline bool is_brotli_encoding(const std::string &encoding) {
  6840. return case_ignore::equal(encoding, "br");
  6841. }
  6842. inline bool is_zstd_encoding(const std::string &encoding) {
  6843. return case_ignore::equal(encoding, "zstd");
  6844. }
  6845. // Returns true if the content coding is one cpp-httplib is able to decompress
  6846. // when the corresponding support is compiled in.
  6847. inline bool is_known_content_encoding(const std::string &encoding) {
  6848. return is_zlib_encoding(encoding) || is_brotli_encoding(encoding) ||
  6849. is_zstd_encoding(encoding);
  6850. }
  6851. inline std::unique_ptr<decompressor>
  6852. create_decompressor(const std::string &encoding) {
  6853. std::unique_ptr<decompressor> decompressor;
  6854. if (is_zlib_encoding(encoding)) {
  6855. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6856. decompressor = detail::make_unique<gzip_decompressor>();
  6857. #endif
  6858. } else if (is_brotli_encoding(encoding)) {
  6859. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6860. decompressor = detail::make_unique<brotli_decompressor>();
  6861. #endif
  6862. } else if (is_zstd_encoding(encoding)) {
  6863. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6864. decompressor = detail::make_unique<zstd_decompressor>();
  6865. #endif
  6866. }
  6867. return decompressor;
  6868. }
  6869. // Returns the best available compressor and its Content-Encoding name.
  6870. // Priority: Brotli > Gzip > Zstd (matches server-side preference).
  6871. inline std::pair<std::unique_ptr<compressor>, const char *>
  6872. create_compressor() {
  6873. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6874. return {detail::make_unique<brotli_compressor>(), "br"};
  6875. #elif defined(CPPHTTPLIB_ZLIB_SUPPORT)
  6876. return {detail::make_unique<gzip_compressor>(), "gzip"};
  6877. #elif defined(CPPHTTPLIB_ZSTD_SUPPORT)
  6878. return {detail::make_unique<zstd_compressor>(), "zstd"};
  6879. #else
  6880. return {nullptr, nullptr};
  6881. #endif
  6882. }
  6883. inline bool is_prohibited_header_name(const std::string &name) {
  6884. // Field names are case-insensitive (RFC 9110 §5.1)
  6885. return case_ignore::equal(name, "REMOTE_ADDR") ||
  6886. case_ignore::equal(name, "REMOTE_PORT") ||
  6887. case_ignore::equal(name, "LOCAL_ADDR") ||
  6888. case_ignore::equal(name, "LOCAL_PORT");
  6889. }
  6890. inline bool has_header(const Headers &headers, const std::string &key) {
  6891. if (is_prohibited_header_name(key)) { return false; }
  6892. return headers.find(key) != headers.end();
  6893. }
  6894. inline const char *get_header_value(const Headers &headers,
  6895. const std::string &key, const char *def,
  6896. size_t id) {
  6897. if (is_prohibited_header_name(key)) {
  6898. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  6899. std::string msg = "Prohibited header name '" + key + "' is specified.";
  6900. throw std::invalid_argument(msg);
  6901. #else
  6902. return "";
  6903. #endif
  6904. }
  6905. auto rng = headers.equal_range(key);
  6906. auto it = bounded_next(rng.first, id, rng.second);
  6907. if (it != rng.second) { return it->second.c_str(); }
  6908. return def;
  6909. }
  6910. inline size_t get_header_value_count(const Headers &headers,
  6911. const std::string &key) {
  6912. return headers.count(key);
  6913. }
  6914. // RFC 9110 Section 5.2 and 5.3: a field that is defined as a comma-separated
  6915. // list may be sent as several field lines, and the combined field value is
  6916. // those values joined by commas in the order they were received. Callers that
  6917. // parse such a list must work on the combined value; reading only the first
  6918. // occurrence silently drops whatever the later field lines carry.
  6919. inline std::string get_combined_header_value(const Headers &headers,
  6920. const std::string &key) {
  6921. std::string combined;
  6922. auto rng = headers.equal_range(key);
  6923. for (auto it = rng.first; it != rng.second; ++it) {
  6924. // RFC 9110 Section 5.6.1.2: a recipient has to parse and ignore empty list
  6925. // elements, so an empty field line must not contribute a bare comma to the
  6926. // combined value.
  6927. if (it->second.empty()) { continue; }
  6928. if (!combined.empty()) { combined += ", "; }
  6929. combined += it->second;
  6930. }
  6931. return combined;
  6932. }
  6933. inline bool has_header_token(const Headers &headers, const std::string &key,
  6934. const std::string &token) {
  6935. // RFC 9110 7.6.1: a comma-separated token list field such as Connection may
  6936. // carry several tokens, and RFC 9110 5.3 lets that list be split across
  6937. // several lines. Match complete tokens rather than searching the raw value,
  6938. // so that a value such as "notupgrade" is not read as the token "upgrade".
  6939. auto rng = headers.equal_range(key);
  6940. for (auto it = rng.first; it != rng.second; ++it) {
  6941. const auto &value = it->second;
  6942. if (split_find(value.data(), value.data() + value.size(), ',',
  6943. [&](const char *b, const char *e) {
  6944. return case_ignore::equal(std::string(b, e), token);
  6945. })) {
  6946. return true;
  6947. }
  6948. }
  6949. return false;
  6950. }
  6951. template <typename Map>
  6952. inline typename Map::mapped_type
  6953. get_multimap_value(const Map &m, const std::string &key, size_t id) {
  6954. auto rng = m.equal_range(key);
  6955. auto it = bounded_next(rng.first, id, rng.second);
  6956. if (it != rng.second) { return it->second; }
  6957. return typename Map::mapped_type();
  6958. }
  6959. inline void set_header(Headers &headers, const std::string &key,
  6960. const std::string &val) {
  6961. if (fields::is_field_valid(key, val)) { headers.emplace(key, val); }
  6962. }
  6963. inline bool read_headers(Stream &strm, Headers &headers) {
  6964. const auto bufsiz = 2048;
  6965. char buf[bufsiz];
  6966. stream_line_reader line_reader(strm, buf, bufsiz);
  6967. size_t header_count = 0;
  6968. for (;;) {
  6969. if (!line_reader.getline()) { return false; }
  6970. // Check if the line ends with CRLF.
  6971. auto line_terminator_len = 2;
  6972. if (line_reader.end_with_crlf()) {
  6973. // Blank line indicates end of headers.
  6974. if (line_reader.size() == 2) { break; }
  6975. } else {
  6976. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  6977. // Blank line indicates end of headers.
  6978. if (line_reader.size() == 1) { break; }
  6979. line_terminator_len = 1;
  6980. #else
  6981. continue; // Skip invalid line.
  6982. #endif
  6983. }
  6984. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  6985. // Check header count limit
  6986. if (header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  6987. // Exclude line terminator
  6988. auto end = line_reader.ptr() + line_reader.size() - line_terminator_len;
  6989. if (!parse_header(line_reader.ptr(), end,
  6990. [&](const std::string &key, const std::string &val) {
  6991. headers.emplace(key, val);
  6992. })) {
  6993. return false;
  6994. }
  6995. header_count++;
  6996. }
  6997. // RFC 9110 Section 8.6: Reject requests with multiple Content-Length
  6998. // headers that have different values to prevent request smuggling.
  6999. auto cl_range = headers.equal_range("Content-Length");
  7000. if (cl_range.first != cl_range.second) {
  7001. const auto &first_val = cl_range.first->second;
  7002. for (auto it = std::next(cl_range.first); it != cl_range.second; ++it) {
  7003. if (it->second != first_val) { return false; }
  7004. }
  7005. }
  7006. return true;
  7007. }
  7008. // Parsed by hand: std::regex_match recurses once per character of the reason
  7009. // phrase, which a server can make as long as a whole line.
  7010. inline bool parse_status_line(const char *line, std::string &version,
  7011. int &status, std::string &reason) {
  7012. if (std::strncmp(line, "HTTP/1.", 7) != 0 ||
  7013. (line[7] != '0' && line[7] != '1') || line[8] != ' ' ||
  7014. !is_ascii_digit(line[9]) || !is_ascii_digit(line[10]) ||
  7015. !is_ascii_digit(line[11])) {
  7016. return false;
  7017. }
  7018. auto p = line + 12;
  7019. auto reason_begin = p;
  7020. if (*p == ' ') {
  7021. reason_begin = ++p;
  7022. p += std::strcspn(p, "\r\n");
  7023. }
  7024. auto reason_end = p;
  7025. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  7026. if (*p == '\r') { p++; }
  7027. #else
  7028. if (*p++ != '\r') { return false; }
  7029. #endif
  7030. if (*p++ != '\n' || *p != '\0') { return false; }
  7031. version.assign(line, 8);
  7032. status = (line[9] - '0') * 100 + (line[10] - '0') * 10 + (line[11] - '0');
  7033. reason.assign(reason_begin, reason_end);
  7034. return true;
  7035. }
  7036. // Everything WebSocketClient::connect() reports about the upgrade exchange.
  7037. // status stays -1 until a status line is parsed, mirroring stream::Result.
  7038. struct WebSocketUpgradeResponse {
  7039. Error error = Error::Success;
  7040. int status = -1;
  7041. Headers headers;
  7042. std::string selected_subprotocol;
  7043. };
  7044. inline bool
  7045. read_websocket_upgrade_response(Stream &strm,
  7046. const std::string &expected_accept,
  7047. const std::string &offered_subprotocols,
  7048. WebSocketUpgradeResponse &upgrade) {
  7049. // Read status line
  7050. const auto bufsiz = 2048;
  7051. char buf[bufsiz];
  7052. stream_line_reader line_reader(strm, buf, bufsiz);
  7053. if (!line_reader.getline()) {
  7054. upgrade.error = Error::Read;
  7055. return false;
  7056. }
  7057. std::string version;
  7058. std::string reason;
  7059. if (!parse_status_line(line_reader.ptr(), version, upgrade.status, reason)) {
  7060. upgrade.error = Error::WebSocketHandshake;
  7061. return false;
  7062. }
  7063. // Read the headers even for a rejection so the caller can see why the
  7064. // server refused the upgrade. A non-101 response may carry a body; it is
  7065. // deliberately left unread since the caller closes the socket right away.
  7066. if (!read_headers(strm, upgrade.headers)) {
  7067. upgrade.error = Error::Read;
  7068. return false;
  7069. }
  7070. const auto &headers = upgrade.headers;
  7071. if (upgrade.status != StatusCode::SwitchingProtocol_101) {
  7072. upgrade.error = Error::WebSocketHandshake;
  7073. return false;
  7074. }
  7075. // Verify Upgrade: websocket (a comma-separated list, matched per token)
  7076. if (!has_header_token(headers, "Upgrade", "websocket")) {
  7077. upgrade.error = Error::WebSocketHandshake;
  7078. return false;
  7079. }
  7080. // Verify Connection: Upgrade
  7081. if (!has_header_token(headers, "Connection", "upgrade")) {
  7082. upgrade.error = Error::WebSocketHandshake;
  7083. return false;
  7084. }
  7085. // Verify Sec-WebSocket-Accept header value
  7086. auto it = headers.find("Sec-WebSocket-Accept");
  7087. if (it == headers.end() || it->second != expected_accept) {
  7088. upgrade.error = Error::WebSocketHandshake;
  7089. return false;
  7090. }
  7091. // Extract negotiated subprotocol
  7092. auto proto_it = headers.find("Sec-WebSocket-Protocol");
  7093. if (proto_it != headers.end()) {
  7094. upgrade.selected_subprotocol = proto_it->second;
  7095. }
  7096. // Verify the subprotocol is one the client offered (RFC 6455 4.1)
  7097. if (!upgrade.selected_subprotocol.empty()) {
  7098. auto was_offered = false;
  7099. split(offered_subprotocols.data(),
  7100. offered_subprotocols.data() + offered_subprotocols.size(), ',',
  7101. [&](const char *b, const char *e) {
  7102. if (std::string(b, e) == upgrade.selected_subprotocol) {
  7103. was_offered = true;
  7104. }
  7105. });
  7106. if (!was_offered) {
  7107. upgrade.error = Error::WebSocketHandshake;
  7108. return false;
  7109. }
  7110. }
  7111. return true;
  7112. }
  7113. enum class ReadContentResult {
  7114. Success, // Successfully read the content
  7115. PayloadTooLarge, // The content exceeds the specified payload limit
  7116. Error // An error occurred while reading the content
  7117. };
  7118. inline ReadContentResult read_content_with_length(
  7119. Stream &strm, size_t len, DownloadProgress progress,
  7120. ContentReceiverWithProgress out,
  7121. size_t payload_max_length = (std::numeric_limits<size_t>::max)()) {
  7122. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7123. detail::BodyReader br;
  7124. br.stream = &strm;
  7125. br.has_content_length = true;
  7126. br.content_length = len;
  7127. br.payload_max_length = payload_max_length;
  7128. br.chunked = false;
  7129. br.bytes_read = 0;
  7130. br.last_error = Error::Success;
  7131. size_t r = 0;
  7132. while (r < len) {
  7133. auto read_len = static_cast<size_t>(len - r);
  7134. auto to_read = (std::min)(read_len, CPPHTTPLIB_RECV_BUFSIZ);
  7135. auto n = detail::read_body_content(&strm, br, buf, to_read);
  7136. if (n <= 0) {
  7137. // Check if it was a payload size error
  7138. if (br.last_error == Error::ExceedMaxPayloadSize) {
  7139. return ReadContentResult::PayloadTooLarge;
  7140. }
  7141. return ReadContentResult::Error;
  7142. }
  7143. if (!out(buf, static_cast<size_t>(n), r, len)) {
  7144. return ReadContentResult::Error;
  7145. }
  7146. r += static_cast<size_t>(n);
  7147. if (progress) {
  7148. if (!progress(r, len)) { return ReadContentResult::Error; }
  7149. }
  7150. }
  7151. return ReadContentResult::Success;
  7152. }
  7153. inline ReadContentResult
  7154. read_content_without_length(Stream &strm, size_t payload_max_length,
  7155. ContentReceiverWithProgress out) {
  7156. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7157. size_t r = 0;
  7158. for (;;) {
  7159. auto n = strm.read(buf, CPPHTTPLIB_RECV_BUFSIZ);
  7160. if (n == 0) { return ReadContentResult::Success; }
  7161. if (n < 0) { return ReadContentResult::Error; }
  7162. // Check if adding this data would exceed the payload limit
  7163. if (payload_max_length > 0 &&
  7164. (r > payload_max_length ||
  7165. payload_max_length - r < static_cast<size_t>(n))) {
  7166. return ReadContentResult::PayloadTooLarge;
  7167. }
  7168. if (!out(buf, static_cast<size_t>(n), r, 0)) {
  7169. return ReadContentResult::Error;
  7170. }
  7171. r += static_cast<size_t>(n);
  7172. }
  7173. return ReadContentResult::Success;
  7174. }
  7175. template <typename T>
  7176. inline ReadContentResult read_content_chunked(Stream &strm, T &x,
  7177. size_t payload_max_length,
  7178. ContentReceiverWithProgress out) {
  7179. detail::ChunkedDecoder dec(strm);
  7180. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7181. size_t total_len = 0;
  7182. for (;;) {
  7183. size_t chunk_offset = 0;
  7184. size_t chunk_total = 0;
  7185. auto n = dec.read_payload(buf, sizeof(buf), chunk_offset, chunk_total);
  7186. if (n < 0) { return ReadContentResult::Error; }
  7187. if (n == 0) {
  7188. if (!dec.parse_trailers_into(x.trailers, x.headers)) {
  7189. return ReadContentResult::Error;
  7190. }
  7191. return ReadContentResult::Success;
  7192. }
  7193. if (payload_max_length > 0 &&
  7194. (total_len > payload_max_length ||
  7195. payload_max_length - total_len < static_cast<size_t>(n))) {
  7196. return ReadContentResult::PayloadTooLarge;
  7197. }
  7198. if (!out(buf, static_cast<size_t>(n), chunk_offset, chunk_total)) {
  7199. return ReadContentResult::Error;
  7200. }
  7201. total_len += static_cast<size_t>(n);
  7202. }
  7203. }
  7204. inline bool is_chunked_transfer_encoding(const Headers &headers) {
  7205. // RFC 9112 6.1: a message is framed with the chunked coding when "chunked"
  7206. // is the final transfer coding. A single field value may list several
  7207. // codings ("gzip, chunked"), and RFC 9110 5.3 lets that list be split across
  7208. // several Transfer-Encoding lines, which combine into one comma-separated
  7209. // list in the order the lines were received. Headers preserves that order,
  7210. // so the final coding is the last token of the last line. Match it
  7211. // case-insensitively rather than comparing the whole value against
  7212. // "chunked".
  7213. //
  7214. // Security: reading a chunked message as unframed leaves its body in the
  7215. // socket, where a keep-alive connection parses it as a smuggled request.
  7216. // Server::process_request() answers 400 and closes when the final coding is
  7217. // not chunked, so a request whose framing cannot be determined never
  7218. // reaches the "no body" path.
  7219. auto rng = headers.equal_range("Transfer-Encoding");
  7220. if (rng.first == rng.second) { return false; }
  7221. // Cleared per line, so a trailing line carrying no coding at all leaves the
  7222. // combined list ending in nothing rather than inheriting the line before it.
  7223. std::string last_coding;
  7224. for (auto it = rng.first; it != rng.second; ++it) {
  7225. const auto &value = it->second;
  7226. last_coding.clear();
  7227. split(value.data(), value.data() + value.size(), ',',
  7228. [&](const char *b, const char *e) { last_coding.assign(b, e); });
  7229. }
  7230. return case_ignore::equal(last_coding, "chunked");
  7231. }
  7232. inline bool has_conflicting_content_length(const Headers &headers) {
  7233. // RFC 9112 §6.3: a message carrying both Transfer-Encoding and a non-zero
  7234. // Content-Length is framed ambiguously. The body readers here delimit it by
  7235. // the transfer coding and drop Content-Length, while an intermediary may do
  7236. // the reverse, so the two disagree on where the body ends and a reused
  7237. // connection is desynchronised (request/response smuggling). Content-Length:
  7238. // 0 is tolerated for compatibility with existing peers.
  7239. return has_header(headers, "Transfer-Encoding") &&
  7240. get_header_value_u64(headers, "Content-Length", 0, 0) > 0;
  7241. }
  7242. template <typename T, typename U>
  7243. bool prepare_content_receiver(T &x, int &status,
  7244. ContentReceiverWithProgress receiver,
  7245. bool decompress, size_t payload_max_length,
  7246. bool &exceed_payload_max_length, U callback) {
  7247. if (decompress) {
  7248. auto encoding = get_combined_header_value(x.headers, "Content-Encoding");
  7249. std::unique_ptr<decompressor> decompressor;
  7250. if (!encoding.empty()) {
  7251. // A coding we know about but were not built with is an error. An
  7252. // unrecognized coding (including "identity") is left alone and the
  7253. // payload is passed through as-is, since some servers misuse the header,
  7254. // e.g. by sending a character set such as "Content-Encoding: UTF-8".
  7255. decompressor = detail::create_decompressor(encoding);
  7256. if (!decompressor && detail::is_known_content_encoding(encoding)) {
  7257. status = StatusCode::UnsupportedMediaType_415;
  7258. return false;
  7259. }
  7260. }
  7261. if (decompressor) {
  7262. if (decompressor->is_valid()) {
  7263. size_t decompressed_size = 0;
  7264. ContentReceiverWithProgress out = [&](const char *buf, size_t n,
  7265. size_t off, size_t len) {
  7266. return decompressor->decompress(
  7267. buf, n, [&](const char *buf2, size_t n2) {
  7268. // Guard against zip-bomb: check
  7269. // decompressed size against limit.
  7270. if (payload_max_length > 0 &&
  7271. (decompressed_size >= payload_max_length ||
  7272. n2 > payload_max_length - decompressed_size)) {
  7273. exceed_payload_max_length = true;
  7274. return false;
  7275. }
  7276. decompressed_size += n2;
  7277. return receiver(buf2, n2, off, len);
  7278. });
  7279. };
  7280. return callback(std::move(out));
  7281. } else {
  7282. status = StatusCode::InternalServerError_500;
  7283. return false;
  7284. }
  7285. }
  7286. }
  7287. ContentReceiverWithProgress out = [&](const char *buf, size_t n, size_t off,
  7288. size_t len) {
  7289. return receiver(buf, n, off, len);
  7290. };
  7291. return callback(std::move(out));
  7292. }
  7293. template <typename T>
  7294. bool read_content(Stream &strm, T &x, size_t payload_max_length, int &status,
  7295. DownloadProgress progress,
  7296. ContentReceiverWithProgress receiver, bool decompress) {
  7297. bool exceed_payload_max_length = false;
  7298. return prepare_content_receiver(
  7299. x, status, std::move(receiver), decompress, payload_max_length,
  7300. exceed_payload_max_length, [&](const ContentReceiverWithProgress &out) {
  7301. auto ret = true;
  7302. // Note: exceed_payload_max_length may also be set by the decompressor
  7303. // wrapper in prepare_content_receiver when the decompressed payload
  7304. // size exceeds the limit.
  7305. if (is_chunked_transfer_encoding(x.headers)) {
  7306. auto result = read_content_chunked(strm, x, payload_max_length, out);
  7307. if (result == ReadContentResult::Success) {
  7308. ret = true;
  7309. } else if (result == ReadContentResult::PayloadTooLarge) {
  7310. exceed_payload_max_length = true;
  7311. ret = false;
  7312. } else {
  7313. ret = false;
  7314. }
  7315. } else if (!has_header(x.headers, "Content-Length")) {
  7316. auto result =
  7317. read_content_without_length(strm, payload_max_length, out);
  7318. if (result == ReadContentResult::Success) {
  7319. ret = true;
  7320. } else if (result == ReadContentResult::PayloadTooLarge) {
  7321. exceed_payload_max_length = true;
  7322. ret = false;
  7323. } else {
  7324. ret = false;
  7325. }
  7326. } else {
  7327. auto is_invalid_value = false;
  7328. auto len = get_header_value_u64(x.headers, "Content-Length",
  7329. (std::numeric_limits<size_t>::max)(),
  7330. 0, is_invalid_value);
  7331. if (is_invalid_value) {
  7332. ret = false;
  7333. } else if (len > 0) {
  7334. auto result = read_content_with_length(
  7335. strm, len, std::move(progress), out, payload_max_length);
  7336. ret = (result == ReadContentResult::Success);
  7337. if (result == ReadContentResult::PayloadTooLarge) {
  7338. exceed_payload_max_length = true;
  7339. }
  7340. }
  7341. }
  7342. if (!ret) {
  7343. status = exceed_payload_max_length ? StatusCode::PayloadTooLarge_413
  7344. : StatusCode::BadRequest_400;
  7345. }
  7346. return ret;
  7347. });
  7348. }
  7349. inline ssize_t write_request_line(Stream &strm, const std::string &method,
  7350. const std::string &path) {
  7351. // Neither the method nor the request target may carry CR/LF, SP or other
  7352. // control octets; otherwise a value smuggled into either splits the request
  7353. // line and injects headers or a whole request.
  7354. if (!fields::is_token(method)) { return -1; }
  7355. if (!fields::is_request_target(path)) { return -1; }
  7356. std::string s = method;
  7357. s += ' ';
  7358. s += path;
  7359. s += " HTTP/1.1\r\n";
  7360. return strm.write(s.data(), s.size());
  7361. }
  7362. inline ssize_t write_response_line(Stream &strm, int status) {
  7363. std::string s = "HTTP/1.1 ";
  7364. s += std::to_string(status);
  7365. s += ' ';
  7366. s += httplib::status_message(status);
  7367. s += "\r\n";
  7368. return strm.write(s.data(), s.size());
  7369. }
  7370. inline ssize_t write_headers(Stream &strm, const Headers &headers) {
  7371. ssize_t write_len = 0;
  7372. for (const auto &x : headers) {
  7373. // Skip fields with invalid names or values to prevent response splitting
  7374. // via CR/LF injection, matching set_header(). The client validates request
  7375. // headers up front in check_and_write_headers, but the server passes
  7376. // res.headers straight to this writer, and res.headers is a public field
  7377. // an application can populate directly with request-derived values.
  7378. if (!fields::is_field_valid(x.first, x.second)) { continue; }
  7379. std::string s;
  7380. s = x.first;
  7381. s += ": ";
  7382. s += x.second;
  7383. s += "\r\n";
  7384. auto len = strm.write(s.data(), s.size());
  7385. if (len < 0) { return len; }
  7386. write_len += len;
  7387. }
  7388. auto len = strm.write("\r\n");
  7389. if (len < 0) { return len; }
  7390. write_len += len;
  7391. return write_len;
  7392. }
  7393. inline bool write_data(Stream &strm, const char *d, size_t l) {
  7394. size_t offset = 0;
  7395. while (offset < l) {
  7396. auto length = strm.write(d + offset, l - offset);
  7397. if (length < 0) { return false; }
  7398. offset += static_cast<size_t>(length);
  7399. }
  7400. return true;
  7401. }
  7402. template <typename T>
  7403. inline bool write_content_with_progress(Stream &strm,
  7404. const ContentProvider &content_provider,
  7405. size_t offset, size_t length,
  7406. T is_shutting_down,
  7407. const UploadProgress &upload_progress,
  7408. Error &error) {
  7409. size_t end_offset = offset + length;
  7410. size_t start_offset = offset;
  7411. auto ok = true;
  7412. auto finished = false;
  7413. DataSink data_sink;
  7414. data_sink.write = [&](const char *d, size_t l) -> bool {
  7415. if (ok) {
  7416. // Bytes past `length` would follow the framed body, where the peer reads
  7417. // them as the next message. Write only what fits and fail the rest.
  7418. if (l > end_offset - offset) {
  7419. l = end_offset - offset;
  7420. ok = false;
  7421. }
  7422. if (write_data(strm, d, l)) {
  7423. offset += l;
  7424. if (upload_progress && length > 0) {
  7425. size_t current_written = offset - start_offset;
  7426. if (!upload_progress(current_written, length)) {
  7427. ok = false;
  7428. return false;
  7429. }
  7430. }
  7431. } else {
  7432. ok = false;
  7433. }
  7434. }
  7435. return ok;
  7436. };
  7437. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7438. // The body is framed by `length`, so a provider that reports itself done
  7439. // early has truncated it. Record that and let the short-body check below
  7440. // fail the write, rather than calling the provider again forever.
  7441. data_sink.done = [&]() { finished = true; };
  7442. while (offset < end_offset && !finished && !is_shutting_down()) {
  7443. auto last_offset = offset;
  7444. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7445. error = Error::Write;
  7446. return false;
  7447. } else if (!content_provider(offset, end_offset - offset, data_sink)) {
  7448. error = Error::Canceled;
  7449. return false;
  7450. } else if (!ok) {
  7451. error = Error::Write;
  7452. return false;
  7453. }
  7454. // A provider that reports success without writing anything and without
  7455. // reporting itself done gets handed the same offset and length again on
  7456. // the next pass, so it would spin here for as long as the peer stays
  7457. // connected. Treat making no progress as a short body, like done() early.
  7458. if (!finished && offset == last_offset) {
  7459. error = Error::Write;
  7460. return false;
  7461. }
  7462. }
  7463. if (offset < end_offset) { // done() called early, or is_shutting_down()
  7464. error = Error::Write;
  7465. return false;
  7466. }
  7467. error = Error::Success;
  7468. return true;
  7469. }
  7470. template <typename T>
  7471. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7472. size_t offset, size_t length, T is_shutting_down,
  7473. Error &error) {
  7474. return write_content_with_progress<T>(strm, content_provider, offset, length,
  7475. is_shutting_down, nullptr, error);
  7476. }
  7477. template <typename T>
  7478. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7479. size_t offset, size_t length,
  7480. const T &is_shutting_down) {
  7481. auto error = Error::Success;
  7482. return write_content(strm, content_provider, offset, length, is_shutting_down,
  7483. error);
  7484. }
  7485. template <typename T>
  7486. inline bool
  7487. write_content_without_length(Stream &strm,
  7488. const ContentProvider &content_provider,
  7489. const T &is_shutting_down) {
  7490. size_t offset = 0;
  7491. auto data_available = true;
  7492. auto ok = true;
  7493. DataSink data_sink;
  7494. data_sink.write = [&](const char *d, size_t l) -> bool {
  7495. if (ok) {
  7496. offset += l;
  7497. if (!write_data(strm, d, l)) { ok = false; }
  7498. }
  7499. return ok;
  7500. };
  7501. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7502. data_sink.done = [&](void) { data_available = false; };
  7503. while (data_available && !is_shutting_down()) {
  7504. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7505. return false;
  7506. } else if (!content_provider(offset, 0, data_sink)) {
  7507. return false;
  7508. } else if (!ok) {
  7509. return false;
  7510. }
  7511. }
  7512. return !data_available; // true only if done() was called, false if shutting
  7513. // down
  7514. }
  7515. // Runs a known-length content provider to completion and compresses what it
  7516. // writes into `out`, chunk by chunk, without holding the identity form.
  7517. inline bool compress_content_provider(const ContentProvider &content_provider,
  7518. size_t length, compressor &cmp,
  7519. std::string &out) {
  7520. size_t offset = 0;
  7521. auto ok = true;
  7522. auto finished = false;
  7523. DataSink data_sink;
  7524. auto append = [&](const char *data, size_t data_len) {
  7525. out.append(data, data_len);
  7526. return true;
  7527. };
  7528. data_sink.write = [&](const char *d, size_t l) -> bool {
  7529. if (!ok) { return false; }
  7530. offset += l;
  7531. if (l > 0 && !cmp.compress(d, l, false, append)) { ok = false; }
  7532. return ok;
  7533. };
  7534. // The body is framed by `length`, so a provider that reports itself done
  7535. // early has truncated it; the short-body check below turns that into a
  7536. // failure rather than calling the provider again forever.
  7537. data_sink.done = [&]() { finished = true; };
  7538. while (offset < length && !finished) {
  7539. auto prev_offset = offset;
  7540. if (!content_provider(offset, length - offset, data_sink) || !ok) {
  7541. return false;
  7542. }
  7543. // No Stream to block on here, so a provider that keeps returning true
  7544. // without writing would spin. Treat a pass that made no progress as a
  7545. // failure.
  7546. if (offset == prev_offset) { return false; }
  7547. }
  7548. if (offset != length) { return false; }
  7549. return cmp.compress(nullptr, 0, true, append);
  7550. }
  7551. // Serves `m` as the response body. `set_content_provider()` clears the coding
  7552. // and the file flag, so recording them has to come after; keeping all of it
  7553. // here means a third file-serving path cannot get that order wrong.
  7554. inline void set_file_content_provider(Response &res,
  7555. const std::shared_ptr<mmap> &m,
  7556. const std::string &content_type,
  7557. EncodingType encoding) {
  7558. // One read and one write move up to this much of the file at a time.
  7559. auto buf = std::make_shared<std::vector<char>>(
  7560. (std::min)(m->size(), size_t(256 * 1024)));
  7561. res.set_content_provider(
  7562. m->size(), content_type,
  7563. [m, buf](size_t offset, size_t length, DataSink &sink) -> bool {
  7564. // Never read past the file, which ends the response early if it has
  7565. // shrunk since it was opened.
  7566. auto n = m->read(offset, buf->data(), (std::min)(length, buf->size()));
  7567. if (n == 0) { return false; }
  7568. sink.write(buf->data(), n);
  7569. return true;
  7570. });
  7571. res.is_file_content_provider_ = true;
  7572. res.content_coding_ = encoding;
  7573. }
  7574. template <typename T, typename U>
  7575. inline bool
  7576. write_content_chunked(Stream &strm, const ContentProvider &content_provider,
  7577. const T &is_shutting_down, U &compressor, Error &error) {
  7578. size_t offset = 0;
  7579. auto data_available = true;
  7580. auto ok = true;
  7581. DataSink data_sink;
  7582. data_sink.write = [&](const char *d, size_t l) -> bool {
  7583. // Only done()/done_with_trailer() end a chunked body. A pass with nothing
  7584. // to hand over is ordinary (an empty buffer popped off a queue), and a
  7585. // zero-length chunk is the terminator, so it must not be emitted here.
  7586. if (ok && l > 0) {
  7587. offset += l;
  7588. std::string payload;
  7589. if (compressor.compress(d, l, false,
  7590. [&](const char *data, size_t data_len) {
  7591. payload.append(data, data_len);
  7592. return true;
  7593. })) {
  7594. if (!payload.empty()) {
  7595. // Emit chunked response header and footer for each chunk
  7596. auto chunk =
  7597. from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7598. if (!write_data(strm, chunk.data(), chunk.size())) { ok = false; }
  7599. }
  7600. } else {
  7601. ok = false;
  7602. }
  7603. }
  7604. return ok;
  7605. };
  7606. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7607. auto done_with_trailer = [&](const Headers *trailer) {
  7608. if (!ok) { return; }
  7609. data_available = false;
  7610. std::string payload;
  7611. if (!compressor.compress(nullptr, 0, true,
  7612. [&](const char *data, size_t data_len) {
  7613. payload.append(data, data_len);
  7614. return true;
  7615. })) {
  7616. ok = false;
  7617. return;
  7618. }
  7619. if (!payload.empty()) {
  7620. // Emit chunked response header and footer for each chunk
  7621. auto chunk = from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7622. if (!write_data(strm, chunk.data(), chunk.size())) {
  7623. ok = false;
  7624. return;
  7625. }
  7626. }
  7627. constexpr const char done_marker[] = "0\r\n";
  7628. if (!write_data(strm, done_marker, str_len(done_marker))) { ok = false; }
  7629. // Trailer
  7630. if (trailer) {
  7631. for (const auto &kv : *trailer) {
  7632. // Skip fields with invalid names or values to prevent response
  7633. // splitting via CR/LF injection, matching set_header().
  7634. if (!fields::is_field_valid(kv.first, kv.second)) { continue; }
  7635. std::string field_line = kv.first + ": " + kv.second + "\r\n";
  7636. if (!write_data(strm, field_line.data(), field_line.size())) {
  7637. ok = false;
  7638. }
  7639. }
  7640. }
  7641. constexpr const char crlf[] = "\r\n";
  7642. if (!write_data(strm, crlf, str_len(crlf))) { ok = false; }
  7643. };
  7644. data_sink.done = [&](void) { done_with_trailer(nullptr); };
  7645. data_sink.done_with_trailer = [&](const Headers &trailer) {
  7646. done_with_trailer(&trailer);
  7647. };
  7648. while (data_available && !is_shutting_down()) {
  7649. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7650. error = Error::Write;
  7651. return false;
  7652. } else if (!content_provider(offset, 0, data_sink)) {
  7653. error = Error::Canceled;
  7654. return false;
  7655. } else if (!ok) {
  7656. error = Error::Write;
  7657. return false;
  7658. }
  7659. }
  7660. if (data_available) { // exited due to is_shutting_down(), not done()
  7661. error = Error::Write;
  7662. return false;
  7663. }
  7664. error = Error::Success;
  7665. return true;
  7666. }
  7667. template <typename T, typename U>
  7668. inline bool write_content_chunked(Stream &strm,
  7669. const ContentProvider &content_provider,
  7670. const T &is_shutting_down, U &compressor) {
  7671. auto error = Error::Success;
  7672. return write_content_chunked(strm, content_provider, is_shutting_down,
  7673. compressor, error);
  7674. }
  7675. template <typename T>
  7676. inline bool redirect(T &cli, Request &req, Response &res,
  7677. const std::string &path, const std::string &location,
  7678. Error &error) {
  7679. Request new_req = req;
  7680. new_req.path = path;
  7681. new_req.redirect_count_ -= 1;
  7682. if (res.status == StatusCode::SeeOther_303 &&
  7683. (req.method != "GET" && req.method != "HEAD")) {
  7684. new_req.method = "GET";
  7685. new_req.body.clear();
  7686. new_req.headers.clear();
  7687. new_req.content_length_ = 0;
  7688. new_req.content_provider_ = nullptr;
  7689. new_req.is_chunked_content_provider_ = false;
  7690. }
  7691. Response new_res;
  7692. auto ret = cli.send(new_req, new_res, error);
  7693. if (ret) {
  7694. req = std::move(new_req);
  7695. res = std::move(new_res);
  7696. if (res.location.empty()) { res.location = location; }
  7697. }
  7698. return ret;
  7699. }
  7700. inline std::string params_to_query_str(const Params &params) {
  7701. std::string query;
  7702. for (auto it = params.begin(); it != params.end(); ++it) {
  7703. if (it != params.begin()) { query += '&'; }
  7704. query += encode_query_component(it->first);
  7705. query += '=';
  7706. query += encode_query_component(it->second);
  7707. }
  7708. return query;
  7709. }
  7710. // Splits one "key=value" span of a query string at its first '='. A span with
  7711. // no '=' at all lands entirely in key, leaving val empty, which is how a bare
  7712. // "?flag" keeps its name.
  7713. inline void divide_query_pair(const char *b, const char *e, std::string &key,
  7714. std::string &val) {
  7715. divide(b, static_cast<std::size_t>(e - b), '=',
  7716. [&](const char *lhs_data, std::size_t lhs_size, const char *rhs_data,
  7717. std::size_t rhs_size) {
  7718. key.assign(lhs_data, lhs_size);
  7719. val.assign(rhs_data, rhs_size);
  7720. });
  7721. }
  7722. inline void parse_query_text(const char *data, std::size_t size,
  7723. Params &params) {
  7724. std::set<std::string> cache;
  7725. split(data, data + size, '&', [&](const char *b, const char *e) {
  7726. std::string kv(b, e);
  7727. if (cache.find(kv) != cache.end()) { return; }
  7728. cache.insert(std::move(kv));
  7729. std::string key;
  7730. std::string val;
  7731. divide_query_pair(b, e, key, val);
  7732. if (!key.empty()) {
  7733. params.emplace(decode_query_component(key), decode_query_component(val));
  7734. }
  7735. });
  7736. }
  7737. inline void parse_query_text(const std::string &s, Params &params) {
  7738. parse_query_text(s.data(), s.size(), params);
  7739. }
  7740. // Normalize a query string by decoding and re-encoding each key/value pair
  7741. // while preserving the original parameter order. This avoids double-encoding
  7742. // and ensures consistent encoding. It works on the raw string rather than
  7743. // parsing into Params and re-serializing, because that round trip cannot
  7744. // reproduce the input: params_to_query_str() always emits '=', so a bare
  7745. // "flag" would come back as "flag=", and parse_query_text() drops exactly
  7746. // duplicated pairs.
  7747. inline std::string normalize_query_string(const std::string &query) {
  7748. std::string result;
  7749. split(query.data(), query.data() + query.size(), '&',
  7750. [&](const char *b, const char *e) {
  7751. std::string key;
  7752. std::string val;
  7753. divide_query_pair(b, e, key, val);
  7754. if (!key.empty()) {
  7755. auto dec_key = decode_query_component(key);
  7756. auto dec_val = decode_query_component(val);
  7757. if (!result.empty()) { result += '&'; }
  7758. result += encode_query_component(dec_key);
  7759. if (!val.empty() || std::find(b, e, '=') != e) {
  7760. result += '=';
  7761. result += encode_query_component(dec_val);
  7762. }
  7763. }
  7764. });
  7765. return result;
  7766. }
  7767. // Build the request target that goes on the wire from a caller-supplied path.
  7768. // Shared by the buffered send path and the streaming API so that both put the
  7769. // same bytes in the request line for the same input.
  7770. inline std::string encode_request_target(const std::string &uri,
  7771. bool path_encode) {
  7772. // The fragment stays with the client (RFC 9110 §7.1).
  7773. auto target = uri.substr(0, uri.find('#'));
  7774. // `substr(0, npos)` yields the whole string, which is what the no-query
  7775. // case needs.
  7776. auto query_pos = target.find('?');
  7777. auto path_part = target.substr(0, query_pos);
  7778. std::string query_part;
  7779. if (query_pos != std::string::npos) {
  7780. query_part = target.substr(query_pos + 1);
  7781. }
  7782. auto result = path_encode ? encode_path(path_part) : std::move(path_part);
  7783. if (!query_part.empty()) {
  7784. // When path encoding is disabled the caller has supplied an already-encoded
  7785. // target and expects the exact bytes to be sent on the wire, so skip
  7786. // normalization for the query too. Normalizing would decode-then-re-encode
  7787. // it and corrupt pre-encoded binary payloads (e.g. turning `%20` into `+`,
  7788. // which a strict RFC 3986 server decodes back as `+`, not a space).
  7789. if (path_encode) {
  7790. auto normalized = normalize_query_string(query_part);
  7791. if (!normalized.empty()) {
  7792. result += '?';
  7793. result += normalized;
  7794. }
  7795. } else {
  7796. result += '?';
  7797. result += query_part;
  7798. }
  7799. }
  7800. return result;
  7801. }
  7802. inline bool parse_multipart_boundary(const std::string &content_type,
  7803. std::string &boundary) {
  7804. std::map<std::string, std::string> params;
  7805. extract_media_type(content_type, &params);
  7806. auto it = params.find("boundary");
  7807. if (it == params.end()) { return false; }
  7808. boundary = it->second;
  7809. // RFC 2046 5.1.1 caps a boundary at 70 characters. The parser scans the body
  7810. // for "--" + boundary, so a body crafted to repeat that delimiter's leading
  7811. // bytes costs a nearly full comparison at nearly every position: the
  7812. // boundary's length multiplies the worst-case cost of scanning a body.
  7813. return !boundary.empty() && boundary.size() <= 70;
  7814. }
  7815. // Takes the quotes off a parameter value. Only \" and \\ are quoted-pairs
  7816. // here, as browsers send any other backslash, such as one in a Windows path,
  7817. // as it is.
  7818. inline std::string unquote_disposition_param(const std::string &s) {
  7819. if (s.size() < 2 || s.front() != '"' || s.back() != '"') { return s; }
  7820. std::string out;
  7821. for (size_t i = 1; i + 1 < s.size(); i++) {
  7822. if (s[i] == '\\' && i + 2 < s.size() &&
  7823. (s[i + 1] == '"' || s[i + 1] == '\\')) {
  7824. i++;
  7825. }
  7826. out += s[i];
  7827. }
  7828. return out;
  7829. }
  7830. inline void parse_disposition_params(const std::string &s, Params &params) {
  7831. std::set<std::string> cache;
  7832. split_unquoted(s.data(), s.data() + s.size(), ';',
  7833. [&](const char *b, const char *e) {
  7834. std::string kv(b, e);
  7835. if (cache.find(kv) != cache.end()) { return; }
  7836. cache.insert(kv);
  7837. std::string key;
  7838. std::string val;
  7839. divide_param_pair(b, e, key, val);
  7840. if (!key.empty()) {
  7841. params.emplace(trim_double_quotes_copy(key),
  7842. unquote_disposition_param(val));
  7843. }
  7844. });
  7845. }
  7846. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7847. inline bool parse_range_header(const std::string &s, Ranges &ranges) {
  7848. #else
  7849. inline bool parse_range_header(const std::string &s, Ranges &ranges) try {
  7850. #endif
  7851. auto is_valid = [](const std::string &str) {
  7852. return std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  7853. };
  7854. if (s.size() > 7 && case_ignore::equal(s.substr(0, 6), "bytes=")) {
  7855. const auto pos = static_cast<size_t>(6);
  7856. const auto len = static_cast<size_t>(s.size() - 6);
  7857. auto all_valid_ranges = true;
  7858. split(&s[pos], &s[pos + len], ',', [&](const char *b, const char *e) {
  7859. if (!all_valid_ranges) { return; }
  7860. const auto it = std::find(b, e, '-');
  7861. if (it == e) {
  7862. all_valid_ranges = false;
  7863. return;
  7864. }
  7865. const auto lhs = std::string(b, it);
  7866. const auto rhs = std::string(it + 1, e);
  7867. if (!is_valid(lhs) || !is_valid(rhs)) {
  7868. all_valid_ranges = false;
  7869. return;
  7870. }
  7871. ssize_t first = -1;
  7872. if (!lhs.empty()) {
  7873. // Reject an overflowing first-byte-pos; treating it as absent (-1)
  7874. // would turn the range into a suffix range.
  7875. auto res =
  7876. detail::from_chars(lhs.data(), lhs.data() + lhs.size(), first);
  7877. if (res.ec != std::errc{}) {
  7878. all_valid_ranges = false;
  7879. return;
  7880. }
  7881. }
  7882. ssize_t last = -1;
  7883. if (!rhs.empty()) {
  7884. // An overflowing last-byte-pos is past any content length, so keeping
  7885. // -1 ("remainder", RFC 9110 14.1.2) is correct here.
  7886. ssize_t v;
  7887. auto res = detail::from_chars(rhs.data(), rhs.data() + rhs.size(), v);
  7888. if (res.ec == std::errc{}) { last = v; }
  7889. }
  7890. if ((first == -1 && last == -1) ||
  7891. (first != -1 && last != -1 && first > last)) {
  7892. all_valid_ranges = false;
  7893. return;
  7894. }
  7895. ranges.emplace_back(first, last);
  7896. });
  7897. return all_valid_ranges && !ranges.empty();
  7898. }
  7899. return false;
  7900. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7901. }
  7902. #else
  7903. } catch (...) { return false; }
  7904. #endif
  7905. // Removes each quoted-string, honoring a quoted-pair (RFC 9110 Section 5.6.4)
  7906. inline std::string remove_quoted_strings(const std::string &s) {
  7907. std::string out;
  7908. auto in_quotes = false;
  7909. for (size_t i = 0; i < s.size(); i++) {
  7910. if (s[i] == '"') {
  7911. in_quotes = !in_quotes;
  7912. } else if (!in_quotes) {
  7913. out += s[i];
  7914. } else if (s[i] == '\\') {
  7915. i++;
  7916. }
  7917. }
  7918. return out;
  7919. }
  7920. inline bool parse_accept_header(const std::string &s,
  7921. std::vector<std::string> &content_types) {
  7922. // Parameter values are not used here, so a quoted-string is dropped rather
  7923. // than parsed: a ',' or ';' inside one must not be read as a delimiter.
  7924. if (s.find('"') != std::string::npos) {
  7925. return parse_accept_header(remove_quoted_strings(s), content_types);
  7926. }
  7927. content_types.clear();
  7928. // Empty string is considered valid (no preference)
  7929. if (s.empty()) { return true; }
  7930. struct AcceptEntry {
  7931. std::string media_type;
  7932. double quality;
  7933. int order;
  7934. };
  7935. std::vector<AcceptEntry> entries;
  7936. int order = 0;
  7937. bool has_invalid_entry = false;
  7938. // Split by comma and parse each entry. RFC 9110 Section 5.6.1.2: a recipient
  7939. // has to parse and ignore empty list elements, so a leading, trailing or
  7940. // doubled comma must not turn a legal Accept value into 400 Bad Request.
  7941. // split() skips them, and the header length limit bounds how many a sender
  7942. // can send, so ignoring all of them cannot be used as a denial-of-service
  7943. // vector.
  7944. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  7945. std::string entry(b, e);
  7946. entry = trim_copy(entry);
  7947. AcceptEntry accept_entry;
  7948. accept_entry.order = order++;
  7949. if (!parse_quality(entry.data(), entry.data() + entry.size(),
  7950. accept_entry.media_type, accept_entry.quality)) {
  7951. has_invalid_entry = true;
  7952. return;
  7953. }
  7954. // Remove additional parameters from media type
  7955. accept_entry.media_type = extract_media_type(accept_entry.media_type);
  7956. // Basic validation of media type format
  7957. if (accept_entry.media_type.empty()) {
  7958. has_invalid_entry = true;
  7959. return;
  7960. }
  7961. // Check for basic media type format (should contain '/' or be '*')
  7962. if (accept_entry.media_type != "*" &&
  7963. accept_entry.media_type.find('/') == std::string::npos) {
  7964. has_invalid_entry = true;
  7965. return;
  7966. }
  7967. entries.push_back(std::move(accept_entry));
  7968. });
  7969. // Return false if any invalid entry was found
  7970. if (has_invalid_entry) { return false; }
  7971. // Sort by quality (descending), then by original order (ascending)
  7972. std::sort(entries.begin(), entries.end(),
  7973. [](const AcceptEntry &a, const AcceptEntry &b) {
  7974. if (a.quality != b.quality) {
  7975. return a.quality > b.quality; // Higher quality first
  7976. }
  7977. return a.order < b.order; // Earlier order first for same quality
  7978. });
  7979. // Extract sorted media types
  7980. content_types.reserve(entries.size());
  7981. for (auto &entry : entries) {
  7982. content_types.push_back(std::move(entry.media_type));
  7983. }
  7984. return true;
  7985. }
  7986. class FormDataParser {
  7987. public:
  7988. FormDataParser() = default;
  7989. void set_boundary(std::string &&boundary) {
  7990. boundary_ = std::move(boundary);
  7991. dash_boundary_crlf_ = dash_ + boundary_ + crlf_;
  7992. crlf_dash_boundary_ = crlf_ + dash_ + boundary_;
  7993. }
  7994. bool is_valid() const { return is_valid_; }
  7995. bool parse(const char *buf, size_t n, const FormDataHeader &header_callback,
  7996. const ContentReceiver &content_callback) {
  7997. // Once the close delimiter has been seen the rest of the body is epilogue
  7998. // to be discarded (RFC 2046). Drop it without buffering so a large epilogue
  7999. // spread across reads is not copied in only to be erased right away.
  8000. if (state_ == 5) { return true; }
  8001. buf_append(buf, n);
  8002. while (buf_size() > 0) {
  8003. switch (state_) {
  8004. case 0: { // Initial boundary
  8005. auto pos = buf_find(dash_boundary_crlf_);
  8006. if (pos == buf_size()) {
  8007. // Not found yet: keep only a possible partial boundary at the tail so
  8008. // that a body which never contains the boundary cannot grow the
  8009. // buffer (and get rescanned from the start) without bound.
  8010. auto keep = dash_boundary_crlf_.size() - 1;
  8011. if (buf_size() > keep) { buf_erase(buf_size() - keep); }
  8012. return true;
  8013. }
  8014. buf_erase(pos + dash_boundary_crlf_.size());
  8015. state_ = 1;
  8016. break;
  8017. }
  8018. case 1: { // New entry
  8019. clear_file_info();
  8020. header_searched_ = 0;
  8021. state_ = 2;
  8022. break;
  8023. }
  8024. case 2: { // Headers
  8025. // Resume where the last call stopped looking, so that a line arriving
  8026. // a few bytes at a time is not searched from its start each time.
  8027. auto pos = buf_find(crlf_, header_searched_);
  8028. if (pos > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  8029. while (pos < buf_size()) {
  8030. // Empty line
  8031. if (pos == 0) {
  8032. if (!header_callback(file_)) {
  8033. is_valid_ = false;
  8034. return false;
  8035. }
  8036. buf_erase(crlf_.size());
  8037. state_ = 3;
  8038. break;
  8039. }
  8040. // Check header count limit
  8041. if (header_count_ >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  8042. is_valid_ = false;
  8043. return false;
  8044. }
  8045. header_count_++;
  8046. const auto header = buf_head(pos);
  8047. if (!parse_header(header.data(), header.data() + header.size(),
  8048. [&](const std::string &, const std::string &) {})) {
  8049. is_valid_ = false;
  8050. return false;
  8051. }
  8052. // Parse and emplace space trimmed headers into a map
  8053. if (!parse_header(
  8054. header.data(), header.data() + header.size(),
  8055. [&](const std::string &key, const std::string &val) {
  8056. file_.headers.emplace(key, val);
  8057. })) {
  8058. is_valid_ = false;
  8059. return false;
  8060. }
  8061. constexpr const char header_content_type[] = "Content-Type:";
  8062. if (start_with_case_ignore(header, header_content_type)) {
  8063. file_.content_type =
  8064. trim_copy(header.substr(str_len(header_content_type)));
  8065. } else {
  8066. std::string disposition_params;
  8067. if (parse_content_disposition(header, disposition_params)) {
  8068. Params params;
  8069. parse_disposition_params(disposition_params, params);
  8070. auto it = params.find("name");
  8071. if (it != params.end()) {
  8072. file_.name = it->second;
  8073. } else {
  8074. is_valid_ = false;
  8075. return false;
  8076. }
  8077. it = params.find("filename");
  8078. if (it != params.end()) { file_.filename = it->second; }
  8079. it = params.find("filename*");
  8080. if (it != params.end()) {
  8081. // RFC 5987: only UTF-8 encoding is allowed
  8082. const auto &val = it->second;
  8083. constexpr const char utf8_prefix[] = "UTF-8''";
  8084. constexpr size_t prefix_len = str_len(utf8_prefix);
  8085. if (val.size() > prefix_len &&
  8086. start_with_case_ignore(val, utf8_prefix)) {
  8087. file_.filename = decode_path_component(
  8088. val.substr(prefix_len)); // override...
  8089. } else {
  8090. is_valid_ = false;
  8091. return false;
  8092. }
  8093. }
  8094. }
  8095. }
  8096. buf_erase(pos + crlf_.size());
  8097. pos = buf_find(crlf_);
  8098. }
  8099. if (state_ != 3) {
  8100. // The CR of the CRLF may be the last byte so far.
  8101. header_searched_ = buf_size() > 0 ? buf_size() - 1 : 0;
  8102. return true;
  8103. }
  8104. break;
  8105. }
  8106. case 3: { // Body
  8107. if (crlf_dash_boundary_.size() > buf_size()) { return true; }
  8108. auto pos = buf_find(crlf_dash_boundary_);
  8109. if (pos < buf_size()) {
  8110. if (!content_callback(buf_data(), pos)) {
  8111. is_valid_ = false;
  8112. return false;
  8113. }
  8114. buf_erase(pos + crlf_dash_boundary_.size());
  8115. state_ = 4;
  8116. } else {
  8117. auto len = buf_size() - crlf_dash_boundary_.size();
  8118. if (len > 0) {
  8119. if (!content_callback(buf_data(), len)) {
  8120. is_valid_ = false;
  8121. return false;
  8122. }
  8123. buf_erase(len);
  8124. }
  8125. return true;
  8126. }
  8127. break;
  8128. }
  8129. case 4: { // Boundary
  8130. if (crlf_.size() > buf_size()) { return true; }
  8131. if (buf_start_with(crlf_)) {
  8132. buf_erase(crlf_.size());
  8133. state_ = 1;
  8134. } else if (buf_start_with(dash_)) {
  8135. buf_erase(dash_.size());
  8136. is_valid_ = true;
  8137. state_ = 5;
  8138. } else {
  8139. // Only CRLF (another part follows) and "--" (close-delimiter) are
  8140. // accepted after a boundary; RFC 2046 allows transport-padding in
  8141. // between, but this parser has never supported it. Either way the
  8142. // body is already destined to be rejected, so fail now instead of
  8143. // buffering the rest of it. Both are two bytes, so the check above
  8144. // already guarantees enough buffered data to decide.
  8145. is_valid_ = false;
  8146. return false;
  8147. }
  8148. break;
  8149. }
  8150. case 5: { // Epilogue
  8151. buf_erase(buf_size());
  8152. break;
  8153. }
  8154. }
  8155. }
  8156. return true;
  8157. }
  8158. private:
  8159. void clear_file_info() {
  8160. file_.name.clear();
  8161. file_.filename.clear();
  8162. file_.content_type.clear();
  8163. file_.headers.clear();
  8164. header_count_ = 0;
  8165. }
  8166. bool start_with_case_ignore(const std::string &a, const char *b,
  8167. size_t offset = 0) const {
  8168. const auto b_len = strlen(b);
  8169. if (a.size() < offset + b_len) { return false; }
  8170. for (size_t i = 0; i < b_len; i++) {
  8171. if (case_ignore::to_lower(a[offset + i]) != case_ignore::to_lower(b[i])) {
  8172. return false;
  8173. }
  8174. }
  8175. return true;
  8176. }
  8177. // Parses "Content-Disposition: form-data; <params>" without std::regex.
  8178. // Returns true if header matches, with the params portion in `params_out`.
  8179. bool parse_content_disposition(const std::string &header,
  8180. std::string &params_out) const {
  8181. constexpr const char prefix[] = "Content-Disposition:";
  8182. constexpr size_t prefix_len = str_len(prefix);
  8183. if (!start_with_case_ignore(header, prefix)) { return false; }
  8184. // Skip whitespace after "Content-Disposition:"
  8185. auto pos = prefix_len;
  8186. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8187. pos++;
  8188. }
  8189. // Match "form-data;" (case-insensitive)
  8190. constexpr const char form_data[] = "form-data;";
  8191. constexpr size_t form_data_len = str_len(form_data);
  8192. if (!start_with_case_ignore(header, form_data, pos)) { return false; }
  8193. pos += form_data_len;
  8194. // Skip whitespace after "form-data;"
  8195. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8196. pos++;
  8197. }
  8198. params_out = header.substr(pos);
  8199. return true;
  8200. }
  8201. const std::string dash_ = "--";
  8202. const std::string crlf_ = "\r\n";
  8203. std::string boundary_;
  8204. std::string dash_boundary_crlf_;
  8205. std::string crlf_dash_boundary_;
  8206. size_t state_ = 0;
  8207. bool is_valid_ = false;
  8208. FormData file_;
  8209. size_t header_count_ = 0;
  8210. size_t header_searched_ = 0;
  8211. // Buffer
  8212. bool start_with(const std::string &a, size_t spos, size_t epos,
  8213. const std::string &b) const {
  8214. if (epos - spos < b.size()) { return false; }
  8215. for (size_t i = 0; i < b.size(); i++) {
  8216. if (a[i + spos] != b[i]) { return false; }
  8217. }
  8218. return true;
  8219. }
  8220. size_t buf_size() const { return buf_epos_ - buf_spos_; }
  8221. const char *buf_data() const { return &buf_[buf_spos_]; }
  8222. std::string buf_head(size_t l) const { return buf_.substr(buf_spos_, l); }
  8223. bool buf_start_with(const std::string &s) const {
  8224. return start_with(buf_, buf_spos_, buf_epos_, s);
  8225. }
  8226. size_t buf_find(const std::string &s, size_t from = 0) const {
  8227. auto c = s.front();
  8228. size_t off = buf_spos_ + from;
  8229. while (off < buf_epos_) {
  8230. auto pos = off;
  8231. while (true) {
  8232. if (pos == buf_epos_) { return buf_size(); }
  8233. if (buf_[pos] == c) { break; }
  8234. pos++;
  8235. }
  8236. auto remaining_size = buf_epos_ - pos;
  8237. if (s.size() > remaining_size) { return buf_size(); }
  8238. if (start_with(buf_, pos, buf_epos_, s)) { return pos - buf_spos_; }
  8239. off = pos + 1;
  8240. }
  8241. return buf_size();
  8242. }
  8243. void buf_append(const char *data, size_t n) {
  8244. auto remaining_size = buf_size();
  8245. if (remaining_size > 0 && buf_spos_ > 0) {
  8246. for (size_t i = 0; i < remaining_size; i++) {
  8247. buf_[i] = buf_[buf_spos_ + i];
  8248. }
  8249. }
  8250. buf_spos_ = 0;
  8251. buf_epos_ = remaining_size;
  8252. if (remaining_size + n > buf_.size()) { buf_.resize(remaining_size + n); }
  8253. for (size_t i = 0; i < n; i++) {
  8254. buf_[buf_epos_ + i] = data[i];
  8255. }
  8256. buf_epos_ += n;
  8257. }
  8258. void buf_erase(size_t size) { buf_spos_ += size; }
  8259. std::string buf_;
  8260. size_t buf_spos_ = 0;
  8261. size_t buf_epos_ = 0;
  8262. };
  8263. inline std::string random_string(size_t length) {
  8264. constexpr const char data[] =
  8265. "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
  8266. std::string result(length, '\0');
  8267. fill_random_bytes(reinterpret_cast<unsigned char *>(&result[0]), length);
  8268. for (auto &c : result) {
  8269. c = data[static_cast<unsigned char>(c) % (sizeof(data) - 1)];
  8270. }
  8271. return result;
  8272. }
  8273. inline std::string make_multipart_data_boundary() {
  8274. return "--cpp-httplib-multipart-data-" + detail::random_string(16);
  8275. }
  8276. inline bool is_multipart_boundary_chars_valid(const std::string &boundary) {
  8277. auto valid = true;
  8278. for (size_t i = 0; i < boundary.size(); i++) {
  8279. auto c = boundary[i];
  8280. if (!is_ascii_alnum(c) && c != '-' && c != '_') {
  8281. valid = false;
  8282. break;
  8283. }
  8284. }
  8285. return valid;
  8286. }
  8287. // Escape a multipart field name/filename following the WHATWG HTML standard
  8288. // ("escape a multipart form-data name"), which is what browsers send:
  8289. // '"' -> %22, CR -> %0D, LF -> %0A
  8290. // With escape_quote = false, only CR and LF are escaped; this is for header
  8291. // values outside a quoted-string (e.g. Content-Type), where '"' is legal.
  8292. inline std::string escape_multipart_field(const std::string &s,
  8293. bool escape_quote = true) {
  8294. std::string result;
  8295. result.reserve(s.size());
  8296. for (auto c : s) {
  8297. switch (c) {
  8298. case '"':
  8299. if (escape_quote) {
  8300. result += "%22";
  8301. } else {
  8302. result += c;
  8303. }
  8304. break;
  8305. case '\r': result += "%0D"; break;
  8306. case '\n': result += "%0A"; break;
  8307. default: result += c; break;
  8308. }
  8309. }
  8310. return result;
  8311. }
  8312. template <typename T>
  8313. inline std::string
  8314. serialize_multipart_formdata_item_begin(const T &item,
  8315. const std::string &boundary) {
  8316. std::string body = "--" + boundary + "\r\n";
  8317. body += "Content-Disposition: form-data; name=\"" +
  8318. escape_multipart_field(item.name) + "\"";
  8319. if (!item.filename.empty()) {
  8320. body += "; filename=\"" + escape_multipart_field(item.filename) + "\"";
  8321. }
  8322. body += "\r\n";
  8323. if (!item.content_type.empty()) {
  8324. body +=
  8325. "Content-Type: " + escape_multipart_field(item.content_type, false) +
  8326. "\r\n";
  8327. }
  8328. body += "\r\n";
  8329. return body;
  8330. }
  8331. inline std::string serialize_multipart_formdata_item_end() { return "\r\n"; }
  8332. inline std::string
  8333. serialize_multipart_formdata_finish(const std::string &boundary) {
  8334. return "--" + boundary + "--\r\n";
  8335. }
  8336. inline std::string
  8337. serialize_multipart_formdata_get_content_type(const std::string &boundary) {
  8338. return "multipart/form-data; boundary=" + boundary;
  8339. }
  8340. inline std::string
  8341. serialize_multipart_formdata(const UploadFormDataItems &items,
  8342. const std::string &boundary, bool finish = true) {
  8343. std::string body;
  8344. for (const auto &item : items) {
  8345. body += serialize_multipart_formdata_item_begin(item, boundary);
  8346. body += item.content + serialize_multipart_formdata_item_end();
  8347. }
  8348. if (finish) { body += serialize_multipart_formdata_finish(boundary); }
  8349. return body;
  8350. }
  8351. inline size_t get_multipart_content_length(const UploadFormDataItems &items,
  8352. const std::string &boundary) {
  8353. size_t total = 0;
  8354. for (const auto &item : items) {
  8355. total += serialize_multipart_formdata_item_begin(item, boundary).size();
  8356. total += item.content.size();
  8357. total += serialize_multipart_formdata_item_end().size();
  8358. }
  8359. total += serialize_multipart_formdata_finish(boundary).size();
  8360. return total;
  8361. }
  8362. struct MultipartSegment {
  8363. const char *data;
  8364. size_t size;
  8365. };
  8366. // NOTE: items must outlive the returned ContentProvider
  8367. // (safe for synchronous use inside Post/Put/Patch)
  8368. inline ContentProvider
  8369. make_multipart_content_provider(const UploadFormDataItems &items,
  8370. const std::string &boundary) {
  8371. // Own the per-item header strings and the finish string
  8372. std::vector<std::string> owned;
  8373. owned.reserve(items.size() + 1);
  8374. for (const auto &item : items)
  8375. owned.push_back(serialize_multipart_formdata_item_begin(item, boundary));
  8376. owned.push_back(serialize_multipart_formdata_finish(boundary));
  8377. // Flat segment list: [header, content, "\r\n"] * N + [finish]
  8378. std::vector<MultipartSegment> segs;
  8379. segs.reserve(items.size() * 3 + 1);
  8380. static const char crlf[] = "\r\n";
  8381. for (size_t i = 0; i < items.size(); i++) {
  8382. segs.push_back({owned[i].data(), owned[i].size()});
  8383. segs.push_back({items[i].content.data(), items[i].content.size()});
  8384. segs.push_back({crlf, 2});
  8385. }
  8386. segs.push_back({owned.back().data(), owned.back().size()});
  8387. struct MultipartState {
  8388. std::vector<std::string> owned;
  8389. std::vector<MultipartSegment> segs;
  8390. std::vector<char> buf = std::vector<char>(CPPHTTPLIB_SEND_BUFSIZ);
  8391. };
  8392. auto state = std::make_shared<MultipartState>();
  8393. state->owned = std::move(owned);
  8394. // `segs` holds raw pointers into owned strings; std::string move preserves
  8395. // the data pointer, so these pointers remain valid after the move above.
  8396. state->segs = std::move(segs);
  8397. return [state](size_t offset, size_t length, DataSink &sink) -> bool {
  8398. // Buffer multiple small segments into fewer, larger writes to avoid
  8399. // excessive TCP packets when there are many form data items (#2410)
  8400. auto &buf = state->buf;
  8401. auto buf_size = buf.size();
  8402. size_t buf_len = 0;
  8403. size_t remaining = length;
  8404. // Find the first segment containing 'offset'
  8405. size_t pos = 0;
  8406. size_t seg_idx = 0;
  8407. for (; seg_idx < state->segs.size(); seg_idx++) {
  8408. const auto &seg = state->segs[seg_idx];
  8409. if (seg.size > 0 && offset - pos < seg.size) { break; }
  8410. pos += seg.size;
  8411. }
  8412. size_t seg_offset = (seg_idx < state->segs.size()) ? offset - pos : 0;
  8413. for (; seg_idx < state->segs.size() && remaining > 0; seg_idx++) {
  8414. const auto &seg = state->segs[seg_idx];
  8415. size_t available = seg.size - seg_offset;
  8416. size_t to_copy = (std::min)(available, remaining);
  8417. const char *src = seg.data + seg_offset;
  8418. seg_offset = 0; // only the first segment has a non-zero offset
  8419. while (to_copy > 0) {
  8420. size_t space = buf_size - buf_len;
  8421. size_t chunk = (std::min)(to_copy, space);
  8422. std::memcpy(buf.data() + buf_len, src, chunk);
  8423. buf_len += chunk;
  8424. src += chunk;
  8425. to_copy -= chunk;
  8426. remaining -= chunk;
  8427. if (buf_len == buf_size) {
  8428. if (!sink.write(buf.data(), buf_len)) { return false; }
  8429. buf_len = 0;
  8430. }
  8431. }
  8432. }
  8433. if (buf_len > 0) { return sink.write(buf.data(), buf_len); }
  8434. return true;
  8435. };
  8436. }
  8437. inline void coalesce_ranges(Ranges &ranges, size_t content_length) {
  8438. if (ranges.size() <= 1) return;
  8439. // Sort ranges by start position
  8440. std::sort(ranges.begin(), ranges.end(),
  8441. [](const Range &a, const Range &b) { return a.first < b.first; });
  8442. Ranges coalesced;
  8443. coalesced.reserve(ranges.size());
  8444. for (auto &r : ranges) {
  8445. auto first_pos = r.first;
  8446. auto last_pos = r.second;
  8447. // Handle special cases like in range_error
  8448. if (first_pos == -1 && last_pos == -1) {
  8449. first_pos = 0;
  8450. last_pos = static_cast<ssize_t>(content_length);
  8451. }
  8452. if (first_pos == -1) {
  8453. first_pos = static_cast<ssize_t>(content_length) - last_pos;
  8454. last_pos = static_cast<ssize_t>(content_length) - 1;
  8455. }
  8456. if (last_pos == -1 || last_pos >= static_cast<ssize_t>(content_length)) {
  8457. last_pos = static_cast<ssize_t>(content_length) - 1;
  8458. }
  8459. // Skip invalid ranges
  8460. if (!(0 <= first_pos && first_pos <= last_pos &&
  8461. last_pos < static_cast<ssize_t>(content_length))) {
  8462. continue;
  8463. }
  8464. // Coalesce with previous range if overlapping or adjacent (but not
  8465. // identical)
  8466. if (!coalesced.empty()) {
  8467. auto &prev = coalesced.back();
  8468. // Check if current range overlaps or is adjacent to previous range
  8469. // but don't coalesce identical ranges (allow duplicates)
  8470. if (first_pos <= prev.second + 1 &&
  8471. !(first_pos == prev.first && last_pos == prev.second)) {
  8472. // Extend the previous range
  8473. prev.second = (std::max)(prev.second, last_pos);
  8474. continue;
  8475. }
  8476. }
  8477. // Add new range
  8478. coalesced.emplace_back(first_pos, last_pos);
  8479. }
  8480. ranges = std::move(coalesced);
  8481. }
  8482. inline bool range_error(Request &req, Response &res) {
  8483. if (!req.ranges.empty() && 200 <= res.status && res.status < 300) {
  8484. if (res.body.empty() && res.content_provider_ && res.content_length_ == 0) {
  8485. req.ranges.clear();
  8486. if (res.status == StatusCode::PartialContent_206) {
  8487. res.status = StatusCode::OK_200;
  8488. }
  8489. return false;
  8490. }
  8491. ssize_t content_len = static_cast<ssize_t>(
  8492. res.content_length_ ? res.content_length_ : res.body.size());
  8493. std::vector<std::pair<ssize_t, ssize_t>> processed_ranges;
  8494. size_t overwrapping_count = 0;
  8495. // NOTE: The following Range check is based on '14.2. Range' in RFC 9110
  8496. // 'HTTP Semantics' to avoid potential denial-of-service attacks.
  8497. // https://www.rfc-editor.org/rfc/rfc9110#section-14.2
  8498. // Too many ranges
  8499. if (req.ranges.size() > CPPHTTPLIB_RANGE_MAX_COUNT) { return true; }
  8500. for (auto &r : req.ranges) {
  8501. auto &first_pos = r.first;
  8502. auto &last_pos = r.second;
  8503. if (first_pos == -1 && last_pos == -1) {
  8504. first_pos = 0;
  8505. last_pos = content_len;
  8506. }
  8507. // RFC 9110 14.1.2: a suffix-length longer than the representation
  8508. // selects the entire representation.
  8509. if (first_pos == -1) {
  8510. first_pos = (std::max)(static_cast<ssize_t>(0), content_len - last_pos);
  8511. last_pos = content_len - 1;
  8512. }
  8513. // NOTE: RFC-9110 '14.1.2. Byte Ranges':
  8514. // A client can limit the number of bytes requested without knowing the
  8515. // size of the selected representation. If the last-pos value is absent,
  8516. // or if the value is greater than or equal to the current length of the
  8517. // representation data, the byte range is interpreted as the remainder of
  8518. // the representation (i.e., the server replaces the value of last-pos
  8519. // with a value that is one less than the current length of the selected
  8520. // representation).
  8521. // https://www.rfc-editor.org/rfc/rfc9110.html#section-14.1.2-6
  8522. if (last_pos == -1 || last_pos >= content_len) {
  8523. last_pos = content_len - 1;
  8524. }
  8525. // Range must be within content length
  8526. if (!(0 <= first_pos && first_pos <= last_pos &&
  8527. last_pos <= content_len - 1)) {
  8528. return true;
  8529. }
  8530. // Request must not have more than two overlapping ranges
  8531. for (const auto &processed_range : processed_ranges) {
  8532. if (!(last_pos < processed_range.first ||
  8533. first_pos > processed_range.second)) {
  8534. overwrapping_count++;
  8535. if (overwrapping_count > 2) { return true; }
  8536. break; // Only count once per range
  8537. }
  8538. }
  8539. processed_ranges.emplace_back(first_pos, last_pos);
  8540. }
  8541. // After validation, coalesce overlapping ranges as per RFC 9110
  8542. coalesce_ranges(req.ranges, static_cast<size_t>(content_len));
  8543. }
  8544. return false;
  8545. }
  8546. inline std::pair<size_t, size_t>
  8547. get_range_offset_and_length(Range r, size_t content_length) {
  8548. assert(r.first != -1 && r.second != -1);
  8549. assert(0 <= r.first && r.first < static_cast<ssize_t>(content_length));
  8550. assert(r.first <= r.second &&
  8551. r.second < static_cast<ssize_t>(content_length));
  8552. (void)(content_length);
  8553. return std::make_pair(static_cast<size_t>(r.first),
  8554. static_cast<size_t>(r.second - r.first) + 1);
  8555. }
  8556. inline std::string make_content_range_header_field(
  8557. const std::pair<size_t, size_t> &offset_and_length, size_t content_length) {
  8558. auto st = offset_and_length.first;
  8559. auto ed = st + offset_and_length.second - 1;
  8560. std::string field = "bytes ";
  8561. field += std::to_string(st);
  8562. field += '-';
  8563. field += std::to_string(ed);
  8564. field += '/';
  8565. field += std::to_string(content_length);
  8566. return field;
  8567. }
  8568. template <typename SToken, typename CToken, typename Content>
  8569. bool process_multipart_ranges_data(const Request &req,
  8570. const std::string &boundary,
  8571. const std::string &content_type,
  8572. size_t content_length, SToken stoken,
  8573. CToken ctoken, Content content) {
  8574. for (size_t i = 0; i < req.ranges.size(); i++) {
  8575. ctoken("--");
  8576. stoken(boundary);
  8577. ctoken("\r\n");
  8578. if (!content_type.empty()) {
  8579. ctoken("Content-Type: ");
  8580. stoken(content_type);
  8581. ctoken("\r\n");
  8582. }
  8583. auto offset_and_length =
  8584. get_range_offset_and_length(req.ranges[i], content_length);
  8585. ctoken("Content-Range: ");
  8586. stoken(make_content_range_header_field(offset_and_length, content_length));
  8587. ctoken("\r\n");
  8588. ctoken("\r\n");
  8589. if (!content(offset_and_length.first, offset_and_length.second)) {
  8590. return false;
  8591. }
  8592. ctoken("\r\n");
  8593. }
  8594. ctoken("--");
  8595. stoken(boundary);
  8596. ctoken("--");
  8597. return true;
  8598. }
  8599. inline void make_multipart_ranges_data(const Request &req, Response &res,
  8600. const std::string &boundary,
  8601. const std::string &content_type,
  8602. size_t content_length,
  8603. std::string &data) {
  8604. process_multipart_ranges_data(
  8605. req, boundary, content_type, content_length,
  8606. [&](const std::string &token) { data += token; },
  8607. [&](const std::string &token) { data += token; },
  8608. [&](size_t offset, size_t length) {
  8609. assert(offset + length <= content_length);
  8610. data += res.body.substr(offset, length);
  8611. return true;
  8612. });
  8613. }
  8614. inline size_t get_multipart_ranges_data_length(const Request &req,
  8615. const std::string &boundary,
  8616. const std::string &content_type,
  8617. size_t content_length) {
  8618. size_t data_length = 0;
  8619. process_multipart_ranges_data(
  8620. req, boundary, content_type, content_length,
  8621. [&](const std::string &token) { data_length += token.size(); },
  8622. [&](const std::string &token) { data_length += token.size(); },
  8623. [&](size_t /*offset*/, size_t length) {
  8624. data_length += length;
  8625. return true;
  8626. });
  8627. return data_length;
  8628. }
  8629. template <typename T>
  8630. inline bool
  8631. write_multipart_ranges_data(Stream &strm, const Request &req, Response &res,
  8632. const std::string &boundary,
  8633. const std::string &content_type,
  8634. size_t content_length, const T &is_shutting_down) {
  8635. return process_multipart_ranges_data(
  8636. req, boundary, content_type, content_length,
  8637. [&](const std::string &token) { strm.write(token); },
  8638. [&](const std::string &token) { strm.write(token); },
  8639. [&](size_t offset, size_t length) {
  8640. return write_content(strm, res.content_provider_, offset, length,
  8641. is_shutting_down);
  8642. });
  8643. }
  8644. inline bool has_framed_body(const Request &req) {
  8645. return is_chunked_transfer_encoding(req.headers) ||
  8646. req.get_header_value_u64("Content-Length") > 0;
  8647. }
  8648. inline bool is_connection_persistent(const Request &req) {
  8649. if (has_header_token(req.headers, "Connection", "close")) { return false; }
  8650. if (req.version == "HTTP/1.0" &&
  8651. !has_header_token(req.headers, "Connection", "keep-alive")) {
  8652. return false;
  8653. }
  8654. return true;
  8655. }
  8656. inline bool expect_content(const Request &req) {
  8657. if (req.method == "POST" || req.method == "PUT" || req.method == "PATCH" ||
  8658. req.method == "DELETE") {
  8659. return true;
  8660. }
  8661. return has_framed_body(req);
  8662. }
  8663. #ifdef _WIN32
  8664. class WSInit {
  8665. public:
  8666. WSInit() {
  8667. WSADATA wsaData;
  8668. if (WSAStartup(0x0002, &wsaData) == 0) is_valid_ = true;
  8669. }
  8670. ~WSInit() {
  8671. if (is_valid_) WSACleanup();
  8672. }
  8673. bool is_valid_ = false;
  8674. };
  8675. static WSInit wsinit_;
  8676. #endif
  8677. // RFC 9110 Section 11.6.1 defines a challenge list as
  8678. // WWW-Authenticate = #challenge
  8679. // challenge = auth-scheme [ 1*SP ( token68 / [ #auth-param ] ) ]
  8680. // auth-param = token BWS "=" BWS ( token / quoted-string )
  8681. // so a server may offer several schemes, each with its own comma-separated
  8682. // auth-param list, in either order and either as separate field lines or
  8683. // packed into one. Splitting on every comma would break apart a challenge's
  8684. // own param list; splitting only on the first space would miss a Digest
  8685. // challenge that isn't first. Split on commas that aren't inside a
  8686. // quoted-string instead, then track which scheme each resulting segment
  8687. // belongs to: a segment whose text before "=" contains whitespace (or that
  8688. // has no "=" at all) starts a new challenge named by its leading token.
  8689. inline std::vector<std::string> split_challenge_segments(const std::string &s) {
  8690. std::vector<std::string> segments;
  8691. size_t start = 0;
  8692. auto in_quotes = false;
  8693. for (size_t i = 0; i < s.size(); i++) {
  8694. auto c = s[i];
  8695. if (in_quotes) {
  8696. if (c == '\\' && i + 1 < s.size()) {
  8697. i++;
  8698. } else if (c == '"') {
  8699. in_quotes = false;
  8700. }
  8701. } else if (c == '"') {
  8702. in_quotes = true;
  8703. } else if (c == ',') {
  8704. segments.push_back(s.substr(start, i - start));
  8705. start = i + 1;
  8706. }
  8707. }
  8708. segments.push_back(s.substr(start));
  8709. return segments;
  8710. }
  8711. inline std::string unescape_quoted_pairs(const std::string &s) {
  8712. std::string out;
  8713. out.reserve(s.size());
  8714. for (size_t i = 0; i < s.size(); i++) {
  8715. if (s[i] == '\\' && i + 1 < s.size()) {
  8716. out += s[++i];
  8717. } else {
  8718. out += s[i];
  8719. }
  8720. }
  8721. return out;
  8722. }
  8723. // Inverse of unescape_quoted_pairs: prepares a value to sit inside a
  8724. // quoted-string. RFC 9110 §5.6.4 requires a literal '\' or '"' to be sent as a
  8725. // quoted-pair, so the recipient recovers the original value.
  8726. inline std::string escape_quoted_pairs(const std::string &s) {
  8727. std::string out;
  8728. out.reserve(s.size());
  8729. for (auto c : s) {
  8730. if (c == '\\' || c == '"') { out += '\\'; }
  8731. out += c;
  8732. }
  8733. return out;
  8734. }
  8735. inline bool parse_www_authenticate(const Response &res,
  8736. std::map<std::string, std::string> &auth,
  8737. bool is_proxy) {
  8738. auto auth_key = is_proxy ? "Proxy-Authenticate" : "WWW-Authenticate";
  8739. auto combined = get_combined_header_value(res.headers, auth_key);
  8740. if (combined.empty()) { return false; }
  8741. auto found_digest = false;
  8742. auto in_digest_challenge = false;
  8743. for (const auto &raw_segment : split_challenge_segments(combined)) {
  8744. auto segment = trim_copy(raw_segment);
  8745. if (segment.empty()) { continue; }
  8746. auto eq_pos = segment.find('=');
  8747. // BWS is allowed on both sides of "=", so the text naming the key (or,
  8748. // for the first segment of a challenge, "<scheme> <key>") must be
  8749. // trimmed before its boundaries are inspected.
  8750. auto key_part = trim_copy(
  8751. eq_pos == std::string::npos ? segment : segment.substr(0, eq_pos));
  8752. auto space_pos = key_part.find_last_of(" \t");
  8753. if (space_pos != std::string::npos || eq_pos == std::string::npos) {
  8754. // "<scheme>[ <key>]" starts a new challenge.
  8755. auto scheme_end =
  8756. space_pos == std::string::npos ? key_part.size() : space_pos;
  8757. // RFC 7616 Section 3.7: a server may offer more than one Digest
  8758. // challenge (e.g. SHA-256 and MD5); keep only the first so a nonce
  8759. // from one challenge is never paired with another's algorithm.
  8760. in_digest_challenge =
  8761. !found_digest &&
  8762. case_ignore::equal(key_part.substr(0, scheme_end), "Digest");
  8763. if (in_digest_challenge) { found_digest = true; }
  8764. if (space_pos == std::string::npos) {
  8765. // Bare scheme (or a token68), no auth-param on this segment.
  8766. continue;
  8767. }
  8768. key_part = key_part.substr(space_pos + 1);
  8769. }
  8770. if (!in_digest_challenge) { continue; }
  8771. auto val = trim_copy(segment.substr(eq_pos + 1));
  8772. auto unquoted = trim_double_quotes_copy(val);
  8773. if (unquoted.size() != val.size()) {
  8774. unquoted = unescape_quoted_pairs(unquoted);
  8775. }
  8776. auth[std::move(key_part)] = std::move(unquoted);
  8777. }
  8778. // RFC 7616 Section 3.3 requires realm and nonce on every Digest challenge;
  8779. // make_digest_authentication_header() dereferences both unconditionally, so
  8780. // a challenge missing either can't produce a usable Authorization header.
  8781. // Treat it the same as no Digest challenge at all.
  8782. return found_digest && auth.find("realm") != auth.end() &&
  8783. auth.find("nonce") != auth.end();
  8784. }
  8785. class ContentProviderAdapter {
  8786. public:
  8787. explicit ContentProviderAdapter(
  8788. ContentProviderWithoutLength &&content_provider)
  8789. : content_provider_(std::move(content_provider)) {}
  8790. bool operator()(size_t offset, size_t, DataSink &sink) {
  8791. return content_provider_(offset, sink);
  8792. }
  8793. private:
  8794. ContentProviderWithoutLength content_provider_;
  8795. };
  8796. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  8797. namespace fields {
  8798. inline bool is_token_char(char c) {
  8799. return is_ascii_alnum(c) || c == '!' || c == '#' || c == '$' || c == '%' ||
  8800. c == '&' || c == '\'' || c == '*' || c == '+' || c == '-' ||
  8801. c == '.' || c == '^' || c == '_' || c == '`' || c == '|' || c == '~';
  8802. }
  8803. inline bool is_token(const std::string &s) {
  8804. if (s.empty()) { return false; }
  8805. for (auto c : s) {
  8806. if (!is_token_char(c)) { return false; }
  8807. }
  8808. return true;
  8809. }
  8810. inline bool is_field_name(const std::string &s) { return is_token(s); }
  8811. inline bool is_vchar(char c) { return c >= 33 && c <= 126; }
  8812. inline bool is_obs_text(char c) { return 128 <= static_cast<unsigned char>(c); }
  8813. inline bool is_field_vchar(char c) { return is_vchar(c) || is_obs_text(c); }
  8814. inline bool is_field_content(const std::string &s) {
  8815. if (s.empty()) { return true; }
  8816. if (s.size() == 1) {
  8817. return is_field_vchar(s[0]);
  8818. } else if (s.size() == 2) {
  8819. return is_field_vchar(s[0]) && is_field_vchar(s[1]);
  8820. } else {
  8821. size_t i = 0;
  8822. if (!is_field_vchar(s[i])) { return false; }
  8823. i++;
  8824. while (i < s.size() - 1) {
  8825. auto c = s[i++];
  8826. if (c == ' ' || c == '\t' || is_field_vchar(c)) {
  8827. } else {
  8828. return false;
  8829. }
  8830. }
  8831. return is_field_vchar(s[i]);
  8832. }
  8833. }
  8834. inline bool is_field_value(const std::string &s) { return is_field_content(s); }
  8835. inline bool is_field_valid(const std::string &name, const std::string &value) {
  8836. return is_field_name(name) && is_field_value(value);
  8837. }
  8838. // RFC 9112 §2.2/§3.2: the request-target has no SP, HTAB or other control
  8839. // characters (incl. bare CR). obs-text (raw UTF-8) is allowed.
  8840. inline bool is_request_target(const std::string &s) {
  8841. return std::all_of(s.begin(), s.end(), is_field_vchar);
  8842. }
  8843. // RFC 9110 §7.2: the bytes of uri-host [ ":" port ], i.e. unreserved,
  8844. // sub-delims, "%", ":" and the IP-literal brackets. An empty value is valid.
  8845. inline bool is_host(const std::string &s) {
  8846. return std::all_of(s.begin(), s.end(), [](char c) {
  8847. return is_ascii_alnum(c) || c == '-' || c == '.' || c == '_' || c == '~' ||
  8848. c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  8849. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  8850. c == '=' || c == '%' || c == ':' || c == '[' || c == ']';
  8851. });
  8852. }
  8853. } // namespace fields
  8854. inline bool perform_websocket_handshake(Stream &strm, Request &req,
  8855. WebSocketUpgradeResponse &upgrade) {
  8856. // Generate a random 16-byte Sec-WebSocket-Key (RFC 6455 Section 4.1)
  8857. std::string key_bytes(16, '\0');
  8858. fill_random_bytes(reinterpret_cast<unsigned char *>(&key_bytes[0]),
  8859. key_bytes.size());
  8860. auto client_key = base64_encode(key_bytes);
  8861. req.headers.erase("Upgrade");
  8862. req.headers.erase("Connection");
  8863. req.headers.erase("Sec-WebSocket-Key");
  8864. req.headers.erase("Sec-WebSocket-Version");
  8865. req.headers.emplace("Upgrade", "websocket");
  8866. req.headers.emplace("Connection", "Upgrade");
  8867. req.headers.emplace("Sec-WebSocket-Key", client_key);
  8868. req.headers.emplace("Sec-WebSocket-Version", "13");
  8869. // Build the request in memory first, like ClientImpl::write_request does.
  8870. // Writing straight to the socket would leak a request line onto the wire
  8871. // before check_and_write_headers gets a chance to reject an invalid header,
  8872. // and would emit one small write per header.
  8873. BufferStream bstrm;
  8874. if (write_request_line(bstrm, req.method, req.path) < 0) {
  8875. upgrade.error = Error::Write;
  8876. return false;
  8877. }
  8878. auto error = Error::Success;
  8879. if (!check_and_write_headers(bstrm, req.headers, write_headers, error)) {
  8880. upgrade.error = error;
  8881. return false;
  8882. }
  8883. const auto &data = bstrm.get_buffer();
  8884. if (!write_data(strm, data.data(), data.size())) {
  8885. upgrade.error = Error::Write;
  8886. return false;
  8887. }
  8888. // Verify 101 response and Sec-WebSocket-Accept header
  8889. auto expected_accept = websocket_accept_key(client_key);
  8890. auto offered_subprotocols =
  8891. get_combined_header_value(req.headers, "Sec-WebSocket-Protocol");
  8892. return read_websocket_upgrade_response(strm, expected_accept,
  8893. offered_subprotocols, upgrade);
  8894. }
  8895. inline bool is_ip_address(const std::string &host) {
  8896. struct in_addr addr4;
  8897. struct in6_addr addr6;
  8898. return inet_pton(AF_INET, host.c_str(), &addr4) == 1 ||
  8899. inet_pton(AF_INET6, host.c_str(), &addr6) == 1;
  8900. }
  8901. // Resolve where a client should connect for `host`, honoring a user-supplied
  8902. // hostname-to-address map. `host` itself is never rewritten, so it keeps
  8903. // supplying the Host header and SNI; only the connection target changes.
  8904. //
  8905. // A mapped IP literal goes to `ip`, which keeps create_socket's AI_NUMERICHOST
  8906. // path. Anything else goes to `connect_host`, which create_socket resolves as
  8907. // a name, or uses as the socket path when the address family is AF_UNIX. An
  8908. // absent or empty mapping leaves `host` as the connection target; without the
  8909. // empty check the value would reach getaddrinfo as a null node and silently
  8910. // resolve to loopback.
  8911. inline void apply_addr_map(const std::map<std::string, std::string> &addr_map,
  8912. const std::string &host, std::string &connect_host,
  8913. std::string &ip) {
  8914. connect_host = host;
  8915. ip.clear();
  8916. auto it = addr_map.find(host);
  8917. if (it == addr_map.end() || it->second.empty()) { return; }
  8918. if (is_ip_address(it->second)) {
  8919. ip = it->second;
  8920. } else {
  8921. connect_host = it->second;
  8922. }
  8923. }
  8924. } // namespace detail
  8925. /*
  8926. * Group 2: detail namespace - SSL common utilities
  8927. */
  8928. #ifdef CPPHTTPLIB_SSL_ENABLED
  8929. namespace detail {
  8930. class SSLSocketStream final : public Stream {
  8931. public:
  8932. SSLSocketStream(
  8933. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  8934. time_t read_timeout_usec, time_t write_timeout_sec,
  8935. time_t write_timeout_usec, time_t max_timeout_msec = 0,
  8936. std::chrono::time_point<std::chrono::steady_clock> start_time =
  8937. (std::chrono::steady_clock::time_point::min)());
  8938. ~SSLSocketStream() override;
  8939. bool is_readable() const override;
  8940. bool wait_readable() const override;
  8941. bool wait_writable() const override;
  8942. bool is_peer_alive() const override;
  8943. ssize_t read(char *ptr, size_t size) override;
  8944. ssize_t write(const char *ptr, size_t size) override;
  8945. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  8946. void get_local_ip_and_port(std::string &ip, int &port) const override;
  8947. socket_t socket() const override;
  8948. time_t duration() const override;
  8949. void set_read_timeout(time_t sec, time_t usec = 0) override;
  8950. void set_max_timeout(time_t msec) override;
  8951. // See SocketStream::set_readable_hint().
  8952. void set_readable_hint() { readable_hint_ = true; }
  8953. private:
  8954. bool ensure_readable();
  8955. socket_t sock_;
  8956. tls::session_t session_;
  8957. time_t read_timeout_sec_;
  8958. time_t read_timeout_usec_;
  8959. time_t write_timeout_sec_;
  8960. time_t write_timeout_usec_;
  8961. time_t max_timeout_msec_;
  8962. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  8963. bool readable_hint_ = false;
  8964. };
  8965. // A TLS stream for WebSocket connections, where the receive path and the
  8966. // send path (application send() plus the heartbeat ping thread) run on
  8967. // different threads. A single TLS session must never be entered
  8968. // concurrently, so every call into the session is serialized by one mutex.
  8969. //
  8970. // Unlike SSLSocketStream, the socket is kept non-blocking for the stream's
  8971. // whole lifetime and each read()/write() performs a single non-blocking TLS
  8972. // call under the lock, then waits for readiness with select() outside the
  8973. // lock. The lock is therefore held only for CPU-bound work, so a reader
  8974. // blocked waiting for data never stalls a concurrent sender.
  8975. //
  8976. // This stream is used only for wss:// connections. Plain ws:// and ordinary
  8977. // HTTP/HTTPS keep using SocketStream/SSLSocketStream unchanged.
  8978. class WebSocketSSLStream final : public Stream {
  8979. public:
  8980. WebSocketSSLStream(socket_t sock, tls::session_t session,
  8981. time_t read_timeout_sec, time_t read_timeout_usec,
  8982. time_t write_timeout_sec, time_t write_timeout_usec);
  8983. ~WebSocketSSLStream() override;
  8984. bool is_readable() const override;
  8985. bool wait_readable() const override;
  8986. bool wait_writable() const override;
  8987. ssize_t read(char *ptr, size_t size) override;
  8988. ssize_t write(const char *ptr, size_t size) override;
  8989. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  8990. void get_local_ip_and_port(std::string &ip, int &port) const override;
  8991. socket_t socket() const override;
  8992. time_t duration() const override;
  8993. void set_read_timeout(time_t sec, time_t usec = 0) override;
  8994. private:
  8995. mutable std::mutex session_mutex_;
  8996. socket_t sock_;
  8997. tls::session_t session_;
  8998. // WebSocket::close() shortens the read timeout from the closing thread
  8999. // while the receive thread is inside wait_readable(), so these two are read
  9000. // and written concurrently. The write timeouts are never mutated.
  9001. std::atomic<time_t> read_timeout_sec_;
  9002. std::atomic<time_t> read_timeout_usec_;
  9003. time_t write_timeout_sec_;
  9004. time_t write_timeout_usec_;
  9005. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  9006. };
  9007. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  9008. inline std::string message_digest(const std::string &s, const EVP_MD *algo) {
  9009. auto context = std::unique_ptr<EVP_MD_CTX, decltype(&EVP_MD_CTX_free)>(
  9010. EVP_MD_CTX_new(), EVP_MD_CTX_free);
  9011. unsigned int hash_length = 0;
  9012. unsigned char hash[EVP_MAX_MD_SIZE];
  9013. EVP_DigestInit_ex(context.get(), algo, nullptr);
  9014. EVP_DigestUpdate(context.get(), s.c_str(), s.size());
  9015. EVP_DigestFinal_ex(context.get(), hash, &hash_length);
  9016. std::stringstream ss;
  9017. for (auto i = 0u; i < hash_length; ++i) {
  9018. ss << std::hex << std::setw(2) << std::setfill('0')
  9019. << static_cast<unsigned int>(hash[i]);
  9020. }
  9021. return ss.str();
  9022. }
  9023. inline std::string MD5(const std::string &s) {
  9024. return message_digest(s, EVP_md5());
  9025. }
  9026. inline std::string SHA_256(const std::string &s) {
  9027. return message_digest(s, EVP_sha256());
  9028. }
  9029. inline std::string SHA_512(const std::string &s) {
  9030. return message_digest(s, EVP_sha512());
  9031. }
  9032. #elif defined(CPPHTTPLIB_MBEDTLS_SUPPORT)
  9033. namespace {
  9034. template <size_t N>
  9035. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  9036. std::stringstream ss;
  9037. for (size_t i = 0; i < N; ++i) {
  9038. ss << std::hex << std::setw(2) << std::setfill('0')
  9039. << static_cast<unsigned int>(hash[i]);
  9040. }
  9041. return ss.str();
  9042. }
  9043. } // namespace
  9044. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9045. // Mbed TLS 4.x provides hashing (and TLS RNG) via PSA Crypto, which must be
  9046. // initialized once. PSA state is process-global; do not free it.
  9047. inline bool ensure_mbedtls_psa_crypto() {
  9048. static std::once_flag once;
  9049. static bool ok = false;
  9050. std::call_once(once, []() { ok = (psa_crypto_init() == PSA_SUCCESS); });
  9051. return ok;
  9052. }
  9053. inline bool psa_hash(psa_algorithm_t alg, const std::string &s,
  9054. unsigned char *out, size_t out_size) {
  9055. if (!ensure_mbedtls_psa_crypto()) { return false; }
  9056. size_t olen = 0;
  9057. return psa_hash_compute(alg, reinterpret_cast<const uint8_t *>(s.data()),
  9058. s.size(), out, out_size, &olen) == PSA_SUCCESS &&
  9059. olen == out_size;
  9060. }
  9061. #endif
  9062. inline std::string MD5(const std::string &s) {
  9063. unsigned char hash[16];
  9064. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9065. if (!psa_hash(PSA_ALG_MD5, s, hash, sizeof(hash))) { return {}; }
  9066. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9067. mbedtls_md5(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9068. hash);
  9069. #else
  9070. mbedtls_md5_ret(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9071. hash);
  9072. #endif
  9073. return hash_to_hex(hash);
  9074. }
  9075. inline std::string SHA_256(const std::string &s) {
  9076. unsigned char hash[32];
  9077. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9078. if (!psa_hash(PSA_ALG_SHA_256, s, hash, sizeof(hash))) { return {}; }
  9079. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9080. mbedtls_sha256(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9081. hash, 0);
  9082. #else
  9083. mbedtls_sha256_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9084. s.size(), hash, 0);
  9085. #endif
  9086. return hash_to_hex(hash);
  9087. }
  9088. inline std::string SHA_512(const std::string &s) {
  9089. unsigned char hash[64];
  9090. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9091. if (!psa_hash(PSA_ALG_SHA_512, s, hash, sizeof(hash))) { return {}; }
  9092. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9093. mbedtls_sha512(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9094. hash, 0);
  9095. #else
  9096. mbedtls_sha512_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9097. s.size(), hash, 0);
  9098. #endif
  9099. return hash_to_hex(hash);
  9100. }
  9101. #elif defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9102. namespace {
  9103. template <size_t N>
  9104. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  9105. std::stringstream ss;
  9106. for (size_t i = 0; i < N; ++i) {
  9107. ss << std::hex << std::setw(2) << std::setfill('0')
  9108. << static_cast<unsigned int>(hash[i]);
  9109. }
  9110. return ss.str();
  9111. }
  9112. } // namespace
  9113. inline std::string MD5(const std::string &s) {
  9114. unsigned char hash[WC_MD5_DIGEST_SIZE];
  9115. wc_Md5Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9116. static_cast<word32>(s.size()), hash);
  9117. return hash_to_hex(hash);
  9118. }
  9119. inline std::string SHA_256(const std::string &s) {
  9120. unsigned char hash[WC_SHA256_DIGEST_SIZE];
  9121. wc_Sha256Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9122. static_cast<word32>(s.size()), hash);
  9123. return hash_to_hex(hash);
  9124. }
  9125. inline std::string SHA_512(const std::string &s) {
  9126. unsigned char hash[WC_SHA512_DIGEST_SIZE];
  9127. wc_Sha512Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9128. static_cast<word32>(s.size()), hash);
  9129. return hash_to_hex(hash);
  9130. }
  9131. #endif
  9132. template <typename T>
  9133. inline bool process_server_socket_ssl(
  9134. const std::atomic<socket_t> &svr_sock, tls::session_t session,
  9135. socket_t sock, size_t keep_alive_max_count, time_t keep_alive_timeout_sec,
  9136. time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec,
  9137. time_t write_timeout_usec, T callback) {
  9138. // See process_server_socket(). The TLS library keeps already decrypted bytes
  9139. // of a pipelined request, which keep_alive() cannot see on the socket.
  9140. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9141. write_timeout_sec, write_timeout_usec);
  9142. return process_server_socket_core(
  9143. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  9144. [&]() { return strm.is_readable(); },
  9145. [&](bool socket_readable, bool close_connection,
  9146. bool &connection_closed) {
  9147. if (socket_readable) { strm.set_readable_hint(); }
  9148. return callback(strm, close_connection, connection_closed);
  9149. });
  9150. }
  9151. template <typename T>
  9152. inline bool process_client_socket_ssl(
  9153. tls::session_t session, socket_t sock, time_t read_timeout_sec,
  9154. time_t read_timeout_usec, time_t write_timeout_sec,
  9155. time_t write_timeout_usec, time_t max_timeout_msec,
  9156. std::chrono::time_point<std::chrono::steady_clock> start_time, T callback) {
  9157. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9158. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  9159. start_time);
  9160. return callback(strm);
  9161. }
  9162. inline std::pair<std::string, std::string> make_digest_authentication_header(
  9163. const Request &req, const std::map<std::string, std::string> &auth,
  9164. size_t cnonce_count, const std::string &cnonce, const std::string &username,
  9165. const std::string &password, bool is_proxy = false) {
  9166. std::string nc;
  9167. {
  9168. std::stringstream ss;
  9169. ss << std::setfill('0') << std::setw(8) << std::hex << cnonce_count;
  9170. nc = ss.str();
  9171. }
  9172. std::string qop;
  9173. if (auth.find("qop") != auth.end()) {
  9174. qop = auth.at("qop");
  9175. if (qop.find("auth-int") != std::string::npos) {
  9176. qop = "auth-int";
  9177. } else if (qop.find("auth") != std::string::npos) {
  9178. qop = "auth";
  9179. } else {
  9180. qop.clear();
  9181. }
  9182. }
  9183. std::string algo = "MD5";
  9184. if (auth.find("algorithm") != auth.end()) {
  9185. // algorithm is an unquoted token (RFC 7616 §3.4). A server value that is
  9186. // not a token would otherwise be emitted verbatim and could carry commas
  9187. // or quotes that inject further auth-params into the header below.
  9188. const auto &a = auth.at("algorithm");
  9189. if (fields::is_token(a)) { algo = a; }
  9190. }
  9191. std::string response;
  9192. {
  9193. auto H = algo == "SHA-256" ? detail::SHA_256
  9194. : algo == "SHA-512" ? detail::SHA_512
  9195. : detail::MD5;
  9196. auto A1 = username + ":" + auth.at("realm") + ":" + password;
  9197. auto A2 = req.method + ":" + req.path;
  9198. if (qop == "auth-int") { A2 += ":" + H(req.body); }
  9199. if (qop.empty()) {
  9200. response = H(H(A1) + ":" + auth.at("nonce") + ":" + H(A2));
  9201. } else {
  9202. response = H(H(A1) + ":" + auth.at("nonce") + ":" + nc + ":" + cnonce +
  9203. ":" + qop + ":" + H(A2));
  9204. }
  9205. }
  9206. auto opaque = (auth.find("opaque") != auth.end()) ? auth.at("opaque") : "";
  9207. // Every value placed inside a quoted-string is escaped so a '"' in it cannot
  9208. // close the string early. realm, nonce and opaque come straight from the
  9209. // server's challenge (parse_www_authenticate() already de-escaped them), so
  9210. // without this a crafted challenge injects extra auth-params into the header.
  9211. auto field =
  9212. "Digest username=\"" + detail::escape_quoted_pairs(username) +
  9213. "\", realm=\"" + detail::escape_quoted_pairs(auth.at("realm")) +
  9214. "\", nonce=\"" + detail::escape_quoted_pairs(auth.at("nonce")) +
  9215. "\", uri=\"" + detail::escape_quoted_pairs(req.path) +
  9216. "\", algorithm=" + algo +
  9217. (qop.empty() ? ", response=\""
  9218. : ", qop=" + qop + ", nc=" + nc + ", cnonce=\"" + cnonce +
  9219. "\", response=\"") +
  9220. response + "\"" +
  9221. (opaque.empty()
  9222. ? ""
  9223. : ", opaque=\"" + detail::escape_quoted_pairs(opaque) + "\"");
  9224. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9225. return std::make_pair(key, field);
  9226. }
  9227. // Follows X509_check_host, which the OpenSSL backend uses, so that every
  9228. // backend accepts the same names.
  9229. inline bool match_hostname(const std::string &pattern,
  9230. const std::string &hostname) {
  9231. // A trailing dot on the host is ignored
  9232. auto host = hostname;
  9233. if (host.size() > 1 && host.back() == '.') { host.pop_back(); }
  9234. // Exact match (case-insensitive)
  9235. if (detail::case_ignore::equal(host, pattern)) { return true; }
  9236. // Split both pattern and hostname into components by '.', keeping any empty
  9237. // one, which no name may have
  9238. auto labels = [](const std::string &s) {
  9239. std::vector<std::string> v;
  9240. size_t b = 0;
  9241. while (true) {
  9242. auto e = s.find('.', b);
  9243. v.push_back(s.substr(b, e - b));
  9244. if (e == std::string::npos) { return v; }
  9245. b = e + 1;
  9246. }
  9247. };
  9248. auto pattern_components = labels(pattern);
  9249. auto host_components = labels(host);
  9250. auto has_empty_label = [](const std::vector<std::string> &v) {
  9251. return std::any_of(v.begin(), v.end(),
  9252. [](const std::string &l) { return l.empty(); });
  9253. };
  9254. if (has_empty_label(pattern_components) || has_empty_label(host_components)) {
  9255. return false;
  9256. }
  9257. // Component count must match
  9258. if (host_components.size() != pattern_components.size()) { return false; }
  9259. // A wildcard needs two labels after it, so that "*.com" matches nothing,
  9260. // and an IDNA label may not have one
  9261. const auto &leftmost = pattern_components.front();
  9262. if (leftmost.find('*') != std::string::npos &&
  9263. (pattern_components.size() < 3 ||
  9264. case_ignore::equal(leftmost.substr(0, 4), "xn--"))) {
  9265. return false;
  9266. }
  9267. // Compare each component with wildcard support
  9268. // Supports: "*" (full wildcard), "prefix*" (partial wildcard)
  9269. // https://bugs.launchpad.net/ubuntu/+source/firefox-3.0/+bug/376484
  9270. // Only the leftmost label may carry a wildcard (RFC 6125 6.4.3)
  9271. auto itr = pattern_components.begin();
  9272. for (const auto &h : host_components) {
  9273. auto &p = *itr;
  9274. auto is_leftmost = itr == pattern_components.begin();
  9275. if (!detail::case_ignore::equal(p, h) && !(is_leftmost && p == "*")) {
  9276. bool partial_match = false;
  9277. if (is_leftmost && !p.empty() && p[p.size() - 1] == '*') {
  9278. const auto prefix_length = p.size() - 1;
  9279. if (prefix_length == 0) {
  9280. partial_match = true;
  9281. } else if (h.size() >= prefix_length) {
  9282. partial_match =
  9283. std::equal(p.begin(),
  9284. p.begin() + static_cast<std::string::difference_type>(
  9285. prefix_length),
  9286. h.begin(), [](const char ca, const char cb) {
  9287. return detail::case_ignore::to_lower(ca) ==
  9288. detail::case_ignore::to_lower(cb);
  9289. });
  9290. }
  9291. }
  9292. if (!partial_match) { return false; }
  9293. }
  9294. ++itr;
  9295. }
  9296. return true;
  9297. }
  9298. #ifdef _WIN32
  9299. // Verify certificate using Windows CertGetCertificateChain API.
  9300. // This provides real-time certificate validation with Windows Update
  9301. // integration, independent of the TLS backend.
  9302. inline bool verify_cert_with_windows_schannel(
  9303. const std::vector<unsigned char> &der_cert, const std::string &hostname,
  9304. bool verify_hostname, uint64_t &out_error, tls::const_session_t session) {
  9305. if (der_cert.empty()) { return false; }
  9306. out_error = 0;
  9307. // Create Windows certificate context from DER data
  9308. auto cert_context = CertCreateCertificateContext(
  9309. X509_ASN_ENCODING | PKCS_7_ASN_ENCODING, der_cert.data(),
  9310. static_cast<DWORD>(der_cert.size()));
  9311. if (!cert_context) {
  9312. out_error = GetLastError();
  9313. return false;
  9314. }
  9315. auto cert_guard =
  9316. scope_exit([&] { CertFreeCertificateContext(cert_context); });
  9317. // Give CryptoAPI the certificates the server sent. Without them it follows
  9318. // the leaf's AIA URL, which may lead to an issuer under an untrusted root.
  9319. std::vector<tls::cert_t> peer_certs;
  9320. tls::get_peer_certs(session, peer_certs);
  9321. auto store = CertOpenStore(CERT_STORE_PROV_MEMORY, 0, 0, 0, nullptr);
  9322. auto store_guard = scope_exit([&] {
  9323. for (auto cert : peer_certs) {
  9324. tls::free_cert(cert);
  9325. }
  9326. if (store) { CertCloseStore(store, 0); }
  9327. });
  9328. for (auto cert : peer_certs) {
  9329. std::vector<unsigned char> der;
  9330. if (store && tls::get_cert_der(cert, der)) {
  9331. CertAddEncodedCertificateToStore(store, X509_ASN_ENCODING, der.data(),
  9332. static_cast<DWORD>(der.size()),
  9333. CERT_STORE_ADD_USE_EXISTING, nullptr);
  9334. }
  9335. }
  9336. // Setup chain parameters
  9337. CERT_CHAIN_PARA chain_para = {};
  9338. chain_para.cbSize = sizeof(chain_para);
  9339. // Require the server authentication usage along the chain, which also
  9340. // rejects roots that Windows trusts only for other purposes.
  9341. LPSTR server_auth = const_cast<LPSTR>(szOID_PKIX_KP_SERVER_AUTH);
  9342. chain_para.RequestedUsage.dwType = USAGE_MATCH_TYPE_AND;
  9343. chain_para.RequestedUsage.Usage.cUsageIdentifier = 1;
  9344. chain_para.RequestedUsage.Usage.rgpszUsageIdentifier = &server_auth;
  9345. // Build certificate chain with revocation checking
  9346. PCCERT_CHAIN_CONTEXT chain_context = nullptr;
  9347. auto chain_result = CertGetCertificateChain(
  9348. nullptr, cert_context, nullptr, store, &chain_para,
  9349. CERT_CHAIN_CACHE_END_CERT | CERT_CHAIN_REVOCATION_CHECK_END_CERT |
  9350. CERT_CHAIN_REVOCATION_ACCUMULATIVE_TIMEOUT,
  9351. nullptr, &chain_context);
  9352. if (!chain_result || !chain_context) {
  9353. out_error = GetLastError();
  9354. return false;
  9355. }
  9356. auto chain_guard =
  9357. scope_exit([&] { CertFreeCertificateChain(chain_context); });
  9358. // Verify SSL policy
  9359. SSL_EXTRA_CERT_CHAIN_POLICY_PARA extra_policy_para = {};
  9360. extra_policy_para.cbSize = sizeof(extra_policy_para);
  9361. #ifdef AUTHTYPE_SERVER
  9362. extra_policy_para.dwAuthType = AUTHTYPE_SERVER;
  9363. #endif
  9364. std::wstring whost;
  9365. if (verify_hostname) {
  9366. whost = u8string_to_wstring(hostname.c_str());
  9367. extra_policy_para.pwszServerName = const_cast<wchar_t *>(whost.c_str());
  9368. }
  9369. CERT_CHAIN_POLICY_PARA policy_para = {};
  9370. policy_para.cbSize = sizeof(policy_para);
  9371. #ifdef CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS
  9372. policy_para.dwFlags = CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS;
  9373. #else
  9374. policy_para.dwFlags = 0;
  9375. #endif
  9376. policy_para.pvExtraPolicyPara = &extra_policy_para;
  9377. CERT_CHAIN_POLICY_STATUS policy_status = {};
  9378. policy_status.cbSize = sizeof(policy_status);
  9379. if (!CertVerifyCertificateChainPolicy(CERT_CHAIN_POLICY_SSL, chain_context,
  9380. &policy_para, &policy_status)) {
  9381. out_error = GetLastError();
  9382. return false;
  9383. }
  9384. if (policy_status.dwError != 0) {
  9385. out_error = policy_status.dwError;
  9386. return false;
  9387. }
  9388. return true;
  9389. }
  9390. #endif // _WIN32
  9391. // Loads CA file/dir configuration and applies the system CA policy to a
  9392. // client TLS context. PEM data and native stores are applied to the context
  9393. // directly at set time; has_custom_store reflects them for the Auto policy
  9394. // decision.
  9395. inline bool load_client_ca_config(tls::ctx_t ctx,
  9396. const std::string &ca_cert_file_path,
  9397. const std::string &ca_cert_dir_path,
  9398. bool has_custom_store, SystemCAMode mode,
  9399. uint64_t &backend_error) {
  9400. auto ret = true;
  9401. if (!ca_cert_file_path.empty()) {
  9402. if (!tls::load_ca_file(ctx, ca_cert_file_path.c_str())) {
  9403. backend_error = tls::get_error();
  9404. ret = false;
  9405. }
  9406. } else if (!ca_cert_dir_path.empty()) {
  9407. if (!tls::load_ca_dir(ctx, ca_cert_dir_path.c_str())) {
  9408. backend_error = tls::get_error();
  9409. ret = false;
  9410. }
  9411. }
  9412. auto has_custom_ca = !ca_cert_file_path.empty() ||
  9413. !ca_cert_dir_path.empty() || has_custom_store;
  9414. if (mode == SystemCAMode::Enabled ||
  9415. (mode == SystemCAMode::Auto && !has_custom_ca)) {
  9416. if (!tls::load_system_certs(ctx)) { backend_error = tls::get_error(); }
  9417. }
  9418. return ret;
  9419. }
  9420. inline std::string ca_certs_to_pem(tls::ctx_t ctx) {
  9421. std::vector<tls::cert_t> certs;
  9422. tls::get_ca_certs(ctx, certs);
  9423. std::string pem;
  9424. for (auto cert : certs) {
  9425. std::vector<unsigned char> der;
  9426. if (tls::get_cert_der(cert, der)) {
  9427. auto b64 = base64_encode(std::string(der.begin(), der.end()));
  9428. pem += "-----BEGIN CERTIFICATE-----\n";
  9429. for (size_t i = 0; i < b64.size(); i += 64) {
  9430. pem += b64.substr(i, 64) + "\n";
  9431. }
  9432. pem += "-----END CERTIFICATE-----\n";
  9433. }
  9434. tls::free_cert(cert);
  9435. }
  9436. return pem;
  9437. }
  9438. // The parts of session setup that only SSLClient needs, plus the handful
  9439. // WebSocketClient also exposes; everything else takes the defaults, which is
  9440. // what keeps the two clients on one implementation.
  9441. struct ClientTlsSessionOptions {
  9442. // Both SSLClient and WebSocketClient expose this independently of
  9443. // certificate verification.
  9444. bool server_hostname_verification = true;
  9445. std::function<SSLVerifierResponse(tls::session_t)> session_verifier;
  9446. // When non-null, guards session creation against concurrent use of the
  9447. // context. A WebSocketClient is not safe to use from several threads to
  9448. // begin with, so it passes nothing.
  9449. std::mutex *ctx_mutex = nullptr;
  9450. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9451. // The caller decides whether Schannel has anything to say about this
  9452. // connection; see SSLClient::initialize_ssl().
  9453. bool windows_cert_verification = false;
  9454. // A server certificate verifier works on the backend's chain verification,
  9455. // so the backend keeps deciding and Schannel only adds its own check.
  9456. bool server_certificate_verifier_set = false;
  9457. #endif
  9458. };
  9459. // Filled in on failure for callers that report error details.
  9460. struct ClientTlsSessionError {
  9461. Error error = Error::Success;
  9462. int ssl_error = 0;
  9463. uint64_t backend_error = 0;
  9464. };
  9465. // Establishes a client TLS session on an already connected socket. On failure
  9466. // the session is left for the caller to free: SSLClient frees it right away,
  9467. // WebSocketClient keeps it in a member that shutdown_and_close() cleans up.
  9468. inline bool setup_client_tls_session(
  9469. const std::string &host, tls::ctx_t ctx, tls::session_t &session,
  9470. socket_t sock, bool server_certificate_verification, time_t timeout_sec,
  9471. time_t timeout_usec, ClientTlsSessionError *out_error = nullptr,
  9472. const ClientTlsSessionOptions &options = ClientTlsSessionOptions()) {
  9473. using namespace tls;
  9474. auto fail = [&](Error error, int ssl_error, uint64_t backend_error) {
  9475. if (out_error) {
  9476. out_error->error = error;
  9477. out_error->ssl_error = ssl_error;
  9478. out_error->backend_error = backend_error;
  9479. }
  9480. return false;
  9481. };
  9482. if (!ctx) {
  9483. session = nullptr;
  9484. return fail(Error::SSLConnection, 0, 0);
  9485. }
  9486. // With Windows verification on and no server certificate verifier set,
  9487. // Schannel is the only chain verifier. The backend's trust store is a
  9488. // snapshot of the Windows stores that lacks the roots Windows fetches on
  9489. // demand, so the backend's verdict is not used.
  9490. auto windows_verifies_chain = false;
  9491. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9492. windows_verifies_chain = options.windows_cert_verification &&
  9493. !options.server_certificate_verifier_set;
  9494. #endif
  9495. {
  9496. std::unique_lock<std::mutex> guard;
  9497. if (options.ctx_mutex) {
  9498. guard = std::unique_lock<std::mutex>(*options.ctx_mutex);
  9499. }
  9500. #if defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9501. // Mbed TLS and wolfSSL need the verification mode set explicitly, on the
  9502. // context, so under the same lock; OpenSSL uses SSL_VERIFY_NONE and does
  9503. // all verification post-handshake. Unless Schannel verifies the chain
  9504. // instead, chain verification happens during the handshake even for IP
  9505. // hosts; the certificate identity is verified post-handshake via
  9506. // verify_hostname().
  9507. set_verify_client(ctx, server_certificate_verification &&
  9508. !windows_verifies_chain);
  9509. #endif
  9510. session = create_session(ctx, sock);
  9511. }
  9512. if (!session) { return fail(Error::SSLConnection, 0, get_error()); }
  9513. // RFC 6066: SNI must not be set for IP addresses; skip it for IP hosts, so
  9514. // their identity is checked post-handshake below instead. On Mbed TLS and
  9515. // wolfSSL, set_sni also drives handshake-time hostname verification, so
  9516. // options.server_hostname_verification is threaded through here.
  9517. if (!is_ip_address(host)) {
  9518. if (!set_sni(session, host.c_str(), options.server_hostname_verification)) {
  9519. return fail(Error::SSLConnection, 0, get_error());
  9520. }
  9521. }
  9522. TlsError tls_err;
  9523. if (!connect_nonblocking(session, sock, timeout_sec, timeout_usec,
  9524. &tls_err)) {
  9525. auto error = Error::SSLConnection;
  9526. if (tls_err.code == ErrorCode::CertVerifyFailed) {
  9527. error = Error::SSLServerVerification;
  9528. } else if (tls_err.code == ErrorCode::HostnameMismatch) {
  9529. error = Error::SSLServerHostnameVerification;
  9530. }
  9531. return fail(error, static_cast<int>(tls_err.code), tls_err.backend_code);
  9532. }
  9533. auto verification_status = SSLVerifierResponse::NoDecisionMade;
  9534. if (options.session_verifier) {
  9535. verification_status = options.session_verifier(session);
  9536. }
  9537. if (verification_status == SSLVerifierResponse::CertificateRejected) {
  9538. return fail(Error::SSLServerVerification, 0, get_error());
  9539. }
  9540. if (verification_status == SSLVerifierResponse::NoDecisionMade &&
  9541. server_certificate_verification) {
  9542. if (!windows_verifies_chain) {
  9543. auto verify_result = get_verify_result(session);
  9544. if (verify_result != 0) {
  9545. return fail(Error::SSLServerVerification, 0,
  9546. static_cast<uint64_t>(verify_result));
  9547. }
  9548. }
  9549. auto server_cert = get_peer_cert(session);
  9550. if (!server_cert) {
  9551. return fail(Error::SSLServerVerification, 0, get_error());
  9552. }
  9553. auto cert_guard = detail::scope_exit([&] { free_cert(server_cert); });
  9554. // Identity check against the peer certificate, post-handshake for all
  9555. // backends. For IP hosts this is the only identity verification, since no
  9556. // hostname is bound during the handshake.
  9557. if (options.server_hostname_verification) {
  9558. if (!verify_hostname(server_cert, host.c_str())) {
  9559. return fail(Error::SSLServerHostnameVerification, 0,
  9560. hostname_mismatch_code());
  9561. }
  9562. }
  9563. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9564. // Windows Schannel verification, which lets Windows fetch missing roots
  9565. // and intermediates on demand. It must not be skipped: unless a server
  9566. // certificate verifier is set, it is the only chain check.
  9567. if (options.windows_cert_verification) {
  9568. std::vector<unsigned char> der;
  9569. uint64_t wincrypt_error = 0;
  9570. if (!get_cert_der(server_cert, der) ||
  9571. !verify_cert_with_windows_schannel(
  9572. der, host, options.server_hostname_verification, wincrypt_error,
  9573. session)) {
  9574. return fail(Error::SSLServerVerification, 0, wincrypt_error);
  9575. }
  9576. }
  9577. #endif
  9578. }
  9579. return true;
  9580. }
  9581. } // namespace detail
  9582. #endif // CPPHTTPLIB_SSL_ENABLED
  9583. /*
  9584. * Group 3: httplib namespace - Non-SSL public API implementations
  9585. */
  9586. inline void default_socket_options(socket_t sock) {
  9587. set_socket_opt(sock, SOL_SOCKET,
  9588. #ifdef SO_REUSEPORT
  9589. SO_REUSEPORT,
  9590. #else
  9591. SO_REUSEADDR,
  9592. #endif
  9593. 1);
  9594. }
  9595. inline bool set_socket_opt(socket_t sock, int level, int optname, int optval) {
  9596. return detail::set_socket_opt_impl(sock, level, optname, &optval,
  9597. sizeof(optval));
  9598. }
  9599. inline std::string get_bearer_token_auth(const Request &req) {
  9600. // The auth scheme is case-insensitive (RFC 9110 11.1), and a value shorter
  9601. // than the prefix carries no token.
  9602. constexpr const char bearer_prefix[] = "Bearer ";
  9603. constexpr auto bearer_prefix_len = detail::str_len(bearer_prefix);
  9604. auto value = req.get_header_value("Authorization");
  9605. if (value.size() >= bearer_prefix_len &&
  9606. detail::case_ignore::equal(value.substr(0, bearer_prefix_len),
  9607. bearer_prefix)) {
  9608. return value.substr(bearer_prefix_len);
  9609. }
  9610. return "";
  9611. }
  9612. inline const char *status_message(int status) {
  9613. switch (status) {
  9614. case StatusCode::Continue_100: return "Continue";
  9615. case StatusCode::SwitchingProtocol_101: return "Switching Protocol";
  9616. case StatusCode::Processing_102: return "Processing";
  9617. case StatusCode::EarlyHints_103: return "Early Hints";
  9618. case StatusCode::OK_200: return "OK";
  9619. case StatusCode::Created_201: return "Created";
  9620. case StatusCode::Accepted_202: return "Accepted";
  9621. case StatusCode::NonAuthoritativeInformation_203:
  9622. return "Non-Authoritative Information";
  9623. case StatusCode::NoContent_204: return "No Content";
  9624. case StatusCode::ResetContent_205: return "Reset Content";
  9625. case StatusCode::PartialContent_206: return "Partial Content";
  9626. case StatusCode::MultiStatus_207: return "Multi-Status";
  9627. case StatusCode::AlreadyReported_208: return "Already Reported";
  9628. case StatusCode::IMUsed_226: return "IM Used";
  9629. case StatusCode::MultipleChoices_300: return "Multiple Choices";
  9630. case StatusCode::MovedPermanently_301: return "Moved Permanently";
  9631. case StatusCode::Found_302: return "Found";
  9632. case StatusCode::SeeOther_303: return "See Other";
  9633. case StatusCode::NotModified_304: return "Not Modified";
  9634. case StatusCode::UseProxy_305: return "Use Proxy";
  9635. case StatusCode::unused_306: return "unused";
  9636. case StatusCode::TemporaryRedirect_307: return "Temporary Redirect";
  9637. case StatusCode::PermanentRedirect_308: return "Permanent Redirect";
  9638. case StatusCode::BadRequest_400: return "Bad Request";
  9639. case StatusCode::Unauthorized_401: return "Unauthorized";
  9640. case StatusCode::PaymentRequired_402: return "Payment Required";
  9641. case StatusCode::Forbidden_403: return "Forbidden";
  9642. case StatusCode::NotFound_404: return "Not Found";
  9643. case StatusCode::MethodNotAllowed_405: return "Method Not Allowed";
  9644. case StatusCode::NotAcceptable_406: return "Not Acceptable";
  9645. case StatusCode::ProxyAuthenticationRequired_407:
  9646. return "Proxy Authentication Required";
  9647. case StatusCode::RequestTimeout_408: return "Request Timeout";
  9648. case StatusCode::Conflict_409: return "Conflict";
  9649. case StatusCode::Gone_410: return "Gone";
  9650. case StatusCode::LengthRequired_411: return "Length Required";
  9651. case StatusCode::PreconditionFailed_412: return "Precondition Failed";
  9652. case StatusCode::PayloadTooLarge_413: return "Payload Too Large";
  9653. case StatusCode::UriTooLong_414: return "URI Too Long";
  9654. case StatusCode::UnsupportedMediaType_415: return "Unsupported Media Type";
  9655. case StatusCode::RangeNotSatisfiable_416: return "Range Not Satisfiable";
  9656. case StatusCode::ExpectationFailed_417: return "Expectation Failed";
  9657. case StatusCode::ImATeapot_418: return "I'm a teapot";
  9658. case StatusCode::MisdirectedRequest_421: return "Misdirected Request";
  9659. case StatusCode::UnprocessableContent_422: return "Unprocessable Content";
  9660. case StatusCode::Locked_423: return "Locked";
  9661. case StatusCode::FailedDependency_424: return "Failed Dependency";
  9662. case StatusCode::TooEarly_425: return "Too Early";
  9663. case StatusCode::UpgradeRequired_426: return "Upgrade Required";
  9664. case StatusCode::PreconditionRequired_428: return "Precondition Required";
  9665. case StatusCode::TooManyRequests_429: return "Too Many Requests";
  9666. case StatusCode::RequestHeaderFieldsTooLarge_431:
  9667. return "Request Header Fields Too Large";
  9668. case StatusCode::UnavailableForLegalReasons_451:
  9669. return "Unavailable For Legal Reasons";
  9670. case StatusCode::NotImplemented_501: return "Not Implemented";
  9671. case StatusCode::BadGateway_502: return "Bad Gateway";
  9672. case StatusCode::ServiceUnavailable_503: return "Service Unavailable";
  9673. case StatusCode::GatewayTimeout_504: return "Gateway Timeout";
  9674. case StatusCode::HttpVersionNotSupported_505:
  9675. return "HTTP Version Not Supported";
  9676. case StatusCode::VariantAlsoNegotiates_506: return "Variant Also Negotiates";
  9677. case StatusCode::InsufficientStorage_507: return "Insufficient Storage";
  9678. case StatusCode::LoopDetected_508: return "Loop Detected";
  9679. case StatusCode::NotExtended_510: return "Not Extended";
  9680. case StatusCode::NetworkAuthenticationRequired_511:
  9681. return "Network Authentication Required";
  9682. default:
  9683. case StatusCode::InternalServerError_500: return "Internal Server Error";
  9684. }
  9685. }
  9686. inline std::string to_string(const Error error) {
  9687. switch (error) {
  9688. case Error::Success: return "Success (no error)";
  9689. case Error::Unknown: return "Unknown";
  9690. case Error::Connection: return "Could not establish connection";
  9691. case Error::BindIPAddress: return "Failed to bind IP address";
  9692. case Error::Read: return "Failed to read connection";
  9693. case Error::Write: return "Failed to write connection";
  9694. case Error::ExceedRedirectCount: return "Maximum redirect count exceeded";
  9695. case Error::Canceled: return "Connection handling canceled";
  9696. case Error::SSLConnection: return "SSL connection failed";
  9697. case Error::SSLLoadingCerts: return "SSL certificate loading failed";
  9698. case Error::SSLServerVerification: return "SSL server verification failed";
  9699. case Error::SSLServerHostnameVerification:
  9700. return "SSL server hostname verification failed";
  9701. case Error::UnsupportedMultipartBoundaryChars:
  9702. return "Unsupported HTTP multipart boundary characters";
  9703. case Error::Compression: return "Compression failed";
  9704. case Error::ConnectionTimeout: return "Connection timed out";
  9705. case Error::ProxyConnection: return "Proxy connection failed";
  9706. case Error::ConnectionClosed: return "Connection closed by server";
  9707. case Error::Timeout: return "Read timeout";
  9708. case Error::ResourceExhaustion: return "Resource exhaustion";
  9709. case Error::TooManyFormDataFiles: return "Too many form data files";
  9710. case Error::ExceedMaxPayloadSize: return "Exceeded maximum payload size";
  9711. case Error::ExceedUriMaxLength: return "Exceeded maximum URI length";
  9712. case Error::ExceedMaxSocketDescriptorCount:
  9713. return "Exceeded maximum socket descriptor count";
  9714. case Error::InvalidRequestLine: return "Invalid request line";
  9715. case Error::InvalidHTTPMethod: return "Invalid HTTP method";
  9716. case Error::InvalidHTTPVersion: return "Invalid HTTP version";
  9717. case Error::InvalidHeaders: return "Invalid headers";
  9718. case Error::MultipartParsing: return "Multipart parsing failed";
  9719. case Error::OpenFile: return "Failed to open file";
  9720. case Error::Listen: return "Failed to listen on socket";
  9721. case Error::GetSockName: return "Failed to get socket name";
  9722. case Error::UnsupportedAddressFamily: return "Unsupported address family";
  9723. case Error::HTTPParsing: return "HTTP parsing failed";
  9724. case Error::InvalidRangeHeader: return "Invalid Range header";
  9725. case Error::UnsupportedContentEncoding: return "Unsupported Content-Encoding";
  9726. case Error::WebSocketHandshake: return "WebSocket handshake failed";
  9727. case Error::UserCallbackException: return "User callback threw an exception";
  9728. default: break;
  9729. }
  9730. return "Invalid";
  9731. }
  9732. inline std::ostream &operator<<(std::ostream &os, const Error &obj) {
  9733. os << to_string(obj);
  9734. os << " (" << static_cast<std::underlying_type<Error>::type>(obj) << ')';
  9735. return os;
  9736. }
  9737. inline std::string hosted_at(const std::string &hostname) {
  9738. std::vector<std::string> addrs;
  9739. hosted_at(hostname, addrs);
  9740. if (addrs.empty()) { return std::string(); }
  9741. return addrs[0];
  9742. }
  9743. inline void hosted_at(const std::string &hostname,
  9744. std::vector<std::string> &addrs) {
  9745. struct addrinfo hints;
  9746. struct addrinfo *result;
  9747. memset(&hints, 0, sizeof(struct addrinfo));
  9748. hints.ai_family = AF_UNSPEC;
  9749. hints.ai_socktype = SOCK_STREAM;
  9750. hints.ai_protocol = 0;
  9751. if (detail::getaddrinfo_with_timeout(hostname.c_str(), nullptr, &hints,
  9752. &result, 0)) {
  9753. #if defined __linux__ && !defined __ANDROID__
  9754. res_init();
  9755. #endif
  9756. return;
  9757. }
  9758. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  9759. for (auto rp = result; rp; rp = rp->ai_next) {
  9760. const auto &addr =
  9761. *reinterpret_cast<struct sockaddr_storage *>(rp->ai_addr);
  9762. std::string ip;
  9763. auto dummy = -1;
  9764. if (detail::get_ip_and_port(addr, sizeof(struct sockaddr_storage), ip,
  9765. dummy)) {
  9766. addrs.emplace_back(std::move(ip));
  9767. }
  9768. }
  9769. }
  9770. inline std::string encode_uri_component(const std::string &value) {
  9771. std::ostringstream escaped;
  9772. escaped.fill('0');
  9773. escaped << std::hex;
  9774. for (auto c : value) {
  9775. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9776. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')') {
  9777. escaped << c;
  9778. } else {
  9779. escaped << std::uppercase;
  9780. escaped << '%' << std::setw(2)
  9781. << static_cast<int>(static_cast<unsigned char>(c));
  9782. escaped << std::nouppercase;
  9783. }
  9784. }
  9785. return escaped.str();
  9786. }
  9787. inline std::string encode_uri(const std::string &value) {
  9788. std::ostringstream escaped;
  9789. escaped.fill('0');
  9790. escaped << std::hex;
  9791. for (auto c : value) {
  9792. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9793. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')' ||
  9794. c == ';' || c == '/' || c == '?' || c == ':' || c == '@' || c == '&' ||
  9795. c == '=' || c == '+' || c == '$' || c == ',' || c == '#') {
  9796. escaped << c;
  9797. } else {
  9798. escaped << std::uppercase;
  9799. escaped << '%' << std::setw(2)
  9800. << static_cast<int>(static_cast<unsigned char>(c));
  9801. escaped << std::nouppercase;
  9802. }
  9803. }
  9804. return escaped.str();
  9805. }
  9806. inline std::string decode_uri_component(const std::string &value) {
  9807. std::string result;
  9808. for (size_t i = 0; i < value.size(); i++) {
  9809. if (value[i] == '%' && i + 2 < value.size()) {
  9810. auto val = 0;
  9811. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9812. result += static_cast<char>(val);
  9813. i += 2;
  9814. } else {
  9815. result += value[i];
  9816. }
  9817. } else {
  9818. result += value[i];
  9819. }
  9820. }
  9821. return result;
  9822. }
  9823. inline std::string decode_uri(const std::string &value) {
  9824. std::string result;
  9825. for (size_t i = 0; i < value.size(); i++) {
  9826. if (value[i] == '%' && i + 2 < value.size()) {
  9827. auto val = 0;
  9828. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9829. auto c = static_cast<char>(val);
  9830. // Keep escapes of the reserved characters that encode_uri leaves
  9831. // literal, so decode_uri is the inverse of encode_uri and an escaped
  9832. // delimiter is not promoted into a real one (as with JS decodeURI).
  9833. if (c == ';' || c == '/' || c == '?' || c == ':' || c == '@' ||
  9834. c == '&' || c == '=' || c == '+' || c == '$' || c == ',' ||
  9835. c == '#') {
  9836. result += value[i];
  9837. result += value[i + 1];
  9838. result += value[i + 2];
  9839. } else {
  9840. result += c;
  9841. }
  9842. i += 2;
  9843. } else {
  9844. result += value[i];
  9845. }
  9846. } else {
  9847. result += value[i];
  9848. }
  9849. }
  9850. return result;
  9851. }
  9852. inline std::string encode_path_component(const std::string &component) {
  9853. std::string result;
  9854. result.reserve(component.size() * 3);
  9855. for (size_t i = 0; i < component.size(); i++) {
  9856. auto c = static_cast<unsigned char>(component[i]);
  9857. // Unreserved characters per RFC 3986: ALPHA / DIGIT / "-" / "." / "_" / "~"
  9858. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9859. c == '_' || c == '~') {
  9860. result += static_cast<char>(c);
  9861. }
  9862. // Path-safe sub-delimiters: "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" /
  9863. // "," / ";" / "="
  9864. else if (c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  9865. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  9866. c == '=') {
  9867. result += static_cast<char>(c);
  9868. }
  9869. // Colon is allowed in path segments except first segment
  9870. else if (c == ':') {
  9871. result += static_cast<char>(c);
  9872. }
  9873. // @ is allowed in path
  9874. else if (c == '@') {
  9875. result += static_cast<char>(c);
  9876. } else {
  9877. result += '%';
  9878. char hex[3];
  9879. snprintf(hex, sizeof(hex), "%02X", c);
  9880. result.append(hex, 2);
  9881. }
  9882. }
  9883. return result;
  9884. }
  9885. inline std::string decode_path_component(const std::string &component) {
  9886. std::string result;
  9887. result.reserve(component.size());
  9888. for (size_t i = 0; i < component.size(); i++) {
  9889. if (component[i] == '%' && i + 1 < component.size()) {
  9890. if (component[i + 1] == 'u') {
  9891. // Unicode %uXXXX encoding
  9892. auto val = 0;
  9893. // 4 digits Unicode codes: val is 0x0000-0xFFFF (from 4 hex digits),
  9894. // so to_utf8 writes at most 3 bytes. buff[4] is safe.
  9895. char buff[4];
  9896. size_t len = 0;
  9897. if (detail::from_hex_to_i(component, i + 2, 4, val) &&
  9898. (len = detail::to_utf8(val, buff)) > 0) {
  9899. result.append(buff, len);
  9900. i += 5; // 'u0000'
  9901. } else {
  9902. // Not 4 hex digits, or a surrogate, which is no character: the
  9903. // escape is kept as it is rather than joining its neighbours
  9904. result += component[i];
  9905. }
  9906. } else {
  9907. // Standard %XX encoding
  9908. auto val = 0;
  9909. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9910. // 2 digits hex codes
  9911. result += static_cast<char>(val);
  9912. i += 2; // 'XX'
  9913. } else {
  9914. result += component[i];
  9915. }
  9916. }
  9917. } else {
  9918. result += component[i];
  9919. }
  9920. }
  9921. return result;
  9922. }
  9923. inline std::string encode_query_component(const std::string &component,
  9924. bool space_as_plus) {
  9925. std::string result;
  9926. result.reserve(component.size() * 3);
  9927. for (size_t i = 0; i < component.size(); i++) {
  9928. auto c = static_cast<unsigned char>(component[i]);
  9929. // Unreserved characters per RFC 3986
  9930. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9931. c == '_' || c == '~') {
  9932. result += static_cast<char>(c);
  9933. }
  9934. // Space handling
  9935. else if (c == ' ') {
  9936. if (space_as_plus) {
  9937. result += '+';
  9938. } else {
  9939. result += "%20";
  9940. }
  9941. }
  9942. // Plus sign handling
  9943. else if (c == '+') {
  9944. if (space_as_plus) {
  9945. result += "%2B";
  9946. } else {
  9947. result += static_cast<char>(c);
  9948. }
  9949. }
  9950. // Query-safe sub-delimiters (excluding & and = which are query delimiters)
  9951. else if (c == '!' || c == '$' || c == '\'' || c == '(' || c == ')' ||
  9952. c == '*' || c == ',' || c == ';') {
  9953. result += static_cast<char>(c);
  9954. }
  9955. // Colon and @ are allowed in query
  9956. else if (c == ':' || c == '@') {
  9957. result += static_cast<char>(c);
  9958. }
  9959. // Forward slash is allowed in query values
  9960. else if (c == '/') {
  9961. result += static_cast<char>(c);
  9962. }
  9963. // Question mark is allowed in query values (after first ?)
  9964. else if (c == '?') {
  9965. result += static_cast<char>(c);
  9966. } else {
  9967. result += '%';
  9968. char hex[3];
  9969. snprintf(hex, sizeof(hex), "%02X", c);
  9970. result.append(hex, 2);
  9971. }
  9972. }
  9973. return result;
  9974. }
  9975. inline std::string decode_query_component(const std::string &component,
  9976. bool plus_as_space) {
  9977. std::string result;
  9978. result.reserve(component.size());
  9979. for (size_t i = 0; i < component.size(); i++) {
  9980. if (component[i] == '%' && i + 2 < component.size()) {
  9981. auto val = 0;
  9982. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9983. result += static_cast<char>(val);
  9984. i += 2;
  9985. } else {
  9986. result += component[i];
  9987. }
  9988. } else if (component[i] == '+' && plus_as_space) {
  9989. result += ' '; // + becomes space in form-urlencoded
  9990. } else {
  9991. result += component[i];
  9992. }
  9993. }
  9994. return result;
  9995. }
  9996. inline std::string sanitize_filename(const std::string &filename) {
  9997. // Extract basename: find the last path separator (/ or \)
  9998. auto pos = filename.find_last_of("/\\");
  9999. auto result =
  10000. (pos != std::string::npos) ? filename.substr(pos + 1) : filename;
  10001. // Strip null bytes
  10002. result.erase(std::remove(result.begin(), result.end(), '\0'), result.end());
  10003. // Trim whitespace
  10004. {
  10005. auto start = result.find_first_not_of(" \t");
  10006. auto end = result.find_last_not_of(" \t");
  10007. result = (start == std::string::npos)
  10008. ? ""
  10009. : result.substr(start, end - start + 1);
  10010. }
  10011. // Reject . and ..
  10012. if (result == "." || result == "..") { return ""; }
  10013. return result;
  10014. }
  10015. inline std::string append_query_params(const std::string &path,
  10016. const Params &params) {
  10017. std::string path_with_query = path;
  10018. path_with_query += path.find('?') == std::string::npos ? '?' : '&';
  10019. path_with_query += detail::params_to_query_str(params);
  10020. return path_with_query;
  10021. }
  10022. // Header utilities
  10023. inline std::pair<std::string, std::string>
  10024. make_range_header(const Ranges &ranges) {
  10025. std::string field = "bytes=";
  10026. auto i = 0;
  10027. for (const auto &r : ranges) {
  10028. if (i != 0) { field += ", "; }
  10029. if (r.first != -1) { field += std::to_string(r.first); }
  10030. field += '-';
  10031. if (r.second != -1) { field += std::to_string(r.second); }
  10032. i++;
  10033. }
  10034. return std::make_pair("Range", std::move(field));
  10035. }
  10036. inline std::pair<std::string, std::string>
  10037. make_basic_authentication_header(const std::string &username,
  10038. const std::string &password, bool is_proxy) {
  10039. auto field = "Basic " + detail::base64_encode(username + ":" + password);
  10040. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  10041. return std::make_pair(key, std::move(field));
  10042. }
  10043. inline std::pair<std::string, std::string>
  10044. make_bearer_token_authentication_header(const std::string &token,
  10045. bool is_proxy = false) {
  10046. auto field = "Bearer " + token;
  10047. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  10048. return std::make_pair(key, std::move(field));
  10049. }
  10050. // Request implementation
  10051. inline size_t Request::get_header_value_u64(const std::string &key, size_t def,
  10052. size_t id) const {
  10053. return detail::get_header_value_u64(headers, key, def, id);
  10054. }
  10055. inline bool Request::has_header(const std::string &key) const {
  10056. return detail::has_header(headers, key);
  10057. }
  10058. inline std::string Request::get_header_value(const std::string &key,
  10059. const char *def, size_t id) const {
  10060. return detail::get_header_value(headers, key, def, id);
  10061. }
  10062. inline size_t Request::get_header_value_count(const std::string &key) const {
  10063. return detail::get_header_value_count(headers, key);
  10064. }
  10065. inline void Request::set_header(const std::string &key,
  10066. const std::string &val) {
  10067. detail::set_header(headers, key, val);
  10068. }
  10069. inline bool Request::has_trailer(const std::string &key) const {
  10070. return trailers.find(key) != trailers.end();
  10071. }
  10072. inline std::string Request::get_trailer_value(const std::string &key,
  10073. size_t id) const {
  10074. return detail::get_multimap_value(trailers, key, id);
  10075. }
  10076. inline size_t Request::get_trailer_value_count(const std::string &key) const {
  10077. return trailers.count(key);
  10078. }
  10079. inline bool Request::has_param(const std::string &key) const {
  10080. return params.find(key) != params.end();
  10081. }
  10082. inline std::string Request::get_param_value(const std::string &key,
  10083. size_t id) const {
  10084. return detail::get_multimap_value(params, key, id);
  10085. }
  10086. inline std::vector<std::string>
  10087. Request::get_param_values(const std::string &key) const {
  10088. auto rng = params.equal_range(key);
  10089. std::vector<std::string> values;
  10090. values.reserve(static_cast<size_t>(std::distance(rng.first, rng.second)));
  10091. for (auto it = rng.first; it != rng.second; ++it) {
  10092. values.push_back(it->second);
  10093. }
  10094. return values;
  10095. }
  10096. inline size_t Request::get_param_value_count(const std::string &key) const {
  10097. return params.count(key);
  10098. }
  10099. inline bool Request::is_multipart_form_data() const {
  10100. const auto &content_type = get_header_value("Content-Type");
  10101. return detail::case_ignore::equal(detail::extract_media_type(content_type),
  10102. "multipart/form-data");
  10103. }
  10104. // Multipart FormData implementation
  10105. inline std::string MultipartFormData::get_field(const std::string &key,
  10106. size_t id) const {
  10107. auto rng = fields.equal_range(key);
  10108. auto it = detail::bounded_next(rng.first, id, rng.second);
  10109. if (it != rng.second) { return it->second.content; }
  10110. return std::string();
  10111. }
  10112. inline std::vector<std::string>
  10113. MultipartFormData::get_fields(const std::string &key) const {
  10114. std::vector<std::string> values;
  10115. auto rng = fields.equal_range(key);
  10116. for (auto it = rng.first; it != rng.second; it++) {
  10117. values.push_back(it->second.content);
  10118. }
  10119. return values;
  10120. }
  10121. inline bool MultipartFormData::has_field(const std::string &key) const {
  10122. return fields.find(key) != fields.end();
  10123. }
  10124. inline size_t MultipartFormData::get_field_count(const std::string &key) const {
  10125. return fields.count(key);
  10126. }
  10127. inline FormData MultipartFormData::get_file(const std::string &key,
  10128. size_t id) const {
  10129. return detail::get_multimap_value(files, key, id);
  10130. }
  10131. inline std::vector<FormData>
  10132. MultipartFormData::get_files(const std::string &key) const {
  10133. std::vector<FormData> values;
  10134. auto rng = files.equal_range(key);
  10135. for (auto it = rng.first; it != rng.second; it++) {
  10136. values.push_back(it->second);
  10137. }
  10138. return values;
  10139. }
  10140. inline bool MultipartFormData::has_file(const std::string &key) const {
  10141. return files.find(key) != files.end();
  10142. }
  10143. inline size_t MultipartFormData::get_file_count(const std::string &key) const {
  10144. return files.count(key);
  10145. }
  10146. // Multipart FormData writer implementation
  10147. inline bool is_valid_multipart_boundary(const std::string &boundary) {
  10148. return detail::is_multipart_boundary_chars_valid(boundary);
  10149. }
  10150. inline MultipartFormDataWriter::MultipartFormDataWriter()
  10151. : boundary_(detail::make_multipart_data_boundary()) {}
  10152. inline MultipartFormDataWriter::MultipartFormDataWriter(std::string boundary)
  10153. : boundary_(std::move(boundary)) {}
  10154. inline const std::string &MultipartFormDataWriter::boundary() const {
  10155. return boundary_;
  10156. }
  10157. inline std::string MultipartFormDataWriter::content_type() const {
  10158. return detail::serialize_multipart_formdata_get_content_type(boundary_);
  10159. }
  10160. inline std::string
  10161. MultipartFormDataWriter::serialize(const UploadFormDataItems &items) const {
  10162. return detail::serialize_multipart_formdata(items, boundary_);
  10163. }
  10164. inline size_t MultipartFormDataWriter::content_length(
  10165. const UploadFormDataItems &items) const {
  10166. return detail::get_multipart_content_length(items, boundary_);
  10167. }
  10168. inline std::string
  10169. MultipartFormDataWriter::item_begin(const UploadFormData &item) const {
  10170. return detail::serialize_multipart_formdata_item_begin(item, boundary_);
  10171. }
  10172. inline std::string MultipartFormDataWriter::item_end() {
  10173. return detail::serialize_multipart_formdata_item_end();
  10174. }
  10175. inline std::string MultipartFormDataWriter::finish() const {
  10176. return detail::serialize_multipart_formdata_finish(boundary_);
  10177. }
  10178. // Response implementation
  10179. namespace detail {
  10180. // A response has one content source: `body`, a content provider, or a file.
  10181. // Each content setter calls this so that the one called last wins.
  10182. inline void clear_content_provider(Response &res) {
  10183. auto releaser = std::move(res.content_provider_resource_releaser_);
  10184. auto success = res.content_provider_success_;
  10185. res.content_length_ = 0;
  10186. res.content_provider_ = nullptr;
  10187. res.content_provider_resource_releaser_ = nullptr;
  10188. res.is_chunked_content_provider_ = false;
  10189. res.is_file_content_provider_ = false;
  10190. res.content_provider_success_ = false;
  10191. res.content_coding_ = EncodingType::None;
  10192. res.file_content_path_.clear();
  10193. res.file_content_content_type_.clear();
  10194. if (releaser) { releaser(success); }
  10195. }
  10196. inline void clear_content(Response &res) {
  10197. res.body.clear();
  10198. clear_content_provider(res);
  10199. }
  10200. // `body` is public, so it can be assigned directly after a provider or a file
  10201. // was set. It came last, so it wins.
  10202. inline void prefer_assigned_body(Response &res) {
  10203. if (!res.body.empty() &&
  10204. (res.content_provider_ || !res.file_content_path_.empty())) {
  10205. clear_content_provider(res);
  10206. }
  10207. }
  10208. // RFC 9112 6.3: a 1xx, 204 or 304 response ends with its header section.
  10209. inline bool body_allowed_for_status(int status) {
  10210. return status >= 200 && status != StatusCode::NoContent_204 &&
  10211. status != StatusCode::NotModified_304;
  10212. }
  10213. // Only a 206 response is served as a partial representation. range_error()
  10214. // validates `req.ranges` only for a 2xx status, so slicing under any other
  10215. // status would start from an unchecked offset.
  10216. inline bool is_partial_content(const Request &req, const Response &res) {
  10217. return !req.ranges.empty() && res.status == StatusCode::PartialContent_206;
  10218. }
  10219. // Sets the Content-Length or Transfer-Encoding framing the body that
  10220. // Server::write_response_core() writes. Only the library sets them: one from a
  10221. // handler would go out next to it, or describe some other body.
  10222. inline void set_framing_headers(const Request &req, Response &res,
  10223. const std::string &boundary,
  10224. const std::string &content_type) {
  10225. // A HEAD response may give the length a GET would have had (RFC 9110 9.3.2).
  10226. auto head_length = req.method == "HEAD"
  10227. ? res.get_header_value("Content-Length")
  10228. : std::string();
  10229. res.headers.erase("Content-Length");
  10230. res.headers.erase("Transfer-Encoding");
  10231. if (!body_allowed_for_status(res.status)) { return; }
  10232. if (res.content_provider_) {
  10233. if (res.content_length_ == 0) {
  10234. if (res.is_chunked_content_provider_) {
  10235. res.set_header("Transfer-Encoding", "chunked");
  10236. }
  10237. return;
  10238. }
  10239. // The part Server::write_content_with_provider() writes.
  10240. auto length = res.content_length_;
  10241. if (is_partial_content(req, res)) {
  10242. length = req.ranges.size() == 1
  10243. ? get_range_offset_and_length(req.ranges[0], length).second
  10244. : get_multipart_ranges_data_length(req, boundary,
  10245. content_type, length);
  10246. }
  10247. res.set_header("Content-Length", std::to_string(length));
  10248. } else if (!res.body.empty()) {
  10249. res.set_header("Content-Length", std::to_string(res.body.size()));
  10250. } else {
  10251. res.set_header("Content-Length", head_length.empty() ? "0" : head_length);
  10252. }
  10253. }
  10254. } // namespace detail
  10255. inline size_t Response::get_header_value_u64(const std::string &key, size_t def,
  10256. size_t id) const {
  10257. return detail::get_header_value_u64(headers, key, def, id);
  10258. }
  10259. inline bool Response::has_header(const std::string &key) const {
  10260. return headers.find(key) != headers.end();
  10261. }
  10262. inline std::string Response::get_header_value(const std::string &key,
  10263. const char *def,
  10264. size_t id) const {
  10265. return detail::get_header_value(headers, key, def, id);
  10266. }
  10267. inline size_t Response::get_header_value_count(const std::string &key) const {
  10268. return detail::get_header_value_count(headers, key);
  10269. }
  10270. inline void Response::set_header(const std::string &key,
  10271. const std::string &val) {
  10272. detail::set_header(headers, key, val);
  10273. }
  10274. inline bool Response::has_trailer(const std::string &key) const {
  10275. return trailers.find(key) != trailers.end();
  10276. }
  10277. inline std::string Response::get_trailer_value(const std::string &key,
  10278. size_t id) const {
  10279. return detail::get_multimap_value(trailers, key, id);
  10280. }
  10281. inline size_t Response::get_trailer_value_count(const std::string &key) const {
  10282. return trailers.count(key);
  10283. }
  10284. inline void Response::set_redirect(const std::string &url, int stat) {
  10285. if (detail::fields::is_field_value(url)) {
  10286. set_header("Location", url);
  10287. if (300 <= stat && stat < 400) {
  10288. this->status = stat;
  10289. } else {
  10290. this->status = StatusCode::Found_302;
  10291. }
  10292. }
  10293. }
  10294. inline void Response::set_content(const char *s, size_t n,
  10295. const std::string &content_type) {
  10296. body.assign(s, n); // Before the releaser runs; it may own `s`.
  10297. detail::clear_content_provider(*this);
  10298. auto rng = headers.equal_range("Content-Type");
  10299. headers.erase(rng.first, rng.second);
  10300. set_header("Content-Type", content_type);
  10301. }
  10302. inline void Response::set_content(const std::string &s,
  10303. const std::string &content_type) {
  10304. set_content(s.data(), s.size(), content_type);
  10305. }
  10306. inline void Response::set_content(std::string &&s,
  10307. const std::string &content_type) {
  10308. body = std::move(s);
  10309. detail::clear_content_provider(*this);
  10310. auto rng = headers.equal_range("Content-Type");
  10311. headers.erase(rng.first, rng.second);
  10312. set_header("Content-Type", content_type);
  10313. }
  10314. inline void Response::set_content_provider(
  10315. size_t in_length, const std::string &content_type, ContentProvider provider,
  10316. ContentProviderResourceReleaser resource_releaser) {
  10317. detail::clear_content(*this);
  10318. set_header("Content-Type", content_type);
  10319. content_length_ = in_length;
  10320. if (in_length > 0) { content_provider_ = std::move(provider); }
  10321. content_provider_resource_releaser_ = std::move(resource_releaser);
  10322. }
  10323. inline void Response::set_content_provider(
  10324. const std::string &content_type, ContentProviderWithoutLength provider,
  10325. ContentProviderResourceReleaser resource_releaser) {
  10326. detail::clear_content(*this);
  10327. set_header("Content-Type", content_type);
  10328. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  10329. content_provider_resource_releaser_ = std::move(resource_releaser);
  10330. }
  10331. inline void Response::set_chunked_content_provider(
  10332. const std::string &content_type, ContentProviderWithoutLength provider,
  10333. ContentProviderResourceReleaser resource_releaser) {
  10334. set_content_provider(content_type, std::move(provider),
  10335. std::move(resource_releaser));
  10336. is_chunked_content_provider_ = true;
  10337. }
  10338. inline void Response::set_file_content(const std::string &path,
  10339. const std::string &content_type) {
  10340. detail::clear_content(*this);
  10341. file_content_path_ = path;
  10342. file_content_content_type_ = content_type;
  10343. }
  10344. inline void Response::set_file_content(const std::string &path) {
  10345. set_file_content(path, std::string());
  10346. }
  10347. // Result implementation
  10348. inline size_t Result::get_request_header_value_u64(const std::string &key,
  10349. size_t def,
  10350. size_t id) const {
  10351. return detail::get_header_value_u64(request_headers_, key, def, id);
  10352. }
  10353. inline bool Result::has_request_header(const std::string &key) const {
  10354. return request_headers_.find(key) != request_headers_.end();
  10355. }
  10356. inline std::string Result::get_request_header_value(const std::string &key,
  10357. const char *def,
  10358. size_t id) const {
  10359. return detail::get_header_value(request_headers_, key, def, id);
  10360. }
  10361. inline size_t
  10362. Result::get_request_header_value_count(const std::string &key) const {
  10363. return request_headers_.count(key);
  10364. }
  10365. // Stream implementation
  10366. inline ssize_t Stream::write(const char *ptr) {
  10367. return write(ptr, strlen(ptr));
  10368. }
  10369. inline ssize_t Stream::write(const std::string &s) {
  10370. return write(s.data(), s.size());
  10371. }
  10372. // BodyReader implementation
  10373. inline ssize_t detail::BodyReader::read(char *buf, size_t len) {
  10374. if (!stream) {
  10375. last_error = Error::Connection;
  10376. return -1;
  10377. }
  10378. if (eof) { return 0; }
  10379. if (!chunked) {
  10380. // Content-Length based reading
  10381. if (has_content_length && bytes_read >= content_length) {
  10382. eof = true;
  10383. return 0;
  10384. }
  10385. auto to_read = len;
  10386. if (has_content_length) {
  10387. auto remaining = content_length - bytes_read;
  10388. to_read = (std::min)(len, remaining);
  10389. }
  10390. auto n = stream->read(buf, to_read);
  10391. if (n < 0) {
  10392. last_error = stream->get_error();
  10393. if (last_error == Error::Success) { last_error = Error::Read; }
  10394. eof = true;
  10395. return n;
  10396. }
  10397. if (n == 0) {
  10398. // Unexpected EOF before content_length
  10399. last_error = stream->get_error();
  10400. if (last_error == Error::Success) { last_error = Error::Read; }
  10401. eof = true;
  10402. return 0;
  10403. }
  10404. bytes_read += static_cast<size_t>(n);
  10405. if (has_content_length && bytes_read >= content_length) { eof = true; }
  10406. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10407. last_error = Error::ExceedMaxPayloadSize;
  10408. eof = true;
  10409. return -1;
  10410. }
  10411. return n;
  10412. }
  10413. // Chunked transfer encoding: delegate to shared decoder instance.
  10414. if (!chunked_decoder) { chunked_decoder.reset(new ChunkedDecoder(*stream)); }
  10415. size_t chunk_offset = 0;
  10416. size_t chunk_total = 0;
  10417. auto n = chunked_decoder->read_payload(buf, len, chunk_offset, chunk_total);
  10418. if (n < 0) {
  10419. last_error = stream->get_error();
  10420. if (last_error == Error::Success) { last_error = Error::Read; }
  10421. eof = true;
  10422. return n;
  10423. }
  10424. if (n == 0) {
  10425. // Final chunk observed. Leave trailer parsing to the caller (StreamHandle).
  10426. eof = true;
  10427. return 0;
  10428. }
  10429. bytes_read += static_cast<size_t>(n);
  10430. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10431. last_error = Error::ExceedMaxPayloadSize;
  10432. eof = true;
  10433. return -1;
  10434. }
  10435. return n;
  10436. }
  10437. // ThreadPool implementation
  10438. inline ThreadPool::ThreadPool(size_t n, size_t max_n, size_t mqr,
  10439. time_t idle_timeout_sec)
  10440. : base_thread_count_(n), max_queued_requests_(mqr),
  10441. idle_timeout_sec_(idle_timeout_sec), idle_thread_count_(0),
  10442. shutdown_(false) {
  10443. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10444. if (max_n != 0 && max_n < n) {
  10445. std::string msg = "max_threads must be >= base_threads";
  10446. throw std::invalid_argument(msg);
  10447. }
  10448. #endif
  10449. max_thread_count_ = max_n == 0 ? n : max_n;
  10450. threads_.reserve(base_thread_count_);
  10451. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10452. try {
  10453. #endif
  10454. for (size_t i = 0; i < base_thread_count_; i++) {
  10455. threads_.emplace_back(std::thread([this]() { worker(false); }));
  10456. }
  10457. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10458. } catch (...) {
  10459. // If thread creation fails partway (e.g., pthread_create returns EAGAIN),
  10460. // signal the workers we already spawned to exit and join them so the
  10461. // vector destructor does not see joinable threads (which would call
  10462. // std::terminate). Then rethrow so the caller learns of the failure.
  10463. {
  10464. std::unique_lock<std::mutex> lock(mutex_);
  10465. shutdown_ = true;
  10466. }
  10467. cond_.notify_all();
  10468. for (auto &t : threads_) {
  10469. if (t.joinable()) { t.join(); }
  10470. }
  10471. throw;
  10472. }
  10473. #endif
  10474. }
  10475. inline bool ThreadPool::enqueue(std::function<void()> fn) {
  10476. {
  10477. std::unique_lock<std::mutex> lock(mutex_);
  10478. if (shutdown_) { return false; }
  10479. if (max_queued_requests_ > 0 && jobs_.size() >= max_queued_requests_) {
  10480. return false;
  10481. }
  10482. jobs_.push_back(std::move(fn));
  10483. // Spawn a dynamic thread if no idle threads and under max
  10484. if (idle_thread_count_ == 0 &&
  10485. threads_.size() + dynamic_threads_.size() < max_thread_count_) {
  10486. cleanup_finished_threads();
  10487. dynamic_threads_.emplace_back(std::thread([this]() { worker(true); }));
  10488. }
  10489. }
  10490. cond_.notify_one();
  10491. return true;
  10492. }
  10493. inline void ThreadPool::shutdown() {
  10494. {
  10495. std::unique_lock<std::mutex> lock(mutex_);
  10496. shutdown_ = true;
  10497. }
  10498. cond_.notify_all();
  10499. for (auto &t : threads_) {
  10500. if (t.joinable()) { t.join(); }
  10501. }
  10502. // Move dynamic_threads_ to a local list under the lock to avoid racing
  10503. // with worker threads that call move_to_finished() concurrently.
  10504. std::list<std::thread> remaining_dynamic;
  10505. {
  10506. std::unique_lock<std::mutex> lock(mutex_);
  10507. remaining_dynamic = std::move(dynamic_threads_);
  10508. }
  10509. for (auto &t : remaining_dynamic) {
  10510. if (t.joinable()) { t.join(); }
  10511. }
  10512. std::unique_lock<std::mutex> lock(mutex_);
  10513. cleanup_finished_threads();
  10514. }
  10515. inline void ThreadPool::move_to_finished(std::thread::id id) {
  10516. // Must be called with mutex_ held
  10517. for (auto it = dynamic_threads_.begin(); it != dynamic_threads_.end(); ++it) {
  10518. if (it->get_id() == id) {
  10519. finished_threads_.push_back(std::move(*it));
  10520. dynamic_threads_.erase(it);
  10521. return;
  10522. }
  10523. }
  10524. }
  10525. inline void ThreadPool::cleanup_finished_threads() {
  10526. // Must be called with mutex_ held
  10527. for (auto &t : finished_threads_) {
  10528. if (t.joinable()) { t.join(); }
  10529. }
  10530. finished_threads_.clear();
  10531. }
  10532. inline void ThreadPool::worker(bool is_dynamic) {
  10533. for (;;) {
  10534. std::function<void()> fn;
  10535. {
  10536. std::unique_lock<std::mutex> lock(mutex_);
  10537. idle_thread_count_++;
  10538. if (is_dynamic) {
  10539. auto has_work =
  10540. cond_.wait_for(lock, std::chrono::seconds(idle_timeout_sec_),
  10541. [&] { return !jobs_.empty() || shutdown_; });
  10542. if (!has_work) {
  10543. // Timed out with no work - exit this dynamic thread
  10544. idle_thread_count_--;
  10545. move_to_finished(std::this_thread::get_id());
  10546. break;
  10547. }
  10548. } else {
  10549. cond_.wait(lock, [&] { return !jobs_.empty() || shutdown_; });
  10550. }
  10551. idle_thread_count_--;
  10552. if (shutdown_ && jobs_.empty()) { break; }
  10553. fn = std::move(jobs_.front());
  10554. jobs_.pop_front();
  10555. }
  10556. assert(true == static_cast<bool>(fn));
  10557. fn();
  10558. }
  10559. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(OPENSSL_IS_BORINGSSL) && \
  10560. !defined(LIBRESSL_VERSION_NUMBER)
  10561. OPENSSL_thread_stop();
  10562. #endif
  10563. }
  10564. /*
  10565. * Group 1 (continued): detail namespace - Stream implementations
  10566. */
  10567. namespace detail {
  10568. inline void calc_actual_timeout(time_t max_timeout_msec, time_t duration_msec,
  10569. time_t timeout_sec, time_t timeout_usec,
  10570. time_t &actual_timeout_sec,
  10571. time_t &actual_timeout_usec) {
  10572. auto timeout_msec = (timeout_sec * 1000) + (timeout_usec / 1000);
  10573. auto actual_timeout_msec =
  10574. (std::min)(max_timeout_msec - duration_msec, timeout_msec);
  10575. if (actual_timeout_msec < 0) { actual_timeout_msec = 0; }
  10576. actual_timeout_sec = actual_timeout_msec / 1000;
  10577. actual_timeout_usec = (actual_timeout_msec % 1000) * 1000;
  10578. }
  10579. // Socket stream implementation
  10580. inline SocketStream::SocketStream(
  10581. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  10582. time_t write_timeout_sec, time_t write_timeout_usec,
  10583. time_t max_timeout_msec,
  10584. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10585. : sock_(sock), read_timeout_sec_(read_timeout_sec),
  10586. read_timeout_usec_(read_timeout_usec),
  10587. write_timeout_sec_(write_timeout_sec),
  10588. write_timeout_usec_(write_timeout_usec),
  10589. max_timeout_msec_(max_timeout_msec), start_time_(start_time),
  10590. read_buff_(read_buff_size_, 0) {}
  10591. inline SocketStream::~SocketStream() = default;
  10592. inline bool SocketStream::is_readable() const {
  10593. return read_buff_off_ < read_buff_content_size_;
  10594. }
  10595. inline bool SocketStream::wait_readable() const {
  10596. if (max_timeout_msec_ <= 0) {
  10597. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10598. }
  10599. time_t read_timeout_sec;
  10600. time_t read_timeout_usec;
  10601. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10602. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10603. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  10604. }
  10605. inline bool SocketStream::wait_writable() const {
  10606. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10607. }
  10608. inline bool SocketStream::ensure_readable() {
  10609. if (readable_hint_) {
  10610. readable_hint_ = false;
  10611. return true;
  10612. }
  10613. return wait_readable();
  10614. }
  10615. inline const char *SocketStream::buffered_data(size_t &size) const {
  10616. size = read_buff_content_size_ - read_buff_off_;
  10617. return size ? read_buff_.data() + read_buff_off_ : nullptr;
  10618. }
  10619. inline void SocketStream::consume_buffered(size_t size) {
  10620. assert(size <= read_buff_content_size_ - read_buff_off_);
  10621. read_buff_off_ += size;
  10622. }
  10623. inline bool SocketStream::is_peer_alive() const {
  10624. return detail::is_socket_alive(sock_);
  10625. }
  10626. inline ssize_t SocketStream::read(char *ptr, size_t size) {
  10627. #ifdef _WIN32
  10628. size =
  10629. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10630. #else
  10631. size = (std::min)(size,
  10632. static_cast<size_t>((std::numeric_limits<ssize_t>::max)()));
  10633. #endif
  10634. if (read_buff_off_ < read_buff_content_size_) {
  10635. auto remaining_size = read_buff_content_size_ - read_buff_off_;
  10636. if (size <= remaining_size) {
  10637. memcpy(ptr, read_buff_.data() + read_buff_off_, size);
  10638. read_buff_off_ += size;
  10639. return static_cast<ssize_t>(size);
  10640. } else {
  10641. memcpy(ptr, read_buff_.data() + read_buff_off_, remaining_size);
  10642. read_buff_off_ += remaining_size;
  10643. return static_cast<ssize_t>(remaining_size);
  10644. }
  10645. }
  10646. if (!ensure_readable()) {
  10647. error_ = Error::Timeout;
  10648. return -1;
  10649. }
  10650. read_buff_off_ = 0;
  10651. read_buff_content_size_ = 0;
  10652. if (size < read_buff_size_) {
  10653. auto n = read_socket(sock_, read_buff_.data(), read_buff_size_,
  10654. CPPHTTPLIB_RECV_FLAGS);
  10655. if (n <= 0) {
  10656. if (n == 0) {
  10657. error_ = Error::ConnectionClosed;
  10658. } else {
  10659. error_ = Error::Read;
  10660. }
  10661. return n;
  10662. } else if (n <= static_cast<ssize_t>(size)) {
  10663. memcpy(ptr, read_buff_.data(), static_cast<size_t>(n));
  10664. return n;
  10665. } else {
  10666. memcpy(ptr, read_buff_.data(), size);
  10667. read_buff_off_ = size;
  10668. read_buff_content_size_ = static_cast<size_t>(n);
  10669. return static_cast<ssize_t>(size);
  10670. }
  10671. } else {
  10672. auto n = read_socket(sock_, ptr, size, CPPHTTPLIB_RECV_FLAGS);
  10673. if (n <= 0) {
  10674. if (n == 0) {
  10675. error_ = Error::ConnectionClosed;
  10676. } else {
  10677. error_ = Error::Read;
  10678. }
  10679. }
  10680. return n;
  10681. }
  10682. }
  10683. inline ssize_t SocketStream::write(const char *ptr, size_t size) {
  10684. if (!wait_writable()) { return -1; }
  10685. #if defined(_WIN32) && !defined(_WIN64)
  10686. size =
  10687. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10688. #endif
  10689. return send_socket(sock_, ptr, size, CPPHTTPLIB_SEND_FLAGS);
  10690. }
  10691. inline void SocketStream::get_remote_ip_and_port(std::string &ip,
  10692. int &port) const {
  10693. return detail::get_remote_ip_and_port(sock_, ip, port);
  10694. }
  10695. inline void SocketStream::get_local_ip_and_port(std::string &ip,
  10696. int &port) const {
  10697. return detail::get_local_ip_and_port(sock_, ip, port);
  10698. }
  10699. inline socket_t SocketStream::socket() const { return sock_; }
  10700. inline time_t SocketStream::duration() const {
  10701. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10702. std::chrono::steady_clock::now() - start_time_)
  10703. .count();
  10704. }
  10705. inline void SocketStream::set_read_timeout(time_t sec, time_t usec) {
  10706. read_timeout_sec_ = sec;
  10707. read_timeout_usec_ = usec;
  10708. }
  10709. inline void SocketStream::set_max_timeout(time_t msec) {
  10710. max_timeout_msec_ = msec;
  10711. start_time_ = std::chrono::steady_clock::now();
  10712. }
  10713. // Buffer stream implementation
  10714. inline bool BufferStream::is_readable() const { return true; }
  10715. inline bool BufferStream::wait_readable() const { return true; }
  10716. inline bool BufferStream::wait_writable() const { return true; }
  10717. inline ssize_t BufferStream::read(char *ptr, size_t size) {
  10718. #if defined(_MSC_VER) && _MSC_VER < 1910
  10719. auto len_read = buffer._Copy_s(ptr, size, size, position);
  10720. #else
  10721. auto len_read = buffer.copy(ptr, size, position);
  10722. #endif
  10723. position += static_cast<size_t>(len_read);
  10724. return static_cast<ssize_t>(len_read);
  10725. }
  10726. inline ssize_t BufferStream::write(const char *ptr, size_t size) {
  10727. buffer.append(ptr, size);
  10728. return static_cast<ssize_t>(size);
  10729. }
  10730. inline void BufferStream::get_remote_ip_and_port(std::string & /*ip*/,
  10731. int & /*port*/) const {}
  10732. inline void BufferStream::get_local_ip_and_port(std::string & /*ip*/,
  10733. int & /*port*/) const {}
  10734. inline socket_t BufferStream::socket() const { return 0; }
  10735. inline time_t BufferStream::duration() const { return 0; }
  10736. inline const std::string &BufferStream::get_buffer() const { return buffer; }
  10737. inline PathParamsMatcher::PathParamsMatcher(const std::string &pattern)
  10738. : MatcherBase(pattern) {
  10739. constexpr const char marker[] = "/:";
  10740. // One past the last ending position of a path param substring
  10741. std::size_t last_param_end = 0;
  10742. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10743. // Needed to ensure that parameter names are unique during matcher
  10744. // construction
  10745. // If exceptions are disabled, only last duplicate path
  10746. // parameter will be set
  10747. std::unordered_set<std::string> param_name_set;
  10748. #endif
  10749. while (true) {
  10750. const auto marker_pos = pattern.find(
  10751. marker, last_param_end == 0 ? last_param_end : last_param_end - 1);
  10752. if (marker_pos == std::string::npos) { break; }
  10753. static_fragments_.push_back(
  10754. pattern.substr(last_param_end, marker_pos - last_param_end + 1));
  10755. const auto param_name_start = marker_pos + str_len(marker);
  10756. auto sep_pos = pattern.find(separator, param_name_start);
  10757. if (sep_pos == std::string::npos) { sep_pos = pattern.length(); }
  10758. auto param_name =
  10759. pattern.substr(param_name_start, sep_pos - param_name_start);
  10760. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10761. if (param_name_set.find(param_name) != param_name_set.cend()) {
  10762. std::string msg = "Encountered path parameter '" + param_name +
  10763. "' multiple times in route pattern '" + pattern + "'.";
  10764. throw std::invalid_argument(msg);
  10765. }
  10766. #endif
  10767. param_names_.push_back(std::move(param_name));
  10768. last_param_end = sep_pos + 1;
  10769. }
  10770. if (last_param_end < pattern.length()) {
  10771. static_fragments_.push_back(pattern.substr(last_param_end));
  10772. }
  10773. }
  10774. inline bool PathParamsMatcher::match(Request &request) const {
  10775. request.matches = std::smatch();
  10776. request.path_params.clear();
  10777. // A pattern without parameters is just a literal path to compare against
  10778. if (param_names_.empty()) { return request.path == pattern(); }
  10779. request.path_params.reserve(param_names_.size());
  10780. // One past the position at which the path matched the pattern last time
  10781. std::size_t starting_pos = 0;
  10782. for (size_t i = 0; i < static_fragments_.size(); ++i) {
  10783. const auto &fragment = static_fragments_[i];
  10784. if (starting_pos + fragment.length() > request.path.length()) {
  10785. return false;
  10786. }
  10787. // Avoid unnecessary allocation by using strncmp instead of substr +
  10788. // comparison
  10789. if (std::strncmp(request.path.c_str() + starting_pos, fragment.c_str(),
  10790. fragment.length()) != 0) {
  10791. return false;
  10792. }
  10793. starting_pos += fragment.length();
  10794. // Should only happen when we have a static fragment after a param
  10795. // Example: '/users/:id/subscriptions'
  10796. // The 'subscriptions' fragment here does not have a corresponding param
  10797. if (i >= param_names_.size()) { continue; }
  10798. auto sep_pos = request.path.find(separator, starting_pos);
  10799. if (sep_pos == std::string::npos) { sep_pos = request.path.length(); }
  10800. const auto &param_name = param_names_[i];
  10801. request.path_params.emplace(
  10802. param_name, request.path.substr(starting_pos, sep_pos - starting_pos));
  10803. // Mark everything up to '/' as matched
  10804. starting_pos = sep_pos + 1;
  10805. }
  10806. // Returns false if the path is longer than the pattern
  10807. return starting_pos >= request.path.length();
  10808. }
  10809. inline bool RegexMatcher::match(Request &request) const {
  10810. request.path_params.clear();
  10811. // See CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH: an overlong path is treated as
  10812. // a non-match rather than risking a stack overflow in std::regex_match.
  10813. if (request.path.length() > CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH) {
  10814. return false;
  10815. }
  10816. return std::regex_match(request.path, request.matches, regex_);
  10817. }
  10818. // Enclose IPv6 address in brackets if needed
  10819. inline std::string prepare_host_string(const std::string &host) {
  10820. // Enclose IPv6 address in brackets (but not if already enclosed)
  10821. if (host.find(':') == std::string::npos ||
  10822. (!host.empty() && host[0] == '[')) {
  10823. // IPv4, hostname, or already bracketed IPv6
  10824. return host;
  10825. } else {
  10826. // IPv6 address without brackets
  10827. return "[" + host + "]";
  10828. }
  10829. }
  10830. inline std::string make_host_and_port_string(const std::string &host, int port,
  10831. bool is_ssl) {
  10832. auto result = prepare_host_string(host);
  10833. // Append port if not default
  10834. if ((!is_ssl && port == 80) || (is_ssl && port == 443)) {
  10835. ; // do nothing
  10836. } else {
  10837. result += ":" + std::to_string(port);
  10838. }
  10839. return result;
  10840. }
  10841. // Create "host:port" string always including port number (for CONNECT method)
  10842. inline std::string
  10843. make_host_and_port_string_always_port(const std::string &host, int port) {
  10844. return prepare_host_string(host) + ":" + std::to_string(port);
  10845. }
  10846. // Value for the Host header a client sends when the caller supplied none.
  10847. // Only the value: callers decide where in their header list it goes.
  10848. inline std::string make_default_host_header_value(const std::string &host,
  10849. int port, bool is_ssl,
  10850. int address_family) {
  10851. if (address_family == AF_UNIX) { return "localhost"; }
  10852. return make_host_and_port_string(host, port, is_ssl);
  10853. }
  10854. inline void add_default_user_agent_header(Request &req) {
  10855. #ifndef CPPHTTPLIB_NO_DEFAULT_USER_AGENT
  10856. if (!req.has_header("User-Agent")) {
  10857. req.set_header("User-Agent",
  10858. std::string("cpp-httplib/") + CPPHTTPLIB_VERSION);
  10859. }
  10860. #else
  10861. (void)req;
  10862. #endif
  10863. }
  10864. bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out);
  10865. NormalizedTarget normalize_target(const std::string &host);
  10866. bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits);
  10867. bool host_matches_no_proxy(const NormalizedTarget &target,
  10868. const std::vector<NoProxyEntry> &entries);
  10869. inline bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits) {
  10870. if (prefix_bits < 0 || prefix_bits > 128) { return false; }
  10871. if (prefix_bits == 0) { return true; }
  10872. int full_bytes = prefix_bits / 8;
  10873. int rem_bits = prefix_bits % 8;
  10874. if (full_bytes > 0 && std::memcmp(ip.data(), net.data(),
  10875. static_cast<size_t>(full_bytes)) != 0) {
  10876. return false;
  10877. }
  10878. if (rem_bits == 0) { return true; }
  10879. auto i = static_cast<size_t>(full_bytes);
  10880. auto mask = static_cast<uint8_t>(0xFFu << (8 - rem_bits));
  10881. return (ip[i] & mask) == (net[i] & mask);
  10882. }
  10883. inline bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out) {
  10884. if (token.empty()) { return false; }
  10885. if (token == "*") {
  10886. out.kind = NoProxyKind::Wildcard;
  10887. return true;
  10888. }
  10889. auto slash = token.find('/');
  10890. std::string addr_part =
  10891. (slash == std::string::npos) ? token : token.substr(0, slash);
  10892. std::string prefix_part =
  10893. (slash == std::string::npos) ? std::string() : token.substr(slash + 1);
  10894. // A bare slash or trailing-slash CIDR like "10.0.0.0/" is malformed;
  10895. // don't silently treat it as a /32 (or /128).
  10896. if (slash != std::string::npos && prefix_part.empty()) { return false; }
  10897. // Accept the bracketed IPv6 form ("[::1]", "[fe80::]/10") as well as the
  10898. // bare form. Brackets have no meaning for IPv4, so skip the IPv4 attempt
  10899. // when brackets are present.
  10900. bool bracketed = addr_part.size() >= 2 && addr_part.front() == '[' &&
  10901. addr_part.back() == ']';
  10902. if (bracketed) { addr_part = addr_part.substr(1, addr_part.size() - 2); }
  10903. if (!bracketed) {
  10904. struct in_addr v4;
  10905. if (inet_pton(AF_INET, addr_part.c_str(), &v4) == 1) {
  10906. int prefix = 32;
  10907. if (!prefix_part.empty() &&
  10908. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 32,
  10909. prefix)) {
  10910. return false;
  10911. }
  10912. out.kind = NoProxyKind::IPv4Cidr;
  10913. std::memcpy(out.net.data(), &v4, sizeof(v4));
  10914. out.prefix_bits = prefix;
  10915. return true;
  10916. }
  10917. }
  10918. struct in6_addr v6;
  10919. if (inet_pton(AF_INET6, addr_part.c_str(), &v6) == 1) {
  10920. int prefix = 128;
  10921. if (!prefix_part.empty() &&
  10922. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 128,
  10923. prefix)) {
  10924. return false;
  10925. }
  10926. out.kind = NoProxyKind::IPv6Cidr;
  10927. std::memcpy(out.net.data(), &v6, sizeof(v6));
  10928. out.prefix_bits = prefix;
  10929. return true;
  10930. }
  10931. // Bracketed entries can only be IPv6. If the IPv6 parse above failed,
  10932. // the entry is malformed — don't fall through to the hostname branch.
  10933. if (bracketed) { return false; }
  10934. // A '/' on a non-IP token means a CIDR prefix without an address. Reject.
  10935. if (slash != std::string::npos) { return false; }
  10936. // Port-specific entries (host:port) are not supported.
  10937. if (token.find(':') != std::string::npos) { return false; }
  10938. std::string hostname = case_ignore::to_lower(token);
  10939. while (!hostname.empty() && hostname.front() == '.') {
  10940. hostname.erase(hostname.begin());
  10941. }
  10942. while (!hostname.empty() && hostname.back() == '.') {
  10943. hostname.pop_back();
  10944. }
  10945. if (hostname.empty()) { return false; }
  10946. out.kind = NoProxyKind::HostnameSuffix;
  10947. out.hostname_pattern = std::move(hostname);
  10948. return true;
  10949. }
  10950. inline NormalizedTarget normalize_target(const std::string &host) {
  10951. NormalizedTarget t;
  10952. std::string h = host;
  10953. if (h.size() >= 2 && h.front() == '[' && h.back() == ']') {
  10954. h = h.substr(1, h.size() - 2);
  10955. }
  10956. // Strip a single trailing dot so "example.com." canonicalizes to
  10957. // "example.com".
  10958. if (!h.empty() && h.back() == '.') { h.pop_back(); }
  10959. t.hostname = case_ignore::to_lower(h);
  10960. if (!t.hostname.empty()) {
  10961. struct in_addr v4;
  10962. struct in6_addr v6;
  10963. if (inet_pton(AF_INET, t.hostname.c_str(), &v4) == 1) {
  10964. t.is_ipv4 = true;
  10965. std::memcpy(t.ip.data(), &v4, sizeof(v4));
  10966. } else if (inet_pton(AF_INET6, t.hostname.c_str(), &v6) == 1) {
  10967. t.is_ipv6 = true;
  10968. std::memcpy(t.ip.data(), &v6, sizeof(v6));
  10969. }
  10970. }
  10971. return t;
  10972. }
  10973. inline bool host_matches_no_proxy(const NormalizedTarget &target,
  10974. const std::vector<NoProxyEntry> &entries) {
  10975. if (target.hostname.empty()) { return false; }
  10976. for (const auto &e : entries) {
  10977. switch (e.kind) {
  10978. case NoProxyKind::Wildcard: return true;
  10979. case NoProxyKind::IPv4Cidr:
  10980. if (target.is_ipv4 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  10981. return true;
  10982. }
  10983. break;
  10984. case NoProxyKind::IPv6Cidr:
  10985. if (target.is_ipv6 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  10986. return true;
  10987. }
  10988. break;
  10989. case NoProxyKind::HostnameSuffix:
  10990. if (target.is_ipv4 || target.is_ipv6) { break; }
  10991. if (target.hostname == e.hostname_pattern) { return true; }
  10992. // Dot-boundary suffix match: prevents "evilexample.com" from matching
  10993. // an entry of "example.com".
  10994. if (target.hostname.size() > e.hostname_pattern.size() + 1) {
  10995. auto offset = target.hostname.size() - e.hostname_pattern.size();
  10996. if (target.hostname[offset - 1] == '.' &&
  10997. target.hostname.compare(offset, e.hostname_pattern.size(),
  10998. e.hostname_pattern) == 0) {
  10999. return true;
  11000. }
  11001. }
  11002. break;
  11003. }
  11004. }
  11005. return false;
  11006. }
  11007. template <typename T>
  11008. inline bool check_and_write_headers(Stream &strm, Headers &headers,
  11009. T header_writer, Error &error) {
  11010. for (const auto &h : headers) {
  11011. if (!detail::fields::is_field_valid(h.first, h.second)) {
  11012. error = Error::InvalidHeaders;
  11013. return false;
  11014. }
  11015. }
  11016. if (header_writer(strm, headers) <= 0) {
  11017. error = Error::Write;
  11018. return false;
  11019. }
  11020. return true;
  11021. }
  11022. } // namespace detail
  11023. /*
  11024. * Group 2 (continued): detail namespace - SSLSocketStream implementation
  11025. */
  11026. #ifdef CPPHTTPLIB_SSL_ENABLED
  11027. namespace detail {
  11028. // SSL socket stream implementation
  11029. inline SSLSocketStream::SSLSocketStream(
  11030. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  11031. time_t read_timeout_usec, time_t write_timeout_sec,
  11032. time_t write_timeout_usec, time_t max_timeout_msec,
  11033. std::chrono::time_point<std::chrono::steady_clock> start_time)
  11034. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  11035. read_timeout_usec_(read_timeout_usec),
  11036. write_timeout_sec_(write_timeout_sec),
  11037. write_timeout_usec_(write_timeout_usec),
  11038. max_timeout_msec_(max_timeout_msec), start_time_(start_time) {
  11039. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  11040. // Clear AUTO_RETRY for proper non-blocking I/O timeout handling
  11041. // Note: create_session() also clears this, but SSLClient currently
  11042. // uses ssl_new() which does not. Until full TLS API migration is complete,
  11043. // we need to ensure AUTO_RETRY is cleared here regardless of how the
  11044. // SSL session was created.
  11045. SSL_clear_mode(static_cast<SSL *>(session), SSL_MODE_AUTO_RETRY);
  11046. #endif
  11047. }
  11048. inline SSLSocketStream::~SSLSocketStream() = default;
  11049. inline bool SSLSocketStream::is_readable() const {
  11050. return tls::pending(session_) > 0;
  11051. }
  11052. inline bool SSLSocketStream::wait_readable() const {
  11053. if (max_timeout_msec_ <= 0) {
  11054. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  11055. }
  11056. time_t read_timeout_sec;
  11057. time_t read_timeout_usec;
  11058. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  11059. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  11060. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  11061. }
  11062. inline bool SSLSocketStream::wait_writable() const {
  11063. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0 &&
  11064. !tls::is_peer_closed(session_, sock_);
  11065. }
  11066. inline bool SSLSocketStream::ensure_readable() {
  11067. if (readable_hint_) {
  11068. readable_hint_ = false;
  11069. return true;
  11070. }
  11071. return wait_readable();
  11072. }
  11073. inline bool SSLSocketStream::is_peer_alive() const {
  11074. return !tls::is_peer_closed(session_, sock_);
  11075. }
  11076. inline ssize_t SSLSocketStream::read(char *ptr, size_t size) {
  11077. if (tls::pending(session_) > 0) {
  11078. tls::TlsError err;
  11079. auto ret = tls::read(session_, ptr, size, err);
  11080. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11081. error_ = Error::ConnectionClosed;
  11082. }
  11083. return ret;
  11084. } else if (ensure_readable()) {
  11085. tls::TlsError err;
  11086. auto ret = tls::read(session_, ptr, size, err);
  11087. if (ret < 0) {
  11088. auto n = 1000;
  11089. #ifdef _WIN32
  11090. while (--n >= 0 && (err.code == tls::ErrorCode::WantRead ||
  11091. (err.code == tls::ErrorCode::SyscallError &&
  11092. WSAGetLastError() == WSAETIMEDOUT))) {
  11093. #else
  11094. while (--n >= 0 && err.code == tls::ErrorCode::WantRead) {
  11095. #endif
  11096. if (tls::pending(session_) > 0) {
  11097. return tls::read(session_, ptr, size, err);
  11098. } else if (wait_readable()) {
  11099. std::this_thread::sleep_for(std::chrono::microseconds{10});
  11100. ret = tls::read(session_, ptr, size, err);
  11101. if (ret >= 0) { return ret; }
  11102. } else {
  11103. break;
  11104. }
  11105. }
  11106. assert(ret < 0);
  11107. } else if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11108. error_ = Error::ConnectionClosed;
  11109. }
  11110. return ret;
  11111. } else {
  11112. error_ = Error::Timeout;
  11113. return -1;
  11114. }
  11115. }
  11116. inline ssize_t SSLSocketStream::write(const char *ptr, size_t size) {
  11117. if (wait_writable()) {
  11118. auto handle_size =
  11119. std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11120. tls::TlsError err;
  11121. auto ret = tls::write(session_, ptr, handle_size, err);
  11122. if (ret < 0) {
  11123. auto n = 1000;
  11124. #ifdef _WIN32
  11125. while (--n >= 0 && (err.code == tls::ErrorCode::WantWrite ||
  11126. (err.code == tls::ErrorCode::SyscallError &&
  11127. WSAGetLastError() == WSAETIMEDOUT))) {
  11128. #else
  11129. while (--n >= 0 && err.code == tls::ErrorCode::WantWrite) {
  11130. #endif
  11131. if (wait_writable()) {
  11132. std::this_thread::sleep_for(std::chrono::microseconds{10});
  11133. ret = tls::write(session_, ptr, handle_size, err);
  11134. if (ret >= 0) { return ret; }
  11135. } else {
  11136. break;
  11137. }
  11138. }
  11139. assert(ret < 0);
  11140. }
  11141. return ret;
  11142. }
  11143. return -1;
  11144. }
  11145. inline void SSLSocketStream::get_remote_ip_and_port(std::string &ip,
  11146. int &port) const {
  11147. detail::get_remote_ip_and_port(sock_, ip, port);
  11148. }
  11149. inline void SSLSocketStream::get_local_ip_and_port(std::string &ip,
  11150. int &port) const {
  11151. detail::get_local_ip_and_port(sock_, ip, port);
  11152. }
  11153. inline socket_t SSLSocketStream::socket() const { return sock_; }
  11154. inline time_t SSLSocketStream::duration() const {
  11155. return std::chrono::duration_cast<std::chrono::milliseconds>(
  11156. std::chrono::steady_clock::now() - start_time_)
  11157. .count();
  11158. }
  11159. inline void SSLSocketStream::set_read_timeout(time_t sec, time_t usec) {
  11160. read_timeout_sec_ = sec;
  11161. read_timeout_usec_ = usec;
  11162. }
  11163. inline void SSLSocketStream::set_max_timeout(time_t msec) {
  11164. max_timeout_msec_ = msec;
  11165. start_time_ = std::chrono::steady_clock::now();
  11166. }
  11167. inline WebSocketSSLStream::WebSocketSSLStream(socket_t sock,
  11168. tls::session_t session,
  11169. time_t read_timeout_sec,
  11170. time_t read_timeout_usec,
  11171. time_t write_timeout_sec,
  11172. time_t write_timeout_usec)
  11173. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  11174. read_timeout_usec_(read_timeout_usec),
  11175. write_timeout_sec_(write_timeout_sec),
  11176. write_timeout_usec_(write_timeout_usec),
  11177. start_time_(std::chrono::steady_clock::now()) {
  11178. // The receive and send paths run on different threads, so each TLS call is
  11179. // driven in non-blocking mode and readiness is awaited with select()
  11180. // outside the session lock. Set the socket non-blocking once here; it is
  11181. // never flipped back, so no thread races on the flag.
  11182. detail::set_nonblocking(sock_, true);
  11183. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  11184. SSL_clear_mode(static_cast<SSL *>(session_), SSL_MODE_AUTO_RETRY);
  11185. #endif
  11186. }
  11187. inline WebSocketSSLStream::~WebSocketSSLStream() = default;
  11188. inline bool WebSocketSSLStream::is_readable() const {
  11189. std::lock_guard<std::mutex> guard(session_mutex_);
  11190. return tls::pending(session_) > 0;
  11191. }
  11192. inline bool WebSocketSSLStream::wait_readable() const {
  11193. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  11194. }
  11195. inline bool WebSocketSSLStream::wait_writable() const {
  11196. // Unlike SSLSocketStream, this deliberately does not call is_peer_closed():
  11197. // that probe toggles the socket's blocking flag, which would race with the
  11198. // concurrent reader on a permanently non-blocking socket.
  11199. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  11200. }
  11201. inline ssize_t WebSocketSSLStream::read(char *ptr, size_t size) {
  11202. tls::TlsError err;
  11203. auto n = 1000;
  11204. while (--n >= 0) {
  11205. {
  11206. std::lock_guard<std::mutex> guard(session_mutex_);
  11207. auto ret = tls::read(session_, ptr, size, err);
  11208. if (ret > 0) { return ret; }
  11209. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11210. error_ = Error::ConnectionClosed;
  11211. return ret;
  11212. }
  11213. }
  11214. // ret < 0. On a non-blocking socket a TLS read can stop needing either
  11215. // direction: the send path shares this session, so output it left pending
  11216. // has to be flushed before more input can be decrypted. Anything else is
  11217. // a hard error.
  11218. auto needs_readable = err.code == tls::ErrorCode::WantRead;
  11219. #ifdef _WIN32
  11220. // On Windows a socket timeout surfaces as a syscall error, not WantRead.
  11221. needs_readable =
  11222. needs_readable || (err.code == tls::ErrorCode::SyscallError &&
  11223. WSAGetLastError() == WSAETIMEDOUT);
  11224. #endif
  11225. if (!needs_readable && err.code != tls::ErrorCode::WantWrite) {
  11226. error_ = Error::Read;
  11227. return -1;
  11228. }
  11229. if (!(needs_readable ? wait_readable() : wait_writable())) {
  11230. error_ = Error::Timeout;
  11231. return -1;
  11232. }
  11233. }
  11234. // Out of retries. Recording a reason matters: a caller that reads get_error()
  11235. // to tell a timeout from a close would otherwise see whatever the previous
  11236. // failure left behind (error_ is never cleared on success).
  11237. error_ = Error::Read;
  11238. return -1;
  11239. }
  11240. inline ssize_t WebSocketSSLStream::write(const char *ptr, size_t size) {
  11241. auto handle_size = std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11242. tls::TlsError err;
  11243. auto n = 1000;
  11244. while (--n >= 0) {
  11245. {
  11246. std::lock_guard<std::mutex> guard(session_mutex_);
  11247. auto ret = tls::write(session_, ptr, handle_size, err);
  11248. if (ret >= 0) { return ret; }
  11249. }
  11250. // ret < 0. As in read(), either direction can be needed: a renegotiation
  11251. // or a post-handshake message must be consumed before the record goes
  11252. // out. Anything else is a hard error.
  11253. auto needs_writable = err.code == tls::ErrorCode::WantWrite;
  11254. #ifdef _WIN32
  11255. // On Windows a socket timeout surfaces as a syscall error, not WantWrite.
  11256. needs_writable =
  11257. needs_writable || (err.code == tls::ErrorCode::SyscallError &&
  11258. WSAGetLastError() == WSAETIMEDOUT);
  11259. #endif
  11260. if (!needs_writable && err.code != tls::ErrorCode::WantRead) { return -1; }
  11261. if (!(needs_writable ? wait_writable() : wait_readable())) { return -1; }
  11262. }
  11263. return -1;
  11264. }
  11265. inline void WebSocketSSLStream::get_remote_ip_and_port(std::string &ip,
  11266. int &port) const {
  11267. detail::get_remote_ip_and_port(sock_, ip, port);
  11268. }
  11269. inline void WebSocketSSLStream::get_local_ip_and_port(std::string &ip,
  11270. int &port) const {
  11271. detail::get_local_ip_and_port(sock_, ip, port);
  11272. }
  11273. inline socket_t WebSocketSSLStream::socket() const { return sock_; }
  11274. inline time_t WebSocketSSLStream::duration() const {
  11275. return std::chrono::duration_cast<std::chrono::milliseconds>(
  11276. std::chrono::steady_clock::now() - start_time_)
  11277. .count();
  11278. }
  11279. inline void WebSocketSSLStream::set_read_timeout(time_t sec, time_t usec) {
  11280. read_timeout_sec_ = sec;
  11281. read_timeout_usec_ = usec;
  11282. }
  11283. } // namespace detail
  11284. #endif // CPPHTTPLIB_SSL_ENABLED
  11285. /*
  11286. * Group 4: Server implementation
  11287. */
  11288. // HTTP server implementation
  11289. inline Server::Server()
  11290. : new_task_queue([] {
  11291. return new ThreadPool(CPPHTTPLIB_THREAD_POOL_COUNT,
  11292. CPPHTTPLIB_THREAD_POOL_MAX_COUNT);
  11293. }) {
  11294. #ifndef _WIN32
  11295. signal(SIGPIPE, SIG_IGN);
  11296. #endif
  11297. }
  11298. inline Server::~Server() = default;
  11299. inline std::unique_ptr<detail::MatcherBase>
  11300. Server::make_matcher(const std::string &pattern) {
  11301. // Path params take precedence, so "/users/:id/(.*)" keeps being matched as
  11302. // a path params pattern
  11303. if (pattern.find("/:") != std::string::npos) {
  11304. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11305. }
  11306. // A pattern with no regex metacharacter only has to be compared literally,
  11307. // which is what PathParamsMatcher already does when it captures no
  11308. // parameter, so std::regex is only worth building for the patterns that
  11309. // actually need it
  11310. if (pattern.find_first_of(".^$|()[]{}*+?\\") == std::string::npos) {
  11311. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11312. }
  11313. return detail::make_unique<detail::RegexMatcher>(pattern);
  11314. }
  11315. inline Server &Server::Get(const std::string &pattern, Handler handler) {
  11316. return add_handler(get_handlers_, pattern, std::move(handler));
  11317. }
  11318. inline Server &Server::Post(const std::string &pattern, Handler handler) {
  11319. return add_handler(post_handlers_, pattern, std::move(handler));
  11320. }
  11321. inline Server &Server::Post(const std::string &pattern,
  11322. HandlerWithContentReader handler) {
  11323. return add_handler(post_handlers_for_content_reader_, pattern,
  11324. std::move(handler));
  11325. }
  11326. inline Server &Server::Put(const std::string &pattern, Handler handler) {
  11327. return add_handler(put_handlers_, pattern, std::move(handler));
  11328. }
  11329. inline Server &Server::Put(const std::string &pattern,
  11330. HandlerWithContentReader handler) {
  11331. return add_handler(put_handlers_for_content_reader_, pattern,
  11332. std::move(handler));
  11333. }
  11334. inline Server &Server::Patch(const std::string &pattern, Handler handler) {
  11335. return add_handler(patch_handlers_, pattern, std::move(handler));
  11336. }
  11337. inline Server &Server::Patch(const std::string &pattern,
  11338. HandlerWithContentReader handler) {
  11339. return add_handler(patch_handlers_for_content_reader_, pattern,
  11340. std::move(handler));
  11341. }
  11342. inline Server &Server::Delete(const std::string &pattern, Handler handler) {
  11343. return add_handler(delete_handlers_, pattern, std::move(handler));
  11344. }
  11345. inline Server &Server::Delete(const std::string &pattern,
  11346. HandlerWithContentReader handler) {
  11347. return add_handler(delete_handlers_for_content_reader_, pattern,
  11348. std::move(handler));
  11349. }
  11350. inline Server &Server::Options(const std::string &pattern, Handler handler) {
  11351. return add_handler(options_handlers_, pattern, std::move(handler));
  11352. }
  11353. inline const std::set<std::string> &Server::builtin_methods() {
  11354. thread_local const std::set<std::string> methods{
  11355. "GET", "HEAD", "POST", "PUT", "DELETE",
  11356. "CONNECT", "OPTIONS", "TRACE", "PATCH", "PRI"};
  11357. return methods;
  11358. }
  11359. inline Server::CustomHandlerEntry *
  11360. Server::custom_entry_for_registration(const std::string &method) {
  11361. // Built-in methods are refused for two different reasons. GET, HEAD, POST,
  11362. // PUT, DELETE, OPTIONS and PATCH are dispatched by the if/else chain in
  11363. // routing() before the custom tables are consulted, so a route registered
  11364. // for one of them could never fire. CONNECT, TRACE and PRI have no branch
  11365. // there and would be reachable, but they carry protocol-level meaning
  11366. // (tunnel setup, request echo, the HTTP/2 connection preface) that this
  11367. // library does not route.
  11368. if (!detail::fields::is_token(method) || builtin_methods().count(method)) {
  11369. output_error_log(Error::InvalidHTTPMethod, nullptr);
  11370. has_invalid_registration_ = true;
  11371. return nullptr;
  11372. }
  11373. return &custom_handlers_[method];
  11374. }
  11375. inline Server &Server::CustomRoute(const std::string &method,
  11376. const std::string &pattern,
  11377. Handler handler) {
  11378. auto *entry = custom_entry_for_registration(method);
  11379. if (!entry) { return *this; }
  11380. return add_handler(entry->handlers, pattern, std::move(handler));
  11381. }
  11382. inline Server &Server::CustomRoute(const std::string &method,
  11383. const std::string &pattern,
  11384. HandlerWithContentReader handler) {
  11385. auto *entry = custom_entry_for_registration(method);
  11386. if (!entry) { return *this; }
  11387. return add_handler(entry->handlers_for_content_reader, pattern,
  11388. std::move(handler));
  11389. }
  11390. inline const Server::CustomHandlerEntry *
  11391. Server::find_custom_entry(const std::string &method) const {
  11392. // find() alone would be correct here. The empty() check is what keeps the
  11393. // per-request cost off servers that never call CustomRoute(), which is the
  11394. // overwhelmingly common case; keep it rather than walking into the tree.
  11395. if (custom_handlers_.empty()) { return nullptr; }
  11396. auto it = custom_handlers_.find(method);
  11397. return it == custom_handlers_.end() ? nullptr : &it->second;
  11398. }
  11399. inline Server &Server::WebSocket(const std::string &pattern,
  11400. WebSocketHandler handler) {
  11401. websocket_handlers_.push_back(
  11402. {make_matcher(pattern), std::move(handler), nullptr});
  11403. return *this;
  11404. }
  11405. inline Server &Server::WebSocket(const std::string &pattern,
  11406. WebSocketHandler handler,
  11407. SubProtocolSelector sub_protocol_selector) {
  11408. websocket_handlers_.push_back({make_matcher(pattern), std::move(handler),
  11409. std::move(sub_protocol_selector)});
  11410. return *this;
  11411. }
  11412. inline bool Server::set_base_dir(const std::string &dir,
  11413. const std::string &mount_point) {
  11414. return set_mount_point(mount_point, dir);
  11415. }
  11416. inline bool Server::set_mount_point(const std::string &mount_point,
  11417. const std::string &dir, Headers headers) {
  11418. detail::FileStat stat(dir);
  11419. if (stat.is_dir()) {
  11420. std::string mnt = !mount_point.empty() ? mount_point : "/";
  11421. if (!mnt.empty() && mnt[0] == '/') {
  11422. // Without the resolved directory, a file could not be checked to be
  11423. // inside it.
  11424. std::string resolved_base;
  11425. if (!detail::canonicalize_path(dir.c_str(), resolved_base)) {
  11426. return false;
  11427. }
  11428. #if defined(_WIN32)
  11429. if (resolved_base.back() != '\\' && resolved_base.back() != '/') {
  11430. resolved_base += '\\';
  11431. }
  11432. #else
  11433. if (resolved_base.back() != '/') { resolved_base += '/'; }
  11434. #endif
  11435. base_dirs_.push_back(
  11436. {std::move(mnt), dir, std::move(resolved_base), std::move(headers)});
  11437. return true;
  11438. }
  11439. }
  11440. return false;
  11441. }
  11442. inline bool Server::remove_mount_point(const std::string &mount_point) {
  11443. for (auto it = base_dirs_.begin(); it != base_dirs_.end(); ++it) {
  11444. if (it->mount_point == mount_point) {
  11445. base_dirs_.erase(it);
  11446. return true;
  11447. }
  11448. }
  11449. return false;
  11450. }
  11451. inline Server &
  11452. Server::set_file_extension_and_mimetype_mapping(const std::string &ext,
  11453. const std::string &mime) {
  11454. file_extension_and_mimetype_map_[ext] = mime;
  11455. return *this;
  11456. }
  11457. inline Server &Server::set_default_file_mimetype(const std::string &mime) {
  11458. default_file_mimetype_ = mime;
  11459. return *this;
  11460. }
  11461. inline Server &Server::set_file_request_handler(Handler handler) {
  11462. file_request_handler_ = std::move(handler);
  11463. return *this;
  11464. }
  11465. inline Server &Server::set_error_handler_core(HandlerWithResponse handler,
  11466. std::true_type) {
  11467. error_handler_ = std::move(handler);
  11468. return *this;
  11469. }
  11470. inline Server &Server::set_error_handler_core(Handler handler,
  11471. std::false_type) {
  11472. error_handler_ = [handler](const Request &req, Response &res) {
  11473. handler(req, res);
  11474. return HandlerResponse::Handled;
  11475. };
  11476. return *this;
  11477. }
  11478. inline Server &Server::set_exception_handler(ExceptionHandler handler) {
  11479. exception_handler_ = std::move(handler);
  11480. return *this;
  11481. }
  11482. inline Server &Server::set_pre_routing_handler(HandlerWithResponse handler) {
  11483. pre_routing_handler_ = std::move(handler);
  11484. return *this;
  11485. }
  11486. inline Server &Server::set_post_routing_handler(Handler handler) {
  11487. post_routing_handler_ = std::move(handler);
  11488. return *this;
  11489. }
  11490. inline Server &Server::set_pre_request_handler(HandlerWithResponse handler) {
  11491. pre_request_handler_ = std::move(handler);
  11492. return *this;
  11493. }
  11494. inline Server &Server::set_logger(Logger logger) {
  11495. logger_ = std::move(logger);
  11496. return *this;
  11497. }
  11498. inline Server &Server::set_error_logger(ErrorLogger error_logger) {
  11499. error_logger_ = std::move(error_logger);
  11500. return *this;
  11501. }
  11502. inline Server &Server::set_pre_compression_logger(Logger logger) {
  11503. pre_compression_logger_ = std::move(logger);
  11504. return *this;
  11505. }
  11506. inline Server &
  11507. Server::set_expect_100_continue_handler(Expect100ContinueHandler handler) {
  11508. expect_100_continue_handler_ = std::move(handler);
  11509. return *this;
  11510. }
  11511. inline Server &Server::set_start_handler(StartHandler handler) {
  11512. start_handler_ = std::move(handler);
  11513. return *this;
  11514. }
  11515. inline Server &Server::set_address_family(int family) {
  11516. address_family_ = family;
  11517. return *this;
  11518. }
  11519. inline Server &Server::set_tcp_nodelay(bool on) {
  11520. tcp_nodelay_ = on;
  11521. return *this;
  11522. }
  11523. inline Server &Server::set_ipv6_v6only(bool on) {
  11524. ipv6_v6only_ = on;
  11525. return *this;
  11526. }
  11527. inline Server &Server::set_socket_options(SocketOptions socket_options) {
  11528. socket_options_ = std::move(socket_options);
  11529. return *this;
  11530. }
  11531. inline Server &Server::set_default_headers(Headers headers) {
  11532. default_headers_ = std::move(headers);
  11533. return *this;
  11534. }
  11535. inline Server &Server::set_header_writer(
  11536. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  11537. header_writer_ = writer;
  11538. return *this;
  11539. }
  11540. inline Server &
  11541. Server::set_trusted_proxies(const std::vector<std::string> &proxies) {
  11542. trusted_proxies_ = proxies;
  11543. return *this;
  11544. }
  11545. inline Server &Server::set_keep_alive_max_count(size_t count) {
  11546. keep_alive_max_count_ = count;
  11547. return *this;
  11548. }
  11549. inline Server &Server::set_keep_alive_timeout(time_t sec) {
  11550. keep_alive_timeout_sec_ = sec;
  11551. return *this;
  11552. }
  11553. template <class Rep, class Period>
  11554. inline Server &Server::set_keep_alive_timeout(
  11555. const std::chrono::duration<Rep, Period> &duration) {
  11556. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11557. set_keep_alive_timeout(sec);
  11558. });
  11559. return *this;
  11560. }
  11561. inline Server &Server::set_read_timeout(time_t sec, time_t usec) {
  11562. read_timeout_sec_ = sec;
  11563. read_timeout_usec_ = usec;
  11564. return *this;
  11565. }
  11566. inline Server &Server::set_write_timeout(time_t sec, time_t usec) {
  11567. write_timeout_sec_ = sec;
  11568. write_timeout_usec_ = usec;
  11569. return *this;
  11570. }
  11571. inline Server &Server::set_idle_interval(time_t sec, time_t usec) {
  11572. idle_interval_sec_ = sec;
  11573. idle_interval_usec_ = usec;
  11574. return *this;
  11575. }
  11576. inline Server &Server::set_payload_max_length(size_t length) {
  11577. payload_max_length_ = length;
  11578. return *this;
  11579. }
  11580. inline Server &Server::set_static_file_compression(bool on) {
  11581. static_file_compression_ = on;
  11582. return *this;
  11583. }
  11584. inline Server &Server::set_static_file_compression_min_length(size_t length) {
  11585. static_file_compression_min_length_ = length;
  11586. return *this;
  11587. }
  11588. inline Server &Server::set_static_file_compression_max_length(size_t length) {
  11589. static_file_compression_max_length_ = length;
  11590. return *this;
  11591. }
  11592. inline Server &Server::set_websocket_max_missed_pongs(int count) {
  11593. websocket_max_missed_pongs_ = count;
  11594. return *this;
  11595. }
  11596. inline Server &Server::set_websocket_ping_interval(time_t sec) {
  11597. websocket_ping_interval_sec_ = sec;
  11598. return *this;
  11599. }
  11600. template <class Rep, class Period>
  11601. inline Server &Server::set_websocket_ping_interval(
  11602. const std::chrono::duration<Rep, Period> &duration) {
  11603. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11604. set_websocket_ping_interval(sec);
  11605. });
  11606. return *this;
  11607. }
  11608. inline bool Server::bind_to_port(const std::string &host, int port,
  11609. int socket_flags) {
  11610. auto ret = bind_internal(host, port, socket_flags);
  11611. if (ret == -1) { is_decommissioned = true; }
  11612. return ret >= 0;
  11613. }
  11614. inline int Server::bind_to_any_port(const std::string &host, int socket_flags) {
  11615. auto ret = bind_internal(host, 0, socket_flags);
  11616. if (ret == -1) { is_decommissioned = true; }
  11617. return ret;
  11618. }
  11619. inline bool Server::listen_after_bind() { return listen_internal(); }
  11620. inline bool Server::listen(const std::string &host, int port,
  11621. int socket_flags) {
  11622. return bind_to_port(host, port, socket_flags) && listen_internal();
  11623. }
  11624. inline bool Server::is_running() const { return is_running_; }
  11625. inline void Server::wait_until_ready() const {
  11626. while (!is_running_ && !is_decommissioned) {
  11627. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  11628. }
  11629. }
  11630. inline void Server::stop() noexcept {
  11631. // Release the listening socket whether or not the accept loop is running:
  11632. // bind_to_port() without listen_after_bind() still owns the descriptor. The
  11633. // exchange is what makes this safe to call concurrently with the accept loop.
  11634. socket_t sock = svr_sock_.exchange(INVALID_SOCKET);
  11635. if (sock != INVALID_SOCKET) {
  11636. detail::shutdown_socket(sock);
  11637. detail::close_socket(sock);
  11638. }
  11639. is_decommissioned = false;
  11640. }
  11641. inline void Server::decommission() { is_decommissioned = true; }
  11642. inline bool Server::parse_request_line(const char *s, Request &req) const {
  11643. auto len = strlen(s);
  11644. if (len < 2 || s[len - 2] != '\r' || s[len - 1] != '\n') { return false; }
  11645. len -= 2;
  11646. {
  11647. // RFC 9112 §3: exactly one SP between the method, the target and the
  11648. // version. Taking other whitespace as a separator too lets recipients
  11649. // that parse more strictly see a different request.
  11650. auto end = s + len;
  11651. if (std::count(s, end, ' ') != 2) { return false; }
  11652. auto sp1 = std::find(s, end, ' ');
  11653. auto sp2 = std::find(sp1 + 1, end, ' ');
  11654. if (sp1 == s || sp2 == sp1 + 1 || sp2 + 1 == end) { return false; }
  11655. req.method.assign(s, sp1);
  11656. req.target.assign(sp1 + 1, sp2);
  11657. req.version.assign(sp2 + 1, end);
  11658. }
  11659. // A method outside the built-in set is accepted only when a handler has been
  11660. // registered for it with CustomRoute().
  11661. const auto &methods = builtin_methods();
  11662. if (methods.find(req.method) == methods.end() &&
  11663. !find_custom_entry(req.method)) {
  11664. output_error_log(Error::InvalidHTTPMethod, &req);
  11665. return false;
  11666. }
  11667. if (req.version != "HTTP/1.1" && req.version != "HTTP/1.0") {
  11668. output_error_log(Error::InvalidHTTPVersion, &req);
  11669. return false;
  11670. }
  11671. // A request-target has no fragment (RFC 9112 §3.2), and one stripped here
  11672. // would leave this server routing a different path than a cache or a
  11673. // filter in front of it sees.
  11674. if (!detail::fields::is_request_target(req.target) ||
  11675. req.target.find('#') != std::string::npos) {
  11676. return false;
  11677. }
  11678. {
  11679. detail::divide(req.target, '?',
  11680. [&](const char *lhs_data, std::size_t lhs_size,
  11681. const char *rhs_data, std::size_t rhs_size) {
  11682. req.path =
  11683. decode_path_component(std::string(lhs_data, lhs_size));
  11684. detail::parse_query_text(rhs_data, rhs_size, req.params);
  11685. });
  11686. }
  11687. return true;
  11688. }
  11689. inline bool Server::write_response(Stream &strm, bool close_connection,
  11690. Request &req, Response &res) {
  11691. // NOTE: `req.ranges` should be empty, otherwise it will be applied
  11692. // incorrectly to the error content.
  11693. req.ranges.clear();
  11694. return write_response_core(strm, close_connection, req, res, false);
  11695. }
  11696. inline bool Server::write_response_with_content(Stream &strm,
  11697. bool close_connection,
  11698. const Request &req,
  11699. Response &res) {
  11700. return write_response_core(strm, close_connection, req, res, true);
  11701. }
  11702. inline bool Server::write_response_core(Stream &strm, bool close_connection,
  11703. const Request &req, Response &res,
  11704. bool need_apply_ranges) {
  11705. assert(res.status != -1);
  11706. if (400 <= res.status && error_handler_ &&
  11707. error_handler_(req, res) == HandlerResponse::Handled) {
  11708. need_apply_ranges = true;
  11709. }
  11710. if (!detail::body_allowed_for_status(res.status)) {
  11711. detail::clear_content(res);
  11712. }
  11713. detail::prefer_assigned_body(res);
  11714. std::string content_type;
  11715. std::string boundary;
  11716. if (need_apply_ranges) { apply_ranges(req, res, content_type, boundary); }
  11717. // Prepare additional headers
  11718. if (close_connection ||
  11719. detail::has_header_token(req.headers, "Connection", "close") ||
  11720. 400 <= res.status || // Don't leave connections open after errors
  11721. // The client withholds the body until `100 Continue`, which was never
  11722. // sent, so whether and when the body follows is unknown.
  11723. (req.expect_100_continue_pending_ && detail::has_framed_body(req)) ||
  11724. // The body was left partway, e.g. by a content receiver that returned
  11725. // false, so the rest of it cannot be told from the next request.
  11726. (req.body_read_started_ && !req.body_consumed_)) {
  11727. res.set_header("Connection", "close");
  11728. } else {
  11729. std::string s = "timeout=";
  11730. s += std::to_string(keep_alive_timeout_sec_);
  11731. s += ", max=";
  11732. s += std::to_string(keep_alive_max_count_);
  11733. res.set_header("Keep-Alive", s);
  11734. }
  11735. if ((!res.body.empty() || res.content_length_ > 0 || res.content_provider_) &&
  11736. !res.has_header("Content-Type")) {
  11737. res.set_header("Content-Type", "text/plain");
  11738. }
  11739. detail::set_framing_headers(req, res, boundary, content_type);
  11740. if (req.method == "HEAD" && !res.has_header("Accept-Ranges")) {
  11741. res.set_header("Accept-Ranges", "bytes");
  11742. }
  11743. if (post_routing_handler_) {
  11744. post_routing_handler_(req, res);
  11745. // Again, for a body or framing headers the handler changed.
  11746. detail::set_framing_headers(req, res, boundary, content_type);
  11747. }
  11748. // Response line and headers
  11749. detail::BufferStream bstrm;
  11750. if (!detail::write_response_line(bstrm, res.status)) { return false; }
  11751. if (header_writer_(bstrm, res.headers) <= 0) { return false; }
  11752. // Combine a small body with the headers so the whole response leaves in a
  11753. // single write. A large body is written on its own instead: a copy of it
  11754. // costs more than the extra write saves.
  11755. auto send_body =
  11756. req.method != "HEAD" && detail::body_allowed_for_status(res.status);
  11757. auto body_is_separate = false;
  11758. auto provider_done = false;
  11759. if (send_body && !res.body.empty() && !res.content_provider_) {
  11760. if (res.body.size() < CPPHTTPLIB_SEND_BUFSIZ) {
  11761. bstrm.write(res.body.data(), res.body.size());
  11762. } else {
  11763. body_is_separate = true;
  11764. }
  11765. } else if (send_body && res.content_provider_ &&
  11766. res.is_file_content_provider_ &&
  11767. res.content_length_ < CPPHTTPLIB_SEND_BUFSIZ) {
  11768. // A small file is read into the same buffer. Other providers may produce
  11769. // their data over time, so they are never held back.
  11770. if (!write_content_with_provider(bstrm, req, res, boundary, content_type)) {
  11771. return false;
  11772. }
  11773. provider_done = true;
  11774. }
  11775. // Log before writing to avoid race condition with client-side code that
  11776. // accesses logger-captured data immediately after receiving the response.
  11777. output_log(req, res);
  11778. // Flush buffer
  11779. auto &data = bstrm.get_buffer();
  11780. if (!detail::write_data(strm, data.data(), data.size())) { return false; }
  11781. if (body_is_separate) {
  11782. return detail::write_data(strm, res.body.data(), res.body.size());
  11783. }
  11784. // Streaming body
  11785. if (send_body && res.content_provider_) {
  11786. if (!provider_done &&
  11787. !write_content_with_provider(strm, req, res, boundary, content_type)) {
  11788. return false;
  11789. }
  11790. res.content_provider_success_ = true;
  11791. }
  11792. return true;
  11793. }
  11794. inline bool
  11795. Server::write_content_with_provider(Stream &strm, const Request &req,
  11796. Response &res, const std::string &boundary,
  11797. const std::string &content_type) {
  11798. auto is_shutting_down = [this]() {
  11799. return this->svr_sock_ == INVALID_SOCKET;
  11800. };
  11801. if (res.content_length_ > 0) {
  11802. if (!detail::is_partial_content(req, res)) {
  11803. return detail::write_content(strm, res.content_provider_, 0,
  11804. res.content_length_, is_shutting_down);
  11805. } else if (req.ranges.size() == 1) {
  11806. auto offset_and_length = detail::get_range_offset_and_length(
  11807. req.ranges[0], res.content_length_);
  11808. return detail::write_content(strm, res.content_provider_,
  11809. offset_and_length.first,
  11810. offset_and_length.second, is_shutting_down);
  11811. } else {
  11812. return detail::write_multipart_ranges_data(
  11813. strm, req, res, boundary, content_type, res.content_length_,
  11814. is_shutting_down);
  11815. }
  11816. } else {
  11817. if (res.is_chunked_content_provider_) {
  11818. // Use the coding `apply_ranges()` chose when it wrote the headers;
  11819. // re-negotiating here would disagree with them, e.g. once a handler's
  11820. // own Content-Encoding header suppresses the negotiation.
  11821. auto compressor = detail::make_compressor(res.content_coding_);
  11822. if (!compressor) {
  11823. compressor = detail::make_unique<detail::nocompressor>();
  11824. }
  11825. return detail::write_content_chunked(strm, res.content_provider_,
  11826. is_shutting_down, *compressor);
  11827. } else {
  11828. return detail::write_content_without_length(strm, res.content_provider_,
  11829. is_shutting_down);
  11830. }
  11831. }
  11832. }
  11833. inline bool Server::read_content(Stream &strm, Request &req, Response &res) {
  11834. FormFields::iterator cur_field;
  11835. FormFiles::iterator cur_file;
  11836. auto is_text_field = false;
  11837. size_t count = 0;
  11838. if (read_content_core(
  11839. strm, req, res,
  11840. // Regular
  11841. [&](const char *buf, size_t n) {
  11842. // Prevent arithmetic overflow when checking sizes.
  11843. // Avoid computing (req.body.size() + n) directly because
  11844. // adding two unsigned `size_t` values can wrap around and
  11845. // produce a small result instead of indicating overflow.
  11846. // Instead, check using subtraction: ensure `n` does not
  11847. // exceed the remaining capacity `max_size() - size()`.
  11848. if (req.body.size() >= req.body.max_size() ||
  11849. n > req.body.max_size() - req.body.size()) {
  11850. return false;
  11851. }
  11852. // Limit decompressed body size to payload_max_length_ to protect
  11853. // against "zip bomb" attacks where a small compressed payload
  11854. // decompresses to a massive size.
  11855. if (payload_max_length_ > 0 &&
  11856. (req.body.size() >= payload_max_length_ ||
  11857. n > payload_max_length_ - req.body.size())) {
  11858. return false;
  11859. }
  11860. req.body.append(buf, n);
  11861. return true;
  11862. },
  11863. // Multipart FormData
  11864. [&](const FormData &file) {
  11865. if (count++ == CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT) {
  11866. output_error_log(Error::TooManyFormDataFiles, &req);
  11867. return false;
  11868. }
  11869. if (file.filename.empty()) {
  11870. cur_field = req.form.fields.emplace(
  11871. file.name, FormField{file.name, file.content, file.headers});
  11872. is_text_field = true;
  11873. } else {
  11874. cur_file = req.form.files.emplace(file.name, file);
  11875. is_text_field = false;
  11876. }
  11877. return true;
  11878. },
  11879. [&](const char *buf, size_t n) {
  11880. if (is_text_field) {
  11881. auto &content = cur_field->second.content;
  11882. if (content.size() + n > content.max_size()) { return false; }
  11883. content.append(buf, n);
  11884. } else {
  11885. auto &content = cur_file->second.content;
  11886. if (content.size() + n > content.max_size()) { return false; }
  11887. content.append(buf, n);
  11888. }
  11889. return true;
  11890. })) {
  11891. const auto &content_type = req.get_header_value("Content-Type");
  11892. if (detail::case_ignore::equal(detail::extract_media_type(content_type),
  11893. "application/x-www-form-urlencoded")) {
  11894. if (req.body.size() > CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH) {
  11895. res.status = StatusCode::PayloadTooLarge_413; // NOTE: should be 414?
  11896. output_error_log(Error::ExceedMaxPayloadSize, &req);
  11897. return false;
  11898. }
  11899. detail::parse_query_text(req.body, req.params);
  11900. }
  11901. return true;
  11902. }
  11903. return false;
  11904. }
  11905. inline bool Server::read_content_with_content_receiver(
  11906. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  11907. FormDataHeader multipart_header, ContentReceiver multipart_receiver) {
  11908. return read_content_core(strm, req, res, std::move(receiver),
  11909. std::move(multipart_header),
  11910. std::move(multipart_receiver));
  11911. }
  11912. inline bool Server::read_content_core(
  11913. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  11914. FormDataHeader multipart_header, ContentReceiver multipart_receiver) const {
  11915. detail::FormDataParser multipart_form_data_parser;
  11916. ContentReceiverWithProgress out;
  11917. if (req.is_multipart_form_data()) {
  11918. const auto &content_type = req.get_header_value("Content-Type");
  11919. std::string boundary;
  11920. if (!detail::parse_multipart_boundary(content_type, boundary)) {
  11921. res.status = StatusCode::BadRequest_400;
  11922. output_error_log(Error::MultipartParsing, &req);
  11923. return false;
  11924. }
  11925. multipart_form_data_parser.set_boundary(std::move(boundary));
  11926. out = [&](const char *buf, size_t n, size_t /*off*/, size_t /*len*/) {
  11927. return multipart_form_data_parser.parse(buf, n, multipart_header,
  11928. multipart_receiver);
  11929. };
  11930. } else {
  11931. out = [receiver](const char *buf, size_t n, size_t /*off*/,
  11932. size_t /*len*/) { return receiver(buf, n); };
  11933. }
  11934. // RFC 9112 §6: no Transfer-Encoding and no Content-Length means no body.
  11935. // For non-SSL builds we still scan non-persistent connections for stray
  11936. // body bytes so the payload limit is enforced (413). On keep-alive,
  11937. // pending bytes may be the next request (issue #2450), so skip.
  11938. #if !defined(CPPHTTPLIB_SSL_ENABLED)
  11939. if (!req.has_header("Content-Length") &&
  11940. !detail::is_chunked_transfer_encoding(req.headers)) {
  11941. if (!detail::is_connection_persistent(req) && payload_max_length_ > 0 &&
  11942. payload_max_length_ < (std::numeric_limits<size_t>::max)()) {
  11943. auto has_data = strm.is_readable();
  11944. if (!has_data) {
  11945. auto s = strm.socket();
  11946. if (s != INVALID_SOCKET) {
  11947. has_data = detail::select_read(s, 0, 0) > 0;
  11948. }
  11949. }
  11950. if (has_data) {
  11951. // Route through the same decompressing reader used by the
  11952. // length-framed and chunked paths below, so payload_max_length_ is
  11953. // enforced on the decompressed size here too instead of only on the
  11954. // compressed wire bytes.
  11955. return detail::read_content(strm, req, payload_max_length_, res.status,
  11956. nullptr, out, true);
  11957. }
  11958. }
  11959. return true;
  11960. }
  11961. #else
  11962. if (!req.has_header("Content-Length") &&
  11963. !detail::is_chunked_transfer_encoding(req.headers)) {
  11964. return true;
  11965. }
  11966. #endif
  11967. // A second read would start where the first one stopped, or in the next
  11968. // request.
  11969. if (req.body_read_started_) { return false; }
  11970. // The client is waiting for this before it sends the body.
  11971. if (req.expect_100_continue_pending_) {
  11972. req.expect_100_continue_pending_ = false;
  11973. detail::write_response_line(strm, StatusCode::Continue_100);
  11974. strm.write("\r\n");
  11975. }
  11976. // Set before reading, since a receiver may also stop by throwing.
  11977. req.body_read_started_ = true;
  11978. if (!detail::read_content(strm, req, payload_max_length_, res.status, nullptr,
  11979. out, true)) {
  11980. return false;
  11981. }
  11982. req.body_consumed_ = true;
  11983. if (req.is_multipart_form_data()) {
  11984. if (!multipart_form_data_parser.is_valid()) {
  11985. res.status = StatusCode::BadRequest_400;
  11986. output_error_log(Error::MultipartParsing, &req);
  11987. return false;
  11988. }
  11989. }
  11990. return true;
  11991. }
  11992. inline bool Server::handle_file_request(Request &req, Response &res) {
  11993. for (const auto &entry : base_dirs_) {
  11994. // Prefix match, on a path segment boundary. A mount point of "/mount"
  11995. // covers "/mount" and "/mount/...", but must not swallow "/mountdir/...".
  11996. // One that already ends in '/' (the root mount among them) carries its own
  11997. // boundary; set_mount_point() guarantees the mount point is not empty.
  11998. if (!req.path.compare(0, entry.mount_point.size(), entry.mount_point) &&
  11999. (entry.mount_point.back() == '/' ||
  12000. req.path.size() == entry.mount_point.size() ||
  12001. req.path[entry.mount_point.size()] == '/')) {
  12002. std::string sub_path = "/" + req.path.substr(entry.mount_point.size());
  12003. if (detail::is_valid_path(sub_path)) {
  12004. auto path = entry.base_dir + sub_path;
  12005. if (path.back() == '/') { path += "index.html"; }
  12006. // Defense-in-depth: is_valid_path blocks ".." traversal in the URL,
  12007. // but symlinks/junctions can still escape the base directory. A path
  12008. // that cannot be resolved, which includes one that does not exist, is
  12009. // not served from here.
  12010. std::string resolved_path;
  12011. if (!detail::canonicalize_path(path.c_str(), resolved_path)) {
  12012. continue;
  12013. }
  12014. if (!detail::is_path_within_base(resolved_path,
  12015. entry.resolved_base_dir)) {
  12016. res.status = StatusCode::Forbidden_403;
  12017. return true;
  12018. }
  12019. detail::FileStat stat(path);
  12020. if (stat.is_dir()) {
  12021. // Relative, so "//dir" cannot name another host; "./" keeps a ':'
  12022. // in the name from reading as a scheme.
  12023. auto name = req.path.substr(req.path.rfind('/') + 1);
  12024. res.set_redirect("./" + encode_path_component(name) + "/",
  12025. StatusCode::MovedPermanently_301);
  12026. return true;
  12027. }
  12028. if (stat.is_file()) {
  12029. for (const auto &kv : entry.headers) {
  12030. res.set_header(kv.first, kv.second);
  12031. }
  12032. auto content_type = detail::find_content_type(
  12033. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  12034. auto encoding = detail::EncodingType::None;
  12035. if (static_file_compression_) {
  12036. encoding =
  12037. static_file_encoding(req, res, content_type, stat.size());
  12038. }
  12039. // The ETag names the representation actually sent, so a client that
  12040. // cached the compressed form revalidates against the compressed ETag
  12041. // and still gets a 304, while one that took identity keeps the plain
  12042. // ETag.
  12043. auto etag = detail::compute_etag(
  12044. stat, encoding == detail::EncodingType::None
  12045. ? std::string()
  12046. : std::string("-") + detail::encoding_name(encoding));
  12047. if (!etag.empty()) { res.set_header("ETag", etag); }
  12048. auto mtime = stat.mtime();
  12049. auto last_modified = detail::file_mtime_to_http_date(mtime);
  12050. if (!last_modified.empty()) {
  12051. res.set_header("Last-Modified", last_modified);
  12052. }
  12053. if (check_if_not_modified(req, res, etag, mtime)) { return true; }
  12054. check_if_range(req, etag, mtime);
  12055. auto mm = std::make_shared<detail::mmap>(path.c_str());
  12056. if (!mm->is_open()) {
  12057. output_error_log(Error::OpenFile, &req);
  12058. return false;
  12059. }
  12060. detail::set_file_content_provider(res, mm, content_type, encoding);
  12061. if (req.method != "HEAD" && file_request_handler_) {
  12062. file_request_handler_(req, res);
  12063. }
  12064. return true;
  12065. } else {
  12066. output_error_log(Error::OpenFile, &req);
  12067. }
  12068. }
  12069. }
  12070. }
  12071. return false;
  12072. }
  12073. inline bool Server::check_if_not_modified(const Request &req, Response &res,
  12074. const std::string &etag,
  12075. time_t mtime) const {
  12076. // Handle conditional GET:
  12077. // 1. If-None-Match takes precedence (RFC 9110 Section 13.1.2)
  12078. // 2. If-Modified-Since is checked only when If-None-Match is absent
  12079. if (req.has_header("If-None-Match")) {
  12080. if (!etag.empty()) {
  12081. auto val =
  12082. detail::get_combined_header_value(req.headers, "If-None-Match");
  12083. // NOTE: We use exact string matching here. This works correctly
  12084. // because our server always generates weak ETags (W/"..."), and
  12085. // clients typically send back the same ETag they received.
  12086. // RFC 9110 Section 8.8.3.2 allows weak comparison for
  12087. // If-None-Match, where W/"x" and "x" would match, but this
  12088. // simplified implementation requires exact matches.
  12089. auto ret = detail::split_find(val.data(), val.data() + val.size(), ',',
  12090. [&](const char *b, const char *e) {
  12091. auto seg_len = static_cast<size_t>(e - b);
  12092. return (seg_len == 1 && *b == '*') ||
  12093. (seg_len == etag.size() &&
  12094. std::equal(b, e, etag.begin()));
  12095. });
  12096. if (ret) {
  12097. res.status = StatusCode::NotModified_304;
  12098. return true;
  12099. }
  12100. }
  12101. } else if (req.has_header("If-Modified-Since")) {
  12102. auto val = req.get_header_value("If-Modified-Since");
  12103. auto t = detail::parse_http_date(val);
  12104. if (t != static_cast<time_t>(-1) && mtime <= t) {
  12105. res.status = StatusCode::NotModified_304;
  12106. return true;
  12107. }
  12108. }
  12109. return false;
  12110. }
  12111. inline bool Server::check_if_range(Request &req, const std::string &etag,
  12112. time_t mtime) const {
  12113. // Handle If-Range for partial content requests (RFC 9110
  12114. // Section 13.1.5). If-Range is only evaluated when Range header is
  12115. // present. If the validator matches, serve partial content; otherwise
  12116. // serve full content.
  12117. if (!req.ranges.empty() && req.has_header("If-Range")) {
  12118. auto val = req.get_header_value("If-Range");
  12119. auto is_valid_range = [&]() {
  12120. if (detail::is_strong_etag(val)) {
  12121. // RFC 9110 Section 13.1.5: If-Range requires strong ETag
  12122. // comparison.
  12123. return (!etag.empty() && val == etag);
  12124. } else if (detail::is_weak_etag(val)) {
  12125. // Weak ETags are not valid for If-Range (RFC 9110 Section 13.1.5)
  12126. return false;
  12127. } else {
  12128. // HTTP-date comparison
  12129. auto t = detail::parse_http_date(val);
  12130. return (t != static_cast<time_t>(-1) && mtime <= t);
  12131. }
  12132. };
  12133. if (!is_valid_range()) {
  12134. // Validator doesn't match: ignore Range and serve full content
  12135. req.ranges.clear();
  12136. return false;
  12137. }
  12138. }
  12139. return true;
  12140. }
  12141. inline socket_t
  12142. Server::create_server_socket(const std::string &host, int port,
  12143. int socket_flags,
  12144. SocketOptions socket_options) const {
  12145. return detail::create_socket(
  12146. host, std::string(), port, address_family_, socket_flags, tcp_nodelay_,
  12147. ipv6_v6only_, std::move(socket_options),
  12148. [&](socket_t sock, struct addrinfo &ai, bool & /*quit*/) -> bool {
  12149. if (::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  12150. output_error_log(Error::BindIPAddress, nullptr);
  12151. return false;
  12152. }
  12153. if (::listen(sock, CPPHTTPLIB_LISTEN_BACKLOG)) {
  12154. output_error_log(Error::Listen, nullptr);
  12155. return false;
  12156. }
  12157. return true;
  12158. });
  12159. }
  12160. inline int Server::bind_internal(const std::string &host, int port,
  12161. int socket_flags) {
  12162. if (is_decommissioned) { return -1; }
  12163. if (!is_valid()) { return -1; }
  12164. svr_sock_ = create_server_socket(host, port, socket_flags, socket_options_);
  12165. if (svr_sock_ == INVALID_SOCKET) { return -1; }
  12166. if (port == 0) {
  12167. struct sockaddr_storage addr;
  12168. socklen_t addr_len = sizeof(addr);
  12169. if (getsockname(svr_sock_, reinterpret_cast<struct sockaddr *>(&addr),
  12170. &addr_len) == -1) {
  12171. output_error_log(Error::GetSockName, nullptr);
  12172. return -1;
  12173. }
  12174. if (addr.ss_family == AF_INET) {
  12175. return ntohs(reinterpret_cast<struct sockaddr_in *>(&addr)->sin_port);
  12176. } else if (addr.ss_family == AF_INET6) {
  12177. return ntohs(reinterpret_cast<struct sockaddr_in6 *>(&addr)->sin6_port);
  12178. } else {
  12179. output_error_log(Error::UnsupportedAddressFamily, nullptr);
  12180. return -1;
  12181. }
  12182. } else {
  12183. return port;
  12184. }
  12185. }
  12186. inline bool Server::listen_internal() {
  12187. // A stop() between bind and listen leaves nothing to accept on. Report
  12188. // failure instead of returning success without ever serving, and mark the
  12189. // server decommissioned the way any failed listen does so that a concurrent
  12190. // wait_until_ready() wakes up instead of spinning forever.
  12191. if (is_decommissioned || svr_sock_ == INVALID_SOCKET) {
  12192. is_decommissioned = true;
  12193. return false;
  12194. }
  12195. auto ret = true;
  12196. is_running_ = true;
  12197. auto se = detail::scope_exit([&]() { is_running_ = false; });
  12198. if (start_handler_) { start_handler_(); }
  12199. {
  12200. std::unique_ptr<TaskQueue> task_queue(new_task_queue());
  12201. while (svr_sock_ != INVALID_SOCKET) {
  12202. #ifndef _WIN32
  12203. if (idle_interval_sec_ > 0 || idle_interval_usec_ > 0) {
  12204. #endif
  12205. auto val = detail::select_read(svr_sock_, idle_interval_sec_,
  12206. idle_interval_usec_);
  12207. if (val == 0) { // Timeout
  12208. task_queue->on_idle();
  12209. continue;
  12210. }
  12211. #ifndef _WIN32
  12212. }
  12213. #endif
  12214. #if defined _WIN32
  12215. // sockets connected via WASAccept inherit flags NO_HANDLE_INHERIT,
  12216. // OVERLAPPED
  12217. socket_t sock = WSAAccept(svr_sock_, nullptr, nullptr, nullptr, 0);
  12218. #elif defined SOCK_CLOEXEC
  12219. socket_t sock = accept4(svr_sock_, nullptr, nullptr, SOCK_CLOEXEC);
  12220. #else
  12221. socket_t sock = accept(svr_sock_, nullptr, nullptr);
  12222. #endif
  12223. if (sock == INVALID_SOCKET) {
  12224. // NOTE: Winsock reports failures through WSAGetLastError() and never
  12225. // touches the CRT errno, so the two have to be asked platform by
  12226. // platform rather than by testing errno here.
  12227. if (detail::is_accept_resource_error()) {
  12228. // The per-process descriptor limit or the network stack's buffer
  12229. // space has been reached. Try to accept new connections after a
  12230. // short sleep.
  12231. std::this_thread::sleep_for(std::chrono::microseconds{1});
  12232. continue;
  12233. } else if (detail::is_accept_transient_error()) {
  12234. continue;
  12235. }
  12236. // Take the descriptor out of svr_sock_ before closing it: a later
  12237. // stop() would otherwise shutdown()/close() a value the OS may have
  12238. // reused, and keep_alive() watches svr_sock_ to notice the server is
  12239. // gone. The exchange also settles the race with a concurrent stop(),
  12240. // since whichever side takes the descriptor closes it exactly once.
  12241. auto listen_sock = svr_sock_.exchange(INVALID_SOCKET);
  12242. if (listen_sock != INVALID_SOCKET) {
  12243. detail::close_socket(listen_sock);
  12244. ret = false;
  12245. output_error_log(Error::Connection, nullptr);
  12246. } else {
  12247. ; // The server socket was closed by user.
  12248. }
  12249. break;
  12250. }
  12251. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO,
  12252. read_timeout_sec_, read_timeout_usec_);
  12253. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_SNDTIMEO,
  12254. write_timeout_sec_, write_timeout_usec_);
  12255. if (tcp_nodelay_) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  12256. if (!task_queue->enqueue(
  12257. [this, sock]() { process_and_close_socket(sock); })) {
  12258. output_error_log(Error::ResourceExhaustion, nullptr);
  12259. detail::shutdown_socket(sock);
  12260. detail::close_socket(sock);
  12261. }
  12262. }
  12263. task_queue->shutdown();
  12264. }
  12265. is_decommissioned = !ret;
  12266. return ret;
  12267. }
  12268. inline bool Server::routing(Request &req, Response &res, Stream &strm) {
  12269. if (pre_routing_handler_ &&
  12270. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12271. return true;
  12272. }
  12273. // File handler
  12274. if ((req.method == "GET" || req.method == "HEAD") &&
  12275. handle_file_request(req, res)) {
  12276. return true;
  12277. }
  12278. const auto *custom = find_custom_entry(req.method);
  12279. // The second clause mirrors what expect_content() does unconditionally for
  12280. // POST/PUT/PATCH/DELETE: a content reader route fires even when the request
  12281. // carries no body. Without it a body-less PROPFIND (RFC 4918 treats one as
  12282. // `allprop`) would skip its handler and fall through to 404.
  12283. if (detail::expect_content(req) ||
  12284. (custom && !custom->handlers_for_content_reader.empty())) {
  12285. // Content reader handler
  12286. {
  12287. // Track whether the ContentReader was aborted due to the decompressed
  12288. // payload exceeding `payload_max_length_`.
  12289. // The user handler runs after the lambda returns, so we must restore the
  12290. // 413 status if the handler overwrites it.
  12291. bool content_reader_payload_too_large = false;
  12292. ContentReader reader(
  12293. [&](ContentReceiver receiver) {
  12294. auto result = read_content_with_content_receiver(
  12295. strm, req, res, std::move(receiver), nullptr, nullptr);
  12296. if (!result) {
  12297. output_error_log(Error::Read, &req);
  12298. if (res.status == StatusCode::PayloadTooLarge_413) {
  12299. content_reader_payload_too_large = true;
  12300. }
  12301. }
  12302. return result;
  12303. },
  12304. [&](FormDataHeader header, ContentReceiver receiver) {
  12305. auto result = read_content_with_content_receiver(
  12306. strm, req, res, nullptr, std::move(header),
  12307. std::move(receiver));
  12308. if (!result) {
  12309. output_error_log(Error::Read, &req);
  12310. if (res.status == StatusCode::PayloadTooLarge_413) {
  12311. content_reader_payload_too_large = true;
  12312. }
  12313. }
  12314. return result;
  12315. });
  12316. bool dispatched = false;
  12317. if (req.method == "POST") {
  12318. dispatched = dispatch_request_for_content_reader(
  12319. req, res, std::move(reader), post_handlers_for_content_reader_);
  12320. } else if (req.method == "PUT") {
  12321. dispatched = dispatch_request_for_content_reader(
  12322. req, res, std::move(reader), put_handlers_for_content_reader_);
  12323. } else if (req.method == "PATCH") {
  12324. dispatched = dispatch_request_for_content_reader(
  12325. req, res, std::move(reader), patch_handlers_for_content_reader_);
  12326. } else if (req.method == "DELETE") {
  12327. dispatched = dispatch_request_for_content_reader(
  12328. req, res, std::move(reader), delete_handlers_for_content_reader_);
  12329. } else if (custom) {
  12330. dispatched = dispatch_request_for_content_reader(
  12331. req, res, std::move(reader), custom->handlers_for_content_reader);
  12332. }
  12333. if (dispatched) {
  12334. if (content_reader_payload_too_large) {
  12335. // Enforce the limit: override any status the handler may have set
  12336. // and return false so the error path sends a plain 413 response.
  12337. res.status = StatusCode::PayloadTooLarge_413;
  12338. detail::clear_content(res);
  12339. return false;
  12340. }
  12341. return true;
  12342. }
  12343. }
  12344. // NOTE: `req.body` is not read here. For a regular handler the body is
  12345. // read inside dispatch_request(), after the route has matched and the
  12346. // pre-request handler has approved the request, so that a rejected
  12347. // request (e.g. failed authentication) never forces us to buffer a
  12348. // potentially large body.
  12349. }
  12350. // Regular handler
  12351. if (req.method == "GET" || req.method == "HEAD") {
  12352. return dispatch_request(req, res, get_handlers_, strm);
  12353. } else if (req.method == "POST") {
  12354. return dispatch_request(req, res, post_handlers_, strm);
  12355. } else if (req.method == "PUT") {
  12356. return dispatch_request(req, res, put_handlers_, strm);
  12357. } else if (req.method == "DELETE") {
  12358. return dispatch_request(req, res, delete_handlers_, strm);
  12359. } else if (req.method == "OPTIONS") {
  12360. return dispatch_request(req, res, options_handlers_, strm);
  12361. } else if (req.method == "PATCH") {
  12362. return dispatch_request(req, res, patch_handlers_, strm);
  12363. } else if (custom) {
  12364. return dispatch_request(req, res, custom->handlers, strm);
  12365. }
  12366. res.status = StatusCode::BadRequest_400;
  12367. return false;
  12368. }
  12369. inline bool Server::dispatch_request(Request &req, Response &res,
  12370. const Handlers &handlers, Stream &strm) {
  12371. for (const auto &x : handlers) {
  12372. const auto &matcher = x.first;
  12373. const auto &handler = x.second;
  12374. if (matcher->match(req)) {
  12375. req.matched_route = matcher->pattern();
  12376. // Run the pre-request handler before reading the body so a rejected
  12377. // request (e.g. failed authentication) never forces us to buffer a
  12378. // potentially large body. `req.matched_route` is available here.
  12379. if (pre_request_handler_ &&
  12380. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12381. return true;
  12382. }
  12383. // The route matched and the request was approved; read the body now.
  12384. if (detail::expect_content(req) && !read_content(strm, req, res)) {
  12385. output_error_log(Error::Read, &req);
  12386. return false;
  12387. }
  12388. handler(req, res);
  12389. return true;
  12390. }
  12391. }
  12392. return false;
  12393. }
  12394. // Decides the content coding for a response served straight from a file. Both
  12395. // the ETag, which has to name the representation actually sent, and
  12396. // `apply_static_file_compression()` go through this, so the two cannot drift
  12397. // apart.
  12398. inline detail::EncodingType
  12399. Server::static_file_encoding(const Request &req, const Response &res,
  12400. const std::string &content_type,
  12401. size_t length) const {
  12402. if (!static_file_compression_) { return detail::EncodingType::None; }
  12403. // Nothing to compress, and an empty file already answers with
  12404. // `Content-Length: 0`. Checked on its own so that a zero floor still cannot
  12405. // turn an empty body into a 20-byte gzip stream.
  12406. if (length == 0) { return detail::EncodingType::None; }
  12407. // A file that already fits in a single packet gains nothing from being made
  12408. // smaller, since it still travels in that one segment, and a file of a few
  12409. // bytes comes out larger than it went in.
  12410. if (length < static_file_compression_min_length_) {
  12411. return detail::EncodingType::None;
  12412. }
  12413. // RFC 9110 applies Range to the representation after content coding, so a
  12414. // compressed 206 would mean compressing the whole file and then slicing it.
  12415. // Serve ranges from the identity representation instead.
  12416. if (!req.ranges.empty()) { return detail::EncodingType::None; }
  12417. if (static_file_compression_max_length_ > 0 &&
  12418. length > static_file_compression_max_length_) {
  12419. return detail::EncodingType::None;
  12420. }
  12421. return detail::encoding_type(req, res, content_type);
  12422. }
  12423. // Compresses a file-backed content provider into `res.body`. Returns false when
  12424. // the response is left untouched.
  12425. inline bool Server::apply_static_file_compression(const Request &req,
  12426. Response &res) const {
  12427. auto type = res.content_coding_;
  12428. if (type == detail::EncodingType::None || !res.content_provider_) {
  12429. return false;
  12430. }
  12431. auto compressor = detail::make_compressor(type);
  12432. if (!compressor) { return false; }
  12433. output_pre_compression_log(req, res);
  12434. std::string compressed;
  12435. if (!detail::compress_content_provider(res.content_provider_,
  12436. res.content_length_, *compressor,
  12437. compressed)) {
  12438. return false;
  12439. }
  12440. res.body.swap(compressed);
  12441. // The provider was consumed in full, so its releaser hears about a success.
  12442. res.content_provider_success_ = true;
  12443. detail::clear_content_provider(res);
  12444. res.set_header("Content-Encoding", detail::encoding_name(type));
  12445. res.set_header("Vary", "Accept-Encoding");
  12446. return true;
  12447. }
  12448. inline void Server::apply_ranges(const Request &req, Response &res,
  12449. std::string &content_type,
  12450. std::string &boundary) const {
  12451. // A known-length content provider leaves `res.body` empty, so the compressor
  12452. // at the end of this function never runs for one (issue #2545). A file-backed
  12453. // provider is fully readable right here, so compress it and answer with an
  12454. // ordinary body: `Content-Length` and HEAD keep working, and the response
  12455. // takes the same path as `set_content()` from here on. Range requests never
  12456. // get a content coding, so `Content-Range` still names identity bytes and
  12457. // none of the range handling below applies.
  12458. if (apply_static_file_compression(req, res)) { return; }
  12459. if (req.ranges.size() > 1 && res.status == StatusCode::PartialContent_206) {
  12460. auto it = res.headers.find("Content-Type");
  12461. if (it != res.headers.end()) {
  12462. content_type = it->second;
  12463. res.headers.erase(it);
  12464. }
  12465. boundary = detail::make_multipart_data_boundary();
  12466. res.set_header("Content-Type",
  12467. "multipart/byteranges; boundary=" + boundary);
  12468. }
  12469. auto type = detail::encoding_type(req, res);
  12470. if (res.body.empty()) {
  12471. if (res.content_length_ > 0 && req.ranges.size() == 1 &&
  12472. res.status == StatusCode::PartialContent_206) {
  12473. auto offset_and_length = detail::get_range_offset_and_length(
  12474. req.ranges[0], res.content_length_);
  12475. auto content_range = detail::make_content_range_header_field(
  12476. offset_and_length, res.content_length_);
  12477. res.set_header("Content-Range", content_range);
  12478. } else if (res.is_chunked_content_provider_) {
  12479. res.content_coding_ = type;
  12480. if (type != detail::EncodingType::None) {
  12481. res.set_header("Content-Encoding", detail::encoding_name(type));
  12482. res.set_header("Vary", "Accept-Encoding");
  12483. }
  12484. }
  12485. } else {
  12486. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12487. ;
  12488. } else if (req.ranges.size() == 1) {
  12489. auto offset_and_length =
  12490. detail::get_range_offset_and_length(req.ranges[0], res.body.size());
  12491. auto offset = offset_and_length.first;
  12492. auto length = offset_and_length.second;
  12493. auto content_range = detail::make_content_range_header_field(
  12494. offset_and_length, res.body.size());
  12495. res.set_header("Content-Range", content_range);
  12496. assert(offset + length <= res.body.size());
  12497. res.body = res.body.substr(offset, length);
  12498. } else {
  12499. std::string data;
  12500. detail::make_multipart_ranges_data(req, res, boundary, content_type,
  12501. res.body.size(), data);
  12502. res.body.swap(data);
  12503. }
  12504. if (type != detail::EncodingType::None) {
  12505. output_pre_compression_log(req, res);
  12506. if (auto compressor = detail::make_compressor(type)) {
  12507. std::string compressed;
  12508. if (compressor->compress(res.body.data(), res.body.size(), true,
  12509. [&](const char *data, size_t data_len) {
  12510. compressed.append(data, data_len);
  12511. return true;
  12512. })) {
  12513. res.body.swap(compressed);
  12514. res.set_header("Content-Encoding", detail::encoding_name(type));
  12515. res.set_header("Vary", "Accept-Encoding");
  12516. }
  12517. }
  12518. }
  12519. res.content_length_ = res.body.size();
  12520. }
  12521. }
  12522. inline bool Server::dispatch_request_for_content_reader(
  12523. Request &req, Response &res, ContentReader content_reader,
  12524. const HandlersForContentReader &handlers) const {
  12525. for (const auto &x : handlers) {
  12526. const auto &matcher = x.first;
  12527. const auto &handler = x.second;
  12528. if (matcher->match(req)) {
  12529. req.matched_route = matcher->pattern();
  12530. if (!pre_request_handler_ ||
  12531. pre_request_handler_(req, res) != HandlerResponse::Handled) {
  12532. handler(req, res, content_reader);
  12533. }
  12534. return true;
  12535. }
  12536. }
  12537. return false;
  12538. }
  12539. inline std::string
  12540. get_client_ip(const std::string &x_forwarded_for,
  12541. const std::vector<std::string> &trusted_proxies) {
  12542. // X-Forwarded-For is a comma-separated list per RFC 7239
  12543. std::vector<std::string> ip_list;
  12544. detail::split(x_forwarded_for.data(),
  12545. x_forwarded_for.data() + x_forwarded_for.size(), ',',
  12546. [&](const char *b, const char *e) {
  12547. auto r = detail::trim(b, e, 0, static_cast<size_t>(e - b));
  12548. ip_list.emplace_back(std::string(b + r.first, b + r.second));
  12549. });
  12550. // A malformed X-Forwarded-For (empty, comma-only, whitespace-only) yields
  12551. // no segments. Signal "no client IP derived" with an empty string so the
  12552. // caller can fall back to the connection-level remote address.
  12553. if (ip_list.empty()) { return std::string(); }
  12554. // Each hop appends the address it received the request from, so the rightmost
  12555. // entries are the ones written by our own infrastructure while the leftmost
  12556. // are whatever the original client chose to send. Walk from the right and
  12557. // skip trusted proxies; the first address that is not a trusted proxy is the
  12558. // furthest point still attributable to a real hop, i.e. the client. Scanning
  12559. // from the left instead lets a client forge an arbitrary address by following
  12560. // it with a trusted proxy's address, which the left-to-right scan then
  12561. // returned as the client.
  12562. for (size_t i = ip_list.size(); i-- > 0;) {
  12563. const auto &ip = ip_list[i];
  12564. auto is_trusted_proxy =
  12565. std::any_of(trusted_proxies.begin(), trusted_proxies.end(),
  12566. [&](const std::string &proxy) { return ip == proxy; });
  12567. if (!is_trusted_proxy) { return ip; }
  12568. }
  12569. // Every hop was a trusted proxy; fall back to the first entry.
  12570. return ip_list.front();
  12571. }
  12572. inline bool
  12573. Server::process_request(Stream &strm, const std::string &remote_addr,
  12574. int remote_port, const std::string &local_addr,
  12575. int local_port, bool close_connection,
  12576. bool &connection_closed,
  12577. const std::function<void(Request &)> &setup_request,
  12578. bool *websocket_upgraded) {
  12579. std::array<char, 2048> buf{};
  12580. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12581. // The read timeout bounds the request line and headers as a whole, so a
  12582. // client sending them a byte at a time cannot hold the worker any longer.
  12583. strm.set_max_timeout(read_timeout_sec_ * 1000 + read_timeout_usec_ / 1000);
  12584. // Connection has been closed on client
  12585. if (!line_reader.getline()) { return false; }
  12586. // RFC 9112 2.2: ignore an empty line received before the request-line. Some
  12587. // clients send an extra CRLF after a request body, which would otherwise be
  12588. // parsed as the next request on a persistent connection.
  12589. if (strcmp(line_reader.ptr(), "\r\n") == 0 && !line_reader.getline()) {
  12590. return false;
  12591. }
  12592. Request req;
  12593. req.start_time_ = std::chrono::steady_clock::now();
  12594. req.remote_addr = remote_addr;
  12595. req.remote_port = remote_port;
  12596. req.local_addr = local_addr;
  12597. req.local_port = local_port;
  12598. Response res;
  12599. res.version = "HTTP/1.1";
  12600. res.headers = default_headers_;
  12601. // RFC 9112 §9.6: a server that sends the "close" connection option must
  12602. // close the connection after that response, whichever path wrote it (an
  12603. // error status, a handler, or a rejected request). Reading on would also
  12604. // parse whatever the client sent next on a connection it considers done.
  12605. auto honor_connection_close = detail::scope_exit([&] {
  12606. if (detail::has_header_token(res.headers, "Connection", "close")) {
  12607. connection_closed = true;
  12608. }
  12609. });
  12610. // Request line and headers. A rejected message leaves the rest of it (and
  12611. // any body) unread, so the connection cannot be reused: the leftover bytes
  12612. // would be parsed as the next request.
  12613. if (!parse_request_line(line_reader.ptr(), req)) {
  12614. connection_closed = true;
  12615. res.status = StatusCode::BadRequest_400;
  12616. output_error_log(Error::InvalidRequestLine, &req);
  12617. return write_response(strm, close_connection, req, res);
  12618. }
  12619. // Request headers
  12620. if (!detail::read_headers(strm, req.headers)) {
  12621. connection_closed = true;
  12622. res.status = StatusCode::BadRequest_400;
  12623. output_error_log(Error::InvalidHeaders, &req);
  12624. return write_response(strm, close_connection, req, res);
  12625. }
  12626. strm.set_max_timeout(0);
  12627. // RFC 9112 §6.3: Reject requests whose framing is invalid or ambiguous,
  12628. // which would otherwise let an intermediary and this parser disagree on
  12629. // where the body ends and enable request smuggling. Three cases: a
  12630. // Content-Length that is not a valid decimal length (e.g. "42, 42", "+42"
  12631. // or empty), which would otherwise be read as "no body"; a non-zero
  12632. // Content-Length alongside any Transfer-Encoding (Content-Length: 0 is
  12633. // tolerated for compatibility with existing clients); and a
  12634. // Transfer-Encoding whose final coding is not chunked, which leaves the body
  12635. // length undeterminable. None of them may fall through to the "no body"
  12636. // path, or the body bytes are parsed as the next request on a persistent
  12637. // connection.
  12638. auto is_invalid_content_length = false;
  12639. detail::get_header_value_u64(req.headers, "Content-Length", 0, 0,
  12640. is_invalid_content_length);
  12641. if (is_invalid_content_length ||
  12642. detail::has_conflicting_content_length(req.headers) ||
  12643. (req.has_header("Transfer-Encoding") &&
  12644. !detail::is_chunked_transfer_encoding(req.headers))) {
  12645. connection_closed = true;
  12646. res.status = StatusCode::BadRequest_400;
  12647. return write_response(strm, close_connection, req, res);
  12648. }
  12649. // RFC 9112 §6.1: a Transfer-Encoding alongside a Content-Length, or in an
  12650. // HTTP/1.0 request, is honoured, but the connection closes after the
  12651. // response.
  12652. if (req.has_header("Transfer-Encoding") &&
  12653. (req.has_header("Content-Length") || req.version == "HTTP/1.0")) {
  12654. connection_closed = true;
  12655. }
  12656. // RFC 9112 §3.2: Reject more than one Host field line, an invalid Host
  12657. // value, or none in HTTP/1.1, so that every recipient of the request sees
  12658. // the same authority.
  12659. auto host_count = req.get_header_value_count("Host");
  12660. if (host_count > 1 || (host_count == 0 && req.version == "HTTP/1.1") ||
  12661. !detail::fields::is_host(req.get_header_value("Host"))) {
  12662. connection_closed = true;
  12663. res.status = StatusCode::BadRequest_400;
  12664. output_error_log(Error::InvalidHeaders, &req);
  12665. return write_response(strm, close_connection, req, res);
  12666. }
  12667. // Check if the request URI doesn't exceed the limit
  12668. if (req.target.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  12669. connection_closed = true;
  12670. res.status = StatusCode::UriTooLong_414;
  12671. output_error_log(Error::ExceedUriMaxLength, &req);
  12672. return write_response(strm, close_connection, req, res);
  12673. }
  12674. if (detail::has_header_token(req.headers, "Connection", "close")) {
  12675. connection_closed = true;
  12676. }
  12677. if (req.version == "HTTP/1.0" &&
  12678. !detail::has_header_token(req.headers, "Connection", "keep-alive")) {
  12679. connection_closed = true;
  12680. }
  12681. // Only honor X-Forwarded-For if the peer on the actual TCP connection is
  12682. // itself a trusted proxy. Otherwise any direct client could spoof
  12683. // remote_addr simply by sending an arbitrary X-Forwarded-For header.
  12684. auto is_trusted_peer = std::any_of(
  12685. trusted_proxies_.begin(), trusted_proxies_.end(),
  12686. [&](const std::string &proxy) { return proxy == remote_addr; });
  12687. if (is_trusted_peer && req.has_header("X-Forwarded-For")) {
  12688. // Some proxies append the address they observed as a separate
  12689. // X-Forwarded-For field line instead of extending the one the client sent
  12690. // (e.g. HAProxy's "option forwardfor"), so the whole combined value has to
  12691. // be scanned. Reading only the first occurrence would hand back the
  12692. // client-supplied, and therefore forgeable, value.
  12693. auto x_forwarded_for =
  12694. detail::get_combined_header_value(req.headers, "X-Forwarded-For");
  12695. auto derived = get_client_ip(x_forwarded_for, trusted_proxies_);
  12696. req.remote_addr = derived.empty() ? remote_addr : derived;
  12697. } else {
  12698. req.remote_addr = remote_addr;
  12699. }
  12700. req.remote_port = remote_port;
  12701. req.local_addr = local_addr;
  12702. req.local_port = local_port;
  12703. if (req.has_header("Accept")) {
  12704. auto accept_header =
  12705. detail::get_combined_header_value(req.headers, "Accept");
  12706. if (!detail::parse_accept_header(accept_header, req.accept_content_types)) {
  12707. connection_closed = true;
  12708. res.status = StatusCode::BadRequest_400;
  12709. output_error_log(Error::HTTPParsing, &req);
  12710. return write_response(strm, close_connection, req, res);
  12711. }
  12712. }
  12713. if (req.has_header("Range")) {
  12714. const auto &range_header_value = req.get_header_value("Range");
  12715. if (!detail::parse_range_header(range_header_value, req.ranges)) {
  12716. connection_closed = true;
  12717. res.status = StatusCode::RangeNotSatisfiable_416;
  12718. output_error_log(Error::InvalidRangeHeader, &req);
  12719. return write_response(strm, close_connection, req, res);
  12720. }
  12721. }
  12722. if (setup_request) { setup_request(req); }
  12723. // RFC 9110 10.1.1: Expect is a comma-separated list whose value is
  12724. // case-insensitive, and a 100-continue expectation in an HTTP/1.0 request
  12725. // must be ignored. An expectation we do not recognize is left alone; the
  12726. // 417 the section allows for one is a MAY, not a requirement.
  12727. //
  12728. // `100 Continue` itself is deferred until the body is actually read (see
  12729. // read_content_core), so a request rejected by a later handler never
  12730. // invites the client to send a body nobody will read.
  12731. if (req.version != "HTTP/1.0" &&
  12732. detail::has_header_token(req.headers, "Expect", "100-continue")) {
  12733. int status = StatusCode::Continue_100;
  12734. if (expect_100_continue_handler_) {
  12735. status = expect_100_continue_handler_(req, res);
  12736. }
  12737. if (status == StatusCode::Continue_100) {
  12738. req.expect_100_continue_pending_ = true;
  12739. } else {
  12740. if (res.status == -1) { res.status = status; }
  12741. connection_closed = true;
  12742. return write_response(strm, true, req, res);
  12743. }
  12744. }
  12745. // Setup `is_connection_closed` method
  12746. auto sock = strm.socket();
  12747. req.is_connection_closed = [sock]() {
  12748. return !detail::is_socket_alive(sock);
  12749. };
  12750. // WebSocket upgrade
  12751. // Run pre_routing_handler_ and pre_request_handler_ before upgrading so
  12752. // that authentication and other middleware can reject the request with an
  12753. // HTTP response (e.g., 401) before the protocol switches.
  12754. // The response says so when this connection closes after it.
  12755. auto close_after_response = close_connection || connection_closed;
  12756. if (detail::is_websocket_upgrade(req)) {
  12757. if (pre_routing_handler_ &&
  12758. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12759. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12760. return write_response_with_content(strm, close_after_response, req, res);
  12761. }
  12762. // Find matching WebSocket handler
  12763. for (const auto &entry : websocket_handlers_) {
  12764. if (entry.matcher->match(req)) {
  12765. req.matched_route = entry.matcher->pattern();
  12766. if (pre_request_handler_ &&
  12767. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12768. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12769. return write_response_with_content(strm, close_after_response, req,
  12770. res);
  12771. }
  12772. // Compute accept key
  12773. auto client_key = req.get_header_value("Sec-WebSocket-Key");
  12774. auto accept_key = detail::websocket_accept_key(client_key);
  12775. // Negotiate subprotocol
  12776. std::string selected_subprotocol;
  12777. if (entry.sub_protocol_selector) {
  12778. auto protocol_header = detail::get_combined_header_value(
  12779. req.headers, "Sec-WebSocket-Protocol");
  12780. if (!protocol_header.empty()) {
  12781. std::vector<std::string> protocols;
  12782. detail::split(protocol_header.data(),
  12783. protocol_header.data() + protocol_header.size(), ',',
  12784. [&](const char *b, const char *e) {
  12785. protocols.emplace_back(b, e);
  12786. });
  12787. selected_subprotocol = entry.sub_protocol_selector(protocols);
  12788. // Ignore a selection the client did not offer (RFC 6455 4.2.2)
  12789. if (std::find(protocols.begin(), protocols.end(),
  12790. selected_subprotocol) == protocols.end()) {
  12791. selected_subprotocol.clear();
  12792. }
  12793. }
  12794. }
  12795. // Send 101 Switching Protocols
  12796. std::string handshake_response = "HTTP/1.1 101 Switching Protocols\r\n"
  12797. "Upgrade: websocket\r\n"
  12798. "Connection: Upgrade\r\n"
  12799. "Sec-WebSocket-Accept: " +
  12800. accept_key + "\r\n";
  12801. if (!selected_subprotocol.empty()) {
  12802. if (!detail::fields::is_field_value(selected_subprotocol)) {
  12803. return false;
  12804. }
  12805. handshake_response +=
  12806. "Sec-WebSocket-Protocol: " + selected_subprotocol + "\r\n";
  12807. }
  12808. handshake_response += "\r\n";
  12809. if (strm.write(handshake_response.data(), handshake_response.size()) <
  12810. 0) {
  12811. return false;
  12812. }
  12813. connection_closed = true;
  12814. if (websocket_upgraded) { *websocket_upgraded = true; }
  12815. {
  12816. #ifdef CPPHTTPLIB_SSL_ENABLED
  12817. if (req.ssl) {
  12818. // wss: the heartbeat ping thread and the read path enter the same
  12819. // TLS session from different threads. Hand the WebSocket a stream
  12820. // that serializes every TLS call, so the shared SSLSocketStream on
  12821. // the plain HTTP/HTTPS paths stays untouched.
  12822. auto ws_strm =
  12823. std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  12824. strm.socket(), const_cast<tls::session_t>(req.ssl),
  12825. CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0,
  12826. write_timeout_sec_, write_timeout_usec_));
  12827. ws::WebSocket ws(std::move(ws_strm), req, true,
  12828. websocket_ping_interval_sec_,
  12829. websocket_max_missed_pongs_);
  12830. entry.handler(req, ws);
  12831. return true;
  12832. }
  12833. #endif
  12834. // Use WebSocket-specific read timeout instead of HTTP timeout
  12835. strm.set_read_timeout(CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND,
  12836. 0);
  12837. ws::WebSocket ws(strm, req, true, websocket_ping_interval_sec_,
  12838. websocket_max_missed_pongs_);
  12839. entry.handler(req, ws);
  12840. }
  12841. return true;
  12842. }
  12843. }
  12844. // No matching handler - fall through to 404
  12845. }
  12846. // Routing
  12847. auto routed = false;
  12848. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  12849. routed = routing(req, res, strm);
  12850. #else
  12851. try {
  12852. routed = routing(req, res, strm);
  12853. } catch (std::exception &) {
  12854. if (exception_handler_) {
  12855. auto ep = std::current_exception();
  12856. exception_handler_(req, res, ep);
  12857. routed = true;
  12858. } else {
  12859. res.status = StatusCode::InternalServerError_500;
  12860. }
  12861. } catch (...) {
  12862. if (exception_handler_) {
  12863. auto ep = std::current_exception();
  12864. exception_handler_(req, res, ep);
  12865. routed = true;
  12866. } else {
  12867. res.status = StatusCode::InternalServerError_500;
  12868. }
  12869. }
  12870. #endif
  12871. auto ret = false;
  12872. if (routed) {
  12873. if (res.status == -1) {
  12874. res.status = req.ranges.empty() ? StatusCode::OK_200
  12875. : StatusCode::PartialContent_206;
  12876. }
  12877. // Before the Range checks below, so they see the body's own length.
  12878. detail::prefer_assigned_body(res);
  12879. // Serve file content by using a content provider
  12880. auto file_open_error = false;
  12881. if (!res.file_content_path_.empty()) {
  12882. const auto &path = res.file_content_path_;
  12883. auto mm = std::make_shared<detail::mmap>(path.c_str());
  12884. if (!mm->is_open()) {
  12885. res.status = StatusCode::NotFound_404;
  12886. output_error_log(Error::OpenFile, &req);
  12887. file_open_error = true;
  12888. } else {
  12889. auto content_type = res.file_content_content_type_;
  12890. if (content_type.empty()) {
  12891. content_type = detail::find_content_type(
  12892. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  12893. }
  12894. detail::set_file_content_provider(
  12895. res, mm, content_type,
  12896. static_file_encoding(req, res, content_type, mm->size()));
  12897. }
  12898. }
  12899. if (file_open_error) {
  12900. ret = write_response(strm, close_after_response, req, res);
  12901. } else if (detail::range_error(req, res)) {
  12902. detail::clear_content(res);
  12903. res.status = StatusCode::RangeNotSatisfiable_416;
  12904. ret = write_response(strm, close_after_response, req, res);
  12905. } else {
  12906. ret = write_response_with_content(strm, close_after_response, req, res);
  12907. }
  12908. } else {
  12909. if (res.status == -1) { res.status = StatusCode::NotFound_404; }
  12910. ret = write_response(strm, close_after_response, req, res);
  12911. }
  12912. // Drain any unconsumed framed body to prevent request smuggling on
  12913. // keep-alive. Without framing there is no body to drain — reading would
  12914. // consume the next request (issue #2450). If the response has committed the
  12915. // connection to close, there is no next request to protect. A body read in
  12916. // part cannot be drained from where it stopped, so the connection closes.
  12917. if (!req.body_consumed_ && detail::has_framed_body(req) &&
  12918. !detail::has_header_token(res.headers, "Connection", "close")) {
  12919. int dummy_status;
  12920. if (req.body_read_started_ ||
  12921. !detail::read_content(
  12922. strm, req, payload_max_length_, dummy_status, nullptr,
  12923. [](const char *, size_t, size_t, size_t) { return true; }, false)) {
  12924. connection_closed = true;
  12925. }
  12926. }
  12927. return ret;
  12928. }
  12929. inline bool Server::is_valid() const { return !has_invalid_registration_; }
  12930. inline bool Server::process_and_close_socket(socket_t sock) {
  12931. std::string remote_addr;
  12932. int remote_port = 0;
  12933. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  12934. std::string local_addr;
  12935. int local_port = 0;
  12936. detail::get_local_ip_and_port(sock, local_addr, local_port);
  12937. bool websocket_upgraded = false;
  12938. auto ret = serve_guarded([&]() {
  12939. return detail::process_server_socket(
  12940. svr_sock_, sock, keep_alive_max_count_, keep_alive_timeout_sec_,
  12941. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12942. write_timeout_usec_,
  12943. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  12944. return process_request(strm, remote_addr, remote_port, local_addr,
  12945. local_port, close_connection,
  12946. connection_closed, nullptr,
  12947. &websocket_upgraded);
  12948. });
  12949. });
  12950. detail::drain_and_close_socket(sock);
  12951. return ret;
  12952. }
  12953. inline void Server::output_log(const Request &req, const Response &res) const {
  12954. if (logger_) {
  12955. std::lock_guard<std::mutex> guard(logger_mutex_);
  12956. logger_(req, res);
  12957. }
  12958. }
  12959. inline void Server::output_pre_compression_log(const Request &req,
  12960. const Response &res) const {
  12961. if (pre_compression_logger_) {
  12962. std::lock_guard<std::mutex> guard(logger_mutex_);
  12963. pre_compression_logger_(req, res);
  12964. }
  12965. }
  12966. inline void Server::output_error_log(const Error &err,
  12967. const Request *req) const {
  12968. if (error_logger_) {
  12969. std::lock_guard<std::mutex> guard(logger_mutex_);
  12970. error_logger_(err, req);
  12971. }
  12972. }
  12973. /*
  12974. * Group 5: ClientImpl and Client (Universal) implementation
  12975. */
  12976. // HTTP client implementation
  12977. inline ClientImpl::ClientImpl(const std::string &host)
  12978. : ClientImpl(host, 80, std::string(), std::string()) {}
  12979. inline ClientImpl::ClientImpl(const std::string &host, int port)
  12980. : ClientImpl(host, port, std::string(), std::string()) {}
  12981. inline ClientImpl::ClientImpl(const std::string &host, int port,
  12982. const std::string &client_cert_path,
  12983. const std::string &client_key_path)
  12984. : host_(detail::escape_abstract_namespace_unix_domain(host)), port_(port),
  12985. client_cert_path_(client_cert_path), client_key_path_(client_key_path) {}
  12986. inline ClientImpl::~ClientImpl() {
  12987. // Wait until all the requests in flight are handled.
  12988. size_t retry_count = 10;
  12989. while (retry_count-- > 0) {
  12990. {
  12991. std::lock_guard<std::mutex> guard(socket_mutex_);
  12992. if (socket_requests_in_flight_ == 0) { break; }
  12993. }
  12994. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  12995. }
  12996. std::lock_guard<std::mutex> guard(socket_mutex_);
  12997. shutdown_socket(socket_);
  12998. close_socket(socket_);
  12999. }
  13000. inline bool ClientImpl::is_valid() const { return true; }
  13001. inline bool
  13002. ClientImpl::is_proxy_enabled_for_host(const std::string &host) const {
  13003. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  13004. if (no_proxy_entries_.empty()) { return true; }
  13005. // host_ is const so its normalized form is invariant; cache it. The
  13006. // cross-host path (setup_redirect_client passing next_host) re-normalizes.
  13007. if (host == host_) {
  13008. if (!host_normalized_valid_) {
  13009. host_normalized_ = detail::normalize_target(host_);
  13010. host_normalized_valid_ = true;
  13011. }
  13012. return !detail::host_matches_no_proxy(host_normalized_, no_proxy_entries_);
  13013. }
  13014. auto target = detail::normalize_target(host);
  13015. return !detail::host_matches_no_proxy(target, no_proxy_entries_);
  13016. }
  13017. inline socket_t ClientImpl::create_client_socket(Error &error) const {
  13018. if (is_proxy_enabled_for_host(host_)) {
  13019. return detail::create_client_socket(
  13020. proxy_host_, std::string(), proxy_port_, address_family_, tcp_nodelay_,
  13021. ipv6_v6only_, socket_options_, connection_timeout_sec_,
  13022. connection_timeout_usec_, read_timeout_sec_, read_timeout_usec_,
  13023. write_timeout_sec_, write_timeout_usec_, interface_, error);
  13024. }
  13025. // Check is custom IP or hostname specified for host_
  13026. std::string connect_host;
  13027. std::string ip;
  13028. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  13029. return detail::create_client_socket(
  13030. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  13031. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  13032. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13033. write_timeout_usec_, interface_, error);
  13034. }
  13035. inline bool ClientImpl::create_and_connect_socket(Socket &socket,
  13036. Error &error) {
  13037. auto sock = create_client_socket(error);
  13038. if (sock == INVALID_SOCKET) { return false; }
  13039. socket.sock = sock;
  13040. return true;
  13041. }
  13042. inline bool ClientImpl::ensure_socket_connection(Socket &socket, Error &error) {
  13043. return create_and_connect_socket(socket, error);
  13044. }
  13045. inline bool ClientImpl::setup_proxy_connection(
  13046. Socket & /*socket*/,
  13047. std::chrono::time_point<std::chrono::steady_clock> /*start_time*/,
  13048. Response & /*res*/, bool & /*success*/, Error & /*error*/) {
  13049. return true;
  13050. }
  13051. inline void ClientImpl::shutdown_ssl(Socket & /*socket*/,
  13052. bool /*shutdown_gracefully*/) {
  13053. // If there are any requests in flight from threads other than us, then it's
  13054. // a thread-unsafe race because individual ssl* objects are not thread-safe.
  13055. assert(socket_requests_in_flight_ == 0 ||
  13056. socket_requests_are_from_thread_ == std::this_thread::get_id());
  13057. }
  13058. inline void ClientImpl::shutdown_socket(Socket &socket) const {
  13059. if (socket.sock == INVALID_SOCKET) { return; }
  13060. detail::shutdown_socket(socket.sock);
  13061. }
  13062. inline void ClientImpl::close_socket(Socket &socket) {
  13063. // If there are requests in flight in another thread, usually closing
  13064. // the socket will be fine and they will simply receive an error when
  13065. // using the closed socket, but it is still a bug since rarely the OS
  13066. // may reassign the socket id to be used for a new socket, and then
  13067. // suddenly they will be operating on a live socket that is different
  13068. // than the one they intended!
  13069. assert(socket_requests_in_flight_ == 0 ||
  13070. socket_requests_are_from_thread_ == std::this_thread::get_id());
  13071. // It is also a bug if this happens while SSL is still active
  13072. #ifdef CPPHTTPLIB_SSL_ENABLED
  13073. assert(socket.ssl == nullptr);
  13074. #endif
  13075. if (socket.sock == INVALID_SOCKET) { return; }
  13076. detail::close_socket(socket.sock);
  13077. socket.sock = INVALID_SOCKET;
  13078. }
  13079. inline void ClientImpl::disconnect(bool gracefully) {
  13080. shutdown_ssl(socket_, gracefully);
  13081. shutdown_socket(socket_);
  13082. close_socket(socket_);
  13083. }
  13084. inline bool ClientImpl::read_response_line(Stream &strm, const Request &req,
  13085. Response &res,
  13086. bool skip_100_continue) const {
  13087. std::array<char, 2048> buf{};
  13088. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  13089. if (!line_reader.getline()) { return false; }
  13090. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  13091. res.reason)) {
  13092. return req.method == "CONNECT";
  13093. }
  13094. // Skip interim (1xx) responses along with their header fields, except a 100
  13095. // Continue the caller handles itself for Expect: 100-continue. 101 ends
  13096. // HTTP on the connection, so it is final.
  13097. while (100 <= res.status && res.status < 200 &&
  13098. res.status != StatusCode::SwitchingProtocol_101 &&
  13099. (skip_100_continue || res.status != StatusCode::Continue_100)) {
  13100. Headers interim_headers;
  13101. if (!detail::read_headers(strm, interim_headers)) { return false; }
  13102. if (!line_reader.getline()) { return false; } // next response line
  13103. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  13104. res.reason)) {
  13105. return false;
  13106. }
  13107. }
  13108. return true;
  13109. }
  13110. inline bool ClientImpl::send(Request &req, Response &res, Error &error) {
  13111. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  13112. auto ret = send_(req, res, error);
  13113. if (error == Error::SSLPeerCouldBeClosed_) {
  13114. assert(!ret);
  13115. ret = send_(req, res, error);
  13116. // If still failing with SSLPeerCouldBeClosed_, convert to Read error
  13117. if (error == Error::SSLPeerCouldBeClosed_) { error = Error::Read; }
  13118. }
  13119. return ret;
  13120. }
  13121. inline bool ClientImpl::send_(Request &req, Response &res, Error &error) {
  13122. {
  13123. std::lock_guard<std::mutex> guard(socket_mutex_);
  13124. // Set this to false immediately - if it ever gets set to true by the end
  13125. // of the request, we know another thread instructed us to close the
  13126. // socket.
  13127. socket_should_be_closed_when_request_is_done_ = false;
  13128. auto is_alive = false;
  13129. if (socket_.is_open()) {
  13130. is_alive = detail::is_socket_alive(socket_.sock);
  13131. #ifdef CPPHTTPLIB_SSL_ENABLED
  13132. if (is_alive && is_ssl()) {
  13133. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13134. is_alive = false;
  13135. }
  13136. }
  13137. #endif
  13138. if (!is_alive) {
  13139. // Peer seems gone — non-graceful shutdown to avoid SIGPIPE.
  13140. disconnect(/*gracefully=*/false);
  13141. }
  13142. }
  13143. if (!is_alive) {
  13144. if (!ensure_socket_connection(socket_, error)) {
  13145. output_error_log(error, &req);
  13146. return false;
  13147. }
  13148. {
  13149. auto success = true;
  13150. if (!setup_proxy_connection(socket_, req.start_time_, res, success,
  13151. error)) {
  13152. if (!success) { output_error_log(error, &req); }
  13153. return success;
  13154. }
  13155. }
  13156. }
  13157. // Mark the current socket as being in use so that it cannot be closed by
  13158. // anyone else while this request is ongoing, even though we will be
  13159. // releasing the mutex.
  13160. if (socket_requests_in_flight_ > 1) {
  13161. assert(socket_requests_are_from_thread_ == std::this_thread::get_id());
  13162. }
  13163. socket_requests_in_flight_ += 1;
  13164. socket_requests_are_from_thread_ = std::this_thread::get_id();
  13165. }
  13166. for (const auto &header : default_headers_) {
  13167. if (req.headers.find(header.first) == req.headers.end()) {
  13168. req.headers.insert(header);
  13169. }
  13170. }
  13171. auto ret = false;
  13172. auto close_connection = !keep_alive_;
  13173. auto se = detail::scope_exit([&]() {
  13174. // Briefly lock mutex in order to mark that a request is no longer ongoing
  13175. std::lock_guard<std::mutex> guard(socket_mutex_);
  13176. socket_requests_in_flight_ -= 1;
  13177. if (socket_requests_in_flight_ <= 0) {
  13178. assert(socket_requests_in_flight_ == 0);
  13179. socket_requests_are_from_thread_ = std::thread::id();
  13180. }
  13181. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  13182. !ret) {
  13183. disconnect(/*gracefully=*/true);
  13184. }
  13185. });
  13186. ret = process_socket(socket_, req.start_time_, [&](Stream &strm) {
  13187. return handle_request(strm, req, res, close_connection, error);
  13188. });
  13189. if (!ret) {
  13190. if (error == Error::Success) {
  13191. error = Error::Unknown;
  13192. output_error_log(error, &req);
  13193. }
  13194. }
  13195. return ret;
  13196. }
  13197. inline Result ClientImpl::send(const Request &req) {
  13198. auto req2 = req;
  13199. return send_(std::move(req2));
  13200. }
  13201. inline Result ClientImpl::send_(Request &&req) {
  13202. auto res = detail::make_unique<Response>();
  13203. auto error = Error::Success;
  13204. auto ret = send(req, *res, error);
  13205. #ifdef CPPHTTPLIB_SSL_ENABLED
  13206. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers),
  13207. last_ssl_error_, last_backend_error_};
  13208. #else
  13209. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers)};
  13210. #endif
  13211. }
  13212. inline void ClientImpl::prepare_default_headers(Request &r, bool for_stream,
  13213. const std::string &ct) {
  13214. (void)for_stream;
  13215. // Default headers are meant for the origin and may carry its credentials, so
  13216. // keep them off the CONNECT request the proxy reads.
  13217. if (r.method != "CONNECT") {
  13218. for (const auto &header : default_headers_) {
  13219. if (!r.has_header(header.first)) { r.headers.insert(header); }
  13220. }
  13221. }
  13222. // RFC 9110 5.3 recommends sending control data such as Host first, so
  13223. // prepend it rather than appending it after the caller's own fields.
  13224. if (!r.has_header("Host")) {
  13225. r.headers.emplace_front(
  13226. "Host", detail::make_default_host_header_value(host_, port_, is_ssl(),
  13227. address_family_));
  13228. }
  13229. if (!r.has_header("Accept")) { r.headers.emplace("Accept", "*/*"); }
  13230. if (!r.content_receiver) {
  13231. if (!r.has_header("Accept-Encoding")) {
  13232. std::string accept_encoding;
  13233. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  13234. accept_encoding = "br";
  13235. #endif
  13236. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  13237. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13238. accept_encoding += "gzip, deflate";
  13239. #endif
  13240. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  13241. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13242. accept_encoding += "zstd";
  13243. #endif
  13244. r.set_header("Accept-Encoding", accept_encoding);
  13245. }
  13246. detail::add_default_user_agent_header(r);
  13247. }
  13248. if (!r.body.empty()) {
  13249. if (!ct.empty() && !r.has_header("Content-Type")) {
  13250. r.headers.emplace("Content-Type", ct);
  13251. }
  13252. if (!r.has_header("Content-Length")) {
  13253. r.headers.emplace("Content-Length", std::to_string(r.body.size()));
  13254. }
  13255. }
  13256. }
  13257. inline ClientImpl::StreamHandle
  13258. ClientImpl::open_stream(const std::string &method, const std::string &path,
  13259. const Params &params, const Headers &headers,
  13260. const std::string &body,
  13261. const std::string &content_type) {
  13262. StreamHandle handle;
  13263. handle.response = detail::make_unique<Response>();
  13264. handle.error = Error::Success;
  13265. // Encode the target exactly like the buffered send path does, so that the
  13266. // same `path` produces the same request line through either API.
  13267. auto raw_query_path =
  13268. params.empty() ? path : append_query_params(path, params);
  13269. auto query_path = detail::encode_request_target(raw_query_path, path_encode_);
  13270. handle.connection_ = detail::make_unique<ClientConnection>();
  13271. {
  13272. std::lock_guard<std::mutex> guard(socket_mutex_);
  13273. auto is_alive = false;
  13274. if (socket_.is_open()) {
  13275. is_alive = detail::is_socket_alive(socket_.sock);
  13276. #ifdef CPPHTTPLIB_SSL_ENABLED
  13277. if (is_alive && is_ssl()) {
  13278. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13279. is_alive = false;
  13280. }
  13281. }
  13282. #endif
  13283. if (!is_alive) { disconnect(/*gracefully=*/false); }
  13284. }
  13285. if (!is_alive) {
  13286. if (!ensure_socket_connection(socket_, handle.error)) {
  13287. handle.response.reset();
  13288. return handle;
  13289. }
  13290. {
  13291. auto success = true;
  13292. auto start_time = std::chrono::steady_clock::now();
  13293. if (!setup_proxy_connection(socket_, start_time, *handle.response,
  13294. success, handle.error)) {
  13295. if (!success) { handle.response.reset(); }
  13296. return handle;
  13297. }
  13298. }
  13299. }
  13300. transfer_socket_ownership_to_handle(handle);
  13301. }
  13302. #ifdef CPPHTTPLIB_SSL_ENABLED
  13303. if (is_ssl() && handle.connection_->session) {
  13304. handle.socket_stream_ = detail::make_unique<detail::SSLSocketStream>(
  13305. handle.connection_->sock, handle.connection_->session,
  13306. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13307. write_timeout_usec_);
  13308. } else {
  13309. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13310. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13311. write_timeout_sec_, write_timeout_usec_);
  13312. }
  13313. #else
  13314. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13315. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13316. write_timeout_sec_, write_timeout_usec_);
  13317. #endif
  13318. handle.stream_ = handle.socket_stream_.get();
  13319. Request req;
  13320. req.method = method;
  13321. req.path = query_path;
  13322. req.headers = headers;
  13323. req.body = body;
  13324. prepare_default_headers(req, true, content_type);
  13325. auto &strm = *handle.stream_;
  13326. // Build the request line and headers in memory first, like write_request()
  13327. // does, so that a rejected header leaves nothing on the wire.
  13328. {
  13329. detail::BufferStream bstrm;
  13330. if (detail::write_request_line(bstrm, req.method, req.path) < 0) {
  13331. handle.error = Error::Write;
  13332. handle.response.reset();
  13333. return handle;
  13334. }
  13335. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13336. handle.error)) {
  13337. handle.response.reset();
  13338. return handle;
  13339. }
  13340. const auto &data = bstrm.get_buffer();
  13341. if (!detail::write_data(strm, data.data(), data.size())) {
  13342. handle.error = Error::Write;
  13343. handle.response.reset();
  13344. return handle;
  13345. }
  13346. }
  13347. if (!body.empty()) {
  13348. if (strm.write(body.data(), body.size()) < 0) {
  13349. handle.error = Error::Write;
  13350. handle.response.reset();
  13351. return handle;
  13352. }
  13353. }
  13354. if (!read_response_line(strm, req, *handle.response) ||
  13355. !detail::read_headers(strm, handle.response->headers)) {
  13356. handle.error = Error::Read;
  13357. handle.response.reset();
  13358. return handle;
  13359. }
  13360. // Same framing check as ClientImpl::process_request(). A HEAD or bodyless
  13361. // (204/304) response legitimately carries framing headers with no body.
  13362. if (method != "HEAD" &&
  13363. handle.response->status != StatusCode::NoContent_204 &&
  13364. handle.response->status != StatusCode::NotModified_304 &&
  13365. detail::has_conflicting_content_length(handle.response->headers)) {
  13366. handle.error = Error::Read;
  13367. handle.response.reset();
  13368. return handle;
  13369. }
  13370. handle.body_reader_.stream = handle.stream_;
  13371. handle.body_reader_.payload_max_length = payload_max_length_;
  13372. if (handle.response->has_header("Content-Length")) {
  13373. bool is_invalid = false;
  13374. auto content_length = detail::get_header_value_u64(
  13375. handle.response->headers, "Content-Length", 0, 0, is_invalid);
  13376. if (is_invalid) {
  13377. handle.error = Error::Read;
  13378. handle.response.reset();
  13379. return handle;
  13380. }
  13381. handle.body_reader_.has_content_length = true;
  13382. handle.body_reader_.content_length = content_length;
  13383. }
  13384. handle.body_reader_.chunked =
  13385. detail::is_chunked_transfer_encoding(handle.response->headers);
  13386. auto content_encoding = detail::get_combined_header_value(
  13387. handle.response->headers, "Content-Encoding");
  13388. if (!content_encoding.empty()) {
  13389. // Same policy as prepare_content_receiver(): reject a coding we know about
  13390. // but were not built with, pass an unrecognized one through as-is.
  13391. handle.decompressor_ = detail::create_decompressor(content_encoding);
  13392. if (!handle.decompressor_) {
  13393. if (detail::is_known_content_encoding(content_encoding)) {
  13394. handle.error = Error::UnsupportedContentEncoding;
  13395. handle.response.reset();
  13396. return handle;
  13397. }
  13398. } else if (!handle.decompressor_->is_valid()) {
  13399. handle.error = Error::Compression;
  13400. handle.response.reset();
  13401. return handle;
  13402. }
  13403. }
  13404. return handle;
  13405. }
  13406. inline ssize_t ClientImpl::StreamHandle::read(char *buf, size_t len) {
  13407. if (!is_valid() || !response) { return -1; }
  13408. if (decompressor_) { return read_with_decompression(buf, len); }
  13409. auto n = detail::read_body_content(stream_, body_reader_, buf, len);
  13410. if (n <= 0 && body_reader_.chunked && !trailers_parsed_ && stream_) {
  13411. trailers_parsed_ = true;
  13412. if (body_reader_.chunked_decoder) {
  13413. if (!body_reader_.chunked_decoder->parse_trailers_into(
  13414. response->trailers, response->headers)) {
  13415. return n;
  13416. }
  13417. } else {
  13418. detail::ChunkedDecoder dec(*stream_);
  13419. if (!dec.parse_trailers_into(response->trailers, response->headers)) {
  13420. return n;
  13421. }
  13422. }
  13423. }
  13424. return n;
  13425. }
  13426. inline ssize_t ClientImpl::StreamHandle::read_with_decompression(char *buf,
  13427. size_t len) {
  13428. if (decompress_offset_ < decompress_buffer_.size()) {
  13429. auto available = decompress_buffer_.size() - decompress_offset_;
  13430. auto to_copy = (std::min)(len, available);
  13431. std::memcpy(buf, decompress_buffer_.data() + decompress_offset_, to_copy);
  13432. decompress_offset_ += to_copy;
  13433. decompressed_bytes_read_ += to_copy;
  13434. return static_cast<ssize_t>(to_copy);
  13435. }
  13436. decompress_buffer_.clear();
  13437. decompress_offset_ = 0;
  13438. constexpr size_t kDecompressionBufferSize = 8192;
  13439. char compressed_buf[kDecompressionBufferSize];
  13440. while (true) {
  13441. auto n = detail::read_body_content(stream_, body_reader_, compressed_buf,
  13442. sizeof(compressed_buf));
  13443. if (n <= 0) { return n; }
  13444. auto exceeded = false;
  13445. bool decompress_ok = decompressor_->decompress(
  13446. compressed_buf, static_cast<size_t>(n),
  13447. [&](const char *data, size_t data_len) {
  13448. decompress_buffer_.append(data, data_len);
  13449. auto limit = body_reader_.payload_max_length;
  13450. exceeded =
  13451. limit > 0 &&
  13452. decompressed_bytes_read_ + decompress_buffer_.size() > limit;
  13453. return !exceeded;
  13454. });
  13455. if (!decompress_ok) {
  13456. body_reader_.last_error =
  13457. exceeded ? Error::ExceedMaxPayloadSize : Error::Read;
  13458. return -1;
  13459. }
  13460. if (!decompress_buffer_.empty()) { break; }
  13461. }
  13462. auto to_copy = (std::min)(len, decompress_buffer_.size());
  13463. std::memcpy(buf, decompress_buffer_.data(), to_copy);
  13464. decompress_offset_ = to_copy;
  13465. decompressed_bytes_read_ += to_copy;
  13466. return static_cast<ssize_t>(to_copy);
  13467. }
  13468. inline void ClientImpl::StreamHandle::parse_trailers_if_needed() {
  13469. if (!response || !stream_ || !body_reader_.chunked || trailers_parsed_) {
  13470. return;
  13471. }
  13472. trailers_parsed_ = true;
  13473. const auto bufsiz = 128;
  13474. char line_buf[bufsiz];
  13475. detail::stream_line_reader line_reader(*stream_, line_buf, bufsiz);
  13476. if (!line_reader.getline()) { return; }
  13477. if (!detail::parse_trailers(line_reader, response->trailers,
  13478. response->headers)) {
  13479. return;
  13480. }
  13481. }
  13482. namespace detail {
  13483. inline ChunkedDecoder::ChunkedDecoder(Stream &s) : strm(s) {}
  13484. inline ssize_t ChunkedDecoder::read_payload(char *buf, size_t len,
  13485. size_t &out_chunk_offset,
  13486. size_t &out_chunk_total) {
  13487. if (finished) { return 0; }
  13488. if (chunk_remaining == 0) {
  13489. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13490. if (!lr.getline()) { return -1; }
  13491. // Everything below is bounded by eol rather than by the buffer's NUL, so
  13492. // the line terminator is never mistaken for line content.
  13493. const char *eol = lr.ptr() + lr.size();
  13494. if (lr.end_with_crlf()) {
  13495. eol -= 2;
  13496. } else if (eol != lr.ptr() && eol[-1] == '\n') {
  13497. // Only reachable under CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR, where
  13498. // getline() ends the line on a bare LF. That LF is the terminator, so it
  13499. // has to come off here or the check below would reject the line.
  13500. eol -= 1;
  13501. }
  13502. // RFC 9112 §7.1: chunk-size = 1*HEXDIG
  13503. const char *p = lr.ptr();
  13504. int v = 0;
  13505. if (p == eol || !is_hex(*p, v)) { return -1; }
  13506. size_t chunk_len = 0;
  13507. constexpr size_t chunk_len_max = (std::numeric_limits<size_t>::max)();
  13508. for (; p < eol && is_hex(*p, v); ++p) {
  13509. if (chunk_len > (chunk_len_max >> 4)) { return -1; }
  13510. chunk_len = (chunk_len << 4) | static_cast<size_t>(v);
  13511. }
  13512. while (p < eol && is_space_or_tab(*p)) {
  13513. ++p;
  13514. }
  13515. // RFC 9112 §7.1.1: only a chunk-ext may sit between the size and the line
  13516. // terminator, and it is built from tokens and quoted-strings, so it never
  13517. // holds a CR, LF or any other control character. getline() reads up to the
  13518. // CRLF, so a bare LF left in here would be swallowed as extension text
  13519. // while an intermediary that ends the line on it delimits the chunks
  13520. // differently, and the two disagree on where the body ends (request
  13521. // smuggling).
  13522. if (p < eol && *p != ';') { return -1; }
  13523. for (; p < eol; ++p) {
  13524. if (!is_space_or_tab(*p) && !fields::is_field_vchar(*p)) { return -1; }
  13525. }
  13526. if (chunk_len == 0) {
  13527. chunk_remaining = 0;
  13528. finished = true;
  13529. out_chunk_offset = 0;
  13530. out_chunk_total = 0;
  13531. return 0;
  13532. }
  13533. chunk_remaining = chunk_len;
  13534. last_chunk_total = chunk_remaining;
  13535. last_chunk_offset = 0;
  13536. }
  13537. auto to_read = (std::min)(chunk_remaining, len);
  13538. auto n = strm.read(buf, to_read);
  13539. if (n <= 0) { return -1; }
  13540. auto offset_before = last_chunk_offset;
  13541. last_chunk_offset += static_cast<size_t>(n);
  13542. chunk_remaining -= static_cast<size_t>(n);
  13543. out_chunk_offset = offset_before;
  13544. out_chunk_total = last_chunk_total;
  13545. if (chunk_remaining == 0) {
  13546. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13547. if (!lr.getline()) { return -1; }
  13548. if (std::strcmp(lr.ptr(), "\r\n") != 0) { return -1; }
  13549. }
  13550. return n;
  13551. }
  13552. inline bool ChunkedDecoder::parse_trailers_into(Headers &dest,
  13553. const Headers &src_headers) {
  13554. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13555. if (!lr.getline()) { return false; }
  13556. return parse_trailers(lr, dest, src_headers);
  13557. }
  13558. } // namespace detail
  13559. inline void
  13560. ClientImpl::transfer_socket_ownership_to_handle(StreamHandle &handle) {
  13561. handle.connection_->sock = socket_.sock;
  13562. #ifdef CPPHTTPLIB_SSL_ENABLED
  13563. handle.connection_->session = socket_.ssl;
  13564. socket_.ssl = nullptr;
  13565. #endif
  13566. socket_.sock = INVALID_SOCKET;
  13567. }
  13568. inline bool ClientImpl::handle_request(Stream &strm, Request &req,
  13569. Response &res, bool close_connection,
  13570. Error &error) {
  13571. if (req.path.empty()) {
  13572. error = Error::Connection;
  13573. output_error_log(error, &req);
  13574. return false;
  13575. }
  13576. auto req_save = req;
  13577. bool ret;
  13578. if (!is_ssl() && is_proxy_enabled_for_host(host_)) {
  13579. auto req2 = req;
  13580. req2.path = "http://" +
  13581. detail::make_host_and_port_string(host_, port_, false) +
  13582. req.path;
  13583. ret = process_request(strm, req2, res, close_connection, error);
  13584. req = std::move(req2);
  13585. req.path = req_save.path;
  13586. } else {
  13587. ret = process_request(strm, req, res, close_connection, error);
  13588. }
  13589. if (!ret) { return false; }
  13590. {
  13591. // NOTE: this requires a not-entirely-obvious chain of calls to be correct
  13592. // for this to be safe.
  13593. // This is safe to call because handle_request is only called by send_
  13594. // which locks the request mutex during the process. It would be a bug
  13595. // to call it from a different thread since it's a thread-safety issue
  13596. // to do these things to the socket if another thread is using the socket.
  13597. std::lock_guard<std::mutex> guard(socket_mutex_);
  13598. // Also when the request asked for it (e.g. a body that was never sent),
  13599. // so that a redirect or an auth retry below does not reuse the socket.
  13600. if (socket_should_be_closed_when_request_is_done_ ||
  13601. detail::has_header_token(res.headers, "Connection", "close") ||
  13602. (res.version == "HTTP/1.0" && res.reason != "Connection established")) {
  13603. disconnect(/*gracefully=*/true);
  13604. }
  13605. }
  13606. if (300 < res.status && res.status < 400 && follow_location_) {
  13607. req = std::move(req_save);
  13608. // The client that followed the redirect has answered any challenge it
  13609. // could. Retrying below would sign another host's challenge and send it
  13610. // here.
  13611. return redirect(req, res, error);
  13612. }
  13613. #ifdef CPPHTTPLIB_SSL_ENABLED
  13614. if ((res.status == StatusCode::Unauthorized_401 ||
  13615. res.status == StatusCode::ProxyAuthenticationRequired_407) &&
  13616. req.authorization_count_ < 5) {
  13617. auto is_proxy = res.status == StatusCode::ProxyAuthenticationRequired_407;
  13618. // Only retry when the 407 actually came from a proxy hop: plain HTTP
  13619. // through an enabled proxy. HTTPS via CONNECT tunnels the 407 from the
  13620. // origin (#2457); direct/bypassed origins have no proxy hop at all.
  13621. if (is_proxy && !(!is_ssl() && is_proxy_enabled_for_host(host_))) {
  13622. return ret;
  13623. }
  13624. const auto &username =
  13625. is_proxy ? proxy_digest_auth_username_ : digest_auth_username_;
  13626. const auto &password =
  13627. is_proxy ? proxy_digest_auth_password_ : digest_auth_password_;
  13628. if (!username.empty() && !password.empty()) {
  13629. std::map<std::string, std::string> auth;
  13630. if (detail::parse_www_authenticate(res, auth, is_proxy)) {
  13631. Request new_req = req;
  13632. new_req.authorization_count_ += 1;
  13633. new_req.headers.erase(is_proxy ? "Proxy-Authorization"
  13634. : "Authorization");
  13635. new_req.headers.insert(detail::make_digest_authentication_header(
  13636. req, auth, new_req.authorization_count_, detail::random_string(10),
  13637. username, password, is_proxy));
  13638. Response new_res;
  13639. ret = send(new_req, new_res, error);
  13640. if (ret) { res = std::move(new_res); }
  13641. }
  13642. }
  13643. }
  13644. #endif
  13645. return ret;
  13646. }
  13647. inline bool ClientImpl::redirect(Request &req, Response &res, Error &error) {
  13648. if (req.redirect_count_ == 0) {
  13649. error = Error::ExceedRedirectCount;
  13650. output_error_log(error, &req);
  13651. return false;
  13652. }
  13653. auto location = res.get_header_value("location");
  13654. if (location.empty()) { return false; }
  13655. detail::UrlComponents uc;
  13656. if (!detail::parse_url(detail::resolve_relative_location(location, req.path),
  13657. uc)) {
  13658. return false;
  13659. }
  13660. // Only follow http/https redirects
  13661. if (!uc.scheme.empty() && uc.scheme != "http" && uc.scheme != "https") {
  13662. return false;
  13663. }
  13664. auto scheme = is_ssl() ? "https" : "http";
  13665. auto next_scheme = std::move(uc.scheme);
  13666. auto next_host = std::move(uc.host);
  13667. auto port_str = std::move(uc.port);
  13668. auto next_path = std::move(uc.path);
  13669. auto next_query = std::move(uc.query);
  13670. auto next_port = port_;
  13671. if (!port_str.empty()) {
  13672. if (!detail::parse_port(port_str, next_port)) { return false; }
  13673. } else if (!next_scheme.empty()) {
  13674. next_port = next_scheme == "https" ? 443 : 80;
  13675. }
  13676. if (next_scheme.empty()) { next_scheme = scheme; }
  13677. if (next_host.empty()) { next_host = host_; }
  13678. if (next_path.empty()) { next_path = "/"; }
  13679. auto path = std::move(next_path) + next_query;
  13680. // Same host redirect - use current client
  13681. if (next_scheme == scheme && next_host == host_ && next_port == port_) {
  13682. return detail::redirect(*this, req, res, path, location, error);
  13683. }
  13684. // Cross-host/scheme redirect - create new client with robust setup
  13685. return create_redirect_client(next_scheme, next_host, next_port, req, res,
  13686. path, location, error);
  13687. }
  13688. // New method for robust redirect client creation
  13689. inline bool ClientImpl::create_redirect_client(
  13690. const std::string &scheme, const std::string &host, int port, Request &req,
  13691. Response &res, const std::string &path, const std::string &location,
  13692. Error &error) {
  13693. // Determine if we need SSL
  13694. auto need_ssl = (scheme == "https");
  13695. // Clean up request headers that are host/client specific
  13696. // Remove headers that should not be carried over to new host
  13697. auto headers_to_remove = std::vector<std::string>{
  13698. "Host", "Proxy-Authorization", "Authorization", "Cookie", "Cookie2"};
  13699. for (const auto &header_name : headers_to_remove) {
  13700. auto it = req.headers.find(header_name);
  13701. while (it != req.headers.end()) {
  13702. it = req.headers.erase(it);
  13703. it = req.headers.find(header_name);
  13704. }
  13705. }
  13706. // Create appropriate client type and handle redirect
  13707. if (need_ssl) {
  13708. #ifdef CPPHTTPLIB_SSL_ENABLED
  13709. // Create SSL client for HTTPS redirect
  13710. SSLClient redirect_client(host, port);
  13711. // Setup basic client configuration first
  13712. setup_redirect_client(redirect_client);
  13713. redirect_client.enable_server_certificate_verification(
  13714. server_certificate_verification_);
  13715. redirect_client.enable_server_hostname_verification(
  13716. server_hostname_verification_);
  13717. redirect_client.system_ca_mode_ = system_ca_mode_;
  13718. // Transfer CA certificate to redirect client
  13719. redirect_client.load_ca_cert_store(ca_cert_pem_.c_str(),
  13720. ca_cert_pem_.size());
  13721. redirect_client.set_ca_cert_path(ca_cert_file_path_, ca_cert_dir_path_);
  13722. if (is_ssl()) {
  13723. auto &self = static_cast<SSLClient &>(*this);
  13724. // A store given to set_ca_cert_store() lives only in this client's
  13725. // context, so pass on the CA certificates the context holds.
  13726. if (self.ca_cert_store_set_) {
  13727. auto pem = detail::ca_certs_to_pem(self.ctx_);
  13728. redirect_client.load_ca_cert_store(pem.data(), pem.size());
  13729. }
  13730. redirect_client.set_session_verifier(self.session_verifier_);
  13731. if (self.server_certificate_verifier_) {
  13732. redirect_client.set_server_certificate_verifier(
  13733. self.server_certificate_verifier_);
  13734. }
  13735. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  13736. redirect_client.enable_windows_cert_verification_ =
  13737. self.enable_windows_cert_verification_;
  13738. #endif
  13739. }
  13740. // Client certificates are set through constructor for SSLClient
  13741. // NOTE: SSLClient constructor already takes client_cert_path and
  13742. // client_key_path so we need to create it properly if client certs are
  13743. // needed
  13744. // Execute the redirect
  13745. return detail::redirect(redirect_client, req, res, path, location, error);
  13746. #else
  13747. // SSL not supported - set appropriate error
  13748. error = Error::SSLConnection;
  13749. output_error_log(error, &req);
  13750. return false;
  13751. #endif
  13752. } else {
  13753. // HTTP redirect
  13754. ClientImpl redirect_client(host, port);
  13755. // Setup client with robust configuration
  13756. setup_redirect_client(redirect_client);
  13757. // Execute the redirect
  13758. return detail::redirect(redirect_client, req, res, path, location, error);
  13759. }
  13760. }
  13761. // New method for robust client setup (based on basic_manual_redirect.cpp
  13762. // logic)
  13763. template <typename ClientType>
  13764. inline void ClientImpl::setup_redirect_client(ClientType &client) {
  13765. // Copy basic settings first
  13766. client.set_connection_timeout(connection_timeout_sec_,
  13767. connection_timeout_usec_);
  13768. client.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  13769. client.set_write_timeout(write_timeout_sec_, write_timeout_usec_);
  13770. client.set_max_timeout(max_timeout_msec_);
  13771. if (has_payload_max_length_) {
  13772. client.set_payload_max_length(payload_max_length_);
  13773. }
  13774. client.set_keep_alive(keep_alive_);
  13775. client.set_follow_location(
  13776. true); // Enable redirects to handle multi-step redirects
  13777. client.set_path_encode(path_encode_);
  13778. client.set_compress(compress_);
  13779. client.set_decompress(decompress_);
  13780. // NOTE: Authentication credentials (basic auth, bearer token, digest auth)
  13781. // are intentionally NOT copied to the redirect client. Per RFC 9110 Section
  13782. // 15.4, credentials must not be forwarded when redirecting to a different
  13783. // host. This function is only called for cross-host redirects; same-host
  13784. // redirects are handled directly in ClientImpl::redirect().
  13785. // Copy the proxy configuration unconditionally; the per-target bypass is
  13786. // re-evaluated at send time, so a later hop to a non-bypassed host can
  13787. // still use the proxy.
  13788. client.no_proxy_entries_ = no_proxy_entries_;
  13789. if (!proxy_host_.empty() && proxy_port_ != -1) {
  13790. client.set_proxy(proxy_host_, proxy_port_);
  13791. if (!proxy_basic_auth_username_.empty() ||
  13792. !proxy_basic_auth_password_.empty()) {
  13793. client.set_proxy_basic_auth(proxy_basic_auth_username_,
  13794. proxy_basic_auth_password_);
  13795. }
  13796. if (!proxy_bearer_token_auth_token_.empty()) {
  13797. client.set_proxy_bearer_token_auth(proxy_bearer_token_auth_token_);
  13798. }
  13799. #ifdef CPPHTTPLIB_SSL_ENABLED
  13800. if (!proxy_digest_auth_username_.empty()) {
  13801. client.set_proxy_digest_auth(proxy_digest_auth_username_,
  13802. proxy_digest_auth_password_);
  13803. }
  13804. #endif
  13805. }
  13806. // Copy network and socket settings
  13807. client.addr_map_ = addr_map_;
  13808. client.set_address_family(address_family_);
  13809. client.set_tcp_nodelay(tcp_nodelay_);
  13810. client.set_ipv6_v6only(ipv6_v6only_);
  13811. if (socket_options_) { client.set_socket_options(socket_options_); }
  13812. if (!interface_.empty()) { client.set_interface(interface_); }
  13813. // Copy logging and headers
  13814. if (logger_) { client.set_logger(logger_); }
  13815. if (error_logger_) { client.set_error_logger(error_logger_); }
  13816. // NOTE: DO NOT copy default_headers_ as they may contain stale Host headers
  13817. // Each new client should generate its own headers based on its target host
  13818. }
  13819. inline bool ClientImpl::write_content_with_provider(Stream &strm,
  13820. const Request &req,
  13821. Error &error) const {
  13822. auto is_shutting_down = []() { return false; };
  13823. if (req.is_chunked_content_provider_) {
  13824. auto compressor = compress_ ? detail::create_compressor().first
  13825. : std::unique_ptr<detail::compressor>();
  13826. if (!compressor) {
  13827. compressor = detail::make_unique<detail::nocompressor>();
  13828. }
  13829. return detail::write_content_chunked(strm, req.content_provider_,
  13830. is_shutting_down, *compressor, error);
  13831. } else {
  13832. return detail::write_content_with_progress(
  13833. strm, req.content_provider_, 0, req.content_length_, is_shutting_down,
  13834. req.upload_progress, error);
  13835. }
  13836. }
  13837. inline bool ClientImpl::write_request(Stream &strm, Request &req,
  13838. bool close_connection, Error &error,
  13839. bool skip_body, bool &rejected_locally) {
  13840. rejected_locally = false;
  13841. // Prepare additional headers
  13842. if (close_connection) {
  13843. if (!req.has_header("Connection")) {
  13844. req.set_header("Connection", "close");
  13845. }
  13846. }
  13847. std::string ct_for_defaults;
  13848. if (!req.has_header("Content-Type") && !req.body.empty()) {
  13849. ct_for_defaults = "text/plain";
  13850. }
  13851. prepare_default_headers(req, false, ct_for_defaults);
  13852. if (req.body.empty()) {
  13853. if (req.content_provider_) {
  13854. if (!req.is_chunked_content_provider_) {
  13855. if (!req.has_header("Content-Length")) {
  13856. auto length = std::to_string(req.content_length_);
  13857. req.set_header("Content-Length", length);
  13858. }
  13859. }
  13860. } else {
  13861. if (req.method == "POST" || req.method == "PUT" ||
  13862. req.method == "PATCH") {
  13863. req.set_header("Content-Length", "0");
  13864. }
  13865. }
  13866. }
  13867. // A CONNECT request is read by the proxy; everything sent through the tunnel
  13868. // it opens is read by the origin. Each credential goes only to its own hop.
  13869. auto is_connect = req.method == "CONNECT";
  13870. if (!is_connect && !req.has_header("Authorization")) {
  13871. if (!basic_auth_password_.empty() || !basic_auth_username_.empty()) {
  13872. req.headers.insert(make_basic_authentication_header(
  13873. basic_auth_username_, basic_auth_password_, false));
  13874. } else if (!bearer_token_auth_token_.empty()) {
  13875. req.headers.insert(make_bearer_token_authentication_header(
  13876. bearer_token_auth_token_, false));
  13877. }
  13878. }
  13879. // Proxy-Authorization is only sent when the proxy reads this message —
  13880. // otherwise NO_PROXY-matched requests, and requests inside a TLS tunnel,
  13881. // would leak proxy credentials to the destination server.
  13882. if (is_proxy_enabled_for_host(host_) && (!is_ssl() || is_connect)) {
  13883. if ((!proxy_basic_auth_username_.empty() ||
  13884. !proxy_basic_auth_password_.empty()) &&
  13885. !req.has_header("Proxy-Authorization")) {
  13886. req.headers.insert(make_basic_authentication_header(
  13887. proxy_basic_auth_username_, proxy_basic_auth_password_, true));
  13888. }
  13889. if (!proxy_bearer_token_auth_token_.empty() &&
  13890. !req.has_header("Proxy-Authorization")) {
  13891. req.headers.insert(make_bearer_token_authentication_header(
  13892. proxy_bearer_token_auth_token_, true));
  13893. }
  13894. }
  13895. // Request line and headers
  13896. {
  13897. detail::BufferStream bstrm;
  13898. // Extract the query from req.path. The encoding itself is delegated to
  13899. // `encode_request_target`; the raw query is still needed here to decide
  13900. // between populating `req.params` from it and falling back to building a
  13901. // query out of caller-supplied `req.params`.
  13902. auto query_pos = req.path.find('?');
  13903. auto query_part = query_pos == std::string::npos
  13904. ? std::string()
  13905. : req.path.substr(query_pos + 1);
  13906. auto path_with_query =
  13907. detail::encode_request_target(req.path, path_encode_);
  13908. if (!query_part.empty()) {
  13909. // The query already came in through `req.path`; still populate
  13910. // `req.params` for handlers/users who read them.
  13911. detail::parse_query_text(query_part, req.params);
  13912. } else if (!req.params.empty()) {
  13913. // No query in `req.path`; build one from `req.params` so existing
  13914. // callers that pass `Params` separately continue to work.
  13915. path_with_query = append_query_params(path_with_query, req.params);
  13916. }
  13917. // Write request line and headers
  13918. if (detail::write_request_line(bstrm, req.method, path_with_query) < 0) {
  13919. // A rejected method (not a token, e.g. carrying CR/LF) or target (e.g.
  13920. // CR/LF in a caller-supplied path under set_path_encode(false)) must
  13921. // fail the request cleanly instead of emitting a request-line-less,
  13922. // header-injecting request.
  13923. error = Error::Write;
  13924. rejected_locally = true;
  13925. output_error_log(error, &req);
  13926. return false;
  13927. }
  13928. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13929. error)) {
  13930. rejected_locally = true;
  13931. output_error_log(error, &req);
  13932. return false;
  13933. }
  13934. // Flush buffer
  13935. auto &data = bstrm.get_buffer();
  13936. if (!detail::write_data(strm, data.data(), data.size())) {
  13937. error = Error::Write;
  13938. output_error_log(error, &req);
  13939. return false;
  13940. }
  13941. }
  13942. // After sending request line and headers, wait briefly for an early server
  13943. // response (e.g. 4xx) and avoid sending a potentially large request body
  13944. // unnecessarily. This workaround is only enabled on Windows because Unix
  13945. // platforms surface write errors (EPIPE) earlier; on Windows kernel send
  13946. // buffering can accept large writes even when the peer already responded.
  13947. // Check the stream first (which covers SSL via `is_readable()`), then
  13948. // fall back to select on the socket. Only perform the wait for very large
  13949. // request bodies to avoid interfering with normal small requests and
  13950. // reduce side-effects. Poll briefly (up to 50ms as default) for an early
  13951. // response. Skip this check when using Expect: 100-continue, as the protocol
  13952. // handles early responses properly.
  13953. #if defined(_WIN32)
  13954. if (!skip_body &&
  13955. req.body.size() > CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD &&
  13956. req.path.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  13957. auto start = std::chrono::high_resolution_clock::now();
  13958. for (;;) {
  13959. // Prefer socket-level readiness to avoid SSL_pending() false-positives
  13960. // from SSL internals. If the underlying socket is readable, assume an
  13961. // early response may be present.
  13962. auto sock = strm.socket();
  13963. if (sock != INVALID_SOCKET && detail::select_read(sock, 0, 0) > 0) {
  13964. return false;
  13965. }
  13966. // Fallback to stream-level check for non-socket streams or when the
  13967. // socket isn't reporting readable. Avoid using `is_readable()` for
  13968. // SSL, since `SSL_pending()` may report buffered records that do not
  13969. // indicate a complete application-level response yet.
  13970. if (!is_ssl() && strm.is_readable()) { return false; }
  13971. auto now = std::chrono::high_resolution_clock::now();
  13972. auto elapsed =
  13973. std::chrono::duration_cast<std::chrono::milliseconds>(now - start)
  13974. .count();
  13975. if (elapsed >= CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND) {
  13976. break;
  13977. }
  13978. std::this_thread::sleep_for(std::chrono::milliseconds(1));
  13979. }
  13980. }
  13981. #endif
  13982. // Body
  13983. if (skip_body) { return true; }
  13984. return write_request_body(strm, req, error);
  13985. }
  13986. inline bool ClientImpl::write_request_body(Stream &strm, Request &req,
  13987. Error &error) {
  13988. if (req.body.empty()) {
  13989. return write_content_with_provider(strm, req, error);
  13990. }
  13991. if (req.upload_progress) {
  13992. auto body_size = req.body.size();
  13993. size_t written = 0;
  13994. auto data = req.body.data();
  13995. while (written < body_size) {
  13996. size_t to_write = (std::min)(CPPHTTPLIB_SEND_BUFSIZ, body_size - written);
  13997. if (!detail::write_data(strm, data + written, to_write)) {
  13998. error = Error::Write;
  13999. output_error_log(error, &req);
  14000. return false;
  14001. }
  14002. written += to_write;
  14003. if (!req.upload_progress(written, body_size)) {
  14004. error = Error::Canceled;
  14005. output_error_log(error, &req);
  14006. return false;
  14007. }
  14008. }
  14009. } else {
  14010. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  14011. error = Error::Write;
  14012. output_error_log(error, &req);
  14013. return false;
  14014. }
  14015. }
  14016. return true;
  14017. }
  14018. inline std::unique_ptr<Response>
  14019. ClientImpl::send_with_content_provider_and_receiver(
  14020. Request &req, const char *body, size_t content_length,
  14021. ContentProvider content_provider,
  14022. ContentProviderWithoutLength content_provider_without_length,
  14023. const std::string &content_type, ContentReceiver content_receiver,
  14024. Error &error) {
  14025. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14026. auto enc = compress_
  14027. ? detail::create_compressor()
  14028. : std::pair<std::unique_ptr<detail::compressor>, const char *>(
  14029. nullptr, nullptr);
  14030. if (enc.second) { req.set_header("Content-Encoding", enc.second); }
  14031. if (enc.first && !content_provider_without_length) {
  14032. auto &compressor = enc.first;
  14033. if (content_provider) {
  14034. auto ok = true;
  14035. auto finished = false;
  14036. size_t offset = 0;
  14037. DataSink data_sink;
  14038. data_sink.write = [&](const char *data, size_t data_len) -> bool {
  14039. if (ok) {
  14040. auto last = offset + data_len == content_length;
  14041. auto ret = compressor->compress(
  14042. data, data_len, last,
  14043. [&](const char *compressed_data, size_t compressed_data_len) {
  14044. req.body.append(compressed_data, compressed_data_len);
  14045. return true;
  14046. });
  14047. if (ret) {
  14048. offset += data_len;
  14049. } else {
  14050. ok = false;
  14051. }
  14052. }
  14053. return ok;
  14054. };
  14055. // As in detail::write_content_with_progress(): the body is framed by
  14056. // content_length, so a provider that finishes early has truncated it.
  14057. // Stop and report that instead of calling the provider forever.
  14058. data_sink.done = [&]() { finished = true; };
  14059. while (ok && !finished && offset < content_length) {
  14060. if (!content_provider(offset, content_length - offset, data_sink)) {
  14061. error = Error::Canceled;
  14062. output_error_log(error, &req);
  14063. return nullptr;
  14064. }
  14065. }
  14066. // A short body here means either the provider stopped early or the
  14067. // compressor gave up. The branch below reports a failing compressor as
  14068. // Error::Compression, so keep the two distinguishable.
  14069. if (offset < content_length) {
  14070. error = ok ? Error::Write : Error::Compression;
  14071. output_error_log(error, &req);
  14072. return nullptr;
  14073. }
  14074. } else {
  14075. if (!compressor->compress(body, content_length, true,
  14076. [&](const char *data, size_t data_len) {
  14077. req.body.append(data, data_len);
  14078. return true;
  14079. })) {
  14080. error = Error::Compression;
  14081. output_error_log(error, &req);
  14082. return nullptr;
  14083. }
  14084. }
  14085. } else {
  14086. if (content_provider) {
  14087. req.content_length_ = content_length;
  14088. req.content_provider_ = std::move(content_provider);
  14089. req.is_chunked_content_provider_ = false;
  14090. } else if (content_provider_without_length) {
  14091. req.content_length_ = 0;
  14092. req.content_provider_ = detail::ContentProviderAdapter(
  14093. std::move(content_provider_without_length));
  14094. req.is_chunked_content_provider_ = true;
  14095. req.set_header("Transfer-Encoding", "chunked");
  14096. } else {
  14097. req.body.assign(body, content_length);
  14098. }
  14099. }
  14100. if (content_receiver) {
  14101. req.content_receiver =
  14102. [content_receiver](const char *data, size_t data_length,
  14103. size_t /*offset*/, size_t /*total_length*/) {
  14104. return content_receiver(data, data_length);
  14105. };
  14106. }
  14107. auto res = detail::make_unique<Response>();
  14108. return send(req, *res, error) ? std::move(res) : nullptr;
  14109. }
  14110. inline Result ClientImpl::send_with_content_provider_and_receiver(
  14111. const std::string &method, const std::string &path, const Headers &headers,
  14112. const char *body, size_t content_length, ContentProvider content_provider,
  14113. ContentProviderWithoutLength content_provider_without_length,
  14114. const std::string &content_type, ContentReceiver content_receiver,
  14115. UploadProgress progress) {
  14116. Request req;
  14117. req.method = method;
  14118. req.headers = headers;
  14119. req.path = path;
  14120. req.upload_progress = std::move(progress);
  14121. if (max_timeout_msec_ > 0) {
  14122. req.start_time_ = std::chrono::steady_clock::now();
  14123. }
  14124. auto error = Error::Success;
  14125. auto res = send_with_content_provider_and_receiver(
  14126. req, body, content_length, std::move(content_provider),
  14127. std::move(content_provider_without_length), content_type,
  14128. std::move(content_receiver), error);
  14129. #ifdef CPPHTTPLIB_SSL_ENABLED
  14130. return Result{std::move(res), error, std::move(req.headers), last_ssl_error_,
  14131. last_backend_error_};
  14132. #else
  14133. return Result{std::move(res), error, std::move(req.headers)};
  14134. #endif
  14135. }
  14136. inline void ClientImpl::output_log(const Request &req,
  14137. const Response &res) const {
  14138. if (logger_) {
  14139. std::lock_guard<std::mutex> guard(logger_mutex_);
  14140. logger_(req, res);
  14141. }
  14142. }
  14143. inline void ClientImpl::output_error_log(const Error &err,
  14144. const Request *req) const {
  14145. if (error_logger_) {
  14146. std::lock_guard<std::mutex> guard(logger_mutex_);
  14147. error_logger_(err, req);
  14148. }
  14149. }
  14150. inline bool ClientImpl::process_request(Stream &strm, Request &req,
  14151. Response &res, bool close_connection,
  14152. Error &error) {
  14153. // Auto-add Expect: 100-continue for large bodies
  14154. if (CPPHTTPLIB_EXPECT_100_THRESHOLD > 0 && !req.has_header("Expect")) {
  14155. auto body_size = req.body.empty() ? req.content_length_ : req.body.size();
  14156. if (body_size >= CPPHTTPLIB_EXPECT_100_THRESHOLD) {
  14157. req.set_header("Expect", "100-continue");
  14158. }
  14159. }
  14160. // Check for Expect: 100-continue
  14161. auto expect_100_continue =
  14162. detail::has_header_token(req.headers, "Expect", "100-continue");
  14163. // Send request (skip body if using Expect: 100-continue)
  14164. auto rejected_locally = false;
  14165. auto write_request_success =
  14166. write_request(strm, req, close_connection, error, expect_100_continue,
  14167. rejected_locally);
  14168. // A failed write normally still reads the response below, since the server
  14169. // may have answered early (e.g. 413/414) and closed while the body was being
  14170. // sent. A request rejected before any byte reached the socket gets no such
  14171. // response, and waiting for one would block until the read timeout.
  14172. if (rejected_locally) { return false; }
  14173. #ifdef CPPHTTPLIB_SSL_ENABLED
  14174. if (is_ssl() && !expect_100_continue) {
  14175. auto is_proxy_enabled = is_proxy_enabled_for_host(host_);
  14176. if (!is_proxy_enabled) {
  14177. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  14178. error = Error::SSLPeerCouldBeClosed_;
  14179. output_error_log(error, &req);
  14180. return false;
  14181. }
  14182. }
  14183. }
  14184. #endif
  14185. // Handle Expect: 100-continue.
  14186. //
  14187. // Wait for an interim/early response by attempting to read the status line
  14188. // under a short timeout, instead of trusting raw socket readability. Over
  14189. // TLS, post-handshake records (e.g. session tickets) make the socket
  14190. // readable without any HTTP response being available; relying on
  14191. // `select_read` there caused the body to be withheld forever and the
  14192. // request to fail with `Read` (#2458). If no status line arrives within the
  14193. // timeout, send the body anyway (matching curl's behavior).
  14194. auto status_line_read = false;
  14195. if (expect_100_continue && write_request_success) {
  14196. if (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND > 0) {
  14197. time_t sec = CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND / 1000;
  14198. time_t usec = (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND % 1000) * 1000;
  14199. strm.set_read_timeout(sec, usec);
  14200. status_line_read = read_response_line(strm, req, res, false);
  14201. strm.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  14202. }
  14203. if (!status_line_read) {
  14204. // No interim response within the timeout: send the body and handle the
  14205. // response as usual.
  14206. if (!write_request_body(strm, req, error)) { return false; }
  14207. expect_100_continue = false; // Switch to normal response handling
  14208. }
  14209. }
  14210. // Receive response and headers
  14211. // When using Expect: 100-continue, don't auto-skip `100 Continue` response
  14212. if ((!status_line_read &&
  14213. !read_response_line(strm, req, res, !expect_100_continue)) ||
  14214. !detail::read_headers(strm, res.headers)) {
  14215. if (write_request_success) { error = Error::Read; }
  14216. output_error_log(error, &req);
  14217. return false;
  14218. }
  14219. if (!write_request_success) { return false; }
  14220. // Handle Expect: 100-continue response
  14221. if (expect_100_continue) {
  14222. if (res.status == StatusCode::Continue_100) {
  14223. // Server accepted, send the body
  14224. if (!write_request_body(strm, req, error)) { return false; }
  14225. // Read the actual response
  14226. res.headers.clear();
  14227. res.body.clear();
  14228. if (!read_response_line(strm, req, res) ||
  14229. !detail::read_headers(strm, res.headers)) {
  14230. error = Error::Read;
  14231. output_error_log(error, &req);
  14232. return false;
  14233. }
  14234. } else {
  14235. // A final response came first, so the body this request declared was
  14236. // never sent, and the server may still be waiting for it. The
  14237. // connection cannot carry another request.
  14238. std::lock_guard<std::mutex> guard(socket_mutex_);
  14239. socket_should_be_closed_when_request_is_done_ = true;
  14240. }
  14241. }
  14242. // Body
  14243. if ((res.status != StatusCode::NoContent_204) && req.method != "HEAD" &&
  14244. req.method != "CONNECT") {
  14245. // Reject ambiguous framing (RFC 9112 §6.3). Unlike a request, a response
  14246. // whose final transfer coding is not chunked is not ambiguous: its body
  14247. // runs until the server closes the connection, so it is not rejected.
  14248. // HEAD/204 are excluded above and a 304 carries no body.
  14249. if (res.status != StatusCode::NotModified_304 &&
  14250. detail::has_conflicting_content_length(res.headers)) {
  14251. error = Error::Read;
  14252. output_error_log(error, &req);
  14253. return false;
  14254. }
  14255. auto redirect = 300 < res.status && res.status < 400 &&
  14256. res.status != StatusCode::NotModified_304 &&
  14257. follow_location_;
  14258. if (req.response_handler && !redirect) {
  14259. if (!req.response_handler(res)) {
  14260. error = Error::Canceled;
  14261. output_error_log(error, &req);
  14262. return false;
  14263. }
  14264. }
  14265. auto out =
  14266. req.content_receiver
  14267. ? static_cast<ContentReceiverWithProgress>(
  14268. [&](const char *buf, size_t n, size_t off, size_t len) {
  14269. if (redirect) { return true; }
  14270. auto ret = req.content_receiver(buf, n, off, len);
  14271. if (!ret) {
  14272. error = Error::Canceled;
  14273. output_error_log(error, &req);
  14274. }
  14275. return ret;
  14276. })
  14277. : static_cast<ContentReceiverWithProgress>(
  14278. [&](const char *buf, size_t n, size_t /*off*/,
  14279. size_t /*len*/) {
  14280. assert(res.body.size() + n <= res.body.max_size());
  14281. if (payload_max_length_ > 0 &&
  14282. (res.body.size() >= payload_max_length_ ||
  14283. n > payload_max_length_ - res.body.size())) {
  14284. return false;
  14285. }
  14286. res.body.append(buf, n);
  14287. return true;
  14288. });
  14289. auto progress = [&](size_t current, size_t total) {
  14290. if (!req.download_progress || redirect) { return true; }
  14291. auto ret = req.download_progress(current, total);
  14292. if (!ret) {
  14293. error = Error::Canceled;
  14294. output_error_log(error, &req);
  14295. }
  14296. return ret;
  14297. };
  14298. if (res.has_header("Content-Length")) {
  14299. if (!req.content_receiver) {
  14300. auto len = res.get_header_value_u64("Content-Length");
  14301. if (len > res.body.max_size()) {
  14302. error = Error::Read;
  14303. output_error_log(error, &req);
  14304. return false;
  14305. }
  14306. // Content-Length is only the server's claim, so reserve no more than
  14307. // payload_max_length_ allows, nor more than 1 MiB before any of the
  14308. // body has arrived. A longer body grows as it is read.
  14309. auto reserve_len =
  14310. (std::min)(static_cast<size_t>(len), size_t(1024 * 1024));
  14311. if (payload_max_length_ > 0) {
  14312. reserve_len = (std::min)(reserve_len, payload_max_length_);
  14313. }
  14314. res.body.reserve(reserve_len);
  14315. }
  14316. }
  14317. if (res.status != StatusCode::NotModified_304) {
  14318. auto content_status = 0;
  14319. auto max_length = (!has_payload_max_length_ && req.content_receiver)
  14320. ? (std::numeric_limits<size_t>::max)()
  14321. : payload_max_length_;
  14322. if (!detail::read_content(strm, res, max_length, content_status,
  14323. std::move(progress), std::move(out),
  14324. decompress_)) {
  14325. if (error != Error::Canceled) {
  14326. // Tell the caller apart from a plain read failure when the body could
  14327. // not be decoded because of its Content-Encoding.
  14328. switch (content_status) {
  14329. case StatusCode::UnsupportedMediaType_415:
  14330. error = Error::UnsupportedContentEncoding;
  14331. break;
  14332. case StatusCode::InternalServerError_500:
  14333. error = Error::Compression;
  14334. break;
  14335. default: error = Error::Read; break;
  14336. }
  14337. }
  14338. output_error_log(error, &req);
  14339. return false;
  14340. }
  14341. }
  14342. }
  14343. // Log
  14344. output_log(req, res);
  14345. return true;
  14346. }
  14347. inline ContentProviderWithoutLength ClientImpl::get_multipart_content_provider(
  14348. const std::string &boundary, const UploadFormDataItems &items,
  14349. const FormDataProviderItems &provider_items) const {
  14350. size_t cur_item = 0;
  14351. size_t cur_start = 0;
  14352. // cur_item and cur_start are copied to within the std::function and
  14353. // maintain state between successive calls
  14354. return [&, cur_item, cur_start](size_t offset,
  14355. DataSink &sink) mutable -> bool {
  14356. if (!offset && !items.empty()) {
  14357. sink.os << detail::serialize_multipart_formdata(items, boundary, false);
  14358. return true;
  14359. } else if (cur_item < provider_items.size()) {
  14360. if (!cur_start) {
  14361. const auto &begin = detail::serialize_multipart_formdata_item_begin(
  14362. provider_items[cur_item], boundary);
  14363. offset += begin.size();
  14364. cur_start = offset;
  14365. sink.os << begin;
  14366. }
  14367. DataSink cur_sink;
  14368. auto has_data = true;
  14369. cur_sink.write = sink.write;
  14370. // Forward is_writable so a provider item asking whether it may keep
  14371. // going gets the outer sink's answer rather than the default `true`.
  14372. cur_sink.is_writable = sink.is_writable;
  14373. cur_sink.done = [&]() { has_data = false; };
  14374. if (!provider_items[cur_item].provider(offset - cur_start, cur_sink)) {
  14375. return false;
  14376. }
  14377. if (!has_data) {
  14378. sink.os << detail::serialize_multipart_formdata_item_end();
  14379. cur_item++;
  14380. cur_start = 0;
  14381. }
  14382. return true;
  14383. } else {
  14384. sink.os << detail::serialize_multipart_formdata_finish(boundary);
  14385. sink.done();
  14386. return true;
  14387. }
  14388. };
  14389. }
  14390. inline bool ClientImpl::process_socket(
  14391. const Socket &socket,
  14392. std::chrono::time_point<std::chrono::steady_clock> start_time,
  14393. std::function<bool(Stream &strm)> callback) {
  14394. return detail::process_client_socket(
  14395. socket.sock, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  14396. write_timeout_usec_, max_timeout_msec_, start_time, std::move(callback));
  14397. }
  14398. inline bool ClientImpl::is_ssl() const { return false; }
  14399. inline Result ClientImpl::Get(const std::string &path,
  14400. DownloadProgress progress) {
  14401. return Get(path, Headers(), std::move(progress));
  14402. }
  14403. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14404. DownloadProgress progress) {
  14405. return Get(path, params, Headers(), std::move(progress));
  14406. }
  14407. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14408. const Headers &headers,
  14409. DownloadProgress progress) {
  14410. if (params.empty()) { return Get(path, headers); }
  14411. std::string path_with_query = append_query_params(path, params);
  14412. return Get(path_with_query, headers, std::move(progress));
  14413. }
  14414. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14415. DownloadProgress progress) {
  14416. Request req;
  14417. req.method = "GET";
  14418. req.path = path;
  14419. req.headers = headers;
  14420. req.download_progress = std::move(progress);
  14421. if (max_timeout_msec_ > 0) {
  14422. req.start_time_ = std::chrono::steady_clock::now();
  14423. }
  14424. return send_(std::move(req));
  14425. }
  14426. inline Result ClientImpl::Get(const std::string &path,
  14427. ContentReceiver content_receiver,
  14428. DownloadProgress progress) {
  14429. return Get(path, Headers(), nullptr, std::move(content_receiver),
  14430. std::move(progress));
  14431. }
  14432. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14433. ContentReceiver content_receiver,
  14434. DownloadProgress progress) {
  14435. return Get(path, headers, nullptr, std::move(content_receiver),
  14436. std::move(progress));
  14437. }
  14438. inline Result ClientImpl::Get(const std::string &path,
  14439. ResponseHandler response_handler,
  14440. ContentReceiver content_receiver,
  14441. DownloadProgress progress) {
  14442. return Get(path, Headers(), std::move(response_handler),
  14443. std::move(content_receiver), std::move(progress));
  14444. }
  14445. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14446. ResponseHandler response_handler,
  14447. ContentReceiver content_receiver,
  14448. DownloadProgress progress) {
  14449. Request req;
  14450. req.method = "GET";
  14451. req.path = path;
  14452. req.headers = headers;
  14453. req.response_handler = std::move(response_handler);
  14454. req.content_receiver =
  14455. [content_receiver](const char *data, size_t data_length,
  14456. size_t /*offset*/, size_t /*total_length*/) {
  14457. return content_receiver(data, data_length);
  14458. };
  14459. req.download_progress = std::move(progress);
  14460. if (max_timeout_msec_ > 0) {
  14461. req.start_time_ = std::chrono::steady_clock::now();
  14462. }
  14463. return send_(std::move(req));
  14464. }
  14465. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14466. const Headers &headers,
  14467. ContentReceiver content_receiver,
  14468. DownloadProgress progress) {
  14469. return Get(path, params, headers, nullptr, std::move(content_receiver),
  14470. std::move(progress));
  14471. }
  14472. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14473. const Headers &headers,
  14474. ResponseHandler response_handler,
  14475. ContentReceiver content_receiver,
  14476. DownloadProgress progress) {
  14477. if (params.empty()) {
  14478. return Get(path, headers, std::move(response_handler),
  14479. std::move(content_receiver), std::move(progress));
  14480. }
  14481. std::string path_with_query = append_query_params(path, params);
  14482. return Get(path_with_query, headers, std::move(response_handler),
  14483. std::move(content_receiver), std::move(progress));
  14484. }
  14485. inline Result ClientImpl::Head(const std::string &path) {
  14486. return Head(path, Headers());
  14487. }
  14488. inline Result ClientImpl::Head(const std::string &path,
  14489. const Headers &headers) {
  14490. Request req;
  14491. req.method = "HEAD";
  14492. req.headers = headers;
  14493. req.path = path;
  14494. if (max_timeout_msec_ > 0) {
  14495. req.start_time_ = std::chrono::steady_clock::now();
  14496. }
  14497. return send_(std::move(req));
  14498. }
  14499. inline Result ClientImpl::Post(const std::string &path) {
  14500. return Post(path, std::string(), std::string());
  14501. }
  14502. inline Result ClientImpl::Post(const std::string &path,
  14503. const Headers &headers) {
  14504. return Post(path, headers, nullptr, 0, std::string());
  14505. }
  14506. inline Result ClientImpl::Post(const std::string &path, const char *body,
  14507. size_t content_length,
  14508. const std::string &content_type,
  14509. UploadProgress progress) {
  14510. return Post(path, Headers(), body, content_length, content_type, progress);
  14511. }
  14512. inline Result ClientImpl::Post(const std::string &path, const std::string &body,
  14513. const std::string &content_type,
  14514. UploadProgress progress) {
  14515. return Post(path, Headers(), body, content_type, progress);
  14516. }
  14517. inline Result ClientImpl::Post(const std::string &path, const Params &params) {
  14518. return Post(path, Headers(), params);
  14519. }
  14520. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14521. ContentProvider content_provider,
  14522. const std::string &content_type,
  14523. UploadProgress progress) {
  14524. return Post(path, Headers(), content_length, std::move(content_provider),
  14525. content_type, progress);
  14526. }
  14527. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14528. ContentProvider content_provider,
  14529. const std::string &content_type,
  14530. ContentReceiver content_receiver,
  14531. UploadProgress progress) {
  14532. return Post(path, Headers(), content_length, std::move(content_provider),
  14533. content_type, std::move(content_receiver), progress);
  14534. }
  14535. inline Result ClientImpl::Post(const std::string &path,
  14536. ContentProviderWithoutLength content_provider,
  14537. const std::string &content_type,
  14538. UploadProgress progress) {
  14539. return Post(path, Headers(), std::move(content_provider), content_type,
  14540. progress);
  14541. }
  14542. inline Result ClientImpl::Post(const std::string &path,
  14543. ContentProviderWithoutLength content_provider,
  14544. const std::string &content_type,
  14545. ContentReceiver content_receiver,
  14546. UploadProgress progress) {
  14547. return Post(path, Headers(), std::move(content_provider), content_type,
  14548. std::move(content_receiver), progress);
  14549. }
  14550. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14551. const Params &params) {
  14552. auto query = detail::params_to_query_str(params);
  14553. return Post(path, headers, query, "application/x-www-form-urlencoded");
  14554. }
  14555. inline Result ClientImpl::Post(const std::string &path,
  14556. const UploadFormDataItems &items,
  14557. UploadProgress progress) {
  14558. return Post(path, Headers(), items, progress);
  14559. }
  14560. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14561. const UploadFormDataItems &items,
  14562. UploadProgress progress) {
  14563. const auto &boundary = detail::make_multipart_data_boundary();
  14564. const auto &content_type =
  14565. detail::serialize_multipart_formdata_get_content_type(boundary);
  14566. auto content_length = detail::get_multipart_content_length(items, boundary);
  14567. return Post(path, headers, content_length,
  14568. detail::make_multipart_content_provider(items, boundary),
  14569. content_type, progress);
  14570. }
  14571. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14572. const UploadFormDataItems &items,
  14573. const std::string &boundary,
  14574. UploadProgress progress) {
  14575. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14576. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14577. }
  14578. const auto &content_type =
  14579. detail::serialize_multipart_formdata_get_content_type(boundary);
  14580. auto content_length = detail::get_multipart_content_length(items, boundary);
  14581. return Post(path, headers, content_length,
  14582. detail::make_multipart_content_provider(items, boundary),
  14583. content_type, progress);
  14584. }
  14585. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14586. const char *body, size_t content_length,
  14587. const std::string &content_type,
  14588. UploadProgress progress) {
  14589. return send_with_content_provider_and_receiver(
  14590. "POST", path, headers, body, content_length, nullptr, nullptr,
  14591. content_type, nullptr, progress);
  14592. }
  14593. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14594. const std::string &body,
  14595. const std::string &content_type,
  14596. UploadProgress progress) {
  14597. return send_with_content_provider_and_receiver(
  14598. "POST", path, headers, body.data(), body.size(), nullptr, nullptr,
  14599. content_type, nullptr, progress);
  14600. }
  14601. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14602. size_t content_length,
  14603. ContentProvider content_provider,
  14604. const std::string &content_type,
  14605. UploadProgress progress) {
  14606. return send_with_content_provider_and_receiver(
  14607. "POST", path, headers, nullptr, content_length,
  14608. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14609. }
  14610. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14611. size_t content_length,
  14612. ContentProvider content_provider,
  14613. const std::string &content_type,
  14614. ContentReceiver content_receiver,
  14615. DownloadProgress progress) {
  14616. return send_with_content_provider_and_receiver(
  14617. "POST", path, headers, nullptr, content_length,
  14618. std::move(content_provider), nullptr, content_type,
  14619. std::move(content_receiver), std::move(progress));
  14620. }
  14621. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14622. ContentProviderWithoutLength content_provider,
  14623. const std::string &content_type,
  14624. UploadProgress progress) {
  14625. return send_with_content_provider_and_receiver(
  14626. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14627. content_type, nullptr, progress);
  14628. }
  14629. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14630. ContentProviderWithoutLength content_provider,
  14631. const std::string &content_type,
  14632. ContentReceiver content_receiver,
  14633. DownloadProgress progress) {
  14634. return send_with_content_provider_and_receiver(
  14635. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14636. content_type, std::move(content_receiver), std::move(progress));
  14637. }
  14638. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14639. const UploadFormDataItems &items,
  14640. const FormDataProviderItems &provider_items,
  14641. UploadProgress progress) {
  14642. const auto &boundary = detail::make_multipart_data_boundary();
  14643. const auto &content_type =
  14644. detail::serialize_multipart_formdata_get_content_type(boundary);
  14645. return send_with_content_provider_and_receiver(
  14646. "POST", path, headers, nullptr, 0, nullptr,
  14647. get_multipart_content_provider(boundary, items, provider_items),
  14648. content_type, nullptr, progress);
  14649. }
  14650. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14651. const std::string &body,
  14652. const std::string &content_type,
  14653. ContentReceiver content_receiver,
  14654. DownloadProgress progress) {
  14655. Request req;
  14656. req.method = "POST";
  14657. req.path = path;
  14658. req.headers = headers;
  14659. req.body = body;
  14660. req.content_receiver =
  14661. [content_receiver](const char *data, size_t data_length,
  14662. size_t /*offset*/, size_t /*total_length*/) {
  14663. return content_receiver(data, data_length);
  14664. };
  14665. req.download_progress = std::move(progress);
  14666. if (max_timeout_msec_ > 0) {
  14667. req.start_time_ = std::chrono::steady_clock::now();
  14668. }
  14669. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14670. return send_(std::move(req));
  14671. }
  14672. inline Result ClientImpl::Put(const std::string &path) {
  14673. return Put(path, std::string(), std::string());
  14674. }
  14675. inline Result ClientImpl::Put(const std::string &path, const Headers &headers) {
  14676. return Put(path, headers, nullptr, 0, std::string());
  14677. }
  14678. inline Result ClientImpl::Put(const std::string &path, const char *body,
  14679. size_t content_length,
  14680. const std::string &content_type,
  14681. UploadProgress progress) {
  14682. return Put(path, Headers(), body, content_length, content_type, progress);
  14683. }
  14684. inline Result ClientImpl::Put(const std::string &path, const std::string &body,
  14685. const std::string &content_type,
  14686. UploadProgress progress) {
  14687. return Put(path, Headers(), body, content_type, progress);
  14688. }
  14689. inline Result ClientImpl::Put(const std::string &path, const Params &params) {
  14690. return Put(path, Headers(), params);
  14691. }
  14692. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14693. ContentProvider content_provider,
  14694. const std::string &content_type,
  14695. UploadProgress progress) {
  14696. return Put(path, Headers(), content_length, std::move(content_provider),
  14697. content_type, progress);
  14698. }
  14699. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14700. ContentProvider content_provider,
  14701. const std::string &content_type,
  14702. ContentReceiver content_receiver,
  14703. UploadProgress progress) {
  14704. return Put(path, Headers(), content_length, std::move(content_provider),
  14705. content_type, std::move(content_receiver), progress);
  14706. }
  14707. inline Result ClientImpl::Put(const std::string &path,
  14708. ContentProviderWithoutLength content_provider,
  14709. const std::string &content_type,
  14710. UploadProgress progress) {
  14711. return Put(path, Headers(), std::move(content_provider), content_type,
  14712. progress);
  14713. }
  14714. inline Result ClientImpl::Put(const std::string &path,
  14715. ContentProviderWithoutLength content_provider,
  14716. const std::string &content_type,
  14717. ContentReceiver content_receiver,
  14718. UploadProgress progress) {
  14719. return Put(path, Headers(), std::move(content_provider), content_type,
  14720. std::move(content_receiver), progress);
  14721. }
  14722. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14723. const Params &params) {
  14724. auto query = detail::params_to_query_str(params);
  14725. return Put(path, headers, query, "application/x-www-form-urlencoded");
  14726. }
  14727. inline Result ClientImpl::Put(const std::string &path,
  14728. const UploadFormDataItems &items,
  14729. UploadProgress progress) {
  14730. return Put(path, Headers(), items, progress);
  14731. }
  14732. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14733. const UploadFormDataItems &items,
  14734. UploadProgress progress) {
  14735. const auto &boundary = detail::make_multipart_data_boundary();
  14736. const auto &content_type =
  14737. detail::serialize_multipart_formdata_get_content_type(boundary);
  14738. auto content_length = detail::get_multipart_content_length(items, boundary);
  14739. return Put(path, headers, content_length,
  14740. detail::make_multipart_content_provider(items, boundary),
  14741. content_type, progress);
  14742. }
  14743. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14744. const UploadFormDataItems &items,
  14745. const std::string &boundary,
  14746. UploadProgress progress) {
  14747. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14748. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14749. }
  14750. const auto &content_type =
  14751. detail::serialize_multipart_formdata_get_content_type(boundary);
  14752. auto content_length = detail::get_multipart_content_length(items, boundary);
  14753. return Put(path, headers, content_length,
  14754. detail::make_multipart_content_provider(items, boundary),
  14755. content_type, progress);
  14756. }
  14757. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14758. const char *body, size_t content_length,
  14759. const std::string &content_type,
  14760. UploadProgress progress) {
  14761. return send_with_content_provider_and_receiver(
  14762. "PUT", path, headers, body, content_length, nullptr, nullptr,
  14763. content_type, nullptr, progress);
  14764. }
  14765. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14766. const std::string &body,
  14767. const std::string &content_type,
  14768. UploadProgress progress) {
  14769. return send_with_content_provider_and_receiver(
  14770. "PUT", path, headers, body.data(), body.size(), nullptr, nullptr,
  14771. content_type, nullptr, progress);
  14772. }
  14773. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14774. size_t content_length,
  14775. ContentProvider content_provider,
  14776. const std::string &content_type,
  14777. UploadProgress progress) {
  14778. return send_with_content_provider_and_receiver(
  14779. "PUT", path, headers, nullptr, content_length,
  14780. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14781. }
  14782. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14783. size_t content_length,
  14784. ContentProvider content_provider,
  14785. const std::string &content_type,
  14786. ContentReceiver content_receiver,
  14787. UploadProgress progress) {
  14788. return send_with_content_provider_and_receiver(
  14789. "PUT", path, headers, nullptr, content_length,
  14790. std::move(content_provider), nullptr, content_type,
  14791. std::move(content_receiver), progress);
  14792. }
  14793. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14794. ContentProviderWithoutLength content_provider,
  14795. const std::string &content_type,
  14796. UploadProgress progress) {
  14797. return send_with_content_provider_and_receiver(
  14798. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14799. content_type, nullptr, progress);
  14800. }
  14801. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14802. ContentProviderWithoutLength content_provider,
  14803. const std::string &content_type,
  14804. ContentReceiver content_receiver,
  14805. UploadProgress progress) {
  14806. return send_with_content_provider_and_receiver(
  14807. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14808. content_type, std::move(content_receiver), progress);
  14809. }
  14810. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14811. const UploadFormDataItems &items,
  14812. const FormDataProviderItems &provider_items,
  14813. UploadProgress progress) {
  14814. const auto &boundary = detail::make_multipart_data_boundary();
  14815. const auto &content_type =
  14816. detail::serialize_multipart_formdata_get_content_type(boundary);
  14817. return send_with_content_provider_and_receiver(
  14818. "PUT", path, headers, nullptr, 0, nullptr,
  14819. get_multipart_content_provider(boundary, items, provider_items),
  14820. content_type, nullptr, progress);
  14821. }
  14822. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14823. const std::string &body,
  14824. const std::string &content_type,
  14825. ContentReceiver content_receiver,
  14826. DownloadProgress progress) {
  14827. Request req;
  14828. req.method = "PUT";
  14829. req.path = path;
  14830. req.headers = headers;
  14831. req.body = body;
  14832. req.content_receiver =
  14833. [content_receiver](const char *data, size_t data_length,
  14834. size_t /*offset*/, size_t /*total_length*/) {
  14835. return content_receiver(data, data_length);
  14836. };
  14837. req.download_progress = std::move(progress);
  14838. if (max_timeout_msec_ > 0) {
  14839. req.start_time_ = std::chrono::steady_clock::now();
  14840. }
  14841. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14842. return send_(std::move(req));
  14843. }
  14844. inline Result ClientImpl::Patch(const std::string &path) {
  14845. return Patch(path, std::string(), std::string());
  14846. }
  14847. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14848. UploadProgress progress) {
  14849. return Patch(path, headers, nullptr, 0, std::string(), progress);
  14850. }
  14851. inline Result ClientImpl::Patch(const std::string &path, const char *body,
  14852. size_t content_length,
  14853. const std::string &content_type,
  14854. UploadProgress progress) {
  14855. return Patch(path, Headers(), body, content_length, content_type, progress);
  14856. }
  14857. inline Result ClientImpl::Patch(const std::string &path,
  14858. const std::string &body,
  14859. const std::string &content_type,
  14860. UploadProgress progress) {
  14861. return Patch(path, Headers(), body, content_type, progress);
  14862. }
  14863. inline Result ClientImpl::Patch(const std::string &path, const Params &params) {
  14864. return Patch(path, Headers(), params);
  14865. }
  14866. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  14867. ContentProvider content_provider,
  14868. const std::string &content_type,
  14869. UploadProgress progress) {
  14870. return Patch(path, Headers(), content_length, std::move(content_provider),
  14871. content_type, progress);
  14872. }
  14873. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  14874. ContentProvider content_provider,
  14875. const std::string &content_type,
  14876. ContentReceiver content_receiver,
  14877. UploadProgress progress) {
  14878. return Patch(path, Headers(), content_length, std::move(content_provider),
  14879. content_type, std::move(content_receiver), progress);
  14880. }
  14881. inline Result ClientImpl::Patch(const std::string &path,
  14882. ContentProviderWithoutLength content_provider,
  14883. const std::string &content_type,
  14884. UploadProgress progress) {
  14885. return Patch(path, Headers(), std::move(content_provider), content_type,
  14886. progress);
  14887. }
  14888. inline Result ClientImpl::Patch(const std::string &path,
  14889. ContentProviderWithoutLength content_provider,
  14890. const std::string &content_type,
  14891. ContentReceiver content_receiver,
  14892. UploadProgress progress) {
  14893. return Patch(path, Headers(), std::move(content_provider), content_type,
  14894. std::move(content_receiver), progress);
  14895. }
  14896. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14897. const Params &params) {
  14898. auto query = detail::params_to_query_str(params);
  14899. return Patch(path, headers, query, "application/x-www-form-urlencoded");
  14900. }
  14901. inline Result ClientImpl::Patch(const std::string &path,
  14902. const UploadFormDataItems &items,
  14903. UploadProgress progress) {
  14904. return Patch(path, Headers(), items, progress);
  14905. }
  14906. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14907. const UploadFormDataItems &items,
  14908. UploadProgress progress) {
  14909. const auto &boundary = detail::make_multipart_data_boundary();
  14910. const auto &content_type =
  14911. detail::serialize_multipart_formdata_get_content_type(boundary);
  14912. auto content_length = detail::get_multipart_content_length(items, boundary);
  14913. return Patch(path, headers, content_length,
  14914. detail::make_multipart_content_provider(items, boundary),
  14915. content_type, progress);
  14916. }
  14917. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14918. const UploadFormDataItems &items,
  14919. const std::string &boundary,
  14920. UploadProgress progress) {
  14921. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14922. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14923. }
  14924. const auto &content_type =
  14925. detail::serialize_multipart_formdata_get_content_type(boundary);
  14926. auto content_length = detail::get_multipart_content_length(items, boundary);
  14927. return Patch(path, headers, content_length,
  14928. detail::make_multipart_content_provider(items, boundary),
  14929. content_type, progress);
  14930. }
  14931. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14932. const char *body, size_t content_length,
  14933. const std::string &content_type,
  14934. UploadProgress progress) {
  14935. return send_with_content_provider_and_receiver(
  14936. "PATCH", path, headers, body, content_length, nullptr, nullptr,
  14937. content_type, nullptr, progress);
  14938. }
  14939. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14940. const std::string &body,
  14941. const std::string &content_type,
  14942. UploadProgress progress) {
  14943. return send_with_content_provider_and_receiver(
  14944. "PATCH", path, headers, body.data(), body.size(), nullptr, nullptr,
  14945. content_type, nullptr, progress);
  14946. }
  14947. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14948. size_t content_length,
  14949. ContentProvider content_provider,
  14950. const std::string &content_type,
  14951. UploadProgress progress) {
  14952. return send_with_content_provider_and_receiver(
  14953. "PATCH", path, headers, nullptr, content_length,
  14954. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14955. }
  14956. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14957. size_t content_length,
  14958. ContentProvider content_provider,
  14959. const std::string &content_type,
  14960. ContentReceiver content_receiver,
  14961. UploadProgress progress) {
  14962. return send_with_content_provider_and_receiver(
  14963. "PATCH", path, headers, nullptr, content_length,
  14964. std::move(content_provider), nullptr, content_type,
  14965. std::move(content_receiver), progress);
  14966. }
  14967. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14968. ContentProviderWithoutLength content_provider,
  14969. const std::string &content_type,
  14970. UploadProgress progress) {
  14971. return send_with_content_provider_and_receiver(
  14972. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14973. content_type, nullptr, progress);
  14974. }
  14975. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14976. ContentProviderWithoutLength content_provider,
  14977. const std::string &content_type,
  14978. ContentReceiver content_receiver,
  14979. UploadProgress progress) {
  14980. return send_with_content_provider_and_receiver(
  14981. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14982. content_type, std::move(content_receiver), progress);
  14983. }
  14984. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14985. const UploadFormDataItems &items,
  14986. const FormDataProviderItems &provider_items,
  14987. UploadProgress progress) {
  14988. const auto &boundary = detail::make_multipart_data_boundary();
  14989. const auto &content_type =
  14990. detail::serialize_multipart_formdata_get_content_type(boundary);
  14991. return send_with_content_provider_and_receiver(
  14992. "PATCH", path, headers, nullptr, 0, nullptr,
  14993. get_multipart_content_provider(boundary, items, provider_items),
  14994. content_type, nullptr, progress);
  14995. }
  14996. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14997. const std::string &body,
  14998. const std::string &content_type,
  14999. ContentReceiver content_receiver,
  15000. DownloadProgress progress) {
  15001. Request req;
  15002. req.method = "PATCH";
  15003. req.path = path;
  15004. req.headers = headers;
  15005. req.body = body;
  15006. req.content_receiver =
  15007. [content_receiver](const char *data, size_t data_length,
  15008. size_t /*offset*/, size_t /*total_length*/) {
  15009. return content_receiver(data, data_length);
  15010. };
  15011. req.download_progress = std::move(progress);
  15012. if (max_timeout_msec_ > 0) {
  15013. req.start_time_ = std::chrono::steady_clock::now();
  15014. }
  15015. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15016. return send_(std::move(req));
  15017. }
  15018. inline Result ClientImpl::Delete(const std::string &path,
  15019. DownloadProgress progress) {
  15020. return Delete(path, Headers(), std::string(), std::string(), progress);
  15021. }
  15022. inline Result ClientImpl::Delete(const std::string &path,
  15023. const Headers &headers,
  15024. DownloadProgress progress) {
  15025. return Delete(path, headers, std::string(), std::string(), progress);
  15026. }
  15027. inline Result ClientImpl::Delete(const std::string &path, const char *body,
  15028. size_t content_length,
  15029. const std::string &content_type,
  15030. DownloadProgress progress) {
  15031. return Delete(path, Headers(), body, content_length, content_type, progress);
  15032. }
  15033. inline Result ClientImpl::Delete(const std::string &path,
  15034. const std::string &body,
  15035. const std::string &content_type,
  15036. DownloadProgress progress) {
  15037. return Delete(path, Headers(), body.data(), body.size(), content_type,
  15038. progress);
  15039. }
  15040. inline Result ClientImpl::Delete(const std::string &path,
  15041. const Headers &headers,
  15042. const std::string &body,
  15043. const std::string &content_type,
  15044. DownloadProgress progress) {
  15045. return Delete(path, headers, body.data(), body.size(), content_type,
  15046. progress);
  15047. }
  15048. inline Result ClientImpl::Delete(const std::string &path, const Params &params,
  15049. DownloadProgress progress) {
  15050. return Delete(path, Headers(), params, progress);
  15051. }
  15052. inline Result ClientImpl::Delete(const std::string &path,
  15053. const Headers &headers, const Params &params,
  15054. DownloadProgress progress) {
  15055. auto query = detail::params_to_query_str(params);
  15056. return Delete(path, headers, query, "application/x-www-form-urlencoded",
  15057. progress);
  15058. }
  15059. inline Result ClientImpl::Delete(const std::string &path,
  15060. const Headers &headers, const char *body,
  15061. size_t content_length,
  15062. const std::string &content_type,
  15063. DownloadProgress progress) {
  15064. Request req;
  15065. req.method = "DELETE";
  15066. req.headers = headers;
  15067. req.path = path;
  15068. req.download_progress = std::move(progress);
  15069. if (max_timeout_msec_ > 0) {
  15070. req.start_time_ = std::chrono::steady_clock::now();
  15071. }
  15072. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15073. req.body.assign(body, content_length);
  15074. return send_(std::move(req));
  15075. }
  15076. inline Result ClientImpl::Options(const std::string &path) {
  15077. return Options(path, Headers());
  15078. }
  15079. inline Result ClientImpl::Options(const std::string &path,
  15080. const Headers &headers) {
  15081. Request req;
  15082. req.method = "OPTIONS";
  15083. req.headers = headers;
  15084. req.path = path;
  15085. if (max_timeout_msec_ > 0) {
  15086. req.start_time_ = std::chrono::steady_clock::now();
  15087. }
  15088. return send_(std::move(req));
  15089. }
  15090. inline void ClientImpl::stop() {
  15091. std::lock_guard<std::mutex> guard(socket_mutex_);
  15092. // If there is anything ongoing right now, the ONLY thread-safe thing we can
  15093. // do is to shutdown_socket, so that threads using this socket suddenly
  15094. // discover they can't read/write any more and error out. Everything else
  15095. // (closing the socket, shutting ssl down) is unsafe because these actions
  15096. // are not thread-safe.
  15097. if (socket_requests_in_flight_ > 0) {
  15098. shutdown_socket(socket_);
  15099. // Aside from that, we set a flag for the socket to be closed when we're
  15100. // done.
  15101. socket_should_be_closed_when_request_is_done_ = true;
  15102. return;
  15103. }
  15104. disconnect(/*gracefully=*/true);
  15105. }
  15106. inline std::string ClientImpl::host() const { return host_; }
  15107. inline int ClientImpl::port() const { return port_; }
  15108. inline size_t ClientImpl::is_socket_open() const {
  15109. std::lock_guard<std::mutex> guard(socket_mutex_);
  15110. return socket_.is_open();
  15111. }
  15112. inline socket_t ClientImpl::socket() const { return socket_.sock; }
  15113. inline void ClientImpl::set_connection_timeout(time_t sec, time_t usec) {
  15114. connection_timeout_sec_ = sec;
  15115. connection_timeout_usec_ = usec;
  15116. }
  15117. inline void ClientImpl::set_read_timeout(time_t sec, time_t usec) {
  15118. read_timeout_sec_ = sec;
  15119. read_timeout_usec_ = usec;
  15120. }
  15121. inline void ClientImpl::set_write_timeout(time_t sec, time_t usec) {
  15122. write_timeout_sec_ = sec;
  15123. write_timeout_usec_ = usec;
  15124. }
  15125. inline void ClientImpl::set_max_timeout(time_t msec) {
  15126. max_timeout_msec_ = msec;
  15127. }
  15128. inline void ClientImpl::set_basic_auth(const std::string &username,
  15129. const std::string &password) {
  15130. basic_auth_username_ = username;
  15131. basic_auth_password_ = password;
  15132. }
  15133. inline void ClientImpl::set_bearer_token_auth(const std::string &token) {
  15134. bearer_token_auth_token_ = token;
  15135. }
  15136. inline void ClientImpl::set_keep_alive(bool on) { keep_alive_ = on; }
  15137. inline void ClientImpl::set_follow_location(bool on) { follow_location_ = on; }
  15138. inline void ClientImpl::set_path_encode(bool on) { path_encode_ = on; }
  15139. inline void
  15140. ClientImpl::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15141. addr_map_ = std::move(addr_map);
  15142. }
  15143. inline void ClientImpl::set_default_headers(Headers headers) {
  15144. default_headers_ = std::move(headers);
  15145. }
  15146. inline void ClientImpl::set_header_writer(
  15147. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15148. header_writer_ = writer;
  15149. }
  15150. inline void ClientImpl::set_address_family(int family) {
  15151. address_family_ = family;
  15152. }
  15153. inline void ClientImpl::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  15154. inline void ClientImpl::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  15155. inline void ClientImpl::set_socket_options(SocketOptions socket_options) {
  15156. socket_options_ = std::move(socket_options);
  15157. }
  15158. inline void ClientImpl::set_compress(bool on) { compress_ = on; }
  15159. inline void ClientImpl::set_decompress(bool on) { decompress_ = on; }
  15160. inline void ClientImpl::set_payload_max_length(size_t length) {
  15161. payload_max_length_ = length;
  15162. has_payload_max_length_ = true;
  15163. }
  15164. inline void ClientImpl::set_interface(const std::string &intf) {
  15165. interface_ = intf;
  15166. }
  15167. inline void ClientImpl::set_proxy(const std::string &host, int port) {
  15168. proxy_host_ = host;
  15169. proxy_port_ = port;
  15170. std::lock_guard<std::mutex> guard(socket_mutex_);
  15171. disconnect(/*gracefully=*/true);
  15172. }
  15173. inline void ClientImpl::set_proxy_basic_auth(const std::string &username,
  15174. const std::string &password) {
  15175. proxy_basic_auth_username_ = username;
  15176. proxy_basic_auth_password_ = password;
  15177. }
  15178. inline void ClientImpl::set_proxy_bearer_token_auth(const std::string &token) {
  15179. proxy_bearer_token_auth_token_ = token;
  15180. }
  15181. inline void ClientImpl::set_no_proxy(const std::vector<std::string> &patterns) {
  15182. std::vector<detail::NoProxyEntry> parsed;
  15183. parsed.reserve(patterns.size());
  15184. for (const auto &p : patterns) {
  15185. auto trimmed = detail::trim_copy(p);
  15186. if (trimmed.empty()) { continue; }
  15187. detail::NoProxyEntry entry;
  15188. if (detail::parse_no_proxy_entry(trimmed, entry)) {
  15189. parsed.push_back(std::move(entry));
  15190. }
  15191. }
  15192. no_proxy_entries_ = std::move(parsed);
  15193. std::lock_guard<std::mutex> guard(socket_mutex_);
  15194. disconnect(/*gracefully=*/true);
  15195. }
  15196. #ifdef CPPHTTPLIB_SSL_ENABLED
  15197. inline void ClientImpl::set_digest_auth(const std::string &username,
  15198. const std::string &password) {
  15199. digest_auth_username_ = username;
  15200. digest_auth_password_ = password;
  15201. }
  15202. inline void ClientImpl::set_ca_cert_path(const std::string &ca_cert_file_path,
  15203. const std::string &ca_cert_dir_path) {
  15204. ca_cert_file_path_ = ca_cert_file_path;
  15205. ca_cert_dir_path_ = ca_cert_dir_path;
  15206. }
  15207. inline void ClientImpl::set_proxy_digest_auth(const std::string &username,
  15208. const std::string &password) {
  15209. proxy_digest_auth_username_ = username;
  15210. proxy_digest_auth_password_ = password;
  15211. }
  15212. inline void ClientImpl::enable_server_certificate_verification(bool enabled) {
  15213. server_certificate_verification_ = enabled;
  15214. }
  15215. inline void ClientImpl::enable_server_hostname_verification(bool enabled) {
  15216. server_hostname_verification_ = enabled;
  15217. }
  15218. inline void ClientImpl::enable_system_ca(bool enabled) {
  15219. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  15220. }
  15221. #endif
  15222. inline void ClientImpl::set_logger(Logger logger) {
  15223. logger_ = std::move(logger);
  15224. }
  15225. inline void ClientImpl::set_error_logger(ErrorLogger error_logger) {
  15226. error_logger_ = std::move(error_logger);
  15227. }
  15228. /*
  15229. * SSL/TLS Common Implementation
  15230. */
  15231. inline ClientConnection::~ClientConnection() {
  15232. #ifdef CPPHTTPLIB_SSL_ENABLED
  15233. if (session) {
  15234. tls::shutdown(session, true);
  15235. tls::free_session(session);
  15236. session = nullptr;
  15237. }
  15238. #endif
  15239. if (sock != INVALID_SOCKET) {
  15240. detail::close_socket(sock);
  15241. sock = INVALID_SOCKET;
  15242. }
  15243. }
  15244. // Universal client implementation
  15245. inline Client::Client(const std::string &scheme_host_port)
  15246. : Client(scheme_host_port, std::string(), std::string()) {}
  15247. inline Client::Client(const std::string &scheme_host_port,
  15248. const std::string &client_cert_path,
  15249. const std::string &client_key_path) {
  15250. detail::UrlComponents uc;
  15251. if (detail::parse_url(scheme_host_port, uc) && !uc.host.empty()) {
  15252. auto &scheme = uc.scheme;
  15253. #ifdef CPPHTTPLIB_SSL_ENABLED
  15254. if (!scheme.empty() && (scheme != "http" && scheme != "https")) {
  15255. #else
  15256. if (!scheme.empty() && scheme != "http") {
  15257. #endif
  15258. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  15259. std::string msg = "'" + scheme + "' scheme is not supported.";
  15260. throw std::invalid_argument(msg);
  15261. #endif
  15262. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15263. return;
  15264. }
  15265. auto is_ssl = scheme == "https";
  15266. auto host = std::move(uc.host);
  15267. auto port = is_ssl ? 443 : 80;
  15268. if (!uc.port.empty() && !detail::parse_port(uc.port, port)) {
  15269. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15270. return;
  15271. }
  15272. if (is_ssl) {
  15273. #ifdef CPPHTTPLIB_SSL_ENABLED
  15274. cli_ = detail::make_unique<SSLClient>(host, port, client_cert_path,
  15275. client_key_path);
  15276. is_ssl_ = is_ssl;
  15277. #endif
  15278. } else {
  15279. cli_ = detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15280. client_key_path);
  15281. }
  15282. } else if (scheme_host_port.find("//") != std::string::npos) {
  15283. // A URL, but not one this client can use, such as one with userinfo
  15284. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15285. } else {
  15286. // NOTE: Update TEST(UniversalClientImplTest, Ipv6LiteralAddress)
  15287. // if port param below changes.
  15288. cli_ = detail::make_unique<ClientImpl>(scheme_host_port, 80,
  15289. client_cert_path, client_key_path);
  15290. }
  15291. }
  15292. inline Client::Client(const std::string &host, int port)
  15293. : Client(host, port, std::string(), std::string()) {}
  15294. inline Client::Client(const std::string &host, int port,
  15295. const std::string &client_cert_path,
  15296. const std::string &client_key_path)
  15297. : cli_(detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15298. client_key_path)) {}
  15299. inline Client::~Client() = default;
  15300. inline bool Client::is_valid() const {
  15301. return cli_ != nullptr && cli_->is_valid();
  15302. }
  15303. inline Result Client::Get(const std::string &path, DownloadProgress progress) {
  15304. return cli_->Get(path, std::move(progress));
  15305. }
  15306. inline Result Client::Get(const std::string &path, const Headers &headers,
  15307. DownloadProgress progress) {
  15308. return cli_->Get(path, headers, std::move(progress));
  15309. }
  15310. inline Result Client::Get(const std::string &path,
  15311. ContentReceiver content_receiver,
  15312. DownloadProgress progress) {
  15313. return cli_->Get(path, std::move(content_receiver), std::move(progress));
  15314. }
  15315. inline Result Client::Get(const std::string &path, const Headers &headers,
  15316. ContentReceiver content_receiver,
  15317. DownloadProgress progress) {
  15318. return cli_->Get(path, headers, std::move(content_receiver),
  15319. std::move(progress));
  15320. }
  15321. inline Result Client::Get(const std::string &path,
  15322. ResponseHandler response_handler,
  15323. ContentReceiver content_receiver,
  15324. DownloadProgress progress) {
  15325. return cli_->Get(path, std::move(response_handler),
  15326. std::move(content_receiver), std::move(progress));
  15327. }
  15328. inline Result Client::Get(const std::string &path, const Headers &headers,
  15329. ResponseHandler response_handler,
  15330. ContentReceiver content_receiver,
  15331. DownloadProgress progress) {
  15332. return cli_->Get(path, headers, std::move(response_handler),
  15333. std::move(content_receiver), std::move(progress));
  15334. }
  15335. inline Result Client::Get(const std::string &path, const Params &params,
  15336. DownloadProgress progress) {
  15337. return cli_->Get(path, params, std::move(progress));
  15338. }
  15339. inline Result Client::Get(const std::string &path, const Params &params,
  15340. const Headers &headers, DownloadProgress progress) {
  15341. return cli_->Get(path, params, headers, std::move(progress));
  15342. }
  15343. inline Result Client::Get(const std::string &path, const Params &params,
  15344. const Headers &headers,
  15345. ContentReceiver content_receiver,
  15346. DownloadProgress progress) {
  15347. return cli_->Get(path, params, headers, std::move(content_receiver),
  15348. std::move(progress));
  15349. }
  15350. inline Result Client::Get(const std::string &path, const Params &params,
  15351. const Headers &headers,
  15352. ResponseHandler response_handler,
  15353. ContentReceiver content_receiver,
  15354. DownloadProgress progress) {
  15355. return cli_->Get(path, params, headers, std::move(response_handler),
  15356. std::move(content_receiver), std::move(progress));
  15357. }
  15358. inline Result Client::Head(const std::string &path) { return cli_->Head(path); }
  15359. inline Result Client::Head(const std::string &path, const Headers &headers) {
  15360. return cli_->Head(path, headers);
  15361. }
  15362. inline Result Client::Post(const std::string &path) { return cli_->Post(path); }
  15363. inline Result Client::Post(const std::string &path, const Headers &headers) {
  15364. return cli_->Post(path, headers);
  15365. }
  15366. inline Result Client::Post(const std::string &path, const char *body,
  15367. size_t content_length,
  15368. const std::string &content_type,
  15369. UploadProgress progress) {
  15370. return cli_->Post(path, body, content_length, content_type, progress);
  15371. }
  15372. inline Result Client::Post(const std::string &path, const Headers &headers,
  15373. const char *body, size_t content_length,
  15374. const std::string &content_type,
  15375. UploadProgress progress) {
  15376. return cli_->Post(path, headers, body, content_length, content_type,
  15377. progress);
  15378. }
  15379. inline Result Client::Post(const std::string &path, const std::string &body,
  15380. const std::string &content_type,
  15381. UploadProgress progress) {
  15382. return cli_->Post(path, body, content_type, progress);
  15383. }
  15384. inline Result Client::Post(const std::string &path, const Headers &headers,
  15385. const std::string &body,
  15386. const std::string &content_type,
  15387. UploadProgress progress) {
  15388. return cli_->Post(path, headers, body, content_type, progress);
  15389. }
  15390. inline Result Client::Post(const std::string &path, size_t content_length,
  15391. ContentProvider content_provider,
  15392. const std::string &content_type,
  15393. UploadProgress progress) {
  15394. return cli_->Post(path, content_length, std::move(content_provider),
  15395. content_type, progress);
  15396. }
  15397. inline Result Client::Post(const std::string &path, size_t content_length,
  15398. ContentProvider content_provider,
  15399. const std::string &content_type,
  15400. ContentReceiver content_receiver,
  15401. UploadProgress progress) {
  15402. return cli_->Post(path, content_length, std::move(content_provider),
  15403. content_type, std::move(content_receiver), progress);
  15404. }
  15405. inline Result Client::Post(const std::string &path,
  15406. ContentProviderWithoutLength content_provider,
  15407. const std::string &content_type,
  15408. UploadProgress progress) {
  15409. return cli_->Post(path, std::move(content_provider), content_type, progress);
  15410. }
  15411. inline Result Client::Post(const std::string &path,
  15412. ContentProviderWithoutLength content_provider,
  15413. const std::string &content_type,
  15414. ContentReceiver content_receiver,
  15415. UploadProgress progress) {
  15416. return cli_->Post(path, std::move(content_provider), content_type,
  15417. std::move(content_receiver), progress);
  15418. }
  15419. inline Result Client::Post(const std::string &path, const Headers &headers,
  15420. size_t content_length,
  15421. ContentProvider content_provider,
  15422. const std::string &content_type,
  15423. UploadProgress progress) {
  15424. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15425. content_type, progress);
  15426. }
  15427. inline Result Client::Post(const std::string &path, const Headers &headers,
  15428. size_t content_length,
  15429. ContentProvider content_provider,
  15430. const std::string &content_type,
  15431. ContentReceiver content_receiver,
  15432. DownloadProgress progress) {
  15433. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15434. content_type, std::move(content_receiver), progress);
  15435. }
  15436. inline Result Client::Post(const std::string &path, const Headers &headers,
  15437. ContentProviderWithoutLength content_provider,
  15438. const std::string &content_type,
  15439. UploadProgress progress) {
  15440. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15441. progress);
  15442. }
  15443. inline Result Client::Post(const std::string &path, const Headers &headers,
  15444. ContentProviderWithoutLength content_provider,
  15445. const std::string &content_type,
  15446. ContentReceiver content_receiver,
  15447. DownloadProgress progress) {
  15448. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15449. std::move(content_receiver), progress);
  15450. }
  15451. inline Result Client::Post(const std::string &path, const Params &params) {
  15452. return cli_->Post(path, params);
  15453. }
  15454. inline Result Client::Post(const std::string &path, const Headers &headers,
  15455. const Params &params) {
  15456. return cli_->Post(path, headers, params);
  15457. }
  15458. inline Result Client::Post(const std::string &path,
  15459. const UploadFormDataItems &items,
  15460. UploadProgress progress) {
  15461. return cli_->Post(path, items, progress);
  15462. }
  15463. inline Result Client::Post(const std::string &path, const Headers &headers,
  15464. const UploadFormDataItems &items,
  15465. UploadProgress progress) {
  15466. return cli_->Post(path, headers, items, progress);
  15467. }
  15468. inline Result Client::Post(const std::string &path, const Headers &headers,
  15469. const UploadFormDataItems &items,
  15470. const std::string &boundary,
  15471. UploadProgress progress) {
  15472. return cli_->Post(path, headers, items, boundary, progress);
  15473. }
  15474. inline Result Client::Post(const std::string &path, const Headers &headers,
  15475. const UploadFormDataItems &items,
  15476. const FormDataProviderItems &provider_items,
  15477. UploadProgress progress) {
  15478. return cli_->Post(path, headers, items, provider_items, progress);
  15479. }
  15480. inline Result Client::Post(const std::string &path, const Headers &headers,
  15481. const std::string &body,
  15482. const std::string &content_type,
  15483. ContentReceiver content_receiver,
  15484. DownloadProgress progress) {
  15485. return cli_->Post(path, headers, body, content_type,
  15486. std::move(content_receiver), progress);
  15487. }
  15488. inline Result Client::Put(const std::string &path) { return cli_->Put(path); }
  15489. inline Result Client::Put(const std::string &path, const Headers &headers) {
  15490. return cli_->Put(path, headers);
  15491. }
  15492. inline Result Client::Put(const std::string &path, const char *body,
  15493. size_t content_length,
  15494. const std::string &content_type,
  15495. UploadProgress progress) {
  15496. return cli_->Put(path, body, content_length, content_type, progress);
  15497. }
  15498. inline Result Client::Put(const std::string &path, const Headers &headers,
  15499. const char *body, size_t content_length,
  15500. const std::string &content_type,
  15501. UploadProgress progress) {
  15502. return cli_->Put(path, headers, body, content_length, content_type, progress);
  15503. }
  15504. inline Result Client::Put(const std::string &path, const std::string &body,
  15505. const std::string &content_type,
  15506. UploadProgress progress) {
  15507. return cli_->Put(path, body, content_type, progress);
  15508. }
  15509. inline Result Client::Put(const std::string &path, const Headers &headers,
  15510. const std::string &body,
  15511. const std::string &content_type,
  15512. UploadProgress progress) {
  15513. return cli_->Put(path, headers, body, content_type, progress);
  15514. }
  15515. inline Result Client::Put(const std::string &path, size_t content_length,
  15516. ContentProvider content_provider,
  15517. const std::string &content_type,
  15518. UploadProgress progress) {
  15519. return cli_->Put(path, content_length, std::move(content_provider),
  15520. content_type, progress);
  15521. }
  15522. inline Result Client::Put(const std::string &path, size_t content_length,
  15523. ContentProvider content_provider,
  15524. const std::string &content_type,
  15525. ContentReceiver content_receiver,
  15526. UploadProgress progress) {
  15527. return cli_->Put(path, content_length, std::move(content_provider),
  15528. content_type, std::move(content_receiver), progress);
  15529. }
  15530. inline Result Client::Put(const std::string &path,
  15531. ContentProviderWithoutLength content_provider,
  15532. const std::string &content_type,
  15533. UploadProgress progress) {
  15534. return cli_->Put(path, std::move(content_provider), content_type, progress);
  15535. }
  15536. inline Result Client::Put(const std::string &path,
  15537. ContentProviderWithoutLength content_provider,
  15538. const std::string &content_type,
  15539. ContentReceiver content_receiver,
  15540. UploadProgress progress) {
  15541. return cli_->Put(path, std::move(content_provider), content_type,
  15542. std::move(content_receiver), progress);
  15543. }
  15544. inline Result Client::Put(const std::string &path, const Headers &headers,
  15545. size_t content_length,
  15546. ContentProvider content_provider,
  15547. const std::string &content_type,
  15548. UploadProgress progress) {
  15549. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15550. content_type, progress);
  15551. }
  15552. inline Result Client::Put(const std::string &path, const Headers &headers,
  15553. size_t content_length,
  15554. ContentProvider content_provider,
  15555. const std::string &content_type,
  15556. ContentReceiver content_receiver,
  15557. UploadProgress progress) {
  15558. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15559. content_type, std::move(content_receiver), progress);
  15560. }
  15561. inline Result Client::Put(const std::string &path, const Headers &headers,
  15562. ContentProviderWithoutLength content_provider,
  15563. const std::string &content_type,
  15564. UploadProgress progress) {
  15565. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15566. progress);
  15567. }
  15568. inline Result Client::Put(const std::string &path, const Headers &headers,
  15569. ContentProviderWithoutLength content_provider,
  15570. const std::string &content_type,
  15571. ContentReceiver content_receiver,
  15572. UploadProgress progress) {
  15573. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15574. std::move(content_receiver), progress);
  15575. }
  15576. inline Result Client::Put(const std::string &path, const Params &params) {
  15577. return cli_->Put(path, params);
  15578. }
  15579. inline Result Client::Put(const std::string &path, const Headers &headers,
  15580. const Params &params) {
  15581. return cli_->Put(path, headers, params);
  15582. }
  15583. inline Result Client::Put(const std::string &path,
  15584. const UploadFormDataItems &items,
  15585. UploadProgress progress) {
  15586. return cli_->Put(path, items, progress);
  15587. }
  15588. inline Result Client::Put(const std::string &path, const Headers &headers,
  15589. const UploadFormDataItems &items,
  15590. UploadProgress progress) {
  15591. return cli_->Put(path, headers, items, progress);
  15592. }
  15593. inline Result Client::Put(const std::string &path, const Headers &headers,
  15594. const UploadFormDataItems &items,
  15595. const std::string &boundary,
  15596. UploadProgress progress) {
  15597. return cli_->Put(path, headers, items, boundary, progress);
  15598. }
  15599. inline Result Client::Put(const std::string &path, const Headers &headers,
  15600. const UploadFormDataItems &items,
  15601. const FormDataProviderItems &provider_items,
  15602. UploadProgress progress) {
  15603. return cli_->Put(path, headers, items, provider_items, progress);
  15604. }
  15605. inline Result Client::Put(const std::string &path, const Headers &headers,
  15606. const std::string &body,
  15607. const std::string &content_type,
  15608. ContentReceiver content_receiver,
  15609. DownloadProgress progress) {
  15610. return cli_->Put(path, headers, body, content_type, content_receiver,
  15611. progress);
  15612. }
  15613. inline Result Client::Patch(const std::string &path) {
  15614. return cli_->Patch(path);
  15615. }
  15616. inline Result Client::Patch(const std::string &path, const Headers &headers) {
  15617. return cli_->Patch(path, headers);
  15618. }
  15619. inline Result Client::Patch(const std::string &path, const char *body,
  15620. size_t content_length,
  15621. const std::string &content_type,
  15622. UploadProgress progress) {
  15623. return cli_->Patch(path, body, content_length, content_type, progress);
  15624. }
  15625. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15626. const char *body, size_t content_length,
  15627. const std::string &content_type,
  15628. UploadProgress progress) {
  15629. return cli_->Patch(path, headers, body, content_length, content_type,
  15630. progress);
  15631. }
  15632. inline Result Client::Patch(const std::string &path, const std::string &body,
  15633. const std::string &content_type,
  15634. UploadProgress progress) {
  15635. return cli_->Patch(path, body, content_type, progress);
  15636. }
  15637. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15638. const std::string &body,
  15639. const std::string &content_type,
  15640. UploadProgress progress) {
  15641. return cli_->Patch(path, headers, body, content_type, progress);
  15642. }
  15643. inline Result Client::Patch(const std::string &path, size_t content_length,
  15644. ContentProvider content_provider,
  15645. const std::string &content_type,
  15646. UploadProgress progress) {
  15647. return cli_->Patch(path, content_length, std::move(content_provider),
  15648. content_type, progress);
  15649. }
  15650. inline Result Client::Patch(const std::string &path, size_t content_length,
  15651. ContentProvider content_provider,
  15652. const std::string &content_type,
  15653. ContentReceiver content_receiver,
  15654. UploadProgress progress) {
  15655. return cli_->Patch(path, content_length, std::move(content_provider),
  15656. content_type, std::move(content_receiver), progress);
  15657. }
  15658. inline Result Client::Patch(const std::string &path,
  15659. ContentProviderWithoutLength content_provider,
  15660. const std::string &content_type,
  15661. UploadProgress progress) {
  15662. return cli_->Patch(path, std::move(content_provider), content_type, progress);
  15663. }
  15664. inline Result Client::Patch(const std::string &path,
  15665. ContentProviderWithoutLength content_provider,
  15666. const std::string &content_type,
  15667. ContentReceiver content_receiver,
  15668. UploadProgress progress) {
  15669. return cli_->Patch(path, std::move(content_provider), content_type,
  15670. std::move(content_receiver), progress);
  15671. }
  15672. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15673. size_t content_length,
  15674. ContentProvider content_provider,
  15675. const std::string &content_type,
  15676. UploadProgress progress) {
  15677. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15678. content_type, progress);
  15679. }
  15680. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15681. size_t content_length,
  15682. ContentProvider content_provider,
  15683. const std::string &content_type,
  15684. ContentReceiver content_receiver,
  15685. UploadProgress progress) {
  15686. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15687. content_type, std::move(content_receiver), progress);
  15688. }
  15689. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15690. ContentProviderWithoutLength content_provider,
  15691. const std::string &content_type,
  15692. UploadProgress progress) {
  15693. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15694. progress);
  15695. }
  15696. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15697. ContentProviderWithoutLength content_provider,
  15698. const std::string &content_type,
  15699. ContentReceiver content_receiver,
  15700. UploadProgress progress) {
  15701. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15702. std::move(content_receiver), progress);
  15703. }
  15704. inline Result Client::Patch(const std::string &path, const Params &params) {
  15705. return cli_->Patch(path, params);
  15706. }
  15707. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15708. const Params &params) {
  15709. return cli_->Patch(path, headers, params);
  15710. }
  15711. inline Result Client::Patch(const std::string &path,
  15712. const UploadFormDataItems &items,
  15713. UploadProgress progress) {
  15714. return cli_->Patch(path, items, progress);
  15715. }
  15716. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15717. const UploadFormDataItems &items,
  15718. UploadProgress progress) {
  15719. return cli_->Patch(path, headers, items, progress);
  15720. }
  15721. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15722. const UploadFormDataItems &items,
  15723. const std::string &boundary,
  15724. UploadProgress progress) {
  15725. return cli_->Patch(path, headers, items, boundary, progress);
  15726. }
  15727. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15728. const UploadFormDataItems &items,
  15729. const FormDataProviderItems &provider_items,
  15730. UploadProgress progress) {
  15731. return cli_->Patch(path, headers, items, provider_items, progress);
  15732. }
  15733. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15734. const std::string &body,
  15735. const std::string &content_type,
  15736. ContentReceiver content_receiver,
  15737. DownloadProgress progress) {
  15738. return cli_->Patch(path, headers, body, content_type, content_receiver,
  15739. progress);
  15740. }
  15741. inline Result Client::Delete(const std::string &path,
  15742. DownloadProgress progress) {
  15743. return cli_->Delete(path, progress);
  15744. }
  15745. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15746. DownloadProgress progress) {
  15747. return cli_->Delete(path, headers, progress);
  15748. }
  15749. inline Result Client::Delete(const std::string &path, const char *body,
  15750. size_t content_length,
  15751. const std::string &content_type,
  15752. DownloadProgress progress) {
  15753. return cli_->Delete(path, body, content_length, content_type, progress);
  15754. }
  15755. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15756. const char *body, size_t content_length,
  15757. const std::string &content_type,
  15758. DownloadProgress progress) {
  15759. return cli_->Delete(path, headers, body, content_length, content_type,
  15760. progress);
  15761. }
  15762. inline Result Client::Delete(const std::string &path, const std::string &body,
  15763. const std::string &content_type,
  15764. DownloadProgress progress) {
  15765. return cli_->Delete(path, body, content_type, progress);
  15766. }
  15767. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15768. const std::string &body,
  15769. const std::string &content_type,
  15770. DownloadProgress progress) {
  15771. return cli_->Delete(path, headers, body, content_type, progress);
  15772. }
  15773. inline Result Client::Delete(const std::string &path, const Params &params,
  15774. DownloadProgress progress) {
  15775. return cli_->Delete(path, params, progress);
  15776. }
  15777. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15778. const Params &params, DownloadProgress progress) {
  15779. return cli_->Delete(path, headers, params, progress);
  15780. }
  15781. inline Result Client::Options(const std::string &path) {
  15782. return cli_->Options(path);
  15783. }
  15784. inline Result Client::Options(const std::string &path, const Headers &headers) {
  15785. return cli_->Options(path, headers);
  15786. }
  15787. inline ClientImpl::StreamHandle
  15788. Client::open_stream(const std::string &method, const std::string &path,
  15789. const Params &params, const Headers &headers,
  15790. const std::string &body, const std::string &content_type) {
  15791. return cli_->open_stream(method, path, params, headers, body, content_type);
  15792. }
  15793. inline bool Client::send(Request &req, Response &res, Error &error) {
  15794. return cli_->send(req, res, error);
  15795. }
  15796. inline Result Client::send(const Request &req) { return cli_->send(req); }
  15797. inline void Client::stop() { cli_->stop(); }
  15798. inline std::string Client::host() const { return cli_->host(); }
  15799. inline int Client::port() const { return cli_->port(); }
  15800. inline size_t Client::is_socket_open() const { return cli_->is_socket_open(); }
  15801. inline socket_t Client::socket() const { return cli_->socket(); }
  15802. inline void
  15803. Client::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15804. cli_->set_hostname_addr_map(std::move(addr_map));
  15805. }
  15806. inline void Client::set_default_headers(Headers headers) {
  15807. cli_->set_default_headers(std::move(headers));
  15808. }
  15809. inline void Client::set_header_writer(
  15810. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15811. cli_->set_header_writer(writer);
  15812. }
  15813. inline void Client::set_address_family(int family) {
  15814. cli_->set_address_family(family);
  15815. }
  15816. inline void Client::set_tcp_nodelay(bool on) { cli_->set_tcp_nodelay(on); }
  15817. inline void Client::set_socket_options(SocketOptions socket_options) {
  15818. cli_->set_socket_options(std::move(socket_options));
  15819. }
  15820. inline void Client::set_connection_timeout(time_t sec, time_t usec) {
  15821. cli_->set_connection_timeout(sec, usec);
  15822. }
  15823. inline void Client::set_read_timeout(time_t sec, time_t usec) {
  15824. cli_->set_read_timeout(sec, usec);
  15825. }
  15826. inline void Client::set_write_timeout(time_t sec, time_t usec) {
  15827. cli_->set_write_timeout(sec, usec);
  15828. }
  15829. inline void Client::set_basic_auth(const std::string &username,
  15830. const std::string &password) {
  15831. cli_->set_basic_auth(username, password);
  15832. }
  15833. inline void Client::set_bearer_token_auth(const std::string &token) {
  15834. cli_->set_bearer_token_auth(token);
  15835. }
  15836. inline void Client::set_keep_alive(bool on) { cli_->set_keep_alive(on); }
  15837. inline void Client::set_follow_location(bool on) {
  15838. cli_->set_follow_location(on);
  15839. }
  15840. inline void Client::set_path_encode(bool on) { cli_->set_path_encode(on); }
  15841. inline void Client::set_compress(bool on) { cli_->set_compress(on); }
  15842. inline void Client::set_decompress(bool on) { cli_->set_decompress(on); }
  15843. inline void Client::set_payload_max_length(size_t length) {
  15844. cli_->set_payload_max_length(length);
  15845. }
  15846. inline void Client::set_interface(const std::string &intf) {
  15847. cli_->set_interface(intf);
  15848. }
  15849. inline void Client::set_proxy(const std::string &host, int port) {
  15850. cli_->set_proxy(host, port);
  15851. }
  15852. inline void Client::set_proxy_basic_auth(const std::string &username,
  15853. const std::string &password) {
  15854. cli_->set_proxy_basic_auth(username, password);
  15855. }
  15856. inline void Client::set_proxy_bearer_token_auth(const std::string &token) {
  15857. cli_->set_proxy_bearer_token_auth(token);
  15858. }
  15859. inline void Client::set_no_proxy(const std::vector<std::string> &patterns) {
  15860. cli_->set_no_proxy(patterns);
  15861. }
  15862. inline void Client::set_logger(Logger logger) {
  15863. cli_->set_logger(std::move(logger));
  15864. }
  15865. inline void Client::set_error_logger(ErrorLogger error_logger) {
  15866. cli_->set_error_logger(std::move(error_logger));
  15867. }
  15868. /*
  15869. * Group 6: SSL Server and Client implementation
  15870. */
  15871. #ifdef CPPHTTPLIB_SSL_ENABLED
  15872. // SSL HTTP server implementation
  15873. inline SSLServer::SSLServer(const char *cert_path, const char *private_key_path,
  15874. const char *client_ca_cert_file_path,
  15875. const char *client_ca_cert_dir_path,
  15876. const char *private_key_password) {
  15877. using namespace tls;
  15878. ctx_ = create_server_context();
  15879. if (!ctx_) { return; }
  15880. // Load server certificate and private key
  15881. if (!set_server_cert_file(ctx_, cert_path, private_key_path,
  15882. private_key_password)) {
  15883. last_ssl_error_ = static_cast<int>(get_error());
  15884. free_context(ctx_);
  15885. ctx_ = nullptr;
  15886. return;
  15887. }
  15888. // Load client CA certificates for client authentication
  15889. if (client_ca_cert_file_path || client_ca_cert_dir_path) {
  15890. if (!set_client_ca_file(ctx_, client_ca_cert_file_path,
  15891. client_ca_cert_dir_path)) {
  15892. last_ssl_error_ = static_cast<int>(get_error());
  15893. free_context(ctx_);
  15894. ctx_ = nullptr;
  15895. return;
  15896. }
  15897. // Enable client certificate verification
  15898. set_verify_client(ctx_, true);
  15899. }
  15900. }
  15901. inline SSLServer::SSLServer(const PemMemory &pem) {
  15902. using namespace tls;
  15903. ctx_ = create_server_context();
  15904. if (ctx_) {
  15905. if (!set_server_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  15906. pem.private_key_password)) {
  15907. last_ssl_error_ = static_cast<int>(get_error());
  15908. free_context(ctx_);
  15909. ctx_ = nullptr;
  15910. } else if (pem.client_ca_pem && pem.client_ca_pem_len > 0) {
  15911. if (!load_ca_pem(ctx_, pem.client_ca_pem, pem.client_ca_pem_len)) {
  15912. last_ssl_error_ = static_cast<int>(get_error());
  15913. free_context(ctx_);
  15914. ctx_ = nullptr;
  15915. } else {
  15916. set_verify_client(ctx_, true);
  15917. }
  15918. }
  15919. }
  15920. }
  15921. inline SSLServer::SSLServer(const tls::ContextSetupCallback &setup_callback) {
  15922. using namespace tls;
  15923. ctx_ = create_server_context();
  15924. if (ctx_) {
  15925. if (!setup_callback(ctx_)) {
  15926. free_context(ctx_);
  15927. ctx_ = nullptr;
  15928. }
  15929. }
  15930. }
  15931. inline SSLServer::~SSLServer() {
  15932. if (ctx_) { tls::free_context(ctx_); }
  15933. }
  15934. inline bool SSLServer::is_valid() const {
  15935. return ctx_ != nullptr && Server::is_valid();
  15936. }
  15937. inline bool SSLServer::process_and_close_socket(socket_t sock) {
  15938. using namespace tls;
  15939. session_t session = nullptr;
  15940. {
  15941. std::unique_lock<std::mutex> lock(ctx_mutex_);
  15942. ctx_cv_.wait(lock, [&] { return updates_pending_ == 0; });
  15943. session = create_session(static_cast<ctx_t>(ctx_), sock);
  15944. if (session) { handshakes_in_progress_++; }
  15945. }
  15946. if (!session) {
  15947. last_ssl_error_ = static_cast<int>(get_error());
  15948. detail::shutdown_socket(sock);
  15949. detail::close_socket(sock);
  15950. return false;
  15951. }
  15952. // Use scope_exit to ensure cleanup on all paths (including exceptions)
  15953. bool handshake_done = false;
  15954. bool ret = false;
  15955. bool websocket_upgraded = false;
  15956. auto cleanup = detail::scope_exit([&] {
  15957. if (handshake_done) { shutdown(session, !websocket_upgraded && ret); }
  15958. free_session(session);
  15959. detail::shutdown_socket(sock);
  15960. detail::close_socket(sock);
  15961. });
  15962. // Perform TLS accept handshake with timeout
  15963. TlsError tls_err;
  15964. auto accepted = accept_nonblocking(session, sock, read_timeout_sec_,
  15965. read_timeout_usec_, &tls_err);
  15966. {
  15967. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15968. if (--handshakes_in_progress_ == 0) { ctx_cv_.notify_all(); }
  15969. }
  15970. if (!accepted) {
  15971. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  15972. // Map TlsError to legacy ssl_error for backward compatibility
  15973. if (tls_err.code == ErrorCode::WantRead) {
  15974. last_ssl_error_ = SSL_ERROR_WANT_READ;
  15975. } else if (tls_err.code == ErrorCode::WantWrite) {
  15976. last_ssl_error_ = SSL_ERROR_WANT_WRITE;
  15977. } else {
  15978. last_ssl_error_ = SSL_ERROR_SSL;
  15979. }
  15980. #else
  15981. last_ssl_error_ = static_cast<int>(get_error());
  15982. #endif
  15983. return false;
  15984. }
  15985. handshake_done = true;
  15986. std::string remote_addr;
  15987. int remote_port = 0;
  15988. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  15989. std::string local_addr;
  15990. int local_port = 0;
  15991. detail::get_local_ip_and_port(sock, local_addr, local_port);
  15992. ret = serve_guarded([&]() {
  15993. return detail::process_server_socket_ssl(
  15994. svr_sock_, session, sock, keep_alive_max_count_,
  15995. keep_alive_timeout_sec_, read_timeout_sec_, read_timeout_usec_,
  15996. write_timeout_sec_, write_timeout_usec_,
  15997. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  15998. return process_request(
  15999. strm, remote_addr, remote_port, local_addr, local_port,
  16000. close_connection, connection_closed,
  16001. [&](Request &req) { req.ssl = session; }, &websocket_upgraded);
  16002. });
  16003. });
  16004. return ret;
  16005. }
  16006. inline bool SSLServer::update_certs_pem(const char *cert_pem,
  16007. const char *key_pem,
  16008. const char *client_ca_pem,
  16009. const char *password) {
  16010. if (!ctx_) { return false; }
  16011. std::unique_lock<std::mutex> lock(ctx_mutex_);
  16012. updates_pending_++;
  16013. auto se = detail::scope_exit([&] {
  16014. if (--updates_pending_ == 0) { ctx_cv_.notify_all(); }
  16015. });
  16016. ctx_cv_.wait(lock, [&] { return handshakes_in_progress_ == 0; });
  16017. if (!tls::update_server_cert(ctx_, cert_pem, key_pem, password)) {
  16018. return false;
  16019. }
  16020. if (client_ca_pem) {
  16021. return tls::update_server_client_ca(ctx_, client_ca_pem);
  16022. }
  16023. return true;
  16024. }
  16025. // SSL HTTP client implementation
  16026. inline SSLClient::~SSLClient() {
  16027. // Make sure to shut down SSL since shutdown_ssl will resolve to the
  16028. // base function rather than the derived function once we get to the
  16029. // base class destructor, and won't free the SSL (causing a leak).
  16030. // This must happen before the context is freed below: some backends
  16031. // (e.g. mbedTLS) have the SSL session borrow a raw pointer into the
  16032. // context, so freeing the context first leaves close_notify reading
  16033. // freed memory.
  16034. shutdown_ssl_impl(socket_, true);
  16035. if (ctx_) {
  16036. tls::free_context(ctx_);
  16037. ctx_ = nullptr;
  16038. }
  16039. }
  16040. inline bool SSLClient::is_valid() const { return ctx_ != nullptr; }
  16041. inline void SSLClient::shutdown_ssl(Socket &socket, bool shutdown_gracefully) {
  16042. shutdown_ssl_impl(socket, shutdown_gracefully);
  16043. }
  16044. inline void SSLClient::shutdown_ssl_impl(Socket &socket,
  16045. bool shutdown_gracefully) {
  16046. if (socket.sock == INVALID_SOCKET) {
  16047. assert(socket.ssl == nullptr);
  16048. return;
  16049. }
  16050. if (socket.ssl) {
  16051. tls::shutdown(socket.ssl, shutdown_gracefully);
  16052. {
  16053. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16054. tls::free_session(socket.ssl);
  16055. }
  16056. socket.ssl = nullptr;
  16057. }
  16058. assert(socket.ssl == nullptr);
  16059. }
  16060. inline bool SSLClient::process_socket(
  16061. const Socket &socket,
  16062. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16063. std::function<bool(Stream &strm)> callback) {
  16064. assert(socket.ssl);
  16065. return detail::process_client_socket_ssl(
  16066. socket.ssl, socket.sock, read_timeout_sec_, read_timeout_usec_,
  16067. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_, start_time,
  16068. std::move(callback));
  16069. }
  16070. inline bool SSLClient::is_ssl() const { return true; }
  16071. inline bool SSLClient::create_and_connect_socket(Socket &socket, Error &error) {
  16072. if (!is_valid()) {
  16073. error = Error::SSLConnection;
  16074. return false;
  16075. }
  16076. return ClientImpl::create_and_connect_socket(socket, error);
  16077. }
  16078. inline bool SSLClient::setup_proxy_connection(
  16079. Socket &socket,
  16080. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16081. Response &res, bool &success, Error &error) {
  16082. if (!is_proxy_enabled_for_host(host_)) { return true; }
  16083. if (!connect_with_proxy(socket, start_time, res, success, error)) {
  16084. return false;
  16085. }
  16086. if (!initialize_ssl(socket, error)) {
  16087. success = false;
  16088. return false;
  16089. }
  16090. return true;
  16091. }
  16092. // Assumes that socket_mutex_ is locked and that there are no requests in
  16093. // flight
  16094. inline bool SSLClient::connect_with_proxy(
  16095. Socket &socket,
  16096. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16097. Response &res, bool &success, Error &error) {
  16098. success = true;
  16099. Response proxy_res;
  16100. if (!detail::process_client_socket(
  16101. socket.sock, read_timeout_sec_, read_timeout_usec_,
  16102. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  16103. start_time, [&](Stream &strm) {
  16104. Request req2;
  16105. req2.method = "CONNECT";
  16106. req2.path =
  16107. detail::make_host_and_port_string_always_port(host_, port_);
  16108. if (max_timeout_msec_ > 0) {
  16109. req2.start_time_ = std::chrono::steady_clock::now();
  16110. }
  16111. return process_request(strm, req2, proxy_res, false, error);
  16112. })) {
  16113. // Thread-safe to close everything because we are assuming there are no
  16114. // requests in flight
  16115. shutdown_ssl(socket, true);
  16116. shutdown_socket(socket);
  16117. close_socket(socket);
  16118. success = false;
  16119. return false;
  16120. }
  16121. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  16122. if (!proxy_digest_auth_username_.empty() &&
  16123. !proxy_digest_auth_password_.empty()) {
  16124. std::map<std::string, std::string> auth;
  16125. if (detail::parse_www_authenticate(proxy_res, auth, true)) {
  16126. // Close the current socket and create a new one for the authenticated
  16127. // request
  16128. shutdown_ssl(socket, true);
  16129. shutdown_socket(socket);
  16130. close_socket(socket);
  16131. // Create a new socket for the authenticated CONNECT request
  16132. if (!ensure_socket_connection(socket, error)) {
  16133. success = false;
  16134. output_error_log(error, nullptr);
  16135. return false;
  16136. }
  16137. proxy_res = Response();
  16138. if (!detail::process_client_socket(
  16139. socket.sock, read_timeout_sec_, read_timeout_usec_,
  16140. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  16141. start_time, [&](Stream &strm) {
  16142. Request req3;
  16143. req3.method = "CONNECT";
  16144. req3.path = detail::make_host_and_port_string_always_port(
  16145. host_, port_);
  16146. req3.headers.insert(detail::make_digest_authentication_header(
  16147. req3, auth, 1, detail::random_string(10),
  16148. proxy_digest_auth_username_, proxy_digest_auth_password_,
  16149. true));
  16150. if (max_timeout_msec_ > 0) {
  16151. req3.start_time_ = std::chrono::steady_clock::now();
  16152. }
  16153. return process_request(strm, req3, proxy_res, false, error);
  16154. })) {
  16155. // Thread-safe to close everything because we are assuming there are
  16156. // no requests in flight
  16157. shutdown_ssl(socket, true);
  16158. shutdown_socket(socket);
  16159. close_socket(socket);
  16160. success = false;
  16161. return false;
  16162. }
  16163. }
  16164. }
  16165. }
  16166. // If status code is not 200, proxy request is failed.
  16167. // Set error to ProxyConnection. A 407 is returned as the response of the
  16168. // request, so the caller sees the proxy asks for credentials; any other
  16169. // status would read as the answer of the origin, which it never reached.
  16170. if (proxy_res.status != StatusCode::OK_200) {
  16171. error = Error::ProxyConnection;
  16172. output_error_log(error, nullptr);
  16173. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  16174. res = std::move(proxy_res);
  16175. } else {
  16176. success = false;
  16177. }
  16178. // Thread-safe to close everything because we are assuming there are
  16179. // no requests in flight
  16180. shutdown_ssl(socket, true);
  16181. shutdown_socket(socket);
  16182. close_socket(socket);
  16183. return false;
  16184. }
  16185. return true;
  16186. }
  16187. inline bool SSLClient::ensure_socket_connection(Socket &socket, Error &error) {
  16188. if (!ClientImpl::ensure_socket_connection(socket, error)) { return false; }
  16189. if (is_proxy_enabled_for_host(host_)) { return true; }
  16190. if (!initialize_ssl(socket, error)) {
  16191. shutdown_socket(socket);
  16192. close_socket(socket);
  16193. return false;
  16194. }
  16195. return true;
  16196. }
  16197. // SSL HTTP client implementation
  16198. inline SSLClient::SSLClient(const std::string &host)
  16199. : SSLClient(host, 443, std::string(), std::string()) {}
  16200. inline SSLClient::SSLClient(const std::string &host, int port)
  16201. : SSLClient(host, port, std::string(), std::string()) {}
  16202. inline void SSLClient::init_ctx() {
  16203. ctx_ = tls::create_client_context();
  16204. if (ctx_) { tls::set_min_version(ctx_, tls::Version::TLS1_2); }
  16205. }
  16206. inline void SSLClient::reset_ctx_on_error() {
  16207. last_backend_error_ = tls::get_error();
  16208. tls::free_context(ctx_);
  16209. ctx_ = nullptr;
  16210. }
  16211. inline SSLClient::SSLClient(const std::string &host, int port,
  16212. const std::string &client_cert_path,
  16213. const std::string &client_key_path,
  16214. const std::string &private_key_password)
  16215. : ClientImpl(host, port, client_cert_path, client_key_path) {
  16216. init_ctx();
  16217. if (!ctx_) { return; }
  16218. if (!client_cert_path.empty() && !client_key_path.empty()) {
  16219. const char *password =
  16220. private_key_password.empty() ? nullptr : private_key_password.c_str();
  16221. if (!tls::set_client_cert_file(ctx_, client_cert_path.c_str(),
  16222. client_key_path.c_str(), password)) {
  16223. reset_ctx_on_error();
  16224. }
  16225. }
  16226. }
  16227. inline SSLClient::SSLClient(const std::string &host, int port,
  16228. const PemMemory &pem)
  16229. : ClientImpl(host, port) {
  16230. init_ctx();
  16231. if (!ctx_) { return; }
  16232. if (pem.cert_pem && pem.key_pem) {
  16233. if (!tls::set_client_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  16234. pem.private_key_password)) {
  16235. reset_ctx_on_error();
  16236. }
  16237. }
  16238. }
  16239. inline void SSLClient::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16240. if (ca_cert_store && ctx_) {
  16241. // set_ca_store takes ownership of ca_cert_store
  16242. tls::set_ca_store(ctx_, ca_cert_store);
  16243. ca_cert_store_set_ = true;
  16244. } else if (ca_cert_store) {
  16245. tls::free_ca_store(ca_cert_store);
  16246. }
  16247. }
  16248. inline void
  16249. SSLClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16250. if (!ctx_) { return; }
  16251. server_certificate_verifier_ = verifier;
  16252. tls::set_verify_callback(ctx_, std::move(verifier));
  16253. }
  16254. inline void SSLClient::set_session_verifier(
  16255. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16256. session_verifier_ = std::move(verifier);
  16257. }
  16258. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16259. inline void SSLClient::enable_windows_certificate_verification(bool enabled) {
  16260. enable_windows_cert_verification_ = enabled;
  16261. }
  16262. #endif
  16263. inline void SSLClient::load_ca_cert_store(const char *ca_cert,
  16264. std::size_t size) {
  16265. if (ctx_ && ca_cert && size > 0) {
  16266. ca_cert_pem_.assign(ca_cert, size); // Store for redirect transfer
  16267. tls::load_ca_pem(ctx_, ca_cert, size);
  16268. }
  16269. }
  16270. inline bool SSLClient::load_certs() {
  16271. auto ret = true;
  16272. // call_once rather than the plain flag WebSocketClient::create_stream() uses:
  16273. // one client is shared across concurrent requests here.
  16274. std::call_once(initialize_cert_, [&]() {
  16275. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16276. ret = detail::load_client_ca_config(
  16277. ctx_, ca_cert_file_path_, ca_cert_dir_path_,
  16278. !ca_cert_pem_.empty() || ca_cert_store_set_, system_ca_mode_,
  16279. last_backend_error_);
  16280. });
  16281. return ret;
  16282. }
  16283. inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) {
  16284. // Load CA certificates if server verification is enabled
  16285. if (server_certificate_verification_) {
  16286. if (!load_certs()) {
  16287. error = Error::SSLLoadingCerts;
  16288. output_error_log(error, nullptr);
  16289. return false;
  16290. }
  16291. }
  16292. detail::ClientTlsSessionOptions options;
  16293. options.server_hostname_verification = server_hostname_verification_;
  16294. options.session_verifier = session_verifier_;
  16295. options.ctx_mutex = &ctx_mutex_;
  16296. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16297. // Skip Schannel when a custom CA cert is specified, as the Windows
  16298. // certificate store would not know about user-provided CA certificates.
  16299. // Also skip when system CA trust is explicitly disabled.
  16300. options.windows_cert_verification =
  16301. enable_windows_cert_verification_ &&
  16302. system_ca_mode_ != SystemCAMode::Disabled && ca_cert_file_path_.empty() &&
  16303. ca_cert_dir_path_.empty() && ca_cert_pem_.empty() && !ca_cert_store_set_;
  16304. // Only a verifier set through set_server_certificate_verifier() is seen
  16305. // here, not one installed with tls::set_verify_callback() directly.
  16306. options.server_certificate_verifier_set =
  16307. static_cast<bool>(server_certificate_verifier_);
  16308. #endif
  16309. tls::session_t session = nullptr;
  16310. // Use scope_exit to ensure session is freed on error paths
  16311. bool success = false;
  16312. auto session_guard = detail::scope_exit([&] {
  16313. if (!success) { tls::free_session(session); }
  16314. });
  16315. detail::ClientTlsSessionError tls_error;
  16316. if (!detail::setup_client_tls_session(
  16317. host_, ctx_, session, socket.sock, server_certificate_verification_,
  16318. connection_timeout_sec_, connection_timeout_usec_, &tls_error,
  16319. options)) {
  16320. error = tls_error.error;
  16321. last_ssl_error_ = tls_error.ssl_error;
  16322. last_backend_error_ = tls_error.backend_error;
  16323. output_error_log(error, nullptr);
  16324. return false;
  16325. }
  16326. success = true;
  16327. socket.ssl = session;
  16328. return true;
  16329. }
  16330. inline void Client::set_digest_auth(const std::string &username,
  16331. const std::string &password) {
  16332. cli_->set_digest_auth(username, password);
  16333. }
  16334. inline void Client::set_proxy_digest_auth(const std::string &username,
  16335. const std::string &password) {
  16336. cli_->set_proxy_digest_auth(username, password);
  16337. }
  16338. inline void Client::enable_server_certificate_verification(bool enabled) {
  16339. cli_->enable_server_certificate_verification(enabled);
  16340. }
  16341. inline void Client::enable_server_hostname_verification(bool enabled) {
  16342. cli_->enable_server_hostname_verification(enabled);
  16343. }
  16344. inline void Client::enable_system_ca(bool enabled) {
  16345. cli_->enable_system_ca(enabled);
  16346. }
  16347. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16348. inline void Client::enable_windows_certificate_verification(bool enabled) {
  16349. if (is_ssl_) {
  16350. static_cast<SSLClient &>(*cli_).enable_windows_certificate_verification(
  16351. enabled);
  16352. }
  16353. }
  16354. #endif
  16355. inline void Client::set_ca_cert_path(const std::string &ca_cert_file_path,
  16356. const std::string &ca_cert_dir_path) {
  16357. cli_->set_ca_cert_path(ca_cert_file_path, ca_cert_dir_path);
  16358. }
  16359. inline void Client::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16360. if (is_ssl_) {
  16361. static_cast<SSLClient &>(*cli_).set_ca_cert_store(ca_cert_store);
  16362. } else if (ca_cert_store) {
  16363. tls::free_ca_store(ca_cert_store);
  16364. }
  16365. }
  16366. inline void Client::load_ca_cert_store(const char *ca_cert, std::size_t size) {
  16367. if (is_ssl_) {
  16368. // Use the PEM-based path so the CA data is retained for redirect transfer
  16369. static_cast<SSLClient &>(*cli_).load_ca_cert_store(ca_cert, size);
  16370. }
  16371. }
  16372. inline void
  16373. Client::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16374. if (is_ssl_) {
  16375. static_cast<SSLClient &>(*cli_).set_server_certificate_verifier(
  16376. std::move(verifier));
  16377. }
  16378. }
  16379. inline void Client::set_session_verifier(
  16380. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16381. if (is_ssl_) {
  16382. static_cast<SSLClient &>(*cli_).set_session_verifier(std::move(verifier));
  16383. }
  16384. }
  16385. inline tls::ctx_t Client::tls_context() const {
  16386. if (is_ssl_) { return static_cast<SSLClient &>(*cli_).tls_context(); }
  16387. return nullptr;
  16388. }
  16389. #endif // CPPHTTPLIB_SSL_ENABLED
  16390. /*
  16391. * Group 7: TLS abstraction layer - Common API
  16392. */
  16393. #ifdef CPPHTTPLIB_SSL_ENABLED
  16394. namespace tls {
  16395. // Helper for PeerCert construction
  16396. inline PeerCert get_peer_cert_from_session(const_session_t session) {
  16397. return PeerCert(get_peer_cert(session));
  16398. }
  16399. namespace impl {
  16400. // Check if a string is an IPv4 address
  16401. inline bool is_ipv4_address(const std::string &str) {
  16402. int dots = 0;
  16403. for (char c : str) {
  16404. if (c == '.') {
  16405. dots++;
  16406. } else if (!detail::is_ascii_digit(c)) {
  16407. return false;
  16408. }
  16409. }
  16410. return dots == 3;
  16411. }
  16412. // Parse IPv4 address string to bytes
  16413. inline bool parse_ipv4(const std::string &str, unsigned char *out) {
  16414. const char *p = str.c_str();
  16415. for (int i = 0; i < 4; i++) {
  16416. if (i > 0) {
  16417. if (*p != '.') { return false; }
  16418. p++;
  16419. }
  16420. int val = 0;
  16421. int digits = 0;
  16422. while (detail::is_ascii_digit(*p)) {
  16423. val = val * 10 + (*p - '0');
  16424. if (val > 255) { return false; }
  16425. p++;
  16426. digits++;
  16427. }
  16428. if (digits == 0) { return false; }
  16429. // Reject leading zeros (e.g., "01.002.03.04") to prevent ambiguity
  16430. if (digits > 1 && *(p - digits) == '0') { return false; }
  16431. out[i] = static_cast<unsigned char>(val);
  16432. }
  16433. return *p == '\0';
  16434. }
  16435. // Parse an IP literal (IPv4 or IPv6) into raw network-order bytes.
  16436. // `out` must have room for at least 16 bytes. Returns the address length
  16437. // (4 for IPv4, 16 for IPv6) on success, or 0 if the string is not an IP
  16438. // literal. Used to match a host against iPAddress SANs the same way the
  16439. // OpenSSL backend does via X509_check_ip.
  16440. inline size_t parse_ip_address(const std::string &str, unsigned char *out) {
  16441. if (is_ipv4_address(str)) { return parse_ipv4(str, out) ? 4 : 0; }
  16442. struct in6_addr addr6 = {};
  16443. if (inet_pton(AF_INET6, str.c_str(), &addr6) == 1) {
  16444. memcpy(out, &addr6, 16);
  16445. return 16;
  16446. }
  16447. return 0;
  16448. }
  16449. #ifdef _WIN32
  16450. // Enumerate Windows system certificates and call callback with DER data
  16451. template <typename Callback>
  16452. inline bool enumerate_windows_system_certs(Callback cb) {
  16453. bool loaded = false;
  16454. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16455. for (auto store_name : store_names) {
  16456. HCERTSTORE hStore = CertOpenSystemStoreW(0, store_name);
  16457. if (hStore) {
  16458. PCCERT_CONTEXT pContext = nullptr;
  16459. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16460. nullptr) {
  16461. if (cb(pContext->pbCertEncoded, pContext->cbCertEncoded)) {
  16462. loaded = true;
  16463. }
  16464. }
  16465. CertCloseStore(hStore, 0);
  16466. }
  16467. }
  16468. return loaded;
  16469. }
  16470. #endif
  16471. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16472. // Enumerate macOS Keychain certificates and call callback with DER data
  16473. template <typename Callback>
  16474. inline bool enumerate_macos_keychain_certs(Callback cb) {
  16475. bool loaded = false;
  16476. const SecTrustSettingsDomain domains[] = {
  16477. kSecTrustSettingsDomainSystem,
  16478. kSecTrustSettingsDomainAdmin,
  16479. kSecTrustSettingsDomainUser,
  16480. };
  16481. for (auto domain : domains) {
  16482. CFArrayRef certs = nullptr;
  16483. OSStatus status = SecTrustSettingsCopyCertificates(domain, &certs);
  16484. if (status != errSecSuccess || !certs) {
  16485. if (certs) CFRelease(certs);
  16486. continue;
  16487. }
  16488. CFIndex count = CFArrayGetCount(certs);
  16489. for (CFIndex i = 0; i < count; i++) {
  16490. SecCertificateRef cert =
  16491. (SecCertificateRef)CFArrayGetValueAtIndex(certs, i);
  16492. CFDataRef data = SecCertificateCopyData(cert);
  16493. if (data) {
  16494. if (cb(CFDataGetBytePtr(data),
  16495. static_cast<size_t>(CFDataGetLength(data)))) {
  16496. loaded = true;
  16497. }
  16498. CFRelease(data);
  16499. }
  16500. }
  16501. CFRelease(certs);
  16502. }
  16503. return loaded;
  16504. }
  16505. #endif
  16506. #if !defined(_WIN32) && !(defined(__APPLE__) && \
  16507. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN))
  16508. // Common CA certificate file paths on Linux/Unix
  16509. inline const char **system_ca_paths() {
  16510. static const char *paths[] = {
  16511. "/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu
  16512. "/etc/pki/tls/certs/ca-bundle.crt", // RHEL/CentOS
  16513. "/etc/ssl/ca-bundle.pem", // OpenSUSE
  16514. "/etc/pki/tls/cacert.pem", // OpenELEC
  16515. "/etc/ssl/cert.pem", // Alpine, FreeBSD
  16516. nullptr};
  16517. return paths;
  16518. }
  16519. // Common CA certificate directory paths on Linux/Unix
  16520. inline const char **system_ca_dirs() {
  16521. static const char *dirs[] = {"/etc/ssl/certs", // Debian/Ubuntu
  16522. "/etc/pki/tls/certs", // RHEL/CentOS
  16523. "/usr/share/ca-certificates", // Other
  16524. nullptr};
  16525. return dirs;
  16526. }
  16527. #endif
  16528. } // namespace impl
  16529. inline bool set_client_ca_file(ctx_t ctx, const char *ca_file,
  16530. const char *ca_dir) {
  16531. if (!ctx) { return false; }
  16532. bool success = true;
  16533. if (ca_file && *ca_file) {
  16534. if (!load_ca_file(ctx, ca_file)) { success = false; }
  16535. }
  16536. if (ca_dir && *ca_dir) {
  16537. if (!load_ca_dir(ctx, ca_dir)) { success = false; }
  16538. }
  16539. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16540. // Set CA list for client certificate request (CertificateRequest message)
  16541. if (ca_file && *ca_file) {
  16542. auto list = SSL_load_client_CA_file(ca_file);
  16543. if (list) { SSL_CTX_set_client_CA_list(static_cast<SSL_CTX *>(ctx), list); }
  16544. }
  16545. #endif
  16546. return success;
  16547. }
  16548. inline bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16549. const char *password) {
  16550. return set_client_cert_pem(ctx, cert, key, password);
  16551. }
  16552. inline bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  16553. const char *key_path, const char *password) {
  16554. return set_client_cert_file(ctx, cert_path, key_path, password);
  16555. }
  16556. // PeerCert implementation
  16557. inline PeerCert::PeerCert() = default;
  16558. inline PeerCert::PeerCert(cert_t cert) : cert_(cert) {}
  16559. inline PeerCert::PeerCert(PeerCert &&other) noexcept : cert_(other.cert_) {
  16560. other.cert_ = nullptr;
  16561. }
  16562. inline PeerCert &PeerCert::operator=(PeerCert &&other) noexcept {
  16563. if (this != &other) {
  16564. if (cert_) { free_cert(cert_); }
  16565. cert_ = other.cert_;
  16566. other.cert_ = nullptr;
  16567. }
  16568. return *this;
  16569. }
  16570. inline PeerCert::~PeerCert() {
  16571. if (cert_) { free_cert(cert_); }
  16572. }
  16573. inline PeerCert::operator bool() const { return cert_ != nullptr; }
  16574. inline std::string PeerCert::subject_cn() const {
  16575. return cert_ ? get_cert_subject_cn(cert_) : std::string();
  16576. }
  16577. inline std::string PeerCert::issuer_name() const {
  16578. return cert_ ? get_cert_issuer_name(cert_) : std::string();
  16579. }
  16580. inline bool PeerCert::check_hostname(const char *hostname) const {
  16581. return cert_ ? verify_hostname(cert_, hostname) : false;
  16582. }
  16583. inline std::vector<SanEntry> PeerCert::sans() const {
  16584. std::vector<SanEntry> result;
  16585. if (cert_) { get_cert_sans(cert_, result); }
  16586. return result;
  16587. }
  16588. inline bool PeerCert::validity(time_t &not_before, time_t &not_after) const {
  16589. return cert_ ? get_cert_validity(cert_, not_before, not_after) : false;
  16590. }
  16591. inline std::string PeerCert::serial() const {
  16592. return cert_ ? get_cert_serial(cert_) : std::string();
  16593. }
  16594. // VerifyContext method implementations
  16595. inline std::string VerifyContext::subject_cn() const {
  16596. return cert ? get_cert_subject_cn(cert) : std::string();
  16597. }
  16598. inline std::string VerifyContext::issuer_name() const {
  16599. return cert ? get_cert_issuer_name(cert) : std::string();
  16600. }
  16601. inline bool VerifyContext::check_hostname(const char *hostname) const {
  16602. return cert ? verify_hostname(cert, hostname) : false;
  16603. }
  16604. inline std::vector<SanEntry> VerifyContext::sans() const {
  16605. std::vector<SanEntry> result;
  16606. if (cert) { get_cert_sans(cert, result); }
  16607. return result;
  16608. }
  16609. inline bool VerifyContext::validity(time_t &not_before,
  16610. time_t &not_after) const {
  16611. return cert ? get_cert_validity(cert, not_before, not_after) : false;
  16612. }
  16613. inline std::string VerifyContext::serial() const {
  16614. return cert ? get_cert_serial(cert) : std::string();
  16615. }
  16616. // TlsError static method implementation
  16617. inline std::string TlsError::verify_error_to_string(long error_code) {
  16618. return verify_error_string(error_code);
  16619. }
  16620. } // namespace tls
  16621. // Request::peer_cert() implementation
  16622. inline tls::PeerCert Request::peer_cert() const {
  16623. return tls::get_peer_cert_from_session(ssl);
  16624. }
  16625. // Request::sni() implementation
  16626. inline std::string Request::sni() const {
  16627. if (!ssl) { return std::string(); }
  16628. const char *s = tls::get_sni(ssl);
  16629. return s ? std::string(s) : std::string();
  16630. }
  16631. #endif // CPPHTTPLIB_SSL_ENABLED
  16632. /*
  16633. * Group 8: TLS abstraction layer - OpenSSL backend
  16634. */
  16635. /*
  16636. * OpenSSL Backend Implementation
  16637. */
  16638. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16639. namespace tls {
  16640. namespace impl {
  16641. // Helper to map OpenSSL SSL_get_error to ErrorCode
  16642. inline ErrorCode map_ssl_error(int ssl_error, int &out_errno) {
  16643. switch (ssl_error) {
  16644. case SSL_ERROR_NONE: return ErrorCode::Success;
  16645. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  16646. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  16647. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  16648. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  16649. case SSL_ERROR_SSL:
  16650. default: return ErrorCode::Fatal;
  16651. }
  16652. }
  16653. // Helper: Create client CA list from PEM string
  16654. // Returns a new STACK_OF(X509_NAME)* or nullptr on failure
  16655. // Caller takes ownership of returned list
  16656. inline STACK_OF(X509_NAME) *
  16657. create_client_ca_list_from_pem(const char *ca_pem) {
  16658. if (!ca_pem) { return nullptr; }
  16659. auto ca_list = sk_X509_NAME_new_null();
  16660. if (!ca_list) { return nullptr; }
  16661. BIO *bio = BIO_new_mem_buf(ca_pem, -1);
  16662. if (!bio) {
  16663. sk_X509_NAME_pop_free(ca_list, X509_NAME_free);
  16664. return nullptr;
  16665. }
  16666. X509 *cert = nullptr;
  16667. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16668. nullptr) {
  16669. const X509_NAME *name = X509_get_subject_name(cert);
  16670. if (name) {
  16671. sk_X509_NAME_push(ca_list, X509_NAME_dup(const_cast<X509_NAME *>(name)));
  16672. }
  16673. X509_free(cert);
  16674. }
  16675. BIO_free(bio);
  16676. return ca_list;
  16677. }
  16678. inline void free_verify_callback(void * /*parent*/, void *ptr,
  16679. CRYPTO_EX_DATA * /*ad*/, int /*idx*/,
  16680. long /*argl*/, void * /*argp*/) {
  16681. delete static_cast<VerifyCallback *>(ptr);
  16682. }
  16683. // The SSL_CTX owns its verify callback, so each client or server sees only
  16684. // its own, on whichever thread runs the handshake.
  16685. inline int verify_callback_index() {
  16686. static const auto index = SSL_CTX_get_ex_new_index(
  16687. 0, nullptr, nullptr, nullptr, free_verify_callback);
  16688. return index;
  16689. }
  16690. // OpenSSL verify callback wrapper
  16691. inline int openssl_verify_callback(int preverify_ok, X509_STORE_CTX *ctx) {
  16692. // Get SSL object from X509_STORE_CTX
  16693. auto ssl = static_cast<SSL *>(
  16694. X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
  16695. if (!ssl) { return preverify_ok; }
  16696. auto callback = static_cast<VerifyCallback *>(
  16697. SSL_CTX_get_ex_data(SSL_get_SSL_CTX(ssl), verify_callback_index()));
  16698. if (!callback) { return preverify_ok; }
  16699. // Get current certificate and depth
  16700. auto cert = X509_STORE_CTX_get_current_cert(ctx);
  16701. int depth = X509_STORE_CTX_get_error_depth(ctx);
  16702. int error = X509_STORE_CTX_get_error(ctx);
  16703. // Build context
  16704. VerifyContext verify_ctx;
  16705. verify_ctx.session = static_cast<session_t>(ssl);
  16706. verify_ctx.cert = static_cast<cert_t>(cert);
  16707. verify_ctx.depth = depth;
  16708. verify_ctx.preverify_ok = (preverify_ok != 0);
  16709. verify_ctx.error_code = error;
  16710. verify_ctx.error_string =
  16711. (error != X509_V_OK) ? X509_verify_cert_error_string(error) : nullptr;
  16712. return (*callback)(verify_ctx) ? 1 : 0;
  16713. }
  16714. // X509_STORE_get0_objects is deprecated since OpenSSL 4.0 because it is not
  16715. // thread-safe; X509_STORE_get1_objects (OpenSSL 3.3+) returns a snapshot
  16716. // that must be released with release_store_objects
  16717. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER) && \
  16718. OPENSSL_VERSION_NUMBER >= 0x30300000L
  16719. #define CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16720. #endif
  16721. inline STACK_OF(X509_OBJECT) * get_store_objects(X509_STORE *store) {
  16722. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16723. return X509_STORE_get1_objects(store);
  16724. #else
  16725. return X509_STORE_get0_objects(store);
  16726. #endif
  16727. }
  16728. inline void release_store_objects(STACK_OF(X509_OBJECT) * objs) {
  16729. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16730. sk_X509_OBJECT_pop_free(objs, X509_OBJECT_free);
  16731. #else
  16732. (void)objs; // get0 variant returns an internal pointer; nothing to free
  16733. #endif
  16734. }
  16735. } // namespace impl
  16736. inline ctx_t create_client_context() {
  16737. SSL_CTX *ctx = SSL_CTX_new(TLS_client_method());
  16738. if (ctx) {
  16739. // Disable auto-retry to properly handle non-blocking I/O
  16740. SSL_CTX_clear_mode(ctx, SSL_MODE_AUTO_RETRY);
  16741. // Set minimum TLS version
  16742. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16743. }
  16744. return static_cast<ctx_t>(ctx);
  16745. }
  16746. inline void free_context(ctx_t ctx) {
  16747. if (ctx) { SSL_CTX_free(static_cast<SSL_CTX *>(ctx)); }
  16748. }
  16749. inline bool set_min_version(ctx_t ctx, Version version) {
  16750. if (!ctx) return false;
  16751. return SSL_CTX_set_min_proto_version(static_cast<SSL_CTX *>(ctx),
  16752. static_cast<int>(version)) == 1;
  16753. }
  16754. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  16755. if (!ctx || !pem || len == 0) return false;
  16756. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16757. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16758. if (!store) return false;
  16759. auto bio = BIO_new_mem_buf(pem, static_cast<int>(len));
  16760. if (!bio) return false;
  16761. bool ok = true;
  16762. X509 *cert = nullptr;
  16763. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16764. nullptr) {
  16765. if (X509_STORE_add_cert(store, cert) != 1) {
  16766. // Ignore duplicate errors
  16767. auto err = ERR_peek_last_error();
  16768. if (ERR_GET_REASON(err) != X509_R_CERT_ALREADY_IN_HASH_TABLE) {
  16769. ok = false;
  16770. }
  16771. }
  16772. X509_free(cert);
  16773. if (!ok) break;
  16774. }
  16775. BIO_free(bio);
  16776. // Clear any "no more certificates" errors
  16777. ERR_clear_error();
  16778. return ok;
  16779. }
  16780. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  16781. if (!ctx || !file_path) return false;
  16782. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), file_path,
  16783. nullptr) == 1;
  16784. }
  16785. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  16786. if (!ctx || !dir_path) return false;
  16787. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), nullptr,
  16788. dir_path) == 1;
  16789. }
  16790. inline bool load_system_certs(ctx_t ctx) {
  16791. if (!ctx) return false;
  16792. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16793. #ifdef _WIN32
  16794. // Windows: Load from system certificate store (ROOT and CA)
  16795. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16796. if (!store) return false;
  16797. bool loaded_any = false;
  16798. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16799. for (auto store_name : store_names) {
  16800. auto hStore = CertOpenSystemStoreW(NULL, store_name);
  16801. if (!hStore) continue;
  16802. PCCERT_CONTEXT pContext = nullptr;
  16803. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16804. nullptr) {
  16805. const unsigned char *data = pContext->pbCertEncoded;
  16806. auto x509 = d2i_X509(nullptr, &data, pContext->cbCertEncoded);
  16807. if (x509) {
  16808. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  16809. X509_free(x509);
  16810. }
  16811. }
  16812. CertCloseStore(hStore, 0);
  16813. }
  16814. return loaded_any;
  16815. #elif defined(__APPLE__)
  16816. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16817. // macOS: Load from Keychain
  16818. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16819. if (!store) return false;
  16820. bool loaded_any = false;
  16821. const SecTrustSettingsDomain domains[] = {
  16822. kSecTrustSettingsDomainSystem,
  16823. kSecTrustSettingsDomainAdmin,
  16824. kSecTrustSettingsDomainUser,
  16825. };
  16826. for (auto domain : domains) {
  16827. CFArrayRef certs = nullptr;
  16828. if (SecTrustSettingsCopyCertificates(domain, &certs) != errSecSuccess ||
  16829. !certs) {
  16830. if (certs) CFRelease(certs);
  16831. continue;
  16832. }
  16833. auto count = CFArrayGetCount(certs);
  16834. for (CFIndex i = 0; i < count; i++) {
  16835. auto cert = reinterpret_cast<SecCertificateRef>(
  16836. const_cast<void *>(CFArrayGetValueAtIndex(certs, i)));
  16837. CFDataRef der = SecCertificateCopyData(cert);
  16838. if (der) {
  16839. const unsigned char *data = CFDataGetBytePtr(der);
  16840. auto x509 = d2i_X509(nullptr, &data, CFDataGetLength(der));
  16841. if (x509) {
  16842. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  16843. X509_free(x509);
  16844. }
  16845. CFRelease(der);
  16846. }
  16847. }
  16848. CFRelease(certs);
  16849. }
  16850. return loaded_any || SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16851. #else
  16852. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16853. #endif
  16854. #else
  16855. // Other Unix: use default verify paths
  16856. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16857. #endif
  16858. }
  16859. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16860. const char *password) {
  16861. if (!ctx || !cert || !key) return false;
  16862. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16863. // Load certificate
  16864. auto cert_bio = BIO_new_mem_buf(cert, -1);
  16865. if (!cert_bio) return false;
  16866. auto x509 = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  16867. BIO_free(cert_bio);
  16868. if (!x509) return false;
  16869. auto cert_ok = SSL_CTX_use_certificate(ssl_ctx, x509) == 1;
  16870. X509_free(x509);
  16871. if (!cert_ok) return false;
  16872. // Load private key
  16873. auto key_bio = BIO_new_mem_buf(key, -1);
  16874. if (!key_bio) return false;
  16875. auto pkey = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  16876. password ? const_cast<char *>(password)
  16877. : nullptr);
  16878. BIO_free(key_bio);
  16879. if (!pkey) return false;
  16880. auto key_ok = SSL_CTX_use_PrivateKey(ssl_ctx, pkey) == 1;
  16881. EVP_PKEY_free(pkey);
  16882. return key_ok && SSL_CTX_check_private_key(ssl_ctx) == 1;
  16883. }
  16884. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  16885. const char *key_path, const char *password) {
  16886. if (!ctx || !cert_path || !key_path) return false;
  16887. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16888. if (password && password[0] != '\0') {
  16889. SSL_CTX_set_default_passwd_cb_userdata(
  16890. ssl_ctx, reinterpret_cast<void *>(const_cast<char *>(password)));
  16891. }
  16892. return SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_path) == 1 &&
  16893. SSL_CTX_use_PrivateKey_file(ssl_ctx, key_path, SSL_FILETYPE_PEM) == 1;
  16894. }
  16895. inline ctx_t create_server_context() {
  16896. SSL_CTX *ctx = SSL_CTX_new(TLS_server_method());
  16897. if (ctx) {
  16898. // No renegotiation, as on the other backends: it would run a handshake
  16899. // that SSLServer::update_certs_pem() does not wait for
  16900. SSL_CTX_set_options(ctx, SSL_OP_NO_COMPRESSION |
  16901. SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION |
  16902. SSL_OP_NO_RENEGOTIATION);
  16903. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16904. }
  16905. return static_cast<ctx_t>(ctx);
  16906. }
  16907. inline void set_verify_client(ctx_t ctx, bool require) {
  16908. if (!ctx) return;
  16909. SSL_CTX_set_verify(static_cast<SSL_CTX *>(ctx),
  16910. require
  16911. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  16912. : SSL_VERIFY_NONE,
  16913. nullptr);
  16914. }
  16915. inline session_t create_session(ctx_t ctx, socket_t sock) {
  16916. if (!ctx || sock == INVALID_SOCKET) return nullptr;
  16917. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16918. SSL *ssl = SSL_new(ssl_ctx);
  16919. if (!ssl) return nullptr;
  16920. // Disable auto-retry for proper non-blocking I/O handling
  16921. SSL_clear_mode(ssl, SSL_MODE_AUTO_RETRY);
  16922. auto bio = BIO_new_socket(static_cast<int>(sock), BIO_NOCLOSE);
  16923. if (!bio) {
  16924. SSL_free(ssl);
  16925. return nullptr;
  16926. }
  16927. SSL_set_bio(ssl, bio, bio);
  16928. return static_cast<session_t>(ssl);
  16929. }
  16930. inline void free_session(session_t session) {
  16931. if (session) { SSL_free(static_cast<SSL *>(session)); }
  16932. }
  16933. inline bool set_sni(session_t session, const char *hostname,
  16934. bool /*verify_hostname*/) {
  16935. if (!session || !hostname) return false;
  16936. auto ssl = static_cast<SSL *>(session);
  16937. // Set SNI (Server Name Indication) only - does not enable verification.
  16938. // OpenSSL never binds identity checking to SNI (that happens post-
  16939. // handshake in setup_client_tls_session()), so verify_hostname is unused.
  16940. #if defined(OPENSSL_IS_BORINGSSL)
  16941. return SSL_set_tlsext_host_name(ssl, hostname) == 1;
  16942. #else
  16943. // Direct call instead of macro to suppress -Wold-style-cast warning
  16944. return SSL_ctrl(ssl, SSL_CTRL_SET_TLSEXT_HOSTNAME, TLSEXT_NAMETYPE_host_name,
  16945. static_cast<void *>(const_cast<char *>(hostname))) == 1;
  16946. #endif
  16947. }
  16948. inline TlsError connect(session_t session) {
  16949. if (!session) { return TlsError(); }
  16950. auto ssl = static_cast<SSL *>(session);
  16951. auto ret = SSL_connect(ssl);
  16952. TlsError err;
  16953. if (ret == 1) {
  16954. err.code = ErrorCode::Success;
  16955. } else {
  16956. auto ssl_err = SSL_get_error(ssl, ret);
  16957. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16958. err.backend_code = ERR_get_error();
  16959. }
  16960. return err;
  16961. }
  16962. inline TlsError accept(session_t session) {
  16963. if (!session) { return TlsError(); }
  16964. auto ssl = static_cast<SSL *>(session);
  16965. auto ret = SSL_accept(ssl);
  16966. TlsError err;
  16967. if (ret == 1) {
  16968. err.code = ErrorCode::Success;
  16969. } else {
  16970. auto ssl_err = SSL_get_error(ssl, ret);
  16971. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16972. err.backend_code = ERR_get_error();
  16973. }
  16974. return err;
  16975. }
  16976. inline bool connect_nonblocking(session_t session, socket_t sock,
  16977. time_t timeout_sec, time_t timeout_usec,
  16978. TlsError *err) {
  16979. if (!session) {
  16980. if (err) { err->code = ErrorCode::Fatal; }
  16981. return false;
  16982. }
  16983. auto ssl = static_cast<SSL *>(session);
  16984. auto bio = SSL_get_rbio(ssl);
  16985. // Set non-blocking mode for handshake
  16986. detail::set_nonblocking(sock, true);
  16987. if (bio) { BIO_set_nbio(bio, 1); }
  16988. auto cleanup = detail::scope_exit([&]() {
  16989. // Restore blocking mode after handshake
  16990. if (bio) { BIO_set_nbio(bio, 0); }
  16991. detail::set_nonblocking(sock, false);
  16992. });
  16993. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  16994. auto res = 0;
  16995. while ((res = SSL_connect(ssl)) != 1) {
  16996. auto ssl_err = SSL_get_error(ssl, res);
  16997. switch (ssl_err) {
  16998. case SSL_ERROR_WANT_READ:
  16999. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  17000. break;
  17001. case SSL_ERROR_WANT_WRITE:
  17002. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  17003. break;
  17004. default: break;
  17005. }
  17006. if (err) {
  17007. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  17008. err->backend_code = ERR_get_error();
  17009. }
  17010. return false;
  17011. }
  17012. if (err) { err->code = ErrorCode::Success; }
  17013. return true;
  17014. }
  17015. inline bool accept_nonblocking(session_t session, socket_t sock,
  17016. time_t timeout_sec, time_t timeout_usec,
  17017. TlsError *err) {
  17018. if (!session) {
  17019. if (err) { err->code = ErrorCode::Fatal; }
  17020. return false;
  17021. }
  17022. auto ssl = static_cast<SSL *>(session);
  17023. auto bio = SSL_get_rbio(ssl);
  17024. // Set non-blocking mode for handshake
  17025. detail::set_nonblocking(sock, true);
  17026. if (bio) { BIO_set_nbio(bio, 1); }
  17027. auto cleanup = detail::scope_exit([&]() {
  17028. // Restore blocking mode after handshake
  17029. if (bio) { BIO_set_nbio(bio, 0); }
  17030. detail::set_nonblocking(sock, false);
  17031. });
  17032. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  17033. auto res = 0;
  17034. while ((res = SSL_accept(ssl)) != 1) {
  17035. auto ssl_err = SSL_get_error(ssl, res);
  17036. switch (ssl_err) {
  17037. case SSL_ERROR_WANT_READ:
  17038. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  17039. break;
  17040. case SSL_ERROR_WANT_WRITE:
  17041. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  17042. break;
  17043. default: break;
  17044. }
  17045. if (err) {
  17046. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  17047. err->backend_code = ERR_get_error();
  17048. }
  17049. return false;
  17050. }
  17051. if (err) { err->code = ErrorCode::Success; }
  17052. return true;
  17053. }
  17054. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  17055. if (!session || !buf) {
  17056. err.code = ErrorCode::Fatal;
  17057. return -1;
  17058. }
  17059. auto ssl = static_cast<SSL *>(session);
  17060. constexpr auto max_len =
  17061. static_cast<size_t>((std::numeric_limits<int>::max)());
  17062. if (len > max_len) { len = max_len; }
  17063. auto ret = SSL_read(ssl, buf, static_cast<int>(len));
  17064. if (ret > 0) {
  17065. err.code = ErrorCode::Success;
  17066. return ret;
  17067. }
  17068. auto ssl_err = SSL_get_error(ssl, ret);
  17069. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17070. if (err.code == ErrorCode::PeerClosed) {
  17071. return 0;
  17072. } // Gracefully handle the peer closed state.
  17073. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  17074. return -1;
  17075. }
  17076. inline ssize_t write(session_t session, const void *buf, size_t len,
  17077. TlsError &err) {
  17078. if (!session || !buf) {
  17079. err.code = ErrorCode::Fatal;
  17080. return -1;
  17081. }
  17082. auto ssl = static_cast<SSL *>(session);
  17083. auto ret = SSL_write(ssl, buf, static_cast<int>(len));
  17084. if (ret > 0) {
  17085. err.code = ErrorCode::Success;
  17086. return ret;
  17087. }
  17088. auto ssl_err = SSL_get_error(ssl, ret);
  17089. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17090. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  17091. return -1;
  17092. }
  17093. inline int pending(const_session_t session) {
  17094. if (!session) return 0;
  17095. return SSL_pending(static_cast<SSL *>(const_cast<void *>(session)));
  17096. }
  17097. inline void shutdown(session_t session, bool graceful) {
  17098. if (!session) return;
  17099. auto ssl = static_cast<SSL *>(session);
  17100. if (graceful) {
  17101. // Send close_notify without waiting for the peer's. The connection is
  17102. // closed right after this, so a unidirectional shutdown is enough, and an
  17103. // idle peer that never answers would otherwise hold this thread until the
  17104. // read timeout. The other backends do not wait either.
  17105. SSL_shutdown(ssl);
  17106. }
  17107. }
  17108. inline bool is_peer_closed(session_t session, socket_t sock) {
  17109. if (!session) return true;
  17110. // Temporarily set socket to non-blocking to avoid blocking on SSL_peek
  17111. detail::set_nonblocking(sock, true);
  17112. auto se = detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17113. auto ssl = static_cast<SSL *>(session);
  17114. char buf;
  17115. auto ret = SSL_peek(ssl, &buf, 1);
  17116. if (ret > 0) return false;
  17117. auto err = SSL_get_error(ssl, ret);
  17118. return err == SSL_ERROR_ZERO_RETURN;
  17119. }
  17120. inline cert_t get_peer_cert(const_session_t session) {
  17121. if (!session) return nullptr;
  17122. return static_cast<cert_t>(SSL_get1_peer_certificate(
  17123. static_cast<SSL *>(const_cast<void *>(session))));
  17124. }
  17125. inline size_t get_peer_certs(const_session_t session,
  17126. std::vector<cert_t> &certs) {
  17127. certs.clear();
  17128. if (!session) { return 0; }
  17129. auto ssl = static_cast<const SSL *>(session);
  17130. // On the server side, the chain leaves out the peer's own certificate
  17131. if (SSL_is_server(ssl)) {
  17132. if (auto leaf = get_peer_cert(session)) { certs.push_back(leaf); }
  17133. }
  17134. auto sk = SSL_get_peer_cert_chain(ssl);
  17135. for (int i = 0; sk && i < sk_X509_num(sk); i++) {
  17136. auto x509 = sk_X509_value(sk, i);
  17137. X509_up_ref(x509);
  17138. certs.push_back(static_cast<cert_t>(x509));
  17139. }
  17140. return certs.size();
  17141. }
  17142. inline void free_cert(cert_t cert) {
  17143. if (cert) { X509_free(static_cast<X509 *>(cert)); }
  17144. }
  17145. inline bool verify_hostname(cert_t cert, const char *hostname) {
  17146. if (!cert || !hostname) return false;
  17147. auto x509 = static_cast<X509 *>(cert);
  17148. // Use X509_check_ip_asc for IP addresses, X509_check_host for DNS names
  17149. if (detail::is_ip_address(hostname)) {
  17150. return X509_check_ip_asc(x509, hostname, 0) == 1;
  17151. }
  17152. return X509_check_host(x509, hostname, strlen(hostname), 0, nullptr) == 1;
  17153. }
  17154. inline uint64_t hostname_mismatch_code() {
  17155. return static_cast<uint64_t>(X509_V_ERR_HOSTNAME_MISMATCH);
  17156. }
  17157. inline long get_verify_result(const_session_t session) {
  17158. if (!session) return X509_V_ERR_UNSPECIFIED;
  17159. return SSL_get_verify_result(static_cast<SSL *>(const_cast<void *>(session)));
  17160. }
  17161. inline std::string get_cert_subject_cn(cert_t cert) {
  17162. if (!cert) return "";
  17163. auto x509 = static_cast<X509 *>(cert);
  17164. auto subject_name = X509_get_subject_name(x509);
  17165. if (!subject_name) return "";
  17166. // X509_NAME_get_text_by_NID is deprecated since OpenSSL 4.0
  17167. auto idx = X509_NAME_get_index_by_NID(subject_name, NID_commonName, -1);
  17168. if (idx < 0) return "";
  17169. auto entry = X509_NAME_get_entry(subject_name, idx);
  17170. if (!entry) return "";
  17171. auto data = X509_NAME_ENTRY_get_data(entry);
  17172. if (!data) return "";
  17173. return std::string(
  17174. reinterpret_cast<const char *>(ASN1_STRING_get0_data(data)),
  17175. static_cast<size_t>(ASN1_STRING_length(data)));
  17176. }
  17177. inline std::string get_cert_issuer_name(cert_t cert) {
  17178. if (!cert) return "";
  17179. auto x509 = static_cast<X509 *>(cert);
  17180. auto issuer_name = X509_get_issuer_name(x509);
  17181. if (!issuer_name) return "";
  17182. char buf[256];
  17183. X509_NAME_oneline(issuer_name, buf, sizeof(buf));
  17184. return std::string(buf);
  17185. }
  17186. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  17187. sans.clear();
  17188. if (!cert) return false;
  17189. auto x509 = static_cast<X509 *>(cert);
  17190. auto names = static_cast<GENERAL_NAMES *>(
  17191. X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  17192. if (!names) return true; // No SANs is valid
  17193. auto count = sk_GENERAL_NAME_num(names);
  17194. for (decltype(count) i = 0; i < count; i++) {
  17195. auto gen = sk_GENERAL_NAME_value(names, i);
  17196. if (!gen) continue;
  17197. SanEntry entry;
  17198. switch (gen->type) {
  17199. case GEN_DNS:
  17200. entry.type = SanType::DNS;
  17201. if (gen->d.dNSName) {
  17202. entry.value = std::string(
  17203. reinterpret_cast<const char *>(
  17204. ASN1_STRING_get0_data(gen->d.dNSName)),
  17205. static_cast<size_t>(ASN1_STRING_length(gen->d.dNSName)));
  17206. }
  17207. break;
  17208. case GEN_IPADD:
  17209. entry.type = SanType::IP;
  17210. if (gen->d.iPAddress) {
  17211. auto data = ASN1_STRING_get0_data(gen->d.iPAddress);
  17212. auto len = ASN1_STRING_length(gen->d.iPAddress);
  17213. if (len == 4) {
  17214. // IPv4
  17215. char buf[INET_ADDRSTRLEN];
  17216. inet_ntop(AF_INET, data, buf, sizeof(buf));
  17217. entry.value = buf;
  17218. } else if (len == 16) {
  17219. // IPv6
  17220. char buf[INET6_ADDRSTRLEN];
  17221. inet_ntop(AF_INET6, data, buf, sizeof(buf));
  17222. entry.value = buf;
  17223. }
  17224. }
  17225. break;
  17226. case GEN_EMAIL:
  17227. entry.type = SanType::EMAIL;
  17228. if (gen->d.rfc822Name) {
  17229. entry.value = std::string(
  17230. reinterpret_cast<const char *>(
  17231. ASN1_STRING_get0_data(gen->d.rfc822Name)),
  17232. static_cast<size_t>(ASN1_STRING_length(gen->d.rfc822Name)));
  17233. }
  17234. break;
  17235. case GEN_URI:
  17236. entry.type = SanType::URI;
  17237. if (gen->d.uniformResourceIdentifier) {
  17238. entry.value = std::string(
  17239. reinterpret_cast<const char *>(
  17240. ASN1_STRING_get0_data(gen->d.uniformResourceIdentifier)),
  17241. static_cast<size_t>(
  17242. ASN1_STRING_length(gen->d.uniformResourceIdentifier)));
  17243. }
  17244. break;
  17245. default: entry.type = SanType::OTHER; break;
  17246. }
  17247. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  17248. }
  17249. GENERAL_NAMES_free(names);
  17250. return true;
  17251. }
  17252. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  17253. time_t &not_after) {
  17254. if (!cert) return false;
  17255. auto x509 = static_cast<X509 *>(cert);
  17256. auto nb = X509_get0_notBefore(x509);
  17257. auto na = X509_get0_notAfter(x509);
  17258. if (!nb || !na) return false;
  17259. ASN1_TIME *epoch = ASN1_TIME_new();
  17260. if (!epoch) return false;
  17261. auto se = detail::scope_exit([&] { ASN1_TIME_free(epoch); });
  17262. if (!ASN1_TIME_set(epoch, 0)) return false;
  17263. int pday, psec;
  17264. if (!ASN1_TIME_diff(&pday, &psec, epoch, nb)) return false;
  17265. not_before = 86400 * (time_t)pday + psec;
  17266. if (!ASN1_TIME_diff(&pday, &psec, epoch, na)) return false;
  17267. not_after = 86400 * (time_t)pday + psec;
  17268. return true;
  17269. }
  17270. inline std::string get_cert_serial(cert_t cert) {
  17271. if (!cert) return "";
  17272. auto x509 = static_cast<X509 *>(cert);
  17273. auto serial = X509_get_serialNumber(x509);
  17274. if (!serial) return "";
  17275. auto bn = ASN1_INTEGER_to_BN(serial, nullptr);
  17276. if (!bn) return "";
  17277. auto hex = BN_bn2hex(bn);
  17278. BN_free(bn);
  17279. if (!hex) return "";
  17280. std::string result(hex);
  17281. OPENSSL_free(hex);
  17282. return result;
  17283. }
  17284. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  17285. if (!cert) return false;
  17286. auto x509 = static_cast<X509 *>(cert);
  17287. auto len = i2d_X509(x509, nullptr);
  17288. if (len < 0) return false;
  17289. der.resize(static_cast<size_t>(len));
  17290. auto p = der.data();
  17291. i2d_X509(x509, &p);
  17292. return true;
  17293. }
  17294. inline const char *get_sni(const_session_t session) {
  17295. if (!session) return nullptr;
  17296. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17297. return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
  17298. }
  17299. inline uint64_t peek_error() { return ERR_peek_last_error(); }
  17300. inline uint64_t get_error() { return ERR_get_error(); }
  17301. inline std::string error_string(uint64_t code) {
  17302. char buf[256];
  17303. ERR_error_string_n(static_cast<unsigned long>(code), buf, sizeof(buf));
  17304. return std::string(buf);
  17305. }
  17306. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  17307. auto mem = BIO_new_mem_buf(pem, static_cast<int>(len));
  17308. if (!mem) { return nullptr; }
  17309. auto mem_guard = detail::scope_exit([&] { BIO_free_all(mem); });
  17310. auto inf = PEM_X509_INFO_read_bio(mem, nullptr, nullptr, nullptr);
  17311. if (!inf) { return nullptr; }
  17312. auto store = X509_STORE_new();
  17313. if (store) {
  17314. for (auto i = 0; i < static_cast<int>(sk_X509_INFO_num(inf)); i++) {
  17315. auto itmp = sk_X509_INFO_value(inf, i);
  17316. if (!itmp) { continue; }
  17317. if (itmp->x509) { X509_STORE_add_cert(store, itmp->x509); }
  17318. if (itmp->crl) { X509_STORE_add_crl(store, itmp->crl); }
  17319. }
  17320. }
  17321. sk_X509_INFO_pop_free(inf, X509_INFO_free);
  17322. return static_cast<ca_store_t>(store);
  17323. }
  17324. inline void free_ca_store(ca_store_t store) {
  17325. if (store) { X509_STORE_free(static_cast<X509_STORE *>(store)); }
  17326. }
  17327. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  17328. if (!ctx || !store) { return false; }
  17329. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17330. auto x509_store = static_cast<X509_STORE *>(store);
  17331. // Check if same store is already set
  17332. if (SSL_CTX_get_cert_store(ssl_ctx) == x509_store) { return true; }
  17333. // SSL_CTX_set_cert_store takes ownership and frees the old store
  17334. SSL_CTX_set_cert_store(ssl_ctx, x509_store);
  17335. return true;
  17336. }
  17337. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  17338. certs.clear();
  17339. if (!ctx) { return 0; }
  17340. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17341. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17342. if (!store) { return 0; }
  17343. auto objs = impl::get_store_objects(store);
  17344. if (!objs) { return 0; }
  17345. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  17346. auto count = sk_X509_OBJECT_num(objs);
  17347. for (decltype(count) i = 0; i < count; i++) {
  17348. auto obj = sk_X509_OBJECT_value(objs, i);
  17349. if (!obj) { continue; }
  17350. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  17351. auto x509 = X509_OBJECT_get0_X509(obj);
  17352. if (x509) {
  17353. // Increment reference count so caller can free it
  17354. X509_up_ref(x509);
  17355. certs.push_back(static_cast<cert_t>(x509));
  17356. }
  17357. }
  17358. }
  17359. return certs.size();
  17360. }
  17361. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  17362. std::vector<std::string> names;
  17363. if (!ctx) { return names; }
  17364. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17365. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17366. if (!store) { return names; }
  17367. auto objs = impl::get_store_objects(store);
  17368. if (!objs) { return names; }
  17369. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  17370. auto count = sk_X509_OBJECT_num(objs);
  17371. for (decltype(count) i = 0; i < count; i++) {
  17372. auto obj = sk_X509_OBJECT_value(objs, i);
  17373. if (!obj) { continue; }
  17374. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  17375. auto x509 = X509_OBJECT_get0_X509(obj);
  17376. if (x509) {
  17377. auto subject = X509_get_subject_name(x509);
  17378. if (subject) {
  17379. char buf[512];
  17380. X509_NAME_oneline(subject, buf, sizeof(buf));
  17381. names.push_back(buf);
  17382. }
  17383. }
  17384. }
  17385. }
  17386. return names;
  17387. }
  17388. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  17389. const char *key_pem, const char *password) {
  17390. if (!ctx || !cert_pem || !key_pem) { return false; }
  17391. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17392. // Load certificate from PEM
  17393. auto cert_bio = BIO_new_mem_buf(cert_pem, -1);
  17394. if (!cert_bio) { return false; }
  17395. auto cert = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  17396. BIO_free(cert_bio);
  17397. if (!cert) { return false; }
  17398. // Load private key from PEM
  17399. auto key_bio = BIO_new_mem_buf(key_pem, -1);
  17400. if (!key_bio) {
  17401. X509_free(cert);
  17402. return false;
  17403. }
  17404. auto key = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  17405. password ? const_cast<char *>(password)
  17406. : nullptr);
  17407. BIO_free(key_bio);
  17408. if (!key) {
  17409. X509_free(cert);
  17410. return false;
  17411. }
  17412. // Update certificate and key
  17413. auto ret = SSL_CTX_use_certificate(ssl_ctx, cert) == 1 &&
  17414. SSL_CTX_use_PrivateKey(ssl_ctx, key) == 1;
  17415. X509_free(cert);
  17416. EVP_PKEY_free(key);
  17417. return ret;
  17418. }
  17419. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  17420. if (!ctx || !ca_pem) { return false; }
  17421. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17422. // Create new X509_STORE from PEM
  17423. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  17424. if (!store) { return false; }
  17425. // SSL_CTX_set_cert_store takes ownership
  17426. SSL_CTX_set_cert_store(ssl_ctx, static_cast<X509_STORE *>(store));
  17427. // Set client CA list for client certificate request
  17428. auto ca_list = impl::create_client_ca_list_from_pem(ca_pem);
  17429. if (ca_list) {
  17430. // SSL_CTX_set_client_CA_list takes ownership of ca_list
  17431. SSL_CTX_set_client_CA_list(ssl_ctx, ca_list);
  17432. }
  17433. // A resumed session is not verified again, so forget the sessions and the
  17434. // ticket keys from before, or a client verified under the old CAs could go
  17435. // on resuming.
  17436. #if OPENSSL_VERSION_NUMBER >= 0x30400000L
  17437. SSL_CTX_flush_sessions_ex(ssl_ctx, (std::numeric_limits<time_t>::max)());
  17438. #else
  17439. SSL_CTX_flush_sessions(ssl_ctx, (std::numeric_limits<long>::max)());
  17440. #endif
  17441. unsigned char ticket_keys[80];
  17442. if (RAND_bytes(ticket_keys, sizeof(ticket_keys)) == 1) {
  17443. SSL_CTX_set_tlsext_ticket_keys(ssl_ctx, ticket_keys, sizeof(ticket_keys));
  17444. }
  17445. return true;
  17446. }
  17447. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  17448. if (!ctx) { return false; }
  17449. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17450. auto index = impl::verify_callback_index();
  17451. if (index < 0) { return false; }
  17452. auto stored = callback ? new VerifyCallback(std::move(callback)) : nullptr;
  17453. delete static_cast<VerifyCallback *>(SSL_CTX_get_ex_data(ssl_ctx, index));
  17454. SSL_CTX_set_ex_data(ssl_ctx, index, stored);
  17455. if (stored) {
  17456. SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, impl::openssl_verify_callback);
  17457. } else {
  17458. SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, nullptr);
  17459. }
  17460. return true;
  17461. }
  17462. inline long get_verify_error(const_session_t session) {
  17463. if (!session) { return -1; }
  17464. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17465. return SSL_get_verify_result(ssl);
  17466. }
  17467. inline std::string verify_error_string(long error_code) {
  17468. if (error_code == X509_V_OK) { return ""; }
  17469. const char *str = X509_verify_cert_error_string(static_cast<int>(error_code));
  17470. return str ? str : "unknown error";
  17471. }
  17472. } // namespace tls
  17473. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  17474. /*
  17475. * Group 9: TLS abstraction layer - Mbed TLS backend
  17476. */
  17477. /*
  17478. * Mbed TLS Backend Implementation
  17479. */
  17480. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  17481. namespace tls {
  17482. namespace impl {
  17483. // Mbed TLS session wrapper
  17484. struct MbedTlsSession {
  17485. mbedtls_ssl_context ssl;
  17486. socket_t sock = INVALID_SOCKET;
  17487. std::string hostname; // For client: set via set_sni
  17488. std::string sni_hostname; // For server: received from client via SNI callback
  17489. // Mbed TLS has no SSL_peek() equivalent, so is_peer_closed() must probe with
  17490. // a real 1-byte mbedtls_ssl_read(). If that probe lands on application data
  17491. // (e.g. a response that arrived while this side was still in its post-write
  17492. // check), the byte is pushed back here and served by the next read().
  17493. unsigned char peeked_byte = 0;
  17494. bool has_peeked_byte = false;
  17495. // Set by set_sni() when the caller disabled hostname verification, so the
  17496. // verify callback can clear the CN/SAN mismatch flag while still enforcing
  17497. // the rest of the chain (Mbed TLS ties SNI and identity checking together;
  17498. // OpenSSL and wolfSSL keep them independent).
  17499. bool suppress_hostname_mismatch = false;
  17500. // Copied from the owning MbedTlsContext at creation, so a handshake only
  17501. // ever runs the callback of its own context.
  17502. VerifyCallback verify_callback;
  17503. MbedTlsSession() { mbedtls_ssl_init(&ssl); }
  17504. ~MbedTlsSession() { mbedtls_ssl_free(&ssl); }
  17505. MbedTlsSession(const MbedTlsSession &) = delete;
  17506. MbedTlsSession &operator=(const MbedTlsSession &) = delete;
  17507. };
  17508. // Thread-local error code accessor for Mbed TLS (since it doesn't have an error
  17509. // queue)
  17510. inline int &mbedtls_last_error() {
  17511. static thread_local int err = 0;
  17512. return err;
  17513. }
  17514. // Helper to map Mbed TLS error to ErrorCode
  17515. inline ErrorCode map_mbedtls_error(int ret, int &out_errno,
  17516. uint32_t verify_flags) {
  17517. if (ret == 0) { return ErrorCode::Success; }
  17518. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return ErrorCode::WantRead; }
  17519. if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) { return ErrorCode::WantWrite; }
  17520. if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
  17521. return ErrorCode::PeerClosed;
  17522. }
  17523. if (ret == MBEDTLS_ERR_NET_CONN_RESET || ret == MBEDTLS_ERR_NET_SEND_FAILED ||
  17524. ret == MBEDTLS_ERR_NET_RECV_FAILED) {
  17525. out_errno = errno;
  17526. return ErrorCode::SyscallError;
  17527. }
  17528. if (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED) {
  17529. // Unlike OpenSSL/wolfSSL, Mbed TLS folds the CN/SAN identity check into
  17530. // the handshake's chain verification (see set_sni()); a mismatch there
  17531. // is reported the same way as any other verify_flags bit. Report it as
  17532. // HostnameMismatch, matching the other backends and the post-handshake
  17533. // identity check below, but only when naming is the sole problem -
  17534. // if the chain itself is also untrusted/expired/etc., that takes
  17535. // priority over the naming detail.
  17536. if (verify_flags == static_cast<uint32_t>(hostname_mismatch_code())) {
  17537. return ErrorCode::HostnameMismatch;
  17538. }
  17539. return ErrorCode::CertVerifyFailed;
  17540. }
  17541. return ErrorCode::Fatal;
  17542. }
  17543. // Populates a TlsError from a failed (non-zero) mbedtls_ssl_handshake()
  17544. // return value, including the verify-flags-dependent HostnameMismatch
  17545. // mapping; shared by connect() and connect_nonblocking() so the
  17546. // backend_code policy for that mapping only lives in one place.
  17547. inline void fill_mbedtls_tls_error(TlsError &err, mbedtls_ssl_context &ssl,
  17548. int ret) {
  17549. auto verify_flags = mbedtls_ssl_get_verify_result(&ssl);
  17550. err.code = map_mbedtls_error(ret, err.sys_errno, verify_flags);
  17551. err.backend_code = err.code == ErrorCode::HostnameMismatch
  17552. ? static_cast<uint64_t>(verify_flags)
  17553. : static_cast<uint64_t>(-ret);
  17554. }
  17555. // A TLS 1.3 NewSessionTicket (signaled by default on Mbed TLS 4.x) is a
  17556. // non-fatal notification delivered between records, not an error and not
  17557. // application data, so I/O calls that see it should just be retried. Kept in
  17558. // one helper so the retry loops keep an intact "do { } while (...)" instead of
  17559. // splitting the closing brace across an #if.
  17560. inline bool mbedtls_is_session_ticket(int ret) {
  17561. #if defined(MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET)
  17562. return ret == MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
  17563. #else
  17564. (void)ret;
  17565. return false;
  17566. #endif
  17567. }
  17568. // BIO-like send callback for Mbed TLS
  17569. inline int mbedtls_net_send_cb(void *ctx, const unsigned char *buf,
  17570. size_t len) {
  17571. auto sock = *static_cast<socket_t *>(ctx);
  17572. #ifdef _WIN32
  17573. auto ret =
  17574. send(sock, reinterpret_cast<const char *>(buf), static_cast<int>(len), 0);
  17575. if (ret == SOCKET_ERROR) {
  17576. int err = WSAGetLastError();
  17577. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_WRITE; }
  17578. return MBEDTLS_ERR_NET_SEND_FAILED;
  17579. }
  17580. #else
  17581. auto ret = send(sock, buf, len, 0);
  17582. if (ret < 0) {
  17583. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17584. return MBEDTLS_ERR_SSL_WANT_WRITE;
  17585. }
  17586. return MBEDTLS_ERR_NET_SEND_FAILED;
  17587. }
  17588. #endif
  17589. return static_cast<int>(ret);
  17590. }
  17591. // BIO-like recv callback for Mbed TLS
  17592. inline int mbedtls_net_recv_cb(void *ctx, unsigned char *buf, size_t len) {
  17593. auto sock = *static_cast<socket_t *>(ctx);
  17594. #ifdef _WIN32
  17595. auto ret =
  17596. recv(sock, reinterpret_cast<char *>(buf), static_cast<int>(len), 0);
  17597. if (ret == SOCKET_ERROR) {
  17598. int err = WSAGetLastError();
  17599. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_READ; }
  17600. return MBEDTLS_ERR_NET_RECV_FAILED;
  17601. }
  17602. #else
  17603. auto ret = recv(sock, buf, len, 0);
  17604. if (ret < 0) {
  17605. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17606. return MBEDTLS_ERR_SSL_WANT_READ;
  17607. }
  17608. return MBEDTLS_ERR_NET_RECV_FAILED;
  17609. }
  17610. #endif
  17611. if (ret == 0) { return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY; }
  17612. return static_cast<int>(ret);
  17613. }
  17614. // MbedTlsContext constructor/destructor implementations
  17615. inline MbedTlsContext::MbedTlsContext() {
  17616. mbedtls_ssl_config_init(&conf);
  17617. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17618. mbedtls_entropy_init(&entropy);
  17619. mbedtls_ctr_drbg_init(&ctr_drbg);
  17620. #endif
  17621. mbedtls_x509_crt_init(&ca_chain);
  17622. mbedtls_x509_crt_init(&own_cert);
  17623. mbedtls_pk_init(&own_key);
  17624. }
  17625. inline MbedTlsContext::~MbedTlsContext() {
  17626. mbedtls_pk_free(&own_key);
  17627. mbedtls_x509_crt_free(&own_cert);
  17628. mbedtls_x509_crt_free(&ca_chain);
  17629. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17630. mbedtls_ctr_drbg_free(&ctr_drbg);
  17631. mbedtls_entropy_free(&entropy);
  17632. #endif
  17633. mbedtls_ssl_config_free(&conf);
  17634. }
  17635. // Thread-local storage for SNI captured during handshake
  17636. // This is needed because the SNI callback doesn't have a way to pass
  17637. // session-specific data before the session is fully set up
  17638. inline std::string &mbedpending_sni() {
  17639. static thread_local std::string sni;
  17640. return sni;
  17641. }
  17642. // SNI callback for Mbed TLS server to capture client's SNI hostname
  17643. inline int mbedtls_sni_callback(void *p_ctx, mbedtls_ssl_context *ssl,
  17644. const unsigned char *name, size_t name_len) {
  17645. (void)p_ctx;
  17646. (void)ssl;
  17647. // Store SNI name in thread-local storage
  17648. // It will be retrieved and stored in the session after handshake
  17649. if (name && name_len > 0) {
  17650. mbedpending_sni().assign(reinterpret_cast<const char *>(name), name_len);
  17651. } else {
  17652. mbedpending_sni().clear();
  17653. }
  17654. return 0; // Accept any SNI
  17655. }
  17656. inline void mbedtls_clear_cn_mismatch(uint32_t *flags) {
  17657. *flags &= ~static_cast<uint32_t>(hostname_mismatch_code());
  17658. }
  17659. // Verify callback used when hostname verification is disabled for a session
  17660. // that has no user-supplied verify callback of its own.
  17661. inline int mbedtls_mask_hostname_mismatch_callback(void *data,
  17662. mbedtls_x509_crt *, int,
  17663. uint32_t *flags) {
  17664. (void)data;
  17665. mbedtls_clear_cn_mismatch(flags);
  17666. return 0;
  17667. }
  17668. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  17669. int cert_depth, uint32_t *flags);
  17670. // MbedTLS verify callback wrapper
  17671. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  17672. int cert_depth, uint32_t *flags) {
  17673. // data points to the MbedTlsSession
  17674. auto *session = static_cast<MbedTlsSession *>(data);
  17675. // set_sni() disabled hostname verification for this session: drop the
  17676. // CN/SAN mismatch flag so it doesn't fail the chain check below, mirroring
  17677. // the OpenSSL/wolfSSL backends where identity checking is independent of
  17678. // SNI. The final pass/fail decision still comes from the remaining flags
  17679. // (or, below, from the user's own verify callback).
  17680. if (session->suppress_hostname_mismatch) { mbedtls_clear_cn_mismatch(flags); }
  17681. // Build context
  17682. VerifyContext verify_ctx;
  17683. verify_ctx.session = static_cast<session_t>(session);
  17684. verify_ctx.cert = static_cast<cert_t>(crt);
  17685. verify_ctx.depth = cert_depth;
  17686. verify_ctx.preverify_ok = (*flags == 0);
  17687. verify_ctx.error_code = static_cast<long>(*flags);
  17688. // Convert Mbed TLS flags to error string
  17689. static thread_local char error_buf[256];
  17690. if (*flags != 0) {
  17691. mbedtls_x509_crt_verify_info(error_buf, sizeof(error_buf), "", *flags);
  17692. verify_ctx.error_string = error_buf;
  17693. } else {
  17694. verify_ctx.error_string = nullptr;
  17695. }
  17696. bool accepted = session->verify_callback(verify_ctx);
  17697. if (accepted) {
  17698. *flags = 0; // Clear all error flags
  17699. return 0;
  17700. }
  17701. return MBEDTLS_ERR_X509_CERT_VERIFY_FAILED;
  17702. }
  17703. } // namespace impl
  17704. inline ctx_t create_client_context() {
  17705. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17706. if (!ctx) { return nullptr; }
  17707. ctx->is_server = false;
  17708. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17709. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17710. if (!detail::ensure_mbedtls_psa_crypto()) {
  17711. delete ctx;
  17712. return nullptr;
  17713. }
  17714. int ret;
  17715. #else
  17716. // Seed the random number generator
  17717. const char *pers = "httplib_client";
  17718. int ret = mbedtls_ctr_drbg_seed(
  17719. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  17720. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  17721. if (ret != 0) {
  17722. impl::mbedtls_last_error() = ret;
  17723. delete ctx;
  17724. return nullptr;
  17725. }
  17726. #endif
  17727. // Set up SSL config for client
  17728. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_CLIENT,
  17729. MBEDTLS_SSL_TRANSPORT_STREAM,
  17730. MBEDTLS_SSL_PRESET_DEFAULT);
  17731. if (ret != 0) {
  17732. impl::mbedtls_last_error() = ret;
  17733. delete ctx;
  17734. return nullptr;
  17735. }
  17736. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17737. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17738. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17739. #endif
  17740. // Default: verify peer certificate
  17741. mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  17742. // Set minimum TLS version to 1.2
  17743. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17744. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17745. #else
  17746. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17747. MBEDTLS_SSL_MINOR_VERSION_3);
  17748. #endif
  17749. return static_cast<ctx_t>(ctx);
  17750. }
  17751. inline ctx_t create_server_context() {
  17752. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17753. if (!ctx) { return nullptr; }
  17754. ctx->is_server = true;
  17755. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17756. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17757. if (!detail::ensure_mbedtls_psa_crypto()) {
  17758. delete ctx;
  17759. return nullptr;
  17760. }
  17761. int ret;
  17762. #else
  17763. // Seed the random number generator
  17764. const char *pers = "httplib_server";
  17765. int ret = mbedtls_ctr_drbg_seed(
  17766. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  17767. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  17768. if (ret != 0) {
  17769. impl::mbedtls_last_error() = ret;
  17770. delete ctx;
  17771. return nullptr;
  17772. }
  17773. #endif
  17774. // Set up SSL config for server
  17775. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_SERVER,
  17776. MBEDTLS_SSL_TRANSPORT_STREAM,
  17777. MBEDTLS_SSL_PRESET_DEFAULT);
  17778. if (ret != 0) {
  17779. impl::mbedtls_last_error() = ret;
  17780. delete ctx;
  17781. return nullptr;
  17782. }
  17783. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17784. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17785. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17786. #endif
  17787. // Default: don't verify client
  17788. mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_NONE);
  17789. // Set minimum TLS version to 1.2
  17790. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17791. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17792. #else
  17793. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17794. MBEDTLS_SSL_MINOR_VERSION_3);
  17795. #endif
  17796. // Set SNI callback to capture client's SNI hostname
  17797. mbedtls_ssl_conf_sni(&ctx->conf, impl::mbedtls_sni_callback, nullptr);
  17798. return static_cast<ctx_t>(ctx);
  17799. }
  17800. inline void free_context(ctx_t ctx) {
  17801. if (ctx) { delete static_cast<impl::MbedTlsContext *>(ctx); }
  17802. }
  17803. inline bool set_min_version(ctx_t ctx, Version version) {
  17804. if (!ctx) { return false; }
  17805. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17806. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17807. // Mbed TLS 3.x uses mbedtls_ssl_protocol_version enum
  17808. mbedtls_ssl_protocol_version min_ver = MBEDTLS_SSL_VERSION_TLS1_2;
  17809. if (version >= Version::TLS1_3) {
  17810. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  17811. min_ver = MBEDTLS_SSL_VERSION_TLS1_3;
  17812. #endif
  17813. }
  17814. mbedtls_ssl_conf_min_tls_version(&mctx->conf, min_ver);
  17815. #else
  17816. // Mbed TLS 2.x uses major/minor version numbers
  17817. int major = MBEDTLS_SSL_MAJOR_VERSION_3;
  17818. int minor = MBEDTLS_SSL_MINOR_VERSION_3; // TLS 1.2
  17819. if (version >= Version::TLS1_3) {
  17820. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  17821. minor = MBEDTLS_SSL_MINOR_VERSION_4; // TLS 1.3
  17822. #else
  17823. minor = MBEDTLS_SSL_MINOR_VERSION_3; // Fall back to TLS 1.2
  17824. #endif
  17825. }
  17826. mbedtls_ssl_conf_min_version(&mctx->conf, major, minor);
  17827. #endif
  17828. return true;
  17829. }
  17830. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  17831. if (!ctx || !pem) { return false; }
  17832. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17833. // mbedtls_x509_crt_parse expects null-terminated string for PEM
  17834. // Add null terminator if not present
  17835. std::string pem_str(pem, len);
  17836. int ret = mbedtls_x509_crt_parse(
  17837. &mctx->ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  17838. pem_str.size() + 1);
  17839. if (ret != 0) {
  17840. impl::mbedtls_last_error() = ret;
  17841. return false;
  17842. }
  17843. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17844. return true;
  17845. }
  17846. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  17847. if (!ctx || !file_path) { return false; }
  17848. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17849. int ret = mbedtls_x509_crt_parse_file(&mctx->ca_chain, file_path);
  17850. if (ret != 0) {
  17851. impl::mbedtls_last_error() = ret;
  17852. return false;
  17853. }
  17854. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17855. return true;
  17856. }
  17857. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  17858. if (!ctx || !dir_path) { return false; }
  17859. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17860. int ret = mbedtls_x509_crt_parse_path(&mctx->ca_chain, dir_path);
  17861. if (ret < 0) { // Returns number of certs on success, negative on error
  17862. impl::mbedtls_last_error() = ret;
  17863. return false;
  17864. }
  17865. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17866. return true;
  17867. }
  17868. inline bool load_system_certs(ctx_t ctx) {
  17869. if (!ctx) { return false; }
  17870. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17871. bool loaded = false;
  17872. #ifdef _WIN32
  17873. loaded = impl::enumerate_windows_system_certs(
  17874. [&](const unsigned char *data, size_t len) {
  17875. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  17876. });
  17877. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  17878. loaded = impl::enumerate_macos_keychain_certs(
  17879. [&](const unsigned char *data, size_t len) {
  17880. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  17881. });
  17882. #else
  17883. for (auto path = impl::system_ca_paths(); *path; ++path) {
  17884. if (mbedtls_x509_crt_parse_file(&mctx->ca_chain, *path) >= 0) {
  17885. loaded = true;
  17886. break;
  17887. }
  17888. }
  17889. if (!loaded) {
  17890. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  17891. if (mbedtls_x509_crt_parse_path(&mctx->ca_chain, *dir) >= 0) {
  17892. loaded = true;
  17893. break;
  17894. }
  17895. }
  17896. }
  17897. #endif
  17898. if (loaded) {
  17899. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17900. }
  17901. return loaded;
  17902. }
  17903. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17904. const char *password) {
  17905. if (!ctx || !cert || !key) { return false; }
  17906. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17907. // Parse certificate
  17908. std::string cert_str(cert);
  17909. int ret = mbedtls_x509_crt_parse(
  17910. &mctx->own_cert,
  17911. reinterpret_cast<const unsigned char *>(cert_str.c_str()),
  17912. cert_str.size() + 1);
  17913. if (ret != 0) {
  17914. impl::mbedtls_last_error() = ret;
  17915. return false;
  17916. }
  17917. // Parse private key
  17918. std::string key_str(key);
  17919. const unsigned char *pwd =
  17920. password ? reinterpret_cast<const unsigned char *>(password) : nullptr;
  17921. size_t pwd_len = password ? strlen(password) : 0;
  17922. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17923. ret = mbedtls_pk_parse_key(
  17924. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  17925. key_str.size() + 1, pwd, pwd_len, mbedtls_ctr_drbg_random,
  17926. &mctx->ctr_drbg);
  17927. #else
  17928. ret = mbedtls_pk_parse_key(
  17929. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  17930. key_str.size() + 1, pwd, pwd_len);
  17931. #endif
  17932. if (ret != 0) {
  17933. impl::mbedtls_last_error() = ret;
  17934. return false;
  17935. }
  17936. // Verify that the certificate and private key match.
  17937. // Mbed TLS 4.x: mbedtls_pk_check_pair() reports a spurious mismatch for
  17938. // PSA-backed keys, so skip it and let the handshake surface a real mismatch.
  17939. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17940. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17941. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  17942. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17943. #else
  17944. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  17945. #endif
  17946. if (ret != 0) {
  17947. impl::mbedtls_last_error() = ret;
  17948. return false;
  17949. }
  17950. #endif
  17951. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  17952. if (ret != 0) {
  17953. impl::mbedtls_last_error() = ret;
  17954. return false;
  17955. }
  17956. return true;
  17957. }
  17958. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  17959. const char *key_path, const char *password) {
  17960. if (!ctx || !cert_path || !key_path) { return false; }
  17961. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17962. // Parse certificate file
  17963. int ret = mbedtls_x509_crt_parse_file(&mctx->own_cert, cert_path);
  17964. if (ret != 0) {
  17965. impl::mbedtls_last_error() = ret;
  17966. return false;
  17967. }
  17968. // Parse private key file
  17969. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17970. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password,
  17971. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17972. #else
  17973. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password);
  17974. #endif
  17975. if (ret != 0) {
  17976. impl::mbedtls_last_error() = ret;
  17977. return false;
  17978. }
  17979. // Verify that the certificate and private key match.
  17980. // Mbed TLS 4.x: see set_client_cert() — skip the spurious check_pair.
  17981. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17982. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17983. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  17984. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17985. #else
  17986. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  17987. #endif
  17988. if (ret != 0) {
  17989. impl::mbedtls_last_error() = ret;
  17990. return false;
  17991. }
  17992. #endif
  17993. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  17994. if (ret != 0) {
  17995. impl::mbedtls_last_error() = ret;
  17996. return false;
  17997. }
  17998. return true;
  17999. }
  18000. inline void set_verify_client(ctx_t ctx, bool require) {
  18001. if (!ctx) { return; }
  18002. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18003. mctx->verify_client = require;
  18004. if (require) {
  18005. mbedtls_ssl_conf_authmode(&mctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  18006. } else {
  18007. // If a verify callback is set, use OPTIONAL mode to ensure the callback
  18008. // is called (matching OpenSSL behavior). Otherwise use NONE.
  18009. mbedtls_ssl_conf_authmode(&mctx->conf, mctx->verify_callback
  18010. ? MBEDTLS_SSL_VERIFY_OPTIONAL
  18011. : MBEDTLS_SSL_VERIFY_NONE);
  18012. }
  18013. }
  18014. inline session_t create_session(ctx_t ctx, socket_t sock) {
  18015. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  18016. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18017. auto session = new (std::nothrow) impl::MbedTlsSession();
  18018. if (!session) { return nullptr; }
  18019. session->sock = sock;
  18020. int ret = mbedtls_ssl_setup(&session->ssl, &mctx->conf);
  18021. if (ret != 0) {
  18022. impl::mbedtls_last_error() = ret;
  18023. delete session;
  18024. return nullptr;
  18025. }
  18026. // Explicitly opt out of in-handshake hostname verification by default;
  18027. // since Mbed TLS 3.6.4 a client handshake with certificate verification
  18028. // fails outright when no hostname was set. set_sni() installs the real
  18029. // hostname for DNS hosts; for IP hosts (where SNI must not be set) the
  18030. // caller verifies the certificate identity post-handshake via
  18031. // verify_hostname().
  18032. mbedtls_ssl_set_hostname(&session->ssl, nullptr);
  18033. // Set BIO callbacks
  18034. mbedtls_ssl_set_bio(&session->ssl, &session->sock, impl::mbedtls_net_send_cb,
  18035. impl::mbedtls_net_recv_cb, nullptr);
  18036. // Set per-session verify callback with session pointer if callback is
  18037. // registered
  18038. session->verify_callback = mctx->verify_callback;
  18039. if (session->verify_callback) {
  18040. mbedtls_ssl_set_verify(&session->ssl, impl::mbedtls_verify_callback,
  18041. session);
  18042. }
  18043. return static_cast<session_t>(session);
  18044. }
  18045. inline void free_session(session_t session) {
  18046. if (session) { delete static_cast<impl::MbedTlsSession *>(session); }
  18047. }
  18048. inline bool set_sni(session_t session, const char *hostname,
  18049. bool verify_hostname) {
  18050. if (!session || !hostname) { return false; }
  18051. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18052. // mbedtls_ssl_set_hostname() both sends the SNI extension and binds the
  18053. // handshake-time CN/SAN check to `hostname`; the two can't be requested
  18054. // independently, so a disabled hostname check is handled below by masking
  18055. // the resulting mismatch flag instead of skipping this call.
  18056. int ret = mbedtls_ssl_set_hostname(&msession->ssl, hostname);
  18057. if (ret != 0) {
  18058. impl::mbedtls_last_error() = ret;
  18059. return false;
  18060. }
  18061. msession->hostname = hostname;
  18062. if (!verify_hostname) {
  18063. msession->suppress_hostname_mismatch = true;
  18064. // If a user verify callback is already wired for this session,
  18065. // mbedtls_verify_callback() masks the mismatch flag itself before
  18066. // consulting it (see suppress_hostname_mismatch above) - reinstalling it
  18067. // here would be redundant. Otherwise install the masking callback alone.
  18068. if (!msession->verify_callback) {
  18069. mbedtls_ssl_set_verify(&msession->ssl,
  18070. impl::mbedtls_mask_hostname_mismatch_callback,
  18071. msession);
  18072. }
  18073. }
  18074. return true;
  18075. }
  18076. inline TlsError connect(session_t session) {
  18077. TlsError err;
  18078. if (!session) {
  18079. err.code = ErrorCode::Fatal;
  18080. return err;
  18081. }
  18082. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18083. int ret;
  18084. do {
  18085. ret = mbedtls_ssl_handshake(&msession->ssl);
  18086. } while (impl::mbedtls_is_session_ticket(ret));
  18087. if (ret == 0) {
  18088. err.code = ErrorCode::Success;
  18089. } else {
  18090. impl::fill_mbedtls_tls_error(err, msession->ssl, ret);
  18091. impl::mbedtls_last_error() = ret;
  18092. }
  18093. return err;
  18094. }
  18095. inline TlsError accept(session_t session) {
  18096. // Same as connect for Mbed TLS - handshake works for both client and server
  18097. auto result = connect(session);
  18098. // After successful handshake, capture SNI from thread-local storage
  18099. if (result.code == ErrorCode::Success && session) {
  18100. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18101. msession->sni_hostname = std::move(impl::mbedpending_sni());
  18102. impl::mbedpending_sni().clear();
  18103. }
  18104. return result;
  18105. }
  18106. inline bool connect_nonblocking(session_t session, socket_t sock,
  18107. time_t timeout_sec, time_t timeout_usec,
  18108. TlsError *err) {
  18109. if (!session) {
  18110. if (err) { err->code = ErrorCode::Fatal; }
  18111. return false;
  18112. }
  18113. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18114. // Set socket to non-blocking mode
  18115. detail::set_nonblocking(sock, true);
  18116. auto cleanup =
  18117. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18118. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  18119. int ret;
  18120. while ((ret = mbedtls_ssl_handshake(&msession->ssl)) != 0) {
  18121. // Non-fatal TLS 1.3 ticket; retry immediately.
  18122. if (impl::mbedtls_is_session_ticket(ret)) { continue; }
  18123. if (ret == MBEDTLS_ERR_SSL_WANT_READ) {
  18124. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  18125. } else if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) {
  18126. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  18127. }
  18128. // TlsError or timeout
  18129. if (err) { impl::fill_mbedtls_tls_error(*err, msession->ssl, ret); }
  18130. impl::mbedtls_last_error() = ret;
  18131. return false;
  18132. }
  18133. if (err) { err->code = ErrorCode::Success; }
  18134. return true;
  18135. }
  18136. inline bool accept_nonblocking(session_t session, socket_t sock,
  18137. time_t timeout_sec, time_t timeout_usec,
  18138. TlsError *err) {
  18139. // Same implementation as connect for Mbed TLS
  18140. bool result =
  18141. connect_nonblocking(session, sock, timeout_sec, timeout_usec, err);
  18142. // After successful handshake, capture SNI from thread-local storage
  18143. if (result && session) {
  18144. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18145. msession->sni_hostname = std::move(impl::mbedpending_sni());
  18146. impl::mbedpending_sni().clear();
  18147. }
  18148. return result;
  18149. }
  18150. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  18151. if (!session || !buf) {
  18152. err.code = ErrorCode::Fatal;
  18153. return -1;
  18154. }
  18155. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18156. // Serve a byte consumed by the is_peer_closed() probe before reading more.
  18157. if (msession->has_peeked_byte) {
  18158. if (len == 0) { return 0; }
  18159. auto p = static_cast<unsigned char *>(buf);
  18160. p[0] = msession->peeked_byte;
  18161. msession->has_peeked_byte = false;
  18162. size_t n = 1;
  18163. // Top up with any already-decrypted bytes without risking a block.
  18164. if (len > 1 && mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  18165. int extra = mbedtls_ssl_read(&msession->ssl, p + 1, len - 1);
  18166. if (extra > 0) { n += static_cast<size_t>(extra); }
  18167. }
  18168. err.code = ErrorCode::Success;
  18169. return static_cast<ssize_t>(n);
  18170. }
  18171. int ret;
  18172. do {
  18173. ret = mbedtls_ssl_read(&msession->ssl, static_cast<unsigned char *>(buf),
  18174. len);
  18175. } while (impl::mbedtls_is_session_ticket(ret));
  18176. if (ret > 0) {
  18177. err.code = ErrorCode::Success;
  18178. return static_cast<ssize_t>(ret);
  18179. }
  18180. if (ret == 0) {
  18181. err.code = ErrorCode::PeerClosed;
  18182. return 0;
  18183. }
  18184. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  18185. err.backend_code = static_cast<uint64_t>(-ret);
  18186. impl::mbedtls_last_error() = ret;
  18187. // mbedTLS signals a clean close_notify via a negative error code rather
  18188. // than 0; surface it as a clean EOF the way OpenSSL/wolfSSL do.
  18189. if (err.code == ErrorCode::PeerClosed) { return 0; }
  18190. return -1;
  18191. }
  18192. inline ssize_t write(session_t session, const void *buf, size_t len,
  18193. TlsError &err) {
  18194. if (!session || !buf) {
  18195. err.code = ErrorCode::Fatal;
  18196. return -1;
  18197. }
  18198. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18199. int ret;
  18200. do {
  18201. ret = mbedtls_ssl_write(&msession->ssl,
  18202. static_cast<const unsigned char *>(buf), len);
  18203. } while (impl::mbedtls_is_session_ticket(ret));
  18204. if (ret > 0) {
  18205. err.code = ErrorCode::Success;
  18206. return static_cast<ssize_t>(ret);
  18207. }
  18208. if (ret == 0) {
  18209. err.code = ErrorCode::PeerClosed;
  18210. return 0;
  18211. }
  18212. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  18213. err.backend_code = static_cast<uint64_t>(-ret);
  18214. impl::mbedtls_last_error() = ret;
  18215. return -1;
  18216. }
  18217. inline int pending(const_session_t session) {
  18218. if (!session) { return 0; }
  18219. auto msession =
  18220. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18221. return static_cast<int>(mbedtls_ssl_get_bytes_avail(&msession->ssl)) +
  18222. (msession->has_peeked_byte ? 1 : 0);
  18223. }
  18224. inline void shutdown(session_t session, bool graceful) {
  18225. if (!session) { return; }
  18226. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18227. if (graceful) {
  18228. // Try to send close_notify, but don't block forever
  18229. int ret;
  18230. int attempts = 0;
  18231. while ((ret = mbedtls_ssl_close_notify(&msession->ssl)) != 0 &&
  18232. attempts < 3) {
  18233. if (ret != MBEDTLS_ERR_SSL_WANT_READ &&
  18234. ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
  18235. break;
  18236. }
  18237. attempts++;
  18238. }
  18239. }
  18240. }
  18241. inline bool is_peer_closed(session_t session, socket_t sock) {
  18242. if (!session || sock == INVALID_SOCKET) { return true; }
  18243. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18244. // Check if there's already decrypted or pushed-back data available.
  18245. // If so, the connection is definitely alive.
  18246. if (msession->has_peeked_byte ||
  18247. mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  18248. return false;
  18249. }
  18250. // Set socket to non-blocking to avoid blocking on read
  18251. detail::set_nonblocking(sock, true);
  18252. auto cleanup =
  18253. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18254. // Probe with a 1-byte read (Mbed TLS has no peek API). If the probe lands
  18255. // on application data — e.g. a response that already arrived — push the
  18256. // byte back so the next read() delivers it instead of losing it.
  18257. unsigned char buf;
  18258. int ret;
  18259. do {
  18260. ret = mbedtls_ssl_read(&msession->ssl, &buf, 1);
  18261. } while (impl::mbedtls_is_session_ticket(ret));
  18262. // If we got data or WANT_READ (would block), connection is alive
  18263. if (ret > 0) {
  18264. msession->peeked_byte = buf;
  18265. msession->has_peeked_byte = true;
  18266. return false;
  18267. }
  18268. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return false; }
  18269. // If we get a peer close notify or a connection reset, the peer is closed
  18270. return ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY ||
  18271. ret == MBEDTLS_ERR_NET_CONN_RESET || ret == 0;
  18272. }
  18273. inline cert_t get_peer_cert(const_session_t session) {
  18274. if (!session) { return nullptr; }
  18275. auto msession =
  18276. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18277. // Mbed TLS returns a pointer to the internal peer cert chain.
  18278. // WARNING: This pointer is only valid while the session is active.
  18279. // Do not use the certificate after calling free_session().
  18280. const mbedtls_x509_crt *cert = mbedtls_ssl_get_peer_cert(&msession->ssl);
  18281. return const_cast<mbedtls_x509_crt *>(cert);
  18282. }
  18283. inline size_t get_peer_certs(const_session_t session,
  18284. std::vector<cert_t> &certs) {
  18285. certs.clear();
  18286. // Mbed TLS parses the whole received chain into a list headed by the peer
  18287. // certificate, owned by the session like get_peer_cert()'s result
  18288. for (auto crt = static_cast<mbedtls_x509_crt *>(get_peer_cert(session));
  18289. crt && crt->raw.len > 0; crt = crt->next) {
  18290. certs.push_back(static_cast<cert_t>(crt));
  18291. }
  18292. return certs.size();
  18293. }
  18294. inline void free_cert(cert_t cert) {
  18295. // Mbed TLS: peer certificate is owned by the SSL context.
  18296. // No-op here, but callers should still call this for cross-backend
  18297. // portability.
  18298. (void)cert;
  18299. }
  18300. inline bool verify_hostname(cert_t cert, const char *hostname) {
  18301. if (!cert || !hostname) { return false; }
  18302. auto mcert = static_cast<const mbedtls_x509_crt *>(cert);
  18303. std::string host_str(hostname);
  18304. // Check if hostname is an IP address (IPv4 or IPv6)
  18305. unsigned char ip_bytes[16];
  18306. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  18307. auto is_ip = ip_len > 0;
  18308. // Check Subject Alternative Names (SAN). Mbed TLS keeps the GeneralName type
  18309. // in buf.tag and the raw value in buf.p / buf.len.
  18310. const mbedtls_x509_sequence *san = &mcert->subject_alt_names;
  18311. while (san != nullptr && san->buf.p != nullptr && san->buf.len > 0) {
  18312. const unsigned char *p = san->buf.p;
  18313. size_t len = san->buf.len;
  18314. auto san_type = san->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK;
  18315. if (is_ip) {
  18316. // For an IP host, only a matching iPAddress SAN of the same family
  18317. // (4 bytes for IPv4, 16 bytes for IPv6) may authenticate it.
  18318. if (san_type == MBEDTLS_X509_SAN_IP_ADDRESS && len == ip_len &&
  18319. memcmp(p, ip_bytes, ip_len) == 0) {
  18320. return true;
  18321. }
  18322. } else if (san_type == MBEDTLS_X509_SAN_DNS_NAME) {
  18323. std::string san_name(reinterpret_cast<const char *>(p), len);
  18324. if (detail::match_hostname(san_name, host_str)) { return true; }
  18325. }
  18326. san = san->next;
  18327. }
  18328. // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
  18329. // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
  18330. // the OpenSSL backend's X509_check_ip behaves the same way).
  18331. if (!is_ip) {
  18332. char cn[256];
  18333. int ret = mbedtls_x509_dn_gets(cn, sizeof(cn), &mcert->subject);
  18334. if (ret > 0) {
  18335. std::string cn_str(cn);
  18336. // Look for "CN=" in the DN string
  18337. size_t cn_pos = cn_str.find("CN=");
  18338. if (cn_pos != std::string::npos) {
  18339. size_t start = cn_pos + 3;
  18340. size_t end = cn_str.find(',', start);
  18341. std::string cn_value =
  18342. cn_str.substr(start, end == std::string::npos ? end : end - start);
  18343. if (detail::match_hostname(cn_value, host_str)) { return true; }
  18344. }
  18345. }
  18346. }
  18347. return false;
  18348. }
  18349. inline uint64_t hostname_mismatch_code() {
  18350. return static_cast<uint64_t>(MBEDTLS_X509_BADCERT_CN_MISMATCH);
  18351. }
  18352. inline long get_verify_result(const_session_t session) {
  18353. if (!session) { return -1; }
  18354. auto msession =
  18355. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18356. uint32_t flags = mbedtls_ssl_get_verify_result(&msession->ssl);
  18357. // Return 0 (X509_V_OK equivalent) if verification passed
  18358. return flags == 0 ? 0 : static_cast<long>(flags);
  18359. }
  18360. inline std::string get_cert_subject_cn(cert_t cert) {
  18361. if (!cert) return "";
  18362. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18363. // Find the CN in the subject
  18364. const mbedtls_x509_name *name = &x509->subject;
  18365. while (name != nullptr) {
  18366. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  18367. return std::string(reinterpret_cast<const char *>(name->val.p),
  18368. name->val.len);
  18369. }
  18370. name = name->next;
  18371. }
  18372. return "";
  18373. }
  18374. inline std::string get_cert_issuer_name(cert_t cert) {
  18375. if (!cert) return "";
  18376. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18377. // Build a human-readable issuer name string
  18378. char buf[512];
  18379. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &x509->issuer);
  18380. if (ret < 0) return "";
  18381. return std::string(buf);
  18382. }
  18383. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  18384. sans.clear();
  18385. if (!cert) return false;
  18386. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18387. // Parse the Subject Alternative Name extension
  18388. const mbedtls_x509_sequence *cur = &x509->subject_alt_names;
  18389. while (cur != nullptr) {
  18390. if (cur->buf.len > 0) {
  18391. const unsigned char *p = cur->buf.p;
  18392. size_t value_len = cur->buf.len;
  18393. SanEntry entry;
  18394. switch (cur->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK) {
  18395. case MBEDTLS_X509_SAN_DNS_NAME:
  18396. entry.type = SanType::DNS;
  18397. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18398. break;
  18399. case MBEDTLS_X509_SAN_IP_ADDRESS:
  18400. entry.type = SanType::IP;
  18401. if (value_len == 4) {
  18402. // IPv4
  18403. char buf[16];
  18404. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", p[0], p[1], p[2], p[3]);
  18405. entry.value = buf;
  18406. } else if (value_len == 16) {
  18407. // IPv6
  18408. char buf[64];
  18409. snprintf(buf, sizeof(buf),
  18410. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  18411. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  18412. p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8], p[9],
  18413. p[10], p[11], p[12], p[13], p[14], p[15]);
  18414. entry.value = buf;
  18415. }
  18416. break;
  18417. case MBEDTLS_X509_SAN_RFC822_NAME:
  18418. entry.type = SanType::EMAIL;
  18419. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18420. break;
  18421. case MBEDTLS_X509_SAN_UNIFORM_RESOURCE_IDENTIFIER:
  18422. entry.type = SanType::URI;
  18423. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18424. break;
  18425. default: entry.type = SanType::OTHER; break;
  18426. }
  18427. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  18428. }
  18429. cur = cur->next;
  18430. }
  18431. return true;
  18432. }
  18433. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  18434. time_t &not_after) {
  18435. if (!cert) return false;
  18436. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18437. // Convert mbedtls_x509_time to time_t
  18438. auto to_time_t = [](const mbedtls_x509_time &t) -> time_t {
  18439. struct tm tm_time = {};
  18440. tm_time.tm_year = t.year - 1900;
  18441. tm_time.tm_mon = t.mon - 1;
  18442. tm_time.tm_mday = t.day;
  18443. tm_time.tm_hour = t.hour;
  18444. tm_time.tm_min = t.min;
  18445. tm_time.tm_sec = t.sec;
  18446. #ifdef _WIN32
  18447. return _mkgmtime(&tm_time);
  18448. #else
  18449. return timegm(&tm_time);
  18450. #endif
  18451. };
  18452. not_before = to_time_t(x509->valid_from);
  18453. not_after = to_time_t(x509->valid_to);
  18454. return true;
  18455. }
  18456. inline std::string get_cert_serial(cert_t cert) {
  18457. if (!cert) return "";
  18458. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18459. // Convert serial number to hex string
  18460. std::string result;
  18461. result.reserve(x509->serial.len * 2);
  18462. for (size_t i = 0; i < x509->serial.len; i++) {
  18463. char hex[3];
  18464. snprintf(hex, sizeof(hex), "%02X", x509->serial.p[i]);
  18465. result += hex;
  18466. }
  18467. return result;
  18468. }
  18469. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  18470. if (!cert) return false;
  18471. auto crt = static_cast<mbedtls_x509_crt *>(cert);
  18472. if (!crt->raw.p || crt->raw.len == 0) return false;
  18473. der.assign(crt->raw.p, crt->raw.p + crt->raw.len);
  18474. return true;
  18475. }
  18476. inline const char *get_sni(const_session_t session) {
  18477. if (!session) return nullptr;
  18478. auto msession = static_cast<const impl::MbedTlsSession *>(session);
  18479. // For server: return SNI received from client during handshake
  18480. if (!msession->sni_hostname.empty()) {
  18481. return msession->sni_hostname.c_str();
  18482. }
  18483. // For client: return the hostname set via set_sni
  18484. if (!msession->hostname.empty()) { return msession->hostname.c_str(); }
  18485. return nullptr;
  18486. }
  18487. inline uint64_t peek_error() {
  18488. // Mbed TLS doesn't have an error queue, return the last error
  18489. return static_cast<uint64_t>(-impl::mbedtls_last_error());
  18490. }
  18491. inline uint64_t get_error() {
  18492. // Mbed TLS doesn't have an error queue, return and clear the last error
  18493. uint64_t err = static_cast<uint64_t>(-impl::mbedtls_last_error());
  18494. impl::mbedtls_last_error() = 0;
  18495. return err;
  18496. }
  18497. inline std::string error_string(uint64_t code) {
  18498. char buf[256];
  18499. mbedtls_strerror(-static_cast<int>(code), buf, sizeof(buf));
  18500. return std::string(buf);
  18501. }
  18502. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  18503. auto *ca_chain = new (std::nothrow) mbedtls_x509_crt;
  18504. if (!ca_chain) { return nullptr; }
  18505. mbedtls_x509_crt_init(ca_chain);
  18506. // mbedtls_x509_crt_parse expects null-terminated PEM
  18507. int ret = mbedtls_x509_crt_parse(ca_chain,
  18508. reinterpret_cast<const unsigned char *>(pem),
  18509. len + 1); // +1 for null terminator
  18510. if (ret != 0) {
  18511. // Try without +1 in case PEM is already null-terminated
  18512. ret = mbedtls_x509_crt_parse(
  18513. ca_chain, reinterpret_cast<const unsigned char *>(pem), len);
  18514. if (ret != 0) {
  18515. mbedtls_x509_crt_free(ca_chain);
  18516. delete ca_chain;
  18517. return nullptr;
  18518. }
  18519. }
  18520. return static_cast<ca_store_t>(ca_chain);
  18521. }
  18522. inline void free_ca_store(ca_store_t store) {
  18523. if (store) {
  18524. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18525. mbedtls_x509_crt_free(ca_chain);
  18526. delete ca_chain;
  18527. }
  18528. }
  18529. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  18530. if (!ctx || !store) { return false; }
  18531. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18532. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18533. // Free existing CA chain
  18534. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  18535. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  18536. // Copy the CA chain (deep copy)
  18537. // Parse from the raw data of the source cert
  18538. mbedtls_x509_crt *src = ca_chain;
  18539. while (src != nullptr) {
  18540. int ret = mbedtls_x509_crt_parse_der(&mbed_ctx->ca_chain, src->raw.p,
  18541. src->raw.len);
  18542. if (ret != 0) {
  18543. free_ca_store(store);
  18544. return false;
  18545. }
  18546. src = src->next;
  18547. }
  18548. // This function takes ownership of the store; the chain was deep-copied
  18549. // above, so release the source
  18550. free_ca_store(store);
  18551. // Update the SSL config to use the new CA chain
  18552. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18553. return true;
  18554. }
  18555. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  18556. certs.clear();
  18557. if (!ctx) { return 0; }
  18558. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18559. // Iterate through the CA chain
  18560. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  18561. while (cert != nullptr && cert->raw.len > 0) {
  18562. // Create a copy of the certificate for the caller
  18563. auto *copy = new mbedtls_x509_crt;
  18564. mbedtls_x509_crt_init(copy);
  18565. int ret = mbedtls_x509_crt_parse_der(copy, cert->raw.p, cert->raw.len);
  18566. if (ret == 0) {
  18567. certs.push_back(static_cast<cert_t>(copy));
  18568. } else {
  18569. mbedtls_x509_crt_free(copy);
  18570. delete copy;
  18571. }
  18572. cert = cert->next;
  18573. }
  18574. return certs.size();
  18575. }
  18576. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  18577. std::vector<std::string> names;
  18578. if (!ctx) { return names; }
  18579. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18580. // Iterate through the CA chain
  18581. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  18582. while (cert != nullptr && cert->raw.len > 0) {
  18583. char buf[512];
  18584. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &cert->subject);
  18585. if (ret > 0) { names.push_back(buf); }
  18586. cert = cert->next;
  18587. }
  18588. return names;
  18589. }
  18590. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  18591. const char *key_pem, const char *password) {
  18592. if (!ctx || !cert_pem || !key_pem) { return false; }
  18593. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18594. // Parse into new objects first, so that a bad pair leaves the old one in
  18595. // place, and swap them in after; the old ones are freed on the way out.
  18596. mbedtls_x509_crt cert;
  18597. mbedtls_pk_context key;
  18598. mbedtls_x509_crt_init(&cert);
  18599. mbedtls_pk_init(&key);
  18600. auto se = detail::scope_exit([&] {
  18601. mbedtls_x509_crt_free(&cert);
  18602. mbedtls_pk_free(&key);
  18603. });
  18604. // Parse certificate PEM
  18605. int ret = mbedtls_x509_crt_parse(
  18606. &cert, reinterpret_cast<const unsigned char *>(cert_pem),
  18607. strlen(cert_pem) + 1);
  18608. if (ret != 0) {
  18609. impl::mbedtls_last_error() = ret;
  18610. return false;
  18611. }
  18612. // Parse private key PEM
  18613. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18614. ret = mbedtls_pk_parse_key(
  18615. &key, reinterpret_cast<const unsigned char *>(key_pem),
  18616. strlen(key_pem) + 1,
  18617. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18618. password ? strlen(password) : 0, mbedtls_ctr_drbg_random,
  18619. &mbed_ctx->ctr_drbg);
  18620. #else
  18621. ret = mbedtls_pk_parse_key(
  18622. &key, reinterpret_cast<const unsigned char *>(key_pem),
  18623. strlen(key_pem) + 1,
  18624. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18625. password ? strlen(password) : 0);
  18626. #endif
  18627. if (ret != 0) {
  18628. impl::mbedtls_last_error() = ret;
  18629. return false;
  18630. }
  18631. std::swap(mbed_ctx->own_cert, cert);
  18632. std::swap(mbed_ctx->own_key, key);
  18633. // Configure SSL to use the new certificate and key
  18634. ret = mbedtls_ssl_conf_own_cert(&mbed_ctx->conf, &mbed_ctx->own_cert,
  18635. &mbed_ctx->own_key);
  18636. if (ret != 0) {
  18637. impl::mbedtls_last_error() = ret;
  18638. return false;
  18639. }
  18640. return true;
  18641. }
  18642. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  18643. if (!ctx || !ca_pem) { return false; }
  18644. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18645. // Parse into a new chain first, so that a bad one leaves the old in place
  18646. mbedtls_x509_crt chain;
  18647. mbedtls_x509_crt_init(&chain);
  18648. auto se = detail::scope_exit([&] { mbedtls_x509_crt_free(&chain); });
  18649. // Parse CA PEM
  18650. int ret = mbedtls_x509_crt_parse(
  18651. &chain, reinterpret_cast<const unsigned char *>(ca_pem),
  18652. strlen(ca_pem) + 1);
  18653. if (ret != 0) {
  18654. impl::mbedtls_last_error() = ret;
  18655. return false;
  18656. }
  18657. std::swap(mbed_ctx->ca_chain, chain);
  18658. // Update SSL config to use new CA chain
  18659. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18660. return true;
  18661. }
  18662. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  18663. if (!ctx) { return false; }
  18664. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18665. // create_session() hands each session its own copy to run.
  18666. mbed_ctx->verify_callback = std::move(callback);
  18667. if (mbed_ctx->verify_callback) {
  18668. // Set OPTIONAL mode to ensure callback is called even when verification
  18669. // is disabled (matching OpenSSL behavior where SSL_VERIFY_PEER is set)
  18670. mbedtls_ssl_conf_authmode(&mbed_ctx->conf, MBEDTLS_SSL_VERIFY_OPTIONAL);
  18671. }
  18672. return true;
  18673. }
  18674. inline long get_verify_error(const_session_t session) {
  18675. if (!session) { return -1; }
  18676. auto *msession =
  18677. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18678. return static_cast<long>(mbedtls_ssl_get_verify_result(&msession->ssl));
  18679. }
  18680. inline std::string verify_error_string(long error_code) {
  18681. if (error_code == 0) { return ""; }
  18682. char buf[256];
  18683. mbedtls_x509_crt_verify_info(buf, sizeof(buf), "",
  18684. static_cast<uint32_t>(error_code));
  18685. // Remove trailing newline if present
  18686. std::string result(buf);
  18687. while (!result.empty() && (result.back() == '\n' || result.back() == ' ')) {
  18688. result.pop_back();
  18689. }
  18690. return result;
  18691. }
  18692. } // namespace tls
  18693. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  18694. /*
  18695. * Group 10: TLS abstraction layer - wolfSSL backend
  18696. */
  18697. /*
  18698. * wolfSSL Backend Implementation
  18699. */
  18700. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  18701. namespace tls {
  18702. namespace impl {
  18703. // wolfSSL session wrapper
  18704. struct WolfSSLSession {
  18705. WOLFSSL *ssl = nullptr;
  18706. socket_t sock = INVALID_SOCKET;
  18707. std::string hostname; // For client: set via set_sni
  18708. std::string sni_hostname; // For server: received from client via SNI callback
  18709. WolfSSLSession() = default;
  18710. ~WolfSSLSession() {
  18711. if (ssl) { wolfSSL_free(ssl); }
  18712. }
  18713. WolfSSLSession(const WolfSSLSession &) = delete;
  18714. WolfSSLSession &operator=(const WolfSSLSession &) = delete;
  18715. };
  18716. // Thread-local error code accessor for wolfSSL
  18717. inline uint64_t &wolfssl_last_error() {
  18718. static thread_local uint64_t err = 0;
  18719. return err;
  18720. }
  18721. // Helper to map wolfSSL error to ErrorCode.
  18722. // ssl_error is the value from wolfSSL_get_error().
  18723. // raw_ret is the raw return value from the wolfSSL call (for low-level error).
  18724. inline ErrorCode map_wolfssl_error(WOLFSSL *ssl, int ssl_error,
  18725. int &out_errno) {
  18726. switch (ssl_error) {
  18727. case SSL_ERROR_NONE: return ErrorCode::Success;
  18728. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  18729. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  18730. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  18731. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  18732. default:
  18733. if (ssl) {
  18734. // wolfSSL stores the low-level error code as a negative value.
  18735. // DOMAIN_NAME_MISMATCH (-322) indicates hostname verification failure.
  18736. int low_err = ssl_error; // wolfSSL_get_error returns the low-level code
  18737. if (low_err == DOMAIN_NAME_MISMATCH) {
  18738. return ErrorCode::HostnameMismatch;
  18739. }
  18740. // Check verify result to distinguish cert verification from generic SSL
  18741. // errors.
  18742. long vr = wolfSSL_get_verify_result(ssl);
  18743. if (vr != 0) { return ErrorCode::CertVerifyFailed; }
  18744. }
  18745. return ErrorCode::Fatal;
  18746. }
  18747. }
  18748. // WolfSSLContext constructor/destructor implementations
  18749. inline WolfSSLContext::WolfSSLContext() { wolfSSL_Init(); }
  18750. inline WolfSSLContext::~WolfSSLContext() {
  18751. if (ctx) { wolfSSL_CTX_free(ctx); }
  18752. }
  18753. // Thread-local storage for SNI captured during handshake
  18754. inline std::string &wolfssl_pending_sni() {
  18755. static thread_local std::string sni;
  18756. return sni;
  18757. }
  18758. // SNI callback for wolfSSL server to capture client's SNI hostname
  18759. inline int wolfssl_sni_callback(WOLFSSL *ssl, int *ret, void *exArg) {
  18760. (void)ret;
  18761. (void)exArg;
  18762. void *name_data = nullptr;
  18763. unsigned short name_len =
  18764. wolfSSL_SNI_GetRequest(ssl, WOLFSSL_SNI_HOST_NAME, &name_data);
  18765. if (name_data && name_len > 0) {
  18766. wolfssl_pending_sni().assign(static_cast<const char *>(name_data),
  18767. name_len);
  18768. } else {
  18769. wolfssl_pending_sni().clear();
  18770. }
  18771. return 0; // Continue regardless
  18772. }
  18773. // The WOLFSSL_CTX points back to its WolfSSLContext, so a handshake only ever
  18774. // runs the verify callback of its own context.
  18775. inline int context_ex_data_index() {
  18776. static const auto index =
  18777. wolfSSL_CTX_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  18778. return index;
  18779. }
  18780. // Each WOLFSSL points back to its WolfSSLSession, the session_t that every
  18781. // other tls:: function takes.
  18782. inline int session_ex_data_index() {
  18783. static const auto index =
  18784. wolfSSL_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  18785. return index;
  18786. }
  18787. // wolfSSL verify callback wrapper
  18788. inline int wolfssl_verify_callback(int preverify_ok,
  18789. WOLFSSL_X509_STORE_CTX *x509_ctx) {
  18790. // Get the WOLFSSL object from the X509_STORE_CTX
  18791. WOLFSSL *ssl = static_cast<WOLFSSL *>(wolfSSL_X509_STORE_CTX_get_ex_data(
  18792. x509_ctx, wolfSSL_get_ex_data_X509_STORE_CTX_idx()));
  18793. if (!ssl) { return preverify_ok; }
  18794. auto wctx = static_cast<WolfSSLContext *>(wolfSSL_CTX_get_ex_data(
  18795. wolfSSL_get_SSL_CTX(ssl), context_ex_data_index()));
  18796. if (!wctx || !wctx->verify_callback) { return preverify_ok; }
  18797. WOLFSSL_X509 *cert = wolfSSL_X509_STORE_CTX_get_current_cert(x509_ctx);
  18798. int depth = wolfSSL_X509_STORE_CTX_get_error_depth(x509_ctx);
  18799. int err = wolfSSL_X509_STORE_CTX_get_error(x509_ctx);
  18800. VerifyContext verify_ctx;
  18801. verify_ctx.session = wolfSSL_get_ex_data(ssl, session_ex_data_index());
  18802. verify_ctx.cert = static_cast<cert_t>(cert);
  18803. verify_ctx.depth = depth;
  18804. verify_ctx.preverify_ok = (preverify_ok != 0);
  18805. verify_ctx.error_code = static_cast<long>(err);
  18806. if (err != 0) {
  18807. verify_ctx.error_string = wolfSSL_X509_verify_cert_error_string(err);
  18808. } else {
  18809. verify_ctx.error_string = nullptr;
  18810. }
  18811. bool accepted = wctx->verify_callback(verify_ctx);
  18812. return accepted ? 1 : 0;
  18813. }
  18814. inline void set_wolfssl_password_cb(WOLFSSL_CTX *ctx, const char *password) {
  18815. wolfSSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char *>(password));
  18816. wolfSSL_CTX_set_default_passwd_cb(
  18817. ctx, [](char *buf, int size, int /*rwflag*/, void *userdata) -> int {
  18818. auto *pwd = static_cast<const char *>(userdata);
  18819. if (!pwd) return 0;
  18820. auto len = static_cast<int>(strlen(pwd));
  18821. if (len > size) len = size;
  18822. memcpy(buf, pwd, static_cast<size_t>(len));
  18823. return len;
  18824. });
  18825. }
  18826. } // namespace impl
  18827. inline ctx_t create_client_context() {
  18828. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  18829. if (!ctx) { return nullptr; }
  18830. ctx->is_server = false;
  18831. WOLFSSL_METHOD *method = wolfTLSv1_2_client_method();
  18832. if (!method) {
  18833. delete ctx;
  18834. return nullptr;
  18835. }
  18836. ctx->ctx = wolfSSL_CTX_new(method);
  18837. if (!ctx->ctx ||
  18838. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  18839. WOLFSSL_SUCCESS) {
  18840. delete ctx;
  18841. return nullptr;
  18842. }
  18843. // Default: verify peer certificate
  18844. wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_PEER, nullptr);
  18845. return static_cast<ctx_t>(ctx);
  18846. }
  18847. inline ctx_t create_server_context() {
  18848. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  18849. if (!ctx) { return nullptr; }
  18850. ctx->is_server = true;
  18851. WOLFSSL_METHOD *method = wolfTLSv1_2_server_method();
  18852. if (!method) {
  18853. delete ctx;
  18854. return nullptr;
  18855. }
  18856. ctx->ctx = wolfSSL_CTX_new(method);
  18857. if (!ctx->ctx ||
  18858. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  18859. WOLFSSL_SUCCESS) {
  18860. delete ctx;
  18861. return nullptr;
  18862. }
  18863. // Default: don't verify client
  18864. wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_NONE, nullptr);
  18865. // Enable SNI on server
  18866. wolfSSL_CTX_SNI_SetOptions(ctx->ctx, WOLFSSL_SNI_HOST_NAME,
  18867. WOLFSSL_SNI_CONTINUE_ON_MISMATCH);
  18868. wolfSSL_CTX_set_servername_callback(ctx->ctx, impl::wolfssl_sni_callback);
  18869. return static_cast<ctx_t>(ctx);
  18870. }
  18871. inline void free_context(ctx_t ctx) {
  18872. if (ctx) { delete static_cast<impl::WolfSSLContext *>(ctx); }
  18873. }
  18874. inline bool set_min_version(ctx_t ctx, Version version) {
  18875. if (!ctx) { return false; }
  18876. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18877. int min_ver = WOLFSSL_TLSV1_2;
  18878. if (version >= Version::TLS1_3) { min_ver = WOLFSSL_TLSV1_3; }
  18879. return wolfSSL_CTX_SetMinVersion(wctx->ctx, min_ver) == WOLFSSL_SUCCESS;
  18880. }
  18881. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  18882. if (!ctx || !pem) { return false; }
  18883. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18884. int ret = wolfSSL_CTX_load_verify_buffer(
  18885. wctx->ctx, reinterpret_cast<const unsigned char *>(pem),
  18886. static_cast<long>(len), SSL_FILETYPE_PEM);
  18887. if (ret != SSL_SUCCESS) {
  18888. impl::wolfssl_last_error() =
  18889. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18890. return false;
  18891. }
  18892. wctx->ca_pem_data_.append(pem, len);
  18893. return true;
  18894. }
  18895. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  18896. if (!ctx || !file_path) { return false; }
  18897. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18898. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, file_path, nullptr);
  18899. if (ret != SSL_SUCCESS) {
  18900. impl::wolfssl_last_error() =
  18901. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18902. return false;
  18903. }
  18904. return true;
  18905. }
  18906. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  18907. if (!ctx || !dir_path) { return false; }
  18908. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18909. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, dir_path);
  18910. // wolfSSL may fail if the directory doesn't contain properly hashed certs.
  18911. // Unlike OpenSSL which lazily loads certs from directories, wolfSSL scans
  18912. // immediately. Return true even on failure since the CA file may have
  18913. // already been loaded, matching OpenSSL's lenient behavior.
  18914. (void)ret;
  18915. return true;
  18916. }
  18917. inline bool load_system_certs(ctx_t ctx) {
  18918. if (!ctx) { return false; }
  18919. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18920. bool loaded = false;
  18921. #ifdef _WIN32
  18922. loaded = impl::enumerate_windows_system_certs(
  18923. [&](const unsigned char *data, size_t len) {
  18924. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  18925. static_cast<long>(len),
  18926. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  18927. });
  18928. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  18929. loaded = impl::enumerate_macos_keychain_certs(
  18930. [&](const unsigned char *data, size_t len) {
  18931. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  18932. static_cast<long>(len),
  18933. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  18934. });
  18935. #else
  18936. for (auto path = impl::system_ca_paths(); *path; ++path) {
  18937. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, *path, nullptr) ==
  18938. SSL_SUCCESS) {
  18939. loaded = true;
  18940. break;
  18941. }
  18942. }
  18943. if (!loaded) {
  18944. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  18945. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, *dir) ==
  18946. SSL_SUCCESS) {
  18947. loaded = true;
  18948. break;
  18949. }
  18950. }
  18951. }
  18952. #endif
  18953. return loaded;
  18954. }
  18955. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  18956. const char *password) {
  18957. if (!ctx || !cert || !key) { return false; }
  18958. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18959. // Load certificate
  18960. int ret = wolfSSL_CTX_use_certificate_buffer(
  18961. wctx->ctx, reinterpret_cast<const unsigned char *>(cert),
  18962. static_cast<long>(strlen(cert)), SSL_FILETYPE_PEM);
  18963. if (ret != SSL_SUCCESS) {
  18964. impl::wolfssl_last_error() =
  18965. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18966. return false;
  18967. }
  18968. // Set password callback if password is provided
  18969. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18970. // Load private key
  18971. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  18972. wctx->ctx, reinterpret_cast<const unsigned char *>(key),
  18973. static_cast<long>(strlen(key)), SSL_FILETYPE_PEM);
  18974. if (ret != SSL_SUCCESS) {
  18975. impl::wolfssl_last_error() =
  18976. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18977. return false;
  18978. }
  18979. // Verify that the certificate and private key match
  18980. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  18981. }
  18982. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  18983. const char *key_path, const char *password) {
  18984. if (!ctx || !cert_path || !key_path) { return false; }
  18985. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18986. // Load certificate file
  18987. int ret =
  18988. wolfSSL_CTX_use_certificate_file(wctx->ctx, cert_path, SSL_FILETYPE_PEM);
  18989. if (ret != SSL_SUCCESS) {
  18990. impl::wolfssl_last_error() =
  18991. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18992. return false;
  18993. }
  18994. // Set password callback if password is provided
  18995. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18996. // Load private key file
  18997. ret = wolfSSL_CTX_use_PrivateKey_file(wctx->ctx, key_path, SSL_FILETYPE_PEM);
  18998. if (ret != SSL_SUCCESS) {
  18999. impl::wolfssl_last_error() =
  19000. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19001. return false;
  19002. }
  19003. // Verify that the certificate and private key match
  19004. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  19005. }
  19006. inline void set_verify_client(ctx_t ctx, bool require) {
  19007. if (!ctx) { return; }
  19008. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19009. wctx->verify_client = require;
  19010. if (require) {
  19011. wolfSSL_CTX_set_verify(
  19012. wctx->ctx, SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
  19013. wctx->verify_callback ? impl::wolfssl_verify_callback : nullptr);
  19014. } else {
  19015. if (wctx->verify_callback) {
  19016. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
  19017. impl::wolfssl_verify_callback);
  19018. } else {
  19019. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_NONE, nullptr);
  19020. }
  19021. }
  19022. }
  19023. inline session_t create_session(ctx_t ctx, socket_t sock) {
  19024. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  19025. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19026. auto session = new (std::nothrow) impl::WolfSSLSession();
  19027. if (!session) { return nullptr; }
  19028. session->sock = sock;
  19029. session->ssl = wolfSSL_new(wctx->ctx);
  19030. if (!session->ssl) {
  19031. impl::wolfssl_last_error() =
  19032. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19033. delete session;
  19034. return nullptr;
  19035. }
  19036. if (wolfSSL_set_ex_data(session->ssl, impl::session_ex_data_index(),
  19037. session) != WOLFSSL_SUCCESS) {
  19038. delete session;
  19039. return nullptr;
  19040. }
  19041. wolfSSL_set_fd(session->ssl, static_cast<int>(sock));
  19042. return static_cast<session_t>(session);
  19043. }
  19044. inline void free_session(session_t session) {
  19045. if (session) { delete static_cast<impl::WolfSSLSession *>(session); }
  19046. }
  19047. inline bool set_sni(session_t session, const char *hostname,
  19048. bool verify_hostname) {
  19049. if (!session || !hostname) { return false; }
  19050. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19051. int ret = wolfSSL_UseSNI(wsession->ssl, WOLFSSL_SNI_HOST_NAME, hostname,
  19052. static_cast<word16>(strlen(hostname)));
  19053. if (ret != WOLFSSL_SUCCESS) {
  19054. impl::wolfssl_last_error() =
  19055. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19056. return false;
  19057. }
  19058. // wolfSSL_check_domain_name binds identity checking to the handshake,
  19059. // separately from the SNI extension sent above; skip it when hostname
  19060. // verification is disabled so only the chain is checked, matching OpenSSL.
  19061. if (verify_hostname) { wolfSSL_check_domain_name(wsession->ssl, hostname); }
  19062. wsession->hostname = hostname;
  19063. return true;
  19064. }
  19065. inline TlsError connect(session_t session) {
  19066. TlsError err;
  19067. if (!session) {
  19068. err.code = ErrorCode::Fatal;
  19069. return err;
  19070. }
  19071. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19072. int ret = wolfSSL_connect(wsession->ssl);
  19073. if (ret == SSL_SUCCESS) {
  19074. err.code = ErrorCode::Success;
  19075. } else {
  19076. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19077. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19078. err.backend_code = static_cast<uint64_t>(ssl_error);
  19079. impl::wolfssl_last_error() = err.backend_code;
  19080. }
  19081. return err;
  19082. }
  19083. inline TlsError accept(session_t session) {
  19084. TlsError err;
  19085. if (!session) {
  19086. err.code = ErrorCode::Fatal;
  19087. return err;
  19088. }
  19089. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19090. int ret = wolfSSL_accept(wsession->ssl);
  19091. if (ret == SSL_SUCCESS) {
  19092. err.code = ErrorCode::Success;
  19093. // Capture SNI from thread-local storage after successful handshake
  19094. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  19095. impl::wolfssl_pending_sni().clear();
  19096. } else {
  19097. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19098. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19099. err.backend_code = static_cast<uint64_t>(ssl_error);
  19100. impl::wolfssl_last_error() = err.backend_code;
  19101. }
  19102. return err;
  19103. }
  19104. inline bool connect_nonblocking(session_t session, socket_t sock,
  19105. time_t timeout_sec, time_t timeout_usec,
  19106. TlsError *err) {
  19107. if (!session) {
  19108. if (err) { err->code = ErrorCode::Fatal; }
  19109. return false;
  19110. }
  19111. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19112. // Set socket to non-blocking mode
  19113. detail::set_nonblocking(sock, true);
  19114. auto cleanup =
  19115. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19116. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  19117. int ret;
  19118. while ((ret = wolfSSL_connect(wsession->ssl)) != SSL_SUCCESS) {
  19119. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19120. if (ssl_error == SSL_ERROR_WANT_READ) {
  19121. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  19122. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  19123. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  19124. }
  19125. // Error or timeout
  19126. if (err) {
  19127. err->code =
  19128. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  19129. err->backend_code = static_cast<uint64_t>(ssl_error);
  19130. }
  19131. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  19132. return false;
  19133. }
  19134. if (err) { err->code = ErrorCode::Success; }
  19135. return true;
  19136. }
  19137. inline bool accept_nonblocking(session_t session, socket_t sock,
  19138. time_t timeout_sec, time_t timeout_usec,
  19139. TlsError *err) {
  19140. if (!session) {
  19141. if (err) { err->code = ErrorCode::Fatal; }
  19142. return false;
  19143. }
  19144. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19145. // Set socket to non-blocking mode
  19146. detail::set_nonblocking(sock, true);
  19147. auto cleanup =
  19148. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19149. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  19150. int ret;
  19151. while ((ret = wolfSSL_accept(wsession->ssl)) != SSL_SUCCESS) {
  19152. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19153. if (ssl_error == SSL_ERROR_WANT_READ) {
  19154. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  19155. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  19156. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  19157. }
  19158. // Error or timeout
  19159. if (err) {
  19160. err->code =
  19161. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  19162. err->backend_code = static_cast<uint64_t>(ssl_error);
  19163. }
  19164. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  19165. return false;
  19166. }
  19167. if (err) { err->code = ErrorCode::Success; }
  19168. // Capture SNI from thread-local storage after successful handshake
  19169. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  19170. impl::wolfssl_pending_sni().clear();
  19171. return true;
  19172. }
  19173. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  19174. if (!session || !buf) {
  19175. err.code = ErrorCode::Fatal;
  19176. return -1;
  19177. }
  19178. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19179. int ret = wolfSSL_read(wsession->ssl, buf, static_cast<int>(len));
  19180. if (ret > 0) {
  19181. err.code = ErrorCode::Success;
  19182. return static_cast<ssize_t>(ret);
  19183. }
  19184. if (ret == 0) {
  19185. err.code = ErrorCode::PeerClosed;
  19186. return 0;
  19187. }
  19188. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19189. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19190. err.backend_code = static_cast<uint64_t>(ssl_error);
  19191. impl::wolfssl_last_error() = err.backend_code;
  19192. return -1;
  19193. }
  19194. inline ssize_t write(session_t session, const void *buf, size_t len,
  19195. TlsError &err) {
  19196. if (!session || !buf) {
  19197. err.code = ErrorCode::Fatal;
  19198. return -1;
  19199. }
  19200. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19201. int ret = wolfSSL_write(wsession->ssl, buf, static_cast<int>(len));
  19202. if (ret > 0) {
  19203. err.code = ErrorCode::Success;
  19204. return static_cast<ssize_t>(ret);
  19205. }
  19206. // wolfSSL_write returns 0 when the peer has sent a close_notify.
  19207. // Treat this as an error (return -1) so callers don't spin in a
  19208. // write loop adding zero to the offset.
  19209. if (ret == 0) {
  19210. err.code = ErrorCode::PeerClosed;
  19211. return -1;
  19212. }
  19213. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19214. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19215. err.backend_code = static_cast<uint64_t>(ssl_error);
  19216. impl::wolfssl_last_error() = err.backend_code;
  19217. return -1;
  19218. }
  19219. inline int pending(const_session_t session) {
  19220. if (!session) { return 0; }
  19221. auto wsession =
  19222. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19223. return wolfSSL_pending(wsession->ssl);
  19224. }
  19225. inline void shutdown(session_t session, bool graceful) {
  19226. if (!session) { return; }
  19227. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19228. if (graceful) {
  19229. int ret;
  19230. int attempts = 0;
  19231. while ((ret = wolfSSL_shutdown(wsession->ssl)) != SSL_SUCCESS &&
  19232. attempts < 3) {
  19233. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19234. if (ssl_error != SSL_ERROR_WANT_READ &&
  19235. ssl_error != SSL_ERROR_WANT_WRITE) {
  19236. break;
  19237. }
  19238. attempts++;
  19239. }
  19240. } else {
  19241. wolfSSL_shutdown(wsession->ssl);
  19242. }
  19243. }
  19244. inline bool is_peer_closed(session_t session, socket_t sock) {
  19245. if (!session || sock == INVALID_SOCKET) { return true; }
  19246. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19247. // Check if there's already decrypted data available
  19248. if (wolfSSL_pending(wsession->ssl) > 0) { return false; }
  19249. // Set socket to non-blocking to avoid blocking on read
  19250. detail::set_nonblocking(sock, true);
  19251. auto cleanup =
  19252. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19253. // Peek 1 byte to check connection status without consuming data
  19254. unsigned char buf;
  19255. int ret = wolfSSL_peek(wsession->ssl, &buf, 1);
  19256. // If we got data or WANT_READ (would block), connection is alive
  19257. if (ret > 0) { return false; }
  19258. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19259. if (ssl_error == SSL_ERROR_WANT_READ) { return false; }
  19260. return ssl_error == SSL_ERROR_ZERO_RETURN || ssl_error == SSL_ERROR_SYSCALL ||
  19261. ret == 0;
  19262. }
  19263. inline cert_t get_peer_cert(const_session_t session) {
  19264. if (!session) { return nullptr; }
  19265. auto wsession =
  19266. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19267. WOLFSSL_X509 *cert = wolfSSL_get_peer_certificate(wsession->ssl);
  19268. return static_cast<cert_t>(cert);
  19269. }
  19270. inline size_t get_peer_certs(const_session_t session,
  19271. std::vector<cert_t> &certs) {
  19272. certs.clear();
  19273. if (!session) { return 0; }
  19274. // wolfSSL keeps the received chain only when built with SESSION_CERTS
  19275. #ifdef SESSION_CERTS
  19276. auto wsession =
  19277. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19278. auto chain = wolfSSL_get_peer_chain(wsession->ssl);
  19279. auto count = chain ? wolfSSL_get_chain_count(chain) : 0;
  19280. for (int i = 0; i < count; i++) {
  19281. auto x509 = wolfSSL_get_chain_X509(chain, i);
  19282. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19283. }
  19284. #endif
  19285. return certs.size();
  19286. }
  19287. inline void free_cert(cert_t cert) {
  19288. if (cert) { wolfSSL_X509_free(static_cast<WOLFSSL_X509 *>(cert)); }
  19289. }
  19290. inline bool verify_hostname(cert_t cert, const char *hostname) {
  19291. if (!cert || !hostname) { return false; }
  19292. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19293. std::string host_str(hostname);
  19294. // Check if hostname is an IP address (IPv4 or IPv6)
  19295. unsigned char ip_bytes[16];
  19296. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  19297. auto is_ip = ip_len > 0;
  19298. // Check Subject Alternative Names
  19299. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  19300. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  19301. if (san_names) {
  19302. int san_count = wolfSSL_sk_num(san_names);
  19303. for (int i = 0; i < san_count; i++) {
  19304. auto *names =
  19305. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  19306. if (!names) continue;
  19307. if (!is_ip && names->type == WOLFSSL_GEN_DNS) {
  19308. // DNS name
  19309. unsigned char *dns_name = nullptr;
  19310. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, names->d.dNSName);
  19311. if (dns_name && dns_len > 0) {
  19312. std::string san_name(reinterpret_cast<char *>(dns_name),
  19313. static_cast<size_t>(dns_len));
  19314. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  19315. if (detail::match_hostname(san_name, host_str)) {
  19316. wolfSSL_sk_free(san_names);
  19317. return true;
  19318. }
  19319. }
  19320. } else if (is_ip && names->type == WOLFSSL_GEN_IPADD) {
  19321. // IP address: only an iPAddress SAN of the same family (4 bytes for
  19322. // IPv4, 16 bytes for IPv6) may authenticate the host.
  19323. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(names->d.iPAddress);
  19324. auto san_ip_len = wolfSSL_ASN1_STRING_length(names->d.iPAddress);
  19325. if (ip_data && san_ip_len == static_cast<int>(ip_len) &&
  19326. memcmp(ip_data, ip_bytes, ip_len) == 0) {
  19327. wolfSSL_sk_free(san_names);
  19328. return true;
  19329. }
  19330. }
  19331. }
  19332. wolfSSL_sk_free(san_names);
  19333. }
  19334. // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
  19335. // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
  19336. // the OpenSSL backend's X509_check_ip behaves the same way).
  19337. auto subject = is_ip ? nullptr : wolfSSL_X509_get_subject_name(x509);
  19338. if (subject) {
  19339. char cn[256] = {};
  19340. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  19341. sizeof(cn));
  19342. if (cn_len > 0) {
  19343. std::string cn_str(cn, static_cast<size_t>(cn_len));
  19344. if (detail::match_hostname(cn_str, host_str)) { return true; }
  19345. }
  19346. }
  19347. return false;
  19348. }
  19349. inline uint64_t hostname_mismatch_code() {
  19350. return static_cast<uint64_t>(DOMAIN_NAME_MISMATCH);
  19351. }
  19352. inline long get_verify_result(const_session_t session) {
  19353. if (!session) { return -1; }
  19354. auto wsession =
  19355. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19356. long result = wolfSSL_get_verify_result(wsession->ssl);
  19357. return result;
  19358. }
  19359. inline std::string get_cert_subject_cn(cert_t cert) {
  19360. if (!cert) return "";
  19361. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19362. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19363. if (!subject) return "";
  19364. char cn[256] = {};
  19365. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  19366. sizeof(cn));
  19367. if (cn_len <= 0) return "";
  19368. return std::string(cn, static_cast<size_t>(cn_len));
  19369. }
  19370. inline std::string get_cert_issuer_name(cert_t cert) {
  19371. if (!cert) return "";
  19372. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19373. WOLFSSL_X509_NAME *issuer = wolfSSL_X509_get_issuer_name(x509);
  19374. if (!issuer) return "";
  19375. char *name_str = wolfSSL_X509_NAME_oneline(issuer, nullptr, 0);
  19376. if (!name_str) return "";
  19377. std::string result(name_str);
  19378. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19379. return result;
  19380. }
  19381. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  19382. sans.clear();
  19383. if (!cert) return false;
  19384. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19385. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  19386. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  19387. if (!san_names) return true; // No SANs is not an error
  19388. int count = wolfSSL_sk_num(san_names);
  19389. for (int i = 0; i < count; i++) {
  19390. auto *name =
  19391. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  19392. if (!name) continue;
  19393. SanEntry entry;
  19394. switch (name->type) {
  19395. case WOLFSSL_GEN_DNS: {
  19396. entry.type = SanType::DNS;
  19397. unsigned char *dns_name = nullptr;
  19398. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, name->d.dNSName);
  19399. if (dns_name && dns_len > 0) {
  19400. entry.value = std::string(reinterpret_cast<char *>(dns_name),
  19401. static_cast<size_t>(dns_len));
  19402. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  19403. }
  19404. break;
  19405. }
  19406. case WOLFSSL_GEN_IPADD: {
  19407. entry.type = SanType::IP;
  19408. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(name->d.iPAddress);
  19409. int ip_len = wolfSSL_ASN1_STRING_length(name->d.iPAddress);
  19410. if (ip_data && ip_len == 4) {
  19411. char buf[16];
  19412. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", ip_data[0], ip_data[1],
  19413. ip_data[2], ip_data[3]);
  19414. entry.value = buf;
  19415. } else if (ip_data && ip_len == 16) {
  19416. char buf[64];
  19417. snprintf(buf, sizeof(buf),
  19418. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  19419. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  19420. ip_data[0], ip_data[1], ip_data[2], ip_data[3], ip_data[4],
  19421. ip_data[5], ip_data[6], ip_data[7], ip_data[8], ip_data[9],
  19422. ip_data[10], ip_data[11], ip_data[12], ip_data[13],
  19423. ip_data[14], ip_data[15]);
  19424. entry.value = buf;
  19425. }
  19426. break;
  19427. }
  19428. case WOLFSSL_GEN_EMAIL:
  19429. entry.type = SanType::EMAIL;
  19430. {
  19431. unsigned char *email = nullptr;
  19432. int email_len = wolfSSL_ASN1_STRING_to_UTF8(&email, name->d.rfc822Name);
  19433. if (email && email_len > 0) {
  19434. entry.value = std::string(reinterpret_cast<char *>(email),
  19435. static_cast<size_t>(email_len));
  19436. XFREE(email, nullptr, DYNAMIC_TYPE_OPENSSL);
  19437. }
  19438. }
  19439. break;
  19440. case WOLFSSL_GEN_URI:
  19441. entry.type = SanType::URI;
  19442. {
  19443. unsigned char *uri = nullptr;
  19444. int uri_len = wolfSSL_ASN1_STRING_to_UTF8(
  19445. &uri, name->d.uniformResourceIdentifier);
  19446. if (uri && uri_len > 0) {
  19447. entry.value = std::string(reinterpret_cast<char *>(uri),
  19448. static_cast<size_t>(uri_len));
  19449. XFREE(uri, nullptr, DYNAMIC_TYPE_OPENSSL);
  19450. }
  19451. }
  19452. break;
  19453. default: entry.type = SanType::OTHER; break;
  19454. }
  19455. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  19456. }
  19457. wolfSSL_sk_free(san_names);
  19458. return true;
  19459. }
  19460. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  19461. time_t &not_after) {
  19462. if (!cert) return false;
  19463. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19464. const WOLFSSL_ASN1_TIME *nb = wolfSSL_X509_get_notBefore(x509);
  19465. const WOLFSSL_ASN1_TIME *na = wolfSSL_X509_get_notAfter(x509);
  19466. if (!nb || !na) return false;
  19467. // wolfSSL_ASN1_TIME_to_tm is available
  19468. struct tm tm_nb = {}, tm_na = {};
  19469. if (wolfSSL_ASN1_TIME_to_tm(nb, &tm_nb) != WOLFSSL_SUCCESS) return false;
  19470. if (wolfSSL_ASN1_TIME_to_tm(na, &tm_na) != WOLFSSL_SUCCESS) return false;
  19471. #ifdef _WIN32
  19472. not_before = _mkgmtime(&tm_nb);
  19473. not_after = _mkgmtime(&tm_na);
  19474. #else
  19475. not_before = timegm(&tm_nb);
  19476. not_after = timegm(&tm_na);
  19477. #endif
  19478. return true;
  19479. }
  19480. inline std::string get_cert_serial(cert_t cert) {
  19481. if (!cert) return "";
  19482. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19483. WOLFSSL_ASN1_INTEGER *serial_asn1 = wolfSSL_X509_get_serialNumber(x509);
  19484. if (!serial_asn1) return "";
  19485. // Get the serial number data
  19486. int len = serial_asn1->length;
  19487. unsigned char *data = serial_asn1->data;
  19488. if (!data || len <= 0) return "";
  19489. std::string result;
  19490. result.reserve(static_cast<size_t>(len) * 2);
  19491. for (int i = 0; i < len; i++) {
  19492. char hex[3];
  19493. snprintf(hex, sizeof(hex), "%02X", data[i]);
  19494. result += hex;
  19495. }
  19496. return result;
  19497. }
  19498. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  19499. if (!cert) return false;
  19500. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19501. int der_len = 0;
  19502. const unsigned char *der_data = wolfSSL_X509_get_der(x509, &der_len);
  19503. if (!der_data || der_len <= 0) return false;
  19504. der.assign(der_data, der_data + der_len);
  19505. return true;
  19506. }
  19507. inline const char *get_sni(const_session_t session) {
  19508. if (!session) return nullptr;
  19509. auto wsession = static_cast<const impl::WolfSSLSession *>(session);
  19510. // For server: return SNI received from client during handshake
  19511. if (!wsession->sni_hostname.empty()) {
  19512. return wsession->sni_hostname.c_str();
  19513. }
  19514. // For client: return the hostname set via set_sni
  19515. if (!wsession->hostname.empty()) { return wsession->hostname.c_str(); }
  19516. return nullptr;
  19517. }
  19518. inline uint64_t peek_error() {
  19519. return static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19520. }
  19521. inline uint64_t get_error() {
  19522. uint64_t err = impl::wolfssl_last_error();
  19523. impl::wolfssl_last_error() = 0;
  19524. return err;
  19525. }
  19526. inline std::string error_string(uint64_t code) {
  19527. char buf[256];
  19528. wolfSSL_ERR_error_string(static_cast<unsigned long>(code), buf);
  19529. return std::string(buf);
  19530. }
  19531. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  19532. if (!pem || len == 0) { return nullptr; }
  19533. // Validate by attempting to load into a temporary ctx
  19534. WOLFSSL_CTX *tmp_ctx = wolfSSL_CTX_new(wolfTLSv1_2_client_method());
  19535. if (!tmp_ctx) { return nullptr; }
  19536. int ret = wolfSSL_CTX_load_verify_buffer(
  19537. tmp_ctx, reinterpret_cast<const unsigned char *>(pem),
  19538. static_cast<long>(len), SSL_FILETYPE_PEM);
  19539. wolfSSL_CTX_free(tmp_ctx);
  19540. if (ret != SSL_SUCCESS) { return nullptr; }
  19541. return static_cast<ca_store_t>(
  19542. new impl::WolfSSLCAStore{std::string(pem, len)});
  19543. }
  19544. inline void free_ca_store(ca_store_t store) {
  19545. delete static_cast<impl::WolfSSLCAStore *>(store);
  19546. }
  19547. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  19548. if (!ctx || !store) { return false; }
  19549. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19550. auto *ca = static_cast<impl::WolfSSLCAStore *>(store);
  19551. int ret = wolfSSL_CTX_load_verify_buffer(
  19552. wctx->ctx, reinterpret_cast<const unsigned char *>(ca->pem_data.data()),
  19553. static_cast<long>(ca->pem_data.size()), SSL_FILETYPE_PEM);
  19554. if (ret == SSL_SUCCESS) { wctx->ca_pem_data_ += ca->pem_data; }
  19555. // This function takes ownership of the store; the PEM data was copied into
  19556. // the context, so release the source
  19557. free_ca_store(store);
  19558. return ret == SSL_SUCCESS;
  19559. }
  19560. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  19561. certs.clear();
  19562. if (!ctx) { return 0; }
  19563. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19564. if (wctx->ca_pem_data_.empty()) { return 0; }
  19565. const std::string &pem = wctx->ca_pem_data_;
  19566. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19567. const std::string end_marker = "-----END CERTIFICATE-----";
  19568. size_t pos = 0;
  19569. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19570. size_t end_pos = pem.find(end_marker, pos);
  19571. if (end_pos == std::string::npos) { break; }
  19572. end_pos += end_marker.size();
  19573. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19574. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19575. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19576. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19577. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19578. pos = end_pos;
  19579. }
  19580. return certs.size();
  19581. }
  19582. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  19583. std::vector<std::string> names;
  19584. if (!ctx) { return names; }
  19585. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19586. if (wctx->ca_pem_data_.empty()) { return names; }
  19587. const std::string &pem = wctx->ca_pem_data_;
  19588. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19589. const std::string end_marker = "-----END CERTIFICATE-----";
  19590. size_t pos = 0;
  19591. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19592. size_t end_pos = pem.find(end_marker, pos);
  19593. if (end_pos == std::string::npos) { break; }
  19594. end_pos += end_marker.size();
  19595. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19596. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19597. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19598. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19599. if (x509) {
  19600. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19601. if (subject) {
  19602. char *name_str = wolfSSL_X509_NAME_oneline(subject, nullptr, 0);
  19603. if (name_str) {
  19604. names.push_back(name_str);
  19605. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19606. }
  19607. }
  19608. wolfSSL_X509_free(x509);
  19609. }
  19610. pos = end_pos;
  19611. }
  19612. return names;
  19613. }
  19614. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  19615. const char *key_pem, const char *password) {
  19616. if (!ctx || !cert_pem || !key_pem) { return false; }
  19617. // Try the pair on a scratch context first, so that a bad one leaves the
  19618. // server's certificate and key as they were
  19619. auto tmp = create_server_context();
  19620. if (!tmp) { return false; }
  19621. auto se = detail::scope_exit([&] { free_context(tmp); });
  19622. if (!set_client_cert_pem(tmp, cert_pem, key_pem, password)) { return false; }
  19623. return set_client_cert_pem(ctx, cert_pem, key_pem, password);
  19624. }
  19625. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  19626. if (!ctx || !ca_pem) { return false; }
  19627. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19628. // Replace the CAs rather than add to them, as the other backends do, once
  19629. // the new ones are known to load
  19630. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  19631. if (!store) { return false; }
  19632. free_ca_store(store);
  19633. wolfSSL_CTX_UnloadCAs(wctx->ctx);
  19634. wctx->ca_pem_data_.clear();
  19635. return load_ca_pem(ctx, ca_pem, strlen(ca_pem));
  19636. }
  19637. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  19638. if (!ctx) { return false; }
  19639. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19640. wctx->verify_callback = std::move(callback);
  19641. if (wctx->verify_callback) {
  19642. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
  19643. impl::wolfssl_verify_callback);
  19644. } else {
  19645. wolfSSL_CTX_set_verify(
  19646. wctx->ctx,
  19647. wctx->verify_client
  19648. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  19649. : SSL_VERIFY_NONE,
  19650. nullptr);
  19651. }
  19652. return true;
  19653. }
  19654. inline long get_verify_error(const_session_t session) {
  19655. if (!session) { return -1; }
  19656. auto *wsession =
  19657. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19658. return wolfSSL_get_verify_result(wsession->ssl);
  19659. }
  19660. inline std::string verify_error_string(long error_code) {
  19661. if (error_code == 0) { return ""; }
  19662. const char *str =
  19663. wolfSSL_X509_verify_cert_error_string(static_cast<int>(error_code));
  19664. return str ? std::string(str) : std::string();
  19665. }
  19666. } // namespace tls
  19667. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  19668. // WebSocket implementation
  19669. namespace ws {
  19670. inline bool WebSocket::send_frame(Opcode op, const char *data, size_t len,
  19671. bool fin) {
  19672. std::lock_guard<std::mutex> lock(write_mutex_);
  19673. if (closed_) { return false; }
  19674. return detail::write_websocket_frame(strm_, op, data, len, fin, !is_server_);
  19675. }
  19676. inline ReadResult WebSocket::read(std::string &msg) {
  19677. // RFC 6455 §5.5.1: a Close is echoed back, unless its payload is malformed,
  19678. // which is answered with a protocol error instead.
  19679. auto answer_close = [&](const std::string &payload) {
  19680. if (closed_.exchange(true)) { return; }
  19681. auto reply = payload;
  19682. if (!impl::is_valid_close_payload(payload)) {
  19683. auto code = static_cast<uint16_t>(CloseStatus::ProtocolError);
  19684. reply = {static_cast<char>(code >> 8), static_cast<char>(code & 0xff)};
  19685. }
  19686. std::lock_guard<std::mutex> lock(write_mutex_);
  19687. detail::write_websocket_frame(strm_, Opcode::Close, reply.data(),
  19688. reply.size(), true, !is_server_);
  19689. };
  19690. std::unique_lock<std::mutex> read_lock(read_mutex_);
  19691. while (!closed_) {
  19692. Opcode opcode;
  19693. std::string payload;
  19694. bool fin;
  19695. impl::FrameRead r =
  19696. impl::read_websocket_frame(strm_, opcode, payload, fin, is_server_,
  19697. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH);
  19698. // A timeout landed on a frame boundary: the connection is untouched and
  19699. // still usable, so hand control back without closing it. That is only
  19700. // useful to a caller who asked for the timeout; the compile-time default
  19701. // is a backstop against a peer gone quiet, and elapsing it closes the
  19702. // connection so a plain `while (ws.read(msg))` loop ends.
  19703. if (r == impl::FrameRead::Timeout && read_timeout_set_) { return Timeout; }
  19704. if (r != impl::FrameRead::Ok) {
  19705. closed_ = true;
  19706. return Fail;
  19707. }
  19708. switch (opcode) {
  19709. case Opcode::Ping: {
  19710. std::lock_guard<std::mutex> lock(write_mutex_);
  19711. detail::write_websocket_frame(strm_, Opcode::Pong, payload.data(),
  19712. payload.size(), true, !is_server_);
  19713. continue;
  19714. }
  19715. case Opcode::Pong: {
  19716. std::lock_guard<std::mutex> lock(ping_mutex_);
  19717. unacked_pings_ = 0;
  19718. continue;
  19719. }
  19720. case Opcode::Close: {
  19721. answer_close(payload);
  19722. return Fail;
  19723. }
  19724. case Opcode::Text:
  19725. case Opcode::Binary: {
  19726. auto result = opcode == Opcode::Text ? Text : Binary;
  19727. msg = std::move(payload);
  19728. // Handle fragmentation
  19729. if (!fin) {
  19730. while (true) {
  19731. Opcode cont_opcode;
  19732. std::string cont_payload;
  19733. bool cont_fin;
  19734. // Only what is left of the limit, but room for a control frame,
  19735. // which may come between the fragments.
  19736. auto max_len =
  19737. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH == 0
  19738. ? size_t(0)
  19739. : (std::max)(size_t(125),
  19740. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH -
  19741. msg.size());
  19742. // A timeout is not reportable here: half of a fragmented message is
  19743. // already in `msg` and read() has no way to resume it, so it is a
  19744. // failure like any other. Timeouts are only ever seen on a message
  19745. // boundary.
  19746. if (impl::read_websocket_frame(strm_, cont_opcode, cont_payload,
  19747. cont_fin, is_server_,
  19748. max_len) != impl::FrameRead::Ok) {
  19749. closed_ = true;
  19750. return Fail;
  19751. }
  19752. if (cont_opcode == Opcode::Ping) {
  19753. std::lock_guard<std::mutex> lock(write_mutex_);
  19754. detail::write_websocket_frame(
  19755. strm_, Opcode::Pong, cont_payload.data(), cont_payload.size(),
  19756. true, !is_server_);
  19757. continue;
  19758. }
  19759. if (cont_opcode == Opcode::Pong) {
  19760. std::lock_guard<std::mutex> lock(ping_mutex_);
  19761. unacked_pings_ = 0;
  19762. continue;
  19763. }
  19764. if (cont_opcode == Opcode::Close) {
  19765. answer_close(cont_payload);
  19766. return Fail;
  19767. }
  19768. // RFC 6455: continuation frames must use opcode 0x0
  19769. if (cont_opcode != Opcode::Continuation) {
  19770. closed_ = true;
  19771. return Fail;
  19772. }
  19773. msg += cont_payload;
  19774. if (CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH > 0 &&
  19775. msg.size() > CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) {
  19776. closed_ = true;
  19777. return Fail;
  19778. }
  19779. if (cont_fin) { break; }
  19780. }
  19781. }
  19782. // RFC 6455 Section 5.6: text frames must contain valid UTF-8
  19783. if (result == Text && !impl::is_valid_utf8(msg)) {
  19784. // close() takes the read lock to wait for the peer's Close reply, so
  19785. // it must not run while this thread still holds it.
  19786. read_lock.unlock();
  19787. close(CloseStatus::InvalidPayload, "invalid UTF-8");
  19788. return Fail;
  19789. }
  19790. return result;
  19791. }
  19792. default: closed_ = true; return Fail;
  19793. }
  19794. }
  19795. return Fail;
  19796. }
  19797. inline bool WebSocket::send(const std::string &data) {
  19798. return send_frame(Opcode::Text, data.data(), data.size());
  19799. }
  19800. inline bool WebSocket::send(const char *data, size_t len) {
  19801. return send_frame(Opcode::Binary, data, len);
  19802. }
  19803. inline void WebSocket::close(CloseStatus status, const std::string &reason) {
  19804. if (closed_.exchange(true)) { return; }
  19805. ping_cv_.notify_all();
  19806. std::string payload;
  19807. auto code = static_cast<uint16_t>(status);
  19808. payload.push_back(static_cast<char>((code >> 8) & 0xFF));
  19809. payload.push_back(static_cast<char>(code & 0xFF));
  19810. // RFC 6455 Section 5.5: control frame payload must not exceed 125 bytes
  19811. // Close frame has 2-byte status code, so reason is limited to 123 bytes,
  19812. // cut back to a whole UTF-8 character
  19813. auto short_reason = reason.substr(0, 123);
  19814. while (!short_reason.empty() && !impl::is_valid_utf8(short_reason)) {
  19815. short_reason.pop_back();
  19816. }
  19817. payload += short_reason;
  19818. // A code that may not be sent, such as NoStatus, goes without a payload
  19819. if (!impl::is_valid_close_payload(payload)) { payload.clear(); }
  19820. {
  19821. std::lock_guard<std::mutex> lock(write_mutex_);
  19822. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  19823. payload.size(), true, !is_server_);
  19824. }
  19825. // RFC 6455 Section 7.1.1: after sending a Close frame, wait for the peer's
  19826. // Close response before closing the TCP connection.
  19827. //
  19828. // Wait only when no other thread is parsing frames. When one is, it is the
  19829. // thread positioned to see the peer's reply, and reading here would take
  19830. // bytes out of the message it is assembling. Bailing out also leaves the
  19831. // stream, including its read timeout, entirely to that thread.
  19832. std::unique_lock<std::mutex> read_lock(read_mutex_, std::try_to_lock);
  19833. if (!read_lock.owns_lock()) { return; }
  19834. // Use a short timeout to avoid hanging if the peer doesn't respond.
  19835. strm_.set_read_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  19836. Opcode op;
  19837. std::string resp;
  19838. bool fin;
  19839. while (impl::read_websocket_frame(strm_, op, resp, fin, is_server_, 125) ==
  19840. impl::FrameRead::Ok) {
  19841. if (op == Opcode::Close) { break; }
  19842. }
  19843. }
  19844. inline WebSocket::~WebSocket() {
  19845. {
  19846. std::lock_guard<std::mutex> lock(ping_mutex_);
  19847. closed_ = true;
  19848. }
  19849. ping_cv_.notify_all();
  19850. if (ping_thread_.joinable()) { ping_thread_.join(); }
  19851. }
  19852. inline void WebSocket::start_heartbeat() {
  19853. if (ping_interval_sec_ == 0) { return; }
  19854. ping_thread_ = std::thread([this]() {
  19855. std::unique_lock<std::mutex> lock(ping_mutex_);
  19856. // The predicate keeps a spurious wakeup from sending a ping early
  19857. while (!ping_cv_.wait_for(lock, std::chrono::seconds(ping_interval_sec_),
  19858. [this]() { return closed_.load(); })) {
  19859. // If the peer has failed to respond to the previous pings, give up.
  19860. // RFC 6455 does not define a pong-timeout mechanism; this is an
  19861. // opt-in liveness check controlled by max_missed_pongs_.
  19862. if (max_missed_pongs_ > 0 && unacked_pings_ >= max_missed_pongs_) {
  19863. lock.unlock();
  19864. close(CloseStatus::GoingAway, "pong timeout");
  19865. // Wake a read() blocked on the unresponsive peer. Only the read side
  19866. // is shut down: a TLS backend answers the EOF with an alert, and
  19867. // writing it to a socket closed for writing raises SIGPIPE.
  19868. #ifdef _WIN32
  19869. shutdown(strm_.socket(), SD_RECEIVE);
  19870. #else
  19871. shutdown(strm_.socket(), SHUT_RD);
  19872. #endif
  19873. return;
  19874. }
  19875. lock.unlock();
  19876. if (!send_frame(Opcode::Ping, nullptr, 0)) {
  19877. lock.lock();
  19878. closed_ = true;
  19879. break;
  19880. }
  19881. lock.lock();
  19882. unacked_pings_++;
  19883. }
  19884. });
  19885. }
  19886. inline const Request &WebSocket::request() const { return req_; }
  19887. inline bool WebSocket::is_open() const { return !closed_; }
  19888. inline void WebSocket::set_read_timeout(time_t sec, time_t usec) {
  19889. // 0 waits forever here, as it does for SO_RCVTIMEO. The stream waits with
  19890. // poll(), where 0 would instead mean "return immediately", so hand it the
  19891. // negative poll uses for an unbounded wait.
  19892. if (sec == 0 && usec == 0) { sec = -1; }
  19893. strm_.set_read_timeout(sec, usec);
  19894. read_timeout_set_ = true;
  19895. }
  19896. // WebSocketClient implementation
  19897. inline WebSocketClient::WebSocketClient(
  19898. const std::string &scheme_host_port_path, const Headers &headers)
  19899. : headers_(headers) {
  19900. detail::UrlComponents uc;
  19901. if (detail::parse_url(scheme_host_port_path, uc) && !uc.scheme.empty() &&
  19902. !uc.host.empty() && !uc.path.empty()) {
  19903. auto &scheme = uc.scheme;
  19904. #ifdef CPPHTTPLIB_SSL_ENABLED
  19905. if (scheme != "ws" && scheme != "wss") {
  19906. #else
  19907. if (scheme != "ws") {
  19908. #endif
  19909. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  19910. std::string msg = "'" + scheme + "' scheme is not supported.";
  19911. throw std::invalid_argument(msg);
  19912. #endif
  19913. return;
  19914. }
  19915. auto is_ssl = scheme == "wss";
  19916. host_ = std::move(uc.host);
  19917. port_ = is_ssl ? 443 : 80;
  19918. if (!uc.port.empty() && !detail::parse_port(uc.port, port_)) { return; }
  19919. path_ = std::move(uc.path);
  19920. if (!uc.query.empty()) { path_ += uc.query; }
  19921. #ifdef CPPHTTPLIB_SSL_ENABLED
  19922. is_ssl_ = is_ssl;
  19923. if (is_ssl_) {
  19924. // The context lives as long as the client so that CA configuration
  19925. // survives reconnects; sessions are created per connection.
  19926. tls_ctx_ = tls::create_client_context();
  19927. if (!tls_ctx_) { return; }
  19928. }
  19929. #else
  19930. if (is_ssl) { return; }
  19931. #endif
  19932. is_valid_ = true;
  19933. }
  19934. }
  19935. #ifdef CPPHTTPLIB_SSL_ENABLED
  19936. inline WebSocketClient::WebSocketClient(
  19937. const std::string &scheme_host_port_path, const PemMemory &pem,
  19938. const Headers &headers)
  19939. : WebSocketClient(scheme_host_port_path, headers) {
  19940. // For ws:// URLs the client certificate is silently ignored, consistent
  19941. // with the TLS-only setters such as set_ca_cert_path().
  19942. if (is_valid_ && is_ssl_ && pem.cert_pem && pem.key_pem) {
  19943. if (!tls::set_client_cert_pem(tls_ctx_, pem.cert_pem, pem.key_pem,
  19944. pem.private_key_password)) {
  19945. tls::free_context(tls_ctx_);
  19946. tls_ctx_ = nullptr;
  19947. is_valid_ = false;
  19948. }
  19949. }
  19950. }
  19951. #endif
  19952. inline WebSocketClient::~WebSocketClient() {
  19953. shutdown_and_close();
  19954. #ifdef CPPHTTPLIB_SSL_ENABLED
  19955. if (tls_ctx_) {
  19956. tls::free_context(tls_ctx_);
  19957. tls_ctx_ = nullptr;
  19958. }
  19959. #endif
  19960. }
  19961. inline bool WebSocketClient::is_valid() const { return is_valid_; }
  19962. inline void WebSocketClient::shutdown_and_close() {
  19963. // Send the close frame while the TLS session is still alive: ws_ holds an
  19964. // SSLSocketStream that keeps a raw pointer to tls_session_, so the session
  19965. // must outlive ws_->close() and ws_.reset() to avoid a use-after-free.
  19966. if (ws_ && ws_->is_open()) { ws_->close(); }
  19967. ws_.reset();
  19968. #ifdef CPPHTTPLIB_SSL_ENABLED
  19969. if (is_ssl_) {
  19970. if (tls_session_) {
  19971. tls::shutdown(tls_session_, true);
  19972. tls::free_session(tls_session_);
  19973. tls_session_ = nullptr;
  19974. }
  19975. }
  19976. #endif
  19977. if (sock_ != INVALID_SOCKET) {
  19978. detail::shutdown_socket(sock_);
  19979. detail::close_socket(sock_);
  19980. sock_ = INVALID_SOCKET;
  19981. }
  19982. }
  19983. inline bool WebSocketClient::create_stream(std::unique_ptr<Stream> &strm,
  19984. Error &error, int &ssl_error,
  19985. uint64_t &ssl_backend_error) {
  19986. // A read timeout of 0 means "wait forever", the way SO_RCVTIMEO reads it.
  19987. // The streams wait with poll(), where 0 instead means "return immediately",
  19988. // so they are given the negative poll uses for an unbounded wait.
  19989. auto unbounded = read_timeout_sec_ == 0 && read_timeout_usec_ == 0;
  19990. time_t strm_read_sec = unbounded ? -1 : read_timeout_sec_;
  19991. time_t strm_read_usec = unbounded ? 0 : read_timeout_usec_;
  19992. // The handshake belongs to establishing the connection, so an unset read
  19993. // timeout leaves it bounded by the connection timeout instead of forever.
  19994. time_t hs_sec = unbounded ? connection_timeout_sec_ : read_timeout_sec_;
  19995. time_t hs_usec = unbounded ? connection_timeout_usec_ : read_timeout_usec_;
  19996. #ifdef CPPHTTPLIB_SSL_ENABLED
  19997. if (is_ssl_) {
  19998. // A plain flag rather than SSLClient::load_certs()'s call_once: connect()
  19999. // is not safe to call concurrently on one client to begin with, since
  20000. // nothing else here is guarded either.
  20001. if (server_certificate_verification_ && !certs_loaded_) {
  20002. uint64_t backend_error = 0;
  20003. detail::load_client_ca_config(tls_ctx_, ca_cert_file_path_,
  20004. ca_cert_dir_path_, custom_ca_loaded_,
  20005. system_ca_mode_, backend_error);
  20006. certs_loaded_ = true;
  20007. }
  20008. detail::ClientTlsSessionOptions options;
  20009. options.server_hostname_verification = server_hostname_verification_;
  20010. options.session_verifier = session_verifier_;
  20011. detail::ClientTlsSessionError tls_error;
  20012. if (!detail::setup_client_tls_session(host_, tls_ctx_, tls_session_, sock_,
  20013. server_certificate_verification_,
  20014. hs_sec, hs_usec, &tls_error,
  20015. options)) {
  20016. error = tls_error.error;
  20017. ssl_error = tls_error.ssl_error;
  20018. ssl_backend_error = tls_error.backend_error;
  20019. return false;
  20020. }
  20021. strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  20022. sock_, tls_session_, strm_read_sec, strm_read_usec, write_timeout_sec_,
  20023. write_timeout_usec_));
  20024. return true;
  20025. }
  20026. #else
  20027. (void)error;
  20028. (void)ssl_error;
  20029. (void)ssl_backend_error;
  20030. (void)hs_sec;
  20031. (void)hs_usec;
  20032. #endif
  20033. strm = std::unique_ptr<Stream>(
  20034. new detail::SocketStream(sock_, strm_read_sec, strm_read_usec,
  20035. write_timeout_sec_, write_timeout_usec_));
  20036. return true;
  20037. }
  20038. inline void WebSocketClient::prepare_default_headers(Request &req) {
  20039. #ifdef CPPHTTPLIB_SSL_ENABLED
  20040. auto is_ssl = is_ssl_;
  20041. #else
  20042. auto is_ssl = false;
  20043. #endif
  20044. if (!req.has_header("Host")) {
  20045. req.headers.emplace("Host", detail::make_default_host_header_value(
  20046. host_, port_, is_ssl, address_family_));
  20047. }
  20048. detail::add_default_user_agent_header(req);
  20049. }
  20050. inline Result WebSocketClient::connect() {
  20051. if (!is_valid_) { return Result{Error::Connection, -1, Headers{}}; }
  20052. shutdown_and_close();
  20053. // Check is custom IP or hostname specified for host_
  20054. std::string connect_host;
  20055. std::string ip;
  20056. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  20057. auto error = Error::Success;
  20058. sock_ = detail::create_client_socket(
  20059. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  20060. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  20061. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  20062. write_timeout_usec_, interface_, error);
  20063. if (sock_ == INVALID_SOCKET) {
  20064. if (error == Error::Success) { error = Error::Connection; }
  20065. return Result{error, -1, Headers{}};
  20066. }
  20067. std::unique_ptr<Stream> strm;
  20068. auto stream_error = Error::SSLConnection;
  20069. int ssl_error = 0;
  20070. uint64_t ssl_backend_error = 0;
  20071. if (!create_stream(strm, stream_error, ssl_error, ssl_backend_error)) {
  20072. shutdown_and_close();
  20073. #ifdef CPPHTTPLIB_SSL_ENABLED
  20074. return Result{stream_error, -1, Headers{}, ssl_error, ssl_backend_error};
  20075. #else
  20076. return Result{stream_error, -1, Headers{}};
  20077. #endif
  20078. }
  20079. Request req;
  20080. req.method = "GET";
  20081. req.path = path_;
  20082. req.headers = headers_;
  20083. prepare_default_headers(req);
  20084. detail::WebSocketUpgradeResponse upgrade;
  20085. if (!detail::perform_websocket_handshake(*strm, req, upgrade)) {
  20086. shutdown_and_close();
  20087. return Result{upgrade.error, upgrade.status, std::move(upgrade.headers)};
  20088. }
  20089. subprotocol_ = std::move(upgrade.selected_subprotocol);
  20090. ws_ = std::unique_ptr<WebSocket>(new WebSocket(std::move(strm), req, false,
  20091. websocket_ping_interval_sec_,
  20092. websocket_max_missed_pongs_));
  20093. // The stream was created with the timeout already; tell the WebSocket
  20094. // whether it came from the caller, so read() knows to report it as Timeout.
  20095. ws_->read_timeout_set_ = read_timeout_set_;
  20096. return Result{Error::Success, upgrade.status, std::move(upgrade.headers)};
  20097. }
  20098. inline ReadResult WebSocketClient::read(std::string &msg) {
  20099. if (!ws_) { return Fail; }
  20100. return ws_->read(msg);
  20101. }
  20102. inline bool WebSocketClient::send(const std::string &data) {
  20103. if (!ws_) { return false; }
  20104. return ws_->send(data);
  20105. }
  20106. inline bool WebSocketClient::send(const char *data, size_t len) {
  20107. if (!ws_) { return false; }
  20108. return ws_->send(data, len);
  20109. }
  20110. inline void WebSocketClient::close(CloseStatus status,
  20111. const std::string &reason) {
  20112. if (ws_) { ws_->close(status, reason); }
  20113. }
  20114. inline bool WebSocketClient::is_open() const { return ws_ && ws_->is_open(); }
  20115. inline const std::string &WebSocketClient::subprotocol() const {
  20116. return subprotocol_;
  20117. }
  20118. inline void WebSocketClient::set_read_timeout(time_t sec, time_t usec) {
  20119. read_timeout_sec_ = sec;
  20120. read_timeout_usec_ = usec;
  20121. read_timeout_set_ = true;
  20122. // The members above only seed the next connect(); read() consults the
  20123. // stream, so an already-open connection has to be told directly.
  20124. if (ws_) { ws_->set_read_timeout(sec, usec); }
  20125. }
  20126. inline void WebSocketClient::set_write_timeout(time_t sec, time_t usec) {
  20127. write_timeout_sec_ = sec;
  20128. write_timeout_usec_ = usec;
  20129. }
  20130. inline void WebSocketClient::set_websocket_ping_interval(time_t sec) {
  20131. websocket_ping_interval_sec_ = sec;
  20132. }
  20133. inline void WebSocketClient::set_websocket_max_missed_pongs(int count) {
  20134. websocket_max_missed_pongs_ = count;
  20135. }
  20136. inline void WebSocketClient::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  20137. inline void WebSocketClient::set_address_family(int family) {
  20138. address_family_ = family;
  20139. }
  20140. inline void WebSocketClient::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  20141. inline void WebSocketClient::set_socket_options(SocketOptions socket_options) {
  20142. socket_options_ = std::move(socket_options);
  20143. }
  20144. inline void WebSocketClient::set_connection_timeout(time_t sec, time_t usec) {
  20145. connection_timeout_sec_ = sec;
  20146. connection_timeout_usec_ = usec;
  20147. }
  20148. inline void WebSocketClient::set_interface(const std::string &intf) {
  20149. interface_ = intf;
  20150. }
  20151. inline void WebSocketClient::set_hostname_addr_map(
  20152. std::map<std::string, std::string> addr_map) {
  20153. addr_map_ = std::move(addr_map);
  20154. }
  20155. #ifdef CPPHTTPLIB_SSL_ENABLED
  20156. inline void
  20157. WebSocketClient::set_ca_cert_path(const std::string &ca_cert_file_path,
  20158. const std::string &ca_cert_dir_path) {
  20159. ca_cert_file_path_ = ca_cert_file_path;
  20160. ca_cert_dir_path_ = ca_cert_dir_path;
  20161. }
  20162. inline void
  20163. WebSocketClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  20164. if (tls_ctx_) { tls::set_verify_callback(tls_ctx_, std::move(verifier)); }
  20165. }
  20166. inline void WebSocketClient::set_session_verifier(
  20167. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  20168. session_verifier_ = std::move(verifier);
  20169. }
  20170. inline void WebSocketClient::set_ca_cert_store(tls::ca_store_t store) {
  20171. if (store && tls_ctx_) {
  20172. // set_ca_store takes ownership of store
  20173. tls::set_ca_store(tls_ctx_, store);
  20174. custom_ca_loaded_ = true;
  20175. } else if (store) {
  20176. tls::free_ca_store(store);
  20177. }
  20178. }
  20179. inline void WebSocketClient::load_ca_cert_store(const char *ca_cert,
  20180. std::size_t size) {
  20181. if (tls_ctx_ && ca_cert && size > 0) {
  20182. tls::load_ca_pem(tls_ctx_, ca_cert, size);
  20183. custom_ca_loaded_ = true;
  20184. }
  20185. }
  20186. inline void
  20187. WebSocketClient::enable_server_certificate_verification(bool enabled) {
  20188. server_certificate_verification_ = enabled;
  20189. }
  20190. inline void WebSocketClient::enable_server_hostname_verification(bool enabled) {
  20191. server_hostname_verification_ = enabled;
  20192. }
  20193. inline void WebSocketClient::enable_system_ca(bool enabled) {
  20194. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  20195. }
  20196. #endif // CPPHTTPLIB_SSL_ENABLED
  20197. } // namespace ws
  20198. // ----------------------------------------------------------------------------
  20199. } // namespace httplib
  20200. #endif // CPPHTTPLIB_HTTPLIB_H