httplib.h 839 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446144471444814449144501445114452144531445414455144561445714458144591446014461144621446314464144651446614467144681446914470144711447214473144741447514476144771447814479144801448114482144831448414485144861448714488144891449014491144921449314494144951449614497144981449914500145011450214503145041450514506145071450814509145101451114512145131451414515145161451714518145191452014521145221452314524145251452614527145281452914530145311453214533145341453514536145371453814539145401454114542145431454414545145461454714548145491455014551145521455314554145551455614557145581455914560145611456214563145641456514566145671456814569145701457114572145731457414575145761457714578145791458014581145821458314584145851458614587145881458914590145911459214593145941459514596145971459814599146001460114602146031460414605146061460714608146091461014611146121461314614146151461614617146181461914620146211462214623146241462514626146271462814629146301463114632146331463414635146361463714638146391464014641146421464314644146451464614647146481464914650146511465214653146541465514656146571465814659146601466114662146631466414665146661466714668146691467014671146721467314674146751467614677146781467914680146811468214683146841468514686146871468814689146901469114692146931469414695146961469714698146991470014701147021470314704147051470614707147081470914710147111471214713147141471514716147171471814719147201472114722147231472414725147261472714728147291473014731147321473314734147351473614737147381473914740147411474214743147441474514746147471474814749147501475114752147531475414755147561475714758147591476014761147621476314764147651476614767147681476914770147711477214773147741477514776147771477814779147801478114782147831478414785147861478714788147891479014791147921479314794147951479614797147981479914800148011480214803148041480514806148071480814809148101481114812148131481414815148161481714818148191482014821148221482314824148251482614827148281482914830148311483214833148341483514836148371483814839148401484114842148431484414845148461484714848148491485014851148521485314854148551485614857148581485914860148611486214863148641486514866148671486814869148701487114872148731487414875148761487714878148791488014881148821488314884148851488614887148881488914890148911489214893148941489514896148971489814899149001490114902149031490414905149061490714908149091491014911149121491314914149151491614917149181491914920149211492214923149241492514926149271492814929149301493114932149331493414935149361493714938149391494014941149421494314944149451494614947149481494914950149511495214953149541495514956149571495814959149601496114962149631496414965149661496714968149691497014971149721497314974149751497614977149781497914980149811498214983149841498514986149871498814989149901499114992149931499414995149961499714998149991500015001150021500315004150051500615007150081500915010150111501215013150141501515016150171501815019150201502115022150231502415025150261502715028150291503015031150321503315034150351503615037150381503915040150411504215043150441504515046150471504815049150501505115052150531505415055150561505715058150591506015061150621506315064150651506615067150681506915070150711507215073150741507515076150771507815079150801508115082150831508415085150861508715088150891509015091150921509315094150951509615097150981509915100151011510215103151041510515106151071510815109151101511115112151131511415115151161511715118151191512015121151221512315124151251512615127151281512915130151311513215133151341513515136151371513815139151401514115142151431514415145151461514715148151491515015151151521515315154151551515615157151581515915160151611516215163151641516515166151671516815169151701517115172151731517415175151761517715178151791518015181151821518315184151851518615187151881518915190151911519215193151941519515196151971519815199152001520115202152031520415205152061520715208152091521015211152121521315214152151521615217152181521915220152211522215223152241522515226152271522815229152301523115232152331523415235152361523715238152391524015241152421524315244152451524615247152481524915250152511525215253152541525515256152571525815259152601526115262152631526415265152661526715268152691527015271152721527315274152751527615277152781527915280152811528215283152841528515286152871528815289152901529115292152931529415295152961529715298152991530015301153021530315304153051530615307153081530915310153111531215313153141531515316153171531815319153201532115322153231532415325153261532715328153291533015331153321533315334153351533615337153381533915340153411534215343153441534515346153471534815349153501535115352153531535415355153561535715358153591536015361153621536315364153651536615367153681536915370153711537215373153741537515376153771537815379153801538115382153831538415385153861538715388153891539015391153921539315394153951539615397153981539915400154011540215403154041540515406154071540815409154101541115412154131541415415154161541715418154191542015421154221542315424154251542615427154281542915430154311543215433154341543515436154371543815439154401544115442154431544415445154461544715448154491545015451154521545315454154551545615457154581545915460154611546215463154641546515466154671546815469154701547115472154731547415475154761547715478154791548015481154821548315484154851548615487154881548915490154911549215493154941549515496154971549815499155001550115502155031550415505155061550715508155091551015511155121551315514155151551615517155181551915520155211552215523155241552515526155271552815529155301553115532155331553415535155361553715538155391554015541155421554315544155451554615547155481554915550155511555215553155541555515556155571555815559155601556115562155631556415565155661556715568155691557015571155721557315574155751557615577155781557915580155811558215583155841558515586155871558815589155901559115592155931559415595155961559715598155991560015601156021560315604156051560615607156081560915610156111561215613156141561515616156171561815619156201562115622156231562415625156261562715628156291563015631156321563315634156351563615637156381563915640156411564215643156441564515646156471564815649156501565115652156531565415655156561565715658156591566015661156621566315664156651566615667156681566915670156711567215673156741567515676156771567815679156801568115682156831568415685156861568715688156891569015691156921569315694156951569615697156981569915700157011570215703157041570515706157071570815709157101571115712157131571415715157161571715718157191572015721157221572315724157251572615727157281572915730157311573215733157341573515736157371573815739157401574115742157431574415745157461574715748157491575015751157521575315754157551575615757157581575915760157611576215763157641576515766157671576815769157701577115772157731577415775157761577715778157791578015781157821578315784157851578615787157881578915790157911579215793157941579515796157971579815799158001580115802158031580415805158061580715808158091581015811158121581315814158151581615817158181581915820158211582215823158241582515826158271582815829158301583115832158331583415835158361583715838158391584015841158421584315844158451584615847158481584915850158511585215853158541585515856158571585815859158601586115862158631586415865158661586715868158691587015871158721587315874158751587615877158781587915880158811588215883158841588515886158871588815889158901589115892158931589415895158961589715898158991590015901159021590315904159051590615907159081590915910159111591215913159141591515916159171591815919159201592115922159231592415925159261592715928159291593015931159321593315934159351593615937159381593915940159411594215943159441594515946159471594815949159501595115952159531595415955159561595715958159591596015961159621596315964159651596615967159681596915970159711597215973159741597515976159771597815979159801598115982159831598415985159861598715988159891599015991159921599315994159951599615997159981599916000160011600216003160041600516006160071600816009160101601116012160131601416015160161601716018160191602016021160221602316024160251602616027160281602916030160311603216033160341603516036160371603816039160401604116042160431604416045160461604716048160491605016051160521605316054160551605616057160581605916060160611606216063160641606516066160671606816069160701607116072160731607416075160761607716078160791608016081160821608316084160851608616087160881608916090160911609216093160941609516096160971609816099161001610116102161031610416105161061610716108161091611016111161121611316114161151611616117161181611916120161211612216123161241612516126161271612816129161301613116132161331613416135161361613716138161391614016141161421614316144161451614616147161481614916150161511615216153161541615516156161571615816159161601616116162161631616416165161661616716168161691617016171161721617316174161751617616177161781617916180161811618216183161841618516186161871618816189161901619116192161931619416195161961619716198161991620016201162021620316204162051620616207162081620916210162111621216213162141621516216162171621816219162201622116222162231622416225162261622716228162291623016231162321623316234162351623616237162381623916240162411624216243162441624516246162471624816249162501625116252162531625416255162561625716258162591626016261162621626316264162651626616267162681626916270162711627216273162741627516276162771627816279162801628116282162831628416285162861628716288162891629016291162921629316294162951629616297162981629916300163011630216303163041630516306163071630816309163101631116312163131631416315163161631716318163191632016321163221632316324163251632616327163281632916330163311633216333163341633516336163371633816339163401634116342163431634416345163461634716348163491635016351163521635316354163551635616357163581635916360163611636216363163641636516366163671636816369163701637116372163731637416375163761637716378163791638016381163821638316384163851638616387163881638916390163911639216393163941639516396163971639816399164001640116402164031640416405164061640716408164091641016411164121641316414164151641616417164181641916420164211642216423164241642516426164271642816429164301643116432164331643416435164361643716438164391644016441164421644316444164451644616447164481644916450164511645216453164541645516456164571645816459164601646116462164631646416465164661646716468164691647016471164721647316474164751647616477164781647916480164811648216483164841648516486164871648816489164901649116492164931649416495164961649716498164991650016501165021650316504165051650616507165081650916510165111651216513165141651516516165171651816519165201652116522165231652416525165261652716528165291653016531165321653316534165351653616537165381653916540165411654216543165441654516546165471654816549165501655116552165531655416555165561655716558165591656016561165621656316564165651656616567165681656916570165711657216573165741657516576165771657816579165801658116582165831658416585165861658716588165891659016591165921659316594165951659616597165981659916600166011660216603166041660516606166071660816609166101661116612166131661416615166161661716618166191662016621166221662316624166251662616627166281662916630166311663216633166341663516636166371663816639166401664116642166431664416645166461664716648166491665016651166521665316654166551665616657166581665916660166611666216663166641666516666166671666816669166701667116672166731667416675166761667716678166791668016681166821668316684166851668616687166881668916690166911669216693166941669516696166971669816699167001670116702167031670416705167061670716708167091671016711167121671316714167151671616717167181671916720167211672216723167241672516726167271672816729167301673116732167331673416735167361673716738167391674016741167421674316744167451674616747167481674916750167511675216753167541675516756167571675816759167601676116762167631676416765167661676716768167691677016771167721677316774167751677616777167781677916780167811678216783167841678516786167871678816789167901679116792167931679416795167961679716798167991680016801168021680316804168051680616807168081680916810168111681216813168141681516816168171681816819168201682116822168231682416825168261682716828168291683016831168321683316834168351683616837168381683916840168411684216843168441684516846168471684816849168501685116852168531685416855168561685716858168591686016861168621686316864168651686616867168681686916870168711687216873168741687516876168771687816879168801688116882168831688416885168861688716888168891689016891168921689316894168951689616897168981689916900169011690216903169041690516906169071690816909169101691116912169131691416915169161691716918169191692016921169221692316924169251692616927169281692916930169311693216933169341693516936169371693816939169401694116942169431694416945169461694716948169491695016951169521695316954169551695616957169581695916960169611696216963169641696516966169671696816969169701697116972169731697416975169761697716978169791698016981169821698316984169851698616987169881698916990169911699216993169941699516996169971699816999170001700117002170031700417005170061700717008170091701017011170121701317014170151701617017170181701917020170211702217023170241702517026170271702817029170301703117032170331703417035170361703717038170391704017041170421704317044170451704617047170481704917050170511705217053170541705517056170571705817059170601706117062170631706417065170661706717068170691707017071170721707317074170751707617077170781707917080170811708217083170841708517086170871708817089170901709117092170931709417095170961709717098170991710017101171021710317104171051710617107171081710917110171111711217113171141711517116171171711817119171201712117122171231712417125171261712717128171291713017131171321713317134171351713617137171381713917140171411714217143171441714517146171471714817149171501715117152171531715417155171561715717158171591716017161171621716317164171651716617167171681716917170171711717217173171741717517176171771717817179171801718117182171831718417185171861718717188171891719017191171921719317194171951719617197171981719917200172011720217203172041720517206172071720817209172101721117212172131721417215172161721717218172191722017221172221722317224172251722617227172281722917230172311723217233172341723517236172371723817239172401724117242172431724417245172461724717248172491725017251172521725317254172551725617257172581725917260172611726217263172641726517266172671726817269172701727117272172731727417275172761727717278172791728017281172821728317284172851728617287172881728917290172911729217293172941729517296172971729817299173001730117302173031730417305173061730717308173091731017311173121731317314173151731617317173181731917320173211732217323173241732517326173271732817329173301733117332173331733417335173361733717338173391734017341173421734317344173451734617347173481734917350173511735217353173541735517356173571735817359173601736117362173631736417365173661736717368173691737017371173721737317374173751737617377173781737917380173811738217383173841738517386173871738817389173901739117392173931739417395173961739717398173991740017401174021740317404174051740617407174081740917410174111741217413174141741517416174171741817419174201742117422174231742417425174261742717428174291743017431174321743317434174351743617437174381743917440174411744217443174441744517446174471744817449174501745117452174531745417455174561745717458174591746017461174621746317464174651746617467174681746917470174711747217473174741747517476174771747817479174801748117482174831748417485174861748717488174891749017491174921749317494174951749617497174981749917500175011750217503175041750517506175071750817509175101751117512175131751417515175161751717518175191752017521175221752317524175251752617527175281752917530175311753217533175341753517536175371753817539175401754117542175431754417545175461754717548175491755017551175521755317554175551755617557175581755917560175611756217563175641756517566175671756817569175701757117572175731757417575175761757717578175791758017581175821758317584175851758617587175881758917590175911759217593175941759517596175971759817599176001760117602176031760417605176061760717608176091761017611176121761317614176151761617617176181761917620176211762217623176241762517626176271762817629176301763117632176331763417635176361763717638176391764017641176421764317644176451764617647176481764917650176511765217653176541765517656176571765817659176601766117662176631766417665176661766717668176691767017671176721767317674176751767617677176781767917680176811768217683176841768517686176871768817689176901769117692176931769417695176961769717698176991770017701177021770317704177051770617707177081770917710177111771217713177141771517716177171771817719177201772117722177231772417725177261772717728177291773017731177321773317734177351773617737177381773917740177411774217743177441774517746177471774817749177501775117752177531775417755177561775717758177591776017761177621776317764177651776617767177681776917770177711777217773177741777517776177771777817779177801778117782177831778417785177861778717788177891779017791177921779317794177951779617797177981779917800178011780217803178041780517806178071780817809178101781117812178131781417815178161781717818178191782017821178221782317824178251782617827178281782917830178311783217833178341783517836178371783817839178401784117842178431784417845178461784717848178491785017851178521785317854178551785617857178581785917860178611786217863178641786517866178671786817869178701787117872178731787417875178761787717878178791788017881178821788317884178851788617887178881788917890178911789217893178941789517896178971789817899179001790117902179031790417905179061790717908179091791017911179121791317914179151791617917179181791917920179211792217923179241792517926179271792817929179301793117932179331793417935179361793717938179391794017941179421794317944179451794617947179481794917950179511795217953179541795517956179571795817959179601796117962179631796417965179661796717968179691797017971179721797317974179751797617977179781797917980179811798217983179841798517986179871798817989179901799117992179931799417995179961799717998179991800018001180021800318004180051800618007180081800918010180111801218013180141801518016180171801818019180201802118022180231802418025180261802718028180291803018031180321803318034180351803618037180381803918040180411804218043180441804518046180471804818049180501805118052180531805418055180561805718058180591806018061180621806318064180651806618067180681806918070180711807218073180741807518076180771807818079180801808118082180831808418085180861808718088180891809018091180921809318094180951809618097180981809918100181011810218103181041810518106181071810818109181101811118112181131811418115181161811718118181191812018121181221812318124181251812618127181281812918130181311813218133181341813518136181371813818139181401814118142181431814418145181461814718148181491815018151181521815318154181551815618157181581815918160181611816218163181641816518166181671816818169181701817118172181731817418175181761817718178181791818018181181821818318184181851818618187181881818918190181911819218193181941819518196181971819818199182001820118202182031820418205182061820718208182091821018211182121821318214182151821618217182181821918220182211822218223182241822518226182271822818229182301823118232182331823418235182361823718238182391824018241182421824318244182451824618247182481824918250182511825218253182541825518256182571825818259182601826118262182631826418265182661826718268182691827018271182721827318274182751827618277182781827918280182811828218283182841828518286182871828818289182901829118292182931829418295182961829718298182991830018301183021830318304183051830618307183081830918310183111831218313183141831518316183171831818319183201832118322183231832418325183261832718328183291833018331183321833318334183351833618337183381833918340183411834218343183441834518346183471834818349183501835118352183531835418355183561835718358183591836018361183621836318364183651836618367183681836918370183711837218373183741837518376183771837818379183801838118382183831838418385183861838718388183891839018391183921839318394183951839618397183981839918400184011840218403184041840518406184071840818409184101841118412184131841418415184161841718418184191842018421184221842318424184251842618427184281842918430184311843218433184341843518436184371843818439184401844118442184431844418445184461844718448184491845018451184521845318454184551845618457184581845918460184611846218463184641846518466184671846818469184701847118472184731847418475184761847718478184791848018481184821848318484184851848618487184881848918490184911849218493184941849518496184971849818499185001850118502185031850418505185061850718508185091851018511185121851318514185151851618517185181851918520185211852218523185241852518526185271852818529185301853118532185331853418535185361853718538185391854018541185421854318544185451854618547185481854918550185511855218553185541855518556185571855818559185601856118562185631856418565185661856718568185691857018571185721857318574185751857618577185781857918580185811858218583185841858518586185871858818589185901859118592185931859418595185961859718598185991860018601186021860318604186051860618607186081860918610186111861218613186141861518616186171861818619186201862118622186231862418625186261862718628186291863018631186321863318634186351863618637186381863918640186411864218643186441864518646186471864818649186501865118652186531865418655186561865718658186591866018661186621866318664186651866618667186681866918670186711867218673186741867518676186771867818679186801868118682186831868418685186861868718688186891869018691186921869318694186951869618697186981869918700187011870218703187041870518706187071870818709187101871118712187131871418715187161871718718187191872018721187221872318724187251872618727187281872918730187311873218733187341873518736187371873818739187401874118742187431874418745187461874718748187491875018751187521875318754187551875618757187581875918760187611876218763187641876518766187671876818769187701877118772187731877418775187761877718778187791878018781187821878318784187851878618787187881878918790187911879218793187941879518796187971879818799188001880118802188031880418805188061880718808188091881018811188121881318814188151881618817188181881918820188211882218823188241882518826188271882818829188301883118832188331883418835188361883718838188391884018841188421884318844188451884618847188481884918850188511885218853188541885518856188571885818859188601886118862188631886418865188661886718868188691887018871188721887318874188751887618877188781887918880188811888218883188841888518886188871888818889188901889118892188931889418895188961889718898188991890018901189021890318904189051890618907189081890918910189111891218913189141891518916189171891818919189201892118922189231892418925189261892718928189291893018931189321893318934189351893618937189381893918940189411894218943189441894518946189471894818949189501895118952189531895418955189561895718958189591896018961189621896318964189651896618967189681896918970189711897218973189741897518976189771897818979189801898118982189831898418985189861898718988189891899018991189921899318994189951899618997189981899919000190011900219003190041900519006190071900819009190101901119012190131901419015190161901719018190191902019021190221902319024190251902619027190281902919030190311903219033190341903519036190371903819039190401904119042190431904419045190461904719048190491905019051190521905319054190551905619057190581905919060190611906219063190641906519066190671906819069190701907119072190731907419075190761907719078190791908019081190821908319084190851908619087190881908919090190911909219093190941909519096190971909819099191001910119102191031910419105191061910719108191091911019111191121911319114191151911619117191181911919120191211912219123191241912519126191271912819129191301913119132191331913419135191361913719138191391914019141191421914319144191451914619147191481914919150191511915219153191541915519156191571915819159191601916119162191631916419165191661916719168191691917019171191721917319174191751917619177191781917919180191811918219183191841918519186191871918819189191901919119192191931919419195191961919719198191991920019201192021920319204192051920619207192081920919210192111921219213192141921519216192171921819219192201922119222192231922419225192261922719228192291923019231192321923319234192351923619237192381923919240192411924219243192441924519246192471924819249192501925119252192531925419255192561925719258192591926019261192621926319264192651926619267192681926919270192711927219273192741927519276192771927819279192801928119282192831928419285192861928719288192891929019291192921929319294192951929619297192981929919300193011930219303193041930519306193071930819309193101931119312193131931419315193161931719318193191932019321193221932319324193251932619327193281932919330193311933219333193341933519336193371933819339193401934119342193431934419345193461934719348193491935019351193521935319354193551935619357193581935919360193611936219363193641936519366193671936819369193701937119372193731937419375193761937719378193791938019381193821938319384193851938619387193881938919390193911939219393193941939519396193971939819399194001940119402194031940419405194061940719408194091941019411194121941319414194151941619417194181941919420194211942219423194241942519426194271942819429194301943119432194331943419435194361943719438194391944019441194421944319444194451944619447194481944919450194511945219453194541945519456194571945819459194601946119462194631946419465194661946719468194691947019471194721947319474194751947619477194781947919480194811948219483194841948519486194871948819489194901949119492194931949419495194961949719498194991950019501195021950319504195051950619507195081950919510195111951219513195141951519516195171951819519195201952119522195231952419525195261952719528195291953019531195321953319534195351953619537195381953919540195411954219543195441954519546195471954819549195501955119552195531955419555195561955719558195591956019561195621956319564195651956619567195681956919570195711957219573195741957519576195771957819579195801958119582195831958419585195861958719588195891959019591195921959319594195951959619597195981959919600196011960219603196041960519606196071960819609196101961119612196131961419615196161961719618196191962019621196221962319624196251962619627196281962919630196311963219633196341963519636196371963819639196401964119642196431964419645196461964719648196491965019651196521965319654196551965619657196581965919660196611966219663196641966519666196671966819669196701967119672196731967419675196761967719678196791968019681196821968319684196851968619687196881968919690196911969219693196941969519696196971969819699197001970119702197031970419705197061970719708197091971019711197121971319714197151971619717197181971919720197211972219723197241972519726197271972819729197301973119732197331973419735197361973719738197391974019741197421974319744197451974619747197481974919750197511975219753197541975519756197571975819759197601976119762197631976419765197661976719768197691977019771197721977319774197751977619777197781977919780197811978219783197841978519786197871978819789197901979119792197931979419795197961979719798197991980019801198021980319804198051980619807198081980919810198111981219813198141981519816198171981819819198201982119822198231982419825198261982719828198291983019831198321983319834198351983619837198381983919840198411984219843198441984519846198471984819849198501985119852198531985419855198561985719858198591986019861198621986319864198651986619867198681986919870198711987219873198741987519876198771987819879198801988119882198831988419885198861988719888198891989019891198921989319894198951989619897198981989919900199011990219903199041990519906199071990819909199101991119912199131991419915199161991719918199191992019921199221992319924199251992619927199281992919930199311993219933199341993519936199371993819939199401994119942199431994419945199461994719948199491995019951199521995319954199551995619957199581995919960199611996219963199641996519966199671996819969199701997119972199731997419975199761997719978199791998019981199821998319984199851998619987199881998919990199911999219993199941999519996199971999819999200002000120002200032000420005200062000720008200092001020011200122001320014200152001620017200182001920020200212002220023200242002520026200272002820029200302003120032200332003420035200362003720038200392004020041200422004320044200452004620047200482004920050200512005220053200542005520056200572005820059200602006120062200632006420065200662006720068200692007020071200722007320074200752007620077200782007920080200812008220083200842008520086200872008820089200902009120092200932009420095200962009720098200992010020101201022010320104201052010620107201082010920110201112011220113201142011520116201172011820119201202012120122201232012420125201262012720128201292013020131201322013320134201352013620137201382013920140201412014220143201442014520146201472014820149201502015120152201532015420155201562015720158201592016020161201622016320164201652016620167201682016920170201712017220173201742017520176201772017820179201802018120182201832018420185201862018720188201892019020191201922019320194201952019620197201982019920200202012020220203202042020520206202072020820209202102021120212202132021420215202162021720218202192022020221202222022320224202252022620227202282022920230202312023220233202342023520236202372023820239202402024120242202432024420245202462024720248202492025020251202522025320254202552025620257202582025920260202612026220263202642026520266202672026820269202702027120272202732027420275202762027720278202792028020281202822028320284202852028620287202882028920290202912029220293202942029520296202972029820299203002030120302203032030420305203062030720308203092031020311203122031320314203152031620317203182031920320203212032220323203242032520326203272032820329203302033120332203332033420335203362033720338203392034020341203422034320344203452034620347203482034920350203512035220353203542035520356203572035820359203602036120362203632036420365203662036720368203692037020371203722037320374203752037620377203782037920380203812038220383203842038520386203872038820389203902039120392203932039420395203962039720398203992040020401204022040320404204052040620407204082040920410204112041220413204142041520416204172041820419204202042120422204232042420425204262042720428204292043020431204322043320434204352043620437204382043920440204412044220443204442044520446204472044820449204502045120452204532045420455204562045720458204592046020461204622046320464204652046620467204682046920470204712047220473204742047520476204772047820479204802048120482204832048420485204862048720488204892049020491204922049320494204952049620497204982049920500205012050220503205042050520506205072050820509205102051120512205132051420515205162051720518205192052020521205222052320524205252052620527205282052920530205312053220533205342053520536205372053820539205402054120542205432054420545205462054720548205492055020551205522055320554205552055620557205582055920560205612056220563205642056520566205672056820569205702057120572205732057420575205762057720578205792058020581205822058320584205852058620587205882058920590205912059220593205942059520596205972059820599206002060120602206032060420605206062060720608206092061020611206122061320614206152061620617206182061920620206212062220623206242062520626206272062820629206302063120632206332063420635206362063720638206392064020641206422064320644206452064620647206482064920650206512065220653206542065520656206572065820659206602066120662206632066420665206662066720668206692067020671206722067320674206752067620677206782067920680206812068220683206842068520686206872068820689206902069120692206932069420695206962069720698206992070020701207022070320704207052070620707207082070920710207112071220713207142071520716207172071820719207202072120722207232072420725207262072720728207292073020731207322073320734207352073620737207382073920740207412074220743207442074520746207472074820749207502075120752207532075420755207562075720758207592076020761207622076320764207652076620767207682076920770207712077220773207742077520776207772077820779207802078120782207832078420785207862078720788207892079020791207922079320794207952079620797207982079920800208012080220803208042080520806208072080820809208102081120812208132081420815208162081720818208192082020821208222082320824208252082620827208282082920830208312083220833208342083520836208372083820839208402084120842208432084420845208462084720848208492085020851208522085320854208552085620857208582085920860208612086220863208642086520866208672086820869208702087120872208732087420875208762087720878208792088020881208822088320884208852088620887208882088920890208912089220893208942089520896208972089820899209002090120902209032090420905209062090720908209092091020911209122091320914209152091620917209182091920920209212092220923209242092520926209272092820929209302093120932209332093420935209362093720938209392094020941209422094320944209452094620947209482094920950209512095220953209542095520956209572095820959209602096120962209632096420965209662096720968209692097020971209722097320974209752097620977209782097920980209812098220983209842098520986209872098820989209902099120992209932099420995209962099720998209992100021001210022100321004210052100621007210082100921010210112101221013210142101521016210172101821019210202102121022210232102421025210262102721028210292103021031210322103321034210352103621037210382103921040210412104221043210442104521046210472104821049210502105121052210532105421055210562105721058210592106021061210622106321064210652106621067210682106921070210712107221073210742107521076210772107821079210802108121082210832108421085210862108721088210892109021091210922109321094210952109621097210982109921100211012110221103211042110521106211072110821109211102111121112211132111421115211162111721118211192112021121211222112321124211252112621127211282112921130211312113221133211342113521136211372113821139211402114121142211432114421145211462114721148211492115021151211522115321154211552115621157211582115921160211612116221163211642116521166211672116821169211702117121172211732117421175211762117721178211792118021181211822118321184211852118621187211882118921190211912119221193211942119521196211972119821199212002120121202212032120421205212062120721208212092121021211212122121321214212152121621217212182121921220212212122221223212242122521226212272122821229212302123121232212332123421235212362123721238212392124021241212422124321244212452124621247212482124921250212512125221253212542125521256212572125821259212602126121262212632126421265212662126721268212692127021271212722127321274212752127621277212782127921280212812128221283212842128521286212872128821289212902129121292212932129421295212962129721298212992130021301213022130321304213052130621307213082130921310213112131221313213142131521316213172131821319213202132121322213232132421325213262132721328213292133021331213322133321334213352133621337213382133921340213412134221343213442134521346213472134821349213502135121352213532135421355213562135721358213592136021361213622136321364213652136621367213682136921370213712137221373213742137521376213772137821379213802138121382213832138421385213862138721388213892139021391213922139321394213952139621397213982139921400214012140221403214042140521406214072140821409214102141121412214132141421415214162141721418214192142021421214222142321424214252142621427214282142921430214312143221433214342143521436214372143821439214402144121442214432144421445214462144721448214492145021451214522145321454214552145621457214582145921460214612146221463214642146521466214672146821469214702147121472214732147421475214762147721478214792148021481214822148321484214852148621487214882148921490214912149221493214942149521496214972149821499215002150121502215032150421505215062150721508215092151021511215122151321514215152151621517215182151921520215212152221523215242152521526215272152821529215302153121532215332153421535215362153721538215392154021541215422154321544215452154621547215482154921550215512155221553215542155521556215572155821559215602156121562215632156421565215662156721568215692157021571215722157321574215752157621577215782157921580215812158221583215842158521586215872158821589215902159121592215932159421595215962159721598215992160021601216022160321604216052160621607216082160921610216112161221613216142161521616216172161821619216202162121622216232162421625216262162721628216292163021631216322163321634216352163621637216382163921640216412164221643216442164521646216472164821649216502165121652216532165421655216562165721658216592166021661216622166321664216652166621667216682166921670216712167221673216742167521676216772167821679216802168121682216832168421685216862168721688216892169021691216922169321694216952169621697216982169921700217012170221703217042170521706217072170821709217102171121712217132171421715217162171721718217192172021721217222172321724217252172621727217282172921730217312173221733217342173521736217372173821739217402174121742217432174421745217462174721748217492175021751217522175321754217552175621757217582175921760217612176221763217642176521766217672176821769217702177121772217732177421775217762177721778217792178021781217822178321784217852178621787217882178921790217912179221793217942179521796217972179821799218002180121802218032180421805218062180721808218092181021811218122181321814218152181621817218182181921820218212182221823218242182521826218272182821829218302183121832218332183421835218362183721838218392184021841218422184321844218452184621847218482184921850218512185221853218542185521856218572185821859218602186121862218632186421865218662186721868218692187021871218722187321874218752187621877218782187921880218812188221883218842188521886218872188821889218902189121892218932189421895218962189721898218992190021901219022190321904219052190621907219082190921910219112191221913219142191521916219172191821919219202192121922219232192421925219262192721928219292193021931219322193321934219352193621937219382193921940219412194221943219442194521946219472194821949219502195121952219532195421955219562195721958219592196021961219622196321964219652196621967219682196921970219712197221973219742197521976219772197821979219802198121982219832198421985219862198721988219892199021991219922199321994219952199621997219982199922000220012200222003220042200522006220072200822009220102201122012220132201422015220162201722018220192202022021220222202322024220252202622027220282202922030220312203222033220342203522036220372203822039220402204122042220432204422045220462204722048220492205022051220522205322054220552205622057220582205922060220612206222063220642206522066220672206822069220702207122072220732207422075220762207722078220792208022081220822208322084220852208622087220882208922090220912209222093220942209522096220972209822099221002210122102221032210422105221062210722108221092211022111221122211322114221152211622117221182211922120221212212222123221242212522126221272212822129221302213122132221332213422135221362213722138221392214022141221422214322144221452214622147221482214922150221512215222153221542215522156221572215822159221602216122162221632216422165221662216722168221692217022171221722217322174221752217622177221782217922180221812218222183221842218522186221872218822189221902219122192221932219422195221962219722198221992220022201222022220322204222052220622207222082220922210222112221222213222142221522216222172221822219222202222122222222232222422225222262222722228222292223022231222322223322234222352223622237222382223922240222412224222243222442224522246222472224822249222502225122252222532225422255222562225722258222592226022261222622226322264222652226622267222682226922270222712227222273222742227522276222772227822279222802228122282222832228422285222862228722288222892229022291222922229322294222952229622297222982229922300223012230222303223042230522306223072230822309223102231122312223132231422315223162231722318223192232022321223222232322324223252232622327223282232922330223312233222333223342233522336223372233822339223402234122342223432234422345223462234722348223492235022351223522235322354223552235622357223582235922360223612236222363223642236522366223672236822369223702237122372223732237422375223762237722378223792238022381223822238322384223852238622387223882238922390223912239222393223942239522396223972239822399224002240122402224032240422405224062240722408224092241022411224122241322414224152241622417224182241922420224212242222423224242242522426224272242822429224302243122432224332243422435224362243722438224392244022441224422244322444224452244622447224482244922450224512245222453224542245522456224572245822459224602246122462224632246422465224662246722468224692247022471224722247322474224752247622477224782247922480224812248222483224842248522486224872248822489224902249122492224932249422495224962249722498224992250022501225022250322504225052250622507225082250922510225112251222513225142251522516225172251822519225202252122522225232252422525225262252722528225292253022531225322253322534225352253622537225382253922540225412254222543225442254522546225472254822549225502255122552225532255422555225562255722558225592256022561225622256322564225652256622567225682256922570225712257222573225742257522576225772257822579225802258122582225832258422585225862258722588225892259022591225922259322594225952259622597225982259922600226012260222603226042260522606226072260822609226102261122612226132261422615226162261722618226192262022621226222262322624226252262622627226282262922630226312263222633226342263522636226372263822639226402264122642226432264422645226462264722648226492265022651226522265322654226552265622657226582265922660226612266222663226642266522666226672266822669226702267122672226732267422675226762267722678226792268022681226822268322684226852268622687226882268922690226912269222693226942269522696226972269822699227002270122702227032270422705227062270722708227092271022711227122271322714227152271622717227182271922720227212272222723227242272522726227272272822729227302273122732227332273422735227362273722738227392274022741227422274322744227452274622747227482274922750227512275222753227542275522756227572275822759227602276122762227632276422765227662276722768227692277022771227722277322774227752277622777227782277922780227812278222783227842278522786227872278822789227902279122792227932279422795227962279722798227992280022801228022280322804228052280622807228082280922810228112281222813228142281522816228172281822819228202282122822228232282422825228262282722828228292283022831228322283322834228352283622837228382283922840228412284222843228442284522846228472284822849228502285122852228532285422855228562285722858228592286022861228622286322864228652286622867228682286922870228712287222873228742287522876228772287822879228802288122882228832288422885228862288722888228892289022891228922289322894228952289622897228982289922900229012290222903229042290522906229072290822909229102291122912229132291422915229162291722918229192292022921229222292322924229252292622927229282292922930229312293222933229342293522936229372293822939229402294122942229432294422945229462294722948229492295022951229522295322954229552295622957229582295922960229612296222963229642296522966229672296822969229702297122972229732297422975229762297722978229792298022981229822298322984229852298622987229882298922990229912299222993229942299522996229972299822999230002300123002230032300423005230062300723008230092301023011230122301323014230152301623017230182301923020230212302223023230242302523026230272302823029230302303123032230332303423035230362303723038230392304023041230422304323044230452304623047230482304923050230512305223053230542305523056230572305823059230602306123062230632306423065230662306723068230692307023071230722307323074230752307623077230782307923080230812308223083230842308523086230872308823089230902309123092230932309423095230962309723098230992310023101231022310323104231052310623107231082310923110231112311223113231142311523116231172311823119231202312123122231232312423125231262312723128231292313023131231322313323134231352313623137231382313923140231412314223143231442314523146231472314823149231502315123152231532315423155231562315723158231592316023161231622316323164231652316623167231682316923170231712317223173231742317523176231772317823179231802318123182231832318423185231862318723188231892319023191231922319323194231952319623197231982319923200232012320223203232042320523206232072320823209232102321123212232132321423215232162321723218232192322023221232222322323224232252322623227232282322923230232312323223233232342323523236232372323823239232402324123242232432324423245232462324723248232492325023251232522325323254232552325623257232582325923260232612326223263232642326523266232672326823269232702327123272232732327423275232762327723278232792328023281232822328323284232852328623287232882328923290232912329223293232942329523296232972329823299233002330123302233032330423305233062330723308233092331023311233122331323314233152331623317233182331923320233212332223323233242332523326233272332823329233302333123332233332333423335233362333723338233392334023341233422334323344233452334623347233482334923350233512335223353233542335523356233572335823359233602336123362233632336423365233662336723368233692337023371233722337323374233752337623377233782337923380233812338223383233842338523386233872338823389233902339123392233932339423395233962339723398233992340023401234022340323404234052340623407234082340923410234112341223413234142341523416234172341823419234202342123422234232342423425234262342723428234292343023431234322343323434234352343623437234382343923440234412344223443234442344523446234472344823449234502345123452234532345423455234562345723458234592346023461234622346323464234652346623467234682346923470234712347223473234742347523476234772347823479234802348123482234832348423485234862348723488234892349023491234922349323494234952349623497234982349923500235012350223503235042350523506235072350823509235102351123512235132351423515235162351723518235192352023521235222352323524235252352623527235282352923530235312353223533235342353523536235372353823539235402354123542235432354423545235462354723548235492355023551235522355323554235552355623557235582355923560235612356223563235642356523566235672356823569235702357123572235732357423575235762357723578235792358023581235822358323584235852358623587235882358923590235912359223593235942359523596235972359823599236002360123602236032360423605236062360723608236092361023611236122361323614236152361623617236182361923620236212362223623236242362523626236272362823629236302363123632236332363423635236362363723638236392364023641236422364323644236452364623647236482364923650236512365223653236542365523656236572365823659236602366123662236632366423665236662366723668236692367023671236722367323674236752367623677236782367923680236812368223683236842368523686236872368823689236902369123692236932369423695236962369723698236992370023701237022370323704237052370623707237082370923710237112371223713237142371523716237172371823719237202372123722237232372423725237262372723728237292373023731237322373323734237352373623737237382373923740237412374223743237442374523746237472374823749237502375123752237532375423755237562375723758237592376023761237622376323764237652376623767237682376923770237712377223773237742377523776237772377823779237802378123782237832378423785237862378723788237892379023791237922379323794237952379623797237982379923800238012380223803238042380523806238072380823809238102381123812238132381423815238162381723818238192382023821238222382323824238252382623827238282382923830238312383223833238342383523836238372383823839238402384123842238432384423845238462384723848238492385023851238522385323854238552385623857238582385923860238612386223863238642386523866238672386823869238702387123872238732387423875238762387723878238792388023881238822388323884238852388623887238882388923890238912389223893238942389523896238972389823899239002390123902239032390423905239062390723908239092391023911239122391323914239152391623917239182391923920239212392223923239242392523926239272392823929239302393123932239332393423935239362393723938239392394023941239422394323944239452394623947239482394923950239512395223953239542395523956239572395823959239602396123962239632396423965239662396723968239692397023971239722397323974239752397623977239782397923980239812398223983239842398523986239872398823989239902399123992239932399423995239962399723998239992400024001240022400324004240052400624007240082400924010240112401224013240142401524016240172401824019240202402124022240232402424025240262402724028240292403024031240322403324034240352403624037240382403924040240412404224043240442404524046240472404824049240502405124052240532405424055240562405724058240592406024061240622406324064240652406624067240682406924070240712407224073240742407524076240772407824079240802408124082240832408424085240862408724088240892409024091240922409324094240952409624097240982409924100241012410224103241042410524106241072410824109241102411124112241132411424115241162411724118241192412024121241222412324124241252412624127241282412924130241312413224133241342413524136241372413824139241402414124142241432414424145241462414724148241492415024151241522415324154241552415624157241582415924160241612416224163241642416524166241672416824169241702417124172241732417424175241762417724178241792418024181241822418324184241852418624187241882418924190241912419224193241942419524196241972419824199242002420124202242032420424205242062420724208242092421024211242122421324214242152421624217242182421924220242212422224223242242422524226242272422824229242302423124232242332423424235242362423724238242392424024241242422424324244242452424624247242482424924250242512425224253242542425524256242572425824259242602426124262242632426424265242662426724268242692427024271242722427324274242752427624277242782427924280242812428224283242842428524286242872428824289242902429124292242932429424295242962429724298242992430024301
  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.63.0"
  10. #define CPPHTTPLIB_VERSION_NUM "0x003f00"
  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_INTERIM_RESPONSE_MAX_COUNT
  104. #define CPPHTTPLIB_INTERIM_RESPONSE_MAX_COUNT 100
  105. #endif
  106. #ifndef CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT
  107. #define CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT 1024
  108. #endif
  109. #ifndef CPPHTTPLIB_PAYLOAD_MAX_LENGTH
  110. #define CPPHTTPLIB_PAYLOAD_MAX_LENGTH (100 * 1024 * 1024) // 100MB
  111. #endif
  112. // How much of an unread request body the server skips to reuse the connection,
  113. // 0 for no limit
  114. #ifndef CPPHTTPLIB_UNREAD_PAYLOAD_MAX_LENGTH
  115. #define CPPHTTPLIB_UNREAD_PAYLOAD_MAX_LENGTH (256 * 1024) // 256KB
  116. #endif
  117. #ifndef CPPHTTPLIB_SSE_MAX_EVENT_LENGTH
  118. #define CPPHTTPLIB_SSE_MAX_EVENT_LENGTH (16 * 1024 * 1024) // 16MB
  119. #endif
  120. #ifndef CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH
  121. #define CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH 8192
  122. #endif
  123. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH
  124. // 1400 rather than a round number: a body that already fits in one 1500-byte
  125. // MTU gains nothing from being made smaller.
  126. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH 1400
  127. #endif
  128. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH
  129. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH (4 * 1024 * 1024) // 4MB
  130. #endif
  131. #ifndef CPPHTTPLIB_RANGE_MAX_COUNT
  132. #define CPPHTTPLIB_RANGE_MAX_COUNT 1024
  133. #endif
  134. // std::regex_match's backtracking implementation (most acutely on libstdc++)
  135. // recurses roughly once per matched character for quantified patterns such
  136. // as "(.*)", so a long enough path can exhaust the calling thread's stack; on
  137. // a default ~8MB thread stack that has been observed to take on the order of
  138. // a couple thousand characters for a simple pattern. 256 leaves a wide safety
  139. // margin below that (well under the 8192-byte request URI limit) while still
  140. // fitting any realistic route segment; raise it if a route legitimately needs
  141. // longer paths. Regex routes are never applied to paths longer than this.
  142. #ifndef CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH
  143. #define CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH 256
  144. #endif
  145. #ifndef CPPHTTPLIB_TCP_NODELAY
  146. #define CPPHTTPLIB_TCP_NODELAY false
  147. #endif
  148. #ifndef CPPHTTPLIB_IPV6_V6ONLY
  149. #define CPPHTTPLIB_IPV6_V6ONLY false
  150. #endif
  151. #ifndef CPPHTTPLIB_RECV_BUFSIZ
  152. #define CPPHTTPLIB_RECV_BUFSIZ size_t(16384u)
  153. #endif
  154. #ifndef CPPHTTPLIB_SEND_BUFSIZ
  155. #define CPPHTTPLIB_SEND_BUFSIZ size_t(16384u)
  156. #endif
  157. #ifndef CPPHTTPLIB_COMPRESSION_BUFSIZ
  158. #define CPPHTTPLIB_COMPRESSION_BUFSIZ size_t(16384u)
  159. #endif
  160. #ifndef CPPHTTPLIB_THREAD_POOL_COUNT
  161. #define CPPHTTPLIB_THREAD_POOL_COUNT \
  162. ((std::max)(8u, std::thread::hardware_concurrency() > 0 \
  163. ? std::thread::hardware_concurrency() - 1 \
  164. : 0))
  165. #endif
  166. #ifndef CPPHTTPLIB_THREAD_POOL_MAX_COUNT
  167. #define CPPHTTPLIB_THREAD_POOL_MAX_COUNT (CPPHTTPLIB_THREAD_POOL_COUNT * 4)
  168. #endif
  169. #ifndef CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT
  170. #define CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT 3 // seconds
  171. #endif
  172. #ifndef CPPHTTPLIB_RECV_FLAGS
  173. #define CPPHTTPLIB_RECV_FLAGS 0
  174. #endif
  175. #ifndef CPPHTTPLIB_SEND_FLAGS
  176. #define CPPHTTPLIB_SEND_FLAGS 0
  177. #endif
  178. #ifndef CPPHTTPLIB_LISTEN_BACKLOG
  179. #define CPPHTTPLIB_LISTEN_BACKLOG 128
  180. #endif
  181. #ifndef CPPHTTPLIB_MAX_LINE_LENGTH
  182. #define CPPHTTPLIB_MAX_LINE_LENGTH 32768
  183. #endif
  184. // These bound the parsing of every request, so 0 cannot lift them.
  185. static_assert(CPPHTTPLIB_REQUEST_URI_MAX_LENGTH > 0,
  186. "CPPHTTPLIB_REQUEST_URI_MAX_LENGTH must be positive");
  187. static_assert(CPPHTTPLIB_HEADER_MAX_LENGTH > 0,
  188. "CPPHTTPLIB_HEADER_MAX_LENGTH must be positive");
  189. static_assert(CPPHTTPLIB_HEADER_MAX_COUNT > 0,
  190. "CPPHTTPLIB_HEADER_MAX_COUNT must be positive");
  191. static_assert(CPPHTTPLIB_MAX_LINE_LENGTH > 0,
  192. "CPPHTTPLIB_MAX_LINE_LENGTH must be positive");
  193. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH
  194. #define CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH 16777216
  195. #endif
  196. // One macro used to set the read timeout for both sides. They want different
  197. // defaults: a client's read timeout is the caller's own tool (it waits forever
  198. // until asked not to), while a server keeps a ceiling that reclaims a worker
  199. // from a peer that has gone quiet. The old name still works and sets both.
  200. #ifdef CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  201. #pragma message( \
  202. "CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND is deprecated; define " \
  203. "CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND and/or " \
  204. "CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND instead")
  205. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  206. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND \
  207. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  208. #endif
  209. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  210. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND \
  211. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  212. #endif
  213. #endif
  214. // 0 waits forever. A read timeout is how a caller gets control back to send on
  215. // the same connection; it is not a liveness check (that is ping/pong). Only a
  216. // timeout set at runtime through set_read_timeout() is reported as
  217. // ws::Timeout; when one of these compile-time defaults elapses, read() returns
  218. // ws::Fail and closes the connection.
  219. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  220. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND 0
  221. #endif
  222. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  223. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND 300
  224. #endif
  225. #ifndef CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND
  226. #define CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND 5
  227. #endif
  228. #ifndef CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND
  229. #define CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND 30
  230. #endif
  231. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS
  232. #define CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS 0
  233. #endif
  234. /*
  235. * Headers
  236. */
  237. #ifdef _WIN32
  238. #ifndef _CRT_SECURE_NO_WARNINGS
  239. #define _CRT_SECURE_NO_WARNINGS
  240. #endif //_CRT_SECURE_NO_WARNINGS
  241. #ifndef _CRT_NONSTDC_NO_DEPRECATE
  242. #define _CRT_NONSTDC_NO_DEPRECATE
  243. #endif //_CRT_NONSTDC_NO_DEPRECATE
  244. #if defined(_MSC_VER)
  245. #if _MSC_VER < 1900
  246. #error Sorry, Visual Studio versions prior to 2015 are not supported
  247. #endif
  248. #pragma comment(lib, "ws2_32.lib")
  249. #ifndef _SSIZE_T_DEFINED
  250. using ssize_t = __int64;
  251. #define _SSIZE_T_DEFINED
  252. #endif
  253. #endif // _MSC_VER
  254. #ifndef S_ISREG
  255. #define S_ISREG(m) (((m) & S_IFREG) == S_IFREG)
  256. #endif // S_ISREG
  257. #ifndef S_ISDIR
  258. #define S_ISDIR(m) (((m) & S_IFDIR) == S_IFDIR)
  259. #endif // S_ISDIR
  260. #ifndef NOMINMAX
  261. #define NOMINMAX
  262. #endif // NOMINMAX
  263. #include <io.h>
  264. #include <winsock2.h>
  265. #include <ws2tcpip.h>
  266. #if defined(__has_include)
  267. #if __has_include(<afunix.h>)
  268. // afunix.h uses types declared in winsock2.h, so has to be included after it.
  269. #include <afunix.h>
  270. #define CPPHTTPLIB_HAVE_AFUNIX_H 1
  271. #endif
  272. #endif
  273. #ifndef WSA_FLAG_NO_HANDLE_INHERIT
  274. #define WSA_FLAG_NO_HANDLE_INHERIT 0x80
  275. #endif
  276. using nfds_t = unsigned long;
  277. using socket_t = SOCKET;
  278. using socklen_t = int;
  279. #else // not _WIN32
  280. #include <arpa/inet.h>
  281. #if !defined(_AIX) && !defined(__MVS__)
  282. #include <ifaddrs.h>
  283. #endif
  284. #ifdef __MVS__
  285. #include <strings.h>
  286. #ifndef NI_MAXHOST
  287. #define NI_MAXHOST 1025
  288. #endif
  289. #endif
  290. #include <net/if.h>
  291. #include <netdb.h>
  292. #include <netinet/in.h>
  293. #ifdef __linux__
  294. #include <resolv.h>
  295. #undef _res // Undefine _res macro to avoid conflicts with user code (#2278)
  296. #endif
  297. #include <csignal>
  298. #include <netinet/tcp.h>
  299. #include <poll.h>
  300. #include <pthread.h>
  301. #include <sys/socket.h>
  302. #include <sys/un.h>
  303. #include <unistd.h>
  304. using socket_t = int;
  305. #ifndef INVALID_SOCKET
  306. #define INVALID_SOCKET (-1)
  307. #endif
  308. #endif //_WIN32
  309. #if defined(__APPLE__)
  310. #include <TargetConditionals.h>
  311. #endif
  312. #include <algorithm>
  313. #include <array>
  314. #include <atomic>
  315. #include <cassert>
  316. #include <chrono>
  317. #include <climits>
  318. #include <condition_variable>
  319. #include <cstdlib>
  320. #include <cstring>
  321. #include <errno.h>
  322. #include <exception>
  323. #include <fcntl.h>
  324. #include <fstream>
  325. #include <functional>
  326. #include <iomanip>
  327. #include <iostream>
  328. #include <iterator>
  329. #include <list>
  330. #include <map>
  331. #include <memory>
  332. #include <mutex>
  333. #include <random>
  334. #include <regex>
  335. #include <set>
  336. #include <sstream>
  337. #include <string>
  338. #include <sys/stat.h>
  339. #include <system_error>
  340. #include <thread>
  341. #include <type_traits>
  342. #include <unordered_map>
  343. #include <unordered_set>
  344. #include <utility>
  345. #include <vector>
  346. // On macOS with a TLS backend, enable Keychain root certificates by default
  347. // unless the user explicitly opts out. Not enabled on iOS/tvOS/watchOS since
  348. // the SecTrustSettings APIs used to enumerate anchor certificates are macOS
  349. // only; on those platforms the user must provide a CA bundle explicitly.
  350. #if defined(__APPLE__) && defined(__clang__) && \
  351. !defined(CPPHTTPLIB_DISABLE_MACOSX_AUTOMATIC_ROOT_CERTIFICATES) && \
  352. (defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  353. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || \
  354. defined(CPPHTTPLIB_WOLFSSL_SUPPORT))
  355. #if TARGET_OS_OSX
  356. #ifndef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  357. #define CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  358. #endif
  359. #endif
  360. #endif
  361. #if defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN) && \
  362. defined(__APPLE__) && !TARGET_OS_OSX
  363. #error \
  364. "CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN is only supported on macOS. On iOS/tvOS/watchOS, supply a CA bundle via set_ca_cert_path()."
  365. #endif
  366. // On Windows, enable Schannel certificate verification by default
  367. // unless the user explicitly opts out.
  368. #if defined(_WIN32) && \
  369. !defined(CPPHTTPLIB_DISABLE_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE)
  370. #define CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  371. #endif
  372. #if defined(CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO) || \
  373. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  374. #if TARGET_OS_MAC && defined(__clang__)
  375. #include <CFNetwork/CFHost.h>
  376. #include <CoreFoundation/CoreFoundation.h>
  377. #endif
  378. #endif
  379. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  380. #ifdef _WIN32
  381. #include <wincrypt.h>
  382. // these are defined in wincrypt.h and it breaks compilation if BoringSSL is
  383. // used
  384. #undef X509_NAME
  385. #undef X509_CERT_PAIR
  386. #undef X509_EXTENSIONS
  387. #undef PKCS7_SIGNER_INFO
  388. #ifdef _MSC_VER
  389. #pragma comment(lib, "crypt32.lib")
  390. #endif
  391. #endif // _WIN32
  392. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  393. #if TARGET_OS_OSX
  394. #include <Security/Security.h>
  395. #endif
  396. #endif
  397. #include <openssl/err.h>
  398. #include <openssl/evp.h>
  399. #include <openssl/rand.h>
  400. #include <openssl/ssl.h>
  401. #include <openssl/x509v3.h>
  402. #if defined(_WIN32) && defined(OPENSSL_USE_APPLINK)
  403. #include <openssl/applink.c>
  404. #endif
  405. #include <iostream>
  406. #include <sstream>
  407. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  408. #if OPENSSL_VERSION_NUMBER < 0x1010107f
  409. #error Please use OpenSSL or a current version of BoringSSL
  410. #endif
  411. #define SSL_get1_peer_certificate SSL_get_peer_certificate
  412. #elif OPENSSL_VERSION_NUMBER < 0x30000000L
  413. #error Sorry, OpenSSL versions prior to 3.0.0 are not supported
  414. #endif
  415. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  416. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  417. // version.h defines MBEDTLS_VERSION_MAJOR (on 2.x/3.x/4.x alike); it is pulled
  418. // in with this first include group so the version gating below can use it.
  419. #include <mbedtls/error.h>
  420. #include <mbedtls/net_sockets.h>
  421. #include <mbedtls/oid.h>
  422. #include <mbedtls/pk.h>
  423. #include <mbedtls/ssl.h>
  424. #include <mbedtls/version.h>
  425. #include <mbedtls/x509_crt.h>
  426. #if MBEDTLS_VERSION_MAJOR >= 4
  427. // Mbed TLS 4.x moved hashing/RNG to PSA Crypto and removed these headers.
  428. #include <psa/crypto.h>
  429. #else
  430. #include <mbedtls/ctr_drbg.h>
  431. #include <mbedtls/entropy.h>
  432. #include <mbedtls/md5.h>
  433. #include <mbedtls/sha1.h>
  434. #include <mbedtls/sha256.h>
  435. #include <mbedtls/sha512.h>
  436. #endif
  437. #ifdef _WIN32
  438. #include <wincrypt.h>
  439. #ifdef _MSC_VER
  440. #pragma comment(lib, "crypt32.lib")
  441. #endif
  442. #endif // _WIN32
  443. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  444. #if TARGET_OS_OSX
  445. #include <Security/Security.h>
  446. #endif
  447. #endif
  448. // Mbed TLS version API compatibility. Note: V4 implies V3 (both defined on
  449. // 4.x), so version-specific 3.x-only code must check V3 && !V4.
  450. #if MBEDTLS_VERSION_MAJOR >= 4
  451. #define CPPHTTPLIB_MBEDTLS_V4
  452. #endif
  453. #if MBEDTLS_VERSION_MAJOR >= 3
  454. #define CPPHTTPLIB_MBEDTLS_V3
  455. #endif
  456. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  457. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  458. #include <wolfssl/options.h>
  459. #include <wolfssl/openssl/x509v3.h>
  460. // Fallback definitions for older wolfSSL versions (e.g., 5.6.6)
  461. #ifndef WOLFSSL_GEN_EMAIL
  462. #define WOLFSSL_GEN_EMAIL 1
  463. #endif
  464. #ifndef WOLFSSL_GEN_DNS
  465. #define WOLFSSL_GEN_DNS 2
  466. #endif
  467. #ifndef WOLFSSL_GEN_URI
  468. #define WOLFSSL_GEN_URI 6
  469. #endif
  470. #ifndef WOLFSSL_GEN_IPADD
  471. #define WOLFSSL_GEN_IPADD 7
  472. #endif
  473. #include <wolfssl/ssl.h>
  474. #include <wolfssl/wolfcrypt/hash.h>
  475. #include <wolfssl/wolfcrypt/md5.h>
  476. #include <wolfssl/wolfcrypt/sha256.h>
  477. #include <wolfssl/wolfcrypt/sha512.h>
  478. #ifdef _WIN32
  479. #include <wincrypt.h>
  480. #ifdef _MSC_VER
  481. #pragma comment(lib, "crypt32.lib")
  482. #endif
  483. #endif // _WIN32
  484. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  485. #if TARGET_OS_OSX
  486. #include <Security/Security.h>
  487. #endif
  488. #endif
  489. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  490. // Define CPPHTTPLIB_SSL_ENABLED if any SSL backend is available
  491. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  492. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  493. #define CPPHTTPLIB_SSL_ENABLED
  494. #endif
  495. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  496. #include <zlib.h>
  497. #endif
  498. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  499. #include <brotli/decode.h>
  500. #include <brotli/encode.h>
  501. #endif
  502. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  503. #include <zstd.h>
  504. #endif
  505. /*
  506. * Declaration
  507. */
  508. namespace httplib {
  509. namespace ws {
  510. class WebSocket;
  511. } // namespace ws
  512. namespace sse {
  513. class SSEClient;
  514. } // namespace sse
  515. namespace detail {
  516. /*
  517. * Backport std::make_unique from C++14.
  518. *
  519. * NOTE: This code came up with the following stackoverflow post:
  520. * https://stackoverflow.com/questions/10149840/c-arrays-and-make-unique
  521. *
  522. */
  523. template <class T, class... Args>
  524. typename std::enable_if<!std::is_array<T>::value, std::unique_ptr<T>>::type
  525. make_unique(Args &&...args) {
  526. return std::unique_ptr<T>(new T(std::forward<Args>(args)...));
  527. }
  528. template <class T>
  529. typename std::enable_if<std::is_array<T>::value, std::unique_ptr<T>>::type
  530. make_unique(std::size_t n) {
  531. typedef typename std::remove_extent<T>::type RT;
  532. return std::unique_ptr<T>(new RT[n]);
  533. }
  534. // Locale-independent ASCII character classification. The <cctype>
  535. // counterparts (std::isalnum, std::isdigit, ...) consult the global C locale,
  536. // so e.g. std::isalnum(0xC5) can return true once an embedder calls
  537. // setlocale(). HTTP grammars are defined over ASCII, so raw bytes must be
  538. // classified without regard to the locale.
  539. inline bool is_ascii_digit(char c) { return '0' <= c && c <= '9'; }
  540. inline bool is_ascii_alpha(char c) {
  541. return ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z');
  542. }
  543. inline bool is_ascii_alnum(char c) {
  544. return is_ascii_digit(c) || is_ascii_alpha(c);
  545. }
  546. namespace case_ignore {
  547. inline unsigned char to_lower(int c) {
  548. const static unsigned char table[256] = {
  549. 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14,
  550. 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29,
  551. 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44,
  552. 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59,
  553. 60, 61, 62, 63, 64, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106,
  554. 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121,
  555. 122, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104,
  556. 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119,
  557. 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134,
  558. 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149,
  559. 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164,
  560. 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179,
  561. 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 224, 225, 226,
  562. 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239, 240, 241,
  563. 242, 243, 244, 245, 246, 215, 248, 249, 250, 251, 252, 253, 254, 223, 224,
  564. 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239,
  565. 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254,
  566. 255,
  567. };
  568. return table[(unsigned char)(char)c];
  569. }
  570. inline std::string to_lower(const std::string &s) {
  571. std::string result = s;
  572. std::transform(
  573. result.begin(), result.end(), result.begin(),
  574. [](unsigned char c) { return static_cast<char>(to_lower(c)); });
  575. return result;
  576. }
  577. inline bool equal(const std::string &a, const std::string &b) {
  578. return a.size() == b.size() &&
  579. std::equal(a.begin(), a.end(), b.begin(), [](char ca, char cb) {
  580. return to_lower(ca) == to_lower(cb);
  581. });
  582. }
  583. // For a literal, without building a std::string from it.
  584. template <size_t N>
  585. inline bool equal(const std::string &a, const char (&b)[N]) {
  586. return a.size() == N - 1 &&
  587. std::equal(a.begin(), a.end(), b, [](char ca, char cb) {
  588. return to_lower(ca) == to_lower(cb);
  589. });
  590. }
  591. struct equal_to {
  592. bool operator()(const std::string &a, const std::string &b) const {
  593. return equal(a, b);
  594. }
  595. };
  596. struct hash {
  597. size_t operator()(const std::string &key) const {
  598. size_t h = 0;
  599. for (auto c : key) {
  600. // Unsets the 6 high bits of h, therefore no overflow happens
  601. h = (((std::numeric_limits<size_t>::max)() >> 6) & h * 33) ^
  602. static_cast<unsigned char>(to_lower(c));
  603. }
  604. return h;
  605. }
  606. };
  607. template <typename T>
  608. using unordered_set = std::unordered_set<T, detail::case_ignore::hash,
  609. detail::case_ignore::equal_to>;
  610. } // namespace case_ignore
  611. // This is based on
  612. // "http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2014/n4189".
  613. struct scope_exit {
  614. explicit scope_exit(std::function<void(void)> &&f)
  615. : exit_function(std::move(f)), execute_on_destruction{true} {}
  616. scope_exit(scope_exit &&rhs) noexcept
  617. : exit_function(std::move(rhs.exit_function)),
  618. execute_on_destruction{rhs.execute_on_destruction} {
  619. rhs.release();
  620. }
  621. ~scope_exit() {
  622. if (execute_on_destruction) { this->exit_function(); }
  623. }
  624. void release() { this->execute_on_destruction = false; }
  625. private:
  626. scope_exit(const scope_exit &) = delete;
  627. void operator=(const scope_exit &) = delete;
  628. scope_exit &operator=(scope_exit &&) = delete;
  629. std::function<void(void)> exit_function;
  630. bool execute_on_destruction;
  631. };
  632. // Simple from_chars implementation for integer and double types (C++17
  633. // substitute)
  634. template <typename T> struct from_chars_result {
  635. const char *ptr;
  636. std::errc ec;
  637. };
  638. template <typename T>
  639. inline from_chars_result<T> from_chars(const char *first, const char *last,
  640. T &value, int base = 10) {
  641. value = 0;
  642. const char *p = first;
  643. bool negative = false;
  644. if (p != last && *p == '-') {
  645. negative = true;
  646. ++p;
  647. }
  648. if (p == last) { return {first, std::errc::invalid_argument}; }
  649. auto radix = static_cast<T>(base);
  650. T result = 0;
  651. for (; p != last; ++p) {
  652. char c = *p;
  653. int digit = -1;
  654. if (is_ascii_digit(c)) {
  655. digit = c - '0';
  656. } else if ('a' <= c && c <= 'z') {
  657. digit = c - 'a' + 10;
  658. } else if ('A' <= c && c <= 'Z') {
  659. digit = c - 'A' + 10;
  660. } else {
  661. break;
  662. }
  663. if (digit < 0 || digit >= base) { break; }
  664. auto d = static_cast<T>(digit);
  665. if (result > ((std::numeric_limits<T>::max)() - d) / radix) {
  666. return {p, std::errc::result_out_of_range};
  667. }
  668. result = result * radix + d;
  669. }
  670. if (p == first || (negative && p == first + 1)) {
  671. return {first, std::errc::invalid_argument};
  672. }
  673. value = negative ? T(0) - result : result;
  674. return {p, std::errc{}};
  675. }
  676. // from_chars for double (hand-written, locale-independent)
  677. //
  678. // The only double consumed by this library is the HTTP quality value, whose
  679. // grammar is (RFC 9110 12.4.2):
  680. // qvalue = ( "0" [ "." 0*3DIGIT ] ) / ( "1" [ "." 0*3("0") ] )
  681. // i.e. a non-negative decimal with no sign, exponent, "inf"/"nan", or wide
  682. // magnitude. So this parser recognizes exactly 1*DIGIT [ "." *DIGIT ] with
  683. // '.' always the decimal separator (std::strtod would instead read it from the
  684. // global C locale, mis-parsing q-values once an embedder calls
  685. // setlocale(LC_ALL, "") into a comma-decimal locale). The caller range-checks
  686. // the result to [0, 1], so inputs outside that range need not be distinguished
  687. // here. Allocation-free, single pass, and free of the overflow/rounding edge
  688. // cases that exponent and wide-range handling would introduce.
  689. inline from_chars_result<double> from_chars(const char *first, const char *last,
  690. double &value) {
  691. value = 0.0;
  692. const char *p = first;
  693. // Each 1eN is exactly representable, so a single final division by the
  694. // matching entry yields a correctly-rounded result.
  695. static const double powers_of_ten[] = {
  696. 1e0, 1e1, 1e2, 1e3, 1e4, 1e5, 1e6, 1e7, 1e8, 1e9,
  697. 1e10, 1e11, 1e12, 1e13, 1e14, 1e15, 1e16, 1e17, 1e18};
  698. const int max_frac_digits =
  699. static_cast<int>(sizeof(powers_of_ten) / sizeof(powers_of_ten[0])) - 1;
  700. // Accumulate digits into a 64-bit integer and remember how many were
  701. // fractional. Two independent caps keep this bounded and safe:
  702. // * accumulation saturates before mantissa could overflow uint64_t, and
  703. // * frac_digits is capped at max_frac_digits so it is always a valid index
  704. // into powers_of_ten (without this an input like "0.000...0" would never
  705. // grow mantissa, so the saturation cap alone would not bound it).
  706. // Both caps only drop digits far beyond the precision a q-value needs; any
  707. // value they would change is well outside [0, 1] and rejected by the caller.
  708. uint64_t mantissa = 0;
  709. int frac_digits = 0;
  710. bool seen_digit = false;
  711. const uint64_t limit = ((std::numeric_limits<uint64_t>::max)() - 9) / 10;
  712. auto accumulate = [&](char c) {
  713. if (mantissa <= limit) {
  714. mantissa = mantissa * 10 + static_cast<uint64_t>(c - '0');
  715. return true;
  716. }
  717. return false;
  718. };
  719. for (; p != last && is_ascii_digit(*p); ++p) {
  720. seen_digit = true;
  721. accumulate(*p);
  722. }
  723. if (p != last && *p == '.') {
  724. ++p;
  725. for (; p != last && is_ascii_digit(*p); ++p) {
  726. seen_digit = true;
  727. if (frac_digits < max_frac_digits && accumulate(*p)) { ++frac_digits; }
  728. }
  729. }
  730. if (!seen_digit) { return {first, std::errc::invalid_argument}; }
  731. value = static_cast<double>(mantissa) / powers_of_ten[frac_digits];
  732. return {p, std::errc{}};
  733. }
  734. inline bool parse_int_in_range(const char *s, size_t len, int lo, int hi,
  735. int &out) {
  736. int val = 0;
  737. auto r = from_chars(s, s + len, val);
  738. if (r.ec != std::errc{} || r.ptr != s + len || val < lo || val > hi) {
  739. return false;
  740. }
  741. out = val;
  742. return true;
  743. }
  744. inline bool parse_port(const char *s, size_t len, int &port) {
  745. return parse_int_in_range(s, len, 1, 65535, port);
  746. }
  747. inline bool parse_port(const std::string &s, int &port) {
  748. return parse_port(s.data(), s.size(), port);
  749. }
  750. struct UrlComponents {
  751. std::string scheme;
  752. std::string host;
  753. std::string port;
  754. std::string path;
  755. std::string query;
  756. };
  757. inline bool parse_url(const std::string &url, UrlComponents &uc) {
  758. uc = {};
  759. size_t pos = 0;
  760. auto sep = url.find("://");
  761. if (sep != std::string::npos) {
  762. uc.scheme = url.substr(0, sep);
  763. // Scheme must be [a-z]+ only
  764. if (uc.scheme.empty()) { return false; }
  765. for (auto c : uc.scheme) {
  766. if (c < 'a' || c > 'z') { return false; }
  767. }
  768. pos = sep + 3;
  769. } else if (url.compare(0, 2, "//") == 0) {
  770. pos = 2;
  771. }
  772. auto has_authority_prefix = pos > 0;
  773. auto has_authority = has_authority_prefix || (!url.empty() && url[0] != '/' &&
  774. url[0] != '?' && url[0] != '#');
  775. if (has_authority) {
  776. // userinfo is not supported, and a backslash that some parsers take for
  777. // '/' would leave them seeing another host than this one.
  778. if (url.find_first_of("@\\", pos) < url.find_first_of("/?#", pos)) {
  779. return false;
  780. }
  781. if (pos < url.size() && url[pos] == '[') {
  782. auto close = url.find(']', pos);
  783. if (close == std::string::npos) { return false; }
  784. uc.host = url.substr(pos + 1, close - pos - 1);
  785. // IPv6 host must be [a-fA-F0-9:]+ only
  786. if (uc.host.empty()) { return false; }
  787. for (auto c : uc.host) {
  788. if (!(is_ascii_digit(c) || (c >= 'a' && c <= 'f') ||
  789. (c >= 'A' && c <= 'F') || c == ':')) {
  790. return false;
  791. }
  792. }
  793. pos = close + 1;
  794. // The IPv6 literal is the whole host, so ']' must be followed by a port,
  795. // path, query or fragment delimiter (or the end of input). Otherwise the
  796. // trailing bytes would be folded into the path while the connection
  797. // still targets the bracketed address.
  798. if (pos < url.size()) {
  799. auto c = url[pos];
  800. if (c != ':' && c != '/' && c != '?' && c != '#') { return false; }
  801. }
  802. } else {
  803. auto end = url.find_first_of(":/?#", pos);
  804. if (end == std::string::npos) { end = url.size(); }
  805. uc.host = url.substr(pos, end - pos);
  806. pos = end;
  807. }
  808. if (pos < url.size() && url[pos] == ':') {
  809. ++pos;
  810. auto end = url.find_first_of("/?#", pos);
  811. if (end == std::string::npos) { end = url.size(); }
  812. uc.port = url.substr(pos, end - pos);
  813. pos = end;
  814. }
  815. // Without :// or //, the entire input must be consumed as host[:port].
  816. // If there is leftover (path, query, etc.), this is not a valid
  817. // host[:port] string — clear and reparse as a plain path.
  818. if (!has_authority_prefix && pos < url.size()) {
  819. uc.host.clear();
  820. uc.port.clear();
  821. pos = 0;
  822. }
  823. }
  824. if (pos < url.size() && url[pos] != '?' && url[pos] != '#') {
  825. auto end = url.find_first_of("?#", pos);
  826. if (end == std::string::npos) { end = url.size(); }
  827. uc.path = url.substr(pos, end - pos);
  828. pos = end;
  829. }
  830. if (pos < url.size() && url[pos] == '?') {
  831. auto end = url.find('#', pos);
  832. if (end == std::string::npos) { end = url.size(); }
  833. uc.query = url.substr(pos, end - pos);
  834. }
  835. return true;
  836. }
  837. // Removes "." and ".." segments from a path that starts with '/' (RFC 3986
  838. // section 5.2.4).
  839. inline std::string remove_dot_segments(const std::string &path) {
  840. std::string out;
  841. size_t i = 0;
  842. while (i < path.size()) {
  843. auto next = (std::min)(path.find('/', i + 1), path.size());
  844. auto segment = path.substr(i + 1, next - i - 1);
  845. auto is_last = next == path.size();
  846. if (segment == "." || segment == "..") {
  847. if (segment == "..") {
  848. out.erase((std::min)(out.rfind('/'), out.size()));
  849. }
  850. if (is_last) { out += '/'; }
  851. } else {
  852. out += '/';
  853. out += segment;
  854. }
  855. i = next;
  856. }
  857. if (out.empty()) { out = "/"; }
  858. return out;
  859. }
  860. // Resolves a relative-path or query-only Location value against the path of
  861. // the request being redirected (RFC 3986 section 5.2). Absolute URIs and
  862. // references starting with '/' are returned unchanged.
  863. inline std::string resolve_relative_location(const std::string &location,
  864. const std::string &base) {
  865. if (location.empty() || location[0] == '/') { return location; }
  866. // A ':' in the first segment means the value has a scheme.
  867. if (location.find(':') < location.find_first_of("/?#")) { return location; }
  868. if (location[0] == '#') { return base.substr(0, base.find('#')) + location; }
  869. auto base_path = base.substr(0, base.find_first_of("?#"));
  870. if (location[0] == '?') { return base_path + location; }
  871. if (base_path.empty() || base_path[0] != '/') { base_path = "/"; }
  872. auto merged = base_path.substr(0, base_path.rfind('/') + 1) + location;
  873. // Remove "." and ".." segments from the merged path.
  874. auto path_end = (std::min)(merged.find_first_of("?#"), merged.size());
  875. return remove_dot_segments(merged.substr(0, path_end)) +
  876. merged.substr(path_end);
  877. }
  878. } // namespace detail
  879. enum class SSLVerifierResponse {
  880. // no decision has been made, use the built-in certificate verifier
  881. NoDecisionMade,
  882. // connection certificate is verified and accepted
  883. CertificateAccepted,
  884. // connection certificate was processed but is rejected
  885. CertificateRejected
  886. };
  887. // System CA loading policy for SSL clients. Auto (the default) loads system
  888. // CA certs only when no custom CA is configured; enable_system_ca() switches
  889. // to an explicit policy.
  890. enum class SystemCAMode { Auto, Enabled, Disabled };
  891. enum StatusCode {
  892. // Information responses
  893. Continue_100 = 100,
  894. SwitchingProtocol_101 = 101,
  895. Processing_102 = 102,
  896. EarlyHints_103 = 103,
  897. // Successful responses
  898. OK_200 = 200,
  899. Created_201 = 201,
  900. Accepted_202 = 202,
  901. NonAuthoritativeInformation_203 = 203,
  902. NoContent_204 = 204,
  903. ResetContent_205 = 205,
  904. PartialContent_206 = 206,
  905. MultiStatus_207 = 207,
  906. AlreadyReported_208 = 208,
  907. IMUsed_226 = 226,
  908. // Redirection messages
  909. MultipleChoices_300 = 300,
  910. MovedPermanently_301 = 301,
  911. Found_302 = 302,
  912. SeeOther_303 = 303,
  913. NotModified_304 = 304,
  914. UseProxy_305 = 305,
  915. unused_306 = 306,
  916. TemporaryRedirect_307 = 307,
  917. PermanentRedirect_308 = 308,
  918. // Client error responses
  919. BadRequest_400 = 400,
  920. Unauthorized_401 = 401,
  921. PaymentRequired_402 = 402,
  922. Forbidden_403 = 403,
  923. NotFound_404 = 404,
  924. MethodNotAllowed_405 = 405,
  925. NotAcceptable_406 = 406,
  926. ProxyAuthenticationRequired_407 = 407,
  927. RequestTimeout_408 = 408,
  928. Conflict_409 = 409,
  929. Gone_410 = 410,
  930. LengthRequired_411 = 411,
  931. PreconditionFailed_412 = 412,
  932. PayloadTooLarge_413 = 413,
  933. UriTooLong_414 = 414,
  934. UnsupportedMediaType_415 = 415,
  935. RangeNotSatisfiable_416 = 416,
  936. ExpectationFailed_417 = 417,
  937. ImATeapot_418 = 418,
  938. MisdirectedRequest_421 = 421,
  939. UnprocessableContent_422 = 422,
  940. Locked_423 = 423,
  941. FailedDependency_424 = 424,
  942. TooEarly_425 = 425,
  943. UpgradeRequired_426 = 426,
  944. PreconditionRequired_428 = 428,
  945. TooManyRequests_429 = 429,
  946. RequestHeaderFieldsTooLarge_431 = 431,
  947. UnavailableForLegalReasons_451 = 451,
  948. // Server error responses
  949. InternalServerError_500 = 500,
  950. NotImplemented_501 = 501,
  951. BadGateway_502 = 502,
  952. ServiceUnavailable_503 = 503,
  953. GatewayTimeout_504 = 504,
  954. HttpVersionNotSupported_505 = 505,
  955. VariantAlsoNegotiates_506 = 506,
  956. InsufficientStorage_507 = 507,
  957. LoopDetected_508 = 508,
  958. NotExtended_510 = 510,
  959. NetworkAuthenticationRequired_511 = 511,
  960. };
  961. namespace detail {
  962. // A multimap that keeps its entries in the order they were inserted.
  963. //
  964. // HTTP needs that order in two places. RFC 9110 5.3 makes the order of header
  965. // fields sharing a field name significant and forbids a proxy from reordering
  966. // them, and a query string's parameters are meaningful in the order the caller
  967. // wrote them. Neither standard container expresses it: std::unordered_multimap
  968. // gives no ordering guarantee at all for equivalent keys (libstdc++ yields
  969. // reverse insertion order, libc++ insertion order), and std::multimap sorts by
  970. // key, which would drop control data such as Host behind whatever else the
  971. // message carries and alphabetise a query string.
  972. //
  973. // Entries are therefore kept in a flat vector, in order. Lookup is a linear
  974. // scan, which beats hashing for the handful of entries a message carries
  975. // (headers are capped at CPPHTTPLIB_HEADER_MAX_COUNT).
  976. //
  977. // KeyEqual compares keys; it is what makes Headers case-insensitive and
  978. // Params, whose parameter names are case-sensitive, not.
  979. template <typename Mapped, typename KeyEqual> class insertion_ordered_multimap {
  980. public:
  981. using key_type = std::string;
  982. using mapped_type = Mapped;
  983. using value_type = std::pair<std::string, Mapped>;
  984. using size_type = std::size_t;
  985. using difference_type = std::ptrdiff_t;
  986. using reference = value_type &;
  987. using const_reference = const value_type &;
  988. private:
  989. static size_type npos() { return static_cast<size_type>(-1); }
  990. static bool keys_equal(const std::string &a, const std::string &b) {
  991. return KeyEqual()(a, b);
  992. }
  993. // Iterating yields every entry in insertion order, but equal_range() and
  994. // find() have to walk only the entries sharing one key, which are not
  995. // adjacent. Both are the same iterator type: key_idx_ selects between the
  996. // two traversals, and since equality compares only the position, an iterator
  997. // restricted to one key still compares equal to end().
  998. template <typename V> class iterator_t {
  999. public:
  1000. using iterator_category = std::bidirectional_iterator_tag;
  1001. using value_type = insertion_ordered_multimap::value_type;
  1002. using difference_type = insertion_ordered_multimap::difference_type;
  1003. using pointer = V *;
  1004. using reference = V &;
  1005. iterator_t() : data_(nullptr), idx_(0), size_(0), key_idx_(npos()) {}
  1006. template <typename U,
  1007. typename std::enable_if<std::is_convertible<U *, V *>::value,
  1008. int>::type = 0>
  1009. iterator_t(const iterator_t<U> &rhs)
  1010. : data_(rhs.data_), idx_(rhs.idx_), size_(rhs.size_),
  1011. key_idx_(rhs.key_idx_) {}
  1012. reference operator*() const { return data_[idx_]; }
  1013. pointer operator->() const { return data_ + idx_; }
  1014. iterator_t &operator++() {
  1015. // Saturating, so that advancing past the last entry of a key stays at
  1016. // end() instead of running off the container.
  1017. if (idx_ >= size_) { return *this; }
  1018. ++idx_;
  1019. if (key_idx_ != npos()) {
  1020. while (idx_ < size_ && !matches(idx_)) {
  1021. ++idx_;
  1022. }
  1023. }
  1024. return *this;
  1025. }
  1026. iterator_t operator++(int) {
  1027. auto tmp = *this;
  1028. ++*this;
  1029. return tmp;
  1030. }
  1031. iterator_t &operator--() {
  1032. if (idx_ == 0) { return *this; }
  1033. --idx_;
  1034. if (key_idx_ != npos()) {
  1035. while (idx_ > 0 && !matches(idx_)) {
  1036. --idx_;
  1037. }
  1038. }
  1039. return *this;
  1040. }
  1041. iterator_t operator--(int) {
  1042. auto tmp = *this;
  1043. --*this;
  1044. return tmp;
  1045. }
  1046. template <typename U> bool operator==(const iterator_t<U> &rhs) const {
  1047. return idx_ == rhs.idx_;
  1048. }
  1049. template <typename U> bool operator!=(const iterator_t<U> &rhs) const {
  1050. return idx_ != rhs.idx_;
  1051. }
  1052. private:
  1053. friend class insertion_ordered_multimap;
  1054. template <typename> friend class iterator_t;
  1055. iterator_t(V *data, size_type idx, size_type size, size_type key_idx)
  1056. : data_(data), idx_(idx), size_(size), key_idx_(key_idx) {}
  1057. bool matches(size_type i) const {
  1058. return keys_equal(data_[i].first, data_[key_idx_].first);
  1059. }
  1060. V *data_;
  1061. size_type idx_;
  1062. size_type size_;
  1063. size_type key_idx_;
  1064. };
  1065. public:
  1066. using iterator = iterator_t<value_type>;
  1067. using const_iterator = iterator_t<const value_type>;
  1068. insertion_ordered_multimap() = default;
  1069. insertion_ordered_multimap(std::initializer_list<value_type> il)
  1070. : entries_(il) {}
  1071. template <typename InputIt>
  1072. insertion_ordered_multimap(InputIt first, InputIt last)
  1073. : entries_(first, last) {}
  1074. iterator begin() { return make_iter(0, npos()); }
  1075. iterator end() { return make_iter(entries_.size(), npos()); }
  1076. const_iterator begin() const { return make_citer(0, npos()); }
  1077. const_iterator end() const { return make_citer(entries_.size(), npos()); }
  1078. const_iterator cbegin() const { return begin(); }
  1079. const_iterator cend() const { return end(); }
  1080. bool empty() const { return entries_.empty(); }
  1081. size_type size() const { return entries_.size(); }
  1082. void clear() { entries_.clear(); }
  1083. void swap(insertion_ordered_multimap &rhs) { entries_.swap(rhs.entries_); }
  1084. iterator insert(const value_type &val) {
  1085. entries_.push_back(val);
  1086. return make_iter(entries_.size() - 1, npos());
  1087. }
  1088. iterator insert(value_type &&val) {
  1089. entries_.push_back(std::move(val));
  1090. return make_iter(entries_.size() - 1, npos());
  1091. }
  1092. template <typename... Args> iterator emplace(Args &&...args) {
  1093. entries_.emplace_back(std::forward<Args>(args)...);
  1094. return make_iter(entries_.size() - 1, npos());
  1095. }
  1096. // For entries that have to lead the message, such as the Host header field
  1097. // (RFC 9110 5.3 recommends sending control data first).
  1098. template <typename... Args> iterator emplace_front(Args &&...args) {
  1099. entries_.emplace(entries_.begin(), std::forward<Args>(args)...);
  1100. return make_iter(0, npos());
  1101. }
  1102. iterator find(const std::string &key) {
  1103. auto i = index_of(key);
  1104. return i == npos() ? end() : make_iter(i, i);
  1105. }
  1106. const_iterator find(const std::string &key) const {
  1107. auto i = index_of(key);
  1108. return i == npos() ? end() : make_citer(i, i);
  1109. }
  1110. size_type count(const std::string &key) const {
  1111. size_type n = 0;
  1112. for (const auto &entry : entries_) {
  1113. if (keys_equal(entry.first, key)) { n++; }
  1114. }
  1115. return n;
  1116. }
  1117. std::pair<iterator, iterator> equal_range(const std::string &key) {
  1118. auto i = index_of(key);
  1119. return i == npos() ? std::make_pair(end(), end())
  1120. : std::make_pair(make_iter(i, i), end());
  1121. }
  1122. std::pair<const_iterator, const_iterator>
  1123. equal_range(const std::string &key) const {
  1124. auto i = index_of(key);
  1125. return i == npos() ? std::make_pair(end(), end())
  1126. : std::make_pair(make_citer(i, i), end());
  1127. }
  1128. size_type erase(const std::string &key) {
  1129. auto before = entries_.size();
  1130. entries_.erase(std::remove_if(entries_.begin(), entries_.end(),
  1131. [&](const value_type &entry) {
  1132. return keys_equal(entry.first, key);
  1133. }),
  1134. entries_.end());
  1135. return before - entries_.size();
  1136. }
  1137. iterator erase(const_iterator pos) {
  1138. entries_.erase(entries_.begin() + static_cast<difference_type>(pos.idx_));
  1139. return make_iter(pos.idx_, npos());
  1140. }
  1141. // Erases what iterating [first, last) would actually visit, so erasing an
  1142. // equal_range() removes only the entries with that key, not everything
  1143. // positioned between them.
  1144. iterator erase(const_iterator first, const_iterator last) {
  1145. auto from = first.idx_;
  1146. auto to = last.idx_;
  1147. if (from >= to) { return make_iter(from, npos()); }
  1148. auto begin_it = entries_.begin();
  1149. auto from_it = begin_it + static_cast<difference_type>(from);
  1150. auto to_it = begin_it + static_cast<difference_type>(to);
  1151. if (first.key_idx_ == npos()) {
  1152. entries_.erase(from_it, to_it);
  1153. } else {
  1154. auto key = entries_[first.key_idx_].first;
  1155. auto keep = from_it;
  1156. for (auto it = from_it; it != to_it; ++it) {
  1157. if (!keys_equal(it->first, key)) {
  1158. if (keep != it) { *keep = std::move(*it); }
  1159. ++keep;
  1160. }
  1161. }
  1162. if (keep != to_it) {
  1163. keep = std::move(to_it, entries_.end(), keep);
  1164. } else {
  1165. keep = entries_.end();
  1166. }
  1167. entries_.erase(keep, entries_.end());
  1168. }
  1169. return make_iter(from, npos());
  1170. }
  1171. friend bool operator==(const insertion_ordered_multimap &lhs,
  1172. const insertion_ordered_multimap &rhs) {
  1173. return lhs.entries_ == rhs.entries_;
  1174. }
  1175. friend bool operator!=(const insertion_ordered_multimap &lhs,
  1176. const insertion_ordered_multimap &rhs) {
  1177. return !(lhs == rhs);
  1178. }
  1179. private:
  1180. size_type index_of(const std::string &key) const {
  1181. for (size_type i = 0; i < entries_.size(); i++) {
  1182. if (keys_equal(entries_[i].first, key)) { return i; }
  1183. }
  1184. return npos();
  1185. }
  1186. iterator make_iter(size_type idx, size_type key_idx) {
  1187. return iterator(entries_.data(), idx, entries_.size(), key_idx);
  1188. }
  1189. const_iterator make_citer(size_type idx, size_type key_idx) const {
  1190. return const_iterator(entries_.data(), idx, entries_.size(), key_idx);
  1191. }
  1192. std::vector<value_type> entries_;
  1193. };
  1194. } // namespace detail
  1195. using Headers =
  1196. detail::insertion_ordered_multimap<std::string,
  1197. detail::case_ignore::equal_to>;
  1198. // Query parameter names are case-sensitive, unlike header field names.
  1199. using Params =
  1200. detail::insertion_ordered_multimap<std::string, std::equal_to<std::string>>;
  1201. using Match = std::smatch;
  1202. using DownloadProgress = std::function<bool(size_t current, size_t total)>;
  1203. using UploadProgress = std::function<bool(size_t current, size_t total)>;
  1204. /*
  1205. * detail: type-erased storage used by UserData.
  1206. * ABI-stable regardless of C++ standard — always uses this custom
  1207. * implementation instead of std::any.
  1208. */
  1209. namespace detail {
  1210. using any_type_id = const void *;
  1211. template <typename T> any_type_id any_typeid() noexcept {
  1212. static const char id = 0;
  1213. return &id;
  1214. }
  1215. struct any_storage {
  1216. virtual ~any_storage() = default;
  1217. virtual std::unique_ptr<any_storage> clone() const = 0;
  1218. virtual any_type_id type_id() const noexcept = 0;
  1219. };
  1220. template <typename T> struct any_value final : any_storage {
  1221. T value;
  1222. template <typename U> explicit any_value(U &&v) : value(std::forward<U>(v)) {}
  1223. std::unique_ptr<any_storage> clone() const override {
  1224. return std::unique_ptr<any_storage>(new any_value<T>(value));
  1225. }
  1226. any_type_id type_id() const noexcept override { return any_typeid<T>(); }
  1227. };
  1228. } // namespace detail
  1229. class UserData {
  1230. public:
  1231. UserData() = default;
  1232. UserData(UserData &&) noexcept = default;
  1233. UserData &operator=(UserData &&) noexcept = default;
  1234. UserData(const UserData &o) {
  1235. for (const auto &e : o.entries_) {
  1236. if (e.second) { entries_[e.first] = e.second->clone(); }
  1237. }
  1238. }
  1239. UserData &operator=(const UserData &o) {
  1240. if (this != &o) {
  1241. entries_.clear();
  1242. for (const auto &e : o.entries_) {
  1243. if (e.second) { entries_[e.first] = e.second->clone(); }
  1244. }
  1245. }
  1246. return *this;
  1247. }
  1248. template <typename T> void set(const std::string &key, T &&value) {
  1249. using D = typename std::decay<T>::type;
  1250. entries_[key].reset(new detail::any_value<D>(std::forward<T>(value)));
  1251. }
  1252. template <typename T> T *get(const std::string &key) noexcept {
  1253. auto it = entries_.find(key);
  1254. if (it == entries_.end() || !it->second) { return nullptr; }
  1255. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1256. return &static_cast<detail::any_value<T> *>(it->second.get())->value;
  1257. }
  1258. template <typename T> const T *get(const std::string &key) const noexcept {
  1259. auto it = entries_.find(key);
  1260. if (it == entries_.end() || !it->second) { return nullptr; }
  1261. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1262. return &static_cast<const detail::any_value<T> *>(it->second.get())->value;
  1263. }
  1264. bool has(const std::string &key) const noexcept {
  1265. return entries_.find(key) != entries_.end();
  1266. }
  1267. void erase(const std::string &key) { entries_.erase(key); }
  1268. void clear() noexcept { entries_.clear(); }
  1269. private:
  1270. std::unordered_map<std::string, std::unique_ptr<detail::any_storage>>
  1271. entries_;
  1272. };
  1273. struct Response;
  1274. using ResponseHandler = std::function<bool(const Response &response)>;
  1275. struct FormData {
  1276. std::string name;
  1277. std::string content;
  1278. std::string filename;
  1279. std::string content_type;
  1280. Headers headers;
  1281. };
  1282. struct FormField {
  1283. std::string name;
  1284. std::string content;
  1285. Headers headers;
  1286. };
  1287. // RFC 7578 5.2: a form processor "SHOULD send back results in order" and
  1288. // "Intermediaries MUST NOT reorder the results", so a handler walking these
  1289. // should see the parts as they were sent. A std::multimap sorts by field name
  1290. // and loses that. Field names are case-sensitive, hence std::equal_to rather
  1291. // than the case-insensitive predicate Headers uses.
  1292. using FormFields =
  1293. detail::insertion_ordered_multimap<FormField, std::equal_to<std::string>>;
  1294. using FormFiles =
  1295. detail::insertion_ordered_multimap<FormData, std::equal_to<std::string>>;
  1296. struct MultipartFormData {
  1297. FormFields fields; // Text fields from multipart
  1298. FormFiles files; // Files from multipart
  1299. // Text field access
  1300. std::string get_field(const std::string &key, size_t id = 0) const;
  1301. std::vector<std::string> get_fields(const std::string &key) const;
  1302. bool has_field(const std::string &key) const;
  1303. size_t get_field_count(const std::string &key) const;
  1304. // File access
  1305. FormData get_file(const std::string &key, size_t id = 0) const;
  1306. std::vector<FormData> get_files(const std::string &key) const;
  1307. bool has_file(const std::string &key) const;
  1308. size_t get_file_count(const std::string &key) const;
  1309. };
  1310. struct UploadFormData {
  1311. std::string name;
  1312. std::string content;
  1313. std::string filename;
  1314. std::string content_type;
  1315. };
  1316. using UploadFormDataItems = std::vector<UploadFormData>;
  1317. class DataSink {
  1318. public:
  1319. DataSink() : os(&sb_), sb_(*this) {}
  1320. DataSink(const DataSink &) = delete;
  1321. DataSink &operator=(const DataSink &) = delete;
  1322. DataSink(DataSink &&) = delete;
  1323. DataSink &operator=(DataSink &&) = delete;
  1324. std::function<bool(const char *data, size_t data_len)> write;
  1325. // Only `write` is mandatory. The rest are defaulted so that a provider
  1326. // calling one on a writer that does not set it gets sensible behaviour
  1327. // rather than std::bad_function_call thrown from a worker thread. Capturing
  1328. // `this` is safe: DataSink is neither copyable nor movable.
  1329. std::function<bool()> is_writable = []() { return true; };
  1330. std::function<void()> done = []() {};
  1331. std::function<void(const Headers &trailer)> done_with_trailer =
  1332. [this](const Headers & /*trailer*/) { done(); };
  1333. std::ostream os;
  1334. private:
  1335. class data_sink_streambuf final : public std::streambuf {
  1336. public:
  1337. explicit data_sink_streambuf(DataSink &sink) : sink_(sink) {}
  1338. protected:
  1339. std::streamsize xsputn(const char *s, std::streamsize n) override {
  1340. if (sink_.write(s, static_cast<size_t>(n))) { return n; }
  1341. return 0;
  1342. }
  1343. private:
  1344. DataSink &sink_;
  1345. };
  1346. data_sink_streambuf sb_;
  1347. };
  1348. using ContentProvider =
  1349. std::function<bool(size_t offset, size_t length, DataSink &sink)>;
  1350. using ContentProviderWithoutLength =
  1351. std::function<bool(size_t offset, DataSink &sink)>;
  1352. using ContentProviderResourceReleaser = std::function<void(bool success)>;
  1353. struct FormDataProvider {
  1354. std::string name;
  1355. ContentProviderWithoutLength provider;
  1356. std::string filename;
  1357. std::string content_type;
  1358. };
  1359. using FormDataProviderItems = std::vector<FormDataProvider>;
  1360. inline FormDataProvider
  1361. make_file_provider(const std::string &name, const std::string &filepath,
  1362. const std::string &filename = std::string(),
  1363. const std::string &content_type = std::string()) {
  1364. FormDataProvider fdp;
  1365. fdp.name = name;
  1366. fdp.filename = filename.empty() ? filepath : filename;
  1367. fdp.content_type = content_type;
  1368. fdp.provider = [filepath](size_t offset, DataSink &sink) -> bool {
  1369. std::ifstream f(filepath, std::ios::binary);
  1370. if (!f) { return false; }
  1371. if (offset > 0) {
  1372. f.seekg(static_cast<std::streamoff>(offset));
  1373. if (!f.good()) {
  1374. sink.done();
  1375. return true;
  1376. }
  1377. }
  1378. char buf[8192];
  1379. f.read(buf, sizeof(buf));
  1380. auto n = static_cast<size_t>(f.gcount());
  1381. if (n > 0) { return sink.write(buf, n); }
  1382. sink.done(); // EOF
  1383. return true;
  1384. };
  1385. return fdp;
  1386. }
  1387. inline std::pair<size_t, ContentProvider>
  1388. make_file_body(const std::string &filepath) {
  1389. size_t size = 0;
  1390. {
  1391. std::ifstream f(filepath, std::ios::binary | std::ios::ate);
  1392. if (!f) { return {0, ContentProvider{}}; }
  1393. size = static_cast<size_t>(f.tellg());
  1394. }
  1395. ContentProvider provider = [filepath](size_t offset, size_t length,
  1396. DataSink &sink) -> bool {
  1397. std::ifstream f(filepath, std::ios::binary);
  1398. if (!f) { return false; }
  1399. f.seekg(static_cast<std::streamoff>(offset));
  1400. if (!f.good()) { return false; }
  1401. char buf[8192];
  1402. while (length > 0) {
  1403. auto to_read = (std::min)(sizeof(buf), length);
  1404. f.read(buf, static_cast<std::streamsize>(to_read));
  1405. auto n = static_cast<size_t>(f.gcount());
  1406. // The file is shorter than the size make_file_body() measured, which the
  1407. // caller has already committed to as Content-Length. The body cannot be
  1408. // completed, so fail as every other error here does.
  1409. if (n == 0) { return false; }
  1410. if (!sink.write(buf, n)) { return false; }
  1411. length -= n;
  1412. }
  1413. return true;
  1414. };
  1415. return {size, std::move(provider)};
  1416. }
  1417. using ContentReceiverWithProgress = std::function<bool(
  1418. const char *data, size_t data_length, size_t offset, size_t total_length)>;
  1419. using ContentReceiver =
  1420. std::function<bool(const char *data, size_t data_length)>;
  1421. using FormDataHeader = std::function<bool(const FormData &file)>;
  1422. class ContentReader {
  1423. public:
  1424. using Reader = std::function<bool(ContentReceiver receiver)>;
  1425. using FormDataReader =
  1426. std::function<bool(FormDataHeader header, ContentReceiver receiver)>;
  1427. ContentReader(Reader reader, FormDataReader multipart_reader)
  1428. : reader_(std::move(reader)),
  1429. formdata_reader_(std::move(multipart_reader)) {}
  1430. bool operator()(FormDataHeader header, ContentReceiver receiver) const {
  1431. return formdata_reader_(std::move(header), std::move(receiver));
  1432. }
  1433. bool operator()(ContentReceiver receiver) const {
  1434. return reader_(std::move(receiver));
  1435. }
  1436. Reader reader_;
  1437. FormDataReader formdata_reader_;
  1438. };
  1439. using Range = std::pair<ssize_t, ssize_t>;
  1440. using Ranges = std::vector<Range>;
  1441. #ifdef CPPHTTPLIB_SSL_ENABLED
  1442. // TLS abstraction layer - public type definitions and API
  1443. namespace tls {
  1444. // Opaque handles (defined as void* for abstraction)
  1445. using ctx_t = void *;
  1446. using session_t = void *;
  1447. using const_session_t = const void *; // For read-only session access
  1448. using cert_t = void *;
  1449. using ca_store_t = void *;
  1450. // TLS versions
  1451. enum class Version {
  1452. TLS1_2 = 0x0303,
  1453. TLS1_3 = 0x0304,
  1454. };
  1455. // Subject Alternative Names (SAN) entry types
  1456. enum class SanType { DNS, IP, EMAIL, URI, OTHER };
  1457. // SAN entry structure
  1458. struct SanEntry {
  1459. SanType type;
  1460. std::string value;
  1461. };
  1462. // Verification context for certificate verification callback
  1463. struct VerifyContext {
  1464. session_t session; // TLS session handle
  1465. cert_t cert; // Current certificate being verified
  1466. int depth; // Certificate chain depth (0 = leaf)
  1467. bool preverify_ok; // OpenSSL/Mbed TLS pre-verification result
  1468. long error_code; // Backend-specific error code (0 = no error)
  1469. const char *error_string; // Human-readable error description
  1470. // Certificate introspection methods
  1471. std::string subject_cn() const;
  1472. std::string issuer_name() const;
  1473. bool check_hostname(const char *hostname) const;
  1474. std::vector<SanEntry> sans() const;
  1475. bool validity(time_t &not_before, time_t &not_after) const;
  1476. std::string serial() const;
  1477. };
  1478. using VerifyCallback = std::function<bool(const VerifyContext &ctx)>;
  1479. // TlsError codes for TLS operations (backend-independent)
  1480. enum class ErrorCode : int {
  1481. Success = 0,
  1482. WantRead, // Non-blocking: need to wait for read
  1483. WantWrite, // Non-blocking: need to wait for write
  1484. PeerClosed, // Peer closed the connection
  1485. Fatal, // Unrecoverable error
  1486. SyscallError, // System call error (check sys_errno)
  1487. CertVerifyFailed, // Certificate verification failed
  1488. HostnameMismatch, // Hostname verification failed
  1489. };
  1490. // TLS error information
  1491. struct TlsError {
  1492. ErrorCode code = ErrorCode::Fatal;
  1493. uint64_t backend_code = 0; // OpenSSL: ERR_get_error(), mbedTLS: return value
  1494. int sys_errno = 0; // errno when SyscallError
  1495. // Convert verification error code to human-readable string
  1496. static std::string verify_error_to_string(long error_code);
  1497. };
  1498. // RAII wrapper for peer certificate
  1499. class PeerCert {
  1500. public:
  1501. PeerCert();
  1502. PeerCert(PeerCert &&other) noexcept;
  1503. PeerCert &operator=(PeerCert &&other) noexcept;
  1504. ~PeerCert();
  1505. PeerCert(const PeerCert &) = delete;
  1506. PeerCert &operator=(const PeerCert &) = delete;
  1507. explicit operator bool() const;
  1508. std::string subject_cn() const;
  1509. std::string issuer_name() const;
  1510. bool check_hostname(const char *hostname) const;
  1511. std::vector<SanEntry> sans() const;
  1512. bool validity(time_t &not_before, time_t &not_after) const;
  1513. std::string serial() const;
  1514. private:
  1515. explicit PeerCert(cert_t cert);
  1516. cert_t cert_ = nullptr;
  1517. friend PeerCert get_peer_cert_from_session(const_session_t session);
  1518. };
  1519. // Callback for TLS context setup (used by SSLServer constructor)
  1520. using ContextSetupCallback = std::function<bool(ctx_t ctx)>;
  1521. } // namespace tls
  1522. #endif
  1523. struct Request {
  1524. std::string method;
  1525. std::string path;
  1526. std::string matched_route;
  1527. Params params;
  1528. Headers headers;
  1529. Headers trailers;
  1530. std::string body;
  1531. std::string remote_addr;
  1532. int remote_port = -1;
  1533. std::string local_addr;
  1534. int local_port = -1;
  1535. // for server
  1536. std::string version;
  1537. std::string target;
  1538. MultipartFormData form;
  1539. Ranges ranges;
  1540. Match matches;
  1541. std::unordered_map<std::string, std::string> path_params;
  1542. std::function<bool()> is_connection_closed = []() { return true; };
  1543. // for client
  1544. std::vector<std::string> accept_content_types;
  1545. ResponseHandler response_handler;
  1546. ContentReceiverWithProgress content_receiver;
  1547. DownloadProgress download_progress;
  1548. UploadProgress upload_progress;
  1549. bool has_header(const std::string &key) const;
  1550. std::string get_header_value(const std::string &key, const char *def = "",
  1551. size_t id = 0) const;
  1552. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1553. size_t id = 0) const;
  1554. size_t get_header_value_count(const std::string &key) const;
  1555. void set_header(const std::string &key, const std::string &val);
  1556. bool has_trailer(const std::string &key) const;
  1557. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1558. size_t get_trailer_value_count(const std::string &key) const;
  1559. bool has_param(const std::string &key) const;
  1560. std::string get_param_value(const std::string &key, size_t id = 0) const;
  1561. std::vector<std::string> get_param_values(const std::string &key) const;
  1562. size_t get_param_value_count(const std::string &key) const;
  1563. bool is_multipart_form_data() const;
  1564. // private members...
  1565. bool body_read_started_ = false;
  1566. bool body_consumed_ = false;
  1567. bool expect_100_continue_pending_ = false;
  1568. size_t redirect_count_ = CPPHTTPLIB_REDIRECT_MAX_COUNT;
  1569. size_t content_length_ = 0;
  1570. ContentProvider content_provider_;
  1571. bool is_chunked_content_provider_ = false;
  1572. size_t authorization_count_ = 0;
  1573. std::chrono::time_point<std::chrono::steady_clock> start_time_ =
  1574. (std::chrono::steady_clock::time_point::min)();
  1575. #ifdef CPPHTTPLIB_SSL_ENABLED
  1576. tls::const_session_t ssl = nullptr;
  1577. tls::PeerCert peer_cert() const;
  1578. std::string sni() const;
  1579. #endif
  1580. };
  1581. namespace detail {
  1582. // Declared up here, away from the rest of the compression helpers, because
  1583. // `Response` stores one.
  1584. enum class EncodingType { None = 0, Gzip, Brotli, Zstd };
  1585. } // namespace detail
  1586. struct Response {
  1587. std::string version;
  1588. int status = -1;
  1589. std::string reason;
  1590. Headers headers;
  1591. Headers trailers;
  1592. std::string body;
  1593. std::string location; // Redirect location
  1594. // User-defined context — set by pre-routing/pre-request handlers and read
  1595. // by route handlers to pass arbitrary data (e.g. decoded auth tokens).
  1596. UserData user_data;
  1597. bool has_header(const std::string &key) const;
  1598. std::string get_header_value(const std::string &key, const char *def = "",
  1599. size_t id = 0) const;
  1600. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1601. size_t id = 0) const;
  1602. size_t get_header_value_count(const std::string &key) const;
  1603. void set_header(const std::string &key, const std::string &val);
  1604. bool has_trailer(const std::string &key) const;
  1605. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1606. size_t get_trailer_value_count(const std::string &key) const;
  1607. void set_redirect(const std::string &url, int status = StatusCode::Found_302);
  1608. void set_content(const char *s, size_t n, const std::string &content_type);
  1609. void set_content(const std::string &s, const std::string &content_type);
  1610. void set_content(std::string &&s, const std::string &content_type);
  1611. void set_content_provider(
  1612. size_t length, const std::string &content_type, ContentProvider provider,
  1613. ContentProviderResourceReleaser resource_releaser = nullptr);
  1614. void set_content_provider(
  1615. const std::string &content_type, ContentProviderWithoutLength provider,
  1616. ContentProviderResourceReleaser resource_releaser = nullptr);
  1617. void set_chunked_content_provider(
  1618. const std::string &content_type, ContentProviderWithoutLength provider,
  1619. ContentProviderResourceReleaser resource_releaser = nullptr);
  1620. void set_file_content(const std::string &path,
  1621. const std::string &content_type);
  1622. void set_file_content(const std::string &path);
  1623. Response() = default;
  1624. Response(const Response &) = default;
  1625. Response &operator=(const Response &) = default;
  1626. Response(Response &&) = default;
  1627. Response &operator=(Response &&) = default;
  1628. ~Response() {
  1629. if (content_provider_resource_releaser_) {
  1630. content_provider_resource_releaser_(content_provider_success_);
  1631. }
  1632. }
  1633. // private members...
  1634. size_t content_length_ = 0;
  1635. ContentProvider content_provider_;
  1636. ContentProviderResourceReleaser content_provider_resource_releaser_;
  1637. bool is_chunked_content_provider_ = false;
  1638. bool is_file_content_provider_ = false;
  1639. bool content_provider_success_ = false;
  1640. std::string file_content_path_;
  1641. std::string file_content_content_type_;
  1642. // Content coding chosen for the response body, decided once so that the
  1643. // headers and the body cannot disagree: where the file is opened for a
  1644. // file-backed content provider (keeping the ETag honest), and in
  1645. // `apply_ranges()` for a chunked content provider. `EncodingType::None`
  1646. // for every other kind of response.
  1647. detail::EncodingType content_coding_ = detail::EncodingType::None;
  1648. };
  1649. enum class Error {
  1650. Success = 0,
  1651. Unknown,
  1652. Connection,
  1653. BindIPAddress,
  1654. Read,
  1655. Write,
  1656. ExceedRedirectCount,
  1657. Canceled,
  1658. SSLConnection,
  1659. SSLLoadingCerts,
  1660. SSLServerVerification,
  1661. SSLServerHostnameVerification,
  1662. UnsupportedMultipartBoundaryChars,
  1663. Compression,
  1664. ConnectionTimeout,
  1665. ProxyConnection,
  1666. ConnectionClosed,
  1667. Timeout,
  1668. ResourceExhaustion,
  1669. TooManyFormDataFiles,
  1670. ExceedMaxPayloadSize,
  1671. ExceedUriMaxLength,
  1672. ExceedMaxSocketDescriptorCount,
  1673. InvalidRequestLine,
  1674. InvalidHTTPMethod,
  1675. InvalidHTTPVersion,
  1676. InvalidHeaders,
  1677. MultipartParsing,
  1678. OpenFile,
  1679. Listen,
  1680. GetSockName,
  1681. UnsupportedAddressFamily,
  1682. HTTPParsing,
  1683. InvalidRangeHeader,
  1684. UnsupportedContentEncoding,
  1685. WebSocketHandshake,
  1686. UserCallbackException,
  1687. // For internal use only
  1688. SSLPeerCouldBeClosed_,
  1689. };
  1690. std::string to_string(Error error);
  1691. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1692. class Stream {
  1693. public:
  1694. virtual ~Stream() = default;
  1695. virtual bool is_readable() const = 0;
  1696. virtual bool wait_readable() const = 0;
  1697. virtual bool wait_writable() const = 0;
  1698. virtual bool is_peer_alive() const { return wait_writable(); }
  1699. virtual ssize_t read(char *ptr, size_t size) = 0;
  1700. virtual ssize_t write(const char *ptr, size_t size) = 0;
  1701. virtual void get_remote_ip_and_port(std::string &ip, int &port) const = 0;
  1702. virtual void get_local_ip_and_port(std::string &ip, int &port) const = 0;
  1703. virtual socket_t socket() const = 0;
  1704. virtual time_t duration() const = 0;
  1705. virtual void set_read_timeout(time_t sec, time_t usec = 0) {
  1706. (void)sec;
  1707. (void)usec;
  1708. }
  1709. // Bounds the reads from now on to `msec` in total, on top of the timeout of
  1710. // each one. 0 lifts the bound.
  1711. virtual void set_max_timeout(time_t msec) { (void)msec; }
  1712. // Lets a wait for data end early once `interrupted` returns true, so that
  1713. // another thread can stop a blocked read on every platform.
  1714. virtual void set_read_interrupt(std::function<bool()> interrupted) {
  1715. (void)interrupted;
  1716. }
  1717. // Bytes already pulled off the socket and sitting in this stream's own
  1718. // buffer. Exposing them lets a line reader scan for a terminator in one
  1719. // pass instead of asking for a byte at a time. A stream that does no
  1720. // buffering of its own reports none, and readers fall back to read().
  1721. virtual const char *buffered_data(size_t &size) const {
  1722. size = 0;
  1723. return nullptr;
  1724. }
  1725. // Discards `size` bytes previously returned by buffered_data().
  1726. virtual void consume_buffered(size_t size) { (void)size; }
  1727. ssize_t write(const char *ptr);
  1728. ssize_t write(const std::string &s);
  1729. Error get_error() const { return error_; }
  1730. protected:
  1731. Error error_ = Error::Success;
  1732. };
  1733. class TaskQueue {
  1734. public:
  1735. TaskQueue() = default;
  1736. virtual ~TaskQueue() = default;
  1737. virtual bool enqueue(std::function<void()> fn) = 0;
  1738. virtual void shutdown() = 0;
  1739. virtual void on_idle() {}
  1740. };
  1741. class ThreadPool final : public TaskQueue {
  1742. public:
  1743. explicit ThreadPool(
  1744. size_t n, size_t max_n = 0, size_t mqr = 0,
  1745. time_t idle_timeout_sec = CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT);
  1746. ThreadPool(const ThreadPool &) = delete;
  1747. ~ThreadPool() override = default;
  1748. bool enqueue(std::function<void()> fn) override;
  1749. void shutdown() override;
  1750. private:
  1751. void worker(bool is_dynamic);
  1752. void move_to_finished(std::thread::id id);
  1753. void cleanup_finished_threads();
  1754. size_t base_thread_count_;
  1755. size_t max_thread_count_;
  1756. size_t max_queued_requests_;
  1757. time_t idle_timeout_sec_;
  1758. size_t idle_thread_count_;
  1759. bool shutdown_;
  1760. std::list<std::function<void()>> jobs_;
  1761. std::vector<std::thread> threads_; // base threads
  1762. std::list<std::thread> dynamic_threads_; // dynamic threads
  1763. std::vector<std::thread>
  1764. finished_threads_; // exited dynamic threads awaiting join
  1765. std::condition_variable cond_;
  1766. std::mutex mutex_;
  1767. };
  1768. using Logger = std::function<void(const Request &, const Response &)>;
  1769. // Forward declaration for Error type
  1770. enum class Error;
  1771. using ErrorLogger = std::function<void(const Error &, const Request *)>;
  1772. using SocketOptions = std::function<void(socket_t sock)>;
  1773. void default_socket_options(socket_t sock);
  1774. bool set_socket_opt(socket_t sock, int level, int optname, int optval);
  1775. const char *status_message(int status);
  1776. std::string to_string(Error error);
  1777. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1778. std::string get_bearer_token_auth(const Request &req);
  1779. namespace detail {
  1780. class MatcherBase {
  1781. public:
  1782. MatcherBase(std::string pattern) : pattern_(std::move(pattern)) {}
  1783. virtual ~MatcherBase() = default;
  1784. const std::string &pattern() const { return pattern_; }
  1785. // Match request path and populate its matches and
  1786. virtual bool match(Request &request) const = 0;
  1787. private:
  1788. std::string pattern_;
  1789. };
  1790. /**
  1791. * Captures parameters in request path and stores them in Request::path_params
  1792. *
  1793. * Capture name is a substring of a pattern from : to /.
  1794. * The rest of the pattern is matched against the request path directly
  1795. * Parameters are captured starting from the next character after
  1796. * the end of the last matched static pattern fragment until the next /.
  1797. *
  1798. * Example pattern:
  1799. * "/path/fragments/:capture/more/fragments/:second_capture"
  1800. * Static fragments:
  1801. * "/path/fragments/", "more/fragments/"
  1802. *
  1803. * Given the following request path:
  1804. * "/path/fragments/:1/more/fragments/:2"
  1805. * the resulting capture will be
  1806. * {{"capture", "1"}, {"second_capture", "2"}}
  1807. */
  1808. class PathParamsMatcher final : public MatcherBase {
  1809. public:
  1810. PathParamsMatcher(const std::string &pattern);
  1811. bool match(Request &request) const override;
  1812. private:
  1813. // Treat segment separators as the end of path parameter capture
  1814. // Does not need to handle query parameters as they are parsed before path
  1815. // matching
  1816. static constexpr char separator = '/';
  1817. // Contains static path fragments to match against, excluding the '/' after
  1818. // path params
  1819. // Fragments are separated by path params
  1820. std::vector<std::string> static_fragments_;
  1821. // Stores the names of the path parameters to be used as keys in the
  1822. // Request::path_params map
  1823. std::vector<std::string> param_names_;
  1824. };
  1825. /**
  1826. * Performs std::regex_match on request path
  1827. * and stores the result in Request::matches
  1828. *
  1829. * Note that regex match is performed directly on the whole request.
  1830. * This means that wildcard patterns may match multiple path segments with /:
  1831. * "/begin/(.*)/end" will match both "/begin/middle/end" and "/begin/1/2/end".
  1832. */
  1833. class RegexMatcher final : public MatcherBase {
  1834. public:
  1835. RegexMatcher(const std::string &pattern)
  1836. : MatcherBase(pattern), regex_(pattern) {}
  1837. bool match(Request &request) const override;
  1838. private:
  1839. std::regex regex_;
  1840. };
  1841. int close_socket(socket_t sock) noexcept;
  1842. bool is_accept_resource_error();
  1843. bool is_accept_transient_error();
  1844. ssize_t write_headers(Stream &strm, const Headers &headers);
  1845. bool set_socket_opt_time(socket_t sock, int level, int optname, time_t sec,
  1846. time_t usec);
  1847. size_t get_multipart_content_length(const UploadFormDataItems &items,
  1848. const std::string &boundary);
  1849. ContentProvider
  1850. make_multipart_content_provider(const UploadFormDataItems &items,
  1851. const std::string &boundary);
  1852. } // namespace detail
  1853. bool is_valid_multipart_boundary(const std::string &boundary);
  1854. // Serializer for multipart/form-data request bodies. The boundary is owned
  1855. // by the writer so that per-part framing and the final terminator always
  1856. // agree. Field names and filenames are escaped following the WHATWG HTML
  1857. // standard ('"' -> %22, CR -> %0D, LF -> %0A); CR and LF are also escaped
  1858. // in content types.
  1859. class MultipartFormDataWriter {
  1860. public:
  1861. MultipartFormDataWriter();
  1862. // precondition: is_valid_multipart_boundary(boundary)
  1863. explicit MultipartFormDataWriter(std::string boundary);
  1864. const std::string &boundary() const;
  1865. std::string content_type() const;
  1866. // In-memory items -> whole body (known length)
  1867. std::string serialize(const UploadFormDataItems &items) const;
  1868. size_t content_length(const UploadFormDataItems &items) const;
  1869. // Per-part framing for streaming via a content provider
  1870. std::string item_begin(const UploadFormData &item) const;
  1871. static std::string item_end();
  1872. std::string finish() const;
  1873. private:
  1874. std::string boundary_;
  1875. };
  1876. class Server {
  1877. public:
  1878. using Handler = std::function<void(const Request &, Response &)>;
  1879. using ExceptionHandler =
  1880. std::function<void(const Request &, Response &, std::exception_ptr ep)>;
  1881. enum class HandlerResponse {
  1882. Handled,
  1883. Unhandled,
  1884. };
  1885. using HandlerWithResponse =
  1886. std::function<HandlerResponse(const Request &, Response &)>;
  1887. using HandlerWithContentReader = std::function<void(
  1888. const Request &, Response &, const ContentReader &content_reader)>;
  1889. using Expect100ContinueHandler =
  1890. std::function<int(const Request &, Response &)>;
  1891. using StartHandler = std::function<void()>;
  1892. using WebSocketHandler =
  1893. std::function<void(const Request &, ws::WebSocket &)>;
  1894. using SubProtocolSelector =
  1895. std::function<std::string(const std::vector<std::string> &protocols)>;
  1896. Server();
  1897. virtual ~Server();
  1898. virtual bool is_valid() const;
  1899. Server &Get(const std::string &pattern, Handler handler);
  1900. Server &Post(const std::string &pattern, Handler handler);
  1901. Server &Post(const std::string &pattern, HandlerWithContentReader handler);
  1902. Server &Put(const std::string &pattern, Handler handler);
  1903. Server &Put(const std::string &pattern, HandlerWithContentReader handler);
  1904. Server &Patch(const std::string &pattern, Handler handler);
  1905. Server &Patch(const std::string &pattern, HandlerWithContentReader handler);
  1906. Server &Delete(const std::string &pattern, Handler handler);
  1907. Server &Delete(const std::string &pattern, HandlerWithContentReader handler);
  1908. Server &Options(const std::string &pattern, Handler handler);
  1909. // Register a handler for an HTTP method outside the built-in set (e.g. the
  1910. // WebDAV methods from RFC 4918). Registering a method here is what makes the
  1911. // server accept it; an unregistered method is still rejected with 400.
  1912. // `method` must be a valid HTTP method token and must not be one of the
  1913. // built-in methods, which have their own registration functions above. A
  1914. // rejected registration makes is_valid() return false, so listen() fails.
  1915. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1916. Handler handler);
  1917. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1918. HandlerWithContentReader handler);
  1919. Server &WebSocket(const std::string &pattern, WebSocketHandler handler);
  1920. Server &WebSocket(const std::string &pattern, WebSocketHandler handler,
  1921. SubProtocolSelector sub_protocol_selector);
  1922. bool set_base_dir(const std::string &dir,
  1923. const std::string &mount_point = std::string());
  1924. bool set_mount_point(const std::string &mount_point, const std::string &dir,
  1925. Headers headers = Headers());
  1926. bool remove_mount_point(const std::string &mount_point);
  1927. Server &set_file_extension_and_mimetype_mapping(const std::string &ext,
  1928. const std::string &mime);
  1929. Server &set_default_file_mimetype(const std::string &mime);
  1930. Server &set_file_request_handler(Handler handler);
  1931. template <class ErrorHandlerFunc>
  1932. Server &set_error_handler(ErrorHandlerFunc &&handler) {
  1933. return set_error_handler_core(
  1934. std::forward<ErrorHandlerFunc>(handler),
  1935. std::is_convertible<ErrorHandlerFunc, HandlerWithResponse>{});
  1936. }
  1937. Server &set_exception_handler(ExceptionHandler handler);
  1938. Server &set_pre_routing_handler(HandlerWithResponse handler);
  1939. Server &set_post_routing_handler(Handler handler);
  1940. Server &set_pre_request_handler(HandlerWithResponse handler);
  1941. Server &set_expect_100_continue_handler(Expect100ContinueHandler handler);
  1942. Server &set_start_handler(StartHandler handler);
  1943. Server &set_logger(Logger logger);
  1944. Server &set_pre_compression_logger(Logger logger);
  1945. Server &set_error_logger(ErrorLogger error_logger);
  1946. Server &set_address_family(int family);
  1947. Server &set_tcp_nodelay(bool on);
  1948. Server &set_ipv6_v6only(bool on);
  1949. Server &set_socket_options(SocketOptions socket_options);
  1950. Server &set_default_headers(Headers headers);
  1951. Server &
  1952. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  1953. Server &set_trusted_proxies(const std::vector<std::string> &proxies);
  1954. Server &set_keep_alive_max_count(size_t count);
  1955. Server &set_keep_alive_timeout(time_t sec);
  1956. template <class Rep, class Period>
  1957. Server &
  1958. set_keep_alive_timeout(const std::chrono::duration<Rep, Period> &duration);
  1959. Server &set_read_timeout(time_t sec, time_t usec = 0);
  1960. template <class Rep, class Period>
  1961. Server &set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  1962. Server &set_write_timeout(time_t sec, time_t usec = 0);
  1963. template <class Rep, class Period>
  1964. Server &set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  1965. Server &set_idle_interval(time_t sec, time_t usec = 0);
  1966. template <class Rep, class Period>
  1967. Server &set_idle_interval(const std::chrono::duration<Rep, Period> &duration);
  1968. Server &set_payload_max_length(size_t length);
  1969. Server &set_compress(bool on);
  1970. Server &set_static_file_compression(bool on);
  1971. Server &set_static_file_compression_min_length(size_t length);
  1972. Server &set_static_file_compression_max_length(size_t length);
  1973. Server &set_websocket_ping_interval(time_t sec);
  1974. template <class Rep, class Period>
  1975. Server &set_websocket_ping_interval(
  1976. const std::chrono::duration<Rep, Period> &duration);
  1977. Server &set_websocket_max_missed_pongs(int count);
  1978. bool bind_to_port(const std::string &host, int port, int socket_flags = 0);
  1979. int bind_to_any_port(const std::string &host, int socket_flags = 0);
  1980. bool listen_after_bind();
  1981. bool listen(const std::string &host, int port, int socket_flags = 0);
  1982. bool is_running() const;
  1983. void wait_until_ready() const;
  1984. void stop() noexcept;
  1985. void decommission();
  1986. std::function<TaskQueue *(void)> new_task_queue;
  1987. protected:
  1988. bool process_request(Stream &strm, const std::string &remote_addr,
  1989. int remote_port, const std::string &local_addr,
  1990. int local_port, bool close_connection,
  1991. bool &connection_closed,
  1992. const std::function<void(Request &)> &setup_request,
  1993. bool *websocket_upgraded = nullptr);
  1994. // Runs the per-connection serving loop and stops an exception thrown by a
  1995. // user callback from escaping the worker thread.
  1996. //
  1997. // process_request() wraps only routing() and the hooks before a WebSocket
  1998. // upgrade in a try/catch. Content providers, the post-routing, error,
  1999. // logging and expect-100 handlers and WebSocket handlers all run outside
  2000. // it, and the task queue calls the job without a catch, so an exception
  2001. // from any of those would terminate the process.
  2002. //
  2003. // No 500 is possible here: by the time a content provider runs, the status
  2004. // line and headers are already on the wire. Report it through the error
  2005. // logger and drop the connection, which is what the peer observes either
  2006. // way. Other connections are unaffected.
  2007. template <typename Serve> bool serve_guarded(Serve &&serve) const {
  2008. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  2009. return serve();
  2010. #else
  2011. try {
  2012. return serve();
  2013. } catch (...) {
  2014. // The error logger is a user callback too, so it must not be able to
  2015. // throw the guard back open.
  2016. try {
  2017. output_error_log(Error::UserCallbackException, nullptr);
  2018. } catch (...) {}
  2019. return false;
  2020. }
  2021. #endif
  2022. }
  2023. std::atomic<socket_t> svr_sock_{INVALID_SOCKET};
  2024. std::vector<std::string> trusted_proxies_;
  2025. size_t keep_alive_max_count_ = CPPHTTPLIB_KEEPALIVE_MAX_COUNT;
  2026. time_t keep_alive_timeout_sec_ = CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND;
  2027. time_t read_timeout_sec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND;
  2028. time_t read_timeout_usec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND;
  2029. time_t write_timeout_sec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND;
  2030. time_t write_timeout_usec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND;
  2031. time_t idle_interval_sec_ = CPPHTTPLIB_IDLE_INTERVAL_SECOND;
  2032. time_t idle_interval_usec_ = CPPHTTPLIB_IDLE_INTERVAL_USECOND;
  2033. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2034. bool compress_ = true;
  2035. bool static_file_compression_ = false;
  2036. size_t static_file_compression_min_length_ =
  2037. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH;
  2038. size_t static_file_compression_max_length_ =
  2039. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH;
  2040. time_t websocket_ping_interval_sec_ =
  2041. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  2042. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  2043. private:
  2044. using Handlers =
  2045. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, Handler>>;
  2046. using HandlersForContentReader =
  2047. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>,
  2048. HandlerWithContentReader>>;
  2049. // Both handler tables for one custom method live in a single entry, so that
  2050. // routing() needs only one map lookup per request to reach either of them.
  2051. struct CustomHandlerEntry {
  2052. Handlers handlers;
  2053. HandlersForContentReader handlers_for_content_reader;
  2054. };
  2055. using CustomHandlers = std::map<std::string, CustomHandlerEntry>;
  2056. static std::unique_ptr<detail::MatcherBase>
  2057. make_matcher(const std::string &pattern);
  2058. static const std::set<std::string> &builtin_methods();
  2059. CustomHandlerEntry *custom_entry_for_registration(const std::string &method);
  2060. const CustomHandlerEntry *find_custom_entry(const std::string &method) const;
  2061. template <typename H>
  2062. Server &add_handler(
  2063. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, H>> &handlers,
  2064. const std::string &pattern, H handler) {
  2065. handlers.emplace_back(make_matcher(pattern), std::move(handler));
  2066. return *this;
  2067. }
  2068. Server &set_error_handler_core(HandlerWithResponse handler, std::true_type);
  2069. Server &set_error_handler_core(Handler handler, std::false_type);
  2070. socket_t create_server_socket(const std::string &host, int port,
  2071. int socket_flags,
  2072. SocketOptions socket_options) const;
  2073. int bind_internal(const std::string &host, int port, int socket_flags);
  2074. bool listen_internal();
  2075. bool routing(Request &req, Response &res, Stream &strm,
  2076. bool skip_pre_routing);
  2077. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  2078. bool handle_exception(Request &req, Response &res);
  2079. #endif
  2080. bool handle_file_request(Request &req, Response &res);
  2081. bool check_if_not_modified(const Request &req, Response &res,
  2082. const std::string &etag, time_t mtime) const;
  2083. bool check_if_range(Request &req, const std::string &etag,
  2084. time_t mtime) const;
  2085. bool dispatch_request(Request &req, Response &res, const Handlers &handlers,
  2086. Stream &strm);
  2087. bool dispatch_request_for_content_reader(
  2088. Request &req, Response &res, ContentReader content_reader,
  2089. const HandlersForContentReader &handlers) const;
  2090. bool parse_request_line(const char *s, Request &req) const;
  2091. detail::EncodingType static_file_encoding(const Request &req,
  2092. const Response &res,
  2093. const std::string &content_type,
  2094. size_t length) const;
  2095. bool apply_static_file_compression(const Request &req, Response &res) const;
  2096. void apply_ranges(const Request &req, Response &res,
  2097. std::string &content_type, std::string &boundary) const;
  2098. bool write_response(Stream &strm, bool close_connection, Request &req,
  2099. Response &res);
  2100. bool write_response_with_content(Stream &strm, bool close_connection,
  2101. const Request &req, Response &res);
  2102. bool write_response_core(Stream &strm, bool close_connection,
  2103. const Request &req, Response &res,
  2104. bool need_apply_ranges);
  2105. bool write_content_with_provider(Stream &strm, const Request &req,
  2106. Response &res, const std::string &boundary,
  2107. const std::string &content_type);
  2108. bool read_content(Stream &strm, Request &req, Response &res);
  2109. bool read_content_with_content_receiver(Stream &strm, Request &req,
  2110. Response &res,
  2111. ContentReceiver receiver,
  2112. FormDataHeader multipart_header,
  2113. ContentReceiver multipart_receiver);
  2114. bool read_content_core(Stream &strm, Request &req, Response &res,
  2115. ContentReceiver receiver,
  2116. FormDataHeader multipart_header,
  2117. ContentReceiver multipart_receiver) const;
  2118. virtual bool process_and_close_socket(socket_t sock);
  2119. void output_log(const Request &req, const Response &res) const;
  2120. void output_pre_compression_log(const Request &req,
  2121. const Response &res) const;
  2122. void output_error_log(const Error &err, const Request *req) const;
  2123. std::atomic<bool> is_running_{false};
  2124. std::atomic<bool> is_decommissioned{false};
  2125. // Set when CustomRoute() refuses a registration. Written before listen(),
  2126. // read by is_valid() on the same thread, so it needs no synchronization.
  2127. bool has_invalid_registration_ = false;
  2128. struct MountPointEntry {
  2129. std::string mount_point;
  2130. std::string base_dir;
  2131. std::string resolved_base_dir;
  2132. Headers headers;
  2133. };
  2134. std::vector<MountPointEntry> base_dirs_;
  2135. std::map<std::string, std::string> file_extension_and_mimetype_map_;
  2136. std::string default_file_mimetype_ = "application/octet-stream";
  2137. Handler file_request_handler_;
  2138. Handlers get_handlers_;
  2139. Handlers post_handlers_;
  2140. HandlersForContentReader post_handlers_for_content_reader_;
  2141. Handlers put_handlers_;
  2142. HandlersForContentReader put_handlers_for_content_reader_;
  2143. Handlers patch_handlers_;
  2144. HandlersForContentReader patch_handlers_for_content_reader_;
  2145. Handlers delete_handlers_;
  2146. HandlersForContentReader delete_handlers_for_content_reader_;
  2147. Handlers options_handlers_;
  2148. CustomHandlers custom_handlers_;
  2149. struct WebSocketHandlerEntry {
  2150. std::unique_ptr<detail::MatcherBase> matcher;
  2151. WebSocketHandler handler;
  2152. SubProtocolSelector sub_protocol_selector;
  2153. };
  2154. using WebSocketHandlers = std::vector<WebSocketHandlerEntry>;
  2155. WebSocketHandlers websocket_handlers_;
  2156. HandlerWithResponse error_handler_;
  2157. ExceptionHandler exception_handler_;
  2158. HandlerWithResponse pre_routing_handler_;
  2159. Handler post_routing_handler_;
  2160. HandlerWithResponse pre_request_handler_;
  2161. Expect100ContinueHandler expect_100_continue_handler_;
  2162. StartHandler start_handler_;
  2163. mutable std::mutex logger_mutex_;
  2164. Logger logger_;
  2165. Logger pre_compression_logger_;
  2166. ErrorLogger error_logger_;
  2167. int address_family_ = AF_UNSPEC;
  2168. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2169. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2170. SocketOptions socket_options_ = default_socket_options;
  2171. Headers default_headers_;
  2172. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2173. detail::write_headers;
  2174. };
  2175. class Result {
  2176. public:
  2177. Result() = default;
  2178. Result(std::unique_ptr<Response> &&res, Error err,
  2179. Headers &&request_headers = Headers{})
  2180. : res_(std::move(res)), err_(err),
  2181. request_headers_(std::move(request_headers)) {}
  2182. // Response
  2183. operator bool() const { return res_ != nullptr; }
  2184. bool operator==(std::nullptr_t) const { return res_ == nullptr; }
  2185. bool operator!=(std::nullptr_t) const { return res_ != nullptr; }
  2186. const Response &value() const { return *res_; }
  2187. Response &value() { return *res_; }
  2188. const Response &operator*() const { return *res_; }
  2189. Response &operator*() { return *res_; }
  2190. const Response *operator->() const { return res_.get(); }
  2191. Response *operator->() { return res_.get(); }
  2192. // Error
  2193. Error error() const { return err_; }
  2194. // Request Headers
  2195. bool has_request_header(const std::string &key) const;
  2196. std::string get_request_header_value(const std::string &key,
  2197. const char *def = "",
  2198. size_t id = 0) const;
  2199. size_t get_request_header_value_u64(const std::string &key, size_t def = 0,
  2200. size_t id = 0) const;
  2201. size_t get_request_header_value_count(const std::string &key) const;
  2202. private:
  2203. std::unique_ptr<Response> res_;
  2204. Error err_ = Error::Unknown;
  2205. Headers request_headers_;
  2206. #ifdef CPPHTTPLIB_SSL_ENABLED
  2207. public:
  2208. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2209. int ssl_error)
  2210. : res_(std::move(res)), err_(err),
  2211. request_headers_(std::move(request_headers)), ssl_error_(ssl_error) {}
  2212. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2213. int ssl_error, uint64_t ssl_backend_error)
  2214. : res_(std::move(res)), err_(err),
  2215. request_headers_(std::move(request_headers)), ssl_error_(ssl_error),
  2216. ssl_backend_error_(ssl_backend_error) {}
  2217. int ssl_error() const { return ssl_error_; }
  2218. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  2219. private:
  2220. int ssl_error_ = 0;
  2221. uint64_t ssl_backend_error_ = 0;
  2222. #endif
  2223. };
  2224. struct ClientConnection {
  2225. socket_t sock = INVALID_SOCKET;
  2226. bool is_open() const { return sock != INVALID_SOCKET; }
  2227. ClientConnection() = default;
  2228. ~ClientConnection();
  2229. ClientConnection(const ClientConnection &) = delete;
  2230. ClientConnection &operator=(const ClientConnection &) = delete;
  2231. ClientConnection(ClientConnection &&other) noexcept
  2232. : sock(other.sock)
  2233. #ifdef CPPHTTPLIB_SSL_ENABLED
  2234. ,
  2235. session(other.session)
  2236. #endif
  2237. {
  2238. other.sock = INVALID_SOCKET;
  2239. #ifdef CPPHTTPLIB_SSL_ENABLED
  2240. other.session = nullptr;
  2241. #endif
  2242. }
  2243. ClientConnection &operator=(ClientConnection &&other) noexcept {
  2244. if (this != &other) {
  2245. sock = other.sock;
  2246. other.sock = INVALID_SOCKET;
  2247. #ifdef CPPHTTPLIB_SSL_ENABLED
  2248. session = other.session;
  2249. other.session = nullptr;
  2250. #endif
  2251. }
  2252. return *this;
  2253. }
  2254. #ifdef CPPHTTPLIB_SSL_ENABLED
  2255. tls::session_t session = nullptr;
  2256. #endif
  2257. };
  2258. namespace detail {
  2259. struct ChunkedDecoder;
  2260. struct BodyReader {
  2261. Stream *stream = nullptr;
  2262. bool has_content_length = false;
  2263. size_t content_length = 0;
  2264. size_t payload_max_length = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2265. size_t bytes_read = 0;
  2266. bool chunked = false;
  2267. bool eof = false;
  2268. std::unique_ptr<ChunkedDecoder> chunked_decoder;
  2269. Error last_error = Error::Success;
  2270. ssize_t read(char *buf, size_t len);
  2271. bool has_error() const { return last_error != Error::Success; }
  2272. };
  2273. inline ssize_t read_body_content(Stream *stream, BodyReader &br, char *buf,
  2274. size_t len) {
  2275. (void)stream;
  2276. return br.read(buf, len);
  2277. }
  2278. class decompressor;
  2279. enum class NoProxyKind {
  2280. Wildcard, // "*"
  2281. HostnameSuffix, // "example.com" or ".example.com"
  2282. IPv4Cidr, // "10.0.0.0/8" (or single IP, treated as /32)
  2283. IPv6Cidr, // "fe80::/10" (or single IP, treated as /128)
  2284. };
  2285. // Unified 16-byte buffer holding either a v4 (first 4 bytes) or v6 address.
  2286. // Lets one CIDR matcher cover both families.
  2287. using IPBytes = std::array<uint8_t, 16>;
  2288. struct NoProxyEntry {
  2289. NoProxyKind kind = NoProxyKind::Wildcard;
  2290. std::string hostname_pattern; // lowercased, leading/trailing dot stripped
  2291. IPBytes net{};
  2292. int prefix_bits = 0;
  2293. };
  2294. struct NormalizedTarget {
  2295. std::string hostname; // lowercase; brackets and trailing dot removed
  2296. bool is_ipv4 = false;
  2297. bool is_ipv6 = false;
  2298. IPBytes ip{};
  2299. };
  2300. } // namespace detail
  2301. class ClientImpl {
  2302. public:
  2303. explicit ClientImpl(const std::string &host);
  2304. explicit ClientImpl(const std::string &host, int port);
  2305. explicit ClientImpl(const std::string &host, int port,
  2306. const std::string &client_cert_path,
  2307. const std::string &client_key_path);
  2308. virtual ~ClientImpl();
  2309. virtual bool is_valid() const;
  2310. struct StreamHandle {
  2311. std::unique_ptr<Response> response;
  2312. Error error = Error::Success;
  2313. StreamHandle() = default;
  2314. StreamHandle(const StreamHandle &) = delete;
  2315. StreamHandle &operator=(const StreamHandle &) = delete;
  2316. StreamHandle(StreamHandle &&) = default;
  2317. StreamHandle &operator=(StreamHandle &&) = default;
  2318. ~StreamHandle() = default;
  2319. bool is_valid() const {
  2320. return response != nullptr && error == Error::Success;
  2321. }
  2322. ssize_t read(char *buf, size_t len);
  2323. void parse_trailers_if_needed();
  2324. Error get_read_error() const { return body_reader_.last_error; }
  2325. bool has_read_error() const { return body_reader_.has_error(); }
  2326. bool trailers_parsed_ = false;
  2327. private:
  2328. friend class ClientImpl;
  2329. friend class sse::SSEClient;
  2330. ssize_t read_with_decompression(char *buf, size_t len);
  2331. std::unique_ptr<ClientConnection> connection_;
  2332. std::unique_ptr<Stream> socket_stream_;
  2333. Stream *stream_ = nullptr;
  2334. detail::BodyReader body_reader_;
  2335. std::unique_ptr<detail::decompressor> decompressor_;
  2336. std::string decompress_buffer_;
  2337. size_t decompress_offset_ = 0;
  2338. size_t decompressed_bytes_read_ = 0;
  2339. };
  2340. // clang-format off
  2341. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2342. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2343. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2344. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2345. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2346. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2347. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2348. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2349. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2350. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2351. Result Head(const std::string &path);
  2352. Result Head(const std::string &path, const Headers &headers);
  2353. Result Post(const std::string &path);
  2354. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2355. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2356. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2357. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2358. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2359. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2360. Result Post(const std::string &path, const Params &params);
  2361. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2362. Result Post(const std::string &path, const Headers &headers);
  2363. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2364. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2365. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2366. 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);
  2367. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2368. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2369. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2370. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2371. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2372. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2373. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2374. Result Put(const std::string &path);
  2375. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2376. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2377. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2378. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2379. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2380. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2381. Result Put(const std::string &path, const Params &params);
  2382. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2383. Result Put(const std::string &path, const Headers &headers);
  2384. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2385. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2386. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2387. 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);
  2388. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2389. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2390. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2391. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2392. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2393. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2394. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2395. Result Patch(const std::string &path);
  2396. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2397. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2398. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2399. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2400. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2401. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2402. Result Patch(const std::string &path, const Params &params);
  2403. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2404. Result Patch(const std::string &path, const Headers &headers, UploadProgress progress = nullptr);
  2405. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2406. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2407. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2408. 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);
  2409. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2410. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2411. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2412. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2413. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2414. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2415. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2416. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2417. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2418. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2419. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2420. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2421. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2422. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2423. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2424. Result Options(const std::string &path);
  2425. Result Options(const std::string &path, const Headers &headers);
  2426. // clang-format on
  2427. // Streaming API: Open a stream for reading response body incrementally
  2428. // Socket ownership is transferred to StreamHandle for true streaming
  2429. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2430. StreamHandle open_stream(const std::string &method, const std::string &path,
  2431. const Params &params = {},
  2432. const Headers &headers = {},
  2433. const std::string &body = {},
  2434. const std::string &content_type = {});
  2435. bool send(Request &req, Response &res, Error &error);
  2436. Result send(const Request &req);
  2437. void stop();
  2438. std::string host() const;
  2439. int port() const;
  2440. size_t is_socket_open() const;
  2441. socket_t socket() const;
  2442. [[deprecated("Use set_direct_hostname_addr_map() instead.")]]
  2443. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2444. void
  2445. set_direct_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2446. void
  2447. set_tunnel_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2448. void set_default_headers(Headers headers);
  2449. void
  2450. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2451. void set_address_family(int family);
  2452. void set_tcp_nodelay(bool on);
  2453. void set_ipv6_v6only(bool on);
  2454. void set_socket_options(SocketOptions socket_options);
  2455. void set_connection_timeout(time_t sec, time_t usec = 0);
  2456. template <class Rep, class Period>
  2457. void
  2458. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2459. void set_read_timeout(time_t sec, time_t usec = 0);
  2460. template <class Rep, class Period>
  2461. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2462. void set_write_timeout(time_t sec, time_t usec = 0);
  2463. template <class Rep, class Period>
  2464. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2465. void set_max_timeout(time_t msec);
  2466. template <class Rep, class Period>
  2467. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2468. void set_basic_auth(const std::string &username, const std::string &password);
  2469. void set_bearer_token_auth(const std::string &token);
  2470. void set_keep_alive(bool on);
  2471. void set_follow_location(bool on);
  2472. void set_path_encode(bool on);
  2473. void set_compress(bool on);
  2474. void set_decompress(bool on);
  2475. void set_payload_max_length(size_t length);
  2476. void set_interface(const std::string &intf);
  2477. void set_proxy(const std::string &host, int port);
  2478. void set_proxy_basic_auth(const std::string &username,
  2479. const std::string &password);
  2480. void set_proxy_bearer_token_auth(const std::string &token);
  2481. void set_no_proxy(const std::vector<std::string> &patterns);
  2482. void set_logger(Logger logger);
  2483. void set_error_logger(ErrorLogger error_logger);
  2484. protected:
  2485. struct Socket {
  2486. socket_t sock = INVALID_SOCKET;
  2487. // For Mbed TLS compatibility: start_time for request timeout tracking
  2488. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  2489. bool is_open() const { return sock != INVALID_SOCKET; }
  2490. #ifdef CPPHTTPLIB_SSL_ENABLED
  2491. tls::session_t ssl = nullptr;
  2492. #endif
  2493. };
  2494. virtual bool create_and_connect_socket(Socket &socket, Error &error);
  2495. virtual bool ensure_socket_connection(Socket &socket, Error &error);
  2496. virtual bool setup_proxy_connection(
  2497. Socket &socket,
  2498. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2499. Response &res, bool &success, Error &error);
  2500. bool is_proxy_enabled_for_host(const std::string &host) const;
  2501. // All of:
  2502. // shutdown_ssl
  2503. // shutdown_socket
  2504. // close_socket
  2505. // disconnect
  2506. // should ONLY be called when socket_mutex_ is locked, and only when
  2507. // no other thread is using the socket.
  2508. virtual void shutdown_ssl(Socket &socket, bool shutdown_gracefully);
  2509. void shutdown_socket(Socket &socket) const;
  2510. void close_socket(Socket &socket);
  2511. void disconnect(bool gracefully);
  2512. // Under socket_mutex_: whether the connection kept alive can take another
  2513. // request. One the peer has closed, or one set up under TLS settings changed
  2514. // since, is closed instead.
  2515. bool socket_reusable();
  2516. // TLS settings apply as a connection is set up, so a change makes the
  2517. // connection kept alive unfit for the next request.
  2518. void tls_settings_changed() { tls_settings_version_++; }
  2519. std::string make_request_target(const Request &req) const;
  2520. bool process_request(Stream &strm, Request &req, Response &res,
  2521. bool close_connection, Error &error);
  2522. bool write_content_with_provider(Stream &strm, const Request &req,
  2523. Error &error) const;
  2524. void output_log(const Request &req, const Response &res) const;
  2525. void output_error_log(const Error &err, const Request *req) const;
  2526. // Socket endpoint information
  2527. const std::string host_;
  2528. const int port_;
  2529. // Current open socket
  2530. Socket socket_;
  2531. mutable std::mutex socket_mutex_;
  2532. std::recursive_mutex request_mutex_;
  2533. // How many send() calls are running on this client, guarded by
  2534. // request_mutex_
  2535. size_t send_depth_ = 0;
  2536. // These are all protected under socket_mutex
  2537. size_t socket_requests_in_flight_ = 0;
  2538. std::thread::id socket_requests_are_from_thread_ = std::thread::id();
  2539. bool socket_should_be_closed_when_request_is_done_ = false;
  2540. size_t socket_tls_settings_version_ = 0;
  2541. std::atomic<size_t> tls_settings_version_{0};
  2542. // Hostname to connection target map. The value is an IP literal or another
  2543. // hostname; only the connection target changes, never the identity.
  2544. std::map<std::string, std::string> addr_map_;
  2545. // Hostname to CONNECT target map, used only through a proxy.
  2546. std::map<std::string, std::string> tunnel_addr_map_;
  2547. // Default headers
  2548. Headers default_headers_;
  2549. // Header writer
  2550. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2551. detail::write_headers;
  2552. // Settings
  2553. std::string client_cert_path_;
  2554. std::string client_key_path_;
  2555. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  2556. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  2557. time_t read_timeout_sec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND;
  2558. time_t read_timeout_usec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND;
  2559. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  2560. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  2561. time_t max_timeout_msec_ = CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND;
  2562. std::string basic_auth_username_;
  2563. std::string basic_auth_password_;
  2564. std::string bearer_token_auth_token_;
  2565. bool keep_alive_ = false;
  2566. bool follow_location_ = false;
  2567. bool path_encode_ = true;
  2568. int address_family_ = AF_UNSPEC;
  2569. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2570. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2571. SocketOptions socket_options_ = nullptr;
  2572. bool compress_ = false;
  2573. bool decompress_ = true;
  2574. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2575. bool has_payload_max_length_ = false;
  2576. std::string interface_;
  2577. std::string proxy_host_;
  2578. int proxy_port_ = -1;
  2579. std::string proxy_basic_auth_username_;
  2580. std::string proxy_basic_auth_password_;
  2581. std::string proxy_bearer_token_auth_token_;
  2582. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  2583. mutable detail::NormalizedTarget host_normalized_;
  2584. mutable bool host_normalized_valid_ = false;
  2585. mutable std::mutex logger_mutex_;
  2586. Logger logger_;
  2587. ErrorLogger error_logger_;
  2588. private:
  2589. bool send_(Request &req, Response &res, Error &error);
  2590. Result send_(Request &&req);
  2591. socket_t create_client_socket(Error &error) const;
  2592. bool read_response_line(Stream &strm, const Request &req, Response &res,
  2593. bool skip_100_continue = true) const;
  2594. bool write_request(Stream &strm, Request &req, bool close_connection,
  2595. Error &error, bool skip_body, bool &rejected_locally);
  2596. bool write_request_body(Stream &strm, Request &req, Error &error);
  2597. void prepare_default_headers(Request &r, bool for_stream,
  2598. const std::string &ct);
  2599. bool redirect(Request &req, Response &res, Error &error);
  2600. bool create_redirect_client(const std::string &scheme,
  2601. const std::string &host, int port, Request &req,
  2602. Response &res, const std::string &path,
  2603. const std::string &location, Error &error);
  2604. template <typename ClientType> void setup_redirect_client(ClientType &client);
  2605. bool handle_request(Stream &strm, Request &req, Response &res,
  2606. bool close_connection, Error &error);
  2607. std::unique_ptr<Response> send_with_content_provider_and_receiver(
  2608. Request &req, const char *body, size_t content_length,
  2609. ContentProvider content_provider,
  2610. ContentProviderWithoutLength content_provider_without_length,
  2611. const std::string &content_type, ContentReceiver content_receiver,
  2612. Error &error);
  2613. Result send_with_content_provider_and_receiver(
  2614. const std::string &method, const std::string &path,
  2615. const Headers &headers, const char *body, size_t content_length,
  2616. ContentProvider content_provider,
  2617. ContentProviderWithoutLength content_provider_without_length,
  2618. const std::string &content_type, ContentReceiver content_receiver,
  2619. UploadProgress progress);
  2620. ContentProviderWithoutLength get_multipart_content_provider(
  2621. const std::string &boundary, const UploadFormDataItems &items,
  2622. const FormDataProviderItems &provider_items) const;
  2623. virtual bool
  2624. process_socket(const Socket &socket,
  2625. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2626. std::function<bool(Stream &strm)> callback);
  2627. virtual bool is_ssl() const;
  2628. void transfer_socket_ownership_to_handle(StreamHandle &handle);
  2629. StreamHandle open_stream_(Request &req);
  2630. void add_credential_headers(Request &req);
  2631. std::string proxy_target_prefix() const;
  2632. #ifdef CPPHTTPLIB_SSL_ENABLED
  2633. public:
  2634. void set_digest_auth(const std::string &username,
  2635. const std::string &password);
  2636. void set_proxy_digest_auth(const std::string &username,
  2637. const std::string &password);
  2638. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2639. const std::string &ca_cert_dir_path = std::string());
  2640. void enable_server_certificate_verification(bool enabled);
  2641. void enable_server_hostname_verification(bool enabled);
  2642. void enable_system_ca(bool enabled);
  2643. protected:
  2644. std::string digest_auth_username_;
  2645. std::string digest_auth_password_;
  2646. std::string proxy_digest_auth_username_;
  2647. std::string proxy_digest_auth_password_;
  2648. std::string ca_cert_file_path_;
  2649. std::string ca_cert_dir_path_;
  2650. bool server_certificate_verification_ = true;
  2651. bool server_hostname_verification_ = true;
  2652. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  2653. std::string ca_cert_pem_; // Store CA cert PEM for redirect transfer
  2654. int last_ssl_error_ = 0;
  2655. uint64_t last_backend_error_ = 0;
  2656. #endif
  2657. };
  2658. namespace detail {
  2659. // Stands in for a client that Client could not make from its arguments, so a
  2660. // request fails rather than going through a null pointer.
  2661. class InvalidClientImpl final : public ClientImpl {
  2662. public:
  2663. InvalidClientImpl() : ClientImpl(std::string(), 0) {}
  2664. bool is_valid() const override { return false; }
  2665. private:
  2666. bool create_and_connect_socket(Socket &, Error &error) override {
  2667. error = Error::Connection;
  2668. return false;
  2669. }
  2670. };
  2671. } // namespace detail
  2672. class Client {
  2673. public:
  2674. // Universal interface
  2675. explicit Client(const std::string &scheme_host_port);
  2676. explicit Client(const std::string &scheme_host_port,
  2677. const std::string &client_cert_path,
  2678. const std::string &client_key_path);
  2679. // HTTP only interface
  2680. explicit Client(const std::string &host, int port);
  2681. explicit Client(const std::string &host, int port,
  2682. const std::string &client_cert_path,
  2683. const std::string &client_key_path);
  2684. Client(Client &&) = default;
  2685. Client &operator=(Client &&) = default;
  2686. ~Client();
  2687. bool is_valid() const;
  2688. // clang-format off
  2689. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2690. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2691. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2692. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2693. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2694. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2695. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2696. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2697. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2698. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2699. Result Head(const std::string &path);
  2700. Result Head(const std::string &path, const Headers &headers);
  2701. Result Post(const std::string &path);
  2702. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2703. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2704. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2705. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2706. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2707. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2708. Result Post(const std::string &path, const Params &params);
  2709. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2710. Result Post(const std::string &path, const Headers &headers);
  2711. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2712. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2713. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2714. 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);
  2715. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2716. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2717. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2718. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2719. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2720. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2721. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2722. Result Put(const std::string &path);
  2723. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2724. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2725. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2726. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2727. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2728. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2729. Result Put(const std::string &path, const Params &params);
  2730. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2731. Result Put(const std::string &path, const Headers &headers);
  2732. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2733. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2734. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2735. 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);
  2736. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2737. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2738. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2739. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2740. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2741. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2742. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2743. Result Patch(const std::string &path);
  2744. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2745. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2746. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2747. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2748. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2749. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2750. Result Patch(const std::string &path, const Params &params);
  2751. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2752. Result Patch(const std::string &path, const Headers &headers);
  2753. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2754. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2755. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2756. 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);
  2757. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2758. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2759. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2760. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2761. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2762. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2763. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2764. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2765. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2766. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2767. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2768. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2769. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2770. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2771. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2772. Result Options(const std::string &path);
  2773. Result Options(const std::string &path, const Headers &headers);
  2774. // clang-format on
  2775. // Streaming API: Open a stream for reading response body incrementally
  2776. // Socket ownership is transferred to StreamHandle for true streaming
  2777. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2778. ClientImpl::StreamHandle open_stream(const std::string &method,
  2779. const std::string &path,
  2780. const Params &params = {},
  2781. const Headers &headers = {},
  2782. const std::string &body = {},
  2783. const std::string &content_type = {});
  2784. bool send(Request &req, Response &res, Error &error);
  2785. Result send(const Request &req);
  2786. void stop();
  2787. std::string host() const;
  2788. int port() const;
  2789. size_t is_socket_open() const;
  2790. socket_t socket() const;
  2791. [[deprecated("Use set_direct_hostname_addr_map() instead.")]]
  2792. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2793. void
  2794. set_direct_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2795. void
  2796. set_tunnel_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2797. void set_default_headers(Headers headers);
  2798. void
  2799. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2800. void set_address_family(int family);
  2801. void set_tcp_nodelay(bool on);
  2802. void set_socket_options(SocketOptions socket_options);
  2803. void set_connection_timeout(time_t sec, time_t usec = 0);
  2804. template <class Rep, class Period>
  2805. void
  2806. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2807. void set_read_timeout(time_t sec, time_t usec = 0);
  2808. template <class Rep, class Period>
  2809. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2810. void set_write_timeout(time_t sec, time_t usec = 0);
  2811. template <class Rep, class Period>
  2812. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2813. void set_max_timeout(time_t msec);
  2814. template <class Rep, class Period>
  2815. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2816. void set_basic_auth(const std::string &username, const std::string &password);
  2817. void set_bearer_token_auth(const std::string &token);
  2818. void set_keep_alive(bool on);
  2819. void set_follow_location(bool on);
  2820. void set_path_encode(bool on);
  2821. void set_compress(bool on);
  2822. void set_decompress(bool on);
  2823. void set_payload_max_length(size_t length);
  2824. void set_interface(const std::string &intf);
  2825. void set_proxy(const std::string &host, int port);
  2826. void set_proxy_basic_auth(const std::string &username,
  2827. const std::string &password);
  2828. void set_proxy_bearer_token_auth(const std::string &token);
  2829. void set_no_proxy(const std::vector<std::string> &patterns);
  2830. void set_logger(Logger logger);
  2831. void set_error_logger(ErrorLogger error_logger);
  2832. private:
  2833. std::unique_ptr<ClientImpl> cli_;
  2834. #ifdef CPPHTTPLIB_SSL_ENABLED
  2835. public:
  2836. void set_digest_auth(const std::string &username,
  2837. const std::string &password);
  2838. void set_proxy_digest_auth(const std::string &username,
  2839. const std::string &password);
  2840. void enable_server_certificate_verification(bool enabled);
  2841. void enable_server_hostname_verification(bool enabled);
  2842. void enable_system_ca(bool enabled);
  2843. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2844. const std::string &ca_cert_dir_path = std::string());
  2845. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2846. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2847. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2848. void set_session_verifier(
  2849. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2850. tls::ctx_t tls_context() const;
  2851. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2852. void enable_windows_certificate_verification(bool enabled);
  2853. #endif
  2854. private:
  2855. bool is_ssl_ = false;
  2856. #endif
  2857. };
  2858. #ifdef CPPHTTPLIB_SSL_ENABLED
  2859. class SSLServer : public Server {
  2860. public:
  2861. SSLServer(const char *cert_path, const char *private_key_path,
  2862. const char *client_ca_cert_file_path = nullptr,
  2863. const char *client_ca_cert_dir_path = nullptr,
  2864. const char *private_key_password = nullptr);
  2865. struct PemMemory {
  2866. const char *cert_pem;
  2867. size_t cert_pem_len;
  2868. const char *key_pem;
  2869. size_t key_pem_len;
  2870. const char *client_ca_pem;
  2871. size_t client_ca_pem_len;
  2872. const char *private_key_password;
  2873. };
  2874. explicit SSLServer(const PemMemory &pem);
  2875. // The callback receives the ctx_t handle which can be cast to the
  2876. // appropriate backend type (SSL_CTX* for OpenSSL,
  2877. // tls::impl::MbedTlsContext* for Mbed TLS)
  2878. explicit SSLServer(const tls::ContextSetupCallback &setup_callback);
  2879. ~SSLServer() override;
  2880. bool is_valid() const override;
  2881. bool update_certs_pem(const char *cert_pem, const char *key_pem,
  2882. const char *client_ca_pem = nullptr,
  2883. const char *password = nullptr);
  2884. tls::ctx_t tls_context() const { return ctx_; }
  2885. int ssl_last_error() const { return last_ssl_error_; }
  2886. private:
  2887. bool process_and_close_socket(socket_t sock) override;
  2888. tls::ctx_t ctx_ = nullptr;
  2889. // update_certs_pem() replaces the certificates and CAs that handshakes read
  2890. // from ctx_, so it waits for the handshakes in progress, which their timeout
  2891. // bounds, and new ones wait while it is pending so that they cannot keep it
  2892. // waiting.
  2893. std::mutex ctx_mutex_;
  2894. std::condition_variable ctx_cv_;
  2895. size_t handshakes_in_progress_ = 0;
  2896. size_t updates_pending_ = 0;
  2897. int last_ssl_error_ = 0;
  2898. };
  2899. class SSLClient final : public ClientImpl {
  2900. public:
  2901. explicit SSLClient(const std::string &host);
  2902. explicit SSLClient(const std::string &host, int port);
  2903. explicit SSLClient(const std::string &host, int port,
  2904. const std::string &client_cert_path,
  2905. const std::string &client_key_path,
  2906. const std::string &private_key_password = std::string());
  2907. struct PemMemory {
  2908. const char *cert_pem;
  2909. size_t cert_pem_len;
  2910. const char *key_pem;
  2911. size_t key_pem_len;
  2912. const char *private_key_password;
  2913. };
  2914. explicit SSLClient(const std::string &host, int port, const PemMemory &pem);
  2915. ~SSLClient() override;
  2916. bool is_valid() const override;
  2917. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2918. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2919. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2920. // Post-handshake session verifier (backend-independent)
  2921. void set_session_verifier(
  2922. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2923. tls::ctx_t tls_context() const { return ctx_; }
  2924. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2925. void enable_windows_certificate_verification(bool enabled);
  2926. #endif
  2927. private:
  2928. bool create_and_connect_socket(Socket &socket, Error &error) override;
  2929. bool ensure_socket_connection(Socket &socket, Error &error) override;
  2930. void shutdown_ssl(Socket &socket, bool shutdown_gracefully) override;
  2931. void shutdown_ssl_impl(Socket &socket, bool shutdown_gracefully);
  2932. bool
  2933. process_socket(const Socket &socket,
  2934. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2935. std::function<bool(Stream &strm)> callback) override;
  2936. bool is_ssl() const override;
  2937. bool setup_proxy_connection(
  2938. Socket &socket,
  2939. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2940. Response &res, bool &success, Error &error) override;
  2941. bool connect_with_proxy(
  2942. Socket &sock,
  2943. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2944. Response &res, bool &success, Error &error);
  2945. bool initialize_ssl(Socket &socket, Error &error);
  2946. void init_ctx();
  2947. void reset_ctx_on_error();
  2948. bool load_certs();
  2949. tls::ctx_t ctx_ = nullptr;
  2950. std::mutex ctx_mutex_;
  2951. std::once_flag initialize_cert_;
  2952. // Tracks whether a custom CA store was applied via set_ca_cert_store(),
  2953. // since the store handle itself is owned by ctx_ and leaves no other trace.
  2954. bool ca_cert_store_set_ = false;
  2955. // Set by set_ca_cert_store() and load_ca_cert_store() even when they bring
  2956. // no certificate, so that a CA that failed to come through fails
  2957. // verification instead of letting the system CAs in.
  2958. bool custom_ca_loaded_ = false;
  2959. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  2960. // Like ca_cert_store_set_, keeps what ctx_ cannot report back: the verifier
  2961. // set_server_certificate_verifier() installed there.
  2962. tls::VerifyCallback server_certificate_verifier_;
  2963. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2964. bool enable_windows_cert_verification_ = true;
  2965. #endif
  2966. friend class ClientImpl;
  2967. };
  2968. #endif // CPPHTTPLIB_SSL_ENABLED
  2969. namespace detail {
  2970. template <typename T, typename U>
  2971. inline void duration_to_sec_and_usec(const T &duration, U callback) {
  2972. auto sec = std::chrono::duration_cast<std::chrono::seconds>(duration).count();
  2973. auto usec = std::chrono::duration_cast<std::chrono::microseconds>(
  2974. duration - std::chrono::seconds(sec))
  2975. .count();
  2976. callback(static_cast<time_t>(sec), static_cast<time_t>(usec));
  2977. }
  2978. template <size_t N> inline constexpr size_t str_len(const char (&)[N]) {
  2979. return N - 1;
  2980. }
  2981. inline bool is_numeric(const std::string &str) {
  2982. return !str.empty() && std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  2983. }
  2984. // std::ranges::next(first, n, last) for C++11
  2985. template <typename It> inline It bounded_next(It first, size_t n, It last) {
  2986. for (; n > 0 && first != last; --n) {
  2987. ++first;
  2988. }
  2989. return first;
  2990. }
  2991. inline size_t get_header_value_u64(const Headers &headers,
  2992. const std::string &key, size_t def,
  2993. size_t id, bool &is_invalid_value) {
  2994. is_invalid_value = false;
  2995. auto rng = headers.equal_range(key);
  2996. auto it = bounded_next(rng.first, id, rng.second);
  2997. if (it != rng.second) {
  2998. if (is_numeric(it->second)) {
  2999. // Parse at size_t width so an out-of-range Content-Length is reported
  3000. // rather than silently saturated/truncated (a value above 2^32 would
  3001. // otherwise wrap to a small framing length on 32-bit builds). Flag it
  3002. // and return SIZE_MAX so the existing oversized-value guards reject it.
  3003. size_t val = 0;
  3004. const auto &s = it->second;
  3005. auto r = from_chars(s.data(), s.data() + s.size(), val);
  3006. if (r.ec == std::errc::result_out_of_range) {
  3007. is_invalid_value = true;
  3008. return (std::numeric_limits<size_t>::max)();
  3009. }
  3010. return val;
  3011. } else {
  3012. is_invalid_value = true;
  3013. }
  3014. }
  3015. return def;
  3016. }
  3017. inline size_t get_header_value_u64(const Headers &headers,
  3018. const std::string &key, size_t def,
  3019. size_t id) {
  3020. auto dummy = false;
  3021. return get_header_value_u64(headers, key, def, id, dummy);
  3022. }
  3023. } // namespace detail
  3024. template <class Rep, class Period>
  3025. inline Server &
  3026. Server::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3027. detail::duration_to_sec_and_usec(
  3028. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3029. return *this;
  3030. }
  3031. template <class Rep, class Period>
  3032. inline Server &
  3033. Server::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3034. detail::duration_to_sec_and_usec(
  3035. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3036. return *this;
  3037. }
  3038. template <class Rep, class Period>
  3039. inline Server &
  3040. Server::set_idle_interval(const std::chrono::duration<Rep, Period> &duration) {
  3041. detail::duration_to_sec_and_usec(
  3042. duration, [&](time_t sec, time_t usec) { set_idle_interval(sec, usec); });
  3043. return *this;
  3044. }
  3045. template <class Rep, class Period>
  3046. inline void ClientImpl::set_connection_timeout(
  3047. const std::chrono::duration<Rep, Period> &duration) {
  3048. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  3049. set_connection_timeout(sec, usec);
  3050. });
  3051. }
  3052. template <class Rep, class Period>
  3053. inline void ClientImpl::set_read_timeout(
  3054. const std::chrono::duration<Rep, Period> &duration) {
  3055. detail::duration_to_sec_and_usec(
  3056. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3057. }
  3058. template <class Rep, class Period>
  3059. inline void ClientImpl::set_write_timeout(
  3060. const std::chrono::duration<Rep, Period> &duration) {
  3061. detail::duration_to_sec_and_usec(
  3062. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3063. }
  3064. template <class Rep, class Period>
  3065. inline void ClientImpl::set_max_timeout(
  3066. const std::chrono::duration<Rep, Period> &duration) {
  3067. auto msec =
  3068. std::chrono::duration_cast<std::chrono::milliseconds>(duration).count();
  3069. set_max_timeout(static_cast<time_t>(msec));
  3070. }
  3071. template <class Rep, class Period>
  3072. inline void Client::set_connection_timeout(
  3073. const std::chrono::duration<Rep, Period> &duration) {
  3074. cli_->set_connection_timeout(duration);
  3075. }
  3076. template <class Rep, class Period>
  3077. inline void
  3078. Client::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3079. cli_->set_read_timeout(duration);
  3080. }
  3081. template <class Rep, class Period>
  3082. inline void
  3083. Client::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3084. cli_->set_write_timeout(duration);
  3085. }
  3086. inline void Client::set_max_timeout(time_t msec) {
  3087. cli_->set_max_timeout(msec);
  3088. }
  3089. template <class Rep, class Period>
  3090. inline void
  3091. Client::set_max_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3092. cli_->set_max_timeout(duration);
  3093. }
  3094. /*
  3095. * Forward declarations and types that will be part of the .h file if split into
  3096. * .h + .cc.
  3097. */
  3098. std::string hosted_at(const std::string &hostname);
  3099. void hosted_at(const std::string &hostname, std::vector<std::string> &addrs);
  3100. // JavaScript-style URL encoding/decoding functions
  3101. std::string encode_uri_component(const std::string &value);
  3102. std::string encode_uri(const std::string &value);
  3103. std::string decode_uri_component(const std::string &value);
  3104. std::string decode_uri(const std::string &value);
  3105. // RFC 3986 compliant URL component encoding/decoding functions
  3106. std::string encode_path_component(const std::string &component);
  3107. std::string decode_path_component(const std::string &component);
  3108. std::string encode_query_component(const std::string &component,
  3109. bool space_as_plus = true);
  3110. std::string decode_query_component(const std::string &component,
  3111. bool plus_as_space = true);
  3112. std::string sanitize_filename(const std::string &filename);
  3113. std::string append_query_params(const std::string &path, const Params &params);
  3114. std::pair<std::string, std::string> make_range_header(const Ranges &ranges);
  3115. std::pair<std::string, std::string>
  3116. make_basic_authentication_header(const std::string &username,
  3117. const std::string &password,
  3118. bool is_proxy = false);
  3119. namespace detail {
  3120. #if defined(_WIN32)
  3121. inline std::wstring u8string_to_wstring(const char *s) {
  3122. if (!s) { return std::wstring(); }
  3123. auto len = static_cast<int>(strlen(s));
  3124. if (!len) { return std::wstring(); }
  3125. auto wlen = ::MultiByteToWideChar(CP_UTF8, 0, s, len, nullptr, 0);
  3126. if (!wlen) { return std::wstring(); }
  3127. std::wstring ws;
  3128. ws.resize(wlen);
  3129. wlen = ::MultiByteToWideChar(
  3130. CP_UTF8, 0, s, len,
  3131. const_cast<LPWSTR>(reinterpret_cast<LPCWSTR>(ws.data())), wlen);
  3132. if (wlen != static_cast<int>(ws.size())) { ws.clear(); }
  3133. return ws;
  3134. }
  3135. #endif
  3136. struct FileStat {
  3137. FileStat(const std::string &path);
  3138. bool is_file() const;
  3139. bool is_dir() const;
  3140. time_t mtime() const;
  3141. size_t size() const;
  3142. private:
  3143. #if defined(_WIN32)
  3144. struct _stat st_;
  3145. #else
  3146. struct stat st_;
  3147. #endif
  3148. int ret_ = -1;
  3149. };
  3150. std::string make_host_and_port_string(const std::string &host, int port,
  3151. bool is_ssl);
  3152. template <typename T>
  3153. bool check_and_write_headers(Stream &strm, Headers &headers, T header_writer,
  3154. Error &error);
  3155. bool write_data(Stream &strm, const char *d, size_t l);
  3156. std::string trim_copy(const std::string &s);
  3157. void divide(
  3158. const char *data, std::size_t size, char d,
  3159. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3160. fn);
  3161. void divide(
  3162. const std::string &str, char d,
  3163. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3164. fn);
  3165. void split(const char *b, const char *e, char d,
  3166. std::function<void(const char *, const char *)> fn);
  3167. void split(const char *b, const char *e, char d, size_t m,
  3168. std::function<void(const char *, const char *)> fn);
  3169. bool split_find(const char *b, const char *e, char d,
  3170. std::function<bool(const char *, const char *)> fn);
  3171. bool has_header_token(const Headers &headers, const std::string &key,
  3172. const std::string &token);
  3173. std::string websocket_accept_key(const std::string &client_key);
  3174. bool is_websocket_upgrade(const Request &req);
  3175. bool process_client_socket(
  3176. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  3177. time_t write_timeout_sec, time_t write_timeout_usec,
  3178. time_t max_timeout_msec,
  3179. std::chrono::time_point<std::chrono::steady_clock> start_time,
  3180. std::function<bool(Stream &)> callback);
  3181. socket_t create_client_socket(const std::string &host, const std::string &ip,
  3182. int port, int address_family, bool tcp_nodelay,
  3183. bool ipv6_v6only, SocketOptions socket_options,
  3184. time_t connection_timeout_sec,
  3185. time_t connection_timeout_usec,
  3186. time_t read_timeout_sec, time_t read_timeout_usec,
  3187. time_t write_timeout_sec,
  3188. time_t write_timeout_usec,
  3189. const std::string &intf, Error &error);
  3190. const char *get_header_value(const Headers &headers, const std::string &key,
  3191. const char *def, size_t id);
  3192. std::string get_combined_header_value(const Headers &headers,
  3193. const std::string &key);
  3194. std::string params_to_query_str(const Params &params);
  3195. void parse_query_text(const char *data, std::size_t size, Params &params);
  3196. void parse_query_text(const std::string &s, Params &params);
  3197. bool parse_multipart_boundary(const std::string &content_type,
  3198. std::string &boundary);
  3199. bool parse_range_header(const std::string &s, Ranges &ranges);
  3200. bool parse_accept_header(const std::string &s,
  3201. std::vector<std::string> &content_types);
  3202. void parse_disposition_params(const std::string &s, Params &params);
  3203. ssize_t send_socket(socket_t sock, const void *ptr, size_t size, int flags);
  3204. ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags);
  3205. EncodingType encoding_type(const Request &req, const std::string &content_type);
  3206. EncodingType encoding_type(const Request &req, const Response &res,
  3207. const std::string &content_type);
  3208. EncodingType encoding_type(const Request &req, const Response &res);
  3209. class BufferStream final : public Stream {
  3210. public:
  3211. BufferStream() = default;
  3212. ~BufferStream() override = default;
  3213. bool is_readable() const override;
  3214. bool wait_readable() const override;
  3215. bool wait_writable() const override;
  3216. ssize_t read(char *ptr, size_t size) override;
  3217. ssize_t write(const char *ptr, size_t size) override;
  3218. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  3219. void get_local_ip_and_port(std::string &ip, int &port) const override;
  3220. socket_t socket() const override;
  3221. time_t duration() const override;
  3222. const std::string &get_buffer() const;
  3223. private:
  3224. std::string buffer;
  3225. size_t position = 0;
  3226. };
  3227. class compressor {
  3228. public:
  3229. virtual ~compressor() = default;
  3230. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3231. virtual bool compress(const char *data, size_t data_length, bool last,
  3232. Callback callback) = 0;
  3233. };
  3234. class decompressor {
  3235. public:
  3236. virtual ~decompressor() = default;
  3237. virtual bool is_valid() const = 0;
  3238. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3239. virtual bool decompress(const char *data, size_t data_length,
  3240. Callback callback) = 0;
  3241. };
  3242. class nocompressor final : public compressor {
  3243. public:
  3244. ~nocompressor() override = default;
  3245. bool compress(const char *data, size_t data_length, bool /*last*/,
  3246. Callback callback) override;
  3247. };
  3248. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  3249. class gzip_compressor final : public compressor {
  3250. public:
  3251. gzip_compressor();
  3252. ~gzip_compressor() override;
  3253. bool compress(const char *data, size_t data_length, bool last,
  3254. Callback callback) override;
  3255. private:
  3256. bool is_valid_ = false;
  3257. z_stream strm_;
  3258. };
  3259. class gzip_decompressor final : public decompressor {
  3260. public:
  3261. gzip_decompressor();
  3262. ~gzip_decompressor() override;
  3263. bool is_valid() const override;
  3264. bool decompress(const char *data, size_t data_length,
  3265. Callback callback) override;
  3266. private:
  3267. bool is_valid_ = false;
  3268. z_stream strm_;
  3269. };
  3270. #endif
  3271. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  3272. class brotli_compressor final : public compressor {
  3273. public:
  3274. brotli_compressor();
  3275. ~brotli_compressor();
  3276. bool compress(const char *data, size_t data_length, bool last,
  3277. Callback callback) override;
  3278. private:
  3279. BrotliEncoderState *state_ = nullptr;
  3280. };
  3281. class brotli_decompressor final : public decompressor {
  3282. public:
  3283. brotli_decompressor();
  3284. ~brotli_decompressor();
  3285. bool is_valid() const override;
  3286. bool decompress(const char *data, size_t data_length,
  3287. Callback callback) override;
  3288. private:
  3289. BrotliDecoderResult decoder_r;
  3290. BrotliDecoderState *decoder_s = nullptr;
  3291. };
  3292. #endif
  3293. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  3294. class zstd_compressor : public compressor {
  3295. public:
  3296. zstd_compressor();
  3297. ~zstd_compressor();
  3298. bool compress(const char *data, size_t data_length, bool last,
  3299. Callback callback) override;
  3300. private:
  3301. ZSTD_CCtx *ctx_ = nullptr;
  3302. };
  3303. class zstd_decompressor : public decompressor {
  3304. public:
  3305. zstd_decompressor();
  3306. ~zstd_decompressor();
  3307. bool is_valid() const override;
  3308. bool decompress(const char *data, size_t data_length,
  3309. Callback callback) override;
  3310. private:
  3311. ZSTD_DCtx *ctx_ = nullptr;
  3312. };
  3313. #endif
  3314. // NOTE: until the read size reaches `fixed_buffer_size`, use `fixed_buffer`
  3315. // to store data. The call can set memory on stack for performance.
  3316. class stream_line_reader {
  3317. public:
  3318. stream_line_reader(Stream &strm, char *fixed_buffer,
  3319. size_t fixed_buffer_size);
  3320. const char *ptr() const;
  3321. size_t size() const;
  3322. bool end_with_crlf() const;
  3323. bool getline();
  3324. private:
  3325. void append(char c);
  3326. void append(const char *data, size_t size);
  3327. Stream &strm_;
  3328. char *fixed_buffer_;
  3329. const size_t fixed_buffer_size_;
  3330. size_t fixed_buffer_used_size_ = 0;
  3331. std::string growable_buffer_;
  3332. };
  3333. bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  3334. const Headers &src_headers);
  3335. struct ChunkedDecoder {
  3336. Stream &strm;
  3337. size_t chunk_remaining = 0;
  3338. bool finished = false;
  3339. char line_buf[64];
  3340. size_t last_chunk_total = 0;
  3341. size_t last_chunk_offset = 0;
  3342. size_t overhead = 0;
  3343. explicit ChunkedDecoder(Stream &s);
  3344. ssize_t read_payload(char *buf, size_t len, size_t &out_chunk_offset,
  3345. size_t &out_chunk_total);
  3346. bool parse_trailers_into(Headers &dest, const Headers &src_headers);
  3347. };
  3348. // A regular file opened to be served: mapped on Windows, read with pread()
  3349. // elsewhere.
  3350. class mmap {
  3351. public:
  3352. mmap(const char *path);
  3353. ~mmap();
  3354. bool open(const char *path);
  3355. void close();
  3356. bool is_open() const;
  3357. size_t size() const;
  3358. // Copies up to len bytes from offset into buf and returns how many: fewer,
  3359. // down to 0, if the file has shrunk since it was opened.
  3360. size_t read(size_t offset, char *buf, size_t len) const;
  3361. private:
  3362. #if defined(_WIN32)
  3363. HANDLE hFile_ = NULL;
  3364. HANDLE hMapping_ = NULL;
  3365. void *addr_ = nullptr;
  3366. bool is_open_empty_file = false;
  3367. #else
  3368. int fd_ = -1;
  3369. #endif
  3370. size_t size_ = 0;
  3371. };
  3372. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  3373. namespace fields {
  3374. bool is_token_char(char c);
  3375. bool is_token(const std::string &s);
  3376. bool is_field_name(const std::string &s);
  3377. bool is_vchar(char c);
  3378. bool is_obs_text(char c);
  3379. bool is_field_vchar(char c);
  3380. bool is_field_content(const std::string &s);
  3381. bool is_field_value(const std::string &s);
  3382. bool is_field_valid(const std::string &name, const std::string &value);
  3383. bool is_request_target(const std::string &s);
  3384. bool is_host(const std::string &s);
  3385. } // namespace fields
  3386. } // namespace detail
  3387. /*
  3388. * TLS Abstraction Layer Declarations
  3389. */
  3390. #ifdef CPPHTTPLIB_SSL_ENABLED
  3391. // TLS abstraction layer - backend-specific type declarations
  3392. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  3393. namespace tls {
  3394. namespace impl {
  3395. // Mbed TLS context wrapper (holds config, entropy, DRBG, CA chain, own
  3396. // cert/key). This struct is accessible via tls::impl for use in SSL context
  3397. // setup callbacks (cast ctx_t to tls::impl::MbedTlsContext*).
  3398. struct MbedTlsContext {
  3399. mbedtls_ssl_config conf;
  3400. #ifndef CPPHTTPLIB_MBEDTLS_V4
  3401. // Mbed TLS 4.x uses PSA Crypto's internal RNG; no explicit entropy/DRBG.
  3402. mbedtls_entropy_context entropy;
  3403. mbedtls_ctr_drbg_context ctr_drbg;
  3404. #endif
  3405. mbedtls_x509_crt ca_chain;
  3406. mbedtls_x509_crt own_cert;
  3407. mbedtls_pk_context own_key;
  3408. bool is_server = false;
  3409. // Peer certificate required (set_verify_client()); a client defaults to true
  3410. bool verify_client = false;
  3411. // Set by tls::set_verify_callback().
  3412. VerifyCallback verify_callback;
  3413. MbedTlsContext();
  3414. ~MbedTlsContext();
  3415. MbedTlsContext(const MbedTlsContext &) = delete;
  3416. MbedTlsContext &operator=(const MbedTlsContext &) = delete;
  3417. };
  3418. } // namespace impl
  3419. } // namespace tls
  3420. #endif
  3421. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  3422. namespace tls {
  3423. namespace impl {
  3424. // wolfSSL context wrapper (holds WOLFSSL_CTX and related state).
  3425. // This struct is accessible via tls::impl for use in SSL context
  3426. // setup callbacks (cast ctx_t to tls::impl::WolfSSLContext*).
  3427. struct WolfSSLContext {
  3428. WOLFSSL_CTX *ctx = nullptr;
  3429. bool is_server = false;
  3430. // Peer certificate required (set_verify_client()); a client defaults to true
  3431. bool verify_client = false;
  3432. // Replaced under verify_callback_mutex()
  3433. std::shared_ptr<VerifyCallback> verify_callback;
  3434. std::string ca_pem_data_; // accumulated PEM for get_ca_names/get_ca_certs
  3435. WolfSSLContext();
  3436. ~WolfSSLContext();
  3437. WolfSSLContext(const WolfSSLContext &) = delete;
  3438. WolfSSLContext &operator=(const WolfSSLContext &) = delete;
  3439. };
  3440. // CA store for wolfSSL: holds raw PEM bytes to allow reloading into any ctx
  3441. struct WolfSSLCAStore {
  3442. std::string pem_data;
  3443. };
  3444. } // namespace impl
  3445. } // namespace tls
  3446. #endif
  3447. #endif // CPPHTTPLIB_SSL_ENABLED
  3448. namespace stream {
  3449. class Result {
  3450. public:
  3451. Result();
  3452. explicit Result(ClientImpl::StreamHandle &&handle, size_t chunk_size = 8192);
  3453. Result(Result &&other) noexcept;
  3454. Result &operator=(Result &&other) noexcept;
  3455. Result(const Result &) = delete;
  3456. Result &operator=(const Result &) = delete;
  3457. // Response info
  3458. bool is_valid() const;
  3459. explicit operator bool() const;
  3460. int status() const;
  3461. const Headers &headers() const;
  3462. std::string get_header_value(const std::string &key,
  3463. const char *def = "") const;
  3464. bool has_header(const std::string &key) const;
  3465. Error error() const;
  3466. Error read_error() const;
  3467. bool has_read_error() const;
  3468. // Stream reading
  3469. bool next();
  3470. const char *data() const;
  3471. size_t size() const;
  3472. std::string read_all();
  3473. private:
  3474. ClientImpl::StreamHandle handle_;
  3475. std::string buffer_;
  3476. size_t current_size_ = 0;
  3477. size_t chunk_size_;
  3478. bool finished_ = false;
  3479. };
  3480. // GET
  3481. template <typename ClientType>
  3482. inline Result Get(ClientType &cli, const std::string &path,
  3483. size_t chunk_size = 8192) {
  3484. return Result{cli.open_stream("GET", path), chunk_size};
  3485. }
  3486. template <typename ClientType>
  3487. inline Result Get(ClientType &cli, const std::string &path,
  3488. const Headers &headers, size_t chunk_size = 8192) {
  3489. return Result{cli.open_stream("GET", path, {}, headers), chunk_size};
  3490. }
  3491. template <typename ClientType>
  3492. inline Result Get(ClientType &cli, const std::string &path,
  3493. const Params &params, size_t chunk_size = 8192) {
  3494. return Result{cli.open_stream("GET", path, params), chunk_size};
  3495. }
  3496. template <typename ClientType>
  3497. inline Result Get(ClientType &cli, const std::string &path,
  3498. const Params &params, const Headers &headers,
  3499. size_t chunk_size = 8192) {
  3500. return Result{cli.open_stream("GET", path, params, headers), chunk_size};
  3501. }
  3502. // POST
  3503. template <typename ClientType>
  3504. inline Result Post(ClientType &cli, const std::string &path,
  3505. const std::string &body, const std::string &content_type,
  3506. size_t chunk_size = 8192) {
  3507. return Result{cli.open_stream("POST", path, {}, {}, body, content_type),
  3508. chunk_size};
  3509. }
  3510. template <typename ClientType>
  3511. inline Result Post(ClientType &cli, const std::string &path,
  3512. const Headers &headers, const std::string &body,
  3513. const std::string &content_type, size_t chunk_size = 8192) {
  3514. return Result{cli.open_stream("POST", path, {}, headers, body, content_type),
  3515. chunk_size};
  3516. }
  3517. template <typename ClientType>
  3518. inline Result Post(ClientType &cli, const std::string &path,
  3519. const Params &params, const std::string &body,
  3520. const std::string &content_type, size_t chunk_size = 8192) {
  3521. return Result{cli.open_stream("POST", path, params, {}, body, content_type),
  3522. chunk_size};
  3523. }
  3524. template <typename ClientType>
  3525. inline Result Post(ClientType &cli, const std::string &path,
  3526. const Params &params, const Headers &headers,
  3527. const std::string &body, const std::string &content_type,
  3528. size_t chunk_size = 8192) {
  3529. return Result{
  3530. cli.open_stream("POST", path, params, headers, body, content_type),
  3531. chunk_size};
  3532. }
  3533. // PUT
  3534. template <typename ClientType>
  3535. inline Result Put(ClientType &cli, const std::string &path,
  3536. const std::string &body, const std::string &content_type,
  3537. size_t chunk_size = 8192) {
  3538. return Result{cli.open_stream("PUT", path, {}, {}, body, content_type),
  3539. chunk_size};
  3540. }
  3541. template <typename ClientType>
  3542. inline Result Put(ClientType &cli, const std::string &path,
  3543. const Headers &headers, const std::string &body,
  3544. const std::string &content_type, size_t chunk_size = 8192) {
  3545. return Result{cli.open_stream("PUT", path, {}, headers, body, content_type),
  3546. chunk_size};
  3547. }
  3548. template <typename ClientType>
  3549. inline Result Put(ClientType &cli, const std::string &path,
  3550. const Params &params, const std::string &body,
  3551. const std::string &content_type, size_t chunk_size = 8192) {
  3552. return Result{cli.open_stream("PUT", path, params, {}, body, content_type),
  3553. chunk_size};
  3554. }
  3555. template <typename ClientType>
  3556. inline Result Put(ClientType &cli, const std::string &path,
  3557. const Params &params, const Headers &headers,
  3558. const std::string &body, const std::string &content_type,
  3559. size_t chunk_size = 8192) {
  3560. return Result{
  3561. cli.open_stream("PUT", path, params, headers, body, content_type),
  3562. chunk_size};
  3563. }
  3564. // PATCH
  3565. template <typename ClientType>
  3566. inline Result Patch(ClientType &cli, const std::string &path,
  3567. const std::string &body, const std::string &content_type,
  3568. size_t chunk_size = 8192) {
  3569. return Result{cli.open_stream("PATCH", path, {}, {}, body, content_type),
  3570. chunk_size};
  3571. }
  3572. template <typename ClientType>
  3573. inline Result Patch(ClientType &cli, const std::string &path,
  3574. const Headers &headers, const std::string &body,
  3575. const std::string &content_type, size_t chunk_size = 8192) {
  3576. return Result{cli.open_stream("PATCH", path, {}, headers, body, content_type),
  3577. chunk_size};
  3578. }
  3579. template <typename ClientType>
  3580. inline Result Patch(ClientType &cli, const std::string &path,
  3581. const Params &params, const std::string &body,
  3582. const std::string &content_type, size_t chunk_size = 8192) {
  3583. return Result{cli.open_stream("PATCH", path, params, {}, body, content_type),
  3584. chunk_size};
  3585. }
  3586. template <typename ClientType>
  3587. inline Result Patch(ClientType &cli, const std::string &path,
  3588. const Params &params, const Headers &headers,
  3589. const std::string &body, const std::string &content_type,
  3590. size_t chunk_size = 8192) {
  3591. return Result{
  3592. cli.open_stream("PATCH", path, params, headers, body, content_type),
  3593. chunk_size};
  3594. }
  3595. // DELETE
  3596. template <typename ClientType>
  3597. inline Result Delete(ClientType &cli, const std::string &path,
  3598. size_t chunk_size = 8192) {
  3599. return Result{cli.open_stream("DELETE", path), chunk_size};
  3600. }
  3601. template <typename ClientType>
  3602. inline Result Delete(ClientType &cli, const std::string &path,
  3603. const Headers &headers, size_t chunk_size = 8192) {
  3604. return Result{cli.open_stream("DELETE", path, {}, headers), chunk_size};
  3605. }
  3606. template <typename ClientType>
  3607. inline Result Delete(ClientType &cli, const std::string &path,
  3608. const std::string &body, const std::string &content_type,
  3609. size_t chunk_size = 8192) {
  3610. return Result{cli.open_stream("DELETE", path, {}, {}, body, content_type),
  3611. chunk_size};
  3612. }
  3613. template <typename ClientType>
  3614. inline Result Delete(ClientType &cli, const std::string &path,
  3615. const Headers &headers, const std::string &body,
  3616. const std::string &content_type,
  3617. size_t chunk_size = 8192) {
  3618. return Result{
  3619. cli.open_stream("DELETE", path, {}, headers, body, content_type),
  3620. chunk_size};
  3621. }
  3622. template <typename ClientType>
  3623. inline Result Delete(ClientType &cli, const std::string &path,
  3624. const Params &params, size_t chunk_size = 8192) {
  3625. return Result{cli.open_stream("DELETE", path, params), chunk_size};
  3626. }
  3627. template <typename ClientType>
  3628. inline Result Delete(ClientType &cli, const std::string &path,
  3629. const Params &params, const Headers &headers,
  3630. size_t chunk_size = 8192) {
  3631. return Result{cli.open_stream("DELETE", path, params, headers), chunk_size};
  3632. }
  3633. template <typename ClientType>
  3634. inline Result Delete(ClientType &cli, const std::string &path,
  3635. const Params &params, const std::string &body,
  3636. const std::string &content_type,
  3637. size_t chunk_size = 8192) {
  3638. return Result{cli.open_stream("DELETE", path, params, {}, body, content_type),
  3639. chunk_size};
  3640. }
  3641. template <typename ClientType>
  3642. inline Result Delete(ClientType &cli, const std::string &path,
  3643. const Params &params, const Headers &headers,
  3644. const std::string &body, const std::string &content_type,
  3645. size_t chunk_size = 8192) {
  3646. return Result{
  3647. cli.open_stream("DELETE", path, params, headers, body, content_type),
  3648. chunk_size};
  3649. }
  3650. // HEAD
  3651. template <typename ClientType>
  3652. inline Result Head(ClientType &cli, const std::string &path,
  3653. size_t chunk_size = 8192) {
  3654. return Result{cli.open_stream("HEAD", path), chunk_size};
  3655. }
  3656. template <typename ClientType>
  3657. inline Result Head(ClientType &cli, const std::string &path,
  3658. const Headers &headers, size_t chunk_size = 8192) {
  3659. return Result{cli.open_stream("HEAD", path, {}, headers), chunk_size};
  3660. }
  3661. template <typename ClientType>
  3662. inline Result Head(ClientType &cli, const std::string &path,
  3663. const Params &params, size_t chunk_size = 8192) {
  3664. return Result{cli.open_stream("HEAD", path, params), chunk_size};
  3665. }
  3666. template <typename ClientType>
  3667. inline Result Head(ClientType &cli, const std::string &path,
  3668. const Params &params, const Headers &headers,
  3669. size_t chunk_size = 8192) {
  3670. return Result{cli.open_stream("HEAD", path, params, headers), chunk_size};
  3671. }
  3672. // OPTIONS
  3673. template <typename ClientType>
  3674. inline Result Options(ClientType &cli, const std::string &path,
  3675. size_t chunk_size = 8192) {
  3676. return Result{cli.open_stream("OPTIONS", path), chunk_size};
  3677. }
  3678. template <typename ClientType>
  3679. inline Result Options(ClientType &cli, const std::string &path,
  3680. const Headers &headers, size_t chunk_size = 8192) {
  3681. return Result{cli.open_stream("OPTIONS", path, {}, headers), chunk_size};
  3682. }
  3683. template <typename ClientType>
  3684. inline Result Options(ClientType &cli, const std::string &path,
  3685. const Params &params, size_t chunk_size = 8192) {
  3686. return Result{cli.open_stream("OPTIONS", path, params), chunk_size};
  3687. }
  3688. template <typename ClientType>
  3689. inline Result Options(ClientType &cli, const std::string &path,
  3690. const Params &params, const Headers &headers,
  3691. size_t chunk_size = 8192) {
  3692. return Result{cli.open_stream("OPTIONS", path, params, headers), chunk_size};
  3693. }
  3694. } // namespace stream
  3695. namespace sse {
  3696. struct SSEMessage {
  3697. std::string event; // Event type (default: "message")
  3698. std::string data; // Event payload
  3699. std::string id; // Event ID for Last-Event-ID header
  3700. SSEMessage();
  3701. void clear();
  3702. };
  3703. class SSEClient {
  3704. public:
  3705. using MessageHandler = std::function<void(const SSEMessage &)>;
  3706. using ErrorHandler = std::function<void(Error)>;
  3707. using OpenHandler = std::function<void()>;
  3708. SSEClient(Client &client, const std::string &path);
  3709. SSEClient(Client &client, const std::string &path, const Headers &headers);
  3710. ~SSEClient();
  3711. SSEClient(const SSEClient &) = delete;
  3712. SSEClient &operator=(const SSEClient &) = delete;
  3713. // Event handlers
  3714. SSEClient &on_message(MessageHandler handler);
  3715. SSEClient &on_event(const std::string &type, MessageHandler handler);
  3716. SSEClient &on_open(OpenHandler handler);
  3717. SSEClient &on_error(ErrorHandler handler);
  3718. SSEClient &set_reconnect_interval(int ms);
  3719. SSEClient &set_max_reconnect_attempts(int n);
  3720. // Update headers (thread-safe)
  3721. SSEClient &set_headers(const Headers &headers);
  3722. // State accessors
  3723. bool is_connected() const;
  3724. std::string last_event_id() const;
  3725. // Blocking start - runs event loop with auto-reconnect
  3726. void start();
  3727. // Non-blocking start - runs in background thread
  3728. void start_async();
  3729. // Stop the client (thread-safe)
  3730. void stop();
  3731. private:
  3732. bool parse_sse_line(const std::string &line, SSEMessage &msg, int &retry_ms,
  3733. bool &has_data, bool &has_id);
  3734. void run_event_loop();
  3735. void dispatch_event(const SSEMessage &msg);
  3736. bool should_reconnect(int count) const;
  3737. void wait_for_reconnect();
  3738. // Client and path
  3739. Client &client_;
  3740. std::string path_;
  3741. Headers headers_;
  3742. mutable std::mutex headers_mutex_;
  3743. // Callbacks
  3744. MessageHandler on_message_;
  3745. std::map<std::string, MessageHandler> event_handlers_;
  3746. OpenHandler on_open_;
  3747. ErrorHandler on_error_;
  3748. // Configuration
  3749. int reconnect_interval_ms_ = 3000;
  3750. int max_reconnect_attempts_ = 0; // 0 = unlimited
  3751. // State
  3752. std::atomic<bool> running_{false};
  3753. std::atomic<bool> connected_{false};
  3754. // Written by the event loop, which start_async() runs on its own thread
  3755. std::string last_event_id_;
  3756. mutable std::mutex last_event_id_mutex_;
  3757. // Async support
  3758. std::thread async_thread_;
  3759. };
  3760. } // namespace sse
  3761. namespace ws {
  3762. class WebSocketClient;
  3763. enum class Opcode : uint8_t {
  3764. Continuation = 0x0,
  3765. Text = 0x1,
  3766. Binary = 0x2,
  3767. Close = 0x8,
  3768. Ping = 0x9,
  3769. Pong = 0xA,
  3770. };
  3771. enum class CloseStatus : uint16_t {
  3772. Normal = 1000,
  3773. GoingAway = 1001,
  3774. ProtocolError = 1002,
  3775. UnsupportedData = 1003,
  3776. NoStatus = 1005,
  3777. Abnormal = 1006,
  3778. InvalidPayload = 1007,
  3779. PolicyViolation = 1008,
  3780. MessageTooBig = 1009,
  3781. MandatoryExtension = 1010,
  3782. InternalError = 1011,
  3783. };
  3784. // Timeout is returned only when a read timeout was set and it elapsed before
  3785. // any byte of a frame arrived: nothing was consumed and the connection is
  3786. // still open, so the caller can send on it and read again. `msg` is left
  3787. // untouched, so a `while (ws.read(msg))` loop must not treat it as a message.
  3788. enum ReadResult : int { Fail = 0, Text = 1, Binary = 2, Timeout = 3 };
  3789. // Result of WebSocketClient::connect(). Truthy only when the WebSocket
  3790. // upgrade handshake fully succeeded. On failure error() identifies the
  3791. // failing layer; status()/headers() expose the server's upgrade response
  3792. // when one was received (status() is -1 otherwise), or the proxy's reply to
  3793. // CONNECT when error() is ProxyConnection.
  3794. class Result {
  3795. public:
  3796. Result() = default;
  3797. Result(Error err, int status, Headers &&headers)
  3798. : err_(err), status_(status), headers_(std::move(headers)) {}
  3799. explicit operator bool() const { return err_ == Error::Success; }
  3800. Error error() const { return err_; }
  3801. // Upgrade response info
  3802. int status() const { return status_; }
  3803. const Headers &headers() const { return headers_; }
  3804. std::string get_header_value(const std::string &key,
  3805. const char *def = "") const {
  3806. return detail::get_header_value(headers_, key, def, 0);
  3807. }
  3808. bool has_header(const std::string &key) const {
  3809. return headers_.find(key) != headers_.end();
  3810. }
  3811. #ifdef CPPHTTPLIB_SSL_ENABLED
  3812. Result(Error err, int status, Headers &&headers, int ssl_error,
  3813. uint64_t ssl_backend_error)
  3814. : err_(err), status_(status), headers_(std::move(headers)),
  3815. ssl_error_(ssl_error), ssl_backend_error_(ssl_backend_error) {}
  3816. int ssl_error() const { return ssl_error_; }
  3817. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  3818. #endif
  3819. private:
  3820. Error err_ = Error::Unknown; // a default-constructed Result is falsy
  3821. int status_ = -1;
  3822. Headers headers_;
  3823. #ifdef CPPHTTPLIB_SSL_ENABLED
  3824. int ssl_error_ = 0;
  3825. uint64_t ssl_backend_error_ = 0;
  3826. #endif
  3827. };
  3828. class WebSocket {
  3829. public:
  3830. WebSocket(const WebSocket &) = delete;
  3831. WebSocket &operator=(const WebSocket &) = delete;
  3832. ~WebSocket();
  3833. ReadResult read(std::string &msg);
  3834. bool send(const std::string &data);
  3835. bool send(const char *data, size_t len);
  3836. void close(CloseStatus status = CloseStatus::Normal,
  3837. const std::string &reason = "");
  3838. const Request &request() const;
  3839. bool is_open() const;
  3840. // Bound how long read() waits before returning Timeout. 0 waits forever.
  3841. // A server handler owns its connection's timeout this way; a client sets it
  3842. // through WebSocketClient. Safe to call while another thread is in read().
  3843. //
  3844. // Only a timeout set here is reported as Timeout. The compile-time default
  3845. // (CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND) is a backstop rather
  3846. // than a request for control, so when it elapses read() returns Fail and
  3847. // closes the connection, and `while (ws.read(msg))` ends as it always has.
  3848. void set_read_timeout(time_t sec, time_t usec = 0);
  3849. template <class Rep, class Period>
  3850. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3851. private:
  3852. friend class httplib::Server;
  3853. friend class httplib::ws::WebSocketClient;
  3854. WebSocket(
  3855. Stream &strm, const Request &req, bool is_server,
  3856. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3857. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3858. : strm_(strm), req_(req), is_server_(is_server),
  3859. ping_interval_sec_(ping_interval_sec),
  3860. max_missed_pongs_(max_missed_pongs) {
  3861. start_heartbeat();
  3862. }
  3863. WebSocket(
  3864. std::unique_ptr<Stream> &&owned_strm, const Request &req, bool is_server,
  3865. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3866. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3867. : strm_(*owned_strm), owned_strm_(std::move(owned_strm)), req_(req),
  3868. is_server_(is_server), ping_interval_sec_(ping_interval_sec),
  3869. max_missed_pongs_(max_missed_pongs) {
  3870. start_heartbeat();
  3871. }
  3872. void start_heartbeat();
  3873. bool send_frame(Opcode op, const char *data, size_t len, bool fin = true);
  3874. Stream &strm_;
  3875. std::unique_ptr<Stream> owned_strm_;
  3876. Request req_;
  3877. bool is_server_;
  3878. time_t ping_interval_sec_;
  3879. int max_missed_pongs_;
  3880. int unacked_pings_ = 0;
  3881. std::atomic<bool> closed_{false};
  3882. // Set when the peer stopped answering pings, to end a read() waiting on it
  3883. std::atomic<bool> pong_timed_out_{false};
  3884. // Set once the caller has bounded read() through set_read_timeout(). Until
  3885. // then the timeout in effect is the compile-time default, and elapsing it
  3886. // is a failure that closes the connection, not a Timeout.
  3887. std::atomic<bool> read_timeout_set_{false};
  3888. std::mutex write_mutex_;
  3889. // Owned by whichever thread is parsing frames off strm_. Only one thread
  3890. // may do so: read_websocket_frame() reads a payload until it has the whole
  3891. // declared length, so a second parser stealing bytes silently corrupts the
  3892. // message the first one is assembling.
  3893. std::mutex read_mutex_;
  3894. std::thread ping_thread_;
  3895. std::mutex ping_mutex_;
  3896. std::condition_variable ping_cv_;
  3897. };
  3898. class WebSocketClient {
  3899. public:
  3900. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3901. const Headers &headers = {});
  3902. ~WebSocketClient();
  3903. WebSocketClient(const WebSocketClient &) = delete;
  3904. WebSocketClient &operator=(const WebSocketClient &) = delete;
  3905. bool is_valid() const;
  3906. Result connect();
  3907. ReadResult read(std::string &msg);
  3908. bool send(const std::string &data);
  3909. bool send(const char *data, size_t len);
  3910. void close(CloseStatus status = CloseStatus::Normal,
  3911. const std::string &reason = "");
  3912. bool is_open() const;
  3913. const std::string &subprotocol() const;
  3914. void set_read_timeout(time_t sec, time_t usec = 0);
  3915. template <class Rep, class Period>
  3916. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3917. void set_write_timeout(time_t sec, time_t usec = 0);
  3918. template <class Rep, class Period>
  3919. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  3920. void set_websocket_ping_interval(time_t sec);
  3921. void set_websocket_max_missed_pongs(int count);
  3922. void set_tcp_nodelay(bool on);
  3923. void set_address_family(int family);
  3924. void set_ipv6_v6only(bool on);
  3925. void set_socket_options(SocketOptions socket_options);
  3926. void set_connection_timeout(time_t sec, time_t usec = 0);
  3927. template <class Rep, class Period>
  3928. void
  3929. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  3930. void set_interface(const std::string &intf);
  3931. [[deprecated("Use set_direct_hostname_addr_map() instead.")]]
  3932. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  3933. void
  3934. set_direct_hostname_addr_map(std::map<std::string, std::string> addr_map);
  3935. void
  3936. set_tunnel_hostname_addr_map(std::map<std::string, std::string> addr_map);
  3937. void set_proxy(const std::string &host, int port);
  3938. void set_proxy_basic_auth(const std::string &username,
  3939. const std::string &password);
  3940. void set_proxy_bearer_token_auth(const std::string &token);
  3941. void set_no_proxy(const std::vector<std::string> &patterns);
  3942. #ifdef CPPHTTPLIB_SSL_ENABLED
  3943. struct PemMemory {
  3944. const char *cert_pem;
  3945. size_t cert_pem_len;
  3946. const char *key_pem;
  3947. size_t key_pem_len;
  3948. const char *private_key_password;
  3949. };
  3950. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3951. const PemMemory &pem, const Headers &headers = {});
  3952. void set_ca_cert_path(const std::string &ca_cert_file_path,
  3953. const std::string &ca_cert_dir_path = std::string());
  3954. void set_ca_cert_store(tls::ca_store_t store);
  3955. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  3956. void enable_server_certificate_verification(bool enabled);
  3957. void enable_server_hostname_verification(bool enabled);
  3958. void enable_system_ca(bool enabled);
  3959. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  3960. void set_session_verifier(
  3961. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  3962. void set_proxy_digest_auth(const std::string &username,
  3963. const std::string &password);
  3964. #endif
  3965. private:
  3966. void shutdown_and_close();
  3967. std::pair<time_t, time_t> handshake_timeout() const;
  3968. bool create_stream(std::unique_ptr<Stream> &strm, Error &error,
  3969. int &ssl_error, uint64_t &ssl_backend_error);
  3970. void prepare_default_headers(Request &req);
  3971. bool is_proxy_enabled() const;
  3972. bool create_and_connect_socket(Error &error);
  3973. bool send_proxy_connect(Request &req, Response &proxy_res, Error &error);
  3974. bool connect_with_proxy(Response &proxy_res, Error &error);
  3975. std::string host_;
  3976. int port_;
  3977. std::string path_;
  3978. Headers headers_;
  3979. std::string subprotocol_;
  3980. bool is_valid_ = false;
  3981. socket_t sock_ = INVALID_SOCKET;
  3982. std::unique_ptr<WebSocket> ws_;
  3983. time_t read_timeout_sec_ = CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND;
  3984. time_t read_timeout_usec_ = 0;
  3985. bool read_timeout_set_ = false; // see WebSocket::read_timeout_set_
  3986. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  3987. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  3988. time_t websocket_ping_interval_sec_ =
  3989. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  3990. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  3991. int address_family_ = AF_UNSPEC;
  3992. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  3993. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  3994. SocketOptions socket_options_ = nullptr;
  3995. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  3996. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  3997. std::string interface_;
  3998. // Hostname to connection target map. The value is an IP literal or another
  3999. // hostname; only the connection target changes, never the identity.
  4000. std::map<std::string, std::string> addr_map_;
  4001. // Hostname to CONNECT target map, used only through a proxy.
  4002. std::map<std::string, std::string> tunnel_addr_map_;
  4003. std::string proxy_host_;
  4004. int proxy_port_ = -1;
  4005. std::string proxy_basic_auth_username_;
  4006. std::string proxy_basic_auth_password_;
  4007. std::string proxy_bearer_token_auth_token_;
  4008. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  4009. #ifdef CPPHTTPLIB_SSL_ENABLED
  4010. bool is_ssl_ = false;
  4011. tls::ctx_t tls_ctx_ = nullptr;
  4012. tls::session_t tls_session_ = nullptr;
  4013. std::string ca_cert_file_path_;
  4014. std::string ca_cert_dir_path_;
  4015. // Set by set_ca_cert_store() and load_ca_cert_store() even when they bring
  4016. // no certificate, so that a CA that failed to come through fails
  4017. // verification instead of letting the system CAs in.
  4018. bool custom_ca_loaded_ = false;
  4019. bool certs_loaded_ = false;
  4020. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  4021. bool server_certificate_verification_ = true;
  4022. bool server_hostname_verification_ = true;
  4023. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  4024. std::string proxy_digest_auth_username_;
  4025. std::string proxy_digest_auth_password_;
  4026. #endif
  4027. };
  4028. template <class Rep, class Period>
  4029. inline void WebSocket::set_read_timeout(
  4030. const std::chrono::duration<Rep, Period> &duration) {
  4031. detail::duration_to_sec_and_usec(
  4032. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  4033. }
  4034. template <class Rep, class Period>
  4035. inline void WebSocketClient::set_read_timeout(
  4036. const std::chrono::duration<Rep, Period> &duration) {
  4037. detail::duration_to_sec_and_usec(
  4038. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  4039. }
  4040. template <class Rep, class Period>
  4041. inline void WebSocketClient::set_write_timeout(
  4042. const std::chrono::duration<Rep, Period> &duration) {
  4043. detail::duration_to_sec_and_usec(
  4044. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  4045. }
  4046. template <class Rep, class Period>
  4047. inline void WebSocketClient::set_connection_timeout(
  4048. const std::chrono::duration<Rep, Period> &duration) {
  4049. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  4050. set_connection_timeout(sec, usec);
  4051. });
  4052. }
  4053. namespace impl {
  4054. bool is_valid_utf8(const std::string &s);
  4055. // Three states, because a failure that consumed bytes and one that consumed
  4056. // none are not the same thing: the first has left the stream in the middle of
  4057. // a frame and the connection cannot be reused, the second can just be retried.
  4058. enum class FrameRead { Ok, Fail, Timeout };
  4059. FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  4060. std::string &payload, bool &fin,
  4061. bool expect_masked, size_t max_len);
  4062. } // namespace impl
  4063. } // namespace ws
  4064. // ----------------------------------------------------------------------------
  4065. /*
  4066. * Implementation that will be part of the .cc file if split into .h + .cc.
  4067. */
  4068. namespace stream {
  4069. // stream::Result implementations
  4070. inline Result::Result() : chunk_size_(8192) {}
  4071. inline Result::Result(ClientImpl::StreamHandle &&handle, size_t chunk_size)
  4072. : handle_(std::move(handle)), chunk_size_(chunk_size) {}
  4073. inline Result::Result(Result &&other) noexcept
  4074. : handle_(std::move(other.handle_)), buffer_(std::move(other.buffer_)),
  4075. current_size_(other.current_size_), chunk_size_(other.chunk_size_),
  4076. finished_(other.finished_) {
  4077. other.current_size_ = 0;
  4078. other.finished_ = true;
  4079. }
  4080. inline Result &Result::operator=(Result &&other) noexcept {
  4081. if (this != &other) {
  4082. handle_ = std::move(other.handle_);
  4083. buffer_ = std::move(other.buffer_);
  4084. current_size_ = other.current_size_;
  4085. chunk_size_ = other.chunk_size_;
  4086. finished_ = other.finished_;
  4087. other.current_size_ = 0;
  4088. other.finished_ = true;
  4089. }
  4090. return *this;
  4091. }
  4092. inline bool Result::is_valid() const { return handle_.is_valid(); }
  4093. inline Result::operator bool() const { return is_valid(); }
  4094. inline int Result::status() const {
  4095. return handle_.response ? handle_.response->status : -1;
  4096. }
  4097. inline const Headers &Result::headers() const {
  4098. static const Headers empty_headers;
  4099. return handle_.response ? handle_.response->headers : empty_headers;
  4100. }
  4101. inline std::string Result::get_header_value(const std::string &key,
  4102. const char *def) const {
  4103. return handle_.response ? handle_.response->get_header_value(key, def) : def;
  4104. }
  4105. inline bool Result::has_header(const std::string &key) const {
  4106. return handle_.response ? handle_.response->has_header(key) : false;
  4107. }
  4108. inline Error Result::error() const { return handle_.error; }
  4109. inline Error Result::read_error() const { return handle_.get_read_error(); }
  4110. inline bool Result::has_read_error() const { return handle_.has_read_error(); }
  4111. inline bool Result::next() {
  4112. if (!handle_.is_valid() || finished_) { return false; }
  4113. if (buffer_.size() < chunk_size_) { buffer_.resize(chunk_size_); }
  4114. ssize_t n = handle_.read(&buffer_[0], chunk_size_);
  4115. if (n > 0) {
  4116. current_size_ = static_cast<size_t>(n);
  4117. return true;
  4118. }
  4119. current_size_ = 0;
  4120. finished_ = true;
  4121. return false;
  4122. }
  4123. inline const char *Result::data() const { return buffer_.data(); }
  4124. inline size_t Result::size() const { return current_size_; }
  4125. inline std::string Result::read_all() {
  4126. std::string result;
  4127. while (next()) {
  4128. result.append(data(), size());
  4129. }
  4130. return result;
  4131. }
  4132. } // namespace stream
  4133. namespace sse {
  4134. // SSEMessage implementations
  4135. inline SSEMessage::SSEMessage() : event("message") {}
  4136. inline void SSEMessage::clear() {
  4137. event = "message";
  4138. data.clear();
  4139. id.clear();
  4140. }
  4141. // SSEClient implementations
  4142. inline SSEClient::SSEClient(Client &client, const std::string &path)
  4143. : client_(client), path_(path) {}
  4144. inline SSEClient::SSEClient(Client &client, const std::string &path,
  4145. const Headers &headers)
  4146. : client_(client), path_(path), headers_(headers) {}
  4147. inline SSEClient::~SSEClient() { stop(); }
  4148. inline SSEClient &SSEClient::on_message(MessageHandler handler) {
  4149. on_message_ = std::move(handler);
  4150. return *this;
  4151. }
  4152. inline SSEClient &SSEClient::on_event(const std::string &type,
  4153. MessageHandler handler) {
  4154. event_handlers_[type] = std::move(handler);
  4155. return *this;
  4156. }
  4157. inline SSEClient &SSEClient::on_open(OpenHandler handler) {
  4158. on_open_ = std::move(handler);
  4159. return *this;
  4160. }
  4161. inline SSEClient &SSEClient::on_error(ErrorHandler handler) {
  4162. on_error_ = std::move(handler);
  4163. return *this;
  4164. }
  4165. inline SSEClient &SSEClient::set_reconnect_interval(int ms) {
  4166. reconnect_interval_ms_ = ms;
  4167. return *this;
  4168. }
  4169. inline SSEClient &SSEClient::set_max_reconnect_attempts(int n) {
  4170. max_reconnect_attempts_ = n;
  4171. return *this;
  4172. }
  4173. inline SSEClient &SSEClient::set_headers(const Headers &headers) {
  4174. std::lock_guard<std::mutex> lock(headers_mutex_);
  4175. headers_ = headers;
  4176. return *this;
  4177. }
  4178. inline bool SSEClient::is_connected() const { return connected_.load(); }
  4179. inline std::string SSEClient::last_event_id() const {
  4180. std::lock_guard<std::mutex> lock(last_event_id_mutex_);
  4181. return last_event_id_;
  4182. }
  4183. inline void SSEClient::start() {
  4184. running_.store(true);
  4185. run_event_loop();
  4186. }
  4187. inline void SSEClient::start_async() {
  4188. running_.store(true);
  4189. async_thread_ = std::thread([this]() { run_event_loop(); });
  4190. }
  4191. inline void SSEClient::stop() {
  4192. running_.store(false);
  4193. client_.stop(); // Cancel any pending operations
  4194. if (async_thread_.joinable()) { async_thread_.join(); }
  4195. }
  4196. inline bool SSEClient::parse_sse_line(const std::string &line, SSEMessage &msg,
  4197. int &retry_ms, bool &has_data,
  4198. bool &has_id) {
  4199. // Blank line signals end of event
  4200. if (line.empty()) { return true; }
  4201. // Lines starting with ':' are comments (ignored)
  4202. if (line[0] == ':') { return false; }
  4203. // Find the colon separator
  4204. auto colon_pos = line.find(':');
  4205. auto field = line.substr(0, colon_pos);
  4206. std::string value;
  4207. // Value starts after colon, skip optional single space
  4208. if (colon_pos != std::string::npos && colon_pos + 1 < line.size()) {
  4209. auto value_start = colon_pos + 1;
  4210. if (line[value_start] == ' ') { value_start++; }
  4211. value = line.substr(value_start);
  4212. }
  4213. // Handle known fields
  4214. if (field == "event") {
  4215. // An empty event type is dispatched as "message" per the SSE spec
  4216. msg.event = value.empty() ? std::string("message") : std::move(value);
  4217. } else if (field == "data") {
  4218. // Multiple data lines are concatenated with newlines
  4219. if (has_data) { msg.data += "\n"; }
  4220. msg.data += value;
  4221. has_data = true;
  4222. } else if (field == "id") {
  4223. // An id that cannot be sent back as Last-Event-ID is ignored. Empty id is
  4224. // valid (clears the last event ID)
  4225. if (detail::fields::is_field_value(value)) {
  4226. msg.id = value;
  4227. has_id = true;
  4228. }
  4229. } else if (field == "retry") {
  4230. // Parse retry interval in milliseconds
  4231. // Per the SSE spec, a value that is not all ASCII digits is ignored.
  4232. if (detail::is_numeric(value)) {
  4233. int v = 0;
  4234. auto res =
  4235. detail::from_chars(value.data(), value.data() + value.size(), v);
  4236. if (res.ec == std::errc{}) { retry_ms = v; }
  4237. }
  4238. }
  4239. // Unknown fields are ignored per SSE spec
  4240. return false;
  4241. }
  4242. inline void SSEClient::run_event_loop() {
  4243. auto reconnect_count = 0;
  4244. while (running_.load()) {
  4245. // Build headers, including Last-Event-ID if we have one
  4246. Headers request_headers;
  4247. {
  4248. std::lock_guard<std::mutex> lock(headers_mutex_);
  4249. request_headers = headers_;
  4250. }
  4251. if (!last_event_id_.empty()) {
  4252. request_headers.emplace("Last-Event-ID", last_event_id_);
  4253. }
  4254. // Open streaming connection. An event stream has no end, so each event is
  4255. // bounded instead of the whole body.
  4256. auto handle = client_.open_stream("GET", path_, {}, request_headers);
  4257. handle.body_reader_.payload_max_length = 0;
  4258. // stop() ends a read that is waiting for the next event
  4259. if (handle.stream_) {
  4260. handle.stream_->set_read_interrupt([this] { return !running_.load(); });
  4261. }
  4262. stream::Result result{std::move(handle)};
  4263. // Connection error handling
  4264. if (!result) {
  4265. connected_.store(false);
  4266. if (on_error_) { on_error_(result.error()); }
  4267. if (!should_reconnect(reconnect_count)) { break; }
  4268. wait_for_reconnect();
  4269. reconnect_count++;
  4270. continue;
  4271. }
  4272. if (result.status() != StatusCode::OK_200) {
  4273. connected_.store(false);
  4274. if (on_error_) { on_error_(Error::Connection); }
  4275. // For certain errors, don't reconnect.
  4276. // Note: 401 is intentionally absent so that handlers can refresh
  4277. // credentials via set_headers() and let the client reconnect.
  4278. if (result.status() == StatusCode::NoContent_204 ||
  4279. result.status() == StatusCode::NotFound_404 ||
  4280. result.status() == StatusCode::Forbidden_403) {
  4281. break;
  4282. }
  4283. if (!should_reconnect(reconnect_count)) { break; }
  4284. wait_for_reconnect();
  4285. reconnect_count++;
  4286. continue;
  4287. }
  4288. // Connection successful
  4289. connected_.store(true);
  4290. reconnect_count = 0;
  4291. if (on_open_) { on_open_(); }
  4292. // Event receiving loop
  4293. std::string buffer;
  4294. SSEMessage current_msg;
  4295. auto has_data = false;
  4296. auto has_id = false;
  4297. auto first_line = true;
  4298. auto after_cr = false;
  4299. auto event_too_long = false;
  4300. while (running_.load() && result.next()) {
  4301. // What is left in the buffer has no line ending
  4302. auto search_pos = buffer.size();
  4303. buffer.append(result.data(), result.size());
  4304. // Process complete lines in the buffer. A line ends with \r\n, \n or \r
  4305. // per the SSE spec
  4306. size_t line_start = 0;
  4307. size_t eol_pos;
  4308. while ((eol_pos = buffer.find_first_of("\r\n", search_pos)) !=
  4309. std::string::npos) {
  4310. auto line = buffer.substr(line_start, eol_pos - line_start);
  4311. line_start = eol_pos + 1;
  4312. search_pos = line_start;
  4313. // The \n of a \r\n may arrive in a later chunk than its \r
  4314. auto is_lf_of_crlf =
  4315. after_cr && line.empty() && buffer[eol_pos] == '\n';
  4316. after_cr = buffer[eol_pos] == '\r';
  4317. if (is_lf_of_crlf) { continue; }
  4318. // A UTF-8 BOM at the start of the stream is ignored per the SSE spec
  4319. if (first_line) {
  4320. first_line = false;
  4321. if (line.compare(0, 3, "\xEF\xBB\xBF") == 0) { line.erase(0, 3); }
  4322. }
  4323. // Parse the line and check if event is complete
  4324. auto event_complete = parse_sse_line(
  4325. line, current_msg, reconnect_interval_ms_, has_data, has_id);
  4326. if (event_complete) {
  4327. // Update last_event_id for reconnection, even for an event that
  4328. // has no data. An empty id clears it.
  4329. if (has_id) {
  4330. std::lock_guard<std::mutex> lock(last_event_id_mutex_);
  4331. last_event_id_ = current_msg.id;
  4332. }
  4333. // An event without a data field is not dispatched
  4334. if (has_data) { dispatch_event(current_msg); }
  4335. // Reset the message for the next event either way
  4336. current_msg.clear();
  4337. has_data = false;
  4338. has_id = false;
  4339. }
  4340. }
  4341. // Keep unprocessed data in buffer
  4342. buffer.erase(0, line_start);
  4343. // Neither an event nor a line still waiting for its end may grow
  4344. // without bound. 0 means no limit.
  4345. if (CPPHTTPLIB_SSE_MAX_EVENT_LENGTH > 0 &&
  4346. buffer.size() + current_msg.data.size() >
  4347. CPPHTTPLIB_SSE_MAX_EVENT_LENGTH) {
  4348. if (on_error_) { on_error_(Error::ExceedMaxPayloadSize); }
  4349. event_too_long = true;
  4350. break;
  4351. }
  4352. }
  4353. // Connection ended
  4354. connected_.store(false);
  4355. // Reconnecting would only get the same event again
  4356. if (!running_.load() || event_too_long) { break; }
  4357. // Check for read errors
  4358. if (result.has_read_error()) {
  4359. if (on_error_) { on_error_(result.read_error()); }
  4360. }
  4361. if (!should_reconnect(reconnect_count)) { break; }
  4362. wait_for_reconnect();
  4363. reconnect_count++;
  4364. }
  4365. connected_.store(false);
  4366. }
  4367. inline void SSEClient::dispatch_event(const SSEMessage &msg) {
  4368. // Check for specific event type handler first
  4369. auto it = event_handlers_.find(msg.event);
  4370. if (it != event_handlers_.end()) {
  4371. it->second(msg);
  4372. return;
  4373. }
  4374. // Fall back to generic message handler
  4375. if (on_message_) { on_message_(msg); }
  4376. }
  4377. inline bool SSEClient::should_reconnect(int count) const {
  4378. if (!running_.load()) { return false; }
  4379. if (max_reconnect_attempts_ == 0) { return true; } // unlimited
  4380. return count < max_reconnect_attempts_;
  4381. }
  4382. inline void SSEClient::wait_for_reconnect() {
  4383. // Use small increments to check running_ flag frequently.
  4384. // Always wait at least one increment, so that a zero interval (e.g.
  4385. // "retry: 0" from the server) cannot cause a busy reconnect loop.
  4386. const auto step_ms = 100;
  4387. auto interval_ms = (std::max)(reconnect_interval_ms_, step_ms);
  4388. auto waited = 0;
  4389. while (running_.load() && waited < interval_ms) {
  4390. std::this_thread::sleep_for(std::chrono::milliseconds(step_ms));
  4391. waited += step_ms;
  4392. }
  4393. }
  4394. } // namespace sse
  4395. #ifdef CPPHTTPLIB_SSL_ENABLED
  4396. /*
  4397. * TLS abstraction layer - internal function declarations
  4398. * These are implementation details and not part of the public API.
  4399. */
  4400. namespace tls {
  4401. // Client context
  4402. ctx_t create_client_context();
  4403. void free_context(ctx_t ctx);
  4404. bool set_min_version(ctx_t ctx, Version version);
  4405. bool load_ca_pem(ctx_t ctx, const char *pem, size_t len);
  4406. bool load_ca_file(ctx_t ctx, const char *file_path);
  4407. bool load_ca_dir(ctx_t ctx, const char *dir_path);
  4408. bool load_system_certs(ctx_t ctx);
  4409. bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4410. const char *password);
  4411. bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  4412. const char *key_path, const char *password);
  4413. // Server context
  4414. ctx_t create_server_context();
  4415. bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4416. const char *password);
  4417. bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  4418. const char *key_path, const char *password);
  4419. bool set_client_ca_file(ctx_t ctx, const char *ca_file, const char *ca_dir);
  4420. void set_verify_client(ctx_t ctx, bool require);
  4421. // Session management
  4422. session_t create_session(ctx_t ctx, socket_t sock);
  4423. void free_session(session_t session);
  4424. bool set_sni(session_t session, const char *hostname, bool verify_hostname);
  4425. // Handshake (non-blocking capable)
  4426. TlsError connect(session_t session);
  4427. TlsError accept(session_t session);
  4428. // Handshake with timeout (blocking until timeout)
  4429. bool connect_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4430. time_t timeout_usec, TlsError *err);
  4431. bool accept_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4432. time_t timeout_usec, TlsError *err);
  4433. // I/O (non-blocking capable)
  4434. ssize_t read(session_t session, void *buf, size_t len, TlsError &err);
  4435. ssize_t write(session_t session, const void *buf, size_t len, TlsError &err);
  4436. int pending(const_session_t session);
  4437. void shutdown(session_t session, bool graceful);
  4438. // Connection state
  4439. bool is_peer_closed(session_t session, socket_t sock);
  4440. // Certificate verification
  4441. cert_t get_peer_cert(const_session_t session);
  4442. // The certificates the peer sent, leaf first. Free each with free_cert(), and
  4443. // do not use them after free_session(), as with get_peer_cert().
  4444. size_t get_peer_certs(const_session_t session, std::vector<cert_t> &certs);
  4445. void free_cert(cert_t cert);
  4446. // Matches the host against the subjectAltName entries only, never the Common
  4447. // Name (RFC 9525).
  4448. bool verify_hostname(cert_t cert, const char *hostname);
  4449. uint64_t hostname_mismatch_code();
  4450. long get_verify_result(const_session_t session);
  4451. // Certificate introspection
  4452. std::string get_cert_subject_cn(cert_t cert);
  4453. std::string get_cert_issuer_name(cert_t cert);
  4454. bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans);
  4455. bool get_cert_validity(cert_t cert, time_t &not_before, time_t &not_after);
  4456. std::string get_cert_serial(cert_t cert);
  4457. bool get_cert_der(cert_t cert, std::vector<unsigned char> &der);
  4458. const char *get_sni(const_session_t session);
  4459. // CA store management
  4460. ca_store_t create_ca_store(const char *pem, size_t len);
  4461. void free_ca_store(ca_store_t store);
  4462. bool set_ca_store(ctx_t ctx, ca_store_t store);
  4463. // Free each with free_cert(), and do not use them once the context's CA
  4464. // certificates change.
  4465. size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs);
  4466. std::vector<std::string> get_ca_names(ctx_t ctx);
  4467. // Dynamic certificate update (for servers)
  4468. bool update_server_cert(ctx_t ctx, const char *cert_pem, const char *key_pem,
  4469. const char *password);
  4470. bool update_server_client_ca(ctx_t ctx, const char *ca_pem);
  4471. // Certificate verification callback
  4472. bool set_verify_callback(ctx_t ctx, VerifyCallback callback);
  4473. long get_verify_error(const_session_t session);
  4474. std::string verify_error_string(long error_code);
  4475. // TlsError information
  4476. uint64_t peek_error();
  4477. uint64_t get_error();
  4478. std::string error_string(uint64_t code);
  4479. } // namespace tls
  4480. #endif // CPPHTTPLIB_SSL_ENABLED
  4481. /*
  4482. * Group 1: detail namespace - Non-SSL utilities
  4483. */
  4484. namespace detail {
  4485. inline bool set_socket_opt_impl(socket_t sock, int level, int optname,
  4486. const void *optval, socklen_t optlen) {
  4487. return setsockopt(sock, level, optname,
  4488. #ifdef _WIN32
  4489. reinterpret_cast<const char *>(optval),
  4490. #else
  4491. optval,
  4492. #endif
  4493. optlen) == 0;
  4494. }
  4495. inline bool set_socket_opt_time(socket_t sock, int level, int optname,
  4496. time_t sec, time_t usec) {
  4497. #ifdef _WIN32
  4498. auto timeout = static_cast<uint32_t>(sec * 1000 + usec / 1000);
  4499. #else
  4500. timeval timeout;
  4501. timeout.tv_sec = static_cast<long>(sec);
  4502. timeout.tv_usec = static_cast<decltype(timeout.tv_usec)>(usec);
  4503. #endif
  4504. return set_socket_opt_impl(sock, level, optname, &timeout, sizeof(timeout));
  4505. }
  4506. inline bool is_hex(char c, int &v) {
  4507. if (is_ascii_digit(c)) {
  4508. v = c - '0';
  4509. return true;
  4510. } else if ('A' <= c && c <= 'F') {
  4511. v = c - 'A' + 10;
  4512. return true;
  4513. } else if ('a' <= c && c <= 'f') {
  4514. v = c - 'a' + 10;
  4515. return true;
  4516. }
  4517. return false;
  4518. }
  4519. inline bool from_hex_to_i(const std::string &s, size_t i, size_t cnt,
  4520. int &val) {
  4521. if (i >= s.size()) { return false; }
  4522. val = 0;
  4523. for (; cnt; i++, cnt--) {
  4524. if (!s[i]) { return false; }
  4525. auto v = 0;
  4526. if (is_hex(s[i], v)) {
  4527. val = val * 16 + v;
  4528. } else {
  4529. return false;
  4530. }
  4531. }
  4532. return true;
  4533. }
  4534. inline std::string from_i_to_hex(size_t n) {
  4535. static const auto charset = "0123456789abcdef";
  4536. std::string ret;
  4537. do {
  4538. ret = charset[n & 15] + ret;
  4539. n >>= 4;
  4540. } while (n > 0);
  4541. return ret;
  4542. }
  4543. // A round trip rather than `n <= SIZE_MAX`, which is always true on 64-bit
  4544. // builds and trips -Wtautological-type-limit-compare.
  4545. inline bool fits_in_size_t(uint64_t n) {
  4546. return static_cast<uint64_t>(static_cast<size_t>(n)) == n;
  4547. }
  4548. inline std::string compute_etag(const FileStat &fs,
  4549. const std::string &suffix = std::string()) {
  4550. if (!fs.is_file()) { return std::string(); }
  4551. // If mtime cannot be determined (negative value indicates an error
  4552. // or sentinel), do not generate an ETag. Returning a neutral / fixed
  4553. // value like 0 could collide with a real file that legitimately has
  4554. // mtime == 0 (epoch) and lead to misleading validators.
  4555. auto mtime_raw = fs.mtime();
  4556. if (mtime_raw < 0) { return std::string(); }
  4557. auto mtime = static_cast<size_t>(mtime_raw);
  4558. auto size = fs.size();
  4559. return std::string("W/\"") + from_i_to_hex(mtime) + "-" +
  4560. from_i_to_hex(size) + suffix + "\"";
  4561. }
  4562. // Format time_t as HTTP-date (RFC 9110 Section 5.6.7): "Sun, 06 Nov 1994
  4563. // 08:49:37 GMT" This implementation is defensive: it validates `mtime`, checks
  4564. // return values from `gmtime_r`/`gmtime_s`, and ensures `strftime` succeeds.
  4565. inline std::string file_mtime_to_http_date(time_t mtime) {
  4566. if (mtime < 0) { return std::string(); }
  4567. struct tm tm_buf;
  4568. #ifdef _WIN32
  4569. if (gmtime_s(&tm_buf, &mtime) != 0) { return std::string(); }
  4570. #else
  4571. if (gmtime_r(&mtime, &tm_buf) == nullptr) { return std::string(); }
  4572. #endif
  4573. char buf[64];
  4574. if (strftime(buf, sizeof(buf), "%a, %d %b %Y %H:%M:%S GMT", &tm_buf) == 0) {
  4575. return std::string();
  4576. }
  4577. return std::string(buf);
  4578. }
  4579. // Parse HTTP-date (RFC 9110 Section 5.6.7) to time_t. Returns -1 on failure.
  4580. inline time_t parse_http_date(const std::string &date_str) {
  4581. struct tm tm_buf;
  4582. // Create a classic locale object once for all parsing attempts
  4583. const std::locale classic_locale = std::locale::classic();
  4584. // Try to parse using std::get_time (C++11, cross-platform)
  4585. auto try_parse = [&](const char *fmt) -> bool {
  4586. std::istringstream ss(date_str);
  4587. ss.imbue(classic_locale);
  4588. memset(&tm_buf, 0, sizeof(tm_buf));
  4589. ss >> std::get_time(&tm_buf, fmt);
  4590. return !ss.fail();
  4591. };
  4592. // RFC 9110 preferred format (HTTP-date): "Sun, 06 Nov 1994 08:49:37 GMT"
  4593. if (!try_parse("%a, %d %b %Y %H:%M:%S")) {
  4594. // RFC 850 format: "Sunday, 06-Nov-94 08:49:37 GMT"
  4595. if (!try_parse("%A, %d-%b-%y %H:%M:%S")) {
  4596. // asctime format: "Sun Nov 6 08:49:37 1994"
  4597. if (!try_parse("%a %b %d %H:%M:%S %Y")) {
  4598. return static_cast<time_t>(-1);
  4599. }
  4600. }
  4601. }
  4602. #ifdef _WIN32
  4603. return _mkgmtime(&tm_buf);
  4604. #elif defined _AIX
  4605. return mktime(&tm_buf);
  4606. #else
  4607. return timegm(&tm_buf);
  4608. #endif
  4609. }
  4610. inline bool is_weak_etag(const std::string &s) {
  4611. // Check if the string is a weak ETag (starts with 'W/"')
  4612. return s.size() > 3 && s[0] == 'W' && s[1] == '/' && s[2] == '"';
  4613. }
  4614. inline bool is_strong_etag(const std::string &s) {
  4615. // Check if the string is a strong ETag (starts and ends with '"', at least 2
  4616. // chars)
  4617. return s.size() >= 2 && s[0] == '"' && s.back() == '"';
  4618. }
  4619. inline size_t to_utf8(int code, char *buff) {
  4620. if (code < 0x0080) {
  4621. buff[0] = static_cast<char>(code & 0x7F);
  4622. return 1;
  4623. } else if (code < 0x0800) {
  4624. buff[0] = static_cast<char>(0xC0 | ((code >> 6) & 0x1F));
  4625. buff[1] = static_cast<char>(0x80 | (code & 0x3F));
  4626. return 2;
  4627. } else if (code < 0xD800) {
  4628. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4629. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4630. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4631. return 3;
  4632. } else if (code < 0xE000) { // D800 - DFFF is invalid...
  4633. return 0;
  4634. } else if (code < 0x10000) {
  4635. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4636. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4637. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4638. return 3;
  4639. } else if (code < 0x110000) {
  4640. buff[0] = static_cast<char>(0xF0 | ((code >> 18) & 0x7));
  4641. buff[1] = static_cast<char>(0x80 | ((code >> 12) & 0x3F));
  4642. buff[2] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4643. buff[3] = static_cast<char>(0x80 | (code & 0x3F));
  4644. return 4;
  4645. }
  4646. // NOTREACHED
  4647. return 0;
  4648. }
  4649. } // namespace detail
  4650. namespace ws {
  4651. namespace impl {
  4652. inline bool is_valid_utf8(const std::string &s) {
  4653. size_t i = 0;
  4654. auto n = s.size();
  4655. while (i < n) {
  4656. auto c = static_cast<unsigned char>(s[i]);
  4657. size_t len;
  4658. uint32_t cp;
  4659. if (c < 0x80) {
  4660. i++;
  4661. continue;
  4662. } else if ((c & 0xE0) == 0xC0) {
  4663. len = 2;
  4664. cp = c & 0x1F;
  4665. } else if ((c & 0xF0) == 0xE0) {
  4666. len = 3;
  4667. cp = c & 0x0F;
  4668. } else if ((c & 0xF8) == 0xF0) {
  4669. len = 4;
  4670. cp = c & 0x07;
  4671. } else {
  4672. return false;
  4673. }
  4674. if (i + len > n) { return false; }
  4675. for (size_t j = 1; j < len; j++) {
  4676. auto b = static_cast<unsigned char>(s[i + j]);
  4677. if ((b & 0xC0) != 0x80) { return false; }
  4678. cp = (cp << 6) | (b & 0x3F);
  4679. }
  4680. // Overlong encoding check
  4681. if (len == 2 && cp < 0x80) { return false; }
  4682. if (len == 3 && cp < 0x800) { return false; }
  4683. if (len == 4 && cp < 0x10000) { return false; }
  4684. // Surrogate halves (U+D800..U+DFFF) and beyond U+10FFFF are invalid
  4685. if (cp >= 0xD800 && cp <= 0xDFFF) { return false; }
  4686. if (cp > 0x10FFFF) { return false; }
  4687. i += len;
  4688. }
  4689. return true;
  4690. }
  4691. } // namespace impl
  4692. } // namespace ws
  4693. namespace detail {
  4694. // NOTE: This code came up with the following stackoverflow post:
  4695. // https://stackoverflow.com/questions/180947/base64-decode-snippet-in-c
  4696. inline std::string base64_encode(const std::string &in) {
  4697. static const auto lookup =
  4698. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4699. std::string out;
  4700. out.reserve(in.size());
  4701. // Unsigned: the accumulator is never masked, so with a signed int the
  4702. // `val << 8` below overflows once enough bytes are folded in (undefined
  4703. // behaviour before C++20). Only the low bits are ever emitted, so the
  4704. // wrap-around of an unsigned accumulator does not affect the output.
  4705. uint32_t val = 0;
  4706. auto valb = -6;
  4707. for (auto c : in) {
  4708. val = (val << 8) + static_cast<uint8_t>(c);
  4709. valb += 8;
  4710. while (valb >= 0) {
  4711. out.push_back(lookup[(val >> valb) & 0x3F]);
  4712. valb -= 6;
  4713. }
  4714. }
  4715. if (valb > -6) { out.push_back(lookup[((val << 8) >> (valb + 8)) & 0x3F]); }
  4716. while (out.size() % 4) {
  4717. out.push_back('=');
  4718. }
  4719. return out;
  4720. }
  4721. inline std::string sha1(const std::string &input) {
  4722. // RFC 3174 SHA-1 implementation
  4723. auto left_rotate = [](uint32_t x, uint32_t n) -> uint32_t {
  4724. return (x << n) | (x >> (32 - n));
  4725. };
  4726. uint32_t h0 = 0x67452301;
  4727. uint32_t h1 = 0xEFCDAB89;
  4728. uint32_t h2 = 0x98BADCFE;
  4729. uint32_t h3 = 0x10325476;
  4730. uint32_t h4 = 0xC3D2E1F0;
  4731. // Pre-processing: adding padding bits
  4732. std::string msg = input;
  4733. uint64_t original_bit_len = static_cast<uint64_t>(msg.size()) * 8;
  4734. msg.push_back(static_cast<char>(0x80u));
  4735. while (msg.size() % 64 != 56) {
  4736. msg.push_back(0);
  4737. }
  4738. // Append original length in bits as 64-bit big-endian
  4739. for (int i = 56; i >= 0; i -= 8) {
  4740. msg.push_back(static_cast<char>((original_bit_len >> i) & 0xFF));
  4741. }
  4742. // Process each 512-bit chunk
  4743. for (size_t offset = 0; offset < msg.size(); offset += 64) {
  4744. uint32_t w[80];
  4745. for (size_t i = 0; i < 16; i++) {
  4746. w[i] =
  4747. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4]))
  4748. << 24) |
  4749. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 1]))
  4750. << 16) |
  4751. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 2]))
  4752. << 8) |
  4753. (static_cast<uint32_t>(
  4754. static_cast<uint8_t>(msg[offset + i * 4 + 3])));
  4755. }
  4756. for (int i = 16; i < 80; i++) {
  4757. w[i] = left_rotate(w[i - 3] ^ w[i - 8] ^ w[i - 14] ^ w[i - 16], 1);
  4758. }
  4759. uint32_t a = h0, b = h1, c = h2, d = h3, e = h4;
  4760. for (int i = 0; i < 80; i++) {
  4761. uint32_t f, k;
  4762. if (i < 20) {
  4763. f = (b & c) | ((~b) & d);
  4764. k = 0x5A827999;
  4765. } else if (i < 40) {
  4766. f = b ^ c ^ d;
  4767. k = 0x6ED9EBA1;
  4768. } else if (i < 60) {
  4769. f = (b & c) | (b & d) | (c & d);
  4770. k = 0x8F1BBCDC;
  4771. } else {
  4772. f = b ^ c ^ d;
  4773. k = 0xCA62C1D6;
  4774. }
  4775. uint32_t temp = left_rotate(a, 5) + f + e + k + w[i];
  4776. e = d;
  4777. d = c;
  4778. c = left_rotate(b, 30);
  4779. b = a;
  4780. a = temp;
  4781. }
  4782. h0 += a;
  4783. h1 += b;
  4784. h2 += c;
  4785. h3 += d;
  4786. h4 += e;
  4787. }
  4788. // Produce the final hash as a 20-byte binary string
  4789. std::string hash(20, '\0');
  4790. for (size_t i = 0; i < 4; i++) {
  4791. hash[i] = static_cast<char>((h0 >> (24 - i * 8)) & 0xFF);
  4792. hash[4 + i] = static_cast<char>((h1 >> (24 - i * 8)) & 0xFF);
  4793. hash[8 + i] = static_cast<char>((h2 >> (24 - i * 8)) & 0xFF);
  4794. hash[12 + i] = static_cast<char>((h3 >> (24 - i * 8)) & 0xFF);
  4795. hash[16 + i] = static_cast<char>((h4 >> (24 - i * 8)) & 0xFF);
  4796. }
  4797. return hash;
  4798. }
  4799. inline std::string websocket_accept_key(const std::string &client_key) {
  4800. const std::string magic = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
  4801. return base64_encode(sha1(client_key + magic));
  4802. }
  4803. inline bool is_websocket_upgrade(const Request &req) {
  4804. if (req.method != "GET") { return false; }
  4805. // Check Upgrade: websocket. RFC 9110 7.8 defines Upgrade as a comma-separated
  4806. // list of protocols and asks recipients to match each name
  4807. // case-insensitively, so look for the token rather than compare the whole
  4808. // field value.
  4809. if (!has_header_token(req.headers, "Upgrade", "websocket")) { return false; }
  4810. // Check Connection: Upgrade
  4811. if (!has_header_token(req.headers, "Connection", "upgrade")) { return false; }
  4812. // Check Sec-WebSocket-Key is a valid base64-encoded 16-byte value (24 chars)
  4813. // RFC 6455 Section 4.2.1
  4814. auto ws_key = req.get_header_value("Sec-WebSocket-Key");
  4815. if (ws_key.size() != 24 || ws_key[22] != '=' || ws_key[23] != '=') {
  4816. return false;
  4817. }
  4818. static const std::string b64chars =
  4819. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4820. for (size_t i = 0; i < 22; i++) {
  4821. if (b64chars.find(ws_key[i]) == std::string::npos) { return false; }
  4822. }
  4823. // Check Sec-WebSocket-Version: 13
  4824. auto version = req.get_header_value("Sec-WebSocket-Version");
  4825. if (version != "13") { return false; }
  4826. return true;
  4827. }
  4828. // Unpredictable bytes for masking keys (RFC 6455 Section 5.3) and nonces
  4829. inline void fill_random_bytes(unsigned char *out, size_t n) {
  4830. thread_local std::random_device rd;
  4831. size_t filled = 0;
  4832. while (filled < n) {
  4833. auto v = rd();
  4834. for (size_t b = 0; b < sizeof(v) && filled < n; ++b, ++filled) {
  4835. out[filled] = static_cast<unsigned char>((v >> (b * 8)) & 0xFFu);
  4836. }
  4837. }
  4838. }
  4839. inline bool write_websocket_frame(Stream &strm, ws::Opcode opcode,
  4840. const char *data, size_t len, bool fin,
  4841. bool mask) {
  4842. // First byte: FIN + opcode
  4843. uint8_t header[2];
  4844. header[0] = static_cast<uint8_t>((fin ? 0x80 : 0x00) |
  4845. (static_cast<uint8_t>(opcode) & 0x0F));
  4846. // Second byte: MASK + payload length
  4847. if (len < 126) {
  4848. header[1] = static_cast<uint8_t>(len);
  4849. if (mask) { header[1] |= 0x80; }
  4850. if (!write_data(strm, reinterpret_cast<char *>(header), 2)) {
  4851. return false;
  4852. }
  4853. } else if (len <= 0xFFFF) {
  4854. header[1] = 126;
  4855. if (mask) { header[1] |= 0x80; }
  4856. if (!write_data(strm, reinterpret_cast<char *>(header), 2)) {
  4857. return false;
  4858. }
  4859. uint8_t ext[2];
  4860. ext[0] = static_cast<uint8_t>((len >> 8) & 0xFF);
  4861. ext[1] = static_cast<uint8_t>(len & 0xFF);
  4862. if (!write_data(strm, reinterpret_cast<char *>(ext), 2)) { return false; }
  4863. } else {
  4864. header[1] = 127;
  4865. if (mask) { header[1] |= 0x80; }
  4866. if (!write_data(strm, reinterpret_cast<char *>(header), 2)) {
  4867. return false;
  4868. }
  4869. uint8_t ext[8];
  4870. for (int i = 7; i >= 0; i--) {
  4871. ext[7 - i] =
  4872. static_cast<uint8_t>((static_cast<uint64_t>(len) >> (i * 8)) & 0xFF);
  4873. }
  4874. if (!write_data(strm, reinterpret_cast<char *>(ext), 8)) { return false; }
  4875. }
  4876. if (mask) {
  4877. // Generate random mask key
  4878. uint8_t mask_key[4];
  4879. fill_random_bytes(mask_key, sizeof(mask_key));
  4880. if (!write_data(strm, reinterpret_cast<char *>(mask_key), 4)) {
  4881. return false;
  4882. }
  4883. // Write masked payload in chunks
  4884. const size_t chunk_size = 4096;
  4885. std::vector<char> buf((std::min)(len, chunk_size));
  4886. for (size_t offset = 0; offset < len; offset += chunk_size) {
  4887. size_t n = (std::min)(chunk_size, len - offset);
  4888. for (size_t i = 0; i < n; i++) {
  4889. buf[i] =
  4890. data[offset + i] ^ static_cast<char>(mask_key[(offset + i) % 4]);
  4891. }
  4892. if (!write_data(strm, buf.data(), n)) { return false; }
  4893. }
  4894. } else {
  4895. if (len > 0) {
  4896. if (!write_data(strm, data, len)) { return false; }
  4897. }
  4898. }
  4899. return true;
  4900. }
  4901. } // namespace detail
  4902. namespace ws {
  4903. namespace impl {
  4904. // Read exactly `size` bytes. Stream::read may return less than asked for -- it
  4905. // hands back whatever its buffer already holds -- so every multi-byte field has
  4906. // to loop. Reading a 2-byte header with a single read() fails whenever the
  4907. // header straddles the read buffer's boundary.
  4908. //
  4909. // Timeout is reported only when nothing at all was consumed. Once a byte has
  4910. // been taken the stream sits mid-field and cannot be resumed, so a timeout
  4911. // there is a failure like any other. (When read() fails it always records why,
  4912. // so the error belongs to this call and not to an earlier one.)
  4913. inline FrameRead read_exact(Stream &strm, void *buf, size_t size) {
  4914. auto p = static_cast<char *>(buf);
  4915. size_t total = 0;
  4916. while (total < size) {
  4917. auto n = strm.read(p + total, size - total);
  4918. if (n <= 0) {
  4919. auto timed_out = total == 0 && strm.get_error() == Error::Timeout;
  4920. return timed_out ? FrameRead::Timeout : FrameRead::Fail;
  4921. }
  4922. total += static_cast<size_t>(n);
  4923. }
  4924. return FrameRead::Ok;
  4925. }
  4926. inline FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  4927. std::string &payload, bool &fin,
  4928. bool expect_masked, size_t max_len) {
  4929. // Read first 2 bytes. This is the only read that may report a timeout: it
  4930. // sits on a frame boundary, where nothing has been consumed yet.
  4931. uint8_t header[2];
  4932. FrameRead first = read_exact(strm, header, 2);
  4933. if (first != FrameRead::Ok) { return first; }
  4934. fin = (header[0] & 0x80) != 0;
  4935. // RSV1, RSV2, RSV3 must be 0 when no extension is negotiated
  4936. if (header[0] & 0x70) { return FrameRead::Fail; }
  4937. opcode = static_cast<Opcode>(header[0] & 0x0F);
  4938. bool masked = (header[1] & 0x80) != 0;
  4939. uint64_t payload_len = header[1] & 0x7F;
  4940. // RFC 6455 Section 5.5: control frames MUST NOT be fragmented and
  4941. // MUST have a payload length of 125 bytes or less
  4942. bool is_control = (static_cast<uint8_t>(opcode) & 0x08) != 0;
  4943. if (is_control) {
  4944. if (!fin) { return FrameRead::Fail; }
  4945. if (payload_len > 125) { return FrameRead::Fail; }
  4946. }
  4947. if (masked != expect_masked) { return FrameRead::Fail; }
  4948. // Extended payload length
  4949. if (payload_len == 126) {
  4950. uint8_t ext[2];
  4951. if (read_exact(strm, ext, 2) != FrameRead::Ok) { return FrameRead::Fail; }
  4952. payload_len = (static_cast<uint64_t>(ext[0]) << 8) | ext[1];
  4953. } else if (payload_len == 127) {
  4954. uint8_t ext[8];
  4955. if (read_exact(strm, ext, 8) != FrameRead::Ok) { return FrameRead::Fail; }
  4956. // RFC 6455 Section 5.2: the most significant bit MUST be 0
  4957. if (ext[0] & 0x80) { return FrameRead::Fail; }
  4958. payload_len = 0;
  4959. for (int i = 0; i < 8; i++) {
  4960. payload_len = (payload_len << 8) | ext[i];
  4961. }
  4962. }
  4963. // A max_len of 0 means no limit, as payload_max_length does, and a length
  4964. // size_t cannot hold (32-bit builds) is refused either way.
  4965. if ((max_len > 0 && payload_len > max_len) ||
  4966. !detail::fits_in_size_t(payload_len)) {
  4967. return FrameRead::Fail;
  4968. }
  4969. // Read mask key if present
  4970. uint8_t mask_key[4] = {0};
  4971. if (masked) {
  4972. if (read_exact(strm, mask_key, 4) != FrameRead::Ok) {
  4973. return FrameRead::Fail;
  4974. }
  4975. }
  4976. // Grow the payload only as it arrives, since a header alone can announce
  4977. // max_len bytes that never come.
  4978. payload.clear();
  4979. auto len = static_cast<size_t>(payload_len);
  4980. while (payload.size() < len) {
  4981. auto offset = payload.size();
  4982. auto n = (std::min)(len - offset, CPPHTTPLIB_RECV_BUFSIZ);
  4983. payload.resize(offset + n);
  4984. if (read_exact(strm, &payload[offset], n) != FrameRead::Ok) {
  4985. return FrameRead::Fail;
  4986. }
  4987. }
  4988. // Unmask if needed
  4989. if (masked) {
  4990. for (size_t i = 0; i < payload.size(); i++) {
  4991. payload[i] ^= static_cast<char>(mask_key[i % 4]);
  4992. }
  4993. }
  4994. return FrameRead::Ok;
  4995. }
  4996. // RFC 6455 §5.5.1, §7.4: a Close payload is empty, or a status code that may
  4997. // be sent followed by a UTF-8 reason.
  4998. inline bool is_valid_close_payload(const std::string &payload) {
  4999. if (payload.empty()) { return true; }
  5000. if (payload.size() < 2) { return false; }
  5001. auto code = (static_cast<uint8_t>(payload[0]) << 8) |
  5002. static_cast<uint8_t>(payload[1]);
  5003. auto may_be_sent = (1000 <= code && code <= 1003) ||
  5004. (1007 <= code && code <= 1014) ||
  5005. (3000 <= code && code <= 4999);
  5006. return may_be_sent && is_valid_utf8(payload.substr(2));
  5007. }
  5008. } // namespace impl
  5009. } // namespace ws
  5010. namespace detail {
  5011. // A path a mount point serves: absolute, with no empty segment except a
  5012. // trailing '/', no segment ending in '.' or a space (which covers "." and
  5013. // ".." and names Windows trims into another file's name) and, on Windows, no
  5014. // ':' (which names an NTFS stream, so "a.txt::$DATA" is a.txt), so the file
  5015. // served is the one that req.path names to the handlers that ran before it.
  5016. inline bool is_valid_path(const std::string &path) {
  5017. if (path.empty() || path[0] != '/') { return false; }
  5018. auto beg = size_t{1};
  5019. for (auto i = beg; i <= path.size(); i++) {
  5020. if (i < path.size() && path[i] != '/') {
  5021. if (path[i] == '\0' || path[i] == '\\') { return false; }
  5022. #ifdef _WIN32
  5023. if (path[i] == ':') { return false; }
  5024. #endif
  5025. continue;
  5026. }
  5027. auto len = i - beg;
  5028. if ((len == 0 && i < path.size()) ||
  5029. (len > 0 && (path[i - 1] == '.' || path[i - 1] == ' '))) {
  5030. return false;
  5031. }
  5032. beg = i + 1;
  5033. }
  5034. return true;
  5035. }
  5036. inline bool canonicalize_path(const char *path, std::string &resolved) {
  5037. #if defined(_WIN32)
  5038. char buf[_MAX_PATH];
  5039. if (_fullpath(buf, path, _MAX_PATH) == nullptr) { return false; }
  5040. resolved = buf;
  5041. #elif defined(PATH_MAX)
  5042. char buf[PATH_MAX];
  5043. if (realpath(path, buf) == nullptr) { return false; }
  5044. resolved = buf;
  5045. #else
  5046. auto buf = realpath(path, nullptr);
  5047. auto guard = scope_exit([&]() { std::free(buf); });
  5048. if (buf == nullptr) { return false; }
  5049. resolved = buf;
  5050. #endif
  5051. return true;
  5052. }
  5053. inline bool is_path_within_base(const std::string &resolved_path,
  5054. const std::string &resolved_base) {
  5055. #if defined(_WIN32)
  5056. return _strnicmp(resolved_path.c_str(), resolved_base.c_str(),
  5057. resolved_base.size()) == 0;
  5058. #else
  5059. return strncmp(resolved_path.c_str(), resolved_base.c_str(),
  5060. resolved_base.size()) == 0;
  5061. #endif
  5062. }
  5063. inline FileStat::FileStat(const std::string &path) {
  5064. #if defined(_WIN32)
  5065. auto wpath = u8string_to_wstring(path.c_str());
  5066. ret_ = _wstat(wpath.c_str(), &st_);
  5067. #else
  5068. ret_ = stat(path.c_str(), &st_);
  5069. #endif
  5070. }
  5071. inline bool FileStat::is_file() const {
  5072. return ret_ >= 0 && S_ISREG(st_.st_mode);
  5073. }
  5074. inline bool FileStat::is_dir() const {
  5075. return ret_ >= 0 && S_ISDIR(st_.st_mode);
  5076. }
  5077. inline time_t FileStat::mtime() const {
  5078. return ret_ >= 0 ? static_cast<time_t>(st_.st_mtime)
  5079. : static_cast<time_t>(-1);
  5080. }
  5081. inline size_t FileStat::size() const {
  5082. return ret_ >= 0 ? static_cast<size_t>(st_.st_size) : 0;
  5083. }
  5084. inline std::string encode_path(const std::string &s) {
  5085. std::string result;
  5086. result.reserve(s.size());
  5087. for (size_t i = 0; s[i]; i++) {
  5088. switch (s[i]) {
  5089. case ' ': result += "%20"; break;
  5090. case '+': result += "%2B"; break;
  5091. case '\'': result += "%27"; break;
  5092. case ',': result += "%2C"; break;
  5093. // case ':': result += "%3A"; break; // ok? probably...
  5094. case ';': result += "%3B"; break;
  5095. default:
  5096. auto c = static_cast<uint8_t>(s[i]);
  5097. // Control characters (incl. CR/LF) and non-ASCII bytes are not allowed
  5098. // in a request-target as-is.
  5099. if (c < 0x20 || c == 0x7f || c >= 0x80) {
  5100. result += '%';
  5101. char hex[4];
  5102. auto len = snprintf(hex, sizeof(hex) - 1, "%02X", c);
  5103. assert(len == 2);
  5104. result.append(hex, static_cast<size_t>(len));
  5105. } else {
  5106. result += s[i];
  5107. }
  5108. break;
  5109. }
  5110. }
  5111. return result;
  5112. }
  5113. inline std::string file_extension(const std::string &path) {
  5114. auto i = path.size();
  5115. while (i > 0 && is_ascii_alnum(path[i - 1])) {
  5116. i--;
  5117. }
  5118. if (i == path.size() || i == 0 || path[i - 1] != '.') {
  5119. return std::string();
  5120. }
  5121. return path.substr(i);
  5122. }
  5123. inline bool is_space_or_tab(char c) { return c == ' ' || c == '\t'; }
  5124. template <typename T>
  5125. inline bool parse_header(const char *beg, const char *end, T fn);
  5126. template <typename T>
  5127. inline bool parse_header(const char *beg, const char *end, T fn) {
  5128. // Skip trailing spaces and tabs.
  5129. while (beg < end && is_space_or_tab(end[-1])) {
  5130. end--;
  5131. }
  5132. auto p = beg;
  5133. while (p < end && *p != ':') {
  5134. p++;
  5135. }
  5136. auto name = std::string(beg, p);
  5137. if (!detail::fields::is_field_name(name)) { return false; }
  5138. if (p == end) { return false; }
  5139. auto key_end = p;
  5140. if (*p++ != ':') { return false; }
  5141. while (p < end && is_space_or_tab(*p)) {
  5142. p++;
  5143. }
  5144. if (p <= end) {
  5145. auto key_len = key_end - beg;
  5146. if (!key_len) { return false; }
  5147. auto key = std::string(beg, key_end);
  5148. auto val = std::string(p, end);
  5149. if (!detail::fields::is_field_value(val)) { return false; }
  5150. // RFC 9110 §5.5: header field values are opaque octets and MUST NOT be
  5151. // percent-decoded by the recipient. Applications that need to interpret a
  5152. // value as a URI component should call httplib::decode_uri_component()
  5153. // (or decode_path_component()) explicitly.
  5154. fn(key, val);
  5155. return true;
  5156. }
  5157. return false;
  5158. }
  5159. inline bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  5160. const Headers &src_headers) {
  5161. // NOTE: In RFC 9112, '7.1 Chunked Transfer Coding' mentions "The chunked
  5162. // transfer coding is complete when a chunk with a chunk-size of zero is
  5163. // received, possibly followed by a trailer section, and finally terminated by
  5164. // an empty line". https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1
  5165. //
  5166. // In '7.1.3. Decoding Chunked', however, the pseudo-code in the section
  5167. // doesn't care for the existence of the final CRLF. In other words, it seems
  5168. // to be ok whether the final CRLF exists or not in the chunked data.
  5169. // https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1.3
  5170. //
  5171. // According to the reference code in RFC 9112, cpp-httplib now allows
  5172. // chunked transfer coding data without the final CRLF.
  5173. // RFC 7230 Section 4.1.2 - Headers prohibited in trailers
  5174. thread_local case_ignore::unordered_set<std::string> prohibited_trailers = {
  5175. "transfer-encoding",
  5176. "content-length",
  5177. "host",
  5178. "authorization",
  5179. "www-authenticate",
  5180. "proxy-authenticate",
  5181. "proxy-authorization",
  5182. "cookie",
  5183. "set-cookie",
  5184. "cache-control",
  5185. "expect",
  5186. "max-forwards",
  5187. "pragma",
  5188. "range",
  5189. "te",
  5190. "age",
  5191. "expires",
  5192. "date",
  5193. "location",
  5194. "retry-after",
  5195. "vary",
  5196. "warning",
  5197. "content-encoding",
  5198. "content-type",
  5199. "content-range",
  5200. "trailer"};
  5201. case_ignore::unordered_set<std::string> declared_trailers;
  5202. auto trailer_header = get_combined_header_value(src_headers, "Trailer");
  5203. if (!trailer_header.empty()) {
  5204. // split() trims each token and skips empty ones, so the name arrives ready
  5205. // to look up.
  5206. split(trailer_header.data(), trailer_header.data() + trailer_header.size(),
  5207. ',', [&](const char *b, const char *e) {
  5208. // A legitimate message declares only a handful of trailers. Cap the
  5209. // set so a peer cannot grow it without bound: an oversized set only
  5210. // arises from an attempt to force many colliding names into
  5211. // quadratic lookups (case_ignore::hash is unkeyed).
  5212. if (declared_trailers.size() >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  5213. return;
  5214. }
  5215. std::string key(b, e);
  5216. if (prohibited_trailers.find(key) == prohibited_trailers.end()) {
  5217. declared_trailers.insert(key);
  5218. }
  5219. });
  5220. }
  5221. size_t trailer_header_count = 0;
  5222. while (strcmp(line_reader.ptr(), "\r\n") != 0) {
  5223. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  5224. // Count every received trailer field, not only the declared ones stored in
  5225. // dest, so undeclared fields cannot keep this loop running past the limit.
  5226. if (trailer_header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  5227. constexpr auto line_terminator_len = 2;
  5228. auto line_beg = line_reader.ptr();
  5229. auto line_end =
  5230. line_reader.ptr() + line_reader.size() - line_terminator_len;
  5231. if (!parse_header(line_beg, line_end,
  5232. [&](const std::string &key, const std::string &val) {
  5233. if (declared_trailers.find(key) !=
  5234. declared_trailers.end()) {
  5235. dest.emplace(key, val);
  5236. }
  5237. })) {
  5238. return false;
  5239. }
  5240. trailer_header_count++;
  5241. if (!line_reader.getline()) { return false; }
  5242. }
  5243. return true;
  5244. }
  5245. inline std::pair<size_t, size_t> trim(const char *b, const char *e, size_t left,
  5246. size_t right) {
  5247. while (b + left < e && is_space_or_tab(b[left])) {
  5248. left++;
  5249. }
  5250. while (right > 0 && is_space_or_tab(b[right - 1])) {
  5251. right--;
  5252. }
  5253. return std::make_pair(left, right);
  5254. }
  5255. inline std::string trim_copy(const std::string &s) {
  5256. auto r = trim(s.data(), s.data() + s.size(), 0, s.size());
  5257. return s.substr(r.first, r.second - r.first);
  5258. }
  5259. inline std::string trim_double_quotes_copy(const std::string &s) {
  5260. if (s.length() >= 2 && s.front() == '"' && s.back() == '"') {
  5261. return s.substr(1, s.size() - 2);
  5262. }
  5263. return s;
  5264. }
  5265. // Takes the quotes off a parameter value. Only \" and \\ are quoted-pairs
  5266. // here, as browsers send any other backslash, such as one in a Windows path,
  5267. // as it is.
  5268. inline std::string unquote_param(const std::string &s) {
  5269. if (s.size() < 2 || s.front() != '"' || s.back() != '"') { return s; }
  5270. std::string out;
  5271. for (size_t i = 1; i + 1 < s.size(); i++) {
  5272. if (s[i] == '\\' && i + 2 < s.size() &&
  5273. (s[i + 1] == '"' || s[i + 1] == '\\')) {
  5274. i++;
  5275. }
  5276. out += s[i];
  5277. }
  5278. return out;
  5279. }
  5280. inline void
  5281. divide(const char *data, std::size_t size, char d,
  5282. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5283. fn) {
  5284. const auto it = std::find(data, data + size, d);
  5285. const auto found = static_cast<std::size_t>(it != data + size);
  5286. const auto lhs_data = data;
  5287. const auto lhs_size = static_cast<std::size_t>(it - data);
  5288. const auto rhs_data = it + found;
  5289. const auto rhs_size = size - lhs_size - found;
  5290. fn(lhs_data, lhs_size, rhs_data, rhs_size);
  5291. }
  5292. inline void
  5293. divide(const std::string &str, char d,
  5294. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5295. fn) {
  5296. divide(str.data(), str.size(), d, std::move(fn));
  5297. }
  5298. inline void split(const char *b, const char *e, char d,
  5299. std::function<void(const char *, const char *)> fn) {
  5300. return split(b, e, d, (std::numeric_limits<size_t>::max)(), std::move(fn));
  5301. }
  5302. inline void split(const char *b, const char *e, char d, size_t m,
  5303. std::function<void(const char *, const char *)> fn) {
  5304. size_t i = 0;
  5305. size_t beg = 0;
  5306. size_t count = 1;
  5307. while (e ? (b + i < e) : (b[i] != '\0')) {
  5308. if (b[i] == d && count < m) {
  5309. auto r = trim(b, e, beg, i);
  5310. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5311. beg = i + 1;
  5312. count++;
  5313. }
  5314. i++;
  5315. }
  5316. if (i) {
  5317. auto r = trim(b, e, beg, i);
  5318. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5319. }
  5320. }
  5321. // Same contract as split(), except that a delimiter inside a quoted-string is
  5322. // not a delimiter. RFC 9110 Section 5.6.6 lets a parameter value be a
  5323. // quoted-string, and ';' and '=' are legal characters inside one.
  5324. inline void split_unquoted(const char *b, const char *e, char d, size_t m,
  5325. std::function<void(const char *, const char *)> fn) {
  5326. size_t i = 0;
  5327. size_t beg = 0;
  5328. size_t count = 1;
  5329. auto in_quotes = false;
  5330. auto has = [&](size_t j) { return e ? (b + j < e) : (b[j] != '\0'); };
  5331. while (has(i)) {
  5332. if (in_quotes && b[i] == '\\' && has(i + 1)) {
  5333. // A quoted-pair, whose second character does not end the string.
  5334. i++;
  5335. } else if (b[i] == '"') {
  5336. in_quotes = !in_quotes;
  5337. } else if (b[i] == d && !in_quotes && count < m) {
  5338. auto r = trim(b, e, beg, i);
  5339. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5340. beg = i + 1;
  5341. count++;
  5342. }
  5343. i++;
  5344. }
  5345. if (i) {
  5346. auto r = trim(b, e, beg, i);
  5347. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5348. }
  5349. }
  5350. inline void split_unquoted(const char *b, const char *e, char d,
  5351. std::function<void(const char *, const char *)> fn) {
  5352. return split_unquoted(b, e, d, (std::numeric_limits<size_t>::max)(),
  5353. std::move(fn));
  5354. }
  5355. // Divide a header parameter at its first '='. RFC 9110 Section 5.6.6 makes the
  5356. // key a token, so the first '=' is the separator even when the value is a
  5357. // quoted-string carrying more of them.
  5358. inline void divide_param_pair(const char *b, const char *e, std::string &key,
  5359. std::string &val) {
  5360. divide(
  5361. b, static_cast<std::size_t>(e - b), '=',
  5362. [&](const char *kb, std::size_t klen, const char *vb, std::size_t vlen) {
  5363. const auto kr = trim(kb, kb + klen, 0, klen);
  5364. key.assign(kb + kr.first, kb + kr.second);
  5365. const auto vr = trim(vb, vb + vlen, 0, vlen);
  5366. val.assign(vb + vr.first, vb + vr.second);
  5367. });
  5368. }
  5369. inline bool split_find(const char *b, const char *e, char d, size_t m,
  5370. std::function<bool(const char *, const char *)> fn) {
  5371. size_t i = 0;
  5372. size_t beg = 0;
  5373. size_t count = 1;
  5374. while (e ? (b + i < e) : (b[i] != '\0')) {
  5375. if (b[i] == d && count < m) {
  5376. auto r = trim(b, e, beg, i);
  5377. if (r.first < r.second) {
  5378. auto found = fn(&b[r.first], &b[r.second]);
  5379. if (found) { return true; }
  5380. }
  5381. beg = i + 1;
  5382. count++;
  5383. }
  5384. i++;
  5385. }
  5386. if (i) {
  5387. auto r = trim(b, e, beg, i);
  5388. if (r.first < r.second) {
  5389. auto found = fn(&b[r.first], &b[r.second]);
  5390. if (found) { return true; }
  5391. }
  5392. }
  5393. return false;
  5394. }
  5395. inline bool split_find(const char *b, const char *e, char d,
  5396. std::function<bool(const char *, const char *)> fn) {
  5397. return split_find(b, e, d, (std::numeric_limits<size_t>::max)(),
  5398. std::move(fn));
  5399. }
  5400. inline stream_line_reader::stream_line_reader(Stream &strm, char *fixed_buffer,
  5401. size_t fixed_buffer_size)
  5402. : strm_(strm), fixed_buffer_(fixed_buffer),
  5403. fixed_buffer_size_(fixed_buffer_size) {}
  5404. inline const char *stream_line_reader::ptr() const {
  5405. if (growable_buffer_.empty()) {
  5406. return fixed_buffer_;
  5407. } else {
  5408. return growable_buffer_.data();
  5409. }
  5410. }
  5411. inline size_t stream_line_reader::size() const {
  5412. if (growable_buffer_.empty()) {
  5413. return fixed_buffer_used_size_;
  5414. } else {
  5415. return growable_buffer_.size();
  5416. }
  5417. }
  5418. inline bool stream_line_reader::end_with_crlf() const {
  5419. auto end = ptr() + size();
  5420. return size() >= 2 && end[-2] == '\r' && end[-1] == '\n';
  5421. }
  5422. inline bool stream_line_reader::getline() {
  5423. fixed_buffer_used_size_ = 0;
  5424. growable_buffer_.clear();
  5425. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5426. char prev_byte = 0;
  5427. #endif
  5428. for (size_t i = 0;; i++) {
  5429. // Fast path: whatever the stream has already buffered can be scanned for
  5430. // the terminator in one pass. Asking for a byte at a time costs a virtual
  5431. // call, a bounds check and a one-byte copy per character of the request.
  5432. size_t buffered_size = 0;
  5433. if (auto buffered = strm_.buffered_data(buffered_size)) {
  5434. auto take = buffered_size;
  5435. auto terminated = false;
  5436. for (size_t at = 0; at < buffered_size;) {
  5437. auto nl = static_cast<const char *>(
  5438. memchr(buffered + at, '\n', buffered_size - at));
  5439. if (!nl) { break; }
  5440. auto pos = static_cast<size_t>(nl - buffered);
  5441. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5442. take = pos + 1;
  5443. terminated = true;
  5444. break;
  5445. #else
  5446. // A bare LF does not end the line; keep looking for CRLF. The CR may
  5447. // be the last byte of an earlier chunk, hence prev_byte.
  5448. if ((pos > 0 ? buffered[pos - 1] : prev_byte) == '\r') {
  5449. take = pos + 1;
  5450. terminated = true;
  5451. break;
  5452. }
  5453. at = pos + 1;
  5454. #endif
  5455. }
  5456. if (size() + take > CPPHTTPLIB_MAX_LINE_LENGTH) { return false; }
  5457. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5458. prev_byte = buffered[take - 1];
  5459. #endif
  5460. append(buffered, take);
  5461. strm_.consume_buffered(take);
  5462. i += take;
  5463. if (terminated) { return true; }
  5464. continue;
  5465. }
  5466. if (size() >= CPPHTTPLIB_MAX_LINE_LENGTH) {
  5467. // Treat exceptionally long lines as an error to
  5468. // prevent infinite loops/memory exhaustion
  5469. return false;
  5470. }
  5471. char byte;
  5472. auto n = strm_.read(&byte, 1);
  5473. if (n < 0) {
  5474. return false;
  5475. } else if (n == 0) {
  5476. if (i == 0) {
  5477. return false;
  5478. } else {
  5479. break;
  5480. }
  5481. }
  5482. append(byte);
  5483. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5484. if (byte == '\n') { break; }
  5485. #else
  5486. if (prev_byte == '\r' && byte == '\n') { break; }
  5487. prev_byte = byte;
  5488. #endif
  5489. }
  5490. return true;
  5491. }
  5492. inline void stream_line_reader::append(char c) { append(&c, 1); }
  5493. inline void stream_line_reader::append(const char *data, size_t size) {
  5494. // Once the line has outgrown the fixed buffer everything must keep going to
  5495. // the growable one, even if a later chunk would have fit. Without the
  5496. // emptiness check a short append after a long one would land in the fixed
  5497. // buffer, which ptr() and size() no longer look at, and be lost.
  5498. if (growable_buffer_.empty() &&
  5499. fixed_buffer_used_size_ + size < fixed_buffer_size_) {
  5500. memcpy(fixed_buffer_ + fixed_buffer_used_size_, data, size);
  5501. fixed_buffer_used_size_ += size;
  5502. fixed_buffer_[fixed_buffer_used_size_] = '\0';
  5503. } else {
  5504. // Unlike the per-character overload, this can be the very first append of
  5505. // the line, so the fixed buffer may hold nothing and carry no terminator
  5506. // yet. assign() takes an explicit length and does not need one.
  5507. if (growable_buffer_.empty()) {
  5508. growable_buffer_.assign(fixed_buffer_, fixed_buffer_used_size_);
  5509. }
  5510. growable_buffer_.append(data, size);
  5511. }
  5512. }
  5513. inline mmap::mmap(const char *path) { open(path); }
  5514. inline mmap::~mmap() { close(); }
  5515. inline bool mmap::open(const char *path) {
  5516. close();
  5517. #if defined(_WIN32)
  5518. auto wpath = u8string_to_wstring(path);
  5519. if (wpath.empty()) { return false; }
  5520. hFile_ =
  5521. ::CreateFile2(wpath.c_str(), GENERIC_READ,
  5522. FILE_SHARE_READ | FILE_SHARE_WRITE, OPEN_EXISTING, NULL);
  5523. if (hFile_ == INVALID_HANDLE_VALUE) { return false; }
  5524. LARGE_INTEGER size{};
  5525. if (!::GetFileSizeEx(hFile_, &size)) { return false; }
  5526. // If the following line doesn't compile due to QuadPart, update Windows SDK.
  5527. // See:
  5528. // https://github.com/yhirose/cpp-httplib/issues/1903#issuecomment-2316520721
  5529. if (!fits_in_size_t(static_cast<uint64_t>(size.QuadPart))) { return false; }
  5530. size_ = static_cast<size_t>(size.QuadPart);
  5531. hMapping_ =
  5532. ::CreateFileMappingFromApp(hFile_, NULL, PAGE_READONLY, size_, NULL);
  5533. // Special treatment for an empty file...
  5534. if (hMapping_ == NULL && size_ == 0) {
  5535. close();
  5536. is_open_empty_file = true;
  5537. return true;
  5538. }
  5539. if (hMapping_ == NULL) {
  5540. close();
  5541. return false;
  5542. }
  5543. addr_ = ::MapViewOfFileFromApp(hMapping_, FILE_MAP_READ, 0, 0);
  5544. if (addr_ == nullptr) {
  5545. close();
  5546. return false;
  5547. }
  5548. #else
  5549. // O_NONBLOCK so that opening a FIFO does not wait for a writer.
  5550. fd_ = ::open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC);
  5551. if (fd_ == -1) { return false; }
  5552. // Only a regular file has a size to serve, unlike a directory or a device.
  5553. struct stat sb;
  5554. if (fstat(fd_, &sb) == -1 || !S_ISREG(sb.st_mode) ||
  5555. !fits_in_size_t(static_cast<uint64_t>(sb.st_size))) {
  5556. close();
  5557. return false;
  5558. }
  5559. size_ = static_cast<size_t>(sb.st_size);
  5560. #endif
  5561. return true;
  5562. }
  5563. inline bool mmap::is_open() const {
  5564. #if defined(_WIN32)
  5565. return is_open_empty_file ? true : addr_ != nullptr;
  5566. #else
  5567. return fd_ != -1;
  5568. #endif
  5569. }
  5570. inline size_t mmap::size() const { return size_; }
  5571. inline void mmap::close() {
  5572. #if defined(_WIN32)
  5573. if (addr_) {
  5574. ::UnmapViewOfFile(addr_);
  5575. addr_ = nullptr;
  5576. }
  5577. if (hMapping_) {
  5578. ::CloseHandle(hMapping_);
  5579. hMapping_ = NULL;
  5580. }
  5581. if (hFile_ != INVALID_HANDLE_VALUE) {
  5582. ::CloseHandle(hFile_);
  5583. hFile_ = INVALID_HANDLE_VALUE;
  5584. }
  5585. is_open_empty_file = false;
  5586. #else
  5587. if (fd_ != -1) {
  5588. ::close(fd_);
  5589. fd_ = -1;
  5590. }
  5591. #endif
  5592. size_ = 0;
  5593. }
  5594. inline int close_socket(socket_t sock) noexcept {
  5595. #ifdef _WIN32
  5596. return closesocket(sock);
  5597. #else
  5598. return close(sock);
  5599. #endif
  5600. }
  5601. template <typename T> inline ssize_t handle_EINTR(T fn) {
  5602. ssize_t res = 0;
  5603. while (true) {
  5604. res = fn();
  5605. if (res < 0 && errno == EINTR) {
  5606. std::this_thread::sleep_for(std::chrono::microseconds{1});
  5607. continue;
  5608. }
  5609. break;
  5610. }
  5611. return res;
  5612. }
  5613. inline size_t mmap::read(size_t offset, char *buf, size_t len) const {
  5614. if (offset >= size_) { return 0; }
  5615. len = (std::min)(len, size_ - offset);
  5616. #if defined(_WIN32)
  5617. // Windows does not let a mapped file be truncated.
  5618. std::memcpy(buf, static_cast<const char *>(addr_) + offset, len);
  5619. return len;
  5620. #else
  5621. auto n = handle_EINTR(
  5622. [&]() { return ::pread(fd_, buf, len, static_cast<off_t>(offset)); });
  5623. return n > 0 ? static_cast<size_t>(n) : 0;
  5624. #endif
  5625. }
  5626. inline ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags) {
  5627. return handle_EINTR([&]() {
  5628. return recv(sock,
  5629. #ifdef _WIN32
  5630. static_cast<char *>(ptr), static_cast<int>(size),
  5631. #else
  5632. ptr, size,
  5633. #endif
  5634. flags);
  5635. });
  5636. }
  5637. inline ssize_t send_socket(socket_t sock, const void *ptr, size_t size,
  5638. int flags) {
  5639. return handle_EINTR([&]() {
  5640. return send(sock,
  5641. #ifdef _WIN32
  5642. static_cast<const char *>(ptr), static_cast<int>(size),
  5643. #else
  5644. ptr, size,
  5645. #endif
  5646. flags);
  5647. });
  5648. }
  5649. inline int poll_wrapper(struct pollfd *fds, nfds_t nfds, int timeout) {
  5650. #ifdef _WIN32
  5651. return ::WSAPoll(fds, nfds, timeout);
  5652. #else
  5653. return ::poll(fds, nfds, timeout);
  5654. #endif
  5655. }
  5656. inline ssize_t select_impl(socket_t sock, short events, time_t sec,
  5657. time_t usec) {
  5658. struct pollfd pfd;
  5659. pfd.fd = sock;
  5660. pfd.events = events;
  5661. pfd.revents = 0;
  5662. // A negative timeout waits forever, poll's own convention. 0 keeps meaning
  5663. // "return immediately", which callers here rely on to probe a socket.
  5664. auto timeout = sec < 0 ? -1 : static_cast<int>(sec * 1000 + usec / 1000);
  5665. return handle_EINTR([&]() { return poll_wrapper(&pfd, 1, timeout); });
  5666. }
  5667. inline ssize_t select_read(socket_t sock, time_t sec, time_t usec) {
  5668. return select_impl(sock, POLLIN, sec, usec);
  5669. }
  5670. inline ssize_t select_write(socket_t sock, time_t sec, time_t usec) {
  5671. return select_impl(sock, POLLOUT, sec, usec);
  5672. }
  5673. // The point sec and usec from now, for select_until(). A negative sec never
  5674. // comes, as a negative timeout waits forever in select_impl().
  5675. inline std::chrono::steady_clock::time_point deadline_after(time_t sec,
  5676. time_t usec) {
  5677. if (sec < 0) { return (std::chrono::steady_clock::time_point::max)(); }
  5678. return std::chrono::steady_clock::now() + std::chrono::seconds(sec) +
  5679. std::chrono::microseconds(usec);
  5680. }
  5681. // Waits only for the time left until deadline, so that all the waits of one
  5682. // TLS handshake come out of a single timeout.
  5683. inline ssize_t select_until(socket_t sock, short events,
  5684. std::chrono::steady_clock::time_point deadline) {
  5685. if (deadline == (std::chrono::steady_clock::time_point::max)()) {
  5686. return select_impl(sock, events, -1, 0);
  5687. }
  5688. auto left = std::chrono::duration_cast<std::chrono::microseconds>(
  5689. deadline - std::chrono::steady_clock::now())
  5690. .count();
  5691. if (left <= 0) { return 0; }
  5692. return select_impl(sock, events, static_cast<time_t>(left / 1000000),
  5693. static_cast<time_t>(left % 1000000));
  5694. }
  5695. // select_read(), but waits in slices and gives up once interrupted() returns
  5696. // true. A local shutdown() would not wake the wait on Windows.
  5697. inline ssize_t
  5698. select_read_interruptible(socket_t sock, time_t sec, time_t usec,
  5699. const std::function<bool()> &interrupted) {
  5700. if (!interrupted) { return select_read(sock, sec, usec); }
  5701. const auto slice = std::chrono::microseconds(100000);
  5702. auto deadline = deadline_after(sec, usec);
  5703. while (!interrupted()) {
  5704. auto left = std::chrono::duration_cast<std::chrono::microseconds>(
  5705. deadline - std::chrono::steady_clock::now());
  5706. auto wait =
  5707. (std::max)((std::min)(left, slice), std::chrono::microseconds(0));
  5708. auto ret = select_impl(sock, POLLIN, 0, static_cast<time_t>(wait.count()));
  5709. if (ret != 0 || wait < slice) { return ret; }
  5710. }
  5711. return 0;
  5712. }
  5713. inline Error wait_until_socket_is_ready(socket_t sock, time_t sec,
  5714. time_t usec) {
  5715. struct pollfd pfd_read;
  5716. pfd_read.fd = sock;
  5717. pfd_read.events = POLLIN | POLLOUT;
  5718. pfd_read.revents = 0;
  5719. auto timeout = static_cast<int>(sec * 1000 + usec / 1000);
  5720. auto poll_res =
  5721. handle_EINTR([&]() { return poll_wrapper(&pfd_read, 1, timeout); });
  5722. if (poll_res == 0) { return Error::ConnectionTimeout; }
  5723. if (poll_res > 0 && pfd_read.revents & (POLLIN | POLLOUT)) {
  5724. auto error = 0;
  5725. socklen_t len = sizeof(error);
  5726. auto res = getsockopt(sock, SOL_SOCKET, SO_ERROR,
  5727. reinterpret_cast<char *>(&error), &len);
  5728. auto successful = res >= 0 && !error;
  5729. return successful ? Error::Success : Error::Connection;
  5730. }
  5731. return Error::Connection;
  5732. }
  5733. inline bool is_socket_alive(socket_t sock) {
  5734. const auto val = detail::select_read(sock, 0, 0);
  5735. if (val == 0) {
  5736. return true;
  5737. } else if (val < 0 && errno == EBADF) {
  5738. return false;
  5739. }
  5740. char buf[1];
  5741. return detail::read_socket(sock, &buf[0], sizeof(buf), MSG_PEEK) > 0;
  5742. }
  5743. class SocketStream final : public Stream {
  5744. public:
  5745. SocketStream(socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5746. time_t write_timeout_sec, time_t write_timeout_usec,
  5747. time_t max_timeout_msec = 0,
  5748. std::chrono::time_point<std::chrono::steady_clock> start_time =
  5749. (std::chrono::steady_clock::time_point::min)());
  5750. ~SocketStream() override;
  5751. bool is_readable() const override;
  5752. bool wait_readable() const override;
  5753. bool wait_writable() const override;
  5754. bool is_peer_alive() const override;
  5755. ssize_t read(char *ptr, size_t size) override;
  5756. ssize_t write(const char *ptr, size_t size) override;
  5757. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  5758. void get_local_ip_and_port(std::string &ip, int &port) const override;
  5759. socket_t socket() const override;
  5760. time_t duration() const override;
  5761. void set_read_timeout(time_t sec, time_t usec = 0) override;
  5762. void set_max_timeout(time_t msec) override;
  5763. void set_read_interrupt(std::function<bool()> interrupted) override;
  5764. const char *buffered_data(size_t &size) const override;
  5765. void consume_buffered(size_t size) override;
  5766. // The caller has just seen this socket become readable. Lets the next read
  5767. // skip its own readiness wait, which would otherwise ask the kernel a
  5768. // question that was answered a moment ago. Consumed by that read.
  5769. void set_readable_hint() { readable_hint_ = true; }
  5770. private:
  5771. bool ensure_readable();
  5772. socket_t sock_;
  5773. // Atomic because ws::WebSocket::set_read_timeout() reaches this from another
  5774. // thread while a read is in flight -- that is the point of it, for a caller
  5775. // holding one connection and wanting control back to send on it.
  5776. std::atomic<time_t> read_timeout_sec_;
  5777. std::atomic<time_t> read_timeout_usec_;
  5778. time_t write_timeout_sec_;
  5779. time_t write_timeout_usec_;
  5780. time_t max_timeout_msec_;
  5781. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  5782. std::function<bool()> read_interrupted_;
  5783. std::vector<char> read_buff_;
  5784. size_t read_buff_off_ = 0;
  5785. size_t read_buff_content_size_ = 0;
  5786. bool readable_hint_ = false;
  5787. static const size_t read_buff_size_ = 1024l * 4;
  5788. };
  5789. inline bool keep_alive(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5790. time_t keep_alive_timeout_sec) {
  5791. using namespace std::chrono;
  5792. const auto interval_usec =
  5793. CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND;
  5794. // Avoid expensive `steady_clock::now()` call for the first time
  5795. if (select_read(sock, 0, interval_usec) > 0) { return true; }
  5796. const auto start = steady_clock::now() - microseconds{interval_usec};
  5797. const auto timeout = seconds{keep_alive_timeout_sec};
  5798. while (true) {
  5799. if (svr_sock == INVALID_SOCKET) {
  5800. break; // Server socket is closed
  5801. }
  5802. auto val = select_read(sock, 0, interval_usec);
  5803. if (val < 0) {
  5804. break; // Ssocket error
  5805. } else if (val == 0) {
  5806. if (steady_clock::now() - start > timeout) {
  5807. break; // Timeout
  5808. }
  5809. } else {
  5810. return true; // Ready for read
  5811. }
  5812. }
  5813. return false;
  5814. }
  5815. // `has_buffered_request` reports whether the connection's stream already holds
  5816. // bytes of the next request. A client may pipeline its requests (RFC 9112
  5817. // 9.3.2), so reading one request can pull the start of the next one into the
  5818. // stream's buffer; that request must be served without waiting for the socket
  5819. // to become readable again, since its bytes are no longer on the socket.
  5820. // `callback` is told whether keep_alive() has just seen the socket go readable.
  5821. template <typename P, typename T>
  5822. inline bool process_server_socket_core(const std::atomic<socket_t> &svr_sock,
  5823. socket_t sock,
  5824. size_t keep_alive_max_count,
  5825. time_t keep_alive_timeout_sec,
  5826. P has_buffered_request, T callback) {
  5827. auto ret = false;
  5828. // A keep_alive_max_count of 0 sets no limit.
  5829. for (size_t served = 0;
  5830. keep_alive_max_count == 0 || served < keep_alive_max_count; served++) {
  5831. auto socket_readable = false;
  5832. if (!has_buffered_request()) {
  5833. if (!keep_alive(svr_sock, sock, keep_alive_timeout_sec)) { break; }
  5834. socket_readable = true;
  5835. }
  5836. auto close_connection = served + 1 == keep_alive_max_count;
  5837. auto connection_closed = false;
  5838. ret = callback(socket_readable, close_connection, connection_closed);
  5839. if (!ret || connection_closed) { break; }
  5840. }
  5841. return ret;
  5842. }
  5843. template <typename T>
  5844. inline bool
  5845. process_server_socket(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5846. size_t keep_alive_max_count,
  5847. time_t keep_alive_timeout_sec, time_t read_timeout_sec,
  5848. time_t read_timeout_usec, time_t write_timeout_sec,
  5849. time_t write_timeout_usec, T callback) {
  5850. // One stream per connection: its read buffer can already hold the start of
  5851. // the next, pipelined request.
  5852. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5853. write_timeout_sec, write_timeout_usec);
  5854. return process_server_socket_core(
  5855. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  5856. [&]() { return strm.is_readable(); },
  5857. [&](bool socket_readable, bool close_connection,
  5858. bool &connection_closed) {
  5859. if (socket_readable) { strm.set_readable_hint(); }
  5860. return callback(strm, close_connection, connection_closed);
  5861. });
  5862. }
  5863. inline bool process_client_socket(
  5864. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5865. time_t write_timeout_sec, time_t write_timeout_usec,
  5866. time_t max_timeout_msec,
  5867. std::chrono::time_point<std::chrono::steady_clock> start_time,
  5868. std::function<bool(Stream &)> callback) {
  5869. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5870. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  5871. start_time);
  5872. return callback(strm);
  5873. }
  5874. inline int shutdown_socket(socket_t sock) noexcept {
  5875. #ifdef _WIN32
  5876. return shutdown(sock, SD_BOTH);
  5877. #else
  5878. return shutdown(sock, SHUT_RDWR);
  5879. #endif
  5880. }
  5881. // Half-closes the write side and drains any in-flight/queued bytes before
  5882. // the final shutdown+close. Closing with unread data in the receive queue
  5883. // (or bytes arriving after the receive side is closed) makes the stack send
  5884. // an abortive RST instead of a graceful FIN, which can make the peer see the
  5885. // response as a failed read even though it was fully written.
  5886. inline void drain_and_close_socket(socket_t sock) noexcept {
  5887. #ifdef _WIN32
  5888. shutdown(sock, SD_SEND);
  5889. #else
  5890. shutdown(sock, SHUT_WR);
  5891. #endif
  5892. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  5893. size_t total = 0;
  5894. const auto deadline = std::chrono::steady_clock::now() +
  5895. std::chrono::milliseconds(100); // bound #1
  5896. while (total < size_t(1024u * 1024u)) { // bound #2
  5897. const auto remaining =
  5898. std::chrono::duration_cast<std::chrono::microseconds>(
  5899. deadline - std::chrono::steady_clock::now())
  5900. .count();
  5901. if (remaining <= 0) { break; }
  5902. if (select_read(sock, 0, static_cast<time_t>(remaining)) <= 0) { break; }
  5903. const auto n = read_socket(sock, buf, sizeof(buf), CPPHTTPLIB_RECV_FLAGS);
  5904. if (n <= 0) { break; }
  5905. total += static_cast<size_t>(n);
  5906. }
  5907. shutdown_socket(sock);
  5908. close_socket(sock);
  5909. }
  5910. inline std::string escape_abstract_namespace_unix_domain(const std::string &s) {
  5911. if (s.size() > 1 && s[0] == '\0') {
  5912. auto ret = s;
  5913. ret[0] = '@';
  5914. return ret;
  5915. }
  5916. return s;
  5917. }
  5918. inline std::string
  5919. unescape_abstract_namespace_unix_domain(const std::string &s) {
  5920. if (s.size() > 1 && s[0] == '@') {
  5921. auto ret = s;
  5922. ret[0] = '\0';
  5923. return ret;
  5924. }
  5925. return s;
  5926. }
  5927. inline int getaddrinfo_with_timeout(const char *node, const char *service,
  5928. const struct addrinfo *hints,
  5929. struct addrinfo **res, time_t timeout_sec) {
  5930. #ifdef CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO
  5931. if (timeout_sec <= 0) {
  5932. // No timeout specified, use standard getaddrinfo
  5933. return getaddrinfo(node, service, hints, res);
  5934. }
  5935. #ifdef _WIN32
  5936. // Windows-specific implementation using GetAddrInfoEx with overlapped I/O
  5937. OVERLAPPED overlapped = {};
  5938. HANDLE event = CreateEventW(nullptr, TRUE, FALSE, nullptr);
  5939. if (!event) { return EAI_FAIL; }
  5940. overlapped.hEvent = event;
  5941. PADDRINFOEXW result_addrinfo = nullptr;
  5942. HANDLE cancel_handle = nullptr;
  5943. ADDRINFOEXW hints_ex = {};
  5944. if (hints) {
  5945. hints_ex.ai_flags = hints->ai_flags;
  5946. hints_ex.ai_family = hints->ai_family;
  5947. hints_ex.ai_socktype = hints->ai_socktype;
  5948. hints_ex.ai_protocol = hints->ai_protocol;
  5949. }
  5950. auto wnode = u8string_to_wstring(node);
  5951. auto wservice = u8string_to_wstring(service);
  5952. auto ret = ::GetAddrInfoExW(wnode.data(), wservice.data(), NS_DNS, nullptr,
  5953. hints ? &hints_ex : nullptr, &result_addrinfo,
  5954. nullptr, &overlapped, nullptr, &cancel_handle);
  5955. if (ret == WSA_IO_PENDING) {
  5956. auto wait_result =
  5957. ::WaitForSingleObject(event, static_cast<DWORD>(timeout_sec * 1000));
  5958. if (wait_result == WAIT_TIMEOUT) {
  5959. if (cancel_handle) { ::GetAddrInfoExCancel(&cancel_handle); }
  5960. ::CloseHandle(event);
  5961. return EAI_AGAIN;
  5962. }
  5963. DWORD bytes_returned;
  5964. if (!::GetOverlappedResult((HANDLE)INVALID_SOCKET, &overlapped,
  5965. &bytes_returned, FALSE)) {
  5966. ::CloseHandle(event);
  5967. return ::WSAGetLastError();
  5968. }
  5969. }
  5970. ::CloseHandle(event);
  5971. if (ret == NO_ERROR || ret == WSA_IO_PENDING) {
  5972. *res = reinterpret_cast<struct addrinfo *>(result_addrinfo);
  5973. return 0;
  5974. }
  5975. return ret;
  5976. #elif TARGET_OS_MAC && defined(__clang__)
  5977. if (!node) { return EAI_NONAME; }
  5978. // macOS implementation using CFHost API for asynchronous DNS resolution
  5979. CFStringRef hostname_ref = CFStringCreateWithCString(
  5980. kCFAllocatorDefault, node, kCFStringEncodingUTF8);
  5981. if (!hostname_ref) { return EAI_MEMORY; }
  5982. CFHostRef host_ref = CFHostCreateWithName(kCFAllocatorDefault, hostname_ref);
  5983. CFRelease(hostname_ref);
  5984. if (!host_ref) { return EAI_MEMORY; }
  5985. // Set up context for callback
  5986. struct CFHostContext {
  5987. bool completed = false;
  5988. bool success = false;
  5989. CFArrayRef addresses = nullptr;
  5990. std::mutex mutex;
  5991. std::condition_variable cv;
  5992. } context;
  5993. CFHostClientContext client_context;
  5994. memset(&client_context, 0, sizeof(client_context));
  5995. client_context.info = &context;
  5996. // Set callback
  5997. auto callback = [](CFHostRef theHost, CFHostInfoType /*typeInfo*/,
  5998. const CFStreamError *error, void *info) {
  5999. auto ctx = static_cast<CFHostContext *>(info);
  6000. std::lock_guard<std::mutex> lock(ctx->mutex);
  6001. if (error && error->error != 0) {
  6002. ctx->success = false;
  6003. } else {
  6004. Boolean hasBeenResolved;
  6005. ctx->addresses = CFHostGetAddressing(theHost, &hasBeenResolved);
  6006. if (ctx->addresses && hasBeenResolved) {
  6007. CFRetain(ctx->addresses);
  6008. ctx->success = true;
  6009. } else {
  6010. ctx->success = false;
  6011. }
  6012. }
  6013. ctx->completed = true;
  6014. ctx->cv.notify_one();
  6015. };
  6016. if (!CFHostSetClient(host_ref, callback, &client_context)) {
  6017. CFRelease(host_ref);
  6018. return EAI_SYSTEM;
  6019. }
  6020. // Schedule on run loop
  6021. CFRunLoopRef run_loop = CFRunLoopGetCurrent();
  6022. CFHostScheduleWithRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  6023. // Start resolution
  6024. CFStreamError stream_error;
  6025. if (!CFHostStartInfoResolution(host_ref, kCFHostAddresses, &stream_error)) {
  6026. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  6027. CFRelease(host_ref);
  6028. return EAI_FAIL;
  6029. }
  6030. // Wait for completion with timeout
  6031. auto timeout_time =
  6032. std::chrono::steady_clock::now() + std::chrono::seconds(timeout_sec);
  6033. bool timed_out = false;
  6034. {
  6035. std::unique_lock<std::mutex> lock(context.mutex);
  6036. while (!context.completed) {
  6037. auto now = std::chrono::steady_clock::now();
  6038. if (now >= timeout_time) {
  6039. timed_out = true;
  6040. break;
  6041. }
  6042. // Run the runloop for a short time
  6043. lock.unlock();
  6044. CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.1, true);
  6045. lock.lock();
  6046. }
  6047. }
  6048. // Clean up
  6049. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  6050. CFHostSetClient(host_ref, nullptr, nullptr);
  6051. if (timed_out || !context.completed) {
  6052. CFHostCancelInfoResolution(host_ref, kCFHostAddresses);
  6053. CFRelease(host_ref);
  6054. return EAI_AGAIN;
  6055. }
  6056. if (!context.success || !context.addresses) {
  6057. CFRelease(host_ref);
  6058. return EAI_NODATA;
  6059. }
  6060. // Convert CFArray to addrinfo
  6061. CFIndex count = CFArrayGetCount(context.addresses);
  6062. if (count == 0) {
  6063. CFRelease(context.addresses);
  6064. CFRelease(host_ref);
  6065. return EAI_NODATA;
  6066. }
  6067. struct addrinfo *result_addrinfo = nullptr;
  6068. struct addrinfo **current = &result_addrinfo;
  6069. for (CFIndex i = 0; i < count; i++) {
  6070. CFDataRef addr_data =
  6071. static_cast<CFDataRef>(CFArrayGetValueAtIndex(context.addresses, i));
  6072. if (!addr_data) continue;
  6073. const struct sockaddr *sockaddr_ptr =
  6074. reinterpret_cast<const struct sockaddr *>(CFDataGetBytePtr(addr_data));
  6075. socklen_t sockaddr_len = static_cast<socklen_t>(CFDataGetLength(addr_data));
  6076. // Allocate addrinfo structure
  6077. *current = static_cast<struct addrinfo *>(malloc(sizeof(struct addrinfo)));
  6078. if (!*current) {
  6079. freeaddrinfo(result_addrinfo);
  6080. CFRelease(context.addresses);
  6081. CFRelease(host_ref);
  6082. return EAI_MEMORY;
  6083. }
  6084. memset(*current, 0, sizeof(struct addrinfo));
  6085. // Set up addrinfo fields
  6086. (*current)->ai_family = sockaddr_ptr->sa_family;
  6087. (*current)->ai_socktype = hints ? hints->ai_socktype : SOCK_STREAM;
  6088. (*current)->ai_protocol = hints ? hints->ai_protocol : IPPROTO_TCP;
  6089. (*current)->ai_addrlen = sockaddr_len;
  6090. // Copy sockaddr
  6091. (*current)->ai_addr = static_cast<struct sockaddr *>(malloc(sockaddr_len));
  6092. if (!(*current)->ai_addr) {
  6093. freeaddrinfo(result_addrinfo);
  6094. CFRelease(context.addresses);
  6095. CFRelease(host_ref);
  6096. return EAI_MEMORY;
  6097. }
  6098. memcpy((*current)->ai_addr, sockaddr_ptr, sockaddr_len);
  6099. // Set port if service is specified
  6100. if (service && *service) {
  6101. int port = 0;
  6102. if (parse_port(service, strlen(service), port)) {
  6103. if (sockaddr_ptr->sa_family == AF_INET) {
  6104. reinterpret_cast<struct sockaddr_in *>((*current)->ai_addr)
  6105. ->sin_port = htons(static_cast<uint16_t>(port));
  6106. } else if (sockaddr_ptr->sa_family == AF_INET6) {
  6107. reinterpret_cast<struct sockaddr_in6 *>((*current)->ai_addr)
  6108. ->sin6_port = htons(static_cast<uint16_t>(port));
  6109. }
  6110. }
  6111. }
  6112. current = &((*current)->ai_next);
  6113. }
  6114. CFRelease(context.addresses);
  6115. CFRelease(host_ref);
  6116. *res = result_addrinfo;
  6117. return 0;
  6118. #elif defined(_GNU_SOURCE) && defined(__GLIBC__) && \
  6119. (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 2)) && \
  6120. !defined(CPPHTTPLIB_THREAD_SANITIZER)
  6121. // Skipped under TSan: glibc's internal resolver thread is invisible to it.
  6122. // #2431: gai_cancel() is non-blocking and may return EAI_NOTCANCELED while
  6123. // the resolver worker still references the stack-local gaicb. The cancel
  6124. // path therefore waits (gai_suspend with no timeout) for the worker to
  6125. // actually finish before letting the stack frame go. The trade-off is that
  6126. // a wedged DNS server can hold this thread for the system resolver timeout
  6127. // (~30s by default) past the caller's connection timeout.
  6128. struct gaicb request{};
  6129. struct gaicb *requests[1] = {&request};
  6130. struct sigevent sevp{};
  6131. struct timespec timeout{timeout_sec, 0};
  6132. request.ar_name = node;
  6133. request.ar_service = service;
  6134. request.ar_request = hints;
  6135. sevp.sigev_notify = SIGEV_NONE;
  6136. int rc = getaddrinfo_a(GAI_NOWAIT, requests, 1, &sevp);
  6137. if (rc != 0) { return rc; }
  6138. auto cleanup = scope_exit([&] {
  6139. if (request.ar_result) { freeaddrinfo(request.ar_result); }
  6140. });
  6141. int wait_result = gai_suspend(requests, 1, &timeout);
  6142. if (wait_result == 0 || wait_result == EAI_ALLDONE) {
  6143. int gai_result = gai_error(&request);
  6144. if (gai_result == 0) {
  6145. *res = request.ar_result;
  6146. request.ar_result = nullptr;
  6147. return 0;
  6148. }
  6149. return gai_result;
  6150. }
  6151. gai_cancel(&request);
  6152. while (gai_error(&request) == EAI_INPROGRESS) {
  6153. gai_suspend(requests, 1, nullptr);
  6154. }
  6155. return wait_result;
  6156. #else
  6157. // Fallback implementation using thread-based timeout for other Unix systems.
  6158. struct GetAddrInfoState {
  6159. ~GetAddrInfoState() {
  6160. if (info) { freeaddrinfo(info); }
  6161. }
  6162. std::mutex mutex;
  6163. std::condition_variable result_cv;
  6164. bool completed = false;
  6165. int result = EAI_SYSTEM;
  6166. std::string node;
  6167. std::string service;
  6168. struct addrinfo hints;
  6169. struct addrinfo *info = nullptr;
  6170. };
  6171. // Allocate on the heap, so the resolver thread can keep using the data.
  6172. auto state = std::make_shared<GetAddrInfoState>();
  6173. if (node) { state->node = node; }
  6174. state->service = service;
  6175. state->hints = *hints;
  6176. std::thread resolve_thread([state]() {
  6177. auto thread_result =
  6178. getaddrinfo(state->node.c_str(), state->service.c_str(), &state->hints,
  6179. &state->info);
  6180. std::lock_guard<std::mutex> lock(state->mutex);
  6181. state->result = thread_result;
  6182. state->completed = true;
  6183. state->result_cv.notify_one();
  6184. });
  6185. // Wait for completion or timeout
  6186. std::unique_lock<std::mutex> lock(state->mutex);
  6187. auto finished =
  6188. state->result_cv.wait_for(lock, std::chrono::seconds(timeout_sec),
  6189. [&] { return state->completed; });
  6190. if (finished) {
  6191. // Operation completed within timeout
  6192. resolve_thread.join();
  6193. *res = state->info;
  6194. state->info = nullptr; // Pass ownership to caller
  6195. return state->result;
  6196. } else {
  6197. // Timeout occurred
  6198. resolve_thread.detach(); // Let the thread finish in background
  6199. return EAI_AGAIN; // Return timeout error
  6200. }
  6201. #endif
  6202. #else
  6203. (void)(timeout_sec); // Unused parameter for non-blocking getaddrinfo
  6204. return getaddrinfo(node, service, hints, res);
  6205. #endif
  6206. }
  6207. template <typename BindOrConnect>
  6208. socket_t create_socket(const std::string &host, const std::string &ip, int port,
  6209. int address_family, int socket_flags, bool tcp_nodelay,
  6210. bool ipv6_v6only, SocketOptions socket_options,
  6211. BindOrConnect bind_or_connect, time_t timeout_sec = 0) {
  6212. // Get address info
  6213. const char *node = nullptr;
  6214. struct addrinfo hints;
  6215. struct addrinfo *result;
  6216. memset(&hints, 0, sizeof(struct addrinfo));
  6217. hints.ai_socktype = SOCK_STREAM;
  6218. hints.ai_protocol = IPPROTO_IP;
  6219. if (!ip.empty()) {
  6220. node = ip.c_str();
  6221. // Ask getaddrinfo to convert IP in c-string to address
  6222. hints.ai_family = AF_UNSPEC;
  6223. hints.ai_flags = AI_NUMERICHOST;
  6224. } else {
  6225. if (!host.empty()) { node = host.c_str(); }
  6226. hints.ai_family = address_family;
  6227. hints.ai_flags = socket_flags;
  6228. }
  6229. #if !defined(_WIN32) || defined(CPPHTTPLIB_HAVE_AFUNIX_H)
  6230. if (hints.ai_family == AF_UNIX) {
  6231. const auto addrlen = host.length();
  6232. if (addrlen > sizeof(sockaddr_un::sun_path)) { return INVALID_SOCKET; }
  6233. #ifdef SOCK_CLOEXEC
  6234. auto sock = socket(hints.ai_family, hints.ai_socktype | SOCK_CLOEXEC,
  6235. hints.ai_protocol);
  6236. #else
  6237. auto sock = socket(hints.ai_family, hints.ai_socktype, hints.ai_protocol);
  6238. #endif
  6239. if (sock != INVALID_SOCKET) {
  6240. sockaddr_un addr{};
  6241. addr.sun_family = AF_UNIX;
  6242. auto unescaped_host = unescape_abstract_namespace_unix_domain(host);
  6243. std::copy(unescaped_host.begin(), unescaped_host.end(), addr.sun_path);
  6244. hints.ai_addr = reinterpret_cast<sockaddr *>(&addr);
  6245. hints.ai_addrlen = static_cast<socklen_t>(
  6246. sizeof(addr) - sizeof(addr.sun_path) + addrlen);
  6247. #ifndef SOCK_CLOEXEC
  6248. #ifndef _WIN32
  6249. fcntl(sock, F_SETFD, FD_CLOEXEC);
  6250. #endif
  6251. #endif
  6252. if (socket_options) { socket_options(sock); }
  6253. #ifdef _WIN32
  6254. // Setting SO_REUSEADDR seems not to work well with AF_UNIX on windows, so
  6255. // remove the option.
  6256. set_socket_opt(sock, SOL_SOCKET, SO_REUSEADDR, 0);
  6257. #endif
  6258. bool dummy;
  6259. if (!bind_or_connect(sock, hints, dummy)) {
  6260. close_socket(sock);
  6261. sock = INVALID_SOCKET;
  6262. }
  6263. }
  6264. return sock;
  6265. }
  6266. #endif
  6267. auto service = std::to_string(port);
  6268. if (getaddrinfo_with_timeout(node, service.c_str(), &hints, &result,
  6269. timeout_sec)) {
  6270. #if defined __linux__ && !defined __ANDROID__
  6271. res_init();
  6272. #endif
  6273. return INVALID_SOCKET;
  6274. }
  6275. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6276. for (auto rp = result; rp; rp = rp->ai_next) {
  6277. // Create a socket
  6278. #ifdef _WIN32
  6279. auto sock =
  6280. WSASocketW(rp->ai_family, rp->ai_socktype, rp->ai_protocol, nullptr, 0,
  6281. WSA_FLAG_NO_HANDLE_INHERIT | WSA_FLAG_OVERLAPPED);
  6282. /**
  6283. * Since the WSA_FLAG_NO_HANDLE_INHERIT is only supported on Windows 7 SP1
  6284. * and above the socket creation fails on older Windows Systems.
  6285. *
  6286. * Let's try to create a socket the old way in this case.
  6287. *
  6288. * Reference:
  6289. * https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketa
  6290. *
  6291. * WSA_FLAG_NO_HANDLE_INHERIT:
  6292. * This flag is supported on Windows 7 with SP1, Windows Server 2008 R2 with
  6293. * SP1, and later
  6294. *
  6295. */
  6296. if (sock == INVALID_SOCKET) {
  6297. sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6298. }
  6299. #else
  6300. #ifdef SOCK_CLOEXEC
  6301. auto sock =
  6302. socket(rp->ai_family, rp->ai_socktype | SOCK_CLOEXEC, rp->ai_protocol);
  6303. #else
  6304. auto sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6305. #endif
  6306. #endif
  6307. if (sock == INVALID_SOCKET) { continue; }
  6308. #if !defined _WIN32 && !defined SOCK_CLOEXEC
  6309. if (fcntl(sock, F_SETFD, FD_CLOEXEC) == -1) {
  6310. close_socket(sock);
  6311. continue;
  6312. }
  6313. #endif
  6314. if (tcp_nodelay) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  6315. if (rp->ai_family == AF_INET6) {
  6316. set_socket_opt(sock, IPPROTO_IPV6, IPV6_V6ONLY, ipv6_v6only ? 1 : 0);
  6317. }
  6318. if (socket_options) { socket_options(sock); }
  6319. // bind or connect
  6320. auto quit = false;
  6321. if (bind_or_connect(sock, *rp, quit)) { return sock; }
  6322. close_socket(sock);
  6323. if (quit) { break; }
  6324. }
  6325. return INVALID_SOCKET;
  6326. }
  6327. inline void set_nonblocking(socket_t sock, bool nonblocking) {
  6328. #ifdef _WIN32
  6329. auto flags = nonblocking ? 1UL : 0UL;
  6330. ioctlsocket(sock, FIONBIO, &flags);
  6331. #else
  6332. auto flags = fcntl(sock, F_GETFL, 0);
  6333. fcntl(sock, F_SETFL,
  6334. nonblocking ? (flags | O_NONBLOCK) : (flags & (~O_NONBLOCK)));
  6335. #endif
  6336. }
  6337. inline bool is_connection_error() {
  6338. #ifdef _WIN32
  6339. return WSAGetLastError() != WSAEWOULDBLOCK;
  6340. #else
  6341. return errno != EINPROGRESS;
  6342. #endif
  6343. }
  6344. // accept() failed because the process or the network stack is temporarily out
  6345. // of resources. The listening socket is still usable, so back off briefly and
  6346. // try again.
  6347. inline bool is_accept_resource_error() {
  6348. #ifdef _WIN32
  6349. auto err = WSAGetLastError();
  6350. return err == WSAEMFILE || err == WSAENOBUFS;
  6351. #else
  6352. auto err = errno;
  6353. return err == EMFILE || err == ENFILE || err == ENOBUFS || err == ENOMEM;
  6354. #endif
  6355. }
  6356. // accept() failed for a reason that says nothing about the listening socket:
  6357. // the pending connection went away before it could be accepted, or the call
  6358. // was interrupted. Retry immediately. WSAAccept()'s own documentation omits
  6359. // WSAECONNRESET, but the accept() it wraps reports an aborted pending
  6360. // connection that way.
  6361. inline bool is_accept_transient_error() {
  6362. #ifdef _WIN32
  6363. auto err = WSAGetLastError();
  6364. return err == WSAEINTR || err == WSAEWOULDBLOCK || err == WSAECONNRESET ||
  6365. err == WSAECONNABORTED;
  6366. #else
  6367. auto err = errno;
  6368. return err == EINTR || err == EAGAIN || err == EWOULDBLOCK ||
  6369. err == ECONNABORTED;
  6370. #endif
  6371. }
  6372. inline bool bind_ip_address(socket_t sock, const std::string &host) {
  6373. struct addrinfo hints;
  6374. struct addrinfo *result;
  6375. memset(&hints, 0, sizeof(struct addrinfo));
  6376. hints.ai_family = AF_UNSPEC;
  6377. hints.ai_socktype = SOCK_STREAM;
  6378. hints.ai_protocol = 0;
  6379. if (getaddrinfo_with_timeout(host.c_str(), "0", &hints, &result, 0)) {
  6380. return false;
  6381. }
  6382. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6383. auto ret = false;
  6384. for (auto rp = result; rp; rp = rp->ai_next) {
  6385. const auto &ai = *rp;
  6386. if (!::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  6387. ret = true;
  6388. break;
  6389. }
  6390. }
  6391. return ret;
  6392. }
  6393. #if !defined _WIN32 && !defined ANDROID && !defined _AIX && !defined __MVS__
  6394. #define USE_IF2IP
  6395. #endif
  6396. #ifdef USE_IF2IP
  6397. inline std::string if2ip(int address_family, const std::string &ifn) {
  6398. struct ifaddrs *ifap;
  6399. getifaddrs(&ifap);
  6400. auto se = detail::scope_exit([&] { freeifaddrs(ifap); });
  6401. std::string addr_candidate;
  6402. for (auto ifa = ifap; ifa; ifa = ifa->ifa_next) {
  6403. if (ifa->ifa_addr && ifn == ifa->ifa_name &&
  6404. (AF_UNSPEC == address_family ||
  6405. ifa->ifa_addr->sa_family == address_family)) {
  6406. if (ifa->ifa_addr->sa_family == AF_INET) {
  6407. auto sa = reinterpret_cast<struct sockaddr_in *>(ifa->ifa_addr);
  6408. char buf[INET_ADDRSTRLEN];
  6409. if (inet_ntop(AF_INET, &sa->sin_addr, buf, INET_ADDRSTRLEN)) {
  6410. return std::string(buf, INET_ADDRSTRLEN);
  6411. }
  6412. } else if (ifa->ifa_addr->sa_family == AF_INET6) {
  6413. auto sa = reinterpret_cast<struct sockaddr_in6 *>(ifa->ifa_addr);
  6414. if (!IN6_IS_ADDR_LINKLOCAL(&sa->sin6_addr)) {
  6415. char buf[INET6_ADDRSTRLEN] = {};
  6416. if (inet_ntop(AF_INET6, &sa->sin6_addr, buf, INET6_ADDRSTRLEN)) {
  6417. // equivalent to mac's IN6_IS_ADDR_UNIQUE_LOCAL
  6418. auto s6_addr_head = sa->sin6_addr.s6_addr[0];
  6419. if (s6_addr_head == 0xfc || s6_addr_head == 0xfd) {
  6420. addr_candidate = std::string(buf, INET6_ADDRSTRLEN);
  6421. } else {
  6422. return std::string(buf, INET6_ADDRSTRLEN);
  6423. }
  6424. }
  6425. }
  6426. }
  6427. }
  6428. }
  6429. return addr_candidate;
  6430. }
  6431. #endif
  6432. inline socket_t create_client_socket(
  6433. const std::string &host, const std::string &ip, int port,
  6434. int address_family, bool tcp_nodelay, bool ipv6_v6only,
  6435. SocketOptions socket_options, time_t connection_timeout_sec,
  6436. time_t connection_timeout_usec, time_t read_timeout_sec,
  6437. time_t read_timeout_usec, time_t write_timeout_sec,
  6438. time_t write_timeout_usec, const std::string &intf, Error &error) {
  6439. auto sock = create_socket(
  6440. host, ip, port, address_family, 0, tcp_nodelay, ipv6_v6only,
  6441. std::move(socket_options),
  6442. [&](socket_t sock2, struct addrinfo &ai, bool &quit) -> bool {
  6443. if (!intf.empty()) {
  6444. #ifdef USE_IF2IP
  6445. auto ip_from_if = if2ip(address_family, intf);
  6446. if (ip_from_if.empty()) { ip_from_if = intf; }
  6447. if (!bind_ip_address(sock2, ip_from_if)) {
  6448. error = Error::BindIPAddress;
  6449. return false;
  6450. }
  6451. #endif
  6452. }
  6453. set_nonblocking(sock2, true);
  6454. auto ret =
  6455. ::connect(sock2, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen));
  6456. if (ret < 0) {
  6457. if (is_connection_error()) {
  6458. error = Error::Connection;
  6459. return false;
  6460. }
  6461. error = wait_until_socket_is_ready(sock2, connection_timeout_sec,
  6462. connection_timeout_usec);
  6463. if (error != Error::Success) {
  6464. if (error == Error::ConnectionTimeout) { quit = true; }
  6465. return false;
  6466. }
  6467. }
  6468. set_nonblocking(sock2, false);
  6469. set_socket_opt_time(sock2, SOL_SOCKET, SO_RCVTIMEO, read_timeout_sec,
  6470. read_timeout_usec);
  6471. set_socket_opt_time(sock2, SOL_SOCKET, SO_SNDTIMEO, write_timeout_sec,
  6472. write_timeout_usec);
  6473. error = Error::Success;
  6474. return true;
  6475. },
  6476. connection_timeout_sec); // Pass DNS timeout
  6477. if (sock != INVALID_SOCKET) {
  6478. error = Error::Success;
  6479. } else {
  6480. if (error == Error::Success) { error = Error::Connection; }
  6481. }
  6482. return sock;
  6483. }
  6484. inline bool get_ip_and_port(const struct sockaddr_storage &addr,
  6485. socklen_t addr_len, std::string &ip, int &port) {
  6486. if (addr.ss_family == AF_INET) {
  6487. port = ntohs(reinterpret_cast<const struct sockaddr_in *>(&addr)->sin_port);
  6488. } else if (addr.ss_family == AF_INET6) {
  6489. port =
  6490. ntohs(reinterpret_cast<const struct sockaddr_in6 *>(&addr)->sin6_port);
  6491. } else {
  6492. return false;
  6493. }
  6494. std::array<char, NI_MAXHOST> ipstr{};
  6495. if (getnameinfo(reinterpret_cast<const struct sockaddr *>(&addr), addr_len,
  6496. ipstr.data(), static_cast<socklen_t>(ipstr.size()), nullptr,
  6497. 0, NI_NUMERICHOST)) {
  6498. return false;
  6499. }
  6500. ip = ipstr.data();
  6501. return true;
  6502. }
  6503. inline void get_local_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6504. struct sockaddr_storage addr;
  6505. socklen_t addr_len = sizeof(addr);
  6506. if (!getsockname(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6507. &addr_len)) {
  6508. get_ip_and_port(addr, addr_len, ip, port);
  6509. }
  6510. }
  6511. inline void get_remote_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6512. struct sockaddr_storage addr;
  6513. socklen_t addr_len = sizeof(addr);
  6514. if (!getpeername(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6515. &addr_len)) {
  6516. #ifndef _WIN32
  6517. if (addr.ss_family == AF_UNIX) {
  6518. #if defined(__linux__)
  6519. struct ucred ucred;
  6520. socklen_t len = sizeof(ucred);
  6521. if (getsockopt(sock, SOL_SOCKET, SO_PEERCRED, &ucred, &len) == 0) {
  6522. port = ucred.pid;
  6523. }
  6524. #elif defined(SOL_LOCAL) && defined(SO_PEERPID)
  6525. pid_t pid;
  6526. socklen_t len = sizeof(pid);
  6527. if (getsockopt(sock, SOL_LOCAL, SO_PEERPID, &pid, &len) == 0) {
  6528. port = pid;
  6529. }
  6530. #endif
  6531. return;
  6532. }
  6533. #endif
  6534. get_ip_and_port(addr, addr_len, ip, port);
  6535. }
  6536. }
  6537. inline std::string
  6538. find_content_type(const std::string &path,
  6539. const std::map<std::string, std::string> &user_data,
  6540. const std::string &default_content_type) {
  6541. // Extensions are matched regardless of case, as web servers do
  6542. auto ext = case_ignore::to_lower(file_extension(path));
  6543. auto it = user_data.find(ext);
  6544. if (it != user_data.end()) { return it->second; }
  6545. static const struct {
  6546. const char *ext;
  6547. const char *type;
  6548. } types[] = {
  6549. {"css", "text/css"},
  6550. {"csv", "text/csv"},
  6551. {"htm", "text/html"},
  6552. {"html", "text/html"},
  6553. {"js", "text/javascript"},
  6554. {"mjs", "text/javascript"},
  6555. {"txt", "text/plain"},
  6556. {"vtt", "text/vtt"},
  6557. {"apng", "image/apng"},
  6558. {"avif", "image/avif"},
  6559. {"bmp", "image/bmp"},
  6560. {"gif", "image/gif"},
  6561. {"png", "image/png"},
  6562. {"svg", "image/svg+xml"},
  6563. {"webp", "image/webp"},
  6564. {"ico", "image/x-icon"},
  6565. {"tif", "image/tiff"},
  6566. {"tiff", "image/tiff"},
  6567. {"jpg", "image/jpeg"},
  6568. {"jpeg", "image/jpeg"},
  6569. {"mp4", "video/mp4"},
  6570. {"mpeg", "video/mpeg"},
  6571. {"webm", "video/webm"},
  6572. {"mp3", "audio/mp3"},
  6573. {"mpga", "audio/mpeg"},
  6574. {"weba", "audio/webm"},
  6575. {"wav", "audio/wave"},
  6576. {"otf", "font/otf"},
  6577. {"ttf", "font/ttf"},
  6578. {"woff", "font/woff"},
  6579. {"woff2", "font/woff2"},
  6580. {"7z", "application/x-7z-compressed"},
  6581. {"atom", "application/atom+xml"},
  6582. {"pdf", "application/pdf"},
  6583. {"json", "application/json"},
  6584. {"rss", "application/rss+xml"},
  6585. {"tar", "application/x-tar"},
  6586. {"xht", "application/xhtml+xml"},
  6587. {"xhtml", "application/xhtml+xml"},
  6588. {"xslt", "application/xslt+xml"},
  6589. {"xml", "application/xml"},
  6590. {"gz", "application/gzip"},
  6591. {"zip", "application/zip"},
  6592. {"wasm", "application/wasm"},
  6593. };
  6594. for (const auto &t : types) {
  6595. if (ext == t.ext) { return t.type; }
  6596. }
  6597. return default_content_type;
  6598. }
  6599. inline std::string
  6600. extract_media_type(const std::string &content_type,
  6601. std::map<std::string, std::string> *params = nullptr) {
  6602. // Extract type/subtype from Content-Type value (RFC 2045)
  6603. // e.g. "application/json; charset=utf-8" -> "application/json"
  6604. auto media_type = content_type;
  6605. auto semicolon_pos = media_type.find(';');
  6606. if (semicolon_pos != std::string::npos) {
  6607. auto param_str = media_type.substr(semicolon_pos + 1);
  6608. media_type = media_type.substr(0, semicolon_pos);
  6609. if (params) {
  6610. // Parse parameters: key=value pairs separated by ';'
  6611. split_unquoted(param_str.data(), param_str.data() + param_str.size(), ';',
  6612. [&](const char *b, const char *e) {
  6613. std::string key;
  6614. std::string val;
  6615. divide_param_pair(b, e, key, val);
  6616. // Parameter names are case-insensitive (RFC 9110
  6617. // §5.6.6)
  6618. if (!key.empty()) {
  6619. params->emplace(case_ignore::to_lower(trim_copy(key)),
  6620. unquote_param(val));
  6621. }
  6622. });
  6623. }
  6624. }
  6625. // Trim whitespace from media type
  6626. return trim_copy(media_type);
  6627. }
  6628. inline bool can_compress_content_type(const std::string &content_type) {
  6629. // Media types are case-insensitive (RFC 9110 §8.3.1)
  6630. auto mime_type = case_ignore::to_lower(extract_media_type(content_type));
  6631. static const char *const compressible[] = {
  6632. "image/svg+xml",
  6633. "application/javascript",
  6634. "application/x-javascript",
  6635. "application/json",
  6636. "application/ld+json",
  6637. "application/xml",
  6638. "application/xhtml+xml",
  6639. "application/rss+xml",
  6640. "application/atom+xml",
  6641. "application/xslt+xml",
  6642. "application/protobuf",
  6643. };
  6644. for (auto type : compressible) {
  6645. if (mime_type == type) { return true; }
  6646. }
  6647. return mime_type != "text/event-stream" && !mime_type.rfind("text/", 0);
  6648. }
  6649. inline bool parse_quality(const char *b, const char *e, std::string &token,
  6650. double &quality) {
  6651. quality = 1.0;
  6652. token.clear();
  6653. // Split on first ';': left = token name, right = parameters
  6654. const char *params_b = nullptr;
  6655. std::size_t params_len = 0;
  6656. divide(
  6657. b, static_cast<std::size_t>(e - b), ';',
  6658. [&](const char *lb, std::size_t llen, const char *rb, std::size_t rlen) {
  6659. auto r = trim(lb, lb + llen, 0, llen);
  6660. if (r.first < r.second) { token.assign(lb + r.first, lb + r.second); }
  6661. params_b = rb;
  6662. params_len = rlen;
  6663. });
  6664. if (token.empty()) { return false; }
  6665. if (params_len == 0) { return true; }
  6666. // Scan parameters for q= (stops on first match)
  6667. bool invalid = false;
  6668. split_find(params_b, params_b + params_len, ';',
  6669. (std::numeric_limits<size_t>::max)(),
  6670. [&](const char *pb, const char *pe) -> bool {
  6671. // Match exactly "q=" or "Q=" (not "query=" etc.)
  6672. auto len = static_cast<size_t>(pe - pb);
  6673. if (len < 2) { return false; }
  6674. if ((pb[0] != 'q' && pb[0] != 'Q') || pb[1] != '=') {
  6675. return false;
  6676. }
  6677. // Trim the value portion
  6678. auto r = trim(pb, pe, 2, len);
  6679. if (r.first >= r.second) {
  6680. invalid = true;
  6681. return true;
  6682. }
  6683. double v = 0.0;
  6684. auto res = from_chars(pb + r.first, pb + r.second, v);
  6685. if (res.ec != std::errc{} || res.ptr != pb + r.second ||
  6686. v < 0.0 || v > 1.0) {
  6687. invalid = true;
  6688. return true;
  6689. }
  6690. quality = v;
  6691. return true;
  6692. });
  6693. return !invalid;
  6694. }
  6695. inline EncodingType encoding_type(const Request &req,
  6696. const std::string &content_type) {
  6697. if (!can_compress_content_type(content_type)) { return EncodingType::None; }
  6698. auto s = get_combined_header_value(req.headers, "Accept-Encoding");
  6699. if (s.empty()) { return EncodingType::None; }
  6700. // Single-pass: iterate tokens and track the best supported encoding.
  6701. // Server preference breaks ties (br > gzip > zstd).
  6702. EncodingType best = EncodingType::None;
  6703. double best_q = 0.0; // q=0 means "not acceptable"
  6704. // Server preference: Brotli > Gzip > Zstd (lower = more preferred)
  6705. auto priority = [](EncodingType t) -> int {
  6706. switch (t) {
  6707. case EncodingType::Brotli: return 0;
  6708. case EncodingType::Gzip: return 1;
  6709. case EncodingType::Zstd: return 2;
  6710. default: return 3;
  6711. }
  6712. };
  6713. std::string name;
  6714. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  6715. double quality = 1.0;
  6716. if (!parse_quality(b, e, name, quality)) { return; }
  6717. if (quality <= 0.0) { return; }
  6718. EncodingType type = EncodingType::None;
  6719. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6720. if (case_ignore::equal(name, "br")) { type = EncodingType::Brotli; }
  6721. #endif
  6722. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6723. if (type == EncodingType::None && case_ignore::equal(name, "gzip")) {
  6724. type = EncodingType::Gzip;
  6725. }
  6726. #endif
  6727. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6728. if (type == EncodingType::None && case_ignore::equal(name, "zstd")) {
  6729. type = EncodingType::Zstd;
  6730. }
  6731. #endif
  6732. if (type == EncodingType::None) { return; }
  6733. // Higher q-value wins; for equal q, server preference breaks ties
  6734. if (quality > best_q ||
  6735. (quality == best_q && priority(type) < priority(best))) {
  6736. best_q = quality;
  6737. best = type;
  6738. }
  6739. });
  6740. return best;
  6741. }
  6742. // `content_type` is taken separately because a file-backed response has not
  6743. // been given one yet when its coding has to be decided.
  6744. inline EncodingType encoding_type(const Request &req, const Response &res,
  6745. const std::string &content_type) {
  6746. // The response already names a content coding of its own: a handler serving
  6747. // a body it encoded itself (pre-compressed static assets, say), or a mount
  6748. // point whose headers name the coding its files are stored in. Applying one
  6749. // on top of that would double-encode the body and append a second
  6750. // `Content-Encoding` field line.
  6751. if (res.has_header("Content-Encoding")) { return EncodingType::None; }
  6752. return encoding_type(req, content_type);
  6753. }
  6754. inline EncodingType encoding_type(const Request &req, const Response &res) {
  6755. return encoding_type(req, res, res.get_header_value("Content-Type"));
  6756. }
  6757. inline std::unique_ptr<compressor> make_compressor(EncodingType type) {
  6758. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6759. if (type == EncodingType::Gzip) {
  6760. return detail::make_unique<gzip_compressor>();
  6761. }
  6762. #endif
  6763. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6764. if (type == EncodingType::Brotli) {
  6765. return detail::make_unique<brotli_compressor>();
  6766. }
  6767. #endif
  6768. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6769. if (type == EncodingType::Zstd) {
  6770. return detail::make_unique<zstd_compressor>();
  6771. }
  6772. #endif
  6773. (void)type;
  6774. return nullptr;
  6775. }
  6776. inline const char *encoding_name(EncodingType type) {
  6777. switch (type) {
  6778. case EncodingType::Gzip: return "gzip";
  6779. case EncodingType::Brotli: return "br";
  6780. case EncodingType::Zstd: return "zstd";
  6781. default: return "";
  6782. }
  6783. }
  6784. inline bool nocompressor::compress(const char *data, size_t data_length,
  6785. bool /*last*/, Callback callback) {
  6786. if (!data_length) { return true; }
  6787. return callback(data, data_length);
  6788. }
  6789. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6790. inline gzip_compressor::gzip_compressor() {
  6791. std::memset(&strm_, 0, sizeof(strm_));
  6792. strm_.zalloc = Z_NULL;
  6793. strm_.zfree = Z_NULL;
  6794. strm_.opaque = Z_NULL;
  6795. is_valid_ = deflateInit2(&strm_, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 31, 8,
  6796. Z_DEFAULT_STRATEGY) == Z_OK;
  6797. }
  6798. inline gzip_compressor::~gzip_compressor() { deflateEnd(&strm_); }
  6799. inline bool gzip_compressor::compress(const char *data, size_t data_length,
  6800. bool last, Callback callback) {
  6801. assert(is_valid_);
  6802. do {
  6803. constexpr size_t max_avail_in =
  6804. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6805. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6806. (std::min)(data_length, max_avail_in));
  6807. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6808. data_length -= strm_.avail_in;
  6809. data += strm_.avail_in;
  6810. auto flush = (last && data_length == 0) ? Z_FINISH : Z_NO_FLUSH;
  6811. auto ret = Z_OK;
  6812. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6813. do {
  6814. strm_.avail_out = static_cast<uInt>(buff.size());
  6815. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6816. ret = deflate(&strm_, flush);
  6817. if (ret == Z_STREAM_ERROR) { return false; }
  6818. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6819. return false;
  6820. }
  6821. } while (strm_.avail_out == 0);
  6822. assert((flush == Z_FINISH && ret == Z_STREAM_END) ||
  6823. (flush == Z_NO_FLUSH && ret == Z_OK));
  6824. assert(strm_.avail_in == 0);
  6825. } while (data_length > 0);
  6826. return true;
  6827. }
  6828. inline gzip_decompressor::gzip_decompressor() {
  6829. std::memset(&strm_, 0, sizeof(strm_));
  6830. strm_.zalloc = Z_NULL;
  6831. strm_.zfree = Z_NULL;
  6832. strm_.opaque = Z_NULL;
  6833. // 15 is the value of wbits, which should be at the maximum possible value
  6834. // to ensure that any gzip stream can be decoded. The offset of 32 specifies
  6835. // that the stream type should be automatically detected either gzip or
  6836. // deflate.
  6837. is_valid_ = inflateInit2(&strm_, 32 + 15) == Z_OK;
  6838. }
  6839. inline gzip_decompressor::~gzip_decompressor() { inflateEnd(&strm_); }
  6840. inline bool gzip_decompressor::is_valid() const { return is_valid_; }
  6841. inline bool gzip_decompressor::decompress(const char *data, size_t data_length,
  6842. Callback callback) {
  6843. assert(is_valid_);
  6844. auto ret = Z_OK;
  6845. do {
  6846. constexpr size_t max_avail_in =
  6847. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6848. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6849. (std::min)(data_length, max_avail_in));
  6850. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6851. data_length -= strm_.avail_in;
  6852. data += strm_.avail_in;
  6853. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6854. while (strm_.avail_in > 0 && ret == Z_OK) {
  6855. strm_.avail_out = static_cast<uInt>(buff.size());
  6856. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6857. ret = inflate(&strm_, Z_NO_FLUSH);
  6858. assert(ret != Z_STREAM_ERROR);
  6859. switch (ret) {
  6860. case Z_NEED_DICT:
  6861. case Z_DATA_ERROR:
  6862. case Z_MEM_ERROR: inflateEnd(&strm_); return false;
  6863. }
  6864. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6865. return false;
  6866. }
  6867. }
  6868. if (ret != Z_OK && ret != Z_STREAM_END) { return false; }
  6869. } while (data_length > 0);
  6870. return true;
  6871. }
  6872. #endif
  6873. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6874. inline brotli_compressor::brotli_compressor() {
  6875. state_ = BrotliEncoderCreateInstance(nullptr, nullptr, nullptr);
  6876. }
  6877. inline brotli_compressor::~brotli_compressor() {
  6878. BrotliEncoderDestroyInstance(state_);
  6879. }
  6880. inline bool brotli_compressor::compress(const char *data, size_t data_length,
  6881. bool last, Callback callback) {
  6882. std::array<uint8_t, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6883. auto operation = last ? BROTLI_OPERATION_FINISH : BROTLI_OPERATION_PROCESS;
  6884. auto available_in = data_length;
  6885. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6886. for (;;) {
  6887. if (last) {
  6888. if (BrotliEncoderIsFinished(state_)) { break; }
  6889. } else {
  6890. if (!available_in) { break; }
  6891. }
  6892. auto available_out = buff.size();
  6893. auto next_out = buff.data();
  6894. if (!BrotliEncoderCompressStream(state_, operation, &available_in, &next_in,
  6895. &available_out, &next_out, nullptr)) {
  6896. return false;
  6897. }
  6898. auto output_bytes = buff.size() - available_out;
  6899. if (output_bytes) {
  6900. callback(reinterpret_cast<const char *>(buff.data()), output_bytes);
  6901. }
  6902. }
  6903. return true;
  6904. }
  6905. inline brotli_decompressor::brotli_decompressor() {
  6906. decoder_s = BrotliDecoderCreateInstance(0, 0, 0);
  6907. decoder_r = decoder_s ? BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT
  6908. : BROTLI_DECODER_RESULT_ERROR;
  6909. }
  6910. inline brotli_decompressor::~brotli_decompressor() {
  6911. if (decoder_s) { BrotliDecoderDestroyInstance(decoder_s); }
  6912. }
  6913. inline bool brotli_decompressor::is_valid() const { return decoder_s; }
  6914. inline bool brotli_decompressor::decompress(const char *data,
  6915. size_t data_length,
  6916. Callback callback) {
  6917. if (decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6918. decoder_r == BROTLI_DECODER_RESULT_ERROR) {
  6919. return 0;
  6920. }
  6921. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6922. size_t avail_in = data_length;
  6923. size_t total_out;
  6924. decoder_r = BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT;
  6925. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6926. while (decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT) {
  6927. char *next_out = buff.data();
  6928. size_t avail_out = buff.size();
  6929. decoder_r = BrotliDecoderDecompressStream(
  6930. decoder_s, &avail_in, &next_in, &avail_out,
  6931. reinterpret_cast<uint8_t **>(&next_out), &total_out);
  6932. if (decoder_r == BROTLI_DECODER_RESULT_ERROR) { return false; }
  6933. if (!callback(buff.data(), buff.size() - avail_out)) { return false; }
  6934. }
  6935. return decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6936. decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT;
  6937. }
  6938. #endif
  6939. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6940. inline zstd_compressor::zstd_compressor() {
  6941. ctx_ = ZSTD_createCCtx();
  6942. ZSTD_CCtx_setParameter(ctx_, ZSTD_c_compressionLevel, ZSTD_fast);
  6943. }
  6944. inline zstd_compressor::~zstd_compressor() { ZSTD_freeCCtx(ctx_); }
  6945. inline bool zstd_compressor::compress(const char *data, size_t data_length,
  6946. bool last, Callback callback) {
  6947. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6948. ZSTD_EndDirective mode = last ? ZSTD_e_end : ZSTD_e_continue;
  6949. ZSTD_inBuffer input = {data, data_length, 0};
  6950. bool finished;
  6951. do {
  6952. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6953. size_t const remaining = ZSTD_compressStream2(ctx_, &output, &input, mode);
  6954. if (ZSTD_isError(remaining)) { return false; }
  6955. if (!callback(buff.data(), output.pos)) { return false; }
  6956. finished = last ? (remaining == 0) : (input.pos == input.size);
  6957. } while (!finished);
  6958. return true;
  6959. }
  6960. inline zstd_decompressor::zstd_decompressor() { ctx_ = ZSTD_createDCtx(); }
  6961. inline zstd_decompressor::~zstd_decompressor() { ZSTD_freeDCtx(ctx_); }
  6962. inline bool zstd_decompressor::is_valid() const { return ctx_ != nullptr; }
  6963. inline bool zstd_decompressor::decompress(const char *data, size_t data_length,
  6964. Callback callback) {
  6965. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6966. ZSTD_inBuffer input = {data, data_length, 0};
  6967. while (input.pos < input.size) {
  6968. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6969. size_t const remaining = ZSTD_decompressStream(ctx_, &output, &input);
  6970. if (ZSTD_isError(remaining)) { return false; }
  6971. if (!callback(buff.data(), output.pos)) { return false; }
  6972. }
  6973. return true;
  6974. }
  6975. #endif
  6976. // Content codings are case-insensitive (RFC 9110 8.4.1). Matching them
  6977. // case-sensitively would make a response labeled e.g. "GZIP" look like an
  6978. // unknown coding, and its payload would be handed back still compressed.
  6979. inline bool is_zlib_encoding(const std::string &encoding) {
  6980. return case_ignore::equal(encoding, "gzip") ||
  6981. case_ignore::equal(encoding, "deflate");
  6982. }
  6983. inline bool is_brotli_encoding(const std::string &encoding) {
  6984. return case_ignore::equal(encoding, "br");
  6985. }
  6986. inline bool is_zstd_encoding(const std::string &encoding) {
  6987. return case_ignore::equal(encoding, "zstd");
  6988. }
  6989. // Returns true if the content coding is one cpp-httplib is able to decompress
  6990. // when the corresponding support is compiled in.
  6991. inline bool is_known_content_encoding(const std::string &encoding) {
  6992. return is_zlib_encoding(encoding) || is_brotli_encoding(encoding) ||
  6993. is_zstd_encoding(encoding);
  6994. }
  6995. inline std::unique_ptr<decompressor>
  6996. create_decompressor(const std::string &encoding) {
  6997. std::unique_ptr<decompressor> decompressor;
  6998. if (is_zlib_encoding(encoding)) {
  6999. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  7000. decompressor = detail::make_unique<gzip_decompressor>();
  7001. #endif
  7002. } else if (is_brotli_encoding(encoding)) {
  7003. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  7004. decompressor = detail::make_unique<brotli_decompressor>();
  7005. #endif
  7006. } else if (is_zstd_encoding(encoding)) {
  7007. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  7008. decompressor = detail::make_unique<zstd_decompressor>();
  7009. #endif
  7010. }
  7011. return decompressor;
  7012. }
  7013. // Returns the best available compressor and its Content-Encoding name.
  7014. // Priority: Brotli > Gzip > Zstd (matches server-side preference).
  7015. inline std::pair<std::unique_ptr<compressor>, const char *>
  7016. create_compressor() {
  7017. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  7018. return {detail::make_unique<brotli_compressor>(), "br"};
  7019. #elif defined(CPPHTTPLIB_ZLIB_SUPPORT)
  7020. return {detail::make_unique<gzip_compressor>(), "gzip"};
  7021. #elif defined(CPPHTTPLIB_ZSTD_SUPPORT)
  7022. return {detail::make_unique<zstd_compressor>(), "zstd"};
  7023. #else
  7024. return {nullptr, nullptr};
  7025. #endif
  7026. }
  7027. inline bool is_prohibited_header_name(const std::string &name) {
  7028. // Field names are case-insensitive (RFC 9110 §5.1)
  7029. return case_ignore::equal(name, "REMOTE_ADDR") ||
  7030. case_ignore::equal(name, "REMOTE_PORT") ||
  7031. case_ignore::equal(name, "LOCAL_ADDR") ||
  7032. case_ignore::equal(name, "LOCAL_PORT");
  7033. }
  7034. inline bool has_header(const Headers &headers, const std::string &key) {
  7035. if (is_prohibited_header_name(key)) { return false; }
  7036. return headers.find(key) != headers.end();
  7037. }
  7038. inline const char *get_header_value(const Headers &headers,
  7039. const std::string &key, const char *def,
  7040. size_t id) {
  7041. if (is_prohibited_header_name(key)) {
  7042. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  7043. std::string msg = "Prohibited header name '" + key + "' is specified.";
  7044. throw std::invalid_argument(msg);
  7045. #else
  7046. return "";
  7047. #endif
  7048. }
  7049. auto rng = headers.equal_range(key);
  7050. auto it = bounded_next(rng.first, id, rng.second);
  7051. if (it != rng.second) { return it->second.c_str(); }
  7052. return def;
  7053. }
  7054. inline size_t get_header_value_count(const Headers &headers,
  7055. const std::string &key) {
  7056. return headers.count(key);
  7057. }
  7058. // RFC 9110 Section 5.2 and 5.3: a field that is defined as a comma-separated
  7059. // list may be sent as several field lines, and the combined field value is
  7060. // those values joined by commas in the order they were received. Callers that
  7061. // parse such a list must work on the combined value; reading only the first
  7062. // occurrence silently drops whatever the later field lines carry.
  7063. inline std::string get_combined_header_value(const Headers &headers,
  7064. const std::string &key) {
  7065. std::string combined;
  7066. auto rng = headers.equal_range(key);
  7067. for (auto it = rng.first; it != rng.second; ++it) {
  7068. // RFC 9110 Section 5.6.1.2: a recipient has to parse and ignore empty list
  7069. // elements, so an empty field line must not contribute a bare comma to the
  7070. // combined value.
  7071. if (it->second.empty()) { continue; }
  7072. if (!combined.empty()) { combined += ", "; }
  7073. combined += it->second;
  7074. }
  7075. return combined;
  7076. }
  7077. inline bool has_header_token(const Headers &headers, const std::string &key,
  7078. const std::string &token) {
  7079. // RFC 9110 7.6.1: a comma-separated token list field such as Connection may
  7080. // carry several tokens, and RFC 9110 5.3 lets that list be split across
  7081. // several lines. Match complete tokens rather than searching the raw value,
  7082. // so that a value such as "notupgrade" is not read as the token "upgrade".
  7083. auto rng = headers.equal_range(key);
  7084. for (auto it = rng.first; it != rng.second; ++it) {
  7085. const auto &value = it->second;
  7086. if (split_find(value.data(), value.data() + value.size(), ',',
  7087. [&](const char *b, const char *e) {
  7088. return case_ignore::equal(std::string(b, e), token);
  7089. })) {
  7090. return true;
  7091. }
  7092. }
  7093. return false;
  7094. }
  7095. template <typename Map>
  7096. inline typename Map::mapped_type
  7097. get_multimap_value(const Map &m, const std::string &key, size_t id) {
  7098. auto rng = m.equal_range(key);
  7099. auto it = bounded_next(rng.first, id, rng.second);
  7100. if (it != rng.second) { return it->second; }
  7101. return typename Map::mapped_type();
  7102. }
  7103. inline void set_header(Headers &headers, const std::string &key,
  7104. const std::string &val) {
  7105. if (fields::is_field_valid(key, val)) { headers.emplace(key, val); }
  7106. }
  7107. // Drops the fields set_header() would refuse, from headers an application can
  7108. // fill directly: CR/LF in one would split the message.
  7109. inline void erase_invalid_fields(Headers &headers) {
  7110. for (auto it = headers.begin(); it != headers.end();) {
  7111. if (fields::is_field_valid(it->first, it->second)) {
  7112. ++it;
  7113. } else {
  7114. it = headers.erase(it);
  7115. }
  7116. }
  7117. }
  7118. inline bool read_headers(Stream &strm, Headers &headers) {
  7119. const auto bufsiz = 2048;
  7120. char buf[bufsiz];
  7121. stream_line_reader line_reader(strm, buf, bufsiz);
  7122. size_t header_count = 0;
  7123. for (;;) {
  7124. if (!line_reader.getline()) { return false; }
  7125. // Check if the line ends with CRLF.
  7126. auto line_terminator_len = 2;
  7127. if (line_reader.end_with_crlf()) {
  7128. // Blank line indicates end of headers.
  7129. if (line_reader.size() == 2) { break; }
  7130. } else {
  7131. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  7132. // Blank line indicates end of headers.
  7133. if (line_reader.size() == 1) { break; }
  7134. line_terminator_len = 1;
  7135. #else
  7136. continue; // Skip invalid line.
  7137. #endif
  7138. }
  7139. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  7140. // Check header count limit
  7141. if (header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  7142. // Exclude line terminator
  7143. auto end = line_reader.ptr() + line_reader.size() - line_terminator_len;
  7144. if (!parse_header(line_reader.ptr(), end,
  7145. [&](const std::string &key, const std::string &val) {
  7146. headers.emplace(key, val);
  7147. })) {
  7148. return false;
  7149. }
  7150. header_count++;
  7151. }
  7152. // RFC 9110 Section 8.6: Reject requests with multiple Content-Length
  7153. // headers that have different values to prevent request smuggling.
  7154. auto cl_range = headers.equal_range("Content-Length");
  7155. if (cl_range.first != cl_range.second) {
  7156. const auto &first_val = cl_range.first->second;
  7157. for (auto it = std::next(cl_range.first); it != cl_range.second; ++it) {
  7158. if (it->second != first_val) { return false; }
  7159. }
  7160. }
  7161. return true;
  7162. }
  7163. // Parsed by hand: std::regex_match recurses once per character of the reason
  7164. // phrase, which a server can make as long as a whole line.
  7165. inline bool parse_status_line(const char *line, std::string &version,
  7166. int &status, std::string &reason) {
  7167. if (std::strncmp(line, "HTTP/1.", 7) != 0 ||
  7168. (line[7] != '0' && line[7] != '1') || line[8] != ' ' ||
  7169. !is_ascii_digit(line[9]) || !is_ascii_digit(line[10]) ||
  7170. !is_ascii_digit(line[11])) {
  7171. return false;
  7172. }
  7173. auto p = line + 12;
  7174. auto reason_begin = p;
  7175. if (*p == ' ') {
  7176. reason_begin = ++p;
  7177. p += std::strcspn(p, "\r\n");
  7178. }
  7179. auto reason_end = p;
  7180. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  7181. if (*p == '\r') { p++; }
  7182. #else
  7183. if (*p++ != '\r') { return false; }
  7184. #endif
  7185. if (*p++ != '\n' || *p != '\0') { return false; }
  7186. version.assign(line, 8);
  7187. status = (line[9] - '0') * 100 + (line[10] - '0') * 10 + (line[11] - '0');
  7188. reason.assign(reason_begin, reason_end);
  7189. return true;
  7190. }
  7191. // Everything WebSocketClient::connect() reports about the upgrade exchange.
  7192. // status stays -1 until a status line is parsed, mirroring stream::Result.
  7193. struct WebSocketUpgradeResponse {
  7194. Error error = Error::Success;
  7195. int status = -1;
  7196. Headers headers;
  7197. std::string selected_subprotocol;
  7198. };
  7199. // Reads a response's status line and headers, leaving any body unread. An
  7200. // unparsable status line is no stream error; it just leaves `status` as is.
  7201. inline bool read_response_head(Stream &strm, int &status, Headers &headers) {
  7202. const auto bufsiz = 2048;
  7203. char buf[bufsiz];
  7204. stream_line_reader line_reader(strm, buf, bufsiz);
  7205. if (!line_reader.getline()) { return false; }
  7206. std::string version;
  7207. std::string reason;
  7208. if (!parse_status_line(line_reader.ptr(), version, status, reason)) {
  7209. return true;
  7210. }
  7211. return read_headers(strm, headers);
  7212. }
  7213. inline bool
  7214. read_websocket_upgrade_response(Stream &strm,
  7215. const std::string &expected_accept,
  7216. const std::string &offered_subprotocols,
  7217. WebSocketUpgradeResponse &upgrade) {
  7218. // The headers of a rejection are kept so the caller can see why the server
  7219. // refused the upgrade.
  7220. if (!read_response_head(strm, upgrade.status, upgrade.headers)) {
  7221. upgrade.error = Error::Read;
  7222. return false;
  7223. }
  7224. const auto &headers = upgrade.headers;
  7225. if (upgrade.status != StatusCode::SwitchingProtocol_101) {
  7226. upgrade.error = Error::WebSocketHandshake;
  7227. return false;
  7228. }
  7229. // Verify Upgrade: websocket (a comma-separated list, matched per token)
  7230. if (!has_header_token(headers, "Upgrade", "websocket")) {
  7231. upgrade.error = Error::WebSocketHandshake;
  7232. return false;
  7233. }
  7234. // Verify Connection: Upgrade
  7235. if (!has_header_token(headers, "Connection", "upgrade")) {
  7236. upgrade.error = Error::WebSocketHandshake;
  7237. return false;
  7238. }
  7239. // Verify Sec-WebSocket-Accept header value
  7240. auto it = headers.find("Sec-WebSocket-Accept");
  7241. if (it == headers.end() || it->second != expected_accept) {
  7242. upgrade.error = Error::WebSocketHandshake;
  7243. return false;
  7244. }
  7245. // Extract negotiated subprotocol
  7246. auto proto_it = headers.find("Sec-WebSocket-Protocol");
  7247. if (proto_it != headers.end()) {
  7248. upgrade.selected_subprotocol = proto_it->second;
  7249. }
  7250. // Verify the subprotocol is one the client offered (RFC 6455 4.1)
  7251. if (!upgrade.selected_subprotocol.empty()) {
  7252. auto was_offered = false;
  7253. split(offered_subprotocols.data(),
  7254. offered_subprotocols.data() + offered_subprotocols.size(), ',',
  7255. [&](const char *b, const char *e) {
  7256. if (std::string(b, e) == upgrade.selected_subprotocol) {
  7257. was_offered = true;
  7258. }
  7259. });
  7260. if (!was_offered) {
  7261. upgrade.error = Error::WebSocketHandshake;
  7262. return false;
  7263. }
  7264. }
  7265. return true;
  7266. }
  7267. enum class ReadContentResult {
  7268. Success, // Successfully read the content
  7269. PayloadTooLarge, // The content exceeds the specified payload limit
  7270. Error // An error occurred while reading the content
  7271. };
  7272. inline ReadContentResult read_content_with_length(
  7273. Stream &strm, size_t len, DownloadProgress progress,
  7274. ContentReceiverWithProgress out,
  7275. size_t payload_max_length = (std::numeric_limits<size_t>::max)()) {
  7276. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7277. detail::BodyReader br;
  7278. br.stream = &strm;
  7279. br.has_content_length = true;
  7280. br.content_length = len;
  7281. br.payload_max_length = payload_max_length;
  7282. br.chunked = false;
  7283. br.bytes_read = 0;
  7284. br.last_error = Error::Success;
  7285. size_t r = 0;
  7286. while (r < len) {
  7287. auto read_len = static_cast<size_t>(len - r);
  7288. auto to_read = (std::min)(read_len, CPPHTTPLIB_RECV_BUFSIZ);
  7289. auto n = detail::read_body_content(&strm, br, buf, to_read);
  7290. if (n <= 0) {
  7291. // Check if it was a payload size error
  7292. if (br.last_error == Error::ExceedMaxPayloadSize) {
  7293. return ReadContentResult::PayloadTooLarge;
  7294. }
  7295. return ReadContentResult::Error;
  7296. }
  7297. if (!out(buf, static_cast<size_t>(n), r, len)) {
  7298. return ReadContentResult::Error;
  7299. }
  7300. r += static_cast<size_t>(n);
  7301. if (progress) {
  7302. if (!progress(r, len)) { return ReadContentResult::Error; }
  7303. }
  7304. }
  7305. return ReadContentResult::Success;
  7306. }
  7307. inline ReadContentResult
  7308. read_content_without_length(Stream &strm, size_t payload_max_length,
  7309. ContentReceiverWithProgress out) {
  7310. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7311. size_t r = 0;
  7312. for (;;) {
  7313. auto n = strm.read(buf, CPPHTTPLIB_RECV_BUFSIZ);
  7314. if (n == 0) { return ReadContentResult::Success; }
  7315. if (n < 0) { return ReadContentResult::Error; }
  7316. // Check if adding this data would exceed the payload limit
  7317. if (payload_max_length > 0 &&
  7318. (r > payload_max_length ||
  7319. payload_max_length - r < static_cast<size_t>(n))) {
  7320. return ReadContentResult::PayloadTooLarge;
  7321. }
  7322. if (!out(buf, static_cast<size_t>(n), r, 0)) {
  7323. return ReadContentResult::Error;
  7324. }
  7325. r += static_cast<size_t>(n);
  7326. }
  7327. return ReadContentResult::Success;
  7328. }
  7329. template <typename T>
  7330. inline ReadContentResult read_content_chunked(Stream &strm, T &x,
  7331. size_t payload_max_length,
  7332. ContentReceiverWithProgress out) {
  7333. detail::ChunkedDecoder dec(strm);
  7334. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7335. size_t total_len = 0;
  7336. for (;;) {
  7337. size_t chunk_offset = 0;
  7338. size_t chunk_total = 0;
  7339. auto n = dec.read_payload(buf, sizeof(buf), chunk_offset, chunk_total);
  7340. if (n < 0) { return ReadContentResult::Error; }
  7341. if (n == 0) {
  7342. if (!dec.parse_trailers_into(x.trailers, x.headers)) {
  7343. return ReadContentResult::Error;
  7344. }
  7345. return ReadContentResult::Success;
  7346. }
  7347. if (payload_max_length > 0 &&
  7348. (total_len > payload_max_length ||
  7349. payload_max_length - total_len < static_cast<size_t>(n))) {
  7350. return ReadContentResult::PayloadTooLarge;
  7351. }
  7352. if (!out(buf, static_cast<size_t>(n), chunk_offset, chunk_total)) {
  7353. return ReadContentResult::Error;
  7354. }
  7355. total_len += static_cast<size_t>(n);
  7356. }
  7357. }
  7358. inline bool is_chunked_transfer_encoding(const Headers &headers) {
  7359. // RFC 9112 6.1: a message is framed with the chunked coding when "chunked"
  7360. // is the final transfer coding. A single field value may list several
  7361. // codings ("gzip, chunked"), and RFC 9110 5.3 lets that list be split across
  7362. // several Transfer-Encoding lines, which combine into one comma-separated
  7363. // list in the order the lines were received. Headers preserves that order,
  7364. // so the final coding is the last token of the last line. Match it
  7365. // case-insensitively rather than comparing the whole value against
  7366. // "chunked".
  7367. //
  7368. // Security: reading a chunked message as unframed leaves its body in the
  7369. // socket, where a keep-alive connection parses it as a smuggled request.
  7370. // Server::process_request() answers 400 and closes when the final coding is
  7371. // not chunked, so a request whose framing cannot be determined never
  7372. // reaches the "no body" path.
  7373. auto rng = headers.equal_range("Transfer-Encoding");
  7374. if (rng.first == rng.second) { return false; }
  7375. // Cleared per line, so a trailing line carrying no coding at all leaves the
  7376. // combined list ending in nothing rather than inheriting the line before it.
  7377. std::string last_coding;
  7378. for (auto it = rng.first; it != rng.second; ++it) {
  7379. const auto &value = it->second;
  7380. last_coding.clear();
  7381. split(value.data(), value.data() + value.size(), ',',
  7382. [&](const char *b, const char *e) { last_coding.assign(b, e); });
  7383. }
  7384. return case_ignore::equal(last_coding, "chunked");
  7385. }
  7386. // RFC 9112 6.1: a message framed by Transfer-Encoding next to a Content-Length,
  7387. // or in HTTP/1.0, leaves the connection unfit to carry another one.
  7388. template <typename T> inline bool has_faulty_transfer_encoding(const T &msg) {
  7389. return msg.has_header("Transfer-Encoding") &&
  7390. (msg.has_header("Content-Length") || msg.version == "HTTP/1.0");
  7391. }
  7392. inline bool has_conflicting_content_length(const Headers &headers) {
  7393. // RFC 9112 §6.3: a message carrying both Transfer-Encoding and a non-zero
  7394. // Content-Length is framed ambiguously. The body readers here delimit it by
  7395. // the transfer coding and drop Content-Length, while an intermediary may do
  7396. // the reverse, so the two disagree on where the body ends and a reused
  7397. // connection is desynchronised (request/response smuggling). Content-Length:
  7398. // 0 is tolerated for compatibility with existing peers.
  7399. return has_header(headers, "Transfer-Encoding") &&
  7400. get_header_value_u64(headers, "Content-Length", 0, 0) > 0;
  7401. }
  7402. template <typename T, typename U>
  7403. bool prepare_content_receiver(T &x, int &status,
  7404. ContentReceiverWithProgress receiver,
  7405. bool decompress, size_t payload_max_length,
  7406. bool &exceed_payload_max_length, U callback) {
  7407. if (decompress) {
  7408. auto encoding = get_combined_header_value(x.headers, "Content-Encoding");
  7409. std::unique_ptr<decompressor> decompressor;
  7410. if (!encoding.empty()) {
  7411. // A coding we know about but were not built with is an error. An
  7412. // unrecognized coding (including "identity") is left alone and the
  7413. // payload is passed through as-is, since some servers misuse the header,
  7414. // e.g. by sending a character set such as "Content-Encoding: UTF-8".
  7415. decompressor = detail::create_decompressor(encoding);
  7416. if (!decompressor && detail::is_known_content_encoding(encoding)) {
  7417. status = StatusCode::UnsupportedMediaType_415;
  7418. return false;
  7419. }
  7420. }
  7421. if (decompressor) {
  7422. if (decompressor->is_valid()) {
  7423. size_t decompressed_size = 0;
  7424. ContentReceiverWithProgress out = [&](const char *buf, size_t n,
  7425. size_t off, size_t len) {
  7426. return decompressor->decompress(
  7427. buf, n, [&](const char *buf2, size_t n2) {
  7428. // Guard against zip-bomb: check
  7429. // decompressed size against limit.
  7430. if (payload_max_length > 0 &&
  7431. (decompressed_size >= payload_max_length ||
  7432. n2 > payload_max_length - decompressed_size)) {
  7433. exceed_payload_max_length = true;
  7434. return false;
  7435. }
  7436. decompressed_size += n2;
  7437. return receiver(buf2, n2, off, len);
  7438. });
  7439. };
  7440. return callback(std::move(out));
  7441. } else {
  7442. status = StatusCode::InternalServerError_500;
  7443. return false;
  7444. }
  7445. }
  7446. }
  7447. ContentReceiverWithProgress out = [&](const char *buf, size_t n, size_t off,
  7448. size_t len) {
  7449. return receiver(buf, n, off, len);
  7450. };
  7451. return callback(std::move(out));
  7452. }
  7453. template <typename T>
  7454. bool read_content(Stream &strm, T &x, size_t payload_max_length, int &status,
  7455. DownloadProgress progress,
  7456. ContentReceiverWithProgress receiver, bool decompress) {
  7457. bool exceed_payload_max_length = false;
  7458. return prepare_content_receiver(
  7459. x, status, std::move(receiver), decompress, payload_max_length,
  7460. exceed_payload_max_length, [&](const ContentReceiverWithProgress &out) {
  7461. auto ret = true;
  7462. // Note: exceed_payload_max_length may also be set by the decompressor
  7463. // wrapper in prepare_content_receiver when the decompressed payload
  7464. // size exceeds the limit.
  7465. if (is_chunked_transfer_encoding(x.headers)) {
  7466. auto result = read_content_chunked(strm, x, payload_max_length, out);
  7467. if (result == ReadContentResult::Success) {
  7468. ret = true;
  7469. } else if (result == ReadContentResult::PayloadTooLarge) {
  7470. exceed_payload_max_length = true;
  7471. ret = false;
  7472. } else {
  7473. ret = false;
  7474. }
  7475. } else if (!has_header(x.headers, "Content-Length")) {
  7476. auto result =
  7477. read_content_without_length(strm, payload_max_length, out);
  7478. if (result == ReadContentResult::Success) {
  7479. ret = true;
  7480. } else if (result == ReadContentResult::PayloadTooLarge) {
  7481. exceed_payload_max_length = true;
  7482. ret = false;
  7483. } else {
  7484. ret = false;
  7485. }
  7486. } else {
  7487. auto is_invalid_value = false;
  7488. auto len = get_header_value_u64(x.headers, "Content-Length",
  7489. (std::numeric_limits<size_t>::max)(),
  7490. 0, is_invalid_value);
  7491. if (is_invalid_value) {
  7492. ret = false;
  7493. } else if (len > 0) {
  7494. auto result = read_content_with_length(
  7495. strm, len, std::move(progress), out, payload_max_length);
  7496. ret = (result == ReadContentResult::Success);
  7497. if (result == ReadContentResult::PayloadTooLarge) {
  7498. exceed_payload_max_length = true;
  7499. }
  7500. }
  7501. }
  7502. if (!ret) {
  7503. status = exceed_payload_max_length ? StatusCode::PayloadTooLarge_413
  7504. : StatusCode::BadRequest_400;
  7505. }
  7506. return ret;
  7507. });
  7508. }
  7509. inline ssize_t write_request_line(Stream &strm, const std::string &method,
  7510. const std::string &path) {
  7511. // Neither the method nor the request target may carry CR/LF, SP or other
  7512. // control octets; otherwise a value smuggled into either splits the request
  7513. // line and injects headers or a whole request.
  7514. if (!fields::is_token(method)) { return -1; }
  7515. if (!fields::is_request_target(path)) { return -1; }
  7516. std::string s = method;
  7517. s += ' ';
  7518. s += path;
  7519. s += " HTTP/1.1\r\n";
  7520. return strm.write(s.data(), s.size());
  7521. }
  7522. inline ssize_t write_response_line(Stream &strm, int status) {
  7523. std::string s = "HTTP/1.1 ";
  7524. s += std::to_string(status);
  7525. s += ' ';
  7526. s += httplib::status_message(status);
  7527. s += "\r\n";
  7528. return strm.write(s.data(), s.size());
  7529. }
  7530. inline ssize_t write_headers(Stream &strm, const Headers &headers) {
  7531. ssize_t write_len = 0;
  7532. for (const auto &x : headers) {
  7533. std::string s;
  7534. s = x.first;
  7535. s += ": ";
  7536. s += x.second;
  7537. s += "\r\n";
  7538. auto len = strm.write(s.data(), s.size());
  7539. if (len < 0) { return len; }
  7540. write_len += len;
  7541. }
  7542. auto len = strm.write("\r\n");
  7543. if (len < 0) { return len; }
  7544. write_len += len;
  7545. return write_len;
  7546. }
  7547. inline bool write_data(Stream &strm, const char *d, size_t l) {
  7548. size_t offset = 0;
  7549. while (offset < l) {
  7550. auto length = strm.write(d + offset, l - offset);
  7551. if (length < 0) { return false; }
  7552. offset += static_cast<size_t>(length);
  7553. }
  7554. return true;
  7555. }
  7556. template <typename T>
  7557. inline bool write_content_with_progress(Stream &strm,
  7558. const ContentProvider &content_provider,
  7559. size_t offset, size_t length,
  7560. T is_shutting_down,
  7561. const UploadProgress &upload_progress,
  7562. Error &error) {
  7563. size_t end_offset = offset + length;
  7564. size_t start_offset = offset;
  7565. auto ok = true;
  7566. auto finished = false;
  7567. DataSink data_sink;
  7568. data_sink.write = [&](const char *d, size_t l) -> bool {
  7569. if (ok) {
  7570. // Bytes past `length` would follow the framed body, where the peer reads
  7571. // them as the next message. Write only what fits and fail the rest.
  7572. if (l > end_offset - offset) {
  7573. l = end_offset - offset;
  7574. ok = false;
  7575. }
  7576. if (write_data(strm, d, l)) {
  7577. offset += l;
  7578. if (upload_progress && length > 0) {
  7579. size_t current_written = offset - start_offset;
  7580. if (!upload_progress(current_written, length)) {
  7581. ok = false;
  7582. return false;
  7583. }
  7584. }
  7585. } else {
  7586. ok = false;
  7587. }
  7588. }
  7589. return ok;
  7590. };
  7591. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7592. // The body is framed by `length`, so a provider that reports itself done
  7593. // early has truncated it. Record that and let the short-body check below
  7594. // fail the write, rather than calling the provider again forever.
  7595. data_sink.done = [&]() { finished = true; };
  7596. while (offset < end_offset && !finished && !is_shutting_down()) {
  7597. auto last_offset = offset;
  7598. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7599. error = Error::Write;
  7600. return false;
  7601. } else if (!content_provider(offset, end_offset - offset, data_sink)) {
  7602. error = Error::Canceled;
  7603. return false;
  7604. } else if (!ok) {
  7605. error = Error::Write;
  7606. return false;
  7607. }
  7608. // A provider that reports success without writing anything and without
  7609. // reporting itself done gets handed the same offset and length again on
  7610. // the next pass, so it would spin here for as long as the peer stays
  7611. // connected. Treat making no progress as a short body, like done() early.
  7612. if (!finished && offset == last_offset) {
  7613. error = Error::Write;
  7614. return false;
  7615. }
  7616. }
  7617. if (offset < end_offset) { // done() called early, or is_shutting_down()
  7618. error = Error::Write;
  7619. return false;
  7620. }
  7621. error = Error::Success;
  7622. return true;
  7623. }
  7624. template <typename T>
  7625. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7626. size_t offset, size_t length, T is_shutting_down,
  7627. Error &error) {
  7628. return write_content_with_progress<T>(strm, content_provider, offset, length,
  7629. is_shutting_down, nullptr, error);
  7630. }
  7631. template <typename T>
  7632. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7633. size_t offset, size_t length,
  7634. const T &is_shutting_down) {
  7635. auto error = Error::Success;
  7636. return write_content(strm, content_provider, offset, length, is_shutting_down,
  7637. error);
  7638. }
  7639. template <typename T>
  7640. inline bool
  7641. write_content_without_length(Stream &strm,
  7642. const ContentProvider &content_provider,
  7643. const T &is_shutting_down) {
  7644. size_t offset = 0;
  7645. auto data_available = true;
  7646. auto ok = true;
  7647. DataSink data_sink;
  7648. data_sink.write = [&](const char *d, size_t l) -> bool {
  7649. if (ok) {
  7650. offset += l;
  7651. if (!write_data(strm, d, l)) { ok = false; }
  7652. }
  7653. return ok;
  7654. };
  7655. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7656. data_sink.done = [&](void) { data_available = false; };
  7657. while (data_available && !is_shutting_down()) {
  7658. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7659. return false;
  7660. } else if (!content_provider(offset, 0, data_sink)) {
  7661. return false;
  7662. } else if (!ok) {
  7663. return false;
  7664. }
  7665. }
  7666. return !data_available; // true only if done() was called, false if shutting
  7667. // down
  7668. }
  7669. // Runs a known-length content provider to completion and compresses what it
  7670. // writes into `out`, chunk by chunk, without holding the identity form.
  7671. inline bool compress_content_provider(const ContentProvider &content_provider,
  7672. size_t length, compressor &cmp,
  7673. std::string &out) {
  7674. size_t offset = 0;
  7675. auto ok = true;
  7676. auto finished = false;
  7677. DataSink data_sink;
  7678. auto append = [&](const char *data, size_t data_len) {
  7679. out.append(data, data_len);
  7680. return true;
  7681. };
  7682. data_sink.write = [&](const char *d, size_t l) -> bool {
  7683. if (!ok) { return false; }
  7684. offset += l;
  7685. if (l > 0 && !cmp.compress(d, l, false, append)) { ok = false; }
  7686. return ok;
  7687. };
  7688. // The body is framed by `length`, so a provider that reports itself done
  7689. // early has truncated it; the short-body check below turns that into a
  7690. // failure rather than calling the provider again forever.
  7691. data_sink.done = [&]() { finished = true; };
  7692. while (offset < length && !finished) {
  7693. auto prev_offset = offset;
  7694. if (!content_provider(offset, length - offset, data_sink) || !ok) {
  7695. return false;
  7696. }
  7697. // No Stream to block on here, so a provider that keeps returning true
  7698. // without writing would spin. Treat a pass that made no progress as a
  7699. // failure.
  7700. if (offset == prev_offset) { return false; }
  7701. }
  7702. if (offset != length) { return false; }
  7703. return cmp.compress(nullptr, 0, true, append);
  7704. }
  7705. // Serves `m` as the response body. `set_content_provider()` clears the coding
  7706. // and the file flag, so recording them has to come after; keeping all of it
  7707. // here means a third file-serving path cannot get that order wrong.
  7708. inline void set_file_content_provider(Response &res,
  7709. const std::shared_ptr<mmap> &m,
  7710. const std::string &content_type,
  7711. EncodingType encoding) {
  7712. // One read and one write move up to this much of the file at a time.
  7713. auto buf = std::make_shared<std::vector<char>>(
  7714. (std::min)(m->size(), size_t(256 * 1024)));
  7715. res.set_content_provider(
  7716. m->size(), content_type,
  7717. [m, buf](size_t offset, size_t length, DataSink &sink) -> bool {
  7718. // Never read past the file, which ends the response early if it has
  7719. // shrunk since it was opened.
  7720. auto n = m->read(offset, buf->data(), (std::min)(length, buf->size()));
  7721. if (n == 0) { return false; }
  7722. sink.write(buf->data(), n);
  7723. return true;
  7724. });
  7725. res.is_file_content_provider_ = true;
  7726. res.content_coding_ = encoding;
  7727. }
  7728. template <typename T, typename U>
  7729. inline bool
  7730. write_content_chunked(Stream &strm, const ContentProvider &content_provider,
  7731. const T &is_shutting_down, U &compressor, Error &error) {
  7732. size_t offset = 0;
  7733. auto data_available = true;
  7734. auto ok = true;
  7735. DataSink data_sink;
  7736. data_sink.write = [&](const char *d, size_t l) -> bool {
  7737. // Only done()/done_with_trailer() end a chunked body. A pass with nothing
  7738. // to hand over is ordinary (an empty buffer popped off a queue), and a
  7739. // zero-length chunk is the terminator, so it must not be emitted here.
  7740. if (ok && l > 0) {
  7741. offset += l;
  7742. std::string payload;
  7743. if (compressor.compress(d, l, false,
  7744. [&](const char *data, size_t data_len) {
  7745. payload.append(data, data_len);
  7746. return true;
  7747. })) {
  7748. if (!payload.empty()) {
  7749. // Emit chunked response header and footer for each chunk
  7750. auto chunk =
  7751. from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7752. if (!write_data(strm, chunk.data(), chunk.size())) { ok = false; }
  7753. }
  7754. } else {
  7755. ok = false;
  7756. }
  7757. }
  7758. return ok;
  7759. };
  7760. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7761. auto done_with_trailer = [&](const Headers *trailer) {
  7762. if (!ok) { return; }
  7763. data_available = false;
  7764. std::string payload;
  7765. if (!compressor.compress(nullptr, 0, true,
  7766. [&](const char *data, size_t data_len) {
  7767. payload.append(data, data_len);
  7768. return true;
  7769. })) {
  7770. ok = false;
  7771. return;
  7772. }
  7773. if (!payload.empty()) {
  7774. // Emit chunked response header and footer for each chunk
  7775. auto chunk = from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7776. if (!write_data(strm, chunk.data(), chunk.size())) {
  7777. ok = false;
  7778. return;
  7779. }
  7780. }
  7781. constexpr const char done_marker[] = "0\r\n";
  7782. if (!write_data(strm, done_marker, str_len(done_marker))) { ok = false; }
  7783. // Trailer
  7784. if (trailer) {
  7785. for (const auto &kv : *trailer) {
  7786. // Skip fields with invalid names or values to prevent response
  7787. // splitting via CR/LF injection, matching set_header().
  7788. if (!fields::is_field_valid(kv.first, kv.second)) { continue; }
  7789. std::string field_line = kv.first + ": " + kv.second + "\r\n";
  7790. if (!write_data(strm, field_line.data(), field_line.size())) {
  7791. ok = false;
  7792. }
  7793. }
  7794. }
  7795. constexpr const char crlf[] = "\r\n";
  7796. if (!write_data(strm, crlf, str_len(crlf))) { ok = false; }
  7797. };
  7798. data_sink.done = [&](void) { done_with_trailer(nullptr); };
  7799. data_sink.done_with_trailer = [&](const Headers &trailer) {
  7800. done_with_trailer(&trailer);
  7801. };
  7802. while (data_available && !is_shutting_down()) {
  7803. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7804. error = Error::Write;
  7805. return false;
  7806. } else if (!content_provider(offset, 0, data_sink)) {
  7807. error = Error::Canceled;
  7808. return false;
  7809. } else if (!ok) {
  7810. error = Error::Write;
  7811. return false;
  7812. }
  7813. }
  7814. if (data_available) { // exited due to is_shutting_down(), not done()
  7815. error = Error::Write;
  7816. return false;
  7817. }
  7818. error = Error::Success;
  7819. return true;
  7820. }
  7821. template <typename T, typename U>
  7822. inline bool write_content_chunked(Stream &strm,
  7823. const ContentProvider &content_provider,
  7824. const T &is_shutting_down, U &compressor) {
  7825. auto error = Error::Success;
  7826. return write_content_chunked(strm, content_provider, is_shutting_down,
  7827. compressor, error);
  7828. }
  7829. template <typename T>
  7830. inline bool redirect(T &cli, Request &req, Response &res,
  7831. const std::string &path, const std::string &location,
  7832. Error &error) {
  7833. Request new_req = req;
  7834. new_req.path = path;
  7835. new_req.redirect_count_ -= 1;
  7836. if (res.status == StatusCode::SeeOther_303 &&
  7837. (req.method != "GET" && req.method != "HEAD")) {
  7838. new_req.method = "GET";
  7839. new_req.body.clear();
  7840. new_req.headers.clear();
  7841. new_req.content_length_ = 0;
  7842. new_req.content_provider_ = nullptr;
  7843. new_req.is_chunked_content_provider_ = false;
  7844. }
  7845. Response new_res;
  7846. auto ret = cli.send(new_req, new_res, error);
  7847. if (ret) {
  7848. req = std::move(new_req);
  7849. res = std::move(new_res);
  7850. if (res.location.empty()) { res.location = location; }
  7851. }
  7852. return ret;
  7853. }
  7854. inline std::string params_to_query_str(const Params &params) {
  7855. std::string query;
  7856. for (auto it = params.begin(); it != params.end(); ++it) {
  7857. if (it != params.begin()) { query += '&'; }
  7858. query += encode_query_component(it->first);
  7859. query += '=';
  7860. query += encode_query_component(it->second);
  7861. }
  7862. return query;
  7863. }
  7864. // Splits one "key=value" span of a query string at its first '='. A span with
  7865. // no '=' at all lands entirely in key, leaving val empty, which is how a bare
  7866. // "?flag" keeps its name.
  7867. inline void divide_query_pair(const char *b, const char *e, std::string &key,
  7868. std::string &val) {
  7869. divide(b, static_cast<std::size_t>(e - b), '=',
  7870. [&](const char *lhs_data, std::size_t lhs_size, const char *rhs_data,
  7871. std::size_t rhs_size) {
  7872. key.assign(lhs_data, lhs_size);
  7873. val.assign(rhs_data, rhs_size);
  7874. });
  7875. }
  7876. inline void parse_query_text(const char *data, std::size_t size,
  7877. Params &params) {
  7878. std::set<std::string> cache;
  7879. split(data, data + size, '&', [&](const char *b, const char *e) {
  7880. std::string kv(b, e);
  7881. if (cache.find(kv) != cache.end()) { return; }
  7882. cache.insert(std::move(kv));
  7883. std::string key;
  7884. std::string val;
  7885. divide_query_pair(b, e, key, val);
  7886. if (!key.empty()) {
  7887. params.emplace(decode_query_component(key), decode_query_component(val));
  7888. }
  7889. });
  7890. }
  7891. inline void parse_query_text(const std::string &s, Params &params) {
  7892. parse_query_text(s.data(), s.size(), params);
  7893. }
  7894. // Normalize a query string by decoding and re-encoding each key/value pair
  7895. // while preserving the original parameter order. This avoids double-encoding
  7896. // and ensures consistent encoding. It works on the raw string rather than
  7897. // parsing into Params and re-serializing, because that round trip cannot
  7898. // reproduce the input: params_to_query_str() always emits '=', so a bare
  7899. // "flag" would come back as "flag=", and parse_query_text() drops exactly
  7900. // duplicated pairs.
  7901. inline std::string normalize_query_string(const std::string &query) {
  7902. std::string result;
  7903. split(query.data(), query.data() + query.size(), '&',
  7904. [&](const char *b, const char *e) {
  7905. std::string key;
  7906. std::string val;
  7907. divide_query_pair(b, e, key, val);
  7908. if (!key.empty()) {
  7909. auto dec_key = decode_query_component(key);
  7910. auto dec_val = decode_query_component(val);
  7911. if (!result.empty()) { result += '&'; }
  7912. result += encode_query_component(dec_key);
  7913. if (!val.empty() || std::find(b, e, '=') != e) {
  7914. result += '=';
  7915. result += encode_query_component(dec_val);
  7916. }
  7917. }
  7918. });
  7919. return result;
  7920. }
  7921. // The query of a client's path: what follows '?', up to the fragment.
  7922. inline std::string query_of(const std::string &path) {
  7923. auto fragment_pos = path.find('#');
  7924. auto query_pos = path.find('?');
  7925. return query_pos < fragment_pos
  7926. ? path.substr(query_pos + 1, fragment_pos - query_pos - 1)
  7927. : std::string();
  7928. }
  7929. // Build the request target that goes on the wire from a caller-supplied path.
  7930. // Shared by the buffered send path and the streaming API so that both put the
  7931. // same bytes in the request line for the same input.
  7932. inline std::string encode_request_target(const std::string &uri,
  7933. bool path_encode) {
  7934. // The fragment stays with the client (RFC 9110 §7.1).
  7935. auto target = uri.substr(0, uri.find('#'));
  7936. // `substr(0, npos)` yields the whole string, which is what the no-query
  7937. // case needs.
  7938. auto query_pos = target.find('?');
  7939. auto path_part = target.substr(0, query_pos);
  7940. std::string query_part;
  7941. if (query_pos != std::string::npos) {
  7942. query_part = target.substr(query_pos + 1);
  7943. }
  7944. auto result = path_encode ? encode_path(path_part) : std::move(path_part);
  7945. if (!query_part.empty()) {
  7946. // When path encoding is disabled the caller has supplied an already-encoded
  7947. // target and expects the exact bytes to be sent on the wire, so skip
  7948. // normalization for the query too. Normalizing would decode-then-re-encode
  7949. // it and corrupt pre-encoded binary payloads (e.g. turning `%20` into `+`,
  7950. // which a strict RFC 3986 server decodes back as `+`, not a space).
  7951. if (path_encode) {
  7952. auto normalized = normalize_query_string(query_part);
  7953. if (!normalized.empty()) {
  7954. result += '?';
  7955. result += normalized;
  7956. }
  7957. } else {
  7958. result += '?';
  7959. result += query_part;
  7960. }
  7961. }
  7962. return result;
  7963. }
  7964. inline bool parse_multipart_boundary(const std::string &content_type,
  7965. std::string &boundary) {
  7966. std::map<std::string, std::string> params;
  7967. extract_media_type(content_type, &params);
  7968. auto it = params.find("boundary");
  7969. if (it == params.end()) { return false; }
  7970. boundary = it->second;
  7971. // RFC 2046 5.1.1 caps a boundary at 70 characters. The parser scans the body
  7972. // for "--" + boundary, so a body crafted to repeat that delimiter's leading
  7973. // bytes costs a nearly full comparison at nearly every position: the
  7974. // boundary's length multiplies the worst-case cost of scanning a body.
  7975. return !boundary.empty() && boundary.size() <= 70;
  7976. }
  7977. inline void parse_disposition_params(const std::string &s, Params &params) {
  7978. std::set<std::string> cache;
  7979. split_unquoted(
  7980. s.data(), s.data() + s.size(), ';', [&](const char *b, const char *e) {
  7981. std::string kv(b, e);
  7982. if (cache.find(kv) != cache.end()) { return; }
  7983. cache.insert(kv);
  7984. std::string key;
  7985. std::string val;
  7986. divide_param_pair(b, e, key, val);
  7987. if (!key.empty()) {
  7988. params.emplace(trim_double_quotes_copy(key), unquote_param(val));
  7989. }
  7990. });
  7991. }
  7992. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7993. inline bool parse_range_header(const std::string &s, Ranges &ranges) {
  7994. #else
  7995. inline bool parse_range_header(const std::string &s, Ranges &ranges) try {
  7996. #endif
  7997. auto is_valid = [](const std::string &str) {
  7998. return std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  7999. };
  8000. if (s.size() > 7 && case_ignore::equal(s.substr(0, 6), "bytes=")) {
  8001. const auto pos = static_cast<size_t>(6);
  8002. const auto len = static_cast<size_t>(s.size() - 6);
  8003. auto all_valid_ranges = true;
  8004. split(&s[pos], &s[pos + len], ',', [&](const char *b, const char *e) {
  8005. if (!all_valid_ranges) { return; }
  8006. const auto it = std::find(b, e, '-');
  8007. if (it == e) {
  8008. all_valid_ranges = false;
  8009. return;
  8010. }
  8011. const auto lhs = std::string(b, it);
  8012. const auto rhs = std::string(it + 1, e);
  8013. if (!is_valid(lhs) || !is_valid(rhs)) {
  8014. all_valid_ranges = false;
  8015. return;
  8016. }
  8017. ssize_t first = -1;
  8018. if (!lhs.empty()) {
  8019. // Reject an overflowing first-byte-pos; treating it as absent (-1)
  8020. // would turn the range into a suffix range.
  8021. auto res =
  8022. detail::from_chars(lhs.data(), lhs.data() + lhs.size(), first);
  8023. if (res.ec != std::errc{}) {
  8024. all_valid_ranges = false;
  8025. return;
  8026. }
  8027. }
  8028. ssize_t last = -1;
  8029. if (!rhs.empty()) {
  8030. // An overflowing last-byte-pos is past any content length, so keeping
  8031. // -1 ("remainder", RFC 9110 14.1.2) is correct here.
  8032. ssize_t v;
  8033. auto res = detail::from_chars(rhs.data(), rhs.data() + rhs.size(), v);
  8034. if (res.ec == std::errc{}) { last = v; }
  8035. }
  8036. if ((first == -1 && last == -1) ||
  8037. (first != -1 && last != -1 && first > last)) {
  8038. all_valid_ranges = false;
  8039. return;
  8040. }
  8041. ranges.emplace_back(first, last);
  8042. });
  8043. return all_valid_ranges && !ranges.empty();
  8044. }
  8045. return false;
  8046. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  8047. }
  8048. #else
  8049. } catch (...) { return false; }
  8050. #endif
  8051. // Removes each quoted-string, honoring a quoted-pair (RFC 9110 Section 5.6.4)
  8052. inline std::string remove_quoted_strings(const std::string &s) {
  8053. std::string out;
  8054. auto in_quotes = false;
  8055. for (size_t i = 0; i < s.size(); i++) {
  8056. if (s[i] == '"') {
  8057. in_quotes = !in_quotes;
  8058. } else if (!in_quotes) {
  8059. out += s[i];
  8060. } else if (s[i] == '\\') {
  8061. i++;
  8062. }
  8063. }
  8064. return out;
  8065. }
  8066. inline bool parse_accept_header(const std::string &s,
  8067. std::vector<std::string> &content_types) {
  8068. // Parameter values are not used here, so a quoted-string is dropped rather
  8069. // than parsed: a ',' or ';' inside one must not be read as a delimiter.
  8070. if (s.find('"') != std::string::npos) {
  8071. return parse_accept_header(remove_quoted_strings(s), content_types);
  8072. }
  8073. content_types.clear();
  8074. // Empty string is considered valid (no preference)
  8075. if (s.empty()) { return true; }
  8076. struct AcceptEntry {
  8077. std::string media_type;
  8078. double quality;
  8079. int order;
  8080. };
  8081. std::vector<AcceptEntry> entries;
  8082. int order = 0;
  8083. bool has_invalid_entry = false;
  8084. // Split by comma and parse each entry. RFC 9110 Section 5.6.1.2: a recipient
  8085. // has to parse and ignore empty list elements, so a leading, trailing or
  8086. // doubled comma must not turn a legal Accept value into 400 Bad Request.
  8087. // split() skips them, and the header length limit bounds how many a sender
  8088. // can send, so ignoring all of them cannot be used as a denial-of-service
  8089. // vector.
  8090. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  8091. std::string entry(b, e);
  8092. entry = trim_copy(entry);
  8093. AcceptEntry accept_entry;
  8094. accept_entry.order = order++;
  8095. if (!parse_quality(entry.data(), entry.data() + entry.size(),
  8096. accept_entry.media_type, accept_entry.quality)) {
  8097. has_invalid_entry = true;
  8098. return;
  8099. }
  8100. // Remove additional parameters from media type
  8101. accept_entry.media_type = extract_media_type(accept_entry.media_type);
  8102. // Basic validation of media type format
  8103. if (accept_entry.media_type.empty()) {
  8104. has_invalid_entry = true;
  8105. return;
  8106. }
  8107. // Check for basic media type format (should contain '/' or be '*')
  8108. if (accept_entry.media_type != "*" &&
  8109. accept_entry.media_type.find('/') == std::string::npos) {
  8110. has_invalid_entry = true;
  8111. return;
  8112. }
  8113. entries.push_back(std::move(accept_entry));
  8114. });
  8115. // Return false if any invalid entry was found
  8116. if (has_invalid_entry) { return false; }
  8117. // Sort by quality (descending), then by original order (ascending)
  8118. std::sort(entries.begin(), entries.end(),
  8119. [](const AcceptEntry &a, const AcceptEntry &b) {
  8120. if (a.quality != b.quality) {
  8121. return a.quality > b.quality; // Higher quality first
  8122. }
  8123. return a.order < b.order; // Earlier order first for same quality
  8124. });
  8125. // Extract sorted media types
  8126. content_types.reserve(entries.size());
  8127. for (auto &entry : entries) {
  8128. content_types.push_back(std::move(entry.media_type));
  8129. }
  8130. return true;
  8131. }
  8132. class FormDataParser {
  8133. public:
  8134. FormDataParser() = default;
  8135. void set_boundary(std::string &&boundary) {
  8136. boundary_ = std::move(boundary);
  8137. dash_boundary_crlf_ = dash_ + boundary_ + crlf_;
  8138. crlf_dash_boundary_ = crlf_ + dash_ + boundary_;
  8139. }
  8140. bool is_valid() const { return is_valid_; }
  8141. bool parse(const char *buf, size_t n, const FormDataHeader &header_callback,
  8142. const ContentReceiver &content_callback) {
  8143. // Once the close delimiter has been seen the rest of the body is epilogue
  8144. // to be discarded (RFC 2046). Drop it without buffering so a large epilogue
  8145. // spread across reads is not copied in only to be erased right away.
  8146. if (state_ == 5) { return true; }
  8147. buf_append(buf, n);
  8148. while (buf_size() > 0) {
  8149. switch (state_) {
  8150. case 0: { // Initial boundary
  8151. auto pos = buf_find(dash_boundary_crlf_);
  8152. if (pos == buf_size()) {
  8153. // Not found yet: keep only a possible partial boundary at the tail so
  8154. // that a body which never contains the boundary cannot grow the
  8155. // buffer (and get rescanned from the start) without bound.
  8156. auto keep = dash_boundary_crlf_.size() - 1;
  8157. if (buf_size() > keep) { buf_erase(buf_size() - keep); }
  8158. return true;
  8159. }
  8160. buf_erase(pos + dash_boundary_crlf_.size());
  8161. state_ = 1;
  8162. break;
  8163. }
  8164. case 1: { // New entry
  8165. clear_file_info();
  8166. header_searched_ = 0;
  8167. state_ = 2;
  8168. break;
  8169. }
  8170. case 2: { // Headers
  8171. // Resume where the last call stopped looking, so that a line arriving
  8172. // a few bytes at a time is not searched from its start each time.
  8173. auto pos = buf_find(crlf_, header_searched_);
  8174. if (pos > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  8175. while (pos < buf_size()) {
  8176. // Empty line
  8177. if (pos == 0) {
  8178. if (!header_callback(file_)) {
  8179. is_valid_ = false;
  8180. return false;
  8181. }
  8182. buf_erase(crlf_.size());
  8183. state_ = 3;
  8184. break;
  8185. }
  8186. // Check header count limit
  8187. if (header_count_ >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  8188. is_valid_ = false;
  8189. return false;
  8190. }
  8191. header_count_++;
  8192. const auto header = buf_head(pos);
  8193. if (!parse_header(header.data(), header.data() + header.size(),
  8194. [&](const std::string &, const std::string &) {})) {
  8195. is_valid_ = false;
  8196. return false;
  8197. }
  8198. // Parse and emplace space trimmed headers into a map
  8199. if (!parse_header(
  8200. header.data(), header.data() + header.size(),
  8201. [&](const std::string &key, const std::string &val) {
  8202. file_.headers.emplace(key, val);
  8203. })) {
  8204. is_valid_ = false;
  8205. return false;
  8206. }
  8207. constexpr const char header_content_type[] = "Content-Type:";
  8208. if (start_with_case_ignore(header, header_content_type)) {
  8209. file_.content_type =
  8210. trim_copy(header.substr(str_len(header_content_type)));
  8211. } else {
  8212. std::string disposition_params;
  8213. if (parse_content_disposition(header, disposition_params)) {
  8214. Params params;
  8215. parse_disposition_params(disposition_params, params);
  8216. auto it = params.find("name");
  8217. if (it != params.end()) {
  8218. file_.name = it->second;
  8219. } else {
  8220. is_valid_ = false;
  8221. return false;
  8222. }
  8223. it = params.find("filename");
  8224. if (it != params.end()) { file_.filename = it->second; }
  8225. it = params.find("filename*");
  8226. if (it != params.end()) {
  8227. // RFC 5987: only UTF-8 encoding is allowed
  8228. const auto &val = it->second;
  8229. constexpr const char utf8_prefix[] = "UTF-8''";
  8230. constexpr size_t prefix_len = str_len(utf8_prefix);
  8231. if (val.size() > prefix_len &&
  8232. start_with_case_ignore(val, utf8_prefix)) {
  8233. file_.filename = decode_path_component(
  8234. val.substr(prefix_len)); // override...
  8235. } else {
  8236. is_valid_ = false;
  8237. return false;
  8238. }
  8239. }
  8240. }
  8241. }
  8242. buf_erase(pos + crlf_.size());
  8243. pos = buf_find(crlf_);
  8244. }
  8245. if (state_ != 3) {
  8246. // The CR of the CRLF may be the last byte so far.
  8247. header_searched_ = buf_size() > 0 ? buf_size() - 1 : 0;
  8248. return true;
  8249. }
  8250. break;
  8251. }
  8252. case 3: { // Body
  8253. if (crlf_dash_boundary_.size() > buf_size()) { return true; }
  8254. auto pos = buf_find(crlf_dash_boundary_);
  8255. if (pos < buf_size()) {
  8256. if (!content_callback(buf_data(), pos)) {
  8257. is_valid_ = false;
  8258. return false;
  8259. }
  8260. buf_erase(pos + crlf_dash_boundary_.size());
  8261. state_ = 4;
  8262. } else {
  8263. auto len = buf_size() - crlf_dash_boundary_.size();
  8264. if (len > 0) {
  8265. if (!content_callback(buf_data(), len)) {
  8266. is_valid_ = false;
  8267. return false;
  8268. }
  8269. buf_erase(len);
  8270. }
  8271. return true;
  8272. }
  8273. break;
  8274. }
  8275. case 4: { // Boundary
  8276. if (crlf_.size() > buf_size()) { return true; }
  8277. if (buf_start_with(crlf_)) {
  8278. buf_erase(crlf_.size());
  8279. state_ = 1;
  8280. } else if (buf_start_with(dash_)) {
  8281. buf_erase(dash_.size());
  8282. is_valid_ = true;
  8283. state_ = 5;
  8284. } else {
  8285. // Only CRLF (another part follows) and "--" (close-delimiter) are
  8286. // accepted after a boundary; RFC 2046 allows transport-padding in
  8287. // between, but this parser has never supported it. Either way the
  8288. // body is already destined to be rejected, so fail now instead of
  8289. // buffering the rest of it. Both are two bytes, so the check above
  8290. // already guarantees enough buffered data to decide.
  8291. is_valid_ = false;
  8292. return false;
  8293. }
  8294. break;
  8295. }
  8296. case 5: { // Epilogue
  8297. buf_erase(buf_size());
  8298. break;
  8299. }
  8300. }
  8301. }
  8302. return true;
  8303. }
  8304. private:
  8305. void clear_file_info() {
  8306. file_.name.clear();
  8307. file_.filename.clear();
  8308. file_.content_type.clear();
  8309. file_.headers.clear();
  8310. header_count_ = 0;
  8311. }
  8312. bool start_with_case_ignore(const std::string &a, const char *b,
  8313. size_t offset = 0) const {
  8314. const auto b_len = strlen(b);
  8315. if (a.size() < offset + b_len) { return false; }
  8316. for (size_t i = 0; i < b_len; i++) {
  8317. if (case_ignore::to_lower(a[offset + i]) != case_ignore::to_lower(b[i])) {
  8318. return false;
  8319. }
  8320. }
  8321. return true;
  8322. }
  8323. // Parses "Content-Disposition: form-data; <params>" without std::regex.
  8324. // Returns true if header matches, with the params portion in `params_out`.
  8325. bool parse_content_disposition(const std::string &header,
  8326. std::string &params_out) const {
  8327. constexpr const char prefix[] = "Content-Disposition:";
  8328. constexpr size_t prefix_len = str_len(prefix);
  8329. if (!start_with_case_ignore(header, prefix)) { return false; }
  8330. // Skip whitespace after "Content-Disposition:"
  8331. auto pos = prefix_len;
  8332. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8333. pos++;
  8334. }
  8335. // Match "form-data;" (case-insensitive)
  8336. constexpr const char form_data[] = "form-data;";
  8337. constexpr size_t form_data_len = str_len(form_data);
  8338. if (!start_with_case_ignore(header, form_data, pos)) { return false; }
  8339. pos += form_data_len;
  8340. // Skip whitespace after "form-data;"
  8341. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8342. pos++;
  8343. }
  8344. params_out = header.substr(pos);
  8345. return true;
  8346. }
  8347. const std::string dash_ = "--";
  8348. const std::string crlf_ = "\r\n";
  8349. std::string boundary_;
  8350. std::string dash_boundary_crlf_;
  8351. std::string crlf_dash_boundary_;
  8352. size_t state_ = 0;
  8353. bool is_valid_ = false;
  8354. FormData file_;
  8355. size_t header_count_ = 0;
  8356. size_t header_searched_ = 0;
  8357. // Buffer
  8358. bool start_with(const std::string &a, size_t spos, size_t epos,
  8359. const std::string &b) const {
  8360. if (epos - spos < b.size()) { return false; }
  8361. for (size_t i = 0; i < b.size(); i++) {
  8362. if (a[i + spos] != b[i]) { return false; }
  8363. }
  8364. return true;
  8365. }
  8366. size_t buf_size() const { return buf_epos_ - buf_spos_; }
  8367. const char *buf_data() const { return &buf_[buf_spos_]; }
  8368. std::string buf_head(size_t l) const { return buf_.substr(buf_spos_, l); }
  8369. bool buf_start_with(const std::string &s) const {
  8370. return start_with(buf_, buf_spos_, buf_epos_, s);
  8371. }
  8372. size_t buf_find(const std::string &s, size_t from = 0) const {
  8373. auto c = s.front();
  8374. size_t off = buf_spos_ + from;
  8375. while (off < buf_epos_) {
  8376. auto pos = off;
  8377. while (true) {
  8378. if (pos == buf_epos_) { return buf_size(); }
  8379. if (buf_[pos] == c) { break; }
  8380. pos++;
  8381. }
  8382. auto remaining_size = buf_epos_ - pos;
  8383. if (s.size() > remaining_size) { return buf_size(); }
  8384. if (start_with(buf_, pos, buf_epos_, s)) { return pos - buf_spos_; }
  8385. off = pos + 1;
  8386. }
  8387. return buf_size();
  8388. }
  8389. void buf_append(const char *data, size_t n) {
  8390. auto remaining_size = buf_size();
  8391. if (remaining_size > 0 && buf_spos_ > 0) {
  8392. for (size_t i = 0; i < remaining_size; i++) {
  8393. buf_[i] = buf_[buf_spos_ + i];
  8394. }
  8395. }
  8396. buf_spos_ = 0;
  8397. buf_epos_ = remaining_size;
  8398. if (remaining_size + n > buf_.size()) { buf_.resize(remaining_size + n); }
  8399. for (size_t i = 0; i < n; i++) {
  8400. buf_[buf_epos_ + i] = data[i];
  8401. }
  8402. buf_epos_ += n;
  8403. }
  8404. void buf_erase(size_t size) { buf_spos_ += size; }
  8405. std::string buf_;
  8406. size_t buf_spos_ = 0;
  8407. size_t buf_epos_ = 0;
  8408. };
  8409. inline std::string random_string(size_t length) {
  8410. constexpr const char data[] =
  8411. "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
  8412. std::string result(length, '\0');
  8413. fill_random_bytes(reinterpret_cast<unsigned char *>(&result[0]), length);
  8414. for (auto &c : result) {
  8415. c = data[static_cast<unsigned char>(c) % (sizeof(data) - 1)];
  8416. }
  8417. return result;
  8418. }
  8419. inline std::string make_multipart_data_boundary() {
  8420. return "--cpp-httplib-multipart-data-" + detail::random_string(16);
  8421. }
  8422. inline bool is_multipart_boundary_chars_valid(const std::string &boundary) {
  8423. auto valid = true;
  8424. for (size_t i = 0; i < boundary.size(); i++) {
  8425. auto c = boundary[i];
  8426. if (!is_ascii_alnum(c) && c != '-' && c != '_') {
  8427. valid = false;
  8428. break;
  8429. }
  8430. }
  8431. return valid;
  8432. }
  8433. // Escape a multipart field name/filename following the WHATWG HTML standard
  8434. // ("escape a multipart form-data name"): '"' -> %22, CR -> %0D, LF -> %0A.
  8435. // As the value is a quoted-string, '\' -> '\\' too, which browsers leave out.
  8436. // With quoted = false, only CR and LF are escaped; this is for header values
  8437. // outside a quoted-string (e.g. Content-Type), where '"' and '\' are legal.
  8438. inline std::string escape_multipart_field(const std::string &s,
  8439. bool quoted = true) {
  8440. std::string result;
  8441. result.reserve(s.size());
  8442. for (auto c : s) {
  8443. switch (c) {
  8444. case '"':
  8445. if (quoted) {
  8446. result += "%22";
  8447. } else {
  8448. result += c;
  8449. }
  8450. break;
  8451. case '\\':
  8452. // A lone backslash would escape the character after it (RFC 9110
  8453. // 5.6.4).
  8454. if (quoted) { result += '\\'; }
  8455. result += c;
  8456. break;
  8457. case '\r': result += "%0D"; break;
  8458. case '\n': result += "%0A"; break;
  8459. default: result += c; break;
  8460. }
  8461. }
  8462. return result;
  8463. }
  8464. template <typename T>
  8465. inline std::string
  8466. serialize_multipart_formdata_item_begin(const T &item,
  8467. const std::string &boundary) {
  8468. std::string body = "--" + boundary + "\r\n";
  8469. body += "Content-Disposition: form-data; name=\"" +
  8470. escape_multipart_field(item.name) + "\"";
  8471. if (!item.filename.empty()) {
  8472. body += "; filename=\"" + escape_multipart_field(item.filename) + "\"";
  8473. }
  8474. body += "\r\n";
  8475. if (!item.content_type.empty()) {
  8476. body +=
  8477. "Content-Type: " + escape_multipart_field(item.content_type, false) +
  8478. "\r\n";
  8479. }
  8480. body += "\r\n";
  8481. return body;
  8482. }
  8483. inline std::string serialize_multipart_formdata_item_end() { return "\r\n"; }
  8484. inline std::string
  8485. serialize_multipart_formdata_finish(const std::string &boundary) {
  8486. return "--" + boundary + "--\r\n";
  8487. }
  8488. inline std::string
  8489. serialize_multipart_formdata_get_content_type(const std::string &boundary) {
  8490. return "multipart/form-data; boundary=" + boundary;
  8491. }
  8492. inline std::string
  8493. serialize_multipart_formdata(const UploadFormDataItems &items,
  8494. const std::string &boundary, bool finish = true) {
  8495. std::string body;
  8496. for (const auto &item : items) {
  8497. body += serialize_multipart_formdata_item_begin(item, boundary);
  8498. body += item.content + serialize_multipart_formdata_item_end();
  8499. }
  8500. if (finish) { body += serialize_multipart_formdata_finish(boundary); }
  8501. return body;
  8502. }
  8503. inline size_t get_multipart_content_length(const UploadFormDataItems &items,
  8504. const std::string &boundary) {
  8505. size_t total = 0;
  8506. for (const auto &item : items) {
  8507. total += serialize_multipart_formdata_item_begin(item, boundary).size();
  8508. total += item.content.size();
  8509. total += serialize_multipart_formdata_item_end().size();
  8510. }
  8511. total += serialize_multipart_formdata_finish(boundary).size();
  8512. return total;
  8513. }
  8514. struct MultipartSegment {
  8515. const char *data;
  8516. size_t size;
  8517. };
  8518. // NOTE: items must outlive the returned ContentProvider
  8519. // (safe for synchronous use inside Post/Put/Patch)
  8520. inline ContentProvider
  8521. make_multipart_content_provider(const UploadFormDataItems &items,
  8522. const std::string &boundary) {
  8523. // Own the per-item header strings and the finish string
  8524. std::vector<std::string> owned;
  8525. owned.reserve(items.size() + 1);
  8526. for (const auto &item : items)
  8527. owned.push_back(serialize_multipart_formdata_item_begin(item, boundary));
  8528. owned.push_back(serialize_multipart_formdata_finish(boundary));
  8529. // Flat segment list: [header, content, "\r\n"] * N + [finish]
  8530. std::vector<MultipartSegment> segs;
  8531. segs.reserve(items.size() * 3 + 1);
  8532. static const char crlf[] = "\r\n";
  8533. for (size_t i = 0; i < items.size(); i++) {
  8534. segs.push_back({owned[i].data(), owned[i].size()});
  8535. segs.push_back({items[i].content.data(), items[i].content.size()});
  8536. segs.push_back({crlf, 2});
  8537. }
  8538. segs.push_back({owned.back().data(), owned.back().size()});
  8539. struct MultipartState {
  8540. std::vector<std::string> owned;
  8541. std::vector<MultipartSegment> segs;
  8542. std::vector<char> buf = std::vector<char>(CPPHTTPLIB_SEND_BUFSIZ);
  8543. };
  8544. auto state = std::make_shared<MultipartState>();
  8545. state->owned = std::move(owned);
  8546. // `segs` holds raw pointers into owned strings; std::string move preserves
  8547. // the data pointer, so these pointers remain valid after the move above.
  8548. state->segs = std::move(segs);
  8549. return [state](size_t offset, size_t length, DataSink &sink) -> bool {
  8550. // Buffer multiple small segments into fewer, larger writes to avoid
  8551. // excessive TCP packets when there are many form data items (#2410)
  8552. auto &buf = state->buf;
  8553. auto buf_size = buf.size();
  8554. size_t buf_len = 0;
  8555. size_t remaining = length;
  8556. // Find the first segment containing 'offset'
  8557. size_t pos = 0;
  8558. size_t seg_idx = 0;
  8559. for (; seg_idx < state->segs.size(); seg_idx++) {
  8560. const auto &seg = state->segs[seg_idx];
  8561. if (seg.size > 0 && offset - pos < seg.size) { break; }
  8562. pos += seg.size;
  8563. }
  8564. size_t seg_offset = (seg_idx < state->segs.size()) ? offset - pos : 0;
  8565. for (; seg_idx < state->segs.size() && remaining > 0; seg_idx++) {
  8566. const auto &seg = state->segs[seg_idx];
  8567. size_t available = seg.size - seg_offset;
  8568. size_t to_copy = (std::min)(available, remaining);
  8569. const char *src = seg.data + seg_offset;
  8570. seg_offset = 0; // only the first segment has a non-zero offset
  8571. while (to_copy > 0) {
  8572. size_t space = buf_size - buf_len;
  8573. size_t chunk = (std::min)(to_copy, space);
  8574. std::memcpy(buf.data() + buf_len, src, chunk);
  8575. buf_len += chunk;
  8576. src += chunk;
  8577. to_copy -= chunk;
  8578. remaining -= chunk;
  8579. if (buf_len == buf_size) {
  8580. if (!sink.write(buf.data(), buf_len)) { return false; }
  8581. buf_len = 0;
  8582. }
  8583. }
  8584. }
  8585. if (buf_len > 0) { return sink.write(buf.data(), buf_len); }
  8586. return true;
  8587. };
  8588. }
  8589. inline void coalesce_ranges(Ranges &ranges, size_t content_length) {
  8590. if (ranges.size() <= 1) return;
  8591. // Sort ranges by start position
  8592. std::sort(ranges.begin(), ranges.end(),
  8593. [](const Range &a, const Range &b) { return a.first < b.first; });
  8594. Ranges coalesced;
  8595. coalesced.reserve(ranges.size());
  8596. for (auto &r : ranges) {
  8597. auto first_pos = r.first;
  8598. auto last_pos = r.second;
  8599. // Handle special cases like in range_error
  8600. if (first_pos == -1 && last_pos == -1) {
  8601. first_pos = 0;
  8602. last_pos = static_cast<ssize_t>(content_length);
  8603. }
  8604. if (first_pos == -1) {
  8605. first_pos = static_cast<ssize_t>(content_length) - last_pos;
  8606. last_pos = static_cast<ssize_t>(content_length) - 1;
  8607. }
  8608. if (last_pos == -1 || last_pos >= static_cast<ssize_t>(content_length)) {
  8609. last_pos = static_cast<ssize_t>(content_length) - 1;
  8610. }
  8611. // Skip invalid ranges
  8612. if (!(0 <= first_pos && first_pos <= last_pos &&
  8613. last_pos < static_cast<ssize_t>(content_length))) {
  8614. continue;
  8615. }
  8616. // Coalesce with previous range if overlapping or adjacent (but not
  8617. // identical)
  8618. if (!coalesced.empty()) {
  8619. auto &prev = coalesced.back();
  8620. // Check if current range overlaps or is adjacent to previous range
  8621. // but don't coalesce identical ranges (allow duplicates)
  8622. if (first_pos <= prev.second + 1 &&
  8623. !(first_pos == prev.first && last_pos == prev.second)) {
  8624. // Extend the previous range
  8625. prev.second = (std::max)(prev.second, last_pos);
  8626. continue;
  8627. }
  8628. }
  8629. // Add new range
  8630. coalesced.emplace_back(first_pos, last_pos);
  8631. }
  8632. ranges = std::move(coalesced);
  8633. }
  8634. inline bool range_error(Request &req, Response &res) {
  8635. if (!req.ranges.empty() && 200 <= res.status && res.status < 300) {
  8636. if (res.body.empty() && res.content_provider_ && res.content_length_ == 0) {
  8637. req.ranges.clear();
  8638. if (res.status == StatusCode::PartialContent_206) {
  8639. res.status = StatusCode::OK_200;
  8640. }
  8641. return false;
  8642. }
  8643. ssize_t content_len = static_cast<ssize_t>(
  8644. res.content_length_ ? res.content_length_ : res.body.size());
  8645. std::vector<std::pair<ssize_t, ssize_t>> processed_ranges;
  8646. size_t overwrapping_count = 0;
  8647. // NOTE: The following Range check is based on '14.2. Range' in RFC 9110
  8648. // 'HTTP Semantics' to avoid potential denial-of-service attacks.
  8649. // https://www.rfc-editor.org/rfc/rfc9110#section-14.2
  8650. // Too many ranges
  8651. if (CPPHTTPLIB_RANGE_MAX_COUNT > 0 &&
  8652. req.ranges.size() > CPPHTTPLIB_RANGE_MAX_COUNT) {
  8653. return true;
  8654. }
  8655. for (auto &r : req.ranges) {
  8656. auto &first_pos = r.first;
  8657. auto &last_pos = r.second;
  8658. if (first_pos == -1 && last_pos == -1) {
  8659. first_pos = 0;
  8660. last_pos = content_len;
  8661. }
  8662. // RFC 9110 14.1.2: a suffix-length longer than the representation
  8663. // selects the entire representation.
  8664. if (first_pos == -1) {
  8665. first_pos = (std::max)(static_cast<ssize_t>(0), content_len - last_pos);
  8666. last_pos = content_len - 1;
  8667. }
  8668. // NOTE: RFC-9110 '14.1.2. Byte Ranges':
  8669. // A client can limit the number of bytes requested without knowing the
  8670. // size of the selected representation. If the last-pos value is absent,
  8671. // or if the value is greater than or equal to the current length of the
  8672. // representation data, the byte range is interpreted as the remainder of
  8673. // the representation (i.e., the server replaces the value of last-pos
  8674. // with a value that is one less than the current length of the selected
  8675. // representation).
  8676. // https://www.rfc-editor.org/rfc/rfc9110.html#section-14.1.2-6
  8677. if (last_pos == -1 || last_pos >= content_len) {
  8678. last_pos = content_len - 1;
  8679. }
  8680. // Range must be within content length
  8681. if (!(0 <= first_pos && first_pos <= last_pos &&
  8682. last_pos <= content_len - 1)) {
  8683. return true;
  8684. }
  8685. // Request must not have more than two overlapping ranges
  8686. for (const auto &processed_range : processed_ranges) {
  8687. if (!(last_pos < processed_range.first ||
  8688. first_pos > processed_range.second)) {
  8689. overwrapping_count++;
  8690. if (overwrapping_count > 2) { return true; }
  8691. break; // Only count once per range
  8692. }
  8693. }
  8694. processed_ranges.emplace_back(first_pos, last_pos);
  8695. }
  8696. // After validation, coalesce overlapping ranges as per RFC 9110
  8697. coalesce_ranges(req.ranges, static_cast<size_t>(content_len));
  8698. }
  8699. return false;
  8700. }
  8701. inline std::pair<size_t, size_t>
  8702. get_range_offset_and_length(Range r, size_t content_length) {
  8703. assert(r.first != -1 && r.second != -1);
  8704. assert(0 <= r.first && r.first < static_cast<ssize_t>(content_length));
  8705. assert(r.first <= r.second &&
  8706. r.second < static_cast<ssize_t>(content_length));
  8707. (void)(content_length);
  8708. return std::make_pair(static_cast<size_t>(r.first),
  8709. static_cast<size_t>(r.second - r.first) + 1);
  8710. }
  8711. inline std::string make_content_range_header_field(
  8712. const std::pair<size_t, size_t> &offset_and_length, size_t content_length) {
  8713. auto st = offset_and_length.first;
  8714. auto ed = st + offset_and_length.second - 1;
  8715. std::string field = "bytes ";
  8716. field += std::to_string(st);
  8717. field += '-';
  8718. field += std::to_string(ed);
  8719. field += '/';
  8720. field += std::to_string(content_length);
  8721. return field;
  8722. }
  8723. template <typename SToken, typename CToken, typename Content>
  8724. bool process_multipart_ranges_data(const Request &req,
  8725. const std::string &boundary,
  8726. const std::string &content_type,
  8727. size_t content_length, SToken stoken,
  8728. CToken ctoken, Content content) {
  8729. for (size_t i = 0; i < req.ranges.size(); i++) {
  8730. ctoken("--");
  8731. stoken(boundary);
  8732. ctoken("\r\n");
  8733. if (!content_type.empty()) {
  8734. ctoken("Content-Type: ");
  8735. stoken(content_type);
  8736. ctoken("\r\n");
  8737. }
  8738. auto offset_and_length =
  8739. get_range_offset_and_length(req.ranges[i], content_length);
  8740. ctoken("Content-Range: ");
  8741. stoken(make_content_range_header_field(offset_and_length, content_length));
  8742. ctoken("\r\n");
  8743. ctoken("\r\n");
  8744. if (!content(offset_and_length.first, offset_and_length.second)) {
  8745. return false;
  8746. }
  8747. ctoken("\r\n");
  8748. }
  8749. ctoken("--");
  8750. stoken(boundary);
  8751. ctoken("--");
  8752. return true;
  8753. }
  8754. inline void make_multipart_ranges_data(const Request &req, Response &res,
  8755. const std::string &boundary,
  8756. const std::string &content_type,
  8757. size_t content_length,
  8758. std::string &data) {
  8759. process_multipart_ranges_data(
  8760. req, boundary, content_type, content_length,
  8761. [&](const std::string &token) { data += token; },
  8762. [&](const std::string &token) { data += token; },
  8763. [&](size_t offset, size_t length) {
  8764. assert(offset + length <= content_length);
  8765. data += res.body.substr(offset, length);
  8766. return true;
  8767. });
  8768. }
  8769. inline size_t get_multipart_ranges_data_length(const Request &req,
  8770. const std::string &boundary,
  8771. const std::string &content_type,
  8772. size_t content_length) {
  8773. size_t data_length = 0;
  8774. process_multipart_ranges_data(
  8775. req, boundary, content_type, content_length,
  8776. [&](const std::string &token) { data_length += token.size(); },
  8777. [&](const std::string &token) { data_length += token.size(); },
  8778. [&](size_t /*offset*/, size_t length) {
  8779. data_length += length;
  8780. return true;
  8781. });
  8782. return data_length;
  8783. }
  8784. template <typename T>
  8785. inline bool
  8786. write_multipart_ranges_data(Stream &strm, const Request &req, Response &res,
  8787. const std::string &boundary,
  8788. const std::string &content_type,
  8789. size_t content_length, const T &is_shutting_down) {
  8790. return process_multipart_ranges_data(
  8791. req, boundary, content_type, content_length,
  8792. [&](const std::string &token) { strm.write(token); },
  8793. [&](const std::string &token) { strm.write(token); },
  8794. [&](size_t offset, size_t length) {
  8795. return write_content(strm, res.content_provider_, offset, length,
  8796. is_shutting_down);
  8797. });
  8798. }
  8799. inline bool has_framed_body(const Request &req) {
  8800. return is_chunked_transfer_encoding(req.headers) ||
  8801. req.get_header_value_u64("Content-Length") > 0;
  8802. }
  8803. inline bool expect_content(const Request &req) {
  8804. if (req.method == "POST" || req.method == "PUT" || req.method == "PATCH" ||
  8805. req.method == "DELETE") {
  8806. return true;
  8807. }
  8808. return has_framed_body(req);
  8809. }
  8810. #ifdef _WIN32
  8811. class WSInit {
  8812. public:
  8813. WSInit() {
  8814. WSADATA wsaData;
  8815. if (WSAStartup(0x0002, &wsaData) == 0) is_valid_ = true;
  8816. }
  8817. ~WSInit() {
  8818. if (is_valid_) WSACleanup();
  8819. }
  8820. bool is_valid_ = false;
  8821. };
  8822. static WSInit wsinit_;
  8823. #endif
  8824. inline std::string unescape_quoted_pairs(const std::string &s) {
  8825. std::string out;
  8826. out.reserve(s.size());
  8827. for (size_t i = 0; i < s.size(); i++) {
  8828. if (s[i] == '\\' && i + 1 < s.size()) {
  8829. out += s[++i];
  8830. } else {
  8831. out += s[i];
  8832. }
  8833. }
  8834. return out;
  8835. }
  8836. // Inverse of unescape_quoted_pairs: prepares a value to sit inside a
  8837. // quoted-string. RFC 9110 §5.6.4 requires a literal '\' or '"' to be sent as a
  8838. // quoted-pair, so the recipient recovers the original value.
  8839. inline std::string escape_quoted_pairs(const std::string &s) {
  8840. std::string out;
  8841. out.reserve(s.size());
  8842. for (auto c : s) {
  8843. if (c == '\\' || c == '"') { out += '\\'; }
  8844. out += c;
  8845. }
  8846. return out;
  8847. }
  8848. // RFC 9110 Section 11.6.1 defines a challenge list as
  8849. // WWW-Authenticate = #challenge
  8850. // challenge = auth-scheme [ 1*SP ( token68 / [ #auth-param ] ) ]
  8851. // auth-param = token BWS "=" BWS ( token / quoted-string )
  8852. // so a server may offer several schemes, each with its own comma-separated
  8853. // auth-param list, in either order and either as separate field lines or
  8854. // packed into one. Splitting on every comma would break apart a challenge's
  8855. // own param list; splitting only on the first space would miss a Digest
  8856. // challenge that isn't first. Split on commas that aren't inside a
  8857. // quoted-string instead (split_unquoted), then track which scheme each
  8858. // resulting segment belongs to: a segment whose text before "=" contains
  8859. // whitespace (or that has no "=" at all) starts a new challenge named by its
  8860. // leading token.
  8861. inline bool parse_www_authenticate(const Response &res,
  8862. std::map<std::string, std::string> &auth,
  8863. bool is_proxy) {
  8864. auto auth_key = is_proxy ? "Proxy-Authenticate" : "WWW-Authenticate";
  8865. auto combined = get_combined_header_value(res.headers, auth_key);
  8866. if (combined.empty()) { return false; }
  8867. auto found_digest = false;
  8868. auto in_digest_challenge = false;
  8869. split_unquoted(
  8870. combined.data(), combined.data() + combined.size(), ',',
  8871. [&](const char *b, const char *e) {
  8872. std::string segment(b, e);
  8873. auto eq_pos = segment.find('=');
  8874. // BWS is allowed on both sides of "=", so the text naming the key (or,
  8875. // for the first segment of a challenge, "<scheme> <key>") must be
  8876. // trimmed before its boundaries are inspected.
  8877. auto key_part = trim_copy(
  8878. eq_pos == std::string::npos ? segment : segment.substr(0, eq_pos));
  8879. auto space_pos = key_part.find_last_of(" \t");
  8880. if (space_pos != std::string::npos || eq_pos == std::string::npos) {
  8881. // "<scheme>[ <key>]" starts a new challenge.
  8882. auto scheme_end =
  8883. space_pos == std::string::npos ? key_part.size() : space_pos;
  8884. // RFC 7616 Section 3.7: a server may offer more than one Digest
  8885. // challenge (e.g. SHA-256 and MD5); keep only the first so a nonce
  8886. // from one challenge is never paired with another's algorithm.
  8887. in_digest_challenge =
  8888. !found_digest &&
  8889. case_ignore::equal(key_part.substr(0, scheme_end), "Digest");
  8890. if (in_digest_challenge) { found_digest = true; }
  8891. if (space_pos == std::string::npos) {
  8892. // Bare scheme (or a token68), no auth-param on this segment.
  8893. return;
  8894. }
  8895. key_part = key_part.substr(space_pos + 1);
  8896. }
  8897. if (!in_digest_challenge) { return; }
  8898. auto val = trim_copy(segment.substr(eq_pos + 1));
  8899. auto unquoted = trim_double_quotes_copy(val);
  8900. if (unquoted.size() != val.size()) {
  8901. unquoted = unescape_quoted_pairs(unquoted);
  8902. }
  8903. auth[std::move(key_part)] = std::move(unquoted);
  8904. });
  8905. // RFC 7616 Section 3.3 requires realm and nonce on every Digest challenge;
  8906. // make_digest_authentication_header() dereferences both unconditionally, so
  8907. // a challenge missing either can't produce a usable Authorization header.
  8908. // Treat it the same as no Digest challenge at all.
  8909. return found_digest && auth.find("realm") != auth.end() &&
  8910. auth.find("nonce") != auth.end();
  8911. }
  8912. class ContentProviderAdapter {
  8913. public:
  8914. explicit ContentProviderAdapter(
  8915. ContentProviderWithoutLength &&content_provider)
  8916. : content_provider_(std::move(content_provider)) {}
  8917. bool operator()(size_t offset, size_t, DataSink &sink) {
  8918. return content_provider_(offset, sink);
  8919. }
  8920. private:
  8921. ContentProviderWithoutLength content_provider_;
  8922. };
  8923. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  8924. namespace fields {
  8925. inline bool is_token_char(char c) {
  8926. return is_ascii_alnum(c) || c == '!' || c == '#' || c == '$' || c == '%' ||
  8927. c == '&' || c == '\'' || c == '*' || c == '+' || c == '-' ||
  8928. c == '.' || c == '^' || c == '_' || c == '`' || c == '|' || c == '~';
  8929. }
  8930. inline bool is_token(const std::string &s) {
  8931. if (s.empty()) { return false; }
  8932. for (auto c : s) {
  8933. if (!is_token_char(c)) { return false; }
  8934. }
  8935. return true;
  8936. }
  8937. inline bool is_field_name(const std::string &s) { return is_token(s); }
  8938. inline bool is_vchar(char c) { return c >= 33 && c <= 126; }
  8939. inline bool is_obs_text(char c) { return 128 <= static_cast<unsigned char>(c); }
  8940. inline bool is_field_vchar(char c) { return is_vchar(c) || is_obs_text(c); }
  8941. inline bool is_field_content(const std::string &s) {
  8942. if (s.empty()) { return true; }
  8943. if (s.size() == 1) {
  8944. return is_field_vchar(s[0]);
  8945. } else if (s.size() == 2) {
  8946. return is_field_vchar(s[0]) && is_field_vchar(s[1]);
  8947. } else {
  8948. size_t i = 0;
  8949. if (!is_field_vchar(s[i])) { return false; }
  8950. i++;
  8951. while (i < s.size() - 1) {
  8952. auto c = s[i++];
  8953. if (c == ' ' || c == '\t' || is_field_vchar(c)) {
  8954. } else {
  8955. return false;
  8956. }
  8957. }
  8958. return is_field_vchar(s[i]);
  8959. }
  8960. }
  8961. inline bool is_field_value(const std::string &s) { return is_field_content(s); }
  8962. inline bool is_field_valid(const std::string &name, const std::string &value) {
  8963. return is_field_name(name) && is_field_value(value);
  8964. }
  8965. // RFC 9112 §2.2/§3.2: the request-target has no SP, HTAB or other control
  8966. // characters (incl. bare CR). obs-text (raw UTF-8) is allowed.
  8967. inline bool is_request_target(const std::string &s) {
  8968. return std::all_of(s.begin(), s.end(), is_field_vchar);
  8969. }
  8970. // RFC 9110 §7.2: the bytes of uri-host [ ":" port ], i.e. unreserved,
  8971. // sub-delims, "%", ":" and the IP-literal brackets. An empty value is valid.
  8972. inline bool is_host(const std::string &s) {
  8973. return std::all_of(s.begin(), s.end(), [](char c) {
  8974. return is_ascii_alnum(c) || c == '-' || c == '.' || c == '_' || c == '~' ||
  8975. c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  8976. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  8977. c == '=' || c == '%' || c == ':' || c == '[' || c == ']';
  8978. });
  8979. }
  8980. } // namespace fields
  8981. // Built in memory first, like ClientImpl::write_request, so a rejected header
  8982. // never leaves a partial request on the wire.
  8983. inline bool write_request_head(Stream &strm, Request &req, Error &error) {
  8984. BufferStream bstrm;
  8985. if (write_request_line(bstrm, req.method, req.path) < 0) {
  8986. error = Error::Write;
  8987. return false;
  8988. }
  8989. if (!check_and_write_headers(bstrm, req.headers, write_headers, error)) {
  8990. return false;
  8991. }
  8992. const auto &data = bstrm.get_buffer();
  8993. if (!write_data(strm, data.data(), data.size())) {
  8994. error = Error::Write;
  8995. return false;
  8996. }
  8997. return true;
  8998. }
  8999. inline bool perform_websocket_handshake(Stream &strm, Request &req,
  9000. WebSocketUpgradeResponse &upgrade) {
  9001. // Generate a random 16-byte Sec-WebSocket-Key (RFC 6455 Section 4.1)
  9002. std::string key_bytes(16, '\0');
  9003. fill_random_bytes(reinterpret_cast<unsigned char *>(&key_bytes[0]),
  9004. key_bytes.size());
  9005. auto client_key = base64_encode(key_bytes);
  9006. req.headers.erase("Upgrade");
  9007. req.headers.erase("Connection");
  9008. req.headers.erase("Sec-WebSocket-Key");
  9009. req.headers.erase("Sec-WebSocket-Version");
  9010. req.headers.emplace("Upgrade", "websocket");
  9011. req.headers.emplace("Connection", "Upgrade");
  9012. req.headers.emplace("Sec-WebSocket-Key", client_key);
  9013. req.headers.emplace("Sec-WebSocket-Version", "13");
  9014. if (!write_request_head(strm, req, upgrade.error)) { return false; }
  9015. // Verify 101 response and Sec-WebSocket-Accept header
  9016. auto expected_accept = websocket_accept_key(client_key);
  9017. auto offered_subprotocols =
  9018. get_combined_header_value(req.headers, "Sec-WebSocket-Protocol");
  9019. return read_websocket_upgrade_response(strm, expected_accept,
  9020. offered_subprotocols, upgrade);
  9021. }
  9022. inline bool is_ip_address(const std::string &host) {
  9023. struct in_addr addr4;
  9024. struct in6_addr addr6;
  9025. return inet_pton(AF_INET, host.c_str(), &addr4) == 1 ||
  9026. inet_pton(AF_INET6, host.c_str(), &addr6) == 1;
  9027. }
  9028. // One spelling for an IPv6 address, and the IPv4 one for an IPv4-mapped IPv6
  9029. // address, which is how a dual-stack socket reports an IPv4 peer. Anything
  9030. // else, including an address with a zone ID, is returned as it is.
  9031. inline std::string canonical_ip(const std::string &addr) {
  9032. struct in6_addr addr6;
  9033. if (addr.find('%') != std::string::npos ||
  9034. inet_pton(AF_INET6, addr.c_str(), &addr6) != 1) {
  9035. return addr;
  9036. }
  9037. char buf[INET6_ADDRSTRLEN];
  9038. if (IN6_IS_ADDR_V4MAPPED(&addr6)) {
  9039. return inet_ntop(AF_INET, &addr6.s6_addr[12], buf, sizeof(buf)) ? buf
  9040. : addr;
  9041. }
  9042. return inet_ntop(AF_INET6, &addr6, buf, sizeof(buf)) ? buf : addr;
  9043. }
  9044. // `trusted_proxies` holds canonical_ip() spellings.
  9045. inline bool is_trusted_proxy(const std::string &addr,
  9046. const std::vector<std::string> &trusted_proxies) {
  9047. if (trusted_proxies.empty()) { return false; }
  9048. return std::find(trusted_proxies.begin(), trusted_proxies.end(),
  9049. canonical_ip(addr)) != trusted_proxies.end();
  9050. }
  9051. // Resolve where a client should connect for `host`, honoring a user-supplied
  9052. // hostname-to-address map. `host` itself is never rewritten, so it keeps
  9053. // supplying the Host header and SNI; only the connection target changes.
  9054. //
  9055. // A mapped IP literal goes to `ip`, which keeps create_socket's AI_NUMERICHOST
  9056. // path. Anything else goes to `connect_host`, which create_socket resolves as
  9057. // a name, or uses as the socket path when the address family is AF_UNIX. An
  9058. // absent or empty mapping leaves `host` as the connection target; without the
  9059. // empty check the value would reach getaddrinfo as a null node and silently
  9060. // resolve to loopback.
  9061. inline void apply_addr_map(const std::map<std::string, std::string> &addr_map,
  9062. const std::string &host, std::string &connect_host,
  9063. std::string &ip) {
  9064. connect_host = host;
  9065. ip.clear();
  9066. auto it = addr_map.find(host);
  9067. if (it == addr_map.end() || it->second.empty()) { return; }
  9068. if (is_ip_address(it->second)) {
  9069. ip = it->second;
  9070. } else {
  9071. connect_host = it->second;
  9072. }
  9073. }
  9074. } // namespace detail
  9075. /*
  9076. * Group 2: detail namespace - SSL common utilities
  9077. */
  9078. #ifdef CPPHTTPLIB_SSL_ENABLED
  9079. namespace detail {
  9080. class SSLSocketStream final : public Stream {
  9081. public:
  9082. SSLSocketStream(
  9083. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  9084. time_t read_timeout_usec, time_t write_timeout_sec,
  9085. time_t write_timeout_usec, time_t max_timeout_msec = 0,
  9086. std::chrono::time_point<std::chrono::steady_clock> start_time =
  9087. (std::chrono::steady_clock::time_point::min)());
  9088. ~SSLSocketStream() override;
  9089. bool is_readable() const override;
  9090. bool wait_readable() const override;
  9091. bool wait_writable() const override;
  9092. bool is_peer_alive() const override;
  9093. ssize_t read(char *ptr, size_t size) override;
  9094. ssize_t write(const char *ptr, size_t size) override;
  9095. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  9096. void get_local_ip_and_port(std::string &ip, int &port) const override;
  9097. socket_t socket() const override;
  9098. time_t duration() const override;
  9099. void set_read_timeout(time_t sec, time_t usec = 0) override;
  9100. void set_max_timeout(time_t msec) override;
  9101. void set_read_interrupt(std::function<bool()> interrupted) override;
  9102. // See SocketStream::set_readable_hint().
  9103. void set_readable_hint() { readable_hint_ = true; }
  9104. // The error from the last read() or write() that failed in the TLS layer,
  9105. // with code Success if none did
  9106. const tls::TlsError &tls_error() const { return tls_error_; }
  9107. private:
  9108. bool ensure_readable();
  9109. socket_t sock_;
  9110. tls::session_t session_;
  9111. time_t read_timeout_sec_;
  9112. time_t read_timeout_usec_;
  9113. time_t write_timeout_sec_;
  9114. time_t write_timeout_usec_;
  9115. time_t max_timeout_msec_;
  9116. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  9117. std::function<bool()> read_interrupted_;
  9118. bool readable_hint_ = false;
  9119. tls::TlsError tls_error_;
  9120. };
  9121. // A TLS stream for WebSocket connections, where the receive path and the
  9122. // send path (application send() plus the heartbeat ping thread) run on
  9123. // different threads. A single TLS session must never be entered
  9124. // concurrently, so every call into the session is serialized by one mutex.
  9125. //
  9126. // Unlike SSLSocketStream, the socket is kept non-blocking for the stream's
  9127. // whole lifetime and each read()/write() performs a single non-blocking TLS
  9128. // call under the lock, then waits for readiness with select() outside the
  9129. // lock. The lock is therefore held only for CPU-bound work, so a reader
  9130. // blocked waiting for data never stalls a concurrent sender.
  9131. //
  9132. // This stream is used only for wss:// connections. Plain ws:// and ordinary
  9133. // HTTP/HTTPS keep using SocketStream/SSLSocketStream unchanged.
  9134. class WebSocketSSLStream final : public Stream {
  9135. public:
  9136. WebSocketSSLStream(socket_t sock, tls::session_t session,
  9137. time_t read_timeout_sec, time_t read_timeout_usec,
  9138. time_t write_timeout_sec, time_t write_timeout_usec);
  9139. ~WebSocketSSLStream() override;
  9140. bool is_readable() const override;
  9141. bool wait_readable() const override;
  9142. bool wait_writable() const override;
  9143. ssize_t read(char *ptr, size_t size) override;
  9144. ssize_t write(const char *ptr, size_t size) override;
  9145. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  9146. void get_local_ip_and_port(std::string &ip, int &port) const override;
  9147. socket_t socket() const override;
  9148. time_t duration() const override;
  9149. void set_read_timeout(time_t sec, time_t usec = 0) override;
  9150. void set_read_interrupt(std::function<bool()> interrupted) override;
  9151. private:
  9152. mutable std::mutex session_mutex_;
  9153. socket_t sock_;
  9154. tls::session_t session_;
  9155. // WebSocket::close() shortens the read timeout from the closing thread
  9156. // while the receive thread is inside wait_readable(), so these two are read
  9157. // and written concurrently. The write timeouts are never mutated.
  9158. std::atomic<time_t> read_timeout_sec_;
  9159. std::atomic<time_t> read_timeout_usec_;
  9160. time_t write_timeout_sec_;
  9161. time_t write_timeout_usec_;
  9162. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  9163. std::function<bool()> read_interrupted_;
  9164. };
  9165. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  9166. inline std::string message_digest(const std::string &s, const EVP_MD *algo) {
  9167. auto context = std::unique_ptr<EVP_MD_CTX, decltype(&EVP_MD_CTX_free)>(
  9168. EVP_MD_CTX_new(), EVP_MD_CTX_free);
  9169. unsigned int hash_length = 0;
  9170. unsigned char hash[EVP_MAX_MD_SIZE];
  9171. EVP_DigestInit_ex(context.get(), algo, nullptr);
  9172. EVP_DigestUpdate(context.get(), s.c_str(), s.size());
  9173. EVP_DigestFinal_ex(context.get(), hash, &hash_length);
  9174. std::stringstream ss;
  9175. for (auto i = 0u; i < hash_length; ++i) {
  9176. ss << std::hex << std::setw(2) << std::setfill('0')
  9177. << static_cast<unsigned int>(hash[i]);
  9178. }
  9179. return ss.str();
  9180. }
  9181. inline std::string MD5(const std::string &s) {
  9182. return message_digest(s, EVP_md5());
  9183. }
  9184. inline std::string SHA_256(const std::string &s) {
  9185. return message_digest(s, EVP_sha256());
  9186. }
  9187. inline std::string SHA_512(const std::string &s) {
  9188. return message_digest(s, EVP_sha512());
  9189. }
  9190. #elif defined(CPPHTTPLIB_MBEDTLS_SUPPORT)
  9191. namespace {
  9192. template <size_t N>
  9193. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  9194. std::stringstream ss;
  9195. for (size_t i = 0; i < N; ++i) {
  9196. ss << std::hex << std::setw(2) << std::setfill('0')
  9197. << static_cast<unsigned int>(hash[i]);
  9198. }
  9199. return ss.str();
  9200. }
  9201. } // namespace
  9202. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9203. // Mbed TLS 4.x provides hashing (and TLS RNG) via PSA Crypto, which must be
  9204. // initialized once. PSA state is process-global; do not free it.
  9205. inline bool ensure_mbedtls_psa_crypto() {
  9206. static std::once_flag once;
  9207. static bool ok = false;
  9208. std::call_once(once, []() { ok = (psa_crypto_init() == PSA_SUCCESS); });
  9209. return ok;
  9210. }
  9211. inline bool psa_hash(psa_algorithm_t alg, const std::string &s,
  9212. unsigned char *out, size_t out_size) {
  9213. if (!ensure_mbedtls_psa_crypto()) { return false; }
  9214. size_t olen = 0;
  9215. return psa_hash_compute(alg, reinterpret_cast<const uint8_t *>(s.data()),
  9216. s.size(), out, out_size, &olen) == PSA_SUCCESS &&
  9217. olen == out_size;
  9218. }
  9219. #endif
  9220. inline std::string MD5(const std::string &s) {
  9221. unsigned char hash[16];
  9222. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9223. if (!psa_hash(PSA_ALG_MD5, s, hash, sizeof(hash))) { return {}; }
  9224. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9225. mbedtls_md5(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9226. hash);
  9227. #else
  9228. mbedtls_md5_ret(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9229. hash);
  9230. #endif
  9231. return hash_to_hex(hash);
  9232. }
  9233. inline std::string SHA_256(const std::string &s) {
  9234. unsigned char hash[32];
  9235. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9236. if (!psa_hash(PSA_ALG_SHA_256, s, hash, sizeof(hash))) { return {}; }
  9237. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9238. mbedtls_sha256(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9239. hash, 0);
  9240. #else
  9241. mbedtls_sha256_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9242. s.size(), hash, 0);
  9243. #endif
  9244. return hash_to_hex(hash);
  9245. }
  9246. inline std::string SHA_512(const std::string &s) {
  9247. unsigned char hash[64];
  9248. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9249. if (!psa_hash(PSA_ALG_SHA_512, s, hash, sizeof(hash))) { return {}; }
  9250. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9251. mbedtls_sha512(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9252. hash, 0);
  9253. #else
  9254. mbedtls_sha512_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9255. s.size(), hash, 0);
  9256. #endif
  9257. return hash_to_hex(hash);
  9258. }
  9259. #elif defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9260. namespace {
  9261. template <size_t N>
  9262. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  9263. std::stringstream ss;
  9264. for (size_t i = 0; i < N; ++i) {
  9265. ss << std::hex << std::setw(2) << std::setfill('0')
  9266. << static_cast<unsigned int>(hash[i]);
  9267. }
  9268. return ss.str();
  9269. }
  9270. } // namespace
  9271. inline std::string MD5(const std::string &s) {
  9272. unsigned char hash[WC_MD5_DIGEST_SIZE];
  9273. wc_Md5Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9274. static_cast<word32>(s.size()), hash);
  9275. return hash_to_hex(hash);
  9276. }
  9277. inline std::string SHA_256(const std::string &s) {
  9278. unsigned char hash[WC_SHA256_DIGEST_SIZE];
  9279. wc_Sha256Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9280. static_cast<word32>(s.size()), hash);
  9281. return hash_to_hex(hash);
  9282. }
  9283. inline std::string SHA_512(const std::string &s) {
  9284. unsigned char hash[WC_SHA512_DIGEST_SIZE];
  9285. wc_Sha512Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9286. static_cast<word32>(s.size()), hash);
  9287. return hash_to_hex(hash);
  9288. }
  9289. #endif
  9290. template <typename T>
  9291. inline bool process_server_socket_ssl(
  9292. const std::atomic<socket_t> &svr_sock, tls::session_t session,
  9293. socket_t sock, size_t keep_alive_max_count, time_t keep_alive_timeout_sec,
  9294. time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec,
  9295. time_t write_timeout_usec, T callback) {
  9296. // See process_server_socket(). The TLS library keeps already decrypted bytes
  9297. // of a pipelined request, which keep_alive() cannot see on the socket.
  9298. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9299. write_timeout_sec, write_timeout_usec);
  9300. return process_server_socket_core(
  9301. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  9302. [&]() { return strm.is_readable(); },
  9303. [&](bool socket_readable, bool close_connection,
  9304. bool &connection_closed) {
  9305. if (socket_readable) { strm.set_readable_hint(); }
  9306. return callback(strm, close_connection, connection_closed);
  9307. });
  9308. }
  9309. template <typename T>
  9310. inline bool process_client_socket_ssl(
  9311. tls::session_t session, socket_t sock, time_t read_timeout_sec,
  9312. time_t read_timeout_usec, time_t write_timeout_sec,
  9313. time_t write_timeout_usec, time_t max_timeout_msec,
  9314. std::chrono::time_point<std::chrono::steady_clock> start_time, T callback) {
  9315. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9316. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  9317. start_time);
  9318. return callback(strm);
  9319. }
  9320. // `uri` is req's request-target in origin form, as curl sends it, also when
  9321. // the request line carries the absolute form for a proxy.
  9322. inline std::pair<std::string, std::string> make_digest_authentication_header(
  9323. const Request &req, const std::string &uri,
  9324. const std::map<std::string, std::string> &auth, size_t cnonce_count,
  9325. const std::string &cnonce, const std::string &username,
  9326. const std::string &password, bool is_proxy = false) {
  9327. std::string nc;
  9328. {
  9329. std::stringstream ss;
  9330. ss << std::setfill('0') << std::setw(8) << std::hex << cnonce_count;
  9331. nc = ss.str();
  9332. }
  9333. std::string qop;
  9334. if (auth.find("qop") != auth.end()) {
  9335. qop = auth.at("qop");
  9336. if (qop.find("auth-int") != std::string::npos) {
  9337. qop = "auth-int";
  9338. } else if (qop.find("auth") != std::string::npos) {
  9339. qop = "auth";
  9340. } else {
  9341. qop.clear();
  9342. }
  9343. }
  9344. std::string algo = "MD5";
  9345. if (auth.find("algorithm") != auth.end()) {
  9346. // algorithm is an unquoted token (RFC 7616 §3.4). A server value that is
  9347. // not a token would otherwise be emitted verbatim and could carry commas
  9348. // or quotes that inject further auth-params into the header below.
  9349. const auto &a = auth.at("algorithm");
  9350. if (fields::is_token(a)) { algo = a; }
  9351. }
  9352. std::string response;
  9353. {
  9354. auto H = algo == "SHA-256" ? detail::SHA_256
  9355. : algo == "SHA-512" ? detail::SHA_512
  9356. : detail::MD5;
  9357. auto A1 = username + ":" + auth.at("realm") + ":" + password;
  9358. auto A2 = req.method + ":" + uri;
  9359. if (qop == "auth-int") { A2 += ":" + H(req.body); }
  9360. if (qop.empty()) {
  9361. response = H(H(A1) + ":" + auth.at("nonce") + ":" + H(A2));
  9362. } else {
  9363. response = H(H(A1) + ":" + auth.at("nonce") + ":" + nc + ":" + cnonce +
  9364. ":" + qop + ":" + H(A2));
  9365. }
  9366. }
  9367. auto opaque = (auth.find("opaque") != auth.end()) ? auth.at("opaque") : "";
  9368. // Every value placed inside a quoted-string is escaped so a '"' in it cannot
  9369. // close the string early. realm, nonce and opaque come straight from the
  9370. // server's challenge (parse_www_authenticate() already de-escaped them), so
  9371. // without this a crafted challenge injects extra auth-params into the header.
  9372. auto field =
  9373. "Digest username=\"" + detail::escape_quoted_pairs(username) +
  9374. "\", realm=\"" + detail::escape_quoted_pairs(auth.at("realm")) +
  9375. "\", nonce=\"" + detail::escape_quoted_pairs(auth.at("nonce")) +
  9376. "\", uri=\"" + detail::escape_quoted_pairs(uri) +
  9377. "\", algorithm=" + algo +
  9378. (qop.empty() ? ", response=\""
  9379. : ", qop=" + qop + ", nc=" + nc + ", cnonce=\"" + cnonce +
  9380. "\", response=\"") +
  9381. response + "\"" +
  9382. (opaque.empty()
  9383. ? ""
  9384. : ", opaque=\"" + detail::escape_quoted_pairs(opaque) + "\"");
  9385. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9386. return std::make_pair(key, field);
  9387. }
  9388. // Follows X509_check_host, which the OpenSSL backend uses, so that every
  9389. // backend accepts the same names.
  9390. inline bool match_hostname(const std::string &pattern,
  9391. const std::string &hostname) {
  9392. // A trailing dot on the host is ignored
  9393. auto host = hostname;
  9394. if (host.size() > 1 && host.back() == '.') { host.pop_back(); }
  9395. // Exact match (case-insensitive)
  9396. if (detail::case_ignore::equal(host, pattern)) { return true; }
  9397. // Split both pattern and hostname into components by '.', keeping any empty
  9398. // one, which no name may have
  9399. auto labels = [](const std::string &s) {
  9400. std::vector<std::string> v;
  9401. size_t b = 0;
  9402. while (true) {
  9403. auto e = s.find('.', b);
  9404. v.push_back(s.substr(b, e - b));
  9405. if (e == std::string::npos) { return v; }
  9406. b = e + 1;
  9407. }
  9408. };
  9409. auto pattern_components = labels(pattern);
  9410. auto host_components = labels(host);
  9411. auto has_empty_label = [](const std::vector<std::string> &v) {
  9412. return std::any_of(v.begin(), v.end(),
  9413. [](const std::string &l) { return l.empty(); });
  9414. };
  9415. if (has_empty_label(pattern_components) || has_empty_label(host_components)) {
  9416. return false;
  9417. }
  9418. // Component count must match
  9419. if (host_components.size() != pattern_components.size()) { return false; }
  9420. // A wildcard needs two labels after it, so that "*.com" matches nothing,
  9421. // and an IDNA label may not have one
  9422. const auto &leftmost = pattern_components.front();
  9423. if (leftmost.find('*') != std::string::npos &&
  9424. (pattern_components.size() < 3 ||
  9425. case_ignore::equal(leftmost.substr(0, 4), "xn--"))) {
  9426. return false;
  9427. }
  9428. // Compare each component with wildcard support
  9429. // Supports: "*" (full wildcard), "prefix*" (partial wildcard)
  9430. // https://bugs.launchpad.net/ubuntu/+source/firefox-3.0/+bug/376484
  9431. // Only the leftmost label may carry a wildcard (RFC 6125 6.4.3)
  9432. auto itr = pattern_components.begin();
  9433. for (const auto &h : host_components) {
  9434. auto &p = *itr;
  9435. auto is_leftmost = itr == pattern_components.begin();
  9436. if (!detail::case_ignore::equal(p, h) && !(is_leftmost && p == "*")) {
  9437. bool partial_match = false;
  9438. if (is_leftmost && !p.empty() && p[p.size() - 1] == '*') {
  9439. const auto prefix_length = p.size() - 1;
  9440. if (prefix_length == 0) {
  9441. partial_match = true;
  9442. } else if (h.size() >= prefix_length) {
  9443. partial_match =
  9444. std::equal(p.begin(),
  9445. p.begin() + static_cast<std::string::difference_type>(
  9446. prefix_length),
  9447. h.begin(), [](const char ca, const char cb) {
  9448. return detail::case_ignore::to_lower(ca) ==
  9449. detail::case_ignore::to_lower(cb);
  9450. });
  9451. }
  9452. }
  9453. if (!partial_match) { return false; }
  9454. }
  9455. ++itr;
  9456. }
  9457. return true;
  9458. }
  9459. #ifdef _WIN32
  9460. // Verify certificate using Windows CertGetCertificateChain API.
  9461. // This provides real-time certificate validation with Windows Update
  9462. // integration, independent of the TLS backend.
  9463. inline bool verify_cert_with_windows_schannel(
  9464. const std::vector<unsigned char> &der_cert, const std::string &hostname,
  9465. bool verify_hostname, uint64_t &out_error, tls::const_session_t session) {
  9466. if (der_cert.empty()) { return false; }
  9467. out_error = 0;
  9468. // Create Windows certificate context from DER data
  9469. auto cert_context = CertCreateCertificateContext(
  9470. X509_ASN_ENCODING | PKCS_7_ASN_ENCODING, der_cert.data(),
  9471. static_cast<DWORD>(der_cert.size()));
  9472. if (!cert_context) {
  9473. out_error = GetLastError();
  9474. return false;
  9475. }
  9476. auto cert_guard =
  9477. scope_exit([&] { CertFreeCertificateContext(cert_context); });
  9478. // Give CryptoAPI the certificates the server sent. Without them it follows
  9479. // the leaf's AIA URL, which may lead to an issuer under an untrusted root.
  9480. std::vector<tls::cert_t> peer_certs;
  9481. tls::get_peer_certs(session, peer_certs);
  9482. auto store = CertOpenStore(CERT_STORE_PROV_MEMORY, 0, 0, 0, nullptr);
  9483. auto store_guard = scope_exit([&] {
  9484. for (auto cert : peer_certs) {
  9485. tls::free_cert(cert);
  9486. }
  9487. if (store) { CertCloseStore(store, 0); }
  9488. });
  9489. for (auto cert : peer_certs) {
  9490. std::vector<unsigned char> der;
  9491. if (store && tls::get_cert_der(cert, der)) {
  9492. CertAddEncodedCertificateToStore(store, X509_ASN_ENCODING, der.data(),
  9493. static_cast<DWORD>(der.size()),
  9494. CERT_STORE_ADD_USE_EXISTING, nullptr);
  9495. }
  9496. }
  9497. // Setup chain parameters
  9498. CERT_CHAIN_PARA chain_para = {};
  9499. chain_para.cbSize = sizeof(chain_para);
  9500. // Require the server authentication usage along the chain, which also
  9501. // rejects roots that Windows trusts only for other purposes.
  9502. LPSTR server_auth = const_cast<LPSTR>(szOID_PKIX_KP_SERVER_AUTH);
  9503. chain_para.RequestedUsage.dwType = USAGE_MATCH_TYPE_AND;
  9504. chain_para.RequestedUsage.Usage.cUsageIdentifier = 1;
  9505. chain_para.RequestedUsage.Usage.rgpszUsageIdentifier = &server_auth;
  9506. // Build certificate chain with revocation checking
  9507. PCCERT_CHAIN_CONTEXT chain_context = nullptr;
  9508. auto chain_result = CertGetCertificateChain(
  9509. nullptr, cert_context, nullptr, store, &chain_para,
  9510. CERT_CHAIN_CACHE_END_CERT | CERT_CHAIN_REVOCATION_CHECK_END_CERT |
  9511. CERT_CHAIN_REVOCATION_ACCUMULATIVE_TIMEOUT,
  9512. nullptr, &chain_context);
  9513. if (!chain_result || !chain_context) {
  9514. out_error = GetLastError();
  9515. return false;
  9516. }
  9517. auto chain_guard =
  9518. scope_exit([&] { CertFreeCertificateChain(chain_context); });
  9519. // Verify SSL policy
  9520. SSL_EXTRA_CERT_CHAIN_POLICY_PARA extra_policy_para = {};
  9521. extra_policy_para.cbSize = sizeof(extra_policy_para);
  9522. #ifdef AUTHTYPE_SERVER
  9523. extra_policy_para.dwAuthType = AUTHTYPE_SERVER;
  9524. #endif
  9525. std::wstring whost;
  9526. if (verify_hostname) {
  9527. whost = u8string_to_wstring(hostname.c_str());
  9528. extra_policy_para.pwszServerName = const_cast<wchar_t *>(whost.c_str());
  9529. }
  9530. CERT_CHAIN_POLICY_PARA policy_para = {};
  9531. policy_para.cbSize = sizeof(policy_para);
  9532. #ifdef CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS
  9533. policy_para.dwFlags = CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS;
  9534. #else
  9535. policy_para.dwFlags = 0;
  9536. #endif
  9537. policy_para.pvExtraPolicyPara = &extra_policy_para;
  9538. CERT_CHAIN_POLICY_STATUS policy_status = {};
  9539. policy_status.cbSize = sizeof(policy_status);
  9540. if (!CertVerifyCertificateChainPolicy(CERT_CHAIN_POLICY_SSL, chain_context,
  9541. &policy_para, &policy_status)) {
  9542. out_error = GetLastError();
  9543. return false;
  9544. }
  9545. if (policy_status.dwError != 0) {
  9546. out_error = policy_status.dwError;
  9547. return false;
  9548. }
  9549. return true;
  9550. }
  9551. #endif // _WIN32
  9552. // Loads CA file/dir configuration and applies the system CA policy to a
  9553. // client TLS context. PEM data and native stores are applied to the context
  9554. // directly at set time; has_custom_store reflects them for the Auto policy
  9555. // decision.
  9556. inline bool load_client_ca_config(tls::ctx_t ctx,
  9557. const std::string &ca_cert_file_path,
  9558. const std::string &ca_cert_dir_path,
  9559. bool has_custom_store, SystemCAMode mode,
  9560. uint64_t &backend_error) {
  9561. auto ret = true;
  9562. if (!ca_cert_file_path.empty()) {
  9563. if (!tls::load_ca_file(ctx, ca_cert_file_path.c_str())) {
  9564. backend_error = tls::get_error();
  9565. ret = false;
  9566. }
  9567. } else if (!ca_cert_dir_path.empty()) {
  9568. if (!tls::load_ca_dir(ctx, ca_cert_dir_path.c_str())) {
  9569. backend_error = tls::get_error();
  9570. ret = false;
  9571. }
  9572. }
  9573. auto has_custom_ca = !ca_cert_file_path.empty() ||
  9574. !ca_cert_dir_path.empty() || has_custom_store;
  9575. if (mode == SystemCAMode::Enabled ||
  9576. (mode == SystemCAMode::Auto && !has_custom_ca)) {
  9577. if (!tls::load_system_certs(ctx)) { backend_error = tls::get_error(); }
  9578. }
  9579. return ret;
  9580. }
  9581. // Serializes the CA certificates installed in ctx as PEM, so they can be
  9582. // loaded into another context.
  9583. inline std::string ca_certs_to_pem(tls::ctx_t ctx) {
  9584. std::string pem;
  9585. std::vector<tls::cert_t> certs;
  9586. tls::get_ca_certs(ctx, certs);
  9587. for (auto cert : certs) {
  9588. std::vector<unsigned char> der;
  9589. if (tls::get_cert_der(cert, der)) {
  9590. auto b64 = base64_encode(std::string(der.begin(), der.end()));
  9591. pem += "-----BEGIN CERTIFICATE-----\n";
  9592. for (size_t i = 0; i < b64.size(); i += 64) {
  9593. pem += b64.substr(i, 64);
  9594. pem += '\n';
  9595. }
  9596. pem += "-----END CERTIFICATE-----\n";
  9597. }
  9598. tls::free_cert(cert);
  9599. }
  9600. return pem;
  9601. }
  9602. // Returns a PemMemory field as a NUL-terminated string: its first len bytes,
  9603. // copied to buf, or pem itself when len is 0.
  9604. inline const char *pem_c_str(const char *pem, size_t len, std::string &buf) {
  9605. if (!pem || len == 0) { return pem; }
  9606. buf.assign(pem, len);
  9607. return buf.c_str();
  9608. }
  9609. // The parts of session setup that only SSLClient needs, plus the handful
  9610. // WebSocketClient also exposes; everything else takes the defaults, which is
  9611. // what keeps the two clients on one implementation.
  9612. struct ClientTlsSessionOptions {
  9613. // Both SSLClient and WebSocketClient expose this independently of
  9614. // certificate verification.
  9615. bool server_hostname_verification = true;
  9616. std::function<SSLVerifierResponse(tls::session_t)> session_verifier;
  9617. // When non-null, guards session creation against concurrent use of the
  9618. // context. A WebSocketClient is not safe to use from several threads to
  9619. // begin with, so it passes nothing.
  9620. std::mutex *ctx_mutex = nullptr;
  9621. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9622. // The caller decides whether Schannel has anything to say about this
  9623. // connection; see SSLClient::initialize_ssl().
  9624. bool windows_cert_verification = false;
  9625. // A server certificate verifier works on the backend's chain verification,
  9626. // so the backend keeps deciding and Schannel only adds its own check.
  9627. bool server_certificate_verifier_set = false;
  9628. #endif
  9629. };
  9630. // Filled in on failure for callers that report error details.
  9631. struct ClientTlsSessionError {
  9632. Error error = Error::Success;
  9633. int ssl_error = 0;
  9634. uint64_t backend_error = 0;
  9635. };
  9636. // Establishes a client TLS session on an already connected socket. On failure
  9637. // the session is left for the caller to free: SSLClient frees it right away,
  9638. // WebSocketClient keeps it in a member that shutdown_and_close() cleans up.
  9639. inline bool setup_client_tls_session(
  9640. const std::string &host, tls::ctx_t ctx, tls::session_t &session,
  9641. socket_t sock, bool server_certificate_verification, time_t timeout_sec,
  9642. time_t timeout_usec, ClientTlsSessionError *out_error = nullptr,
  9643. const ClientTlsSessionOptions &options = ClientTlsSessionOptions()) {
  9644. using namespace tls;
  9645. auto fail = [&](Error error, int ssl_error, uint64_t backend_error) {
  9646. if (out_error) {
  9647. out_error->error = error;
  9648. out_error->ssl_error = ssl_error;
  9649. out_error->backend_error = backend_error;
  9650. }
  9651. return false;
  9652. };
  9653. // A TLS failure, whose verification codes name the Error too
  9654. auto fail_tls = [&](ErrorCode code, uint64_t backend_error) {
  9655. auto error = Error::SSLConnection;
  9656. if (code == ErrorCode::CertVerifyFailed) {
  9657. error = Error::SSLServerVerification;
  9658. } else if (code == ErrorCode::HostnameMismatch) {
  9659. error = Error::SSLServerHostnameVerification;
  9660. }
  9661. return fail(error, static_cast<int>(code), backend_error);
  9662. };
  9663. if (!ctx) {
  9664. session = nullptr;
  9665. return fail(Error::SSLConnection, 0, 0);
  9666. }
  9667. // With Windows verification on and no server certificate verifier set,
  9668. // Schannel is the only chain verifier. The backend's trust store is a
  9669. // snapshot of the Windows stores that lacks the roots Windows fetches on
  9670. // demand, so the backend's verdict is not used.
  9671. auto windows_verifies_chain = false;
  9672. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9673. windows_verifies_chain = options.windows_cert_verification &&
  9674. !options.server_certificate_verifier_set;
  9675. #endif
  9676. // The chain, and a host name, are verified during the handshake, so that a
  9677. // server failing them never gets to see a client certificate. Unless
  9678. // Schannel verifies the chain instead, this holds for IP hosts too, whose
  9679. // identity is checked after the handshake by verify_hostname().
  9680. auto verify_in_handshake =
  9681. server_certificate_verification && !windows_verifies_chain;
  9682. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  9683. // A session verifier may accept a certificate the built-in check rejects,
  9684. // and runs only after the handshake
  9685. verify_in_handshake = verify_in_handshake && !options.session_verifier;
  9686. #endif
  9687. {
  9688. std::unique_lock<std::mutex> guard;
  9689. if (options.ctx_mutex) {
  9690. guard = std::unique_lock<std::mutex>(*options.ctx_mutex);
  9691. }
  9692. // The mode is set on the context, so under the same lock
  9693. set_verify_client(ctx, verify_in_handshake);
  9694. session = create_session(ctx, sock);
  9695. }
  9696. if (!session) { return fail(Error::SSLConnection, 0, get_error()); }
  9697. // RFC 6066: SNI must not be set for IP addresses; skip it for IP hosts, so
  9698. // their identity is checked post-handshake below instead.
  9699. if (!is_ip_address(host)) {
  9700. if (!set_sni(session, host.c_str(),
  9701. verify_in_handshake && options.server_hostname_verification)) {
  9702. return fail(Error::SSLConnection, 0, get_error());
  9703. }
  9704. }
  9705. TlsError tls_err;
  9706. if (!connect_nonblocking(session, sock, timeout_sec, timeout_usec,
  9707. &tls_err)) {
  9708. return fail_tls(tls_err.code, tls_err.backend_code);
  9709. }
  9710. auto verification_status = SSLVerifierResponse::NoDecisionMade;
  9711. if (options.session_verifier) {
  9712. verification_status = options.session_verifier(session);
  9713. }
  9714. if (verification_status == SSLVerifierResponse::CertificateRejected) {
  9715. return fail(Error::SSLServerVerification, 0, get_error());
  9716. }
  9717. if (verification_status == SSLVerifierResponse::NoDecisionMade &&
  9718. server_certificate_verification) {
  9719. if (!windows_verifies_chain) {
  9720. auto verify_result = get_verify_result(session);
  9721. if (verify_result != 0) {
  9722. return fail_tls(ErrorCode::CertVerifyFailed,
  9723. static_cast<uint64_t>(verify_result));
  9724. }
  9725. }
  9726. auto server_cert = get_peer_cert(session);
  9727. if (!server_cert) {
  9728. return fail_tls(ErrorCode::CertVerifyFailed, get_error());
  9729. }
  9730. auto cert_guard = detail::scope_exit([&] { free_cert(server_cert); });
  9731. // Identity check against the peer certificate, post-handshake for all
  9732. // backends. For IP hosts this is the only identity verification, since no
  9733. // hostname is bound during the handshake.
  9734. if (options.server_hostname_verification) {
  9735. if (!verify_hostname(server_cert, host.c_str())) {
  9736. return fail_tls(ErrorCode::HostnameMismatch, hostname_mismatch_code());
  9737. }
  9738. }
  9739. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9740. // Windows Schannel verification, which lets Windows fetch missing roots
  9741. // and intermediates on demand. It must not be skipped: unless a server
  9742. // certificate verifier is set, it is the only chain check.
  9743. if (options.windows_cert_verification) {
  9744. std::vector<unsigned char> der;
  9745. uint64_t wincrypt_error = 0;
  9746. if (!get_cert_der(server_cert, der) ||
  9747. !verify_cert_with_windows_schannel(
  9748. der, host, options.server_hostname_verification, wincrypt_error,
  9749. session)) {
  9750. return fail_tls(ErrorCode::CertVerifyFailed, wincrypt_error);
  9751. }
  9752. }
  9753. #endif
  9754. }
  9755. return true;
  9756. }
  9757. } // namespace detail
  9758. #endif // CPPHTTPLIB_SSL_ENABLED
  9759. /*
  9760. * Group 3: httplib namespace - Non-SSL public API implementations
  9761. */
  9762. inline void default_socket_options(socket_t sock) {
  9763. set_socket_opt(sock, SOL_SOCKET,
  9764. #ifdef SO_REUSEPORT
  9765. SO_REUSEPORT,
  9766. #else
  9767. SO_REUSEADDR,
  9768. #endif
  9769. 1);
  9770. }
  9771. inline bool set_socket_opt(socket_t sock, int level, int optname, int optval) {
  9772. return detail::set_socket_opt_impl(sock, level, optname, &optval,
  9773. sizeof(optval));
  9774. }
  9775. inline std::string get_bearer_token_auth(const Request &req) {
  9776. // The auth scheme is case-insensitive (RFC 9110 11.1), and a value shorter
  9777. // than the prefix carries no token.
  9778. constexpr const char bearer_prefix[] = "Bearer ";
  9779. constexpr auto bearer_prefix_len = detail::str_len(bearer_prefix);
  9780. auto value = req.get_header_value("Authorization");
  9781. if (value.size() >= bearer_prefix_len &&
  9782. detail::case_ignore::equal(value.substr(0, bearer_prefix_len),
  9783. bearer_prefix)) {
  9784. return value.substr(bearer_prefix_len);
  9785. }
  9786. return "";
  9787. }
  9788. inline const char *status_message(int status) {
  9789. switch (status) {
  9790. case StatusCode::Continue_100: return "Continue";
  9791. case StatusCode::SwitchingProtocol_101: return "Switching Protocol";
  9792. case StatusCode::Processing_102: return "Processing";
  9793. case StatusCode::EarlyHints_103: return "Early Hints";
  9794. case StatusCode::OK_200: return "OK";
  9795. case StatusCode::Created_201: return "Created";
  9796. case StatusCode::Accepted_202: return "Accepted";
  9797. case StatusCode::NonAuthoritativeInformation_203:
  9798. return "Non-Authoritative Information";
  9799. case StatusCode::NoContent_204: return "No Content";
  9800. case StatusCode::ResetContent_205: return "Reset Content";
  9801. case StatusCode::PartialContent_206: return "Partial Content";
  9802. case StatusCode::MultiStatus_207: return "Multi-Status";
  9803. case StatusCode::AlreadyReported_208: return "Already Reported";
  9804. case StatusCode::IMUsed_226: return "IM Used";
  9805. case StatusCode::MultipleChoices_300: return "Multiple Choices";
  9806. case StatusCode::MovedPermanently_301: return "Moved Permanently";
  9807. case StatusCode::Found_302: return "Found";
  9808. case StatusCode::SeeOther_303: return "See Other";
  9809. case StatusCode::NotModified_304: return "Not Modified";
  9810. case StatusCode::UseProxy_305: return "Use Proxy";
  9811. case StatusCode::unused_306: return "unused";
  9812. case StatusCode::TemporaryRedirect_307: return "Temporary Redirect";
  9813. case StatusCode::PermanentRedirect_308: return "Permanent Redirect";
  9814. case StatusCode::BadRequest_400: return "Bad Request";
  9815. case StatusCode::Unauthorized_401: return "Unauthorized";
  9816. case StatusCode::PaymentRequired_402: return "Payment Required";
  9817. case StatusCode::Forbidden_403: return "Forbidden";
  9818. case StatusCode::NotFound_404: return "Not Found";
  9819. case StatusCode::MethodNotAllowed_405: return "Method Not Allowed";
  9820. case StatusCode::NotAcceptable_406: return "Not Acceptable";
  9821. case StatusCode::ProxyAuthenticationRequired_407:
  9822. return "Proxy Authentication Required";
  9823. case StatusCode::RequestTimeout_408: return "Request Timeout";
  9824. case StatusCode::Conflict_409: return "Conflict";
  9825. case StatusCode::Gone_410: return "Gone";
  9826. case StatusCode::LengthRequired_411: return "Length Required";
  9827. case StatusCode::PreconditionFailed_412: return "Precondition Failed";
  9828. case StatusCode::PayloadTooLarge_413: return "Payload Too Large";
  9829. case StatusCode::UriTooLong_414: return "URI Too Long";
  9830. case StatusCode::UnsupportedMediaType_415: return "Unsupported Media Type";
  9831. case StatusCode::RangeNotSatisfiable_416: return "Range Not Satisfiable";
  9832. case StatusCode::ExpectationFailed_417: return "Expectation Failed";
  9833. case StatusCode::ImATeapot_418: return "I'm a teapot";
  9834. case StatusCode::MisdirectedRequest_421: return "Misdirected Request";
  9835. case StatusCode::UnprocessableContent_422: return "Unprocessable Content";
  9836. case StatusCode::Locked_423: return "Locked";
  9837. case StatusCode::FailedDependency_424: return "Failed Dependency";
  9838. case StatusCode::TooEarly_425: return "Too Early";
  9839. case StatusCode::UpgradeRequired_426: return "Upgrade Required";
  9840. case StatusCode::PreconditionRequired_428: return "Precondition Required";
  9841. case StatusCode::TooManyRequests_429: return "Too Many Requests";
  9842. case StatusCode::RequestHeaderFieldsTooLarge_431:
  9843. return "Request Header Fields Too Large";
  9844. case StatusCode::UnavailableForLegalReasons_451:
  9845. return "Unavailable For Legal Reasons";
  9846. case StatusCode::NotImplemented_501: return "Not Implemented";
  9847. case StatusCode::BadGateway_502: return "Bad Gateway";
  9848. case StatusCode::ServiceUnavailable_503: return "Service Unavailable";
  9849. case StatusCode::GatewayTimeout_504: return "Gateway Timeout";
  9850. case StatusCode::HttpVersionNotSupported_505:
  9851. return "HTTP Version Not Supported";
  9852. case StatusCode::VariantAlsoNegotiates_506: return "Variant Also Negotiates";
  9853. case StatusCode::InsufficientStorage_507: return "Insufficient Storage";
  9854. case StatusCode::LoopDetected_508: return "Loop Detected";
  9855. case StatusCode::NotExtended_510: return "Not Extended";
  9856. case StatusCode::NetworkAuthenticationRequired_511:
  9857. return "Network Authentication Required";
  9858. default:
  9859. case StatusCode::InternalServerError_500: return "Internal Server Error";
  9860. }
  9861. }
  9862. inline std::string to_string(const Error error) {
  9863. switch (error) {
  9864. case Error::Success: return "Success (no error)";
  9865. case Error::Unknown: return "Unknown";
  9866. case Error::Connection: return "Could not establish connection";
  9867. case Error::BindIPAddress: return "Failed to bind IP address";
  9868. case Error::Read: return "Failed to read connection";
  9869. case Error::Write: return "Failed to write connection";
  9870. case Error::ExceedRedirectCount: return "Maximum redirect count exceeded";
  9871. case Error::Canceled: return "Connection handling canceled";
  9872. case Error::SSLConnection: return "SSL connection failed";
  9873. case Error::SSLLoadingCerts: return "SSL certificate loading failed";
  9874. case Error::SSLServerVerification: return "SSL server verification failed";
  9875. case Error::SSLServerHostnameVerification:
  9876. return "SSL server hostname verification failed";
  9877. case Error::UnsupportedMultipartBoundaryChars:
  9878. return "Unsupported HTTP multipart boundary characters";
  9879. case Error::Compression: return "Compression failed";
  9880. case Error::ConnectionTimeout: return "Connection timed out";
  9881. case Error::ProxyConnection: return "Proxy connection failed";
  9882. case Error::ConnectionClosed: return "Connection closed by server";
  9883. case Error::Timeout: return "Read timeout";
  9884. case Error::ResourceExhaustion: return "Resource exhaustion";
  9885. case Error::TooManyFormDataFiles: return "Too many form data files";
  9886. case Error::ExceedMaxPayloadSize: return "Exceeded maximum payload size";
  9887. case Error::ExceedUriMaxLength: return "Exceeded maximum URI length";
  9888. case Error::ExceedMaxSocketDescriptorCount:
  9889. return "Exceeded maximum socket descriptor count";
  9890. case Error::InvalidRequestLine: return "Invalid request line";
  9891. case Error::InvalidHTTPMethod: return "Invalid HTTP method";
  9892. case Error::InvalidHTTPVersion: return "Invalid HTTP version";
  9893. case Error::InvalidHeaders: return "Invalid headers";
  9894. case Error::MultipartParsing: return "Multipart parsing failed";
  9895. case Error::OpenFile: return "Failed to open file";
  9896. case Error::Listen: return "Failed to listen on socket";
  9897. case Error::GetSockName: return "Failed to get socket name";
  9898. case Error::UnsupportedAddressFamily: return "Unsupported address family";
  9899. case Error::HTTPParsing: return "HTTP parsing failed";
  9900. case Error::InvalidRangeHeader: return "Invalid Range header";
  9901. case Error::UnsupportedContentEncoding: return "Unsupported Content-Encoding";
  9902. case Error::WebSocketHandshake: return "WebSocket handshake failed";
  9903. case Error::UserCallbackException: return "User callback threw an exception";
  9904. default: break;
  9905. }
  9906. return "Invalid";
  9907. }
  9908. inline std::ostream &operator<<(std::ostream &os, const Error &obj) {
  9909. os << to_string(obj);
  9910. os << " (" << static_cast<std::underlying_type<Error>::type>(obj) << ')';
  9911. return os;
  9912. }
  9913. inline std::string hosted_at(const std::string &hostname) {
  9914. std::vector<std::string> addrs;
  9915. hosted_at(hostname, addrs);
  9916. if (addrs.empty()) { return std::string(); }
  9917. return addrs[0];
  9918. }
  9919. inline void hosted_at(const std::string &hostname,
  9920. std::vector<std::string> &addrs) {
  9921. struct addrinfo hints;
  9922. struct addrinfo *result;
  9923. memset(&hints, 0, sizeof(struct addrinfo));
  9924. hints.ai_family = AF_UNSPEC;
  9925. hints.ai_socktype = SOCK_STREAM;
  9926. hints.ai_protocol = 0;
  9927. if (detail::getaddrinfo_with_timeout(hostname.c_str(), nullptr, &hints,
  9928. &result, 0)) {
  9929. #if defined __linux__ && !defined __ANDROID__
  9930. res_init();
  9931. #endif
  9932. return;
  9933. }
  9934. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  9935. for (auto rp = result; rp; rp = rp->ai_next) {
  9936. const auto &addr =
  9937. *reinterpret_cast<struct sockaddr_storage *>(rp->ai_addr);
  9938. std::string ip;
  9939. auto dummy = -1;
  9940. if (detail::get_ip_and_port(addr, sizeof(struct sockaddr_storage), ip,
  9941. dummy)) {
  9942. addrs.emplace_back(std::move(ip));
  9943. }
  9944. }
  9945. }
  9946. inline std::string encode_uri_component(const std::string &value) {
  9947. std::ostringstream escaped;
  9948. escaped.fill('0');
  9949. escaped << std::hex;
  9950. for (auto c : value) {
  9951. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9952. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')') {
  9953. escaped << c;
  9954. } else {
  9955. escaped << std::uppercase;
  9956. escaped << '%' << std::setw(2)
  9957. << static_cast<int>(static_cast<unsigned char>(c));
  9958. escaped << std::nouppercase;
  9959. }
  9960. }
  9961. return escaped.str();
  9962. }
  9963. inline std::string encode_uri(const std::string &value) {
  9964. std::ostringstream escaped;
  9965. escaped.fill('0');
  9966. escaped << std::hex;
  9967. for (auto c : value) {
  9968. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9969. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')' ||
  9970. c == ';' || c == '/' || c == '?' || c == ':' || c == '@' || c == '&' ||
  9971. c == '=' || c == '+' || c == '$' || c == ',' || c == '#') {
  9972. escaped << c;
  9973. } else {
  9974. escaped << std::uppercase;
  9975. escaped << '%' << std::setw(2)
  9976. << static_cast<int>(static_cast<unsigned char>(c));
  9977. escaped << std::nouppercase;
  9978. }
  9979. }
  9980. return escaped.str();
  9981. }
  9982. inline std::string decode_uri_component(const std::string &value) {
  9983. std::string result;
  9984. for (size_t i = 0; i < value.size(); i++) {
  9985. if (value[i] == '%' && i + 2 < value.size()) {
  9986. auto val = 0;
  9987. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9988. result += static_cast<char>(val);
  9989. i += 2;
  9990. } else {
  9991. result += value[i];
  9992. }
  9993. } else {
  9994. result += value[i];
  9995. }
  9996. }
  9997. return result;
  9998. }
  9999. inline std::string decode_uri(const std::string &value) {
  10000. std::string result;
  10001. for (size_t i = 0; i < value.size(); i++) {
  10002. if (value[i] == '%' && i + 2 < value.size()) {
  10003. auto val = 0;
  10004. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  10005. auto c = static_cast<char>(val);
  10006. // Keep escapes of the reserved characters that encode_uri leaves
  10007. // literal, so decode_uri is the inverse of encode_uri and an escaped
  10008. // delimiter is not promoted into a real one (as with JS decodeURI).
  10009. if (c == ';' || c == '/' || c == '?' || c == ':' || c == '@' ||
  10010. c == '&' || c == '=' || c == '+' || c == '$' || c == ',' ||
  10011. c == '#') {
  10012. result += value[i];
  10013. result += value[i + 1];
  10014. result += value[i + 2];
  10015. } else {
  10016. result += c;
  10017. }
  10018. i += 2;
  10019. } else {
  10020. result += value[i];
  10021. }
  10022. } else {
  10023. result += value[i];
  10024. }
  10025. }
  10026. return result;
  10027. }
  10028. inline std::string encode_path_component(const std::string &component) {
  10029. std::string result;
  10030. result.reserve(component.size() * 3);
  10031. for (size_t i = 0; i < component.size(); i++) {
  10032. auto c = static_cast<unsigned char>(component[i]);
  10033. // Unreserved characters per RFC 3986: ALPHA / DIGIT / "-" / "." / "_" / "~"
  10034. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  10035. c == '_' || c == '~') {
  10036. result += static_cast<char>(c);
  10037. }
  10038. // Path-safe sub-delimiters: "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" /
  10039. // "," / ";" / "="
  10040. else if (c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  10041. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  10042. c == '=') {
  10043. result += static_cast<char>(c);
  10044. }
  10045. // Colon is allowed in path segments except first segment
  10046. else if (c == ':') {
  10047. result += static_cast<char>(c);
  10048. }
  10049. // @ is allowed in path
  10050. else if (c == '@') {
  10051. result += static_cast<char>(c);
  10052. } else {
  10053. result += '%';
  10054. char hex[3];
  10055. snprintf(hex, sizeof(hex), "%02X", c);
  10056. result.append(hex, 2);
  10057. }
  10058. }
  10059. return result;
  10060. }
  10061. inline std::string decode_path_component(const std::string &component) {
  10062. std::string result;
  10063. result.reserve(component.size());
  10064. for (size_t i = 0; i < component.size(); i++) {
  10065. if (component[i] == '%' && i + 1 < component.size()) {
  10066. if (component[i + 1] == 'u') {
  10067. // Unicode %uXXXX encoding
  10068. auto val = 0;
  10069. // 4 digits Unicode codes: val is 0x0000-0xFFFF (from 4 hex digits),
  10070. // so to_utf8 writes at most 3 bytes. buff[4] is safe.
  10071. char buff[4];
  10072. size_t len = 0;
  10073. if (detail::from_hex_to_i(component, i + 2, 4, val) &&
  10074. (len = detail::to_utf8(val, buff)) > 0) {
  10075. result.append(buff, len);
  10076. i += 5; // 'u0000'
  10077. } else {
  10078. // Not 4 hex digits, or a surrogate, which is no character: the
  10079. // escape is kept as it is rather than joining its neighbours
  10080. result += component[i];
  10081. }
  10082. } else {
  10083. // Standard %XX encoding
  10084. auto val = 0;
  10085. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  10086. // 2 digits hex codes
  10087. result += static_cast<char>(val);
  10088. i += 2; // 'XX'
  10089. } else {
  10090. result += component[i];
  10091. }
  10092. }
  10093. } else {
  10094. result += component[i];
  10095. }
  10096. }
  10097. return result;
  10098. }
  10099. inline std::string encode_query_component(const std::string &component,
  10100. bool space_as_plus) {
  10101. std::string result;
  10102. result.reserve(component.size() * 3);
  10103. for (size_t i = 0; i < component.size(); i++) {
  10104. auto c = static_cast<unsigned char>(component[i]);
  10105. // Unreserved characters per RFC 3986
  10106. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  10107. c == '_' || c == '~') {
  10108. result += static_cast<char>(c);
  10109. }
  10110. // Space handling
  10111. else if (c == ' ') {
  10112. if (space_as_plus) {
  10113. result += '+';
  10114. } else {
  10115. result += "%20";
  10116. }
  10117. }
  10118. // Plus sign handling
  10119. else if (c == '+') {
  10120. if (space_as_plus) {
  10121. result += "%2B";
  10122. } else {
  10123. result += static_cast<char>(c);
  10124. }
  10125. }
  10126. // Query-safe sub-delimiters (excluding & and = which are query delimiters)
  10127. else if (c == '!' || c == '$' || c == '\'' || c == '(' || c == ')' ||
  10128. c == '*' || c == ',' || c == ';') {
  10129. result += static_cast<char>(c);
  10130. }
  10131. // Colon and @ are allowed in query
  10132. else if (c == ':' || c == '@') {
  10133. result += static_cast<char>(c);
  10134. }
  10135. // Forward slash is allowed in query values
  10136. else if (c == '/') {
  10137. result += static_cast<char>(c);
  10138. }
  10139. // Question mark is allowed in query values (after first ?)
  10140. else if (c == '?') {
  10141. result += static_cast<char>(c);
  10142. } else {
  10143. result += '%';
  10144. char hex[3];
  10145. snprintf(hex, sizeof(hex), "%02X", c);
  10146. result.append(hex, 2);
  10147. }
  10148. }
  10149. return result;
  10150. }
  10151. inline std::string decode_query_component(const std::string &component,
  10152. bool plus_as_space) {
  10153. std::string result;
  10154. result.reserve(component.size());
  10155. for (size_t i = 0; i < component.size(); i++) {
  10156. if (component[i] == '%' && i + 2 < component.size()) {
  10157. auto val = 0;
  10158. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  10159. result += static_cast<char>(val);
  10160. i += 2;
  10161. } else {
  10162. result += component[i];
  10163. }
  10164. } else if (component[i] == '+' && plus_as_space) {
  10165. result += ' '; // + becomes space in form-urlencoded
  10166. } else {
  10167. result += component[i];
  10168. }
  10169. }
  10170. return result;
  10171. }
  10172. inline std::string sanitize_filename(const std::string &filename) {
  10173. // Extract basename: find the last path separator (/ or \) and, on Windows,
  10174. // ':', which ends a drive prefix ("C:..") or names an NTFS stream ("a:b")
  10175. #ifdef _WIN32
  10176. auto pos = filename.find_last_of("/\\:");
  10177. #else
  10178. auto pos = filename.find_last_of("/\\");
  10179. #endif
  10180. auto result =
  10181. (pos != std::string::npos) ? filename.substr(pos + 1) : filename;
  10182. // Strip null bytes
  10183. result.erase(std::remove(result.begin(), result.end(), '\0'), result.end());
  10184. // Trim whitespace
  10185. {
  10186. auto start = result.find_first_not_of(" \t");
  10187. auto end = result.find_last_not_of(" \t");
  10188. result = (start == std::string::npos)
  10189. ? ""
  10190. : result.substr(start, end - start + 1);
  10191. }
  10192. // Reject . and ..
  10193. if (result == "." || result == "..") { return ""; }
  10194. return result;
  10195. }
  10196. inline std::string append_query_params(const std::string &path,
  10197. const Params &params) {
  10198. // The query ends at the fragment (RFC 3986 3.5), so the params go before it.
  10199. auto fragment_pos = path.find('#');
  10200. auto path_with_query = path.substr(0, fragment_pos);
  10201. path_with_query += path_with_query.find('?') == std::string::npos ? '?' : '&';
  10202. path_with_query += detail::params_to_query_str(params);
  10203. if (fragment_pos != std::string::npos) {
  10204. path_with_query.append(path, fragment_pos, std::string::npos);
  10205. }
  10206. return path_with_query;
  10207. }
  10208. // Header utilities
  10209. inline std::pair<std::string, std::string>
  10210. make_range_header(const Ranges &ranges) {
  10211. std::string field = "bytes=";
  10212. auto i = 0;
  10213. for (const auto &r : ranges) {
  10214. if (i != 0) { field += ", "; }
  10215. if (r.first != -1) { field += std::to_string(r.first); }
  10216. field += '-';
  10217. if (r.second != -1) { field += std::to_string(r.second); }
  10218. i++;
  10219. }
  10220. return std::make_pair("Range", std::move(field));
  10221. }
  10222. inline std::pair<std::string, std::string>
  10223. make_basic_authentication_header(const std::string &username,
  10224. const std::string &password, bool is_proxy) {
  10225. auto field = "Basic " + detail::base64_encode(username + ":" + password);
  10226. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  10227. return std::make_pair(key, std::move(field));
  10228. }
  10229. inline std::pair<std::string, std::string>
  10230. make_bearer_token_authentication_header(const std::string &token,
  10231. bool is_proxy = false) {
  10232. auto field = "Bearer " + token;
  10233. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  10234. return std::make_pair(key, std::move(field));
  10235. }
  10236. namespace detail {
  10237. // Basic auth when a username or password is set, otherwise a bearer token,
  10238. // unless the request already carries the header.
  10239. inline void add_authorization_header(Request &req, const std::string &username,
  10240. const std::string &password,
  10241. const std::string &token, bool is_proxy) {
  10242. if (req.has_header(is_proxy ? "Proxy-Authorization" : "Authorization")) {
  10243. return;
  10244. }
  10245. if (!username.empty() || !password.empty()) {
  10246. req.headers.insert(
  10247. make_basic_authentication_header(username, password, is_proxy));
  10248. } else if (!token.empty()) {
  10249. req.headers.insert(
  10250. make_bearer_token_authentication_header(token, is_proxy));
  10251. }
  10252. }
  10253. } // namespace detail
  10254. // Request implementation
  10255. inline size_t Request::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 Request::has_header(const std::string &key) const {
  10260. return detail::has_header(headers, key);
  10261. }
  10262. inline std::string Request::get_header_value(const std::string &key,
  10263. const char *def, size_t id) const {
  10264. return detail::get_header_value(headers, key, def, id);
  10265. }
  10266. inline size_t Request::get_header_value_count(const std::string &key) const {
  10267. return detail::get_header_value_count(headers, key);
  10268. }
  10269. inline void Request::set_header(const std::string &key,
  10270. const std::string &val) {
  10271. detail::set_header(headers, key, val);
  10272. }
  10273. inline bool Request::has_trailer(const std::string &key) const {
  10274. return trailers.find(key) != trailers.end();
  10275. }
  10276. inline std::string Request::get_trailer_value(const std::string &key,
  10277. size_t id) const {
  10278. return detail::get_multimap_value(trailers, key, id);
  10279. }
  10280. inline size_t Request::get_trailer_value_count(const std::string &key) const {
  10281. return trailers.count(key);
  10282. }
  10283. inline bool Request::has_param(const std::string &key) const {
  10284. return params.find(key) != params.end();
  10285. }
  10286. inline std::string Request::get_param_value(const std::string &key,
  10287. size_t id) const {
  10288. return detail::get_multimap_value(params, key, id);
  10289. }
  10290. inline std::vector<std::string>
  10291. Request::get_param_values(const std::string &key) const {
  10292. auto rng = params.equal_range(key);
  10293. std::vector<std::string> values;
  10294. values.reserve(static_cast<size_t>(std::distance(rng.first, rng.second)));
  10295. for (auto it = rng.first; it != rng.second; ++it) {
  10296. values.push_back(it->second);
  10297. }
  10298. return values;
  10299. }
  10300. inline size_t Request::get_param_value_count(const std::string &key) const {
  10301. return params.count(key);
  10302. }
  10303. inline bool Request::is_multipart_form_data() const {
  10304. const auto &content_type = get_header_value("Content-Type");
  10305. return detail::case_ignore::equal(detail::extract_media_type(content_type),
  10306. "multipart/form-data");
  10307. }
  10308. // Multipart FormData implementation
  10309. inline std::string MultipartFormData::get_field(const std::string &key,
  10310. size_t id) const {
  10311. auto rng = fields.equal_range(key);
  10312. auto it = detail::bounded_next(rng.first, id, rng.second);
  10313. if (it != rng.second) { return it->second.content; }
  10314. return std::string();
  10315. }
  10316. inline std::vector<std::string>
  10317. MultipartFormData::get_fields(const std::string &key) const {
  10318. std::vector<std::string> values;
  10319. auto rng = fields.equal_range(key);
  10320. for (auto it = rng.first; it != rng.second; it++) {
  10321. values.push_back(it->second.content);
  10322. }
  10323. return values;
  10324. }
  10325. inline bool MultipartFormData::has_field(const std::string &key) const {
  10326. return fields.find(key) != fields.end();
  10327. }
  10328. inline size_t MultipartFormData::get_field_count(const std::string &key) const {
  10329. return fields.count(key);
  10330. }
  10331. inline FormData MultipartFormData::get_file(const std::string &key,
  10332. size_t id) const {
  10333. return detail::get_multimap_value(files, key, id);
  10334. }
  10335. inline std::vector<FormData>
  10336. MultipartFormData::get_files(const std::string &key) const {
  10337. std::vector<FormData> values;
  10338. auto rng = files.equal_range(key);
  10339. for (auto it = rng.first; it != rng.second; it++) {
  10340. values.push_back(it->second);
  10341. }
  10342. return values;
  10343. }
  10344. inline bool MultipartFormData::has_file(const std::string &key) const {
  10345. return files.find(key) != files.end();
  10346. }
  10347. inline size_t MultipartFormData::get_file_count(const std::string &key) const {
  10348. return files.count(key);
  10349. }
  10350. // Multipart FormData writer implementation
  10351. inline bool is_valid_multipart_boundary(const std::string &boundary) {
  10352. return detail::is_multipart_boundary_chars_valid(boundary);
  10353. }
  10354. inline MultipartFormDataWriter::MultipartFormDataWriter()
  10355. : boundary_(detail::make_multipart_data_boundary()) {}
  10356. inline MultipartFormDataWriter::MultipartFormDataWriter(std::string boundary)
  10357. : boundary_(std::move(boundary)) {}
  10358. inline const std::string &MultipartFormDataWriter::boundary() const {
  10359. return boundary_;
  10360. }
  10361. inline std::string MultipartFormDataWriter::content_type() const {
  10362. return detail::serialize_multipart_formdata_get_content_type(boundary_);
  10363. }
  10364. inline std::string
  10365. MultipartFormDataWriter::serialize(const UploadFormDataItems &items) const {
  10366. return detail::serialize_multipart_formdata(items, boundary_);
  10367. }
  10368. inline size_t MultipartFormDataWriter::content_length(
  10369. const UploadFormDataItems &items) const {
  10370. return detail::get_multipart_content_length(items, boundary_);
  10371. }
  10372. inline std::string
  10373. MultipartFormDataWriter::item_begin(const UploadFormData &item) const {
  10374. return detail::serialize_multipart_formdata_item_begin(item, boundary_);
  10375. }
  10376. inline std::string MultipartFormDataWriter::item_end() {
  10377. return detail::serialize_multipart_formdata_item_end();
  10378. }
  10379. inline std::string MultipartFormDataWriter::finish() const {
  10380. return detail::serialize_multipart_formdata_finish(boundary_);
  10381. }
  10382. // Response implementation
  10383. namespace detail {
  10384. // A response has one content source: `body`, a content provider, or a file.
  10385. // Each content setter calls this so that the one called last wins.
  10386. inline void clear_content_provider(Response &res) {
  10387. auto releaser = std::move(res.content_provider_resource_releaser_);
  10388. auto success = res.content_provider_success_;
  10389. res.content_length_ = 0;
  10390. res.content_provider_ = nullptr;
  10391. res.content_provider_resource_releaser_ = nullptr;
  10392. res.is_chunked_content_provider_ = false;
  10393. res.is_file_content_provider_ = false;
  10394. res.content_provider_success_ = false;
  10395. res.content_coding_ = EncodingType::None;
  10396. res.file_content_path_.clear();
  10397. res.file_content_content_type_.clear();
  10398. if (releaser) { releaser(success); }
  10399. }
  10400. inline void clear_content(Response &res) {
  10401. res.body.clear();
  10402. clear_content_provider(res);
  10403. }
  10404. // The Content-Type of the old content goes with it.
  10405. inline void set_content_type(Response &res, const std::string &content_type) {
  10406. res.headers.erase("Content-Type");
  10407. res.set_header("Content-Type", content_type);
  10408. }
  10409. // `body` is public, so it can be assigned directly after a provider or a file
  10410. // was set. It came last, so it wins.
  10411. inline void prefer_assigned_body(Response &res) {
  10412. if (!res.body.empty() &&
  10413. (res.content_provider_ || !res.file_content_path_.empty())) {
  10414. clear_content_provider(res);
  10415. }
  10416. }
  10417. // RFC 9112 6.3: a 1xx, 204 or 304 response ends with its header section.
  10418. inline bool body_allowed_for_status(int status) {
  10419. return status >= 200 && status != StatusCode::NoContent_204 &&
  10420. status != StatusCode::NotModified_304;
  10421. }
  10422. // Only a 206 response is served as a partial representation. range_error()
  10423. // validates `req.ranges` only for a 2xx status, so slicing under any other
  10424. // status would start from an unchecked offset.
  10425. inline bool is_partial_content(const Request &req, const Response &res) {
  10426. return !req.ranges.empty() && res.status == StatusCode::PartialContent_206;
  10427. }
  10428. // Sets the Content-Length or Transfer-Encoding framing the body that
  10429. // Server::write_response_core() writes, or closes the connection after a body
  10430. // that has neither. Only the library sets them: one from a handler would go
  10431. // out next to it, or describe some other body.
  10432. inline void set_framing_headers(const Request &req, Response &res,
  10433. const std::string &boundary,
  10434. const std::string &content_type) {
  10435. // A HEAD response may give the length a GET would have had (RFC 9110 9.3.2).
  10436. auto head_length = req.method == "HEAD"
  10437. ? res.get_header_value("Content-Length")
  10438. : std::string();
  10439. res.headers.erase("Content-Length");
  10440. res.headers.erase("Transfer-Encoding");
  10441. if (!body_allowed_for_status(res.status)) { return; }
  10442. if (res.content_provider_) {
  10443. if (res.content_length_ == 0) {
  10444. if (res.is_chunked_content_provider_) {
  10445. res.set_header("Transfer-Encoding", "chunked");
  10446. } else if (req.method != "HEAD") {
  10447. // RFC 9112 6.3: a body with neither ends where the connection does.
  10448. res.headers.erase("Keep-Alive");
  10449. if (!has_header_token(res.headers, "Connection", "close")) {
  10450. res.set_header("Connection", "close");
  10451. }
  10452. }
  10453. return;
  10454. }
  10455. // The part Server::write_content_with_provider() writes.
  10456. auto length = res.content_length_;
  10457. if (is_partial_content(req, res)) {
  10458. length = req.ranges.size() == 1
  10459. ? get_range_offset_and_length(req.ranges[0], length).second
  10460. : get_multipart_ranges_data_length(req, boundary,
  10461. content_type, length);
  10462. }
  10463. res.set_header("Content-Length", std::to_string(length));
  10464. } else if (!res.body.empty()) {
  10465. res.set_header("Content-Length", std::to_string(res.body.size()));
  10466. } else {
  10467. res.set_header("Content-Length", head_length.empty() ? "0" : head_length);
  10468. }
  10469. }
  10470. } // namespace detail
  10471. inline size_t Response::get_header_value_u64(const std::string &key, size_t def,
  10472. size_t id) const {
  10473. return detail::get_header_value_u64(headers, key, def, id);
  10474. }
  10475. inline bool Response::has_header(const std::string &key) const {
  10476. return headers.find(key) != headers.end();
  10477. }
  10478. inline std::string Response::get_header_value(const std::string &key,
  10479. const char *def,
  10480. size_t id) const {
  10481. return detail::get_header_value(headers, key, def, id);
  10482. }
  10483. inline size_t Response::get_header_value_count(const std::string &key) const {
  10484. return detail::get_header_value_count(headers, key);
  10485. }
  10486. inline void Response::set_header(const std::string &key,
  10487. const std::string &val) {
  10488. detail::set_header(headers, key, val);
  10489. }
  10490. inline bool Response::has_trailer(const std::string &key) const {
  10491. return trailers.find(key) != trailers.end();
  10492. }
  10493. inline std::string Response::get_trailer_value(const std::string &key,
  10494. size_t id) const {
  10495. return detail::get_multimap_value(trailers, key, id);
  10496. }
  10497. inline size_t Response::get_trailer_value_count(const std::string &key) const {
  10498. return trailers.count(key);
  10499. }
  10500. inline void Response::set_redirect(const std::string &url, int stat) {
  10501. if (detail::fields::is_field_value(url)) {
  10502. set_header("Location", url);
  10503. if (300 <= stat && stat < 400) {
  10504. this->status = stat;
  10505. } else {
  10506. this->status = StatusCode::Found_302;
  10507. }
  10508. }
  10509. }
  10510. inline void Response::set_content(const char *s, size_t n,
  10511. const std::string &content_type) {
  10512. body.assign(s, n); // Before the releaser runs; it may own `s`.
  10513. detail::clear_content_provider(*this);
  10514. detail::set_content_type(*this, content_type);
  10515. }
  10516. inline void Response::set_content(const std::string &s,
  10517. const std::string &content_type) {
  10518. set_content(s.data(), s.size(), content_type);
  10519. }
  10520. inline void Response::set_content(std::string &&s,
  10521. const std::string &content_type) {
  10522. body = std::move(s);
  10523. detail::clear_content_provider(*this);
  10524. detail::set_content_type(*this, content_type);
  10525. }
  10526. inline void Response::set_content_provider(
  10527. size_t in_length, const std::string &content_type, ContentProvider provider,
  10528. ContentProviderResourceReleaser resource_releaser) {
  10529. detail::clear_content(*this);
  10530. detail::set_content_type(*this, content_type);
  10531. content_length_ = in_length;
  10532. if (in_length > 0) { content_provider_ = std::move(provider); }
  10533. content_provider_resource_releaser_ = std::move(resource_releaser);
  10534. }
  10535. inline void Response::set_content_provider(
  10536. const std::string &content_type, ContentProviderWithoutLength provider,
  10537. ContentProviderResourceReleaser resource_releaser) {
  10538. detail::clear_content(*this);
  10539. detail::set_content_type(*this, content_type);
  10540. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  10541. content_provider_resource_releaser_ = std::move(resource_releaser);
  10542. }
  10543. inline void Response::set_chunked_content_provider(
  10544. const std::string &content_type, ContentProviderWithoutLength provider,
  10545. ContentProviderResourceReleaser resource_releaser) {
  10546. set_content_provider(content_type, std::move(provider),
  10547. std::move(resource_releaser));
  10548. is_chunked_content_provider_ = true;
  10549. }
  10550. inline void Response::set_file_content(const std::string &path,
  10551. const std::string &content_type) {
  10552. detail::clear_content(*this);
  10553. headers.erase("Content-Type");
  10554. file_content_path_ = path;
  10555. file_content_content_type_ = content_type;
  10556. }
  10557. inline void Response::set_file_content(const std::string &path) {
  10558. set_file_content(path, std::string());
  10559. }
  10560. // Result implementation
  10561. inline size_t Result::get_request_header_value_u64(const std::string &key,
  10562. size_t def,
  10563. size_t id) const {
  10564. return detail::get_header_value_u64(request_headers_, key, def, id);
  10565. }
  10566. inline bool Result::has_request_header(const std::string &key) const {
  10567. return request_headers_.find(key) != request_headers_.end();
  10568. }
  10569. inline std::string Result::get_request_header_value(const std::string &key,
  10570. const char *def,
  10571. size_t id) const {
  10572. return detail::get_header_value(request_headers_, key, def, id);
  10573. }
  10574. inline size_t
  10575. Result::get_request_header_value_count(const std::string &key) const {
  10576. return request_headers_.count(key);
  10577. }
  10578. // Stream implementation
  10579. inline ssize_t Stream::write(const char *ptr) {
  10580. return write(ptr, strlen(ptr));
  10581. }
  10582. inline ssize_t Stream::write(const std::string &s) {
  10583. return write(s.data(), s.size());
  10584. }
  10585. // BodyReader implementation
  10586. inline ssize_t detail::BodyReader::read(char *buf, size_t len) {
  10587. if (!stream) {
  10588. last_error = Error::Connection;
  10589. return -1;
  10590. }
  10591. if (eof) { return 0; }
  10592. if (!chunked) {
  10593. // Content-Length based reading
  10594. if (has_content_length && bytes_read >= content_length) {
  10595. eof = true;
  10596. return 0;
  10597. }
  10598. auto to_read = len;
  10599. if (has_content_length) {
  10600. auto remaining = content_length - bytes_read;
  10601. to_read = (std::min)(len, remaining);
  10602. }
  10603. auto n = stream->read(buf, to_read);
  10604. // Without Content-Length the body ends when the connection closes
  10605. // (RFC 9112 §6.3); with one, an EOF here came too early
  10606. if (n < 0 || (n == 0 && has_content_length)) {
  10607. last_error = stream->get_error();
  10608. if (last_error == Error::Success) { last_error = Error::Read; }
  10609. }
  10610. if (n <= 0) {
  10611. eof = true;
  10612. return n;
  10613. }
  10614. bytes_read += static_cast<size_t>(n);
  10615. if (has_content_length && bytes_read >= content_length) { eof = true; }
  10616. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10617. last_error = Error::ExceedMaxPayloadSize;
  10618. eof = true;
  10619. return -1;
  10620. }
  10621. return n;
  10622. }
  10623. // Chunked transfer encoding: delegate to shared decoder instance.
  10624. if (!chunked_decoder) { chunked_decoder.reset(new ChunkedDecoder(*stream)); }
  10625. size_t chunk_offset = 0;
  10626. size_t chunk_total = 0;
  10627. auto n = chunked_decoder->read_payload(buf, len, chunk_offset, chunk_total);
  10628. if (n < 0) {
  10629. last_error = stream->get_error();
  10630. if (last_error == Error::Success) { last_error = Error::Read; }
  10631. eof = true;
  10632. return n;
  10633. }
  10634. if (n == 0) {
  10635. // Final chunk observed. Leave trailer parsing to the caller (StreamHandle).
  10636. eof = true;
  10637. return 0;
  10638. }
  10639. bytes_read += static_cast<size_t>(n);
  10640. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10641. last_error = Error::ExceedMaxPayloadSize;
  10642. eof = true;
  10643. return -1;
  10644. }
  10645. return n;
  10646. }
  10647. // ThreadPool implementation
  10648. inline ThreadPool::ThreadPool(size_t n, size_t max_n, size_t mqr,
  10649. time_t idle_timeout_sec)
  10650. : base_thread_count_(n), max_queued_requests_(mqr),
  10651. idle_timeout_sec_(idle_timeout_sec), idle_thread_count_(0),
  10652. shutdown_(false) {
  10653. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10654. if (max_n != 0 && max_n < n) {
  10655. std::string msg = "max_threads must be >= base_threads";
  10656. throw std::invalid_argument(msg);
  10657. }
  10658. #endif
  10659. max_thread_count_ = max_n == 0 ? n : max_n;
  10660. threads_.reserve(base_thread_count_);
  10661. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10662. try {
  10663. #endif
  10664. for (size_t i = 0; i < base_thread_count_; i++) {
  10665. threads_.emplace_back(std::thread([this]() { worker(false); }));
  10666. }
  10667. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10668. } catch (...) {
  10669. // If thread creation fails partway (e.g., pthread_create returns EAGAIN),
  10670. // signal the workers we already spawned to exit and join them so the
  10671. // vector destructor does not see joinable threads (which would call
  10672. // std::terminate). Then rethrow so the caller learns of the failure.
  10673. {
  10674. std::unique_lock<std::mutex> lock(mutex_);
  10675. shutdown_ = true;
  10676. }
  10677. cond_.notify_all();
  10678. for (auto &t : threads_) {
  10679. if (t.joinable()) { t.join(); }
  10680. }
  10681. throw;
  10682. }
  10683. #endif
  10684. }
  10685. inline bool ThreadPool::enqueue(std::function<void()> fn) {
  10686. {
  10687. std::unique_lock<std::mutex> lock(mutex_);
  10688. if (shutdown_) { return false; }
  10689. if (max_queued_requests_ > 0 && jobs_.size() >= max_queued_requests_) {
  10690. return false;
  10691. }
  10692. jobs_.push_back(std::move(fn));
  10693. // Spawn a dynamic thread if jobs outnumber idle threads and under max
  10694. if (jobs_.size() > idle_thread_count_ &&
  10695. threads_.size() + dynamic_threads_.size() < max_thread_count_) {
  10696. cleanup_finished_threads();
  10697. dynamic_threads_.emplace_back(std::thread([this]() { worker(true); }));
  10698. }
  10699. }
  10700. cond_.notify_one();
  10701. return true;
  10702. }
  10703. inline void ThreadPool::shutdown() {
  10704. {
  10705. std::unique_lock<std::mutex> lock(mutex_);
  10706. shutdown_ = true;
  10707. }
  10708. cond_.notify_all();
  10709. for (auto &t : threads_) {
  10710. if (t.joinable()) { t.join(); }
  10711. }
  10712. // Move dynamic_threads_ to a local list under the lock to avoid racing
  10713. // with worker threads that call move_to_finished() concurrently.
  10714. std::list<std::thread> remaining_dynamic;
  10715. {
  10716. std::unique_lock<std::mutex> lock(mutex_);
  10717. remaining_dynamic = std::move(dynamic_threads_);
  10718. }
  10719. for (auto &t : remaining_dynamic) {
  10720. if (t.joinable()) { t.join(); }
  10721. }
  10722. std::unique_lock<std::mutex> lock(mutex_);
  10723. cleanup_finished_threads();
  10724. }
  10725. inline void ThreadPool::move_to_finished(std::thread::id id) {
  10726. // Must be called with mutex_ held
  10727. for (auto it = dynamic_threads_.begin(); it != dynamic_threads_.end(); ++it) {
  10728. if (it->get_id() == id) {
  10729. finished_threads_.push_back(std::move(*it));
  10730. dynamic_threads_.erase(it);
  10731. return;
  10732. }
  10733. }
  10734. }
  10735. inline void ThreadPool::cleanup_finished_threads() {
  10736. // Must be called with mutex_ held
  10737. for (auto &t : finished_threads_) {
  10738. if (t.joinable()) { t.join(); }
  10739. }
  10740. finished_threads_.clear();
  10741. }
  10742. inline void ThreadPool::worker(bool is_dynamic) {
  10743. for (;;) {
  10744. std::function<void()> fn;
  10745. {
  10746. std::unique_lock<std::mutex> lock(mutex_);
  10747. idle_thread_count_++;
  10748. if (is_dynamic) {
  10749. auto has_work =
  10750. cond_.wait_for(lock, std::chrono::seconds(idle_timeout_sec_),
  10751. [&] { return !jobs_.empty() || shutdown_; });
  10752. if (!has_work) {
  10753. // Timed out with no work - exit this dynamic thread
  10754. idle_thread_count_--;
  10755. move_to_finished(std::this_thread::get_id());
  10756. break;
  10757. }
  10758. } else {
  10759. cond_.wait(lock, [&] { return !jobs_.empty() || shutdown_; });
  10760. }
  10761. idle_thread_count_--;
  10762. if (shutdown_ && jobs_.empty()) { break; }
  10763. fn = std::move(jobs_.front());
  10764. jobs_.pop_front();
  10765. }
  10766. assert(true == static_cast<bool>(fn));
  10767. fn();
  10768. }
  10769. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(OPENSSL_IS_BORINGSSL) && \
  10770. !defined(LIBRESSL_VERSION_NUMBER)
  10771. OPENSSL_thread_stop();
  10772. #endif
  10773. }
  10774. /*
  10775. * Group 1 (continued): detail namespace - Stream implementations
  10776. */
  10777. namespace detail {
  10778. inline void calc_actual_timeout(time_t max_timeout_msec, time_t duration_msec,
  10779. time_t timeout_sec, time_t timeout_usec,
  10780. time_t &actual_timeout_sec,
  10781. time_t &actual_timeout_usec) {
  10782. auto timeout_msec = (timeout_sec * 1000) + (timeout_usec / 1000);
  10783. auto actual_timeout_msec =
  10784. (std::min)(max_timeout_msec - duration_msec, timeout_msec);
  10785. if (actual_timeout_msec < 0) { actual_timeout_msec = 0; }
  10786. actual_timeout_sec = actual_timeout_msec / 1000;
  10787. actual_timeout_usec = (actual_timeout_msec % 1000) * 1000;
  10788. }
  10789. // Socket stream implementation
  10790. inline SocketStream::SocketStream(
  10791. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  10792. time_t write_timeout_sec, time_t write_timeout_usec,
  10793. time_t max_timeout_msec,
  10794. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10795. : sock_(sock), read_timeout_sec_(read_timeout_sec),
  10796. read_timeout_usec_(read_timeout_usec),
  10797. write_timeout_sec_(write_timeout_sec),
  10798. write_timeout_usec_(write_timeout_usec),
  10799. max_timeout_msec_(max_timeout_msec), start_time_(start_time),
  10800. read_buff_(read_buff_size_, 0) {}
  10801. inline SocketStream::~SocketStream() = default;
  10802. inline bool SocketStream::is_readable() const {
  10803. return read_buff_off_ < read_buff_content_size_;
  10804. }
  10805. inline bool SocketStream::wait_readable() const {
  10806. if (max_timeout_msec_ <= 0) {
  10807. return select_read_interruptible(sock_, read_timeout_sec_,
  10808. read_timeout_usec_, read_interrupted_) > 0;
  10809. }
  10810. time_t read_timeout_sec;
  10811. time_t read_timeout_usec;
  10812. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10813. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10814. return select_read_interruptible(sock_, read_timeout_sec, read_timeout_usec,
  10815. read_interrupted_) > 0;
  10816. }
  10817. inline bool SocketStream::wait_writable() const {
  10818. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10819. }
  10820. inline bool SocketStream::ensure_readable() {
  10821. if (readable_hint_) {
  10822. readable_hint_ = false;
  10823. return true;
  10824. }
  10825. return wait_readable();
  10826. }
  10827. inline const char *SocketStream::buffered_data(size_t &size) const {
  10828. size = read_buff_content_size_ - read_buff_off_;
  10829. return size ? read_buff_.data() + read_buff_off_ : nullptr;
  10830. }
  10831. inline void SocketStream::consume_buffered(size_t size) {
  10832. assert(size <= read_buff_content_size_ - read_buff_off_);
  10833. read_buff_off_ += size;
  10834. }
  10835. inline bool SocketStream::is_peer_alive() const {
  10836. return detail::is_socket_alive(sock_);
  10837. }
  10838. inline ssize_t SocketStream::read(char *ptr, size_t size) {
  10839. #ifdef _WIN32
  10840. size =
  10841. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10842. #else
  10843. size = (std::min)(size,
  10844. static_cast<size_t>((std::numeric_limits<ssize_t>::max)()));
  10845. #endif
  10846. if (read_buff_off_ < read_buff_content_size_) {
  10847. auto remaining_size = read_buff_content_size_ - read_buff_off_;
  10848. if (size <= remaining_size) {
  10849. memcpy(ptr, read_buff_.data() + read_buff_off_, size);
  10850. read_buff_off_ += size;
  10851. return static_cast<ssize_t>(size);
  10852. } else {
  10853. memcpy(ptr, read_buff_.data() + read_buff_off_, remaining_size);
  10854. read_buff_off_ += remaining_size;
  10855. return static_cast<ssize_t>(remaining_size);
  10856. }
  10857. }
  10858. if (!ensure_readable()) {
  10859. error_ = Error::Timeout;
  10860. return -1;
  10861. }
  10862. read_buff_off_ = 0;
  10863. read_buff_content_size_ = 0;
  10864. if (size < read_buff_size_) {
  10865. auto n = read_socket(sock_, read_buff_.data(), read_buff_size_,
  10866. CPPHTTPLIB_RECV_FLAGS);
  10867. if (n <= 0) {
  10868. if (n == 0) {
  10869. error_ = Error::ConnectionClosed;
  10870. } else {
  10871. error_ = Error::Read;
  10872. }
  10873. return n;
  10874. } else if (n <= static_cast<ssize_t>(size)) {
  10875. memcpy(ptr, read_buff_.data(), static_cast<size_t>(n));
  10876. return n;
  10877. } else {
  10878. memcpy(ptr, read_buff_.data(), size);
  10879. read_buff_off_ = size;
  10880. read_buff_content_size_ = static_cast<size_t>(n);
  10881. return static_cast<ssize_t>(size);
  10882. }
  10883. } else {
  10884. auto n = read_socket(sock_, ptr, size, CPPHTTPLIB_RECV_FLAGS);
  10885. if (n <= 0) {
  10886. if (n == 0) {
  10887. error_ = Error::ConnectionClosed;
  10888. } else {
  10889. error_ = Error::Read;
  10890. }
  10891. }
  10892. return n;
  10893. }
  10894. }
  10895. inline ssize_t SocketStream::write(const char *ptr, size_t size) {
  10896. if (!wait_writable()) { return -1; }
  10897. #if defined(_WIN32) && !defined(_WIN64)
  10898. size =
  10899. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10900. #endif
  10901. return send_socket(sock_, ptr, size, CPPHTTPLIB_SEND_FLAGS);
  10902. }
  10903. inline void SocketStream::get_remote_ip_and_port(std::string &ip,
  10904. int &port) const {
  10905. return detail::get_remote_ip_and_port(sock_, ip, port);
  10906. }
  10907. inline void SocketStream::get_local_ip_and_port(std::string &ip,
  10908. int &port) const {
  10909. return detail::get_local_ip_and_port(sock_, ip, port);
  10910. }
  10911. inline socket_t SocketStream::socket() const { return sock_; }
  10912. inline time_t SocketStream::duration() const {
  10913. return static_cast<time_t>(
  10914. std::chrono::duration_cast<std::chrono::milliseconds>(
  10915. std::chrono::steady_clock::now() - start_time_)
  10916. .count());
  10917. }
  10918. inline void SocketStream::set_read_timeout(time_t sec, time_t usec) {
  10919. read_timeout_sec_ = sec;
  10920. read_timeout_usec_ = usec;
  10921. }
  10922. inline void SocketStream::set_max_timeout(time_t msec) {
  10923. max_timeout_msec_ = msec;
  10924. start_time_ = std::chrono::steady_clock::now();
  10925. }
  10926. inline void
  10927. SocketStream::set_read_interrupt(std::function<bool()> interrupted) {
  10928. read_interrupted_ = std::move(interrupted);
  10929. }
  10930. // Buffer stream implementation
  10931. inline bool BufferStream::is_readable() const { return true; }
  10932. inline bool BufferStream::wait_readable() const { return true; }
  10933. inline bool BufferStream::wait_writable() const { return true; }
  10934. inline ssize_t BufferStream::read(char *ptr, size_t size) {
  10935. #if defined(_MSC_VER) && _MSC_VER < 1910
  10936. auto len_read = buffer._Copy_s(ptr, size, size, position);
  10937. #else
  10938. auto len_read = buffer.copy(ptr, size, position);
  10939. #endif
  10940. position += static_cast<size_t>(len_read);
  10941. return static_cast<ssize_t>(len_read);
  10942. }
  10943. inline ssize_t BufferStream::write(const char *ptr, size_t size) {
  10944. buffer.append(ptr, size);
  10945. return static_cast<ssize_t>(size);
  10946. }
  10947. inline void BufferStream::get_remote_ip_and_port(std::string & /*ip*/,
  10948. int & /*port*/) const {}
  10949. inline void BufferStream::get_local_ip_and_port(std::string & /*ip*/,
  10950. int & /*port*/) const {}
  10951. inline socket_t BufferStream::socket() const { return 0; }
  10952. inline time_t BufferStream::duration() const { return 0; }
  10953. inline const std::string &BufferStream::get_buffer() const { return buffer; }
  10954. inline PathParamsMatcher::PathParamsMatcher(const std::string &pattern)
  10955. : MatcherBase(pattern) {
  10956. constexpr const char marker[] = "/:";
  10957. // One past the last ending position of a path param substring
  10958. std::size_t last_param_end = 0;
  10959. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10960. // Needed to ensure that parameter names are unique during matcher
  10961. // construction
  10962. // If exceptions are disabled, only last duplicate path
  10963. // parameter will be set
  10964. std::unordered_set<std::string> param_name_set;
  10965. #endif
  10966. while (true) {
  10967. const auto marker_pos = pattern.find(
  10968. marker, last_param_end == 0 ? last_param_end : last_param_end - 1);
  10969. if (marker_pos == std::string::npos) { break; }
  10970. static_fragments_.push_back(
  10971. pattern.substr(last_param_end, marker_pos - last_param_end + 1));
  10972. const auto param_name_start = marker_pos + str_len(marker);
  10973. auto sep_pos = pattern.find(separator, param_name_start);
  10974. if (sep_pos == std::string::npos) { sep_pos = pattern.length(); }
  10975. auto param_name =
  10976. pattern.substr(param_name_start, sep_pos - param_name_start);
  10977. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10978. if (param_name_set.find(param_name) != param_name_set.cend()) {
  10979. std::string msg = "Encountered path parameter '" + param_name +
  10980. "' multiple times in route pattern '" + pattern + "'.";
  10981. throw std::invalid_argument(msg);
  10982. }
  10983. #endif
  10984. param_names_.push_back(std::move(param_name));
  10985. last_param_end = sep_pos + 1;
  10986. }
  10987. if (last_param_end < pattern.length()) {
  10988. static_fragments_.push_back(pattern.substr(last_param_end));
  10989. }
  10990. }
  10991. inline bool PathParamsMatcher::match(Request &request) const {
  10992. request.matches = std::smatch();
  10993. request.path_params.clear();
  10994. // A pattern without parameters is just a literal path to compare against
  10995. if (param_names_.empty()) { return request.path == pattern(); }
  10996. request.path_params.reserve(param_names_.size());
  10997. // One past the position at which the path matched the pattern last time
  10998. std::size_t starting_pos = 0;
  10999. for (size_t i = 0; i < static_fragments_.size(); ++i) {
  11000. const auto &fragment = static_fragments_[i];
  11001. if (starting_pos + fragment.length() > request.path.length()) {
  11002. return false;
  11003. }
  11004. // Avoid unnecessary allocation by using strncmp instead of substr +
  11005. // comparison
  11006. if (std::strncmp(request.path.c_str() + starting_pos, fragment.c_str(),
  11007. fragment.length()) != 0) {
  11008. return false;
  11009. }
  11010. starting_pos += fragment.length();
  11011. // Should only happen when we have a static fragment after a param
  11012. // Example: '/users/:id/subscriptions'
  11013. // The 'subscriptions' fragment here does not have a corresponding param
  11014. if (i >= param_names_.size()) { continue; }
  11015. auto sep_pos = request.path.find(separator, starting_pos);
  11016. if (sep_pos == std::string::npos) { sep_pos = request.path.length(); }
  11017. const auto &param_name = param_names_[i];
  11018. request.path_params.emplace(
  11019. param_name, request.path.substr(starting_pos, sep_pos - starting_pos));
  11020. // Mark everything up to '/' as matched
  11021. starting_pos = sep_pos + 1;
  11022. }
  11023. // Returns false if the path is longer than the pattern
  11024. return starting_pos >= request.path.length();
  11025. }
  11026. inline bool RegexMatcher::match(Request &request) const {
  11027. request.path_params.clear();
  11028. // See CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH: an overlong path is treated as
  11029. // a non-match rather than risking a stack overflow in std::regex_match.
  11030. if (request.path.length() > CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH) {
  11031. return false;
  11032. }
  11033. return std::regex_match(request.path, request.matches, regex_);
  11034. }
  11035. // Enclose IPv6 address in brackets if needed
  11036. inline std::string prepare_host_string(const std::string &host) {
  11037. // Enclose IPv6 address in brackets (but not if already enclosed)
  11038. if (host.find(':') == std::string::npos ||
  11039. (!host.empty() && host[0] == '[')) {
  11040. // IPv4, hostname, or already bracketed IPv6
  11041. return host;
  11042. } else {
  11043. // IPv6 address without brackets
  11044. return "[" + host + "]";
  11045. }
  11046. }
  11047. inline std::string make_host_and_port_string(const std::string &host, int port,
  11048. bool is_ssl) {
  11049. auto result = prepare_host_string(host);
  11050. // Append port if not default
  11051. if ((!is_ssl && port == 80) || (is_ssl && port == 443)) {
  11052. ; // do nothing
  11053. } else {
  11054. result += ":" + std::to_string(port);
  11055. }
  11056. return result;
  11057. }
  11058. // Create "host:port" string always including port number (for CONNECT method)
  11059. inline std::string
  11060. make_host_and_port_string_always_port(const std::string &host, int port) {
  11061. return prepare_host_string(host) + ":" + std::to_string(port);
  11062. }
  11063. // Request target of a CONNECT for `host`, with `addr_map` applied.
  11064. inline std::string
  11065. make_connect_request_target(const std::map<std::string, std::string> &addr_map,
  11066. const std::string &host, int port) {
  11067. std::string connect_host;
  11068. std::string ip;
  11069. apply_addr_map(addr_map, host, connect_host, ip);
  11070. return make_host_and_port_string_always_port(ip.empty() ? connect_host : ip,
  11071. port);
  11072. }
  11073. // Value for the Host header a client sends when the caller supplied none.
  11074. // Only the value: callers decide where in their header list it goes.
  11075. inline std::string make_default_host_header_value(const std::string &host,
  11076. int port, bool is_ssl,
  11077. int address_family) {
  11078. if (address_family == AF_UNIX) { return "localhost"; }
  11079. return make_host_and_port_string(host, port, is_ssl);
  11080. }
  11081. inline void add_default_user_agent_header(Request &req) {
  11082. #ifndef CPPHTTPLIB_NO_DEFAULT_USER_AGENT
  11083. if (!req.has_header("User-Agent")) {
  11084. req.set_header("User-Agent",
  11085. std::string("cpp-httplib/") + CPPHTTPLIB_VERSION);
  11086. }
  11087. #else
  11088. (void)req;
  11089. #endif
  11090. }
  11091. bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out);
  11092. NormalizedTarget normalize_target(const std::string &host);
  11093. bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits);
  11094. bool host_matches_no_proxy(const NormalizedTarget &target,
  11095. const std::vector<NoProxyEntry> &entries);
  11096. inline bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits) {
  11097. if (prefix_bits < 0 || prefix_bits > 128) { return false; }
  11098. if (prefix_bits == 0) { return true; }
  11099. int full_bytes = prefix_bits / 8;
  11100. int rem_bits = prefix_bits % 8;
  11101. if (full_bytes > 0 && std::memcmp(ip.data(), net.data(),
  11102. static_cast<size_t>(full_bytes)) != 0) {
  11103. return false;
  11104. }
  11105. if (rem_bits == 0) { return true; }
  11106. auto i = static_cast<size_t>(full_bytes);
  11107. auto mask = static_cast<uint8_t>(0xFFu << (8 - rem_bits));
  11108. return (ip[i] & mask) == (net[i] & mask);
  11109. }
  11110. inline bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out) {
  11111. if (token.empty()) { return false; }
  11112. if (token == "*") {
  11113. out.kind = NoProxyKind::Wildcard;
  11114. return true;
  11115. }
  11116. auto slash = token.find('/');
  11117. std::string addr_part =
  11118. (slash == std::string::npos) ? token : token.substr(0, slash);
  11119. std::string prefix_part =
  11120. (slash == std::string::npos) ? std::string() : token.substr(slash + 1);
  11121. // A bare slash or trailing-slash CIDR like "10.0.0.0/" is malformed;
  11122. // don't silently treat it as a /32 (or /128).
  11123. if (slash != std::string::npos && prefix_part.empty()) { return false; }
  11124. // Accept the bracketed IPv6 form ("[::1]", "[fe80::]/10") as well as the
  11125. // bare form. Brackets have no meaning for IPv4, so skip the IPv4 attempt
  11126. // when brackets are present.
  11127. bool bracketed = addr_part.size() >= 2 && addr_part.front() == '[' &&
  11128. addr_part.back() == ']';
  11129. if (bracketed) { addr_part = addr_part.substr(1, addr_part.size() - 2); }
  11130. if (!bracketed) {
  11131. struct in_addr v4;
  11132. if (inet_pton(AF_INET, addr_part.c_str(), &v4) == 1) {
  11133. int prefix = 32;
  11134. if (!prefix_part.empty() &&
  11135. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 32,
  11136. prefix)) {
  11137. return false;
  11138. }
  11139. out.kind = NoProxyKind::IPv4Cidr;
  11140. std::memcpy(out.net.data(), &v4, sizeof(v4));
  11141. out.prefix_bits = prefix;
  11142. return true;
  11143. }
  11144. }
  11145. struct in6_addr v6;
  11146. if (inet_pton(AF_INET6, addr_part.c_str(), &v6) == 1) {
  11147. int prefix = 128;
  11148. if (!prefix_part.empty() &&
  11149. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 128,
  11150. prefix)) {
  11151. return false;
  11152. }
  11153. out.kind = NoProxyKind::IPv6Cidr;
  11154. std::memcpy(out.net.data(), &v6, sizeof(v6));
  11155. out.prefix_bits = prefix;
  11156. return true;
  11157. }
  11158. // Bracketed entries can only be IPv6. If the IPv6 parse above failed,
  11159. // the entry is malformed — don't fall through to the hostname branch.
  11160. if (bracketed) { return false; }
  11161. // A '/' on a non-IP token means a CIDR prefix without an address. Reject.
  11162. if (slash != std::string::npos) { return false; }
  11163. // Port-specific entries (host:port) are not supported.
  11164. if (token.find(':') != std::string::npos) { return false; }
  11165. std::string hostname = case_ignore::to_lower(token);
  11166. while (!hostname.empty() && hostname.front() == '.') {
  11167. hostname.erase(hostname.begin());
  11168. }
  11169. while (!hostname.empty() && hostname.back() == '.') {
  11170. hostname.pop_back();
  11171. }
  11172. if (hostname.empty()) { return false; }
  11173. out.kind = NoProxyKind::HostnameSuffix;
  11174. out.hostname_pattern = std::move(hostname);
  11175. return true;
  11176. }
  11177. inline std::vector<NoProxyEntry>
  11178. parse_no_proxy_entries(const std::vector<std::string> &patterns) {
  11179. std::vector<NoProxyEntry> entries;
  11180. entries.reserve(patterns.size());
  11181. for (const auto &p : patterns) {
  11182. auto trimmed = trim_copy(p);
  11183. if (trimmed.empty()) { continue; }
  11184. NoProxyEntry entry;
  11185. if (parse_no_proxy_entry(trimmed, entry)) {
  11186. entries.push_back(std::move(entry));
  11187. }
  11188. }
  11189. return entries;
  11190. }
  11191. inline NormalizedTarget normalize_target(const std::string &host) {
  11192. NormalizedTarget t;
  11193. std::string h = host;
  11194. if (h.size() >= 2 && h.front() == '[' && h.back() == ']') {
  11195. h = h.substr(1, h.size() - 2);
  11196. }
  11197. // Strip a single trailing dot so "example.com." canonicalizes to
  11198. // "example.com".
  11199. if (!h.empty() && h.back() == '.') { h.pop_back(); }
  11200. t.hostname = case_ignore::to_lower(h);
  11201. if (!t.hostname.empty()) {
  11202. struct in_addr v4;
  11203. struct in6_addr v6;
  11204. if (inet_pton(AF_INET, t.hostname.c_str(), &v4) == 1) {
  11205. t.is_ipv4 = true;
  11206. std::memcpy(t.ip.data(), &v4, sizeof(v4));
  11207. } else if (inet_pton(AF_INET6, t.hostname.c_str(), &v6) == 1) {
  11208. t.is_ipv6 = true;
  11209. std::memcpy(t.ip.data(), &v6, sizeof(v6));
  11210. }
  11211. }
  11212. return t;
  11213. }
  11214. inline bool host_matches_no_proxy(const NormalizedTarget &target,
  11215. const std::vector<NoProxyEntry> &entries) {
  11216. if (target.hostname.empty()) { return false; }
  11217. for (const auto &e : entries) {
  11218. switch (e.kind) {
  11219. case NoProxyKind::Wildcard: return true;
  11220. case NoProxyKind::IPv4Cidr:
  11221. if (target.is_ipv4 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  11222. return true;
  11223. }
  11224. break;
  11225. case NoProxyKind::IPv6Cidr:
  11226. if (target.is_ipv6 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  11227. return true;
  11228. }
  11229. break;
  11230. case NoProxyKind::HostnameSuffix:
  11231. if (target.is_ipv4 || target.is_ipv6) { break; }
  11232. if (target.hostname == e.hostname_pattern) { return true; }
  11233. // Dot-boundary suffix match: prevents "evilexample.com" from matching
  11234. // an entry of "example.com".
  11235. if (target.hostname.size() > e.hostname_pattern.size() + 1) {
  11236. auto offset = target.hostname.size() - e.hostname_pattern.size();
  11237. if (target.hostname[offset - 1] == '.' &&
  11238. target.hostname.compare(offset, e.hostname_pattern.size(),
  11239. e.hostname_pattern) == 0) {
  11240. return true;
  11241. }
  11242. }
  11243. break;
  11244. }
  11245. }
  11246. return false;
  11247. }
  11248. template <typename T>
  11249. inline bool check_and_write_headers(Stream &strm, Headers &headers,
  11250. T header_writer, Error &error) {
  11251. for (const auto &h : headers) {
  11252. if (!detail::fields::is_field_valid(h.first, h.second)) {
  11253. error = Error::InvalidHeaders;
  11254. return false;
  11255. }
  11256. }
  11257. if (header_writer(strm, headers) <= 0) {
  11258. error = Error::Write;
  11259. return false;
  11260. }
  11261. return true;
  11262. }
  11263. } // namespace detail
  11264. /*
  11265. * Group 2 (continued): detail namespace - SSLSocketStream implementation
  11266. */
  11267. #ifdef CPPHTTPLIB_SSL_ENABLED
  11268. namespace detail {
  11269. // SSL socket stream implementation
  11270. inline SSLSocketStream::SSLSocketStream(
  11271. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  11272. time_t read_timeout_usec, time_t write_timeout_sec,
  11273. time_t write_timeout_usec, time_t max_timeout_msec,
  11274. std::chrono::time_point<std::chrono::steady_clock> start_time)
  11275. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  11276. read_timeout_usec_(read_timeout_usec),
  11277. write_timeout_sec_(write_timeout_sec),
  11278. write_timeout_usec_(write_timeout_usec),
  11279. max_timeout_msec_(max_timeout_msec), start_time_(start_time) {
  11280. tls_error_.code = tls::ErrorCode::Success;
  11281. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  11282. // Clear AUTO_RETRY for proper non-blocking I/O timeout handling
  11283. // Note: create_session() also clears this, but SSLClient currently
  11284. // uses ssl_new() which does not. Until full TLS API migration is complete,
  11285. // we need to ensure AUTO_RETRY is cleared here regardless of how the
  11286. // SSL session was created.
  11287. SSL_clear_mode(static_cast<SSL *>(session), SSL_MODE_AUTO_RETRY);
  11288. #endif
  11289. }
  11290. inline SSLSocketStream::~SSLSocketStream() = default;
  11291. inline bool SSLSocketStream::is_readable() const {
  11292. return tls::pending(session_) > 0;
  11293. }
  11294. inline bool SSLSocketStream::wait_readable() const {
  11295. if (max_timeout_msec_ <= 0) {
  11296. return select_read_interruptible(sock_, read_timeout_sec_,
  11297. read_timeout_usec_, read_interrupted_) > 0;
  11298. }
  11299. time_t read_timeout_sec;
  11300. time_t read_timeout_usec;
  11301. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  11302. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  11303. return select_read_interruptible(sock_, read_timeout_sec, read_timeout_usec,
  11304. read_interrupted_) > 0;
  11305. }
  11306. inline bool SSLSocketStream::wait_writable() const {
  11307. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0 &&
  11308. !tls::is_peer_closed(session_, sock_);
  11309. }
  11310. inline bool SSLSocketStream::ensure_readable() {
  11311. if (readable_hint_) {
  11312. readable_hint_ = false;
  11313. return true;
  11314. }
  11315. return wait_readable();
  11316. }
  11317. inline bool SSLSocketStream::is_peer_alive() const {
  11318. return !tls::is_peer_closed(session_, sock_);
  11319. }
  11320. inline ssize_t SSLSocketStream::read(char *ptr, size_t size) {
  11321. if (tls::pending(session_) > 0) {
  11322. tls::TlsError err;
  11323. auto ret = tls::read(session_, ptr, size, err);
  11324. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11325. error_ = Error::ConnectionClosed;
  11326. } else if (ret < 0) {
  11327. tls_error_ = err;
  11328. }
  11329. return ret;
  11330. } else if (ensure_readable()) {
  11331. tls::TlsError err;
  11332. auto ret = tls::read(session_, ptr, size, err);
  11333. if (ret < 0) {
  11334. auto n = 1000;
  11335. #ifdef _WIN32
  11336. while (--n >= 0 && (err.code == tls::ErrorCode::WantRead ||
  11337. (err.code == tls::ErrorCode::SyscallError &&
  11338. WSAGetLastError() == WSAETIMEDOUT))) {
  11339. #else
  11340. while (--n >= 0 && err.code == tls::ErrorCode::WantRead) {
  11341. #endif
  11342. if (tls::pending(session_) > 0) {
  11343. ret = tls::read(session_, ptr, size, err);
  11344. if (ret >= 0) { return ret; }
  11345. break;
  11346. } else if (wait_readable()) {
  11347. std::this_thread::sleep_for(std::chrono::microseconds{10});
  11348. ret = tls::read(session_, ptr, size, err);
  11349. if (ret >= 0) { return ret; }
  11350. } else {
  11351. break;
  11352. }
  11353. }
  11354. assert(ret < 0);
  11355. tls_error_ = err;
  11356. } else if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11357. error_ = Error::ConnectionClosed;
  11358. }
  11359. return ret;
  11360. } else {
  11361. error_ = Error::Timeout;
  11362. return -1;
  11363. }
  11364. }
  11365. inline ssize_t SSLSocketStream::write(const char *ptr, size_t size) {
  11366. if (wait_writable()) {
  11367. auto handle_size =
  11368. std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11369. tls::TlsError err;
  11370. auto ret = tls::write(session_, ptr, handle_size, err);
  11371. if (ret < 0) {
  11372. auto n = 1000;
  11373. #ifdef _WIN32
  11374. while (--n >= 0 && (err.code == tls::ErrorCode::WantWrite ||
  11375. (err.code == tls::ErrorCode::SyscallError &&
  11376. WSAGetLastError() == WSAETIMEDOUT))) {
  11377. #else
  11378. while (--n >= 0 && err.code == tls::ErrorCode::WantWrite) {
  11379. #endif
  11380. if (wait_writable()) {
  11381. std::this_thread::sleep_for(std::chrono::microseconds{10});
  11382. ret = tls::write(session_, ptr, handle_size, err);
  11383. if (ret >= 0) { return ret; }
  11384. } else {
  11385. break;
  11386. }
  11387. }
  11388. assert(ret < 0);
  11389. tls_error_ = err;
  11390. }
  11391. return ret;
  11392. }
  11393. return -1;
  11394. }
  11395. inline void SSLSocketStream::get_remote_ip_and_port(std::string &ip,
  11396. int &port) const {
  11397. detail::get_remote_ip_and_port(sock_, ip, port);
  11398. }
  11399. inline void SSLSocketStream::get_local_ip_and_port(std::string &ip,
  11400. int &port) const {
  11401. detail::get_local_ip_and_port(sock_, ip, port);
  11402. }
  11403. inline socket_t SSLSocketStream::socket() const { return sock_; }
  11404. inline time_t SSLSocketStream::duration() const {
  11405. return static_cast<time_t>(
  11406. std::chrono::duration_cast<std::chrono::milliseconds>(
  11407. std::chrono::steady_clock::now() - start_time_)
  11408. .count());
  11409. }
  11410. inline void SSLSocketStream::set_read_timeout(time_t sec, time_t usec) {
  11411. read_timeout_sec_ = sec;
  11412. read_timeout_usec_ = usec;
  11413. }
  11414. inline void SSLSocketStream::set_max_timeout(time_t msec) {
  11415. max_timeout_msec_ = msec;
  11416. start_time_ = std::chrono::steady_clock::now();
  11417. }
  11418. inline void
  11419. SSLSocketStream::set_read_interrupt(std::function<bool()> interrupted) {
  11420. read_interrupted_ = std::move(interrupted);
  11421. }
  11422. inline WebSocketSSLStream::WebSocketSSLStream(socket_t sock,
  11423. tls::session_t session,
  11424. time_t read_timeout_sec,
  11425. time_t read_timeout_usec,
  11426. time_t write_timeout_sec,
  11427. time_t write_timeout_usec)
  11428. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  11429. read_timeout_usec_(read_timeout_usec),
  11430. write_timeout_sec_(write_timeout_sec),
  11431. write_timeout_usec_(write_timeout_usec),
  11432. start_time_(std::chrono::steady_clock::now()) {
  11433. // The receive and send paths run on different threads, so each TLS call is
  11434. // driven in non-blocking mode and readiness is awaited with select()
  11435. // outside the session lock. Set the socket non-blocking once here; it is
  11436. // never flipped back, so no thread races on the flag.
  11437. detail::set_nonblocking(sock_, true);
  11438. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  11439. SSL_clear_mode(static_cast<SSL *>(session_), SSL_MODE_AUTO_RETRY);
  11440. #endif
  11441. }
  11442. inline WebSocketSSLStream::~WebSocketSSLStream() = default;
  11443. inline bool WebSocketSSLStream::is_readable() const {
  11444. std::lock_guard<std::mutex> guard(session_mutex_);
  11445. return tls::pending(session_) > 0;
  11446. }
  11447. inline bool WebSocketSSLStream::wait_readable() const {
  11448. return select_read_interruptible(sock_, read_timeout_sec_, read_timeout_usec_,
  11449. read_interrupted_) > 0;
  11450. }
  11451. inline bool WebSocketSSLStream::wait_writable() const {
  11452. // Unlike SSLSocketStream, this deliberately does not call is_peer_closed():
  11453. // that probe toggles the socket's blocking flag, which would race with the
  11454. // concurrent reader on a permanently non-blocking socket.
  11455. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  11456. }
  11457. inline ssize_t WebSocketSSLStream::read(char *ptr, size_t size) {
  11458. tls::TlsError err;
  11459. auto n = 1000;
  11460. while (--n >= 0) {
  11461. {
  11462. std::lock_guard<std::mutex> guard(session_mutex_);
  11463. auto ret = tls::read(session_, ptr, size, err);
  11464. if (ret > 0) { return ret; }
  11465. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11466. error_ = Error::ConnectionClosed;
  11467. return ret;
  11468. }
  11469. }
  11470. // ret < 0. On a non-blocking socket a TLS read can stop needing either
  11471. // direction: the send path shares this session, so output it left pending
  11472. // has to be flushed before more input can be decrypted. Anything else is
  11473. // a hard error.
  11474. auto needs_readable = err.code == tls::ErrorCode::WantRead;
  11475. #ifdef _WIN32
  11476. // On Windows a socket timeout surfaces as a syscall error, not WantRead.
  11477. needs_readable =
  11478. needs_readable || (err.code == tls::ErrorCode::SyscallError &&
  11479. WSAGetLastError() == WSAETIMEDOUT);
  11480. #endif
  11481. if (!needs_readable && err.code != tls::ErrorCode::WantWrite) {
  11482. error_ = Error::Read;
  11483. return -1;
  11484. }
  11485. if (!(needs_readable ? wait_readable() : wait_writable())) {
  11486. error_ = Error::Timeout;
  11487. return -1;
  11488. }
  11489. }
  11490. // Out of retries. Recording a reason matters: a caller that reads get_error()
  11491. // to tell a timeout from a close would otherwise see whatever the previous
  11492. // failure left behind (error_ is never cleared on success).
  11493. error_ = Error::Read;
  11494. return -1;
  11495. }
  11496. inline ssize_t WebSocketSSLStream::write(const char *ptr, size_t size) {
  11497. auto handle_size = std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11498. tls::TlsError err;
  11499. auto n = 1000;
  11500. while (--n >= 0) {
  11501. {
  11502. std::lock_guard<std::mutex> guard(session_mutex_);
  11503. auto ret = tls::write(session_, ptr, handle_size, err);
  11504. if (ret >= 0) { return ret; }
  11505. }
  11506. // ret < 0. As in read(), either direction can be needed: a renegotiation
  11507. // or a post-handshake message must be consumed before the record goes
  11508. // out. Anything else is a hard error.
  11509. auto needs_writable = err.code == tls::ErrorCode::WantWrite;
  11510. #ifdef _WIN32
  11511. // On Windows a socket timeout surfaces as a syscall error, not WantWrite.
  11512. needs_writable =
  11513. needs_writable || (err.code == tls::ErrorCode::SyscallError &&
  11514. WSAGetLastError() == WSAETIMEDOUT);
  11515. #endif
  11516. if (!needs_writable && err.code != tls::ErrorCode::WantRead) { return -1; }
  11517. if (!(needs_writable ? wait_writable() : wait_readable())) { return -1; }
  11518. }
  11519. return -1;
  11520. }
  11521. inline void WebSocketSSLStream::get_remote_ip_and_port(std::string &ip,
  11522. int &port) const {
  11523. detail::get_remote_ip_and_port(sock_, ip, port);
  11524. }
  11525. inline void WebSocketSSLStream::get_local_ip_and_port(std::string &ip,
  11526. int &port) const {
  11527. detail::get_local_ip_and_port(sock_, ip, port);
  11528. }
  11529. inline socket_t WebSocketSSLStream::socket() const { return sock_; }
  11530. inline time_t WebSocketSSLStream::duration() const {
  11531. return static_cast<time_t>(
  11532. std::chrono::duration_cast<std::chrono::milliseconds>(
  11533. std::chrono::steady_clock::now() - start_time_)
  11534. .count());
  11535. }
  11536. inline void WebSocketSSLStream::set_read_timeout(time_t sec, time_t usec) {
  11537. read_timeout_sec_ = sec;
  11538. read_timeout_usec_ = usec;
  11539. }
  11540. inline void
  11541. WebSocketSSLStream::set_read_interrupt(std::function<bool()> interrupted) {
  11542. read_interrupted_ = std::move(interrupted);
  11543. }
  11544. } // namespace detail
  11545. #endif // CPPHTTPLIB_SSL_ENABLED
  11546. /*
  11547. * Group 4: Server implementation
  11548. */
  11549. // HTTP server implementation
  11550. inline Server::Server()
  11551. : new_task_queue([] {
  11552. return new ThreadPool(CPPHTTPLIB_THREAD_POOL_COUNT,
  11553. CPPHTTPLIB_THREAD_POOL_MAX_COUNT);
  11554. }) {
  11555. #ifndef _WIN32
  11556. signal(SIGPIPE, SIG_IGN);
  11557. #endif
  11558. }
  11559. inline Server::~Server() = default;
  11560. inline std::unique_ptr<detail::MatcherBase>
  11561. Server::make_matcher(const std::string &pattern) {
  11562. // Path params take precedence, so "/users/:id/(.*)" keeps being matched as
  11563. // a path params pattern
  11564. if (pattern.find("/:") != std::string::npos) {
  11565. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11566. }
  11567. // A pattern with no regex metacharacter only has to be compared literally,
  11568. // which is what PathParamsMatcher already does when it captures no
  11569. // parameter, so std::regex is only worth building for the patterns that
  11570. // actually need it
  11571. if (pattern.find_first_of(".^$|()[]{}*+?\\") == std::string::npos) {
  11572. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11573. }
  11574. return detail::make_unique<detail::RegexMatcher>(pattern);
  11575. }
  11576. inline Server &Server::Get(const std::string &pattern, Handler handler) {
  11577. return add_handler(get_handlers_, pattern, std::move(handler));
  11578. }
  11579. inline Server &Server::Post(const std::string &pattern, Handler handler) {
  11580. return add_handler(post_handlers_, pattern, std::move(handler));
  11581. }
  11582. inline Server &Server::Post(const std::string &pattern,
  11583. HandlerWithContentReader handler) {
  11584. return add_handler(post_handlers_for_content_reader_, pattern,
  11585. std::move(handler));
  11586. }
  11587. inline Server &Server::Put(const std::string &pattern, Handler handler) {
  11588. return add_handler(put_handlers_, pattern, std::move(handler));
  11589. }
  11590. inline Server &Server::Put(const std::string &pattern,
  11591. HandlerWithContentReader handler) {
  11592. return add_handler(put_handlers_for_content_reader_, pattern,
  11593. std::move(handler));
  11594. }
  11595. inline Server &Server::Patch(const std::string &pattern, Handler handler) {
  11596. return add_handler(patch_handlers_, pattern, std::move(handler));
  11597. }
  11598. inline Server &Server::Patch(const std::string &pattern,
  11599. HandlerWithContentReader handler) {
  11600. return add_handler(patch_handlers_for_content_reader_, pattern,
  11601. std::move(handler));
  11602. }
  11603. inline Server &Server::Delete(const std::string &pattern, Handler handler) {
  11604. return add_handler(delete_handlers_, pattern, std::move(handler));
  11605. }
  11606. inline Server &Server::Delete(const std::string &pattern,
  11607. HandlerWithContentReader handler) {
  11608. return add_handler(delete_handlers_for_content_reader_, pattern,
  11609. std::move(handler));
  11610. }
  11611. inline Server &Server::Options(const std::string &pattern, Handler handler) {
  11612. return add_handler(options_handlers_, pattern, std::move(handler));
  11613. }
  11614. inline const std::set<std::string> &Server::builtin_methods() {
  11615. thread_local const std::set<std::string> methods{
  11616. "GET", "HEAD", "POST", "PUT", "DELETE",
  11617. "CONNECT", "OPTIONS", "TRACE", "PATCH", "PRI"};
  11618. return methods;
  11619. }
  11620. inline Server::CustomHandlerEntry *
  11621. Server::custom_entry_for_registration(const std::string &method) {
  11622. // Built-in methods are refused for two different reasons. GET, HEAD, POST,
  11623. // PUT, DELETE, OPTIONS and PATCH are dispatched by the if/else chain in
  11624. // routing() before the custom tables are consulted, so a route registered
  11625. // for one of them could never fire. CONNECT, TRACE and PRI have no branch
  11626. // there and would be reachable, but they carry protocol-level meaning
  11627. // (tunnel setup, request echo, the HTTP/2 connection preface) that this
  11628. // library does not route.
  11629. if (!detail::fields::is_token(method) || builtin_methods().count(method)) {
  11630. output_error_log(Error::InvalidHTTPMethod, nullptr);
  11631. has_invalid_registration_ = true;
  11632. return nullptr;
  11633. }
  11634. return &custom_handlers_[method];
  11635. }
  11636. inline Server &Server::CustomRoute(const std::string &method,
  11637. const std::string &pattern,
  11638. Handler handler) {
  11639. auto *entry = custom_entry_for_registration(method);
  11640. if (!entry) { return *this; }
  11641. return add_handler(entry->handlers, pattern, std::move(handler));
  11642. }
  11643. inline Server &Server::CustomRoute(const std::string &method,
  11644. const std::string &pattern,
  11645. HandlerWithContentReader handler) {
  11646. auto *entry = custom_entry_for_registration(method);
  11647. if (!entry) { return *this; }
  11648. return add_handler(entry->handlers_for_content_reader, pattern,
  11649. std::move(handler));
  11650. }
  11651. inline const Server::CustomHandlerEntry *
  11652. Server::find_custom_entry(const std::string &method) const {
  11653. // find() alone would be correct here. The empty() check is what keeps the
  11654. // per-request cost off servers that never call CustomRoute(), which is the
  11655. // overwhelmingly common case; keep it rather than walking into the tree.
  11656. if (custom_handlers_.empty()) { return nullptr; }
  11657. auto it = custom_handlers_.find(method);
  11658. return it == custom_handlers_.end() ? nullptr : &it->second;
  11659. }
  11660. inline Server &Server::WebSocket(const std::string &pattern,
  11661. WebSocketHandler handler) {
  11662. websocket_handlers_.push_back(
  11663. {make_matcher(pattern), std::move(handler), nullptr});
  11664. return *this;
  11665. }
  11666. inline Server &Server::WebSocket(const std::string &pattern,
  11667. WebSocketHandler handler,
  11668. SubProtocolSelector sub_protocol_selector) {
  11669. websocket_handlers_.push_back({make_matcher(pattern), std::move(handler),
  11670. std::move(sub_protocol_selector)});
  11671. return *this;
  11672. }
  11673. inline bool Server::set_base_dir(const std::string &dir,
  11674. const std::string &mount_point) {
  11675. return set_mount_point(mount_point, dir);
  11676. }
  11677. inline bool Server::set_mount_point(const std::string &mount_point,
  11678. const std::string &dir, Headers headers) {
  11679. detail::FileStat stat(dir);
  11680. if (stat.is_dir()) {
  11681. std::string mnt = !mount_point.empty() ? mount_point : "/";
  11682. if (!mnt.empty() && mnt[0] == '/') {
  11683. // Without the resolved directory, a file could not be checked to be
  11684. // inside it.
  11685. std::string resolved_base;
  11686. if (!detail::canonicalize_path(dir.c_str(), resolved_base)) {
  11687. return false;
  11688. }
  11689. #if defined(_WIN32)
  11690. if (resolved_base.back() != '\\' && resolved_base.back() != '/') {
  11691. resolved_base += '\\';
  11692. }
  11693. #else
  11694. if (resolved_base.back() != '/') { resolved_base += '/'; }
  11695. #endif
  11696. base_dirs_.push_back(
  11697. {std::move(mnt), dir, std::move(resolved_base), std::move(headers)});
  11698. return true;
  11699. }
  11700. }
  11701. return false;
  11702. }
  11703. inline bool Server::remove_mount_point(const std::string &mount_point) {
  11704. for (auto it = base_dirs_.begin(); it != base_dirs_.end(); ++it) {
  11705. if (it->mount_point == mount_point) {
  11706. base_dirs_.erase(it);
  11707. return true;
  11708. }
  11709. }
  11710. return false;
  11711. }
  11712. inline Server &
  11713. Server::set_file_extension_and_mimetype_mapping(const std::string &ext,
  11714. const std::string &mime) {
  11715. // Keyed as find_content_type() looks it up
  11716. auto key = detail::case_ignore::to_lower(ext);
  11717. if (!key.empty() && key[0] == '.') { key.erase(0, 1); }
  11718. file_extension_and_mimetype_map_[key] = mime;
  11719. return *this;
  11720. }
  11721. inline Server &Server::set_default_file_mimetype(const std::string &mime) {
  11722. default_file_mimetype_ = mime;
  11723. return *this;
  11724. }
  11725. inline Server &Server::set_file_request_handler(Handler handler) {
  11726. file_request_handler_ = std::move(handler);
  11727. return *this;
  11728. }
  11729. inline Server &Server::set_error_handler_core(HandlerWithResponse handler,
  11730. std::true_type) {
  11731. error_handler_ = std::move(handler);
  11732. return *this;
  11733. }
  11734. inline Server &Server::set_error_handler_core(Handler handler,
  11735. std::false_type) {
  11736. error_handler_ = [handler](const Request &req, Response &res) {
  11737. handler(req, res);
  11738. return HandlerResponse::Handled;
  11739. };
  11740. return *this;
  11741. }
  11742. inline Server &Server::set_exception_handler(ExceptionHandler handler) {
  11743. exception_handler_ = std::move(handler);
  11744. return *this;
  11745. }
  11746. inline Server &Server::set_pre_routing_handler(HandlerWithResponse handler) {
  11747. pre_routing_handler_ = std::move(handler);
  11748. return *this;
  11749. }
  11750. inline Server &Server::set_post_routing_handler(Handler handler) {
  11751. post_routing_handler_ = std::move(handler);
  11752. return *this;
  11753. }
  11754. inline Server &Server::set_pre_request_handler(HandlerWithResponse handler) {
  11755. pre_request_handler_ = std::move(handler);
  11756. return *this;
  11757. }
  11758. inline Server &Server::set_logger(Logger logger) {
  11759. logger_ = std::move(logger);
  11760. return *this;
  11761. }
  11762. inline Server &Server::set_error_logger(ErrorLogger error_logger) {
  11763. error_logger_ = std::move(error_logger);
  11764. return *this;
  11765. }
  11766. inline Server &Server::set_pre_compression_logger(Logger logger) {
  11767. pre_compression_logger_ = std::move(logger);
  11768. return *this;
  11769. }
  11770. inline Server &
  11771. Server::set_expect_100_continue_handler(Expect100ContinueHandler handler) {
  11772. expect_100_continue_handler_ = std::move(handler);
  11773. return *this;
  11774. }
  11775. inline Server &Server::set_start_handler(StartHandler handler) {
  11776. start_handler_ = std::move(handler);
  11777. return *this;
  11778. }
  11779. inline Server &Server::set_address_family(int family) {
  11780. address_family_ = family;
  11781. return *this;
  11782. }
  11783. inline Server &Server::set_tcp_nodelay(bool on) {
  11784. tcp_nodelay_ = on;
  11785. return *this;
  11786. }
  11787. inline Server &Server::set_ipv6_v6only(bool on) {
  11788. ipv6_v6only_ = on;
  11789. return *this;
  11790. }
  11791. inline Server &Server::set_socket_options(SocketOptions socket_options) {
  11792. socket_options_ = std::move(socket_options);
  11793. return *this;
  11794. }
  11795. inline Server &Server::set_default_headers(Headers headers) {
  11796. default_headers_ = std::move(headers);
  11797. return *this;
  11798. }
  11799. inline Server &Server::set_header_writer(
  11800. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  11801. header_writer_ = writer;
  11802. return *this;
  11803. }
  11804. inline Server &
  11805. Server::set_trusted_proxies(const std::vector<std::string> &proxies) {
  11806. trusted_proxies_.clear();
  11807. trusted_proxies_.reserve(proxies.size());
  11808. for (const auto &proxy : proxies) {
  11809. trusted_proxies_.push_back(detail::canonical_ip(proxy));
  11810. }
  11811. return *this;
  11812. }
  11813. inline Server &Server::set_keep_alive_max_count(size_t count) {
  11814. keep_alive_max_count_ = count;
  11815. return *this;
  11816. }
  11817. inline Server &Server::set_keep_alive_timeout(time_t sec) {
  11818. keep_alive_timeout_sec_ = sec;
  11819. return *this;
  11820. }
  11821. template <class Rep, class Period>
  11822. inline Server &Server::set_keep_alive_timeout(
  11823. const std::chrono::duration<Rep, Period> &duration) {
  11824. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11825. set_keep_alive_timeout(sec);
  11826. });
  11827. return *this;
  11828. }
  11829. inline Server &Server::set_read_timeout(time_t sec, time_t usec) {
  11830. read_timeout_sec_ = sec;
  11831. read_timeout_usec_ = usec;
  11832. return *this;
  11833. }
  11834. inline Server &Server::set_write_timeout(time_t sec, time_t usec) {
  11835. write_timeout_sec_ = sec;
  11836. write_timeout_usec_ = usec;
  11837. return *this;
  11838. }
  11839. inline Server &Server::set_idle_interval(time_t sec, time_t usec) {
  11840. idle_interval_sec_ = sec;
  11841. idle_interval_usec_ = usec;
  11842. return *this;
  11843. }
  11844. inline Server &Server::set_payload_max_length(size_t length) {
  11845. payload_max_length_ = length;
  11846. return *this;
  11847. }
  11848. inline Server &Server::set_compress(bool on) {
  11849. compress_ = on;
  11850. return *this;
  11851. }
  11852. inline Server &Server::set_static_file_compression(bool on) {
  11853. static_file_compression_ = on;
  11854. return *this;
  11855. }
  11856. inline Server &Server::set_static_file_compression_min_length(size_t length) {
  11857. static_file_compression_min_length_ = length;
  11858. return *this;
  11859. }
  11860. inline Server &Server::set_static_file_compression_max_length(size_t length) {
  11861. static_file_compression_max_length_ = length;
  11862. return *this;
  11863. }
  11864. inline Server &Server::set_websocket_max_missed_pongs(int count) {
  11865. websocket_max_missed_pongs_ = count;
  11866. return *this;
  11867. }
  11868. inline Server &Server::set_websocket_ping_interval(time_t sec) {
  11869. websocket_ping_interval_sec_ = sec;
  11870. return *this;
  11871. }
  11872. template <class Rep, class Period>
  11873. inline Server &Server::set_websocket_ping_interval(
  11874. const std::chrono::duration<Rep, Period> &duration) {
  11875. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11876. set_websocket_ping_interval(sec);
  11877. });
  11878. return *this;
  11879. }
  11880. inline bool Server::bind_to_port(const std::string &host, int port,
  11881. int socket_flags) {
  11882. auto ret = bind_internal(host, port, socket_flags);
  11883. if (ret == -1) { is_decommissioned = true; }
  11884. return ret >= 0;
  11885. }
  11886. inline int Server::bind_to_any_port(const std::string &host, int socket_flags) {
  11887. auto ret = bind_internal(host, 0, socket_flags);
  11888. if (ret == -1) { is_decommissioned = true; }
  11889. return ret;
  11890. }
  11891. inline bool Server::listen_after_bind() { return listen_internal(); }
  11892. inline bool Server::listen(const std::string &host, int port,
  11893. int socket_flags) {
  11894. return bind_to_port(host, port, socket_flags) && listen_internal();
  11895. }
  11896. inline bool Server::is_running() const { return is_running_; }
  11897. inline void Server::wait_until_ready() const {
  11898. while (!is_running_ && !is_decommissioned) {
  11899. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  11900. }
  11901. }
  11902. inline void Server::stop() noexcept {
  11903. // Release the listening socket whether or not the accept loop is running:
  11904. // bind_to_port() without listen_after_bind() still owns the descriptor. The
  11905. // exchange is what makes this safe to call concurrently with the accept loop.
  11906. socket_t sock = svr_sock_.exchange(INVALID_SOCKET);
  11907. if (sock != INVALID_SOCKET) {
  11908. detail::shutdown_socket(sock);
  11909. detail::close_socket(sock);
  11910. }
  11911. is_decommissioned = false;
  11912. }
  11913. inline void Server::decommission() { is_decommissioned = true; }
  11914. inline bool Server::parse_request_line(const char *s, Request &req) const {
  11915. auto len = strlen(s);
  11916. if (len < 2 || s[len - 2] != '\r' || s[len - 1] != '\n') { return false; }
  11917. len -= 2;
  11918. {
  11919. // RFC 9112 §3: exactly one SP between the method, the target and the
  11920. // version. Taking other whitespace as a separator too lets recipients
  11921. // that parse more strictly see a different request.
  11922. auto end = s + len;
  11923. if (std::count(s, end, ' ') != 2) { return false; }
  11924. auto sp1 = std::find(s, end, ' ');
  11925. auto sp2 = std::find(sp1 + 1, end, ' ');
  11926. if (sp1 == s || sp2 == sp1 + 1 || sp2 + 1 == end) { return false; }
  11927. req.method.assign(s, sp1);
  11928. req.target.assign(sp1 + 1, sp2);
  11929. req.version.assign(sp2 + 1, end);
  11930. }
  11931. // A method outside the built-in set is accepted only when a handler has been
  11932. // registered for it with CustomRoute().
  11933. const auto &methods = builtin_methods();
  11934. if (methods.find(req.method) == methods.end() &&
  11935. !find_custom_entry(req.method)) {
  11936. output_error_log(Error::InvalidHTTPMethod, &req);
  11937. return false;
  11938. }
  11939. if (req.version != "HTTP/1.1" && req.version != "HTTP/1.0") {
  11940. output_error_log(Error::InvalidHTTPVersion, &req);
  11941. return false;
  11942. }
  11943. // A request-target has no fragment (RFC 9112 §3.2), and one stripped here
  11944. // would leave this server routing a different path than a cache or a
  11945. // filter in front of it sees.
  11946. if (!detail::fields::is_request_target(req.target) ||
  11947. req.target.find('#') != std::string::npos) {
  11948. return false;
  11949. }
  11950. {
  11951. detail::divide(req.target, '?',
  11952. [&](const char *lhs_data, std::size_t lhs_size,
  11953. const char *rhs_data, std::size_t rhs_size) {
  11954. req.path =
  11955. decode_path_component(std::string(lhs_data, lhs_size));
  11956. detail::parse_query_text(rhs_data, rhs_size, req.params);
  11957. });
  11958. }
  11959. return true;
  11960. }
  11961. inline bool Server::write_response(Stream &strm, bool close_connection,
  11962. Request &req, Response &res) {
  11963. // NOTE: `req.ranges` should be empty, otherwise it will be applied
  11964. // incorrectly to the error content.
  11965. req.ranges.clear();
  11966. return write_response_core(strm, close_connection, req, res, false);
  11967. }
  11968. inline bool Server::write_response_with_content(Stream &strm,
  11969. bool close_connection,
  11970. const Request &req,
  11971. Response &res) {
  11972. return write_response_core(strm, close_connection, req, res, true);
  11973. }
  11974. inline bool Server::write_response_core(Stream &strm, bool close_connection,
  11975. const Request &req, Response &res,
  11976. bool need_apply_ranges) {
  11977. assert(res.status != -1);
  11978. if (400 <= res.status && error_handler_ &&
  11979. error_handler_(req, res) == HandlerResponse::Handled) {
  11980. need_apply_ranges = true;
  11981. }
  11982. // Before anything below reads res.headers, which the handlers may have
  11983. // filled directly
  11984. detail::erase_invalid_fields(res.headers);
  11985. if (!detail::body_allowed_for_status(res.status)) {
  11986. detail::clear_content(res);
  11987. }
  11988. detail::prefer_assigned_body(res);
  11989. std::string content_type;
  11990. std::string boundary;
  11991. if (need_apply_ranges) { apply_ranges(req, res, content_type, boundary); }
  11992. // Prepare additional headers
  11993. if (close_connection ||
  11994. detail::has_header_token(req.headers, "Connection", "close") ||
  11995. 400 <= res.status || // Don't leave connections open after errors
  11996. // The client withholds the body until `100 Continue`, which was never
  11997. // sent, so whether and when the body follows is unknown.
  11998. (req.expect_100_continue_pending_ && detail::has_framed_body(req)) ||
  11999. // The body was left partway, e.g. by a content receiver that returned
  12000. // false, so the rest of it cannot be told from the next request.
  12001. (req.body_read_started_ && !req.body_consumed_)) {
  12002. res.set_header("Connection", "close");
  12003. } else {
  12004. std::string s = "timeout=";
  12005. s += std::to_string(keep_alive_timeout_sec_);
  12006. if (keep_alive_max_count_ > 0) {
  12007. s += ", max=";
  12008. s += std::to_string(keep_alive_max_count_);
  12009. }
  12010. res.set_header("Keep-Alive", s);
  12011. }
  12012. if ((!res.body.empty() || res.content_length_ > 0 || res.content_provider_) &&
  12013. !res.has_header("Content-Type")) {
  12014. res.set_header("Content-Type", "text/plain");
  12015. }
  12016. detail::set_framing_headers(req, res, boundary, content_type);
  12017. if (req.method == "HEAD" && !res.has_header("Accept-Ranges")) {
  12018. res.set_header("Accept-Ranges", "bytes");
  12019. }
  12020. if (post_routing_handler_) {
  12021. post_routing_handler_(req, res);
  12022. detail::erase_invalid_fields(res.headers);
  12023. // Again, for a body or framing headers the handler changed.
  12024. detail::set_framing_headers(req, res, boundary, content_type);
  12025. }
  12026. // Response line and headers
  12027. detail::BufferStream bstrm;
  12028. if (!detail::write_response_line(bstrm, res.status)) { return false; }
  12029. if (header_writer_(bstrm, res.headers) <= 0) { return false; }
  12030. // Combine a small body with the headers so the whole response leaves in a
  12031. // single write. A large body is written on its own instead: a copy of it
  12032. // costs more than the extra write saves.
  12033. auto send_body =
  12034. req.method != "HEAD" && detail::body_allowed_for_status(res.status);
  12035. auto body_is_separate = false;
  12036. auto provider_done = false;
  12037. if (send_body && !res.body.empty() && !res.content_provider_) {
  12038. if (res.body.size() < CPPHTTPLIB_SEND_BUFSIZ) {
  12039. bstrm.write(res.body.data(), res.body.size());
  12040. } else {
  12041. body_is_separate = true;
  12042. }
  12043. } else if (send_body && res.content_provider_ &&
  12044. res.is_file_content_provider_ &&
  12045. res.content_length_ < CPPHTTPLIB_SEND_BUFSIZ) {
  12046. // A small file is read into the same buffer. Other providers may produce
  12047. // their data over time, so they are never held back.
  12048. if (!write_content_with_provider(bstrm, req, res, boundary, content_type)) {
  12049. return false;
  12050. }
  12051. provider_done = true;
  12052. }
  12053. // Log before writing to avoid race condition with client-side code that
  12054. // accesses logger-captured data immediately after receiving the response.
  12055. output_log(req, res);
  12056. // Flush buffer
  12057. auto &data = bstrm.get_buffer();
  12058. if (!detail::write_data(strm, data.data(), data.size())) { return false; }
  12059. if (body_is_separate) {
  12060. return detail::write_data(strm, res.body.data(), res.body.size());
  12061. }
  12062. // Streaming body
  12063. if (send_body && res.content_provider_) {
  12064. if (!provider_done &&
  12065. !write_content_with_provider(strm, req, res, boundary, content_type)) {
  12066. return false;
  12067. }
  12068. res.content_provider_success_ = true;
  12069. }
  12070. return true;
  12071. }
  12072. inline bool
  12073. Server::write_content_with_provider(Stream &strm, const Request &req,
  12074. Response &res, const std::string &boundary,
  12075. const std::string &content_type) {
  12076. auto is_shutting_down = [this]() {
  12077. return this->svr_sock_ == INVALID_SOCKET;
  12078. };
  12079. if (res.content_length_ > 0) {
  12080. if (!detail::is_partial_content(req, res)) {
  12081. return detail::write_content(strm, res.content_provider_, 0,
  12082. res.content_length_, is_shutting_down);
  12083. } else if (req.ranges.size() == 1) {
  12084. auto offset_and_length = detail::get_range_offset_and_length(
  12085. req.ranges[0], res.content_length_);
  12086. return detail::write_content(strm, res.content_provider_,
  12087. offset_and_length.first,
  12088. offset_and_length.second, is_shutting_down);
  12089. } else {
  12090. return detail::write_multipart_ranges_data(
  12091. strm, req, res, boundary, content_type, res.content_length_,
  12092. is_shutting_down);
  12093. }
  12094. } else {
  12095. if (res.is_chunked_content_provider_) {
  12096. // Use the coding `apply_ranges()` chose when it wrote the headers;
  12097. // re-negotiating here would disagree with them, e.g. once a handler's
  12098. // own Content-Encoding header suppresses the negotiation.
  12099. auto compressor = detail::make_compressor(res.content_coding_);
  12100. if (!compressor) {
  12101. compressor = detail::make_unique<detail::nocompressor>();
  12102. }
  12103. return detail::write_content_chunked(strm, res.content_provider_,
  12104. is_shutting_down, *compressor);
  12105. } else {
  12106. return detail::write_content_without_length(strm, res.content_provider_,
  12107. is_shutting_down);
  12108. }
  12109. }
  12110. }
  12111. inline bool Server::read_content(Stream &strm, Request &req, Response &res) {
  12112. FormFields::iterator cur_field;
  12113. FormFiles::iterator cur_file;
  12114. auto is_text_field = false;
  12115. size_t count = 0;
  12116. if (read_content_core(
  12117. strm, req, res,
  12118. // Regular
  12119. [&](const char *buf, size_t n) {
  12120. // Prevent arithmetic overflow when checking sizes.
  12121. // Avoid computing (req.body.size() + n) directly because
  12122. // adding two unsigned `size_t` values can wrap around and
  12123. // produce a small result instead of indicating overflow.
  12124. // Instead, check using subtraction: ensure `n` does not
  12125. // exceed the remaining capacity `max_size() - size()`.
  12126. if (req.body.size() >= req.body.max_size() ||
  12127. n > req.body.max_size() - req.body.size()) {
  12128. return false;
  12129. }
  12130. // Limit decompressed body size to payload_max_length_ to protect
  12131. // against "zip bomb" attacks where a small compressed payload
  12132. // decompresses to a massive size.
  12133. if (payload_max_length_ > 0 &&
  12134. (req.body.size() >= payload_max_length_ ||
  12135. n > payload_max_length_ - req.body.size())) {
  12136. return false;
  12137. }
  12138. req.body.append(buf, n);
  12139. return true;
  12140. },
  12141. // Multipart FormData
  12142. [&](const FormData &file) {
  12143. if (CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT > 0 &&
  12144. count++ == CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT) {
  12145. output_error_log(Error::TooManyFormDataFiles, &req);
  12146. return false;
  12147. }
  12148. if (file.filename.empty()) {
  12149. cur_field = req.form.fields.emplace(
  12150. file.name, FormField{file.name, file.content, file.headers});
  12151. is_text_field = true;
  12152. } else {
  12153. cur_file = req.form.files.emplace(file.name, file);
  12154. is_text_field = false;
  12155. }
  12156. return true;
  12157. },
  12158. [&](const char *buf, size_t n) {
  12159. if (is_text_field) {
  12160. auto &content = cur_field->second.content;
  12161. if (content.size() + n > content.max_size()) { return false; }
  12162. content.append(buf, n);
  12163. } else {
  12164. auto &content = cur_file->second.content;
  12165. if (content.size() + n > content.max_size()) { return false; }
  12166. content.append(buf, n);
  12167. }
  12168. return true;
  12169. })) {
  12170. const auto &content_type = req.get_header_value("Content-Type");
  12171. if (detail::case_ignore::equal(detail::extract_media_type(content_type),
  12172. "application/x-www-form-urlencoded")) {
  12173. if (CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH > 0 &&
  12174. req.body.size() > CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH) {
  12175. res.status = StatusCode::PayloadTooLarge_413; // NOTE: should be 414?
  12176. output_error_log(Error::ExceedMaxPayloadSize, &req);
  12177. return false;
  12178. }
  12179. detail::parse_query_text(req.body, req.params);
  12180. }
  12181. return true;
  12182. }
  12183. return false;
  12184. }
  12185. inline bool Server::read_content_with_content_receiver(
  12186. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  12187. FormDataHeader multipart_header, ContentReceiver multipart_receiver) {
  12188. return read_content_core(strm, req, res, std::move(receiver),
  12189. std::move(multipart_header),
  12190. std::move(multipart_receiver));
  12191. }
  12192. inline bool Server::read_content_core(
  12193. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  12194. FormDataHeader multipart_header, ContentReceiver multipart_receiver) const {
  12195. detail::FormDataParser multipart_form_data_parser;
  12196. ContentReceiverWithProgress out;
  12197. if (req.is_multipart_form_data()) {
  12198. const auto &content_type = req.get_header_value("Content-Type");
  12199. std::string boundary;
  12200. if (!detail::parse_multipart_boundary(content_type, boundary)) {
  12201. res.status = StatusCode::BadRequest_400;
  12202. output_error_log(Error::MultipartParsing, &req);
  12203. return false;
  12204. }
  12205. multipart_form_data_parser.set_boundary(std::move(boundary));
  12206. out = [&](const char *buf, size_t n, size_t /*off*/, size_t /*len*/) {
  12207. return multipart_form_data_parser.parse(buf, n, multipart_header,
  12208. multipart_receiver);
  12209. };
  12210. } else {
  12211. out = [receiver](const char *buf, size_t n, size_t /*off*/,
  12212. size_t /*len*/) { return receiver(buf, n); };
  12213. }
  12214. // RFC 9112 §6: no Transfer-Encoding and no Content-Length means no body.
  12215. if (!req.has_header("Content-Length") &&
  12216. !detail::is_chunked_transfer_encoding(req.headers)) {
  12217. return true;
  12218. }
  12219. // A second read would start where the first one stopped, or in the next
  12220. // request.
  12221. if (req.body_read_started_) { return false; }
  12222. // The client is waiting for this before it sends the body.
  12223. if (req.expect_100_continue_pending_) {
  12224. req.expect_100_continue_pending_ = false;
  12225. detail::write_response_line(strm, StatusCode::Continue_100);
  12226. strm.write("\r\n");
  12227. }
  12228. // Set before reading, since a receiver may also stop by throwing.
  12229. req.body_read_started_ = true;
  12230. if (!detail::read_content(strm, req, payload_max_length_, res.status, nullptr,
  12231. out, true)) {
  12232. return false;
  12233. }
  12234. req.body_consumed_ = true;
  12235. if (req.is_multipart_form_data()) {
  12236. if (!multipart_form_data_parser.is_valid()) {
  12237. res.status = StatusCode::BadRequest_400;
  12238. output_error_log(Error::MultipartParsing, &req);
  12239. return false;
  12240. }
  12241. }
  12242. return true;
  12243. }
  12244. inline bool Server::handle_file_request(Request &req, Response &res) {
  12245. if (!detail::is_valid_path(req.path)) { return false; }
  12246. for (const auto &entry : base_dirs_) {
  12247. // Prefix match, on a path segment boundary. A mount point of "/mount"
  12248. // covers "/mount" and "/mount/...", but must not swallow "/mountdir/...".
  12249. // One that already ends in '/' (the root mount among them) carries its own
  12250. // boundary; set_mount_point() guarantees the mount point is not empty.
  12251. if (!req.path.compare(0, entry.mount_point.size(), entry.mount_point) &&
  12252. (entry.mount_point.back() == '/' ||
  12253. req.path.size() == entry.mount_point.size() ||
  12254. req.path[entry.mount_point.size()] == '/')) {
  12255. std::string sub_path = "/" + req.path.substr(entry.mount_point.size());
  12256. auto path = entry.base_dir + sub_path;
  12257. if (path.back() == '/') { path += "index.html"; }
  12258. // Defense-in-depth: is_valid_path blocks ".." traversal in the URL,
  12259. // but symlinks/junctions can still escape the base directory. A path
  12260. // that cannot be resolved, which includes one that does not exist, is
  12261. // not served from here.
  12262. std::string resolved_path;
  12263. if (!detail::canonicalize_path(path.c_str(), resolved_path)) { continue; }
  12264. if (!detail::is_path_within_base(resolved_path,
  12265. entry.resolved_base_dir)) {
  12266. res.status = StatusCode::Forbidden_403;
  12267. return true;
  12268. }
  12269. detail::FileStat stat(path);
  12270. if (stat.is_dir()) {
  12271. // Relative, so "//dir" cannot name another host; "./" keeps a ':'
  12272. // in the name from reading as a scheme.
  12273. auto name = req.path.substr(req.path.rfind('/') + 1);
  12274. res.set_redirect("./" + encode_path_component(name) + "/",
  12275. StatusCode::MovedPermanently_301);
  12276. return true;
  12277. }
  12278. if (stat.is_file()) {
  12279. for (const auto &kv : entry.headers) {
  12280. res.set_header(kv.first, kv.second);
  12281. }
  12282. auto content_type = detail::find_content_type(
  12283. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  12284. auto encoding = detail::EncodingType::None;
  12285. if (static_file_compression_) {
  12286. encoding = static_file_encoding(req, res, content_type, stat.size());
  12287. }
  12288. // The ETag names the representation actually sent, so a client that
  12289. // cached the compressed form revalidates against the compressed ETag
  12290. // and still gets a 304, while one that took identity keeps the plain
  12291. // ETag.
  12292. auto etag = detail::compute_etag(
  12293. stat, encoding == detail::EncodingType::None
  12294. ? std::string()
  12295. : std::string("-") + detail::encoding_name(encoding));
  12296. if (!etag.empty()) { res.set_header("ETag", etag); }
  12297. auto mtime = stat.mtime();
  12298. auto last_modified = detail::file_mtime_to_http_date(mtime);
  12299. if (!last_modified.empty()) {
  12300. res.set_header("Last-Modified", last_modified);
  12301. }
  12302. if (check_if_not_modified(req, res, etag, mtime)) { return true; }
  12303. check_if_range(req, etag, mtime);
  12304. auto mm = std::make_shared<detail::mmap>(path.c_str());
  12305. if (!mm->is_open()) {
  12306. output_error_log(Error::OpenFile, &req);
  12307. return false;
  12308. }
  12309. detail::set_file_content_provider(res, mm, content_type, encoding);
  12310. if (req.method != "HEAD" && file_request_handler_) {
  12311. file_request_handler_(req, res);
  12312. }
  12313. return true;
  12314. } else {
  12315. output_error_log(Error::OpenFile, &req);
  12316. }
  12317. }
  12318. }
  12319. return false;
  12320. }
  12321. inline bool Server::check_if_not_modified(const Request &req, Response &res,
  12322. const std::string &etag,
  12323. time_t mtime) const {
  12324. // Handle conditional GET:
  12325. // 1. If-None-Match takes precedence (RFC 9110 Section 13.1.2)
  12326. // 2. If-Modified-Since is checked only when If-None-Match is absent
  12327. if (req.has_header("If-None-Match")) {
  12328. if (!etag.empty()) {
  12329. auto val =
  12330. detail::get_combined_header_value(req.headers, "If-None-Match");
  12331. // NOTE: We use exact string matching here. This works correctly
  12332. // because our server always generates weak ETags (W/"..."), and
  12333. // clients typically send back the same ETag they received.
  12334. // RFC 9110 Section 8.8.3.2 allows weak comparison for
  12335. // If-None-Match, where W/"x" and "x" would match, but this
  12336. // simplified implementation requires exact matches.
  12337. auto ret = detail::split_find(val.data(), val.data() + val.size(), ',',
  12338. [&](const char *b, const char *e) {
  12339. auto seg_len = static_cast<size_t>(e - b);
  12340. return (seg_len == 1 && *b == '*') ||
  12341. (seg_len == etag.size() &&
  12342. std::equal(b, e, etag.begin()));
  12343. });
  12344. if (ret) {
  12345. res.status = StatusCode::NotModified_304;
  12346. return true;
  12347. }
  12348. }
  12349. } else if (req.has_header("If-Modified-Since")) {
  12350. auto val = req.get_header_value("If-Modified-Since");
  12351. auto t = detail::parse_http_date(val);
  12352. if (t != static_cast<time_t>(-1) && mtime <= t) {
  12353. res.status = StatusCode::NotModified_304;
  12354. return true;
  12355. }
  12356. }
  12357. return false;
  12358. }
  12359. inline bool Server::check_if_range(Request &req, const std::string &etag,
  12360. time_t mtime) const {
  12361. // Handle If-Range for partial content requests (RFC 9110
  12362. // Section 13.1.5). If-Range is only evaluated when Range header is
  12363. // present. If the validator matches, serve partial content; otherwise
  12364. // serve full content.
  12365. if (!req.ranges.empty() && req.has_header("If-Range")) {
  12366. auto val = req.get_header_value("If-Range");
  12367. auto is_valid_range = [&]() {
  12368. if (detail::is_strong_etag(val)) {
  12369. // RFC 9110 Section 13.1.5: If-Range requires strong ETag
  12370. // comparison.
  12371. return (!etag.empty() && val == etag);
  12372. } else if (detail::is_weak_etag(val)) {
  12373. // Weak ETags are not valid for If-Range (RFC 9110 Section 13.1.5)
  12374. return false;
  12375. } else {
  12376. // HTTP-date comparison
  12377. auto t = detail::parse_http_date(val);
  12378. return (t != static_cast<time_t>(-1) && mtime <= t);
  12379. }
  12380. };
  12381. if (!is_valid_range()) {
  12382. // Validator doesn't match: ignore Range and serve full content
  12383. req.ranges.clear();
  12384. return false;
  12385. }
  12386. }
  12387. return true;
  12388. }
  12389. inline socket_t
  12390. Server::create_server_socket(const std::string &host, int port,
  12391. int socket_flags,
  12392. SocketOptions socket_options) const {
  12393. return detail::create_socket(
  12394. host, std::string(), port, address_family_, socket_flags, tcp_nodelay_,
  12395. ipv6_v6only_, std::move(socket_options),
  12396. [&](socket_t sock, struct addrinfo &ai, bool & /*quit*/) -> bool {
  12397. if (::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  12398. output_error_log(Error::BindIPAddress, nullptr);
  12399. return false;
  12400. }
  12401. if (::listen(sock, CPPHTTPLIB_LISTEN_BACKLOG)) {
  12402. output_error_log(Error::Listen, nullptr);
  12403. return false;
  12404. }
  12405. return true;
  12406. });
  12407. }
  12408. inline int Server::bind_internal(const std::string &host, int port,
  12409. int socket_flags) {
  12410. if (is_decommissioned) { return -1; }
  12411. if (!is_valid()) { return -1; }
  12412. svr_sock_ = create_server_socket(host, port, socket_flags, socket_options_);
  12413. if (svr_sock_ == INVALID_SOCKET) { return -1; }
  12414. if (port == 0) {
  12415. struct sockaddr_storage addr;
  12416. socklen_t addr_len = sizeof(addr);
  12417. if (getsockname(svr_sock_, reinterpret_cast<struct sockaddr *>(&addr),
  12418. &addr_len) == -1) {
  12419. output_error_log(Error::GetSockName, nullptr);
  12420. return -1;
  12421. }
  12422. if (addr.ss_family == AF_INET) {
  12423. return ntohs(reinterpret_cast<struct sockaddr_in *>(&addr)->sin_port);
  12424. } else if (addr.ss_family == AF_INET6) {
  12425. return ntohs(reinterpret_cast<struct sockaddr_in6 *>(&addr)->sin6_port);
  12426. } else {
  12427. output_error_log(Error::UnsupportedAddressFamily, nullptr);
  12428. return -1;
  12429. }
  12430. } else {
  12431. return port;
  12432. }
  12433. }
  12434. inline bool Server::listen_internal() {
  12435. // A stop() between bind and listen leaves nothing to accept on. Report
  12436. // failure instead of returning success without ever serving, and mark the
  12437. // server decommissioned the way any failed listen does so that a concurrent
  12438. // wait_until_ready() wakes up instead of spinning forever.
  12439. if (is_decommissioned || svr_sock_ == INVALID_SOCKET) {
  12440. is_decommissioned = true;
  12441. return false;
  12442. }
  12443. auto ret = true;
  12444. is_running_ = true;
  12445. auto se = detail::scope_exit([&]() { is_running_ = false; });
  12446. if (start_handler_) { start_handler_(); }
  12447. {
  12448. std::unique_ptr<TaskQueue> task_queue(new_task_queue());
  12449. while (svr_sock_ != INVALID_SOCKET) {
  12450. #ifndef _WIN32
  12451. if (idle_interval_sec_ > 0 || idle_interval_usec_ > 0) {
  12452. #endif
  12453. auto val = detail::select_read(svr_sock_, idle_interval_sec_,
  12454. idle_interval_usec_);
  12455. if (val == 0) { // Timeout
  12456. task_queue->on_idle();
  12457. continue;
  12458. }
  12459. #ifndef _WIN32
  12460. }
  12461. #endif
  12462. #if defined _WIN32
  12463. // sockets connected via WASAccept inherit flags NO_HANDLE_INHERIT,
  12464. // OVERLAPPED
  12465. socket_t sock = WSAAccept(svr_sock_, nullptr, nullptr, nullptr, 0);
  12466. #elif defined SOCK_CLOEXEC
  12467. socket_t sock = accept4(svr_sock_, nullptr, nullptr, SOCK_CLOEXEC);
  12468. #else
  12469. socket_t sock = accept(svr_sock_, nullptr, nullptr);
  12470. #endif
  12471. if (sock == INVALID_SOCKET) {
  12472. // NOTE: Winsock reports failures through WSAGetLastError() and never
  12473. // touches the CRT errno, so the two have to be asked platform by
  12474. // platform rather than by testing errno here.
  12475. if (detail::is_accept_resource_error()) {
  12476. // The per-process descriptor limit or the network stack's buffer
  12477. // space has been reached. Try to accept new connections after a
  12478. // short sleep.
  12479. std::this_thread::sleep_for(std::chrono::microseconds{1});
  12480. continue;
  12481. } else if (detail::is_accept_transient_error()) {
  12482. continue;
  12483. }
  12484. // Take the descriptor out of svr_sock_ before closing it: a later
  12485. // stop() would otherwise shutdown()/close() a value the OS may have
  12486. // reused, and keep_alive() watches svr_sock_ to notice the server is
  12487. // gone. The exchange also settles the race with a concurrent stop(),
  12488. // since whichever side takes the descriptor closes it exactly once.
  12489. auto listen_sock = svr_sock_.exchange(INVALID_SOCKET);
  12490. if (listen_sock != INVALID_SOCKET) {
  12491. detail::close_socket(listen_sock);
  12492. ret = false;
  12493. output_error_log(Error::Connection, nullptr);
  12494. } else {
  12495. ; // The server socket was closed by user.
  12496. }
  12497. break;
  12498. }
  12499. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO,
  12500. read_timeout_sec_, read_timeout_usec_);
  12501. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_SNDTIMEO,
  12502. write_timeout_sec_, write_timeout_usec_);
  12503. if (tcp_nodelay_) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  12504. if (!task_queue->enqueue(
  12505. [this, sock]() { process_and_close_socket(sock); })) {
  12506. output_error_log(Error::ResourceExhaustion, nullptr);
  12507. detail::shutdown_socket(sock);
  12508. detail::close_socket(sock);
  12509. }
  12510. }
  12511. task_queue->shutdown();
  12512. }
  12513. is_decommissioned = !ret;
  12514. return ret;
  12515. }
  12516. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  12517. // Call from a catch block. The response is a 500 unless the exception handler
  12518. // sets another status. Returns whether the exception handler ran.
  12519. inline bool Server::handle_exception(Request &req, Response &res) {
  12520. res.status = StatusCode::InternalServerError_500;
  12521. if (!exception_handler_) { return false; }
  12522. exception_handler_(req, res, std::current_exception());
  12523. return true;
  12524. }
  12525. #endif
  12526. inline bool Server::routing(Request &req, Response &res, Stream &strm,
  12527. bool skip_pre_routing) {
  12528. if (!skip_pre_routing && pre_routing_handler_ &&
  12529. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12530. return true;
  12531. }
  12532. // File handler
  12533. if ((req.method == "GET" || req.method == "HEAD") &&
  12534. handle_file_request(req, res)) {
  12535. return true;
  12536. }
  12537. const auto *custom = find_custom_entry(req.method);
  12538. // The second clause mirrors what expect_content() does unconditionally for
  12539. // POST/PUT/PATCH/DELETE: a content reader route fires even when the request
  12540. // carries no body. Without it a body-less PROPFIND (RFC 4918 treats one as
  12541. // `allprop`) would skip its handler and fall through to 404.
  12542. if (detail::expect_content(req) ||
  12543. (custom && !custom->handlers_for_content_reader.empty())) {
  12544. // Content reader handler
  12545. {
  12546. // Track whether the ContentReader was aborted due to the decompressed
  12547. // payload exceeding `payload_max_length_`.
  12548. // The user handler runs after the lambda returns, so we must restore the
  12549. // 413 status if the handler overwrites it.
  12550. bool content_reader_payload_too_large = false;
  12551. ContentReader reader(
  12552. [&](ContentReceiver receiver) {
  12553. auto result = read_content_with_content_receiver(
  12554. strm, req, res, std::move(receiver), nullptr, nullptr);
  12555. if (!result) {
  12556. output_error_log(Error::Read, &req);
  12557. if (res.status == StatusCode::PayloadTooLarge_413) {
  12558. content_reader_payload_too_large = true;
  12559. }
  12560. }
  12561. return result;
  12562. },
  12563. [&](FormDataHeader header, ContentReceiver receiver) {
  12564. auto result = read_content_with_content_receiver(
  12565. strm, req, res, nullptr, std::move(header),
  12566. std::move(receiver));
  12567. if (!result) {
  12568. output_error_log(Error::Read, &req);
  12569. if (res.status == StatusCode::PayloadTooLarge_413) {
  12570. content_reader_payload_too_large = true;
  12571. }
  12572. }
  12573. return result;
  12574. });
  12575. bool dispatched = false;
  12576. if (req.method == "POST") {
  12577. dispatched = dispatch_request_for_content_reader(
  12578. req, res, std::move(reader), post_handlers_for_content_reader_);
  12579. } else if (req.method == "PUT") {
  12580. dispatched = dispatch_request_for_content_reader(
  12581. req, res, std::move(reader), put_handlers_for_content_reader_);
  12582. } else if (req.method == "PATCH") {
  12583. dispatched = dispatch_request_for_content_reader(
  12584. req, res, std::move(reader), patch_handlers_for_content_reader_);
  12585. } else if (req.method == "DELETE") {
  12586. dispatched = dispatch_request_for_content_reader(
  12587. req, res, std::move(reader), delete_handlers_for_content_reader_);
  12588. } else if (custom) {
  12589. dispatched = dispatch_request_for_content_reader(
  12590. req, res, std::move(reader), custom->handlers_for_content_reader);
  12591. }
  12592. if (dispatched) {
  12593. if (content_reader_payload_too_large) {
  12594. // Enforce the limit: override any status the handler may have set
  12595. // and return false so the error path sends a plain 413 response.
  12596. res.status = StatusCode::PayloadTooLarge_413;
  12597. detail::clear_content(res);
  12598. return false;
  12599. }
  12600. return true;
  12601. }
  12602. }
  12603. // NOTE: `req.body` is not read here. For a regular handler the body is
  12604. // read inside dispatch_request(), after the route has matched and the
  12605. // pre-request handler has approved the request, so that a rejected
  12606. // request (e.g. failed authentication) never forces us to buffer a
  12607. // potentially large body.
  12608. }
  12609. // Regular handler
  12610. if (req.method == "GET" || req.method == "HEAD") {
  12611. return dispatch_request(req, res, get_handlers_, strm);
  12612. } else if (req.method == "POST") {
  12613. return dispatch_request(req, res, post_handlers_, strm);
  12614. } else if (req.method == "PUT") {
  12615. return dispatch_request(req, res, put_handlers_, strm);
  12616. } else if (req.method == "DELETE") {
  12617. return dispatch_request(req, res, delete_handlers_, strm);
  12618. } else if (req.method == "OPTIONS") {
  12619. return dispatch_request(req, res, options_handlers_, strm);
  12620. } else if (req.method == "PATCH") {
  12621. return dispatch_request(req, res, patch_handlers_, strm);
  12622. } else if (custom) {
  12623. return dispatch_request(req, res, custom->handlers, strm);
  12624. }
  12625. res.status = StatusCode::BadRequest_400;
  12626. return false;
  12627. }
  12628. inline bool Server::dispatch_request(Request &req, Response &res,
  12629. const Handlers &handlers, Stream &strm) {
  12630. for (const auto &x : handlers) {
  12631. const auto &matcher = x.first;
  12632. const auto &handler = x.second;
  12633. if (matcher->match(req)) {
  12634. req.matched_route = matcher->pattern();
  12635. // Run the pre-request handler before reading the body so a rejected
  12636. // request (e.g. failed authentication) never forces us to buffer a
  12637. // potentially large body. `req.matched_route` is available here.
  12638. if (pre_request_handler_ &&
  12639. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12640. return true;
  12641. }
  12642. // The route matched and the request was approved; read the body now.
  12643. if (detail::expect_content(req) && !read_content(strm, req, res)) {
  12644. output_error_log(Error::Read, &req);
  12645. return false;
  12646. }
  12647. handler(req, res);
  12648. return true;
  12649. }
  12650. }
  12651. return false;
  12652. }
  12653. // Decides the content coding for a response served straight from a file. Both
  12654. // the ETag, which has to name the representation actually sent, and
  12655. // `apply_static_file_compression()` go through this, so the two cannot drift
  12656. // apart.
  12657. inline detail::EncodingType
  12658. Server::static_file_encoding(const Request &req, const Response &res,
  12659. const std::string &content_type,
  12660. size_t length) const {
  12661. if (!static_file_compression_) { return detail::EncodingType::None; }
  12662. // Nothing to compress, and an empty file already answers with
  12663. // `Content-Length: 0`. Checked on its own so that a zero floor still cannot
  12664. // turn an empty body into a 20-byte gzip stream.
  12665. if (length == 0) { return detail::EncodingType::None; }
  12666. // A file that already fits in a single packet gains nothing from being made
  12667. // smaller, since it still travels in that one segment, and a file of a few
  12668. // bytes comes out larger than it went in.
  12669. if (length < static_file_compression_min_length_) {
  12670. return detail::EncodingType::None;
  12671. }
  12672. // RFC 9110 applies Range to the representation after content coding, so a
  12673. // compressed 206 would mean compressing the whole file and then slicing it.
  12674. // Serve ranges from the identity representation instead.
  12675. if (!req.ranges.empty()) { return detail::EncodingType::None; }
  12676. if (static_file_compression_max_length_ > 0 &&
  12677. length > static_file_compression_max_length_) {
  12678. return detail::EncodingType::None;
  12679. }
  12680. return detail::encoding_type(req, res, content_type);
  12681. }
  12682. // Compresses a file-backed content provider into `res.body`. Returns false when
  12683. // the response is left untouched.
  12684. inline bool Server::apply_static_file_compression(const Request &req,
  12685. Response &res) const {
  12686. auto type = res.content_coding_;
  12687. if (type == detail::EncodingType::None || !res.content_provider_) {
  12688. return false;
  12689. }
  12690. auto compressor = detail::make_compressor(type);
  12691. if (!compressor) { return false; }
  12692. output_pre_compression_log(req, res);
  12693. std::string compressed;
  12694. if (!detail::compress_content_provider(res.content_provider_,
  12695. res.content_length_, *compressor,
  12696. compressed)) {
  12697. return false;
  12698. }
  12699. res.body.swap(compressed);
  12700. // The provider was consumed in full, so its releaser hears about a success.
  12701. res.content_provider_success_ = true;
  12702. detail::clear_content_provider(res);
  12703. res.set_header("Content-Encoding", detail::encoding_name(type));
  12704. res.set_header("Vary", "Accept-Encoding");
  12705. return true;
  12706. }
  12707. inline void Server::apply_ranges(const Request &req, Response &res,
  12708. std::string &content_type,
  12709. std::string &boundary) const {
  12710. // A known-length content provider leaves `res.body` empty, so the compressor
  12711. // at the end of this function never runs for one (issue #2545). A file-backed
  12712. // provider is fully readable right here, so compress it and answer with an
  12713. // ordinary body: `Content-Length` and HEAD keep working, and the response
  12714. // takes the same path as `set_content()` from here on. Range requests never
  12715. // get a content coding, so `Content-Range` still names identity bytes and
  12716. // none of the range handling below applies.
  12717. if (apply_static_file_compression(req, res)) { return; }
  12718. if (req.ranges.size() > 1 && res.status == StatusCode::PartialContent_206) {
  12719. auto it = res.headers.find("Content-Type");
  12720. if (it != res.headers.end()) {
  12721. content_type = it->second;
  12722. res.headers.erase(it);
  12723. }
  12724. boundary = detail::make_multipart_data_boundary();
  12725. res.set_header("Content-Type",
  12726. "multipart/byteranges; boundary=" + boundary);
  12727. }
  12728. auto type =
  12729. compress_ ? detail::encoding_type(req, res) : detail::EncodingType::None;
  12730. if (res.body.empty()) {
  12731. if (res.content_length_ > 0 && req.ranges.size() == 1 &&
  12732. res.status == StatusCode::PartialContent_206) {
  12733. auto offset_and_length = detail::get_range_offset_and_length(
  12734. req.ranges[0], res.content_length_);
  12735. auto content_range = detail::make_content_range_header_field(
  12736. offset_and_length, res.content_length_);
  12737. res.set_header("Content-Range", content_range);
  12738. } else if (res.is_chunked_content_provider_) {
  12739. res.content_coding_ = type;
  12740. if (type != detail::EncodingType::None) {
  12741. res.set_header("Content-Encoding", detail::encoding_name(type));
  12742. res.set_header("Vary", "Accept-Encoding");
  12743. }
  12744. }
  12745. } else {
  12746. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12747. ;
  12748. } else if (req.ranges.size() == 1) {
  12749. auto offset_and_length =
  12750. detail::get_range_offset_and_length(req.ranges[0], res.body.size());
  12751. auto offset = offset_and_length.first;
  12752. auto length = offset_and_length.second;
  12753. auto content_range = detail::make_content_range_header_field(
  12754. offset_and_length, res.body.size());
  12755. res.set_header("Content-Range", content_range);
  12756. assert(offset + length <= res.body.size());
  12757. res.body = res.body.substr(offset, length);
  12758. } else {
  12759. std::string data;
  12760. detail::make_multipart_ranges_data(req, res, boundary, content_type,
  12761. res.body.size(), data);
  12762. res.body.swap(data);
  12763. }
  12764. if (type != detail::EncodingType::None) {
  12765. output_pre_compression_log(req, res);
  12766. if (auto compressor = detail::make_compressor(type)) {
  12767. std::string compressed;
  12768. if (compressor->compress(res.body.data(), res.body.size(), true,
  12769. [&](const char *data, size_t data_len) {
  12770. compressed.append(data, data_len);
  12771. return true;
  12772. })) {
  12773. res.body.swap(compressed);
  12774. res.set_header("Content-Encoding", detail::encoding_name(type));
  12775. res.set_header("Vary", "Accept-Encoding");
  12776. }
  12777. }
  12778. }
  12779. res.content_length_ = res.body.size();
  12780. }
  12781. }
  12782. inline bool Server::dispatch_request_for_content_reader(
  12783. Request &req, Response &res, ContentReader content_reader,
  12784. const HandlersForContentReader &handlers) const {
  12785. for (const auto &x : handlers) {
  12786. const auto &matcher = x.first;
  12787. const auto &handler = x.second;
  12788. if (matcher->match(req)) {
  12789. req.matched_route = matcher->pattern();
  12790. if (!pre_request_handler_ ||
  12791. pre_request_handler_(req, res) != HandlerResponse::Handled) {
  12792. handler(req, res, content_reader);
  12793. }
  12794. return true;
  12795. }
  12796. }
  12797. return false;
  12798. }
  12799. inline std::string
  12800. get_client_ip(const std::string &x_forwarded_for,
  12801. const std::vector<std::string> &trusted_proxies) {
  12802. // X-Forwarded-For is a comma-separated list per RFC 7239
  12803. std::vector<std::string> ip_list;
  12804. detail::split(x_forwarded_for.data(),
  12805. x_forwarded_for.data() + x_forwarded_for.size(), ',',
  12806. [&](const char *b, const char *e) {
  12807. auto r = detail::trim(b, e, 0, static_cast<size_t>(e - b));
  12808. ip_list.emplace_back(std::string(b + r.first, b + r.second));
  12809. });
  12810. // A malformed X-Forwarded-For (empty, comma-only, whitespace-only) yields
  12811. // no segments. Signal "no client IP derived" with an empty string so the
  12812. // caller can fall back to the connection-level remote address.
  12813. if (ip_list.empty()) { return std::string(); }
  12814. // Each hop appends the address it received the request from, so the rightmost
  12815. // entries are the ones written by our own infrastructure while the leftmost
  12816. // are whatever the original client chose to send. Walk from the right and
  12817. // skip trusted proxies; the first address that is not a trusted proxy is the
  12818. // furthest point still attributable to a real hop, i.e. the client. Scanning
  12819. // from the left instead lets a client forge an arbitrary address by following
  12820. // it with a trusted proxy's address, which the left-to-right scan then
  12821. // returned as the client.
  12822. for (size_t i = ip_list.size(); i-- > 0;) {
  12823. const auto &ip = ip_list[i];
  12824. if (!detail::is_trusted_proxy(ip, trusted_proxies)) { return ip; }
  12825. }
  12826. // Every hop was a trusted proxy; fall back to the first entry.
  12827. return ip_list.front();
  12828. }
  12829. inline bool
  12830. Server::process_request(Stream &strm, const std::string &remote_addr,
  12831. int remote_port, const std::string &local_addr,
  12832. int local_port, bool close_connection,
  12833. bool &connection_closed,
  12834. const std::function<void(Request &)> &setup_request,
  12835. bool *websocket_upgraded) {
  12836. std::array<char, 2048> buf{};
  12837. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12838. // The read timeout bounds the request line and headers as a whole, so a
  12839. // client sending them a byte at a time cannot hold the worker any longer.
  12840. auto read_timeout_msec = read_timeout_sec_ * 1000 + read_timeout_usec_ / 1000;
  12841. strm.set_max_timeout(read_timeout_msec);
  12842. // Connection has been closed on client
  12843. if (!line_reader.getline()) { return false; }
  12844. // RFC 9112 2.2: ignore an empty line received before the request-line. Some
  12845. // clients send an extra CRLF after a request body, which would otherwise be
  12846. // parsed as the next request on a persistent connection.
  12847. if (strcmp(line_reader.ptr(), "\r\n") == 0 && !line_reader.getline()) {
  12848. return false;
  12849. }
  12850. Request req;
  12851. req.start_time_ = std::chrono::steady_clock::now();
  12852. req.remote_addr = remote_addr;
  12853. req.remote_port = remote_port;
  12854. req.local_addr = local_addr;
  12855. req.local_port = local_port;
  12856. Response res;
  12857. res.version = "HTTP/1.1";
  12858. res.headers = default_headers_;
  12859. // RFC 9112 §9.6: a server that sends the "close" connection option must
  12860. // close the connection after that response, whichever path wrote it (an
  12861. // error status, a handler, or a rejected request). Reading on would also
  12862. // parse whatever the client sent next on a connection it considers done.
  12863. auto honor_connection_close = detail::scope_exit([&] {
  12864. if (detail::has_header_token(res.headers, "Connection", "close")) {
  12865. connection_closed = true;
  12866. }
  12867. });
  12868. // Request line and headers. A rejected message leaves the rest of it (and
  12869. // any body) unread, so the connection cannot be reused: the leftover bytes
  12870. // would be parsed as the next request.
  12871. if (!parse_request_line(line_reader.ptr(), req)) {
  12872. connection_closed = true;
  12873. res.status = StatusCode::BadRequest_400;
  12874. output_error_log(Error::InvalidRequestLine, &req);
  12875. return write_response(strm, close_connection, req, res);
  12876. }
  12877. // Request headers
  12878. if (!detail::read_headers(strm, req.headers)) {
  12879. connection_closed = true;
  12880. res.status = StatusCode::BadRequest_400;
  12881. output_error_log(Error::InvalidHeaders, &req);
  12882. return write_response(strm, close_connection, req, res);
  12883. }
  12884. strm.set_max_timeout(0);
  12885. // RFC 9112 §6.3: Reject requests whose framing is invalid or ambiguous,
  12886. // which would otherwise let an intermediary and this parser disagree on
  12887. // where the body ends and enable request smuggling. Three cases: a
  12888. // Content-Length that is not a valid decimal length (e.g. "42, 42", "+42"
  12889. // or empty), which would otherwise be read as "no body"; a non-zero
  12890. // Content-Length alongside any Transfer-Encoding (Content-Length: 0 is
  12891. // tolerated for compatibility with existing clients); and a
  12892. // Transfer-Encoding whose final coding is not chunked, which leaves the body
  12893. // length undeterminable. None of them may fall through to the "no body"
  12894. // path, or the body bytes are parsed as the next request on a persistent
  12895. // connection.
  12896. auto is_invalid_content_length = false;
  12897. detail::get_header_value_u64(req.headers, "Content-Length", 0, 0,
  12898. is_invalid_content_length);
  12899. if (is_invalid_content_length ||
  12900. detail::has_conflicting_content_length(req.headers) ||
  12901. (req.has_header("Transfer-Encoding") &&
  12902. !detail::is_chunked_transfer_encoding(req.headers))) {
  12903. connection_closed = true;
  12904. res.status = StatusCode::BadRequest_400;
  12905. return write_response(strm, close_connection, req, res);
  12906. }
  12907. // RFC 9112 6.1: a lone "chunked" is the only transfer coding implemented
  12908. if (req.has_header("Transfer-Encoding") &&
  12909. (req.get_header_value_count("Transfer-Encoding") != 1 ||
  12910. !detail::case_ignore::equal(req.get_header_value("Transfer-Encoding"),
  12911. "chunked"))) {
  12912. connection_closed = true;
  12913. res.status = StatusCode::NotImplemented_501;
  12914. return write_response(strm, close_connection, req, res);
  12915. }
  12916. // RFC 9112 §6.1: a Transfer-Encoding alongside a Content-Length, or in an
  12917. // HTTP/1.0 request, is honoured, but the connection closes after the
  12918. // response.
  12919. if (detail::has_faulty_transfer_encoding(req)) { connection_closed = true; }
  12920. // RFC 9112 §3.2: Reject more than one Host field line, an invalid Host
  12921. // value, or none in HTTP/1.1, so that every recipient of the request sees
  12922. // the same authority.
  12923. auto host_count = req.get_header_value_count("Host");
  12924. if (host_count > 1 || (host_count == 0 && req.version == "HTTP/1.1") ||
  12925. !detail::fields::is_host(req.get_header_value("Host"))) {
  12926. connection_closed = true;
  12927. res.status = StatusCode::BadRequest_400;
  12928. output_error_log(Error::InvalidHeaders, &req);
  12929. return write_response(strm, close_connection, req, res);
  12930. }
  12931. // Check if the request URI doesn't exceed the limit
  12932. if (req.target.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  12933. connection_closed = true;
  12934. res.status = StatusCode::UriTooLong_414;
  12935. output_error_log(Error::ExceedUriMaxLength, &req);
  12936. return write_response(strm, close_connection, req, res);
  12937. }
  12938. if (detail::has_header_token(req.headers, "Connection", "close")) {
  12939. connection_closed = true;
  12940. }
  12941. if (req.version == "HTTP/1.0" &&
  12942. !detail::has_header_token(req.headers, "Connection", "keep-alive")) {
  12943. connection_closed = true;
  12944. }
  12945. // Only honor X-Forwarded-For if the peer on the actual TCP connection is
  12946. // itself a trusted proxy. Otherwise any direct client could spoof
  12947. // remote_addr simply by sending an arbitrary X-Forwarded-For header.
  12948. if (detail::is_trusted_proxy(remote_addr, trusted_proxies_) &&
  12949. req.has_header("X-Forwarded-For")) {
  12950. // Some proxies append the address they observed as a separate
  12951. // X-Forwarded-For field line instead of extending the one the client sent
  12952. // (e.g. HAProxy's "option forwardfor"), so the whole combined value has to
  12953. // be scanned. Reading only the first occurrence would hand back the
  12954. // client-supplied, and therefore forgeable, value.
  12955. auto x_forwarded_for =
  12956. detail::get_combined_header_value(req.headers, "X-Forwarded-For");
  12957. auto derived = get_client_ip(x_forwarded_for, trusted_proxies_);
  12958. req.remote_addr = derived.empty() ? remote_addr : derived;
  12959. } else {
  12960. req.remote_addr = remote_addr;
  12961. }
  12962. req.remote_port = remote_port;
  12963. req.local_addr = local_addr;
  12964. req.local_port = local_port;
  12965. if (req.has_header("Accept")) {
  12966. auto accept_header =
  12967. detail::get_combined_header_value(req.headers, "Accept");
  12968. if (!detail::parse_accept_header(accept_header, req.accept_content_types)) {
  12969. connection_closed = true;
  12970. res.status = StatusCode::BadRequest_400;
  12971. output_error_log(Error::HTTPParsing, &req);
  12972. return write_response(strm, close_connection, req, res);
  12973. }
  12974. }
  12975. // RFC 9110 14.2: range handling is defined only for GET (and so for HEAD)
  12976. if ((req.method == "GET" || req.method == "HEAD") &&
  12977. req.has_header("Range")) {
  12978. const auto &range_header_value = req.get_header_value("Range");
  12979. if (!detail::parse_range_header(range_header_value, req.ranges)) {
  12980. connection_closed = true;
  12981. res.status = StatusCode::RangeNotSatisfiable_416;
  12982. output_error_log(Error::InvalidRangeHeader, &req);
  12983. return write_response(strm, close_connection, req, res);
  12984. }
  12985. }
  12986. if (setup_request) { setup_request(req); }
  12987. // RFC 9110 10.1.1: Expect is a comma-separated list whose value is
  12988. // case-insensitive, and a 100-continue expectation in an HTTP/1.0 request
  12989. // must be ignored. An expectation we do not recognize is left alone; the
  12990. // 417 the section allows for one is a MAY, not a requirement.
  12991. //
  12992. // `100 Continue` itself is deferred until the body is actually read (see
  12993. // read_content_core), so a request rejected by a later handler never
  12994. // invites the client to send a body nobody will read.
  12995. if (req.version != "HTTP/1.0" &&
  12996. detail::has_header_token(req.headers, "Expect", "100-continue")) {
  12997. int status = StatusCode::Continue_100;
  12998. if (expect_100_continue_handler_) {
  12999. status = expect_100_continue_handler_(req, res);
  13000. }
  13001. if (status == StatusCode::Continue_100) {
  13002. req.expect_100_continue_pending_ = true;
  13003. } else {
  13004. if (res.status == -1) { res.status = status; }
  13005. connection_closed = true;
  13006. return write_response(strm, true, req, res);
  13007. }
  13008. }
  13009. // Setup `is_connection_closed` method
  13010. auto sock = strm.socket();
  13011. req.is_connection_closed = [sock]() {
  13012. return !detail::is_socket_alive(sock);
  13013. };
  13014. // WebSocket upgrade
  13015. // Run pre_routing_handler_ and pre_request_handler_ before upgrading so
  13016. // that authentication and other middleware can reject the request with an
  13017. // HTTP response (e.g., 401) before the protocol switches.
  13018. // The response says so when this connection closes after it.
  13019. auto close_after_response = close_connection || connection_closed;
  13020. // An upgrade request has been through pre-routing before it reaches routing()
  13021. auto is_upgrade = detail::is_websocket_upgrade(req);
  13022. if (is_upgrade) {
  13023. // A response given here leaves the body unread, and it would be parsed as
  13024. // the next request.
  13025. auto close_if_answered =
  13026. close_after_response || detail::has_framed_body(req);
  13027. const WebSocketHandlerEntry *ws_route = nullptr;
  13028. std::string selected_subprotocol;
  13029. auto answer_before_upgrade = [&]() -> bool {
  13030. if (pre_routing_handler_ &&
  13031. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  13032. return true;
  13033. }
  13034. for (const auto &entry : websocket_handlers_) {
  13035. if (!entry.matcher->match(req)) { continue; }
  13036. req.matched_route = entry.matcher->pattern();
  13037. if (pre_request_handler_ &&
  13038. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  13039. return true;
  13040. }
  13041. ws_route = &entry;
  13042. if (entry.sub_protocol_selector) {
  13043. auto protocol_header = detail::get_combined_header_value(
  13044. req.headers, "Sec-WebSocket-Protocol");
  13045. if (!protocol_header.empty()) {
  13046. std::vector<std::string> protocols;
  13047. detail::split(protocol_header.data(),
  13048. protocol_header.data() + protocol_header.size(), ',',
  13049. [&](const char *b, const char *e) {
  13050. protocols.emplace_back(b, e);
  13051. });
  13052. selected_subprotocol = entry.sub_protocol_selector(protocols);
  13053. // Ignore a selection the client did not offer (RFC 6455 4.2.2)
  13054. if (std::find(protocols.begin(), protocols.end(),
  13055. selected_subprotocol) == protocols.end()) {
  13056. selected_subprotocol.clear();
  13057. }
  13058. }
  13059. }
  13060. return false;
  13061. }
  13062. return false;
  13063. };
  13064. auto answered = false;
  13065. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  13066. answered = answer_before_upgrade();
  13067. #else
  13068. try {
  13069. answered = answer_before_upgrade();
  13070. } catch (...) {
  13071. if (!handle_exception(req, res)) {
  13072. return write_response(strm, close_if_answered, req, res);
  13073. }
  13074. answered = true;
  13075. }
  13076. #endif
  13077. if (answered) {
  13078. if (res.status == -1) { res.status = StatusCode::OK_200; }
  13079. return write_response_with_content(strm, close_if_answered, req, res);
  13080. }
  13081. if (ws_route) {
  13082. auto client_key = req.get_header_value("Sec-WebSocket-Key");
  13083. auto accept_key = detail::websocket_accept_key(client_key);
  13084. // Send 101 Switching Protocols
  13085. std::string handshake_response = "HTTP/1.1 101 Switching Protocols\r\n"
  13086. "Upgrade: websocket\r\n"
  13087. "Connection: Upgrade\r\n"
  13088. "Sec-WebSocket-Accept: " +
  13089. accept_key + "\r\n";
  13090. if (!selected_subprotocol.empty()) {
  13091. if (!detail::fields::is_field_value(selected_subprotocol)) {
  13092. return false;
  13093. }
  13094. handshake_response +=
  13095. "Sec-WebSocket-Protocol: " + selected_subprotocol + "\r\n";
  13096. }
  13097. handshake_response += "\r\n";
  13098. if (strm.write(handshake_response.data(), handshake_response.size()) <
  13099. 0) {
  13100. return false;
  13101. }
  13102. connection_closed = true;
  13103. if (websocket_upgraded) { *websocket_upgraded = true; }
  13104. #ifdef CPPHTTPLIB_SSL_ENABLED
  13105. if (req.ssl) {
  13106. // wss: the heartbeat ping thread and the read path enter the same
  13107. // TLS session from different threads. Hand the WebSocket a stream
  13108. // that serializes every TLS call, so the shared SSLSocketStream on
  13109. // the plain HTTP/HTTPS paths stays untouched.
  13110. auto ws_strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  13111. strm.socket(), const_cast<tls::session_t>(req.ssl),
  13112. CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0,
  13113. write_timeout_sec_, write_timeout_usec_));
  13114. ws::WebSocket ws(std::move(ws_strm), req, true,
  13115. websocket_ping_interval_sec_,
  13116. websocket_max_missed_pongs_);
  13117. ws_route->handler(req, ws);
  13118. return true;
  13119. }
  13120. #endif
  13121. // Use WebSocket-specific read timeout instead of HTTP timeout
  13122. strm.set_read_timeout(CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0);
  13123. ws::WebSocket ws(strm, req, true, websocket_ping_interval_sec_,
  13124. websocket_max_missed_pongs_);
  13125. ws_route->handler(req, ws);
  13126. return true;
  13127. }
  13128. // No WebSocket route: route it as a plain HTTP request
  13129. }
  13130. // Routing
  13131. auto routed = false;
  13132. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  13133. routed = routing(req, res, strm, is_upgrade);
  13134. #else
  13135. try {
  13136. routed = routing(req, res, strm, is_upgrade);
  13137. } catch (...) { routed = handle_exception(req, res); }
  13138. #endif
  13139. auto ret = false;
  13140. if (routed) {
  13141. if (res.status == -1) {
  13142. res.status = req.ranges.empty() ? StatusCode::OK_200
  13143. : StatusCode::PartialContent_206;
  13144. }
  13145. // Before the Range checks below, so they see the body's own length.
  13146. detail::prefer_assigned_body(res);
  13147. // Serve file content by using a content provider
  13148. auto file_open_error = false;
  13149. if (!res.file_content_path_.empty()) {
  13150. const auto &path = res.file_content_path_;
  13151. auto mm = std::make_shared<detail::mmap>(path.c_str());
  13152. if (!mm->is_open()) {
  13153. res.status = StatusCode::NotFound_404;
  13154. output_error_log(Error::OpenFile, &req);
  13155. file_open_error = true;
  13156. } else {
  13157. auto content_type = res.file_content_content_type_;
  13158. if (content_type.empty()) {
  13159. // One the handler set after set_file_content()
  13160. content_type = res.get_header_value("Content-Type");
  13161. }
  13162. if (content_type.empty()) {
  13163. content_type = detail::find_content_type(
  13164. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  13165. }
  13166. detail::set_file_content_provider(
  13167. res, mm, content_type,
  13168. static_file_encoding(req, res, content_type, mm->size()));
  13169. }
  13170. }
  13171. if (file_open_error) {
  13172. ret = write_response(strm, close_after_response, req, res);
  13173. } else if (detail::range_error(req, res)) {
  13174. detail::clear_content(res);
  13175. res.status = StatusCode::RangeNotSatisfiable_416;
  13176. ret = write_response(strm, close_after_response, req, res);
  13177. } else {
  13178. ret = write_response_with_content(strm, close_after_response, req, res);
  13179. }
  13180. } else {
  13181. if (res.status == -1) { res.status = StatusCode::NotFound_404; }
  13182. ret = write_response(strm, close_after_response, req, res);
  13183. }
  13184. // Drain any unconsumed framed body to prevent request smuggling on
  13185. // keep-alive. Without framing there is no body to drain — reading would
  13186. // consume the next request (issue #2450). If the response has committed the
  13187. // connection to close, there is no next request to protect. A body read in
  13188. // part cannot be drained from where it stopped, so the connection closes,
  13189. // as it does when the body is longer than the drain limit or does not
  13190. // arrive within the read timeout.
  13191. if (!req.body_consumed_ && detail::has_framed_body(req) &&
  13192. !detail::has_header_token(res.headers, "Connection", "close")) {
  13193. strm.set_max_timeout(read_timeout_msec);
  13194. int dummy_status;
  13195. if (req.body_read_started_ ||
  13196. !detail::read_content(
  13197. strm, req, CPPHTTPLIB_UNREAD_PAYLOAD_MAX_LENGTH, dummy_status,
  13198. nullptr, [](const char *, size_t, size_t, size_t) { return true; },
  13199. false)) {
  13200. connection_closed = true;
  13201. }
  13202. }
  13203. return ret;
  13204. }
  13205. inline bool Server::is_valid() const { return !has_invalid_registration_; }
  13206. inline bool Server::process_and_close_socket(socket_t sock) {
  13207. std::string remote_addr;
  13208. int remote_port = 0;
  13209. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  13210. std::string local_addr;
  13211. int local_port = 0;
  13212. detail::get_local_ip_and_port(sock, local_addr, local_port);
  13213. bool websocket_upgraded = false;
  13214. auto ret = serve_guarded([&]() {
  13215. return detail::process_server_socket(
  13216. svr_sock_, sock, keep_alive_max_count_, keep_alive_timeout_sec_,
  13217. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13218. write_timeout_usec_,
  13219. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  13220. return process_request(strm, remote_addr, remote_port, local_addr,
  13221. local_port, close_connection,
  13222. connection_closed, nullptr,
  13223. &websocket_upgraded);
  13224. });
  13225. });
  13226. detail::drain_and_close_socket(sock);
  13227. return ret;
  13228. }
  13229. inline void Server::output_log(const Request &req, const Response &res) const {
  13230. if (logger_) {
  13231. std::lock_guard<std::mutex> guard(logger_mutex_);
  13232. logger_(req, res);
  13233. }
  13234. }
  13235. inline void Server::output_pre_compression_log(const Request &req,
  13236. const Response &res) const {
  13237. if (pre_compression_logger_) {
  13238. std::lock_guard<std::mutex> guard(logger_mutex_);
  13239. pre_compression_logger_(req, res);
  13240. }
  13241. }
  13242. inline void Server::output_error_log(const Error &err,
  13243. const Request *req) const {
  13244. if (error_logger_) {
  13245. std::lock_guard<std::mutex> guard(logger_mutex_);
  13246. error_logger_(err, req);
  13247. }
  13248. }
  13249. /*
  13250. * Group 5: ClientImpl and Client (Universal) implementation
  13251. */
  13252. // HTTP client implementation
  13253. inline ClientImpl::ClientImpl(const std::string &host)
  13254. : ClientImpl(host, 80, std::string(), std::string()) {}
  13255. inline ClientImpl::ClientImpl(const std::string &host, int port)
  13256. : ClientImpl(host, port, std::string(), std::string()) {}
  13257. inline ClientImpl::ClientImpl(const std::string &host, int port,
  13258. const std::string &client_cert_path,
  13259. const std::string &client_key_path)
  13260. : host_(detail::escape_abstract_namespace_unix_domain(host)), port_(port),
  13261. client_cert_path_(client_cert_path), client_key_path_(client_key_path) {}
  13262. inline ClientImpl::~ClientImpl() {
  13263. // Wait until all the requests in flight are handled.
  13264. size_t retry_count = 10;
  13265. while (retry_count-- > 0) {
  13266. {
  13267. std::lock_guard<std::mutex> guard(socket_mutex_);
  13268. if (socket_requests_in_flight_ == 0) { break; }
  13269. }
  13270. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  13271. }
  13272. std::lock_guard<std::mutex> guard(socket_mutex_);
  13273. shutdown_socket(socket_);
  13274. close_socket(socket_);
  13275. }
  13276. inline bool ClientImpl::is_valid() const { return true; }
  13277. inline bool
  13278. ClientImpl::is_proxy_enabled_for_host(const std::string &host) const {
  13279. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  13280. if (no_proxy_entries_.empty()) { return true; }
  13281. // host_ is const so its normalized form is invariant; cache it. The
  13282. // cross-host path (setup_redirect_client passing next_host) re-normalizes.
  13283. if (host == host_) {
  13284. if (!host_normalized_valid_) {
  13285. host_normalized_ = detail::normalize_target(host_);
  13286. host_normalized_valid_ = true;
  13287. }
  13288. return !detail::host_matches_no_proxy(host_normalized_, no_proxy_entries_);
  13289. }
  13290. auto target = detail::normalize_target(host);
  13291. return !detail::host_matches_no_proxy(target, no_proxy_entries_);
  13292. }
  13293. inline socket_t ClientImpl::create_client_socket(Error &error) const {
  13294. if (is_proxy_enabled_for_host(host_)) {
  13295. return detail::create_client_socket(
  13296. proxy_host_, std::string(), proxy_port_, address_family_, tcp_nodelay_,
  13297. ipv6_v6only_, socket_options_, connection_timeout_sec_,
  13298. connection_timeout_usec_, read_timeout_sec_, read_timeout_usec_,
  13299. write_timeout_sec_, write_timeout_usec_, interface_, error);
  13300. }
  13301. // Check is custom IP or hostname specified for host_
  13302. std::string connect_host;
  13303. std::string ip;
  13304. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  13305. return detail::create_client_socket(
  13306. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  13307. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  13308. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13309. write_timeout_usec_, interface_, error);
  13310. }
  13311. inline bool ClientImpl::create_and_connect_socket(Socket &socket,
  13312. Error &error) {
  13313. auto sock = create_client_socket(error);
  13314. if (sock == INVALID_SOCKET) { return false; }
  13315. socket.sock = sock;
  13316. return true;
  13317. }
  13318. inline bool ClientImpl::ensure_socket_connection(Socket &socket, Error &error) {
  13319. socket_tls_settings_version_ = tls_settings_version_;
  13320. return create_and_connect_socket(socket, error);
  13321. }
  13322. inline bool ClientImpl::setup_proxy_connection(
  13323. Socket & /*socket*/,
  13324. std::chrono::time_point<std::chrono::steady_clock> /*start_time*/,
  13325. Response & /*res*/, bool & /*success*/, Error & /*error*/) {
  13326. return true;
  13327. }
  13328. inline void ClientImpl::shutdown_ssl(Socket & /*socket*/,
  13329. bool /*shutdown_gracefully*/) {
  13330. // If there are any requests in flight from threads other than us, then it's
  13331. // a thread-unsafe race because individual ssl* objects are not thread-safe.
  13332. assert(socket_requests_in_flight_ == 0 ||
  13333. socket_requests_are_from_thread_ == std::this_thread::get_id());
  13334. }
  13335. inline void ClientImpl::shutdown_socket(Socket &socket) const {
  13336. if (socket.sock == INVALID_SOCKET) { return; }
  13337. detail::shutdown_socket(socket.sock);
  13338. }
  13339. inline void ClientImpl::close_socket(Socket &socket) {
  13340. // If there are requests in flight in another thread, usually closing
  13341. // the socket will be fine and they will simply receive an error when
  13342. // using the closed socket, but it is still a bug since rarely the OS
  13343. // may reassign the socket id to be used for a new socket, and then
  13344. // suddenly they will be operating on a live socket that is different
  13345. // than the one they intended!
  13346. assert(socket_requests_in_flight_ == 0 ||
  13347. socket_requests_are_from_thread_ == std::this_thread::get_id());
  13348. // It is also a bug if this happens while SSL is still active
  13349. #ifdef CPPHTTPLIB_SSL_ENABLED
  13350. assert(socket.ssl == nullptr);
  13351. #endif
  13352. if (socket.sock == INVALID_SOCKET) { return; }
  13353. detail::close_socket(socket.sock);
  13354. socket.sock = INVALID_SOCKET;
  13355. }
  13356. inline void ClientImpl::disconnect(bool gracefully) {
  13357. shutdown_ssl(socket_, gracefully);
  13358. shutdown_socket(socket_);
  13359. close_socket(socket_);
  13360. }
  13361. inline bool ClientImpl::socket_reusable() {
  13362. if (!socket_.is_open()) { return false; }
  13363. auto is_alive = detail::is_socket_alive(socket_.sock);
  13364. #ifdef CPPHTTPLIB_SSL_ENABLED
  13365. if (is_alive && is_ssl() && tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13366. is_alive = false;
  13367. }
  13368. #endif
  13369. if (!is_alive) {
  13370. // Peer seems gone — non-graceful shutdown to avoid SIGPIPE.
  13371. disconnect(/*gracefully=*/false);
  13372. return false;
  13373. }
  13374. if (is_ssl() && socket_tls_settings_version_ != tls_settings_version_) {
  13375. disconnect(/*gracefully=*/true);
  13376. return false;
  13377. }
  13378. return true;
  13379. }
  13380. inline bool ClientImpl::read_response_line(Stream &strm, const Request &req,
  13381. Response &res,
  13382. bool skip_100_continue) const {
  13383. std::array<char, 2048> buf{};
  13384. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  13385. if (!line_reader.getline()) { return false; }
  13386. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  13387. res.reason)) {
  13388. return req.method == "CONNECT";
  13389. }
  13390. // Skip interim (1xx) responses along with their header fields, except a 100
  13391. // Continue the caller handles itself for Expect: 100-continue. 101 ends
  13392. // HTTP on the connection, so it is final. A server sending them without end
  13393. // would hold the client, so there may be only so many.
  13394. size_t interim_count = 0;
  13395. while (100 <= res.status && res.status < 200 &&
  13396. res.status != StatusCode::SwitchingProtocol_101 &&
  13397. (skip_100_continue || res.status != StatusCode::Continue_100)) {
  13398. if (++interim_count > CPPHTTPLIB_INTERIM_RESPONSE_MAX_COUNT) {
  13399. return false;
  13400. }
  13401. Headers interim_headers;
  13402. if (!detail::read_headers(strm, interim_headers)) { return false; }
  13403. if (!line_reader.getline()) { return false; } // next response line
  13404. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  13405. res.reason)) {
  13406. return false;
  13407. }
  13408. }
  13409. return true;
  13410. }
  13411. inline bool ClientImpl::send(Request &req, Response &res, Error &error) {
  13412. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  13413. // A same-origin redirect and a digest retry send through here again. Only
  13414. // the call the caller made reports a failure, once, with its request.
  13415. auto outermost = send_depth_++ == 0;
  13416. auto se = detail::scope_exit([&] { send_depth_--; });
  13417. if (outermost) { error = Error::Success; }
  13418. auto ret = send_(req, res, error);
  13419. if (error == Error::SSLPeerCouldBeClosed_) {
  13420. assert(!ret);
  13421. ret = send_(req, res, error);
  13422. // If still failing with SSLPeerCouldBeClosed_, convert to Read error
  13423. if (error == Error::SSLPeerCouldBeClosed_) { error = Error::Read; }
  13424. }
  13425. // Also an answer that carries an error, such as a proxy's 407
  13426. if (outermost && error != Error::Success) { output_error_log(error, &req); }
  13427. return ret;
  13428. }
  13429. inline bool ClientImpl::send_(Request &req, Response &res, Error &error) {
  13430. #ifdef CPPHTTPLIB_SSL_ENABLED
  13431. // Don't let an earlier attempt's TLS error show up in this one's Result. A
  13432. // client that failed to set up its TLS context keeps reporting why.
  13433. if (is_valid()) {
  13434. last_ssl_error_ = 0;
  13435. last_backend_error_ = 0;
  13436. }
  13437. #endif
  13438. {
  13439. std::lock_guard<std::mutex> guard(socket_mutex_);
  13440. // Set this to false immediately - if it ever gets set to true by the end
  13441. // of the request, we know another thread instructed us to close the
  13442. // socket.
  13443. socket_should_be_closed_when_request_is_done_ = false;
  13444. if (!socket_reusable()) {
  13445. if (!ensure_socket_connection(socket_, error)) { return false; }
  13446. {
  13447. auto success = true;
  13448. if (!setup_proxy_connection(socket_, req.start_time_, res, success,
  13449. error)) {
  13450. return success;
  13451. }
  13452. }
  13453. }
  13454. // Mark the current socket as being in use so that it cannot be closed by
  13455. // anyone else while this request is ongoing, even though we will be
  13456. // releasing the mutex.
  13457. if (socket_requests_in_flight_ > 1) {
  13458. assert(socket_requests_are_from_thread_ == std::this_thread::get_id());
  13459. }
  13460. socket_requests_in_flight_ += 1;
  13461. socket_requests_are_from_thread_ = std::this_thread::get_id();
  13462. }
  13463. for (const auto &header : default_headers_) {
  13464. if (req.headers.find(header.first) == req.headers.end()) {
  13465. req.headers.insert(header);
  13466. }
  13467. }
  13468. auto ret = false;
  13469. auto close_connection = !keep_alive_;
  13470. auto se = detail::scope_exit([&]() {
  13471. // Briefly lock mutex in order to mark that a request is no longer ongoing
  13472. std::lock_guard<std::mutex> guard(socket_mutex_);
  13473. socket_requests_in_flight_ -= 1;
  13474. if (socket_requests_in_flight_ <= 0) {
  13475. assert(socket_requests_in_flight_ == 0);
  13476. socket_requests_are_from_thread_ = std::thread::id();
  13477. }
  13478. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  13479. !ret) {
  13480. disconnect(/*gracefully=*/true);
  13481. }
  13482. });
  13483. ret = process_socket(socket_, req.start_time_, [&](Stream &strm) {
  13484. return handle_request(strm, req, res, close_connection, error);
  13485. });
  13486. if (!ret) {
  13487. if (error == Error::Success) { error = Error::Unknown; }
  13488. }
  13489. return ret;
  13490. }
  13491. inline Result ClientImpl::send(const Request &req) {
  13492. auto req2 = req;
  13493. return send_(std::move(req2));
  13494. }
  13495. inline Result ClientImpl::send_(Request &&req) {
  13496. auto res = detail::make_unique<Response>();
  13497. auto error = Error::Success;
  13498. #ifdef CPPHTTPLIB_SSL_ENABLED
  13499. // Hold the request lock until the Result has read this request's TLS error
  13500. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  13501. #endif
  13502. auto ret = send(req, *res, error);
  13503. #ifdef CPPHTTPLIB_SSL_ENABLED
  13504. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers),
  13505. last_ssl_error_, last_backend_error_};
  13506. #else
  13507. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers)};
  13508. #endif
  13509. }
  13510. inline void ClientImpl::prepare_default_headers(Request &r, bool for_stream,
  13511. const std::string &ct) {
  13512. (void)for_stream;
  13513. // Default headers are meant for the origin and may carry its credentials, so
  13514. // keep them off the CONNECT request the proxy reads.
  13515. if (r.method != "CONNECT") {
  13516. for (const auto &header : default_headers_) {
  13517. if (!r.has_header(header.first)) { r.headers.insert(header); }
  13518. }
  13519. }
  13520. // RFC 9110 5.3 recommends sending control data such as Host first, so
  13521. // prepend it rather than appending it after the caller's own fields.
  13522. if (!r.has_header("Host")) {
  13523. r.headers.emplace_front(
  13524. "Host", detail::make_default_host_header_value(host_, port_, is_ssl(),
  13525. address_family_));
  13526. }
  13527. if (!r.has_header("Accept")) { r.headers.emplace("Accept", "*/*"); }
  13528. if (!r.content_receiver) {
  13529. if (!r.has_header("Accept-Encoding")) {
  13530. std::string accept_encoding;
  13531. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  13532. accept_encoding = "br";
  13533. #endif
  13534. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  13535. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13536. accept_encoding += "gzip, deflate";
  13537. #endif
  13538. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  13539. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13540. accept_encoding += "zstd";
  13541. #endif
  13542. r.set_header("Accept-Encoding", accept_encoding);
  13543. }
  13544. detail::add_default_user_agent_header(r);
  13545. }
  13546. if (!r.body.empty()) {
  13547. if (!ct.empty() && !r.has_header("Content-Type")) {
  13548. r.headers.emplace("Content-Type", ct);
  13549. }
  13550. if (!r.has_header("Content-Length")) {
  13551. r.headers.emplace("Content-Length", std::to_string(r.body.size()));
  13552. }
  13553. }
  13554. }
  13555. inline ClientImpl::StreamHandle
  13556. ClientImpl::open_stream(const std::string &method, const std::string &path,
  13557. const Params &params, const Headers &headers,
  13558. const std::string &body,
  13559. const std::string &content_type) {
  13560. // Encode the target exactly like the buffered send path does, so that the
  13561. // same `path` produces the same request line through either API.
  13562. auto raw_query_path =
  13563. params.empty() ? path : append_query_params(path, params);
  13564. Request req;
  13565. req.method = method;
  13566. req.path = detail::encode_request_target(raw_query_path, path_encode_);
  13567. req.headers = headers;
  13568. req.body = body;
  13569. prepare_default_headers(req, true, content_type);
  13570. auto handle = open_stream_(req);
  13571. // Like a buffered request, a stream that fails to open is reported once
  13572. if (handle.error != Error::Success) { output_error_log(handle.error, &req); }
  13573. return handle;
  13574. }
  13575. inline ClientImpl::StreamHandle ClientImpl::open_stream_(Request &req) {
  13576. StreamHandle handle;
  13577. handle.response = detail::make_unique<Response>();
  13578. handle.error = Error::Success;
  13579. handle.connection_ = detail::make_unique<ClientConnection>();
  13580. {
  13581. std::lock_guard<std::mutex> guard(socket_mutex_);
  13582. if (!socket_reusable()) {
  13583. if (!ensure_socket_connection(socket_, handle.error)) {
  13584. handle.response.reset();
  13585. return handle;
  13586. }
  13587. {
  13588. auto success = true;
  13589. auto start_time = std::chrono::steady_clock::now();
  13590. if (!setup_proxy_connection(socket_, start_time, *handle.response,
  13591. success, handle.error)) {
  13592. if (!success) { handle.response.reset(); }
  13593. return handle;
  13594. }
  13595. }
  13596. }
  13597. transfer_socket_ownership_to_handle(handle);
  13598. }
  13599. #ifdef CPPHTTPLIB_SSL_ENABLED
  13600. if (is_ssl() && handle.connection_->session) {
  13601. handle.socket_stream_ = detail::make_unique<detail::SSLSocketStream>(
  13602. handle.connection_->sock, handle.connection_->session,
  13603. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13604. write_timeout_usec_);
  13605. } else {
  13606. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13607. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13608. write_timeout_sec_, write_timeout_usec_);
  13609. }
  13610. #else
  13611. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13612. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13613. write_timeout_sec_, write_timeout_usec_);
  13614. #endif
  13615. handle.stream_ = handle.socket_stream_.get();
  13616. auto &strm = *handle.stream_;
  13617. // After connecting, as for a buffered request
  13618. add_credential_headers(req);
  13619. // Build the request line and headers in memory first, like write_request()
  13620. // does, so that a rejected header leaves nothing on the wire.
  13621. {
  13622. detail::BufferStream bstrm;
  13623. // The path follows the authority in absolute-form, so one that does not
  13624. // begin with '/' (e.g. "@evil.example/x") would name another host.
  13625. auto prefix = proxy_target_prefix();
  13626. if ((!prefix.empty() && req.path[0] != '/') ||
  13627. detail::write_request_line(bstrm, req.method, prefix + req.path) < 0) {
  13628. handle.error = Error::Write;
  13629. handle.response.reset();
  13630. return handle;
  13631. }
  13632. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13633. handle.error)) {
  13634. handle.response.reset();
  13635. return handle;
  13636. }
  13637. const auto &data = bstrm.get_buffer();
  13638. if (!detail::write_data(strm, data.data(), data.size())) {
  13639. handle.error = Error::Write;
  13640. handle.response.reset();
  13641. return handle;
  13642. }
  13643. }
  13644. if (!req.body.empty()) {
  13645. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  13646. handle.error = Error::Write;
  13647. handle.response.reset();
  13648. return handle;
  13649. }
  13650. }
  13651. if (!read_response_line(strm, req, *handle.response) ||
  13652. !detail::read_headers(strm, handle.response->headers)) {
  13653. handle.error = Error::Read;
  13654. handle.response.reset();
  13655. return handle;
  13656. }
  13657. handle.body_reader_.stream = handle.stream_;
  13658. handle.body_reader_.payload_max_length = payload_max_length_;
  13659. // RFC 9112 6.3: a response to HEAD, and a 204 or 304 response, ends with its
  13660. // header section, so none of its framing or coding headers apply.
  13661. if (req.method == "HEAD" ||
  13662. handle.response->status == StatusCode::NoContent_204 ||
  13663. handle.response->status == StatusCode::NotModified_304) {
  13664. handle.body_reader_.eof = true;
  13665. return handle;
  13666. }
  13667. // Same framing check as ClientImpl::process_request()
  13668. if (detail::has_conflicting_content_length(handle.response->headers)) {
  13669. handle.error = Error::Read;
  13670. handle.response.reset();
  13671. return handle;
  13672. }
  13673. if (handle.response->has_header("Content-Length")) {
  13674. bool is_invalid = false;
  13675. auto content_length = detail::get_header_value_u64(
  13676. handle.response->headers, "Content-Length", 0, 0, is_invalid);
  13677. if (is_invalid) {
  13678. handle.error = Error::Read;
  13679. handle.response.reset();
  13680. return handle;
  13681. }
  13682. handle.body_reader_.has_content_length = true;
  13683. handle.body_reader_.content_length = content_length;
  13684. }
  13685. handle.body_reader_.chunked =
  13686. detail::is_chunked_transfer_encoding(handle.response->headers);
  13687. auto content_encoding = detail::get_combined_header_value(
  13688. handle.response->headers, "Content-Encoding");
  13689. if (decompress_ && !content_encoding.empty()) {
  13690. // Same policy as prepare_content_receiver(): reject a coding we know about
  13691. // but were not built with, pass an unrecognized one through as-is.
  13692. handle.decompressor_ = detail::create_decompressor(content_encoding);
  13693. if (!handle.decompressor_) {
  13694. if (detail::is_known_content_encoding(content_encoding)) {
  13695. handle.error = Error::UnsupportedContentEncoding;
  13696. handle.response.reset();
  13697. return handle;
  13698. }
  13699. } else if (!handle.decompressor_->is_valid()) {
  13700. handle.error = Error::Compression;
  13701. handle.response.reset();
  13702. return handle;
  13703. }
  13704. }
  13705. return handle;
  13706. }
  13707. inline ssize_t ClientImpl::StreamHandle::read(char *buf, size_t len) {
  13708. if (!is_valid() || !response) { return -1; }
  13709. auto n = decompressor_
  13710. ? read_with_decompression(buf, len)
  13711. : detail::read_body_content(stream_, body_reader_, buf, len);
  13712. if (n == 0) { parse_trailers_if_needed(); }
  13713. return n;
  13714. }
  13715. inline ssize_t ClientImpl::StreamHandle::read_with_decompression(char *buf,
  13716. size_t len) {
  13717. if (decompress_offset_ < decompress_buffer_.size()) {
  13718. auto available = decompress_buffer_.size() - decompress_offset_;
  13719. auto to_copy = (std::min)(len, available);
  13720. std::memcpy(buf, decompress_buffer_.data() + decompress_offset_, to_copy);
  13721. decompress_offset_ += to_copy;
  13722. decompressed_bytes_read_ += to_copy;
  13723. return static_cast<ssize_t>(to_copy);
  13724. }
  13725. decompress_buffer_.clear();
  13726. decompress_offset_ = 0;
  13727. constexpr size_t kDecompressionBufferSize = 8192;
  13728. char compressed_buf[kDecompressionBufferSize];
  13729. while (true) {
  13730. auto n = detail::read_body_content(stream_, body_reader_, compressed_buf,
  13731. sizeof(compressed_buf));
  13732. if (n <= 0) { return n; }
  13733. auto exceeded = false;
  13734. bool decompress_ok = decompressor_->decompress(
  13735. compressed_buf, static_cast<size_t>(n),
  13736. [&](const char *data, size_t data_len) {
  13737. decompress_buffer_.append(data, data_len);
  13738. auto limit = body_reader_.payload_max_length;
  13739. exceeded =
  13740. limit > 0 &&
  13741. decompressed_bytes_read_ + decompress_buffer_.size() > limit;
  13742. return !exceeded;
  13743. });
  13744. if (!decompress_ok) {
  13745. body_reader_.last_error =
  13746. exceeded ? Error::ExceedMaxPayloadSize : Error::Read;
  13747. return -1;
  13748. }
  13749. if (!decompress_buffer_.empty()) { break; }
  13750. }
  13751. auto to_copy = (std::min)(len, decompress_buffer_.size());
  13752. std::memcpy(buf, decompress_buffer_.data(), to_copy);
  13753. decompress_offset_ = to_copy;
  13754. decompressed_bytes_read_ += to_copy;
  13755. return static_cast<ssize_t>(to_copy);
  13756. }
  13757. inline void ClientImpl::StreamHandle::parse_trailers_if_needed() {
  13758. // The trailers follow the last chunk, so there are none before it
  13759. auto &decoder = body_reader_.chunked_decoder;
  13760. if (!response || trailers_parsed_ || !decoder || !decoder->finished) {
  13761. return;
  13762. }
  13763. trailers_parsed_ = true;
  13764. decoder->parse_trailers_into(response->trailers, response->headers);
  13765. }
  13766. namespace detail {
  13767. inline ChunkedDecoder::ChunkedDecoder(Stream &s) : strm(s) {}
  13768. inline ssize_t ChunkedDecoder::read_payload(char *buf, size_t len,
  13769. size_t &out_chunk_offset,
  13770. size_t &out_chunk_total) {
  13771. if (finished) { return 0; }
  13772. if (chunk_remaining == 0) {
  13773. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13774. if (!lr.getline()) { return -1; }
  13775. // Everything below is bounded by eol rather than by the buffer's NUL, so
  13776. // the line terminator is never mistaken for line content.
  13777. const char *eol = lr.ptr() + lr.size();
  13778. if (lr.end_with_crlf()) {
  13779. eol -= 2;
  13780. } else if (eol != lr.ptr() && eol[-1] == '\n') {
  13781. // Only reachable under CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR, where
  13782. // getline() ends the line on a bare LF. That LF is the terminator, so it
  13783. // has to come off here or the check below would reject the line.
  13784. eol -= 1;
  13785. }
  13786. // RFC 9112 §7.1: chunk-size = 1*HEXDIG
  13787. const char *p = lr.ptr();
  13788. int v = 0;
  13789. if (p == eol || !is_hex(*p, v)) { return -1; }
  13790. size_t chunk_len = 0;
  13791. constexpr size_t chunk_len_max = (std::numeric_limits<size_t>::max)();
  13792. for (; p < eol && is_hex(*p, v); ++p) {
  13793. if (chunk_len > (chunk_len_max >> 4)) { return -1; }
  13794. chunk_len = (chunk_len << 4) | static_cast<size_t>(v);
  13795. }
  13796. while (p < eol && is_space_or_tab(*p)) {
  13797. ++p;
  13798. }
  13799. // RFC 9112 §7.1.1: only a chunk-ext may sit between the size and the line
  13800. // terminator, and it is built from tokens and quoted-strings, so it never
  13801. // holds a CR, LF or any other control character. getline() reads up to the
  13802. // CRLF, so a bare LF left in here would be swallowed as extension text
  13803. // while an intermediary that ends the line on it delimits the chunks
  13804. // differently, and the two disagree on where the body ends (request
  13805. // smuggling).
  13806. if (p < eol && *p != ';') { return -1; }
  13807. for (; p < eol; ++p) {
  13808. if (!is_space_or_tab(*p) && !fields::is_field_vchar(*p)) { return -1; }
  13809. }
  13810. // The bytes around the data are no payload, so they are counted on their
  13811. // own, as Go does: each chunk may spend 16 bytes and twice its data on
  13812. // them, which lets a stream send a byte at a time, and what goes past that
  13813. // in padding, leading zeros and extensions builds up to one header field.
  13814. overhead += lr.size() + 2;
  13815. overhead = overhead > 16 ? overhead - 16 : 0;
  13816. overhead = chunk_len > overhead / 2 ? 0 : overhead - 2 * chunk_len;
  13817. if (overhead > CPPHTTPLIB_HEADER_MAX_LENGTH) { return -1; }
  13818. if (chunk_len == 0) {
  13819. chunk_remaining = 0;
  13820. finished = true;
  13821. out_chunk_offset = 0;
  13822. out_chunk_total = 0;
  13823. return 0;
  13824. }
  13825. chunk_remaining = chunk_len;
  13826. last_chunk_total = chunk_remaining;
  13827. last_chunk_offset = 0;
  13828. }
  13829. auto to_read = (std::min)(chunk_remaining, len);
  13830. auto n = strm.read(buf, to_read);
  13831. if (n <= 0) { return -1; }
  13832. auto offset_before = last_chunk_offset;
  13833. last_chunk_offset += static_cast<size_t>(n);
  13834. chunk_remaining -= static_cast<size_t>(n);
  13835. out_chunk_offset = offset_before;
  13836. out_chunk_total = last_chunk_total;
  13837. if (chunk_remaining == 0) {
  13838. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13839. if (!lr.getline()) { return -1; }
  13840. if (std::strcmp(lr.ptr(), "\r\n") != 0) { return -1; }
  13841. }
  13842. return n;
  13843. }
  13844. inline bool ChunkedDecoder::parse_trailers_into(Headers &dest,
  13845. const Headers &src_headers) {
  13846. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13847. if (!lr.getline()) { return false; }
  13848. return parse_trailers(lr, dest, src_headers);
  13849. }
  13850. // Only 301, 302, 303, 307 and 308 redirect. Any other 3xx, such as a 304, or
  13851. // a redirect without a Location, is a final response.
  13852. inline bool is_redirect(const Response &res) {
  13853. switch (res.status) {
  13854. case StatusCode::MovedPermanently_301:
  13855. case StatusCode::Found_302:
  13856. case StatusCode::SeeOther_303:
  13857. case StatusCode::TemporaryRedirect_307:
  13858. case StatusCode::PermanentRedirect_308:
  13859. return !res.get_header_value("Location").empty();
  13860. default: return false;
  13861. }
  13862. }
  13863. } // namespace detail
  13864. inline void
  13865. ClientImpl::transfer_socket_ownership_to_handle(StreamHandle &handle) {
  13866. handle.connection_->sock = socket_.sock;
  13867. #ifdef CPPHTTPLIB_SSL_ENABLED
  13868. handle.connection_->session = socket_.ssl;
  13869. socket_.ssl = nullptr;
  13870. #endif
  13871. socket_.sock = INVALID_SOCKET;
  13872. }
  13873. // A plain HTTP proxy reads the target in absolute-form (RFC 9112 3.2.2)
  13874. inline std::string ClientImpl::proxy_target_prefix() const {
  13875. if (is_ssl() || !is_proxy_enabled_for_host(host_)) { return std::string(); }
  13876. return "http://" + detail::make_host_and_port_string(host_, port_, false);
  13877. }
  13878. inline bool ClientImpl::handle_request(Stream &strm, Request &req,
  13879. Response &res, bool close_connection,
  13880. Error &error) {
  13881. if (req.path.empty()) {
  13882. error = Error::Connection;
  13883. return false;
  13884. }
  13885. auto req_save = req;
  13886. bool ret;
  13887. auto prefix = proxy_target_prefix();
  13888. if (!prefix.empty()) {
  13889. // The path follows the authority in absolute-form, so one that does not
  13890. // begin with '/' (e.g. "@evil.example/x") would name another host.
  13891. if (req.path[0] != '/') {
  13892. error = Error::Write;
  13893. return false;
  13894. }
  13895. auto req2 = req;
  13896. req2.path = prefix + req.path;
  13897. ret = process_request(strm, req2, res, close_connection, error);
  13898. req = std::move(req2);
  13899. req.path = req_save.path;
  13900. } else {
  13901. ret = process_request(strm, req, res, close_connection, error);
  13902. }
  13903. if (!ret) { return false; }
  13904. {
  13905. // NOTE: this requires a not-entirely-obvious chain of calls to be correct
  13906. // for this to be safe.
  13907. // This is safe to call because handle_request is only called by send_
  13908. // which locks the request mutex during the process. It would be a bug
  13909. // to call it from a different thread since it's a thread-safety issue
  13910. // to do these things to the socket if another thread is using the socket.
  13911. std::lock_guard<std::mutex> guard(socket_mutex_);
  13912. // Also when the request asked for it (e.g. a body that was never sent,
  13913. // or "Connection: close"), so that a redirect or an auth retry below does
  13914. // not reuse the socket.
  13915. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  13916. detail::has_header_token(res.headers, "Connection", "close") ||
  13917. (res.version == "HTTP/1.0" && res.reason != "Connection established")) {
  13918. disconnect(/*gracefully=*/true);
  13919. }
  13920. }
  13921. if (follow_location_ && detail::is_redirect(res)) {
  13922. req = std::move(req_save);
  13923. // The client that followed the redirect has answered any challenge it
  13924. // could. Retrying below would sign another host's challenge and send it
  13925. // here.
  13926. return redirect(req, res, error);
  13927. }
  13928. #ifdef CPPHTTPLIB_SSL_ENABLED
  13929. if ((res.status == StatusCode::Unauthorized_401 ||
  13930. res.status == StatusCode::ProxyAuthenticationRequired_407) &&
  13931. req.authorization_count_ < 5) {
  13932. auto is_proxy = res.status == StatusCode::ProxyAuthenticationRequired_407;
  13933. // Only retry when the 407 actually came from a proxy hop: plain HTTP
  13934. // through an enabled proxy. HTTPS via CONNECT tunnels the 407 from the
  13935. // origin (#2457); direct/bypassed origins have no proxy hop at all.
  13936. if (is_proxy && !(!is_ssl() && is_proxy_enabled_for_host(host_))) {
  13937. return ret;
  13938. }
  13939. const auto &username =
  13940. is_proxy ? proxy_digest_auth_username_ : digest_auth_username_;
  13941. const auto &password =
  13942. is_proxy ? proxy_digest_auth_password_ : digest_auth_password_;
  13943. if (!username.empty() && !password.empty()) {
  13944. std::map<std::string, std::string> auth;
  13945. if (detail::parse_www_authenticate(res, auth, is_proxy)) {
  13946. Request new_req = req;
  13947. new_req.authorization_count_ += 1;
  13948. new_req.headers.erase(is_proxy ? "Proxy-Authorization"
  13949. : "Authorization");
  13950. new_req.headers.insert(detail::make_digest_authentication_header(
  13951. req, make_request_target(req), auth, new_req.authorization_count_,
  13952. detail::random_string(10), username, password, is_proxy));
  13953. Response new_res;
  13954. ret = send(new_req, new_res, error);
  13955. if (ret) { res = std::move(new_res); }
  13956. }
  13957. }
  13958. }
  13959. #endif
  13960. return ret;
  13961. }
  13962. inline bool ClientImpl::redirect(Request &req, Response &res, Error &error) {
  13963. if (req.redirect_count_ == 0) {
  13964. error = Error::ExceedRedirectCount;
  13965. return false;
  13966. }
  13967. auto location = res.get_header_value("location");
  13968. if (location.empty()) { return false; }
  13969. detail::UrlComponents uc;
  13970. if (!detail::parse_url(detail::resolve_relative_location(location, req.path),
  13971. uc)) {
  13972. return false;
  13973. }
  13974. // Only follow http/https redirects
  13975. if (!uc.scheme.empty() && uc.scheme != "http" && uc.scheme != "https") {
  13976. return false;
  13977. }
  13978. auto scheme = is_ssl() ? "https" : "http";
  13979. auto next_scheme = std::move(uc.scheme);
  13980. auto next_host = std::move(uc.host);
  13981. auto port_str = std::move(uc.port);
  13982. auto next_path = std::move(uc.path);
  13983. auto next_query = std::move(uc.query);
  13984. auto next_port = port_;
  13985. if (!port_str.empty()) {
  13986. if (!detail::parse_port(port_str, next_port)) { return false; }
  13987. } else if (!next_scheme.empty()) {
  13988. next_port = next_scheme == "https" ? 443 : 80;
  13989. }
  13990. if (next_scheme.empty()) { next_scheme = scheme; }
  13991. if (next_host.empty()) { next_host = host_; }
  13992. if (next_path.empty()) { next_path = "/"; }
  13993. // An absolute or absolute-path location can have dot segments too.
  13994. if (next_path[0] == '/') {
  13995. next_path = detail::remove_dot_segments(next_path);
  13996. }
  13997. auto path = std::move(next_path) + next_query;
  13998. // Same host redirect - use current client
  13999. if (next_scheme == scheme && next_host == host_ && next_port == port_) {
  14000. return detail::redirect(*this, req, res, path, location, error);
  14001. }
  14002. // Cross-host/scheme redirect - create new client with robust setup
  14003. return create_redirect_client(next_scheme, next_host, next_port, req, res,
  14004. path, location, error);
  14005. }
  14006. // New method for robust redirect client creation
  14007. inline bool ClientImpl::create_redirect_client(
  14008. const std::string &scheme, const std::string &host, int port, Request &req,
  14009. Response &res, const std::string &path, const std::string &location,
  14010. Error &error) {
  14011. // Determine if we need SSL
  14012. auto need_ssl = (scheme == "https");
  14013. // Clean up request headers that are host/client specific
  14014. // Remove headers that should not be carried over to new host
  14015. auto headers_to_remove = std::vector<std::string>{
  14016. "Host", "Proxy-Authorization", "Authorization", "Cookie", "Cookie2"};
  14017. for (const auto &header_name : headers_to_remove) {
  14018. auto it = req.headers.find(header_name);
  14019. while (it != req.headers.end()) {
  14020. it = req.headers.erase(it);
  14021. it = req.headers.find(header_name);
  14022. }
  14023. }
  14024. // Create appropriate client type and handle redirect
  14025. if (need_ssl) {
  14026. #ifdef CPPHTTPLIB_SSL_ENABLED
  14027. // Create SSL client for HTTPS redirect
  14028. SSLClient redirect_client(host, port);
  14029. // Setup basic client configuration first
  14030. setup_redirect_client(redirect_client);
  14031. redirect_client.enable_server_certificate_verification(
  14032. server_certificate_verification_);
  14033. redirect_client.enable_server_hostname_verification(
  14034. server_hostname_verification_);
  14035. redirect_client.system_ca_mode_ = system_ca_mode_;
  14036. // Transfer CA certificate to redirect client
  14037. redirect_client.set_ca_cert_path(ca_cert_file_path_, ca_cert_dir_path_);
  14038. if (is_ssl()) {
  14039. auto &self = static_cast<SSLClient &>(*this);
  14040. // A store given to set_ca_cert_store() lives only in this client's
  14041. // context, which then holds all that is trusted.
  14042. if (self.ca_cert_store_set_) {
  14043. std::string pem;
  14044. {
  14045. std::lock_guard<std::mutex> guard(self.ctx_mutex_);
  14046. pem = detail::ca_certs_to_pem(self.ctx_);
  14047. }
  14048. redirect_client.load_ca_cert_store(pem.data(), pem.size());
  14049. redirect_client.ca_cert_store_set_ = true;
  14050. } else if (self.custom_ca_loaded_) {
  14051. redirect_client.load_ca_cert_store(ca_cert_pem_.c_str(),
  14052. ca_cert_pem_.size());
  14053. }
  14054. redirect_client.set_session_verifier(self.session_verifier_);
  14055. if (self.server_certificate_verifier_) {
  14056. redirect_client.set_server_certificate_verifier(
  14057. self.server_certificate_verifier_);
  14058. }
  14059. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  14060. redirect_client.enable_windows_cert_verification_ =
  14061. self.enable_windows_cert_verification_;
  14062. #endif
  14063. }
  14064. // Client certificates are set through constructor for SSLClient
  14065. // NOTE: SSLClient constructor already takes client_cert_path and
  14066. // client_key_path so we need to create it properly if client certs are
  14067. // needed
  14068. // Execute the redirect
  14069. return detail::redirect(redirect_client, req, res, path, location, error);
  14070. #else
  14071. // SSL not supported - set appropriate error
  14072. error = Error::SSLConnection;
  14073. return false;
  14074. #endif
  14075. } else {
  14076. // HTTP redirect
  14077. ClientImpl redirect_client(host, port);
  14078. // Setup client with robust configuration
  14079. setup_redirect_client(redirect_client);
  14080. // Execute the redirect
  14081. return detail::redirect(redirect_client, req, res, path, location, error);
  14082. }
  14083. }
  14084. // New method for robust client setup (based on basic_manual_redirect.cpp
  14085. // logic)
  14086. template <typename ClientType>
  14087. inline void ClientImpl::setup_redirect_client(ClientType &client) {
  14088. // Copy basic settings first
  14089. client.set_connection_timeout(connection_timeout_sec_,
  14090. connection_timeout_usec_);
  14091. client.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  14092. client.set_write_timeout(write_timeout_sec_, write_timeout_usec_);
  14093. client.set_max_timeout(max_timeout_msec_);
  14094. if (has_payload_max_length_) {
  14095. client.set_payload_max_length(payload_max_length_);
  14096. }
  14097. client.set_keep_alive(keep_alive_);
  14098. client.set_follow_location(
  14099. true); // Enable redirects to handle multi-step redirects
  14100. client.set_path_encode(path_encode_);
  14101. client.set_compress(compress_);
  14102. client.set_decompress(decompress_);
  14103. // NOTE: Authentication credentials (basic auth, bearer token, digest auth)
  14104. // are intentionally NOT copied to the redirect client. Per RFC 9110 Section
  14105. // 15.4, credentials must not be forwarded when redirecting to a different
  14106. // host. This function is only called for cross-host redirects; same-host
  14107. // redirects are handled directly in ClientImpl::redirect().
  14108. // Copy the proxy configuration unconditionally; the per-target bypass is
  14109. // re-evaluated at send time, so a later hop to a non-bypassed host can
  14110. // still use the proxy.
  14111. client.no_proxy_entries_ = no_proxy_entries_;
  14112. if (!proxy_host_.empty() && proxy_port_ != -1) {
  14113. client.set_proxy(proxy_host_, proxy_port_);
  14114. if (!proxy_basic_auth_username_.empty() ||
  14115. !proxy_basic_auth_password_.empty()) {
  14116. client.set_proxy_basic_auth(proxy_basic_auth_username_,
  14117. proxy_basic_auth_password_);
  14118. }
  14119. if (!proxy_bearer_token_auth_token_.empty()) {
  14120. client.set_proxy_bearer_token_auth(proxy_bearer_token_auth_token_);
  14121. }
  14122. #ifdef CPPHTTPLIB_SSL_ENABLED
  14123. if (!proxy_digest_auth_username_.empty()) {
  14124. client.set_proxy_digest_auth(proxy_digest_auth_username_,
  14125. proxy_digest_auth_password_);
  14126. }
  14127. #endif
  14128. }
  14129. // Copy network and socket settings
  14130. client.addr_map_ = addr_map_;
  14131. client.tunnel_addr_map_ = tunnel_addr_map_;
  14132. client.set_address_family(address_family_);
  14133. client.set_tcp_nodelay(tcp_nodelay_);
  14134. client.set_ipv6_v6only(ipv6_v6only_);
  14135. if (socket_options_) { client.set_socket_options(socket_options_); }
  14136. if (!interface_.empty()) { client.set_interface(interface_); }
  14137. // Copy logging and headers. Not the error logger: a failure comes back to
  14138. // this client's send(), which reports it with the caller's request.
  14139. if (logger_) { client.set_logger(logger_); }
  14140. // NOTE: DO NOT copy default_headers_ as they may contain stale Host headers
  14141. // Each new client should generate its own headers based on its target host
  14142. }
  14143. inline bool ClientImpl::write_content_with_provider(Stream &strm,
  14144. const Request &req,
  14145. Error &error) const {
  14146. auto is_shutting_down = []() { return false; };
  14147. if (req.is_chunked_content_provider_) {
  14148. auto compressor = compress_ ? detail::create_compressor().first
  14149. : std::unique_ptr<detail::compressor>();
  14150. if (!compressor) {
  14151. compressor = detail::make_unique<detail::nocompressor>();
  14152. }
  14153. return detail::write_content_chunked(strm, req.content_provider_,
  14154. is_shutting_down, *compressor, error);
  14155. } else {
  14156. return detail::write_content_with_progress(
  14157. strm, req.content_provider_, 0, req.content_length_, is_shutting_down,
  14158. req.upload_progress, error);
  14159. }
  14160. }
  14161. // What goes on the request line for req: its path, encoded and without the
  14162. // fragment, with `req.params` as the query when the path has none.
  14163. inline std::string ClientImpl::make_request_target(const Request &req) const {
  14164. auto target = detail::encode_request_target(req.path, path_encode_);
  14165. if (detail::query_of(req.path).empty() && !req.params.empty()) {
  14166. target = append_query_params(target, req.params);
  14167. }
  14168. return target;
  14169. }
  14170. inline void ClientImpl::add_credential_headers(Request &req) {
  14171. // A CONNECT request is read by the proxy; everything sent through the tunnel
  14172. // it opens is read by the origin. Each credential goes only to its own hop.
  14173. auto is_connect = req.method == "CONNECT";
  14174. if (!is_connect) {
  14175. detail::add_authorization_header(req, basic_auth_username_,
  14176. basic_auth_password_,
  14177. bearer_token_auth_token_, false);
  14178. }
  14179. // Proxy-Authorization is only sent when the proxy reads this message —
  14180. // otherwise NO_PROXY-matched requests, and requests inside a TLS tunnel,
  14181. // would leak proxy credentials to the destination server.
  14182. if (is_proxy_enabled_for_host(host_) && (!is_ssl() || is_connect)) {
  14183. detail::add_authorization_header(req, proxy_basic_auth_username_,
  14184. proxy_basic_auth_password_,
  14185. proxy_bearer_token_auth_token_, true);
  14186. }
  14187. }
  14188. inline bool ClientImpl::write_request(Stream &strm, Request &req,
  14189. bool close_connection, Error &error,
  14190. bool skip_body, bool &rejected_locally) {
  14191. rejected_locally = false;
  14192. // Prepare additional headers
  14193. if (close_connection) {
  14194. if (!req.has_header("Connection")) {
  14195. req.set_header("Connection", "close");
  14196. }
  14197. }
  14198. std::string ct_for_defaults;
  14199. if (!req.has_header("Content-Type") && !req.body.empty()) {
  14200. ct_for_defaults = "text/plain";
  14201. }
  14202. prepare_default_headers(req, false, ct_for_defaults);
  14203. if (req.body.empty()) {
  14204. if (req.content_provider_) {
  14205. if (!req.is_chunked_content_provider_) {
  14206. if (!req.has_header("Content-Length")) {
  14207. auto length = std::to_string(req.content_length_);
  14208. req.set_header("Content-Length", length);
  14209. }
  14210. }
  14211. } else {
  14212. if (req.method == "POST" || req.method == "PUT" ||
  14213. req.method == "PATCH") {
  14214. req.set_header("Content-Length", "0");
  14215. }
  14216. }
  14217. }
  14218. add_credential_headers(req);
  14219. // Request line and headers
  14220. {
  14221. detail::BufferStream bstrm;
  14222. auto path_with_query = make_request_target(req);
  14223. // The query already came in through `req.path`; still populate
  14224. // `req.params` for handlers/users who read them.
  14225. auto query_part = detail::query_of(req.path);
  14226. if (!query_part.empty()) {
  14227. detail::parse_query_text(query_part, req.params);
  14228. }
  14229. // Write request line and headers
  14230. if (detail::write_request_line(bstrm, req.method, path_with_query) < 0) {
  14231. // A rejected method (not a token, e.g. carrying CR/LF) or target (e.g.
  14232. // CR/LF in a caller-supplied path under set_path_encode(false)) must
  14233. // fail the request cleanly instead of emitting a request-line-less,
  14234. // header-injecting request.
  14235. error = Error::Write;
  14236. rejected_locally = true;
  14237. return false;
  14238. }
  14239. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  14240. error)) {
  14241. rejected_locally = true;
  14242. return false;
  14243. }
  14244. // Flush buffer
  14245. auto &data = bstrm.get_buffer();
  14246. if (!detail::write_data(strm, data.data(), data.size())) {
  14247. error = Error::Write;
  14248. return false;
  14249. }
  14250. }
  14251. // After sending request line and headers, wait briefly for an early server
  14252. // response (e.g. 4xx) and avoid sending a potentially large request body
  14253. // unnecessarily. This workaround is only enabled on Windows because Unix
  14254. // platforms surface write errors (EPIPE) earlier; on Windows kernel send
  14255. // buffering can accept large writes even when the peer already responded.
  14256. // Check the stream first (which covers SSL via `is_readable()`), then
  14257. // fall back to select on the socket. Only perform the wait for very large
  14258. // request bodies to avoid interfering with normal small requests and
  14259. // reduce side-effects. Poll briefly (up to 50ms as default) for an early
  14260. // response. Skip this check when using Expect: 100-continue, as the protocol
  14261. // handles early responses properly.
  14262. #if defined(_WIN32)
  14263. if (!skip_body &&
  14264. req.body.size() > CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD &&
  14265. req.path.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  14266. auto start = std::chrono::high_resolution_clock::now();
  14267. for (;;) {
  14268. // Prefer socket-level readiness to avoid SSL_pending() false-positives
  14269. // from SSL internals. If the underlying socket is readable, assume an
  14270. // early response may be present.
  14271. auto sock = strm.socket();
  14272. if (sock != INVALID_SOCKET && detail::select_read(sock, 0, 0) > 0) {
  14273. return false;
  14274. }
  14275. // Fallback to stream-level check for non-socket streams or when the
  14276. // socket isn't reporting readable. Avoid using `is_readable()` for
  14277. // SSL, since `SSL_pending()` may report buffered records that do not
  14278. // indicate a complete application-level response yet.
  14279. if (!is_ssl() && strm.is_readable()) { return false; }
  14280. auto now = std::chrono::high_resolution_clock::now();
  14281. auto elapsed =
  14282. std::chrono::duration_cast<std::chrono::milliseconds>(now - start)
  14283. .count();
  14284. if (elapsed >= CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND) {
  14285. break;
  14286. }
  14287. std::this_thread::sleep_for(std::chrono::milliseconds(1));
  14288. }
  14289. }
  14290. #endif
  14291. // Body
  14292. if (skip_body) { return true; }
  14293. return write_request_body(strm, req, error);
  14294. }
  14295. inline bool ClientImpl::write_request_body(Stream &strm, Request &req,
  14296. Error &error) {
  14297. if (req.body.empty()) {
  14298. return write_content_with_provider(strm, req, error);
  14299. }
  14300. if (req.upload_progress) {
  14301. auto body_size = req.body.size();
  14302. size_t written = 0;
  14303. auto data = req.body.data();
  14304. while (written < body_size) {
  14305. size_t to_write = (std::min)(CPPHTTPLIB_SEND_BUFSIZ, body_size - written);
  14306. if (!detail::write_data(strm, data + written, to_write)) {
  14307. error = Error::Write;
  14308. return false;
  14309. }
  14310. written += to_write;
  14311. if (!req.upload_progress(written, body_size)) {
  14312. error = Error::Canceled;
  14313. return false;
  14314. }
  14315. }
  14316. } else {
  14317. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  14318. error = Error::Write;
  14319. return false;
  14320. }
  14321. }
  14322. return true;
  14323. }
  14324. inline std::unique_ptr<Response>
  14325. ClientImpl::send_with_content_provider_and_receiver(
  14326. Request &req, const char *body, size_t content_length,
  14327. ContentProvider content_provider,
  14328. ContentProviderWithoutLength content_provider_without_length,
  14329. const std::string &content_type, ContentReceiver content_receiver,
  14330. Error &error) {
  14331. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14332. auto enc = compress_
  14333. ? detail::create_compressor()
  14334. : std::pair<std::unique_ptr<detail::compressor>, const char *>(
  14335. nullptr, nullptr);
  14336. if (enc.second) { req.set_header("Content-Encoding", enc.second); }
  14337. if (enc.first && !content_provider_without_length) {
  14338. auto &compressor = enc.first;
  14339. if (content_provider) {
  14340. auto ok = true;
  14341. auto finished = false;
  14342. size_t offset = 0;
  14343. DataSink data_sink;
  14344. data_sink.write = [&](const char *data, size_t data_len) -> bool {
  14345. if (ok) {
  14346. auto last = offset + data_len == content_length;
  14347. auto ret = compressor->compress(
  14348. data, data_len, last,
  14349. [&](const char *compressed_data, size_t compressed_data_len) {
  14350. req.body.append(compressed_data, compressed_data_len);
  14351. return true;
  14352. });
  14353. if (ret) {
  14354. offset += data_len;
  14355. } else {
  14356. ok = false;
  14357. }
  14358. }
  14359. return ok;
  14360. };
  14361. // As in detail::write_content_with_progress(): the body is framed by
  14362. // content_length, so a provider that finishes early has truncated it.
  14363. // Stop and report that instead of calling the provider forever.
  14364. data_sink.done = [&]() { finished = true; };
  14365. while (ok && !finished && offset < content_length) {
  14366. if (!content_provider(offset, content_length - offset, data_sink)) {
  14367. error = Error::Canceled;
  14368. output_error_log(error, &req);
  14369. return nullptr;
  14370. }
  14371. }
  14372. // A short body here means either the provider stopped early or the
  14373. // compressor gave up. The branch below reports a failing compressor as
  14374. // Error::Compression, so keep the two distinguishable.
  14375. if (offset < content_length) {
  14376. error = ok ? Error::Write : Error::Compression;
  14377. output_error_log(error, &req);
  14378. return nullptr;
  14379. }
  14380. } else {
  14381. if (!compressor->compress(body, content_length, true,
  14382. [&](const char *data, size_t data_len) {
  14383. req.body.append(data, data_len);
  14384. return true;
  14385. })) {
  14386. error = Error::Compression;
  14387. output_error_log(error, &req);
  14388. return nullptr;
  14389. }
  14390. }
  14391. } else {
  14392. if (content_provider) {
  14393. req.content_length_ = content_length;
  14394. req.content_provider_ = std::move(content_provider);
  14395. req.is_chunked_content_provider_ = false;
  14396. } else if (content_provider_without_length) {
  14397. req.content_length_ = 0;
  14398. req.content_provider_ = detail::ContentProviderAdapter(
  14399. std::move(content_provider_without_length));
  14400. req.is_chunked_content_provider_ = true;
  14401. req.set_header("Transfer-Encoding", "chunked");
  14402. } else {
  14403. req.body.assign(body, content_length);
  14404. }
  14405. }
  14406. if (content_receiver) {
  14407. req.content_receiver =
  14408. [content_receiver](const char *data, size_t data_length,
  14409. size_t /*offset*/, size_t /*total_length*/) {
  14410. return content_receiver(data, data_length);
  14411. };
  14412. }
  14413. auto res = detail::make_unique<Response>();
  14414. return send(req, *res, error) ? std::move(res) : nullptr;
  14415. }
  14416. inline Result ClientImpl::send_with_content_provider_and_receiver(
  14417. const std::string &method, const std::string &path, const Headers &headers,
  14418. const char *body, size_t content_length, ContentProvider content_provider,
  14419. ContentProviderWithoutLength content_provider_without_length,
  14420. const std::string &content_type, ContentReceiver content_receiver,
  14421. UploadProgress progress) {
  14422. Request req;
  14423. req.method = method;
  14424. req.headers = headers;
  14425. req.path = path;
  14426. req.upload_progress = std::move(progress);
  14427. if (max_timeout_msec_ > 0) {
  14428. req.start_time_ = std::chrono::steady_clock::now();
  14429. }
  14430. auto error = Error::Success;
  14431. #ifdef CPPHTTPLIB_SSL_ENABLED
  14432. // Hold the request lock until the Result has read this request's TLS error
  14433. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  14434. #endif
  14435. auto res = send_with_content_provider_and_receiver(
  14436. req, body, content_length, std::move(content_provider),
  14437. std::move(content_provider_without_length), content_type,
  14438. std::move(content_receiver), error);
  14439. #ifdef CPPHTTPLIB_SSL_ENABLED
  14440. return Result{std::move(res), error, std::move(req.headers), last_ssl_error_,
  14441. last_backend_error_};
  14442. #else
  14443. return Result{std::move(res), error, std::move(req.headers)};
  14444. #endif
  14445. }
  14446. inline void ClientImpl::output_log(const Request &req,
  14447. const Response &res) const {
  14448. if (logger_) {
  14449. std::lock_guard<std::mutex> guard(logger_mutex_);
  14450. logger_(req, res);
  14451. }
  14452. }
  14453. inline void ClientImpl::output_error_log(const Error &err,
  14454. const Request *req) const {
  14455. if (error_logger_) {
  14456. std::lock_guard<std::mutex> guard(logger_mutex_);
  14457. error_logger_(err, req);
  14458. }
  14459. }
  14460. inline bool ClientImpl::process_request(Stream &strm, Request &req,
  14461. Response &res, bool close_connection,
  14462. Error &error) {
  14463. // Auto-add Expect: 100-continue for large bodies
  14464. if (CPPHTTPLIB_EXPECT_100_THRESHOLD > 0 && !req.has_header("Expect")) {
  14465. auto body_size = req.body.empty() ? req.content_length_ : req.body.size();
  14466. if (body_size >= CPPHTTPLIB_EXPECT_100_THRESHOLD) {
  14467. req.set_header("Expect", "100-continue");
  14468. }
  14469. }
  14470. // Check for Expect: 100-continue
  14471. auto expect_100_continue =
  14472. detail::has_header_token(req.headers, "Expect", "100-continue");
  14473. // Send request (skip body if using Expect: 100-continue)
  14474. auto rejected_locally = false;
  14475. auto write_request_success =
  14476. write_request(strm, req, close_connection, error, expect_100_continue,
  14477. rejected_locally);
  14478. // A failed write normally still reads the response below, since the server
  14479. // may have answered early (e.g. 413/414) and closed while the body was being
  14480. // sent. A request rejected before any byte reached the socket gets no such
  14481. // response, and waiting for one would block until the read timeout.
  14482. if (rejected_locally) { return false; }
  14483. #ifdef CPPHTTPLIB_SSL_ENABLED
  14484. if (is_ssl() && !expect_100_continue) {
  14485. auto is_proxy_enabled = is_proxy_enabled_for_host(host_);
  14486. if (!is_proxy_enabled) {
  14487. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  14488. error = Error::SSLPeerCouldBeClosed_;
  14489. return false;
  14490. }
  14491. }
  14492. }
  14493. #endif
  14494. // Handle Expect: 100-continue.
  14495. //
  14496. // Wait for an interim/early response by attempting to read the status line
  14497. // under a short timeout, instead of trusting raw socket readability. Over
  14498. // TLS, post-handshake records (e.g. session tickets) make the socket
  14499. // readable without any HTTP response being available; relying on
  14500. // `select_read` there caused the body to be withheld forever and the
  14501. // request to fail with `Read` (#2458). If no status line arrives within the
  14502. // timeout, send the body anyway (matching curl's behavior).
  14503. auto status_line_read = false;
  14504. if (expect_100_continue && write_request_success) {
  14505. if (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND > 0) {
  14506. time_t sec = CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND / 1000;
  14507. time_t usec = (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND % 1000) * 1000;
  14508. strm.set_read_timeout(sec, usec);
  14509. status_line_read = read_response_line(strm, req, res, false);
  14510. strm.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  14511. }
  14512. if (!status_line_read) {
  14513. // No interim response within the timeout: send the body and handle the
  14514. // response as usual.
  14515. if (!write_request_body(strm, req, error)) { return false; }
  14516. expect_100_continue = false; // Switch to normal response handling
  14517. }
  14518. }
  14519. // Receive response and headers
  14520. // When using Expect: 100-continue, don't auto-skip `100 Continue` response
  14521. if ((!status_line_read &&
  14522. !read_response_line(strm, req, res, !expect_100_continue)) ||
  14523. !detail::read_headers(strm, res.headers)) {
  14524. if (write_request_success) { error = Error::Read; }
  14525. return false;
  14526. }
  14527. if (!write_request_success) { return false; }
  14528. // Handle Expect: 100-continue response
  14529. if (expect_100_continue) {
  14530. if (res.status == StatusCode::Continue_100) {
  14531. // Server accepted, send the body
  14532. if (!write_request_body(strm, req, error)) { return false; }
  14533. // Read the actual response
  14534. res.headers.clear();
  14535. res.body.clear();
  14536. if (!read_response_line(strm, req, res) ||
  14537. !detail::read_headers(strm, res.headers)) {
  14538. error = Error::Read;
  14539. return false;
  14540. }
  14541. } else {
  14542. // A final response came first, so the body this request declared was
  14543. // never sent, and the server may still be waiting for it. The
  14544. // connection cannot carry another request.
  14545. std::lock_guard<std::mutex> guard(socket_mutex_);
  14546. socket_should_be_closed_when_request_is_done_ = true;
  14547. }
  14548. }
  14549. // Body
  14550. if ((res.status != StatusCode::NoContent_204) && req.method != "HEAD" &&
  14551. req.method != "CONNECT") {
  14552. // Reject ambiguous framing (RFC 9112 §6.3). Unlike a request, a response
  14553. // whose final transfer coding is not chunked is not ambiguous: its body
  14554. // runs until the server closes the connection, so it is not rejected.
  14555. // HEAD/204 are excluded above and a 304 carries no body.
  14556. if (res.status != StatusCode::NotModified_304) {
  14557. if (detail::has_conflicting_content_length(res.headers)) {
  14558. error = Error::Read;
  14559. return false;
  14560. }
  14561. if (detail::has_faulty_transfer_encoding(res)) {
  14562. std::lock_guard<std::mutex> guard(socket_mutex_);
  14563. socket_should_be_closed_when_request_is_done_ = true;
  14564. }
  14565. }
  14566. auto redirect = follow_location_ && detail::is_redirect(res);
  14567. if (req.response_handler && !redirect) {
  14568. if (!req.response_handler(res)) {
  14569. error = Error::Canceled;
  14570. return false;
  14571. }
  14572. }
  14573. auto out =
  14574. req.content_receiver
  14575. ? static_cast<ContentReceiverWithProgress>(
  14576. [&](const char *buf, size_t n, size_t off, size_t len) {
  14577. if (redirect) { return true; }
  14578. auto ret = req.content_receiver(buf, n, off, len);
  14579. if (!ret) { error = Error::Canceled; }
  14580. return ret;
  14581. })
  14582. : static_cast<ContentReceiverWithProgress>(
  14583. [&](const char *buf, size_t n, size_t /*off*/,
  14584. size_t /*len*/) {
  14585. assert(res.body.size() + n <= res.body.max_size());
  14586. if (payload_max_length_ > 0 &&
  14587. (res.body.size() >= payload_max_length_ ||
  14588. n > payload_max_length_ - res.body.size())) {
  14589. return false;
  14590. }
  14591. res.body.append(buf, n);
  14592. return true;
  14593. });
  14594. auto progress = [&](size_t current, size_t total) {
  14595. if (!req.download_progress || redirect) { return true; }
  14596. auto ret = req.download_progress(current, total);
  14597. if (!ret) { error = Error::Canceled; }
  14598. return ret;
  14599. };
  14600. if (res.has_header("Content-Length")) {
  14601. if (!req.content_receiver) {
  14602. auto len = res.get_header_value_u64("Content-Length");
  14603. if (len > res.body.max_size()) {
  14604. error = Error::Read;
  14605. return false;
  14606. }
  14607. // Content-Length is only the server's claim, so reserve no more than
  14608. // payload_max_length_ allows, nor more than 1 MiB before any of the
  14609. // body has arrived. A longer body grows as it is read.
  14610. auto reserve_len =
  14611. (std::min)(static_cast<size_t>(len), size_t(1024 * 1024));
  14612. if (payload_max_length_ > 0) {
  14613. reserve_len = (std::min)(reserve_len, payload_max_length_);
  14614. }
  14615. res.body.reserve(reserve_len);
  14616. }
  14617. }
  14618. if (res.status != StatusCode::NotModified_304) {
  14619. auto content_status = 0;
  14620. auto max_length = (!has_payload_max_length_ && req.content_receiver)
  14621. ? (std::numeric_limits<size_t>::max)()
  14622. : payload_max_length_;
  14623. if (!detail::read_content(strm, res, max_length, content_status,
  14624. std::move(progress), std::move(out),
  14625. decompress_)) {
  14626. if (error != Error::Canceled) {
  14627. // Tell the caller apart from a plain read failure when the body was
  14628. // over the payload limit or could not be decoded because of its
  14629. // Content-Encoding.
  14630. switch (content_status) {
  14631. case StatusCode::PayloadTooLarge_413:
  14632. error = Error::ExceedMaxPayloadSize;
  14633. break;
  14634. case StatusCode::UnsupportedMediaType_415:
  14635. error = Error::UnsupportedContentEncoding;
  14636. break;
  14637. case StatusCode::InternalServerError_500:
  14638. error = Error::Compression;
  14639. break;
  14640. default: error = Error::Read; break;
  14641. }
  14642. }
  14643. return false;
  14644. }
  14645. }
  14646. }
  14647. // Log
  14648. output_log(req, res);
  14649. return true;
  14650. }
  14651. inline ContentProviderWithoutLength ClientImpl::get_multipart_content_provider(
  14652. const std::string &boundary, const UploadFormDataItems &items,
  14653. const FormDataProviderItems &provider_items) const {
  14654. size_t cur_item = 0;
  14655. size_t cur_start = 0;
  14656. // cur_item and cur_start are copied to within the std::function and
  14657. // maintain state between successive calls
  14658. return [&, cur_item, cur_start](size_t offset,
  14659. DataSink &sink) mutable -> bool {
  14660. if (!offset && !items.empty()) {
  14661. sink.os << detail::serialize_multipart_formdata(items, boundary, false);
  14662. return true;
  14663. } else if (cur_item < provider_items.size()) {
  14664. if (!cur_start) {
  14665. const auto &begin = detail::serialize_multipart_formdata_item_begin(
  14666. provider_items[cur_item], boundary);
  14667. offset += begin.size();
  14668. cur_start = offset;
  14669. sink.os << begin;
  14670. }
  14671. DataSink cur_sink;
  14672. auto has_data = true;
  14673. cur_sink.write = sink.write;
  14674. // Forward is_writable so a provider item asking whether it may keep
  14675. // going gets the outer sink's answer rather than the default `true`.
  14676. cur_sink.is_writable = sink.is_writable;
  14677. cur_sink.done = [&]() { has_data = false; };
  14678. if (!provider_items[cur_item].provider(offset - cur_start, cur_sink)) {
  14679. return false;
  14680. }
  14681. if (!has_data) {
  14682. sink.os << detail::serialize_multipart_formdata_item_end();
  14683. cur_item++;
  14684. cur_start = 0;
  14685. }
  14686. return true;
  14687. } else {
  14688. sink.os << detail::serialize_multipart_formdata_finish(boundary);
  14689. sink.done();
  14690. return true;
  14691. }
  14692. };
  14693. }
  14694. inline bool ClientImpl::process_socket(
  14695. const Socket &socket,
  14696. std::chrono::time_point<std::chrono::steady_clock> start_time,
  14697. std::function<bool(Stream &strm)> callback) {
  14698. return detail::process_client_socket(
  14699. socket.sock, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  14700. write_timeout_usec_, max_timeout_msec_, start_time, std::move(callback));
  14701. }
  14702. inline bool ClientImpl::is_ssl() const { return false; }
  14703. inline Result ClientImpl::Get(const std::string &path,
  14704. DownloadProgress progress) {
  14705. return Get(path, Headers(), std::move(progress));
  14706. }
  14707. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14708. DownloadProgress progress) {
  14709. return Get(path, params, Headers(), std::move(progress));
  14710. }
  14711. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14712. const Headers &headers,
  14713. DownloadProgress progress) {
  14714. if (params.empty()) { return Get(path, headers); }
  14715. std::string path_with_query = append_query_params(path, params);
  14716. return Get(path_with_query, headers, std::move(progress));
  14717. }
  14718. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14719. DownloadProgress progress) {
  14720. Request req;
  14721. req.method = "GET";
  14722. req.path = path;
  14723. req.headers = headers;
  14724. req.download_progress = std::move(progress);
  14725. if (max_timeout_msec_ > 0) {
  14726. req.start_time_ = std::chrono::steady_clock::now();
  14727. }
  14728. return send_(std::move(req));
  14729. }
  14730. inline Result ClientImpl::Get(const std::string &path,
  14731. ContentReceiver content_receiver,
  14732. DownloadProgress progress) {
  14733. return Get(path, Headers(), nullptr, std::move(content_receiver),
  14734. std::move(progress));
  14735. }
  14736. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14737. ContentReceiver content_receiver,
  14738. DownloadProgress progress) {
  14739. return Get(path, headers, nullptr, std::move(content_receiver),
  14740. std::move(progress));
  14741. }
  14742. inline Result ClientImpl::Get(const std::string &path,
  14743. ResponseHandler response_handler,
  14744. ContentReceiver content_receiver,
  14745. DownloadProgress progress) {
  14746. return Get(path, Headers(), std::move(response_handler),
  14747. std::move(content_receiver), std::move(progress));
  14748. }
  14749. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14750. ResponseHandler response_handler,
  14751. ContentReceiver content_receiver,
  14752. DownloadProgress progress) {
  14753. Request req;
  14754. req.method = "GET";
  14755. req.path = path;
  14756. req.headers = headers;
  14757. req.response_handler = std::move(response_handler);
  14758. req.content_receiver =
  14759. [content_receiver](const char *data, size_t data_length,
  14760. size_t /*offset*/, size_t /*total_length*/) {
  14761. return content_receiver(data, data_length);
  14762. };
  14763. req.download_progress = std::move(progress);
  14764. if (max_timeout_msec_ > 0) {
  14765. req.start_time_ = std::chrono::steady_clock::now();
  14766. }
  14767. return send_(std::move(req));
  14768. }
  14769. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14770. const Headers &headers,
  14771. ContentReceiver content_receiver,
  14772. DownloadProgress progress) {
  14773. return Get(path, params, headers, nullptr, std::move(content_receiver),
  14774. std::move(progress));
  14775. }
  14776. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14777. const Headers &headers,
  14778. ResponseHandler response_handler,
  14779. ContentReceiver content_receiver,
  14780. DownloadProgress progress) {
  14781. if (params.empty()) {
  14782. return Get(path, headers, std::move(response_handler),
  14783. std::move(content_receiver), std::move(progress));
  14784. }
  14785. std::string path_with_query = append_query_params(path, params);
  14786. return Get(path_with_query, headers, std::move(response_handler),
  14787. std::move(content_receiver), std::move(progress));
  14788. }
  14789. inline Result ClientImpl::Head(const std::string &path) {
  14790. return Head(path, Headers());
  14791. }
  14792. inline Result ClientImpl::Head(const std::string &path,
  14793. const Headers &headers) {
  14794. Request req;
  14795. req.method = "HEAD";
  14796. req.headers = headers;
  14797. req.path = path;
  14798. if (max_timeout_msec_ > 0) {
  14799. req.start_time_ = std::chrono::steady_clock::now();
  14800. }
  14801. return send_(std::move(req));
  14802. }
  14803. inline Result ClientImpl::Post(const std::string &path) {
  14804. return Post(path, std::string(), std::string());
  14805. }
  14806. inline Result ClientImpl::Post(const std::string &path,
  14807. const Headers &headers) {
  14808. return Post(path, headers, nullptr, 0, std::string());
  14809. }
  14810. inline Result ClientImpl::Post(const std::string &path, const char *body,
  14811. size_t content_length,
  14812. const std::string &content_type,
  14813. UploadProgress progress) {
  14814. return Post(path, Headers(), body, content_length, content_type, progress);
  14815. }
  14816. inline Result ClientImpl::Post(const std::string &path, const std::string &body,
  14817. const std::string &content_type,
  14818. UploadProgress progress) {
  14819. return Post(path, Headers(), body, content_type, progress);
  14820. }
  14821. inline Result ClientImpl::Post(const std::string &path, const Params &params) {
  14822. return Post(path, Headers(), params);
  14823. }
  14824. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14825. ContentProvider content_provider,
  14826. const std::string &content_type,
  14827. UploadProgress progress) {
  14828. return Post(path, Headers(), content_length, std::move(content_provider),
  14829. content_type, progress);
  14830. }
  14831. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14832. ContentProvider content_provider,
  14833. const std::string &content_type,
  14834. ContentReceiver content_receiver,
  14835. UploadProgress progress) {
  14836. return Post(path, Headers(), content_length, std::move(content_provider),
  14837. content_type, std::move(content_receiver), progress);
  14838. }
  14839. inline Result ClientImpl::Post(const std::string &path,
  14840. ContentProviderWithoutLength content_provider,
  14841. const std::string &content_type,
  14842. UploadProgress progress) {
  14843. return Post(path, Headers(), std::move(content_provider), content_type,
  14844. progress);
  14845. }
  14846. inline Result ClientImpl::Post(const std::string &path,
  14847. ContentProviderWithoutLength content_provider,
  14848. const std::string &content_type,
  14849. ContentReceiver content_receiver,
  14850. UploadProgress progress) {
  14851. return Post(path, Headers(), std::move(content_provider), content_type,
  14852. std::move(content_receiver), progress);
  14853. }
  14854. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14855. const Params &params) {
  14856. auto query = detail::params_to_query_str(params);
  14857. return Post(path, headers, query, "application/x-www-form-urlencoded");
  14858. }
  14859. inline Result ClientImpl::Post(const std::string &path,
  14860. const UploadFormDataItems &items,
  14861. UploadProgress progress) {
  14862. return Post(path, Headers(), items, progress);
  14863. }
  14864. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14865. const UploadFormDataItems &items,
  14866. UploadProgress progress) {
  14867. const auto &boundary = detail::make_multipart_data_boundary();
  14868. const auto &content_type =
  14869. detail::serialize_multipart_formdata_get_content_type(boundary);
  14870. auto content_length = detail::get_multipart_content_length(items, boundary);
  14871. return Post(path, headers, content_length,
  14872. detail::make_multipart_content_provider(items, boundary),
  14873. content_type, progress);
  14874. }
  14875. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14876. const UploadFormDataItems &items,
  14877. const std::string &boundary,
  14878. UploadProgress progress) {
  14879. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14880. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14881. }
  14882. const auto &content_type =
  14883. detail::serialize_multipart_formdata_get_content_type(boundary);
  14884. auto content_length = detail::get_multipart_content_length(items, boundary);
  14885. return Post(path, headers, content_length,
  14886. detail::make_multipart_content_provider(items, boundary),
  14887. content_type, progress);
  14888. }
  14889. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14890. const char *body, size_t content_length,
  14891. const std::string &content_type,
  14892. UploadProgress progress) {
  14893. return send_with_content_provider_and_receiver(
  14894. "POST", path, headers, body, content_length, nullptr, nullptr,
  14895. content_type, nullptr, progress);
  14896. }
  14897. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14898. const std::string &body,
  14899. const std::string &content_type,
  14900. UploadProgress progress) {
  14901. return send_with_content_provider_and_receiver(
  14902. "POST", path, headers, body.data(), body.size(), nullptr, nullptr,
  14903. content_type, nullptr, progress);
  14904. }
  14905. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14906. size_t content_length,
  14907. ContentProvider content_provider,
  14908. const std::string &content_type,
  14909. UploadProgress progress) {
  14910. return send_with_content_provider_and_receiver(
  14911. "POST", path, headers, nullptr, content_length,
  14912. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14913. }
  14914. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14915. size_t content_length,
  14916. ContentProvider content_provider,
  14917. const std::string &content_type,
  14918. ContentReceiver content_receiver,
  14919. DownloadProgress progress) {
  14920. return send_with_content_provider_and_receiver(
  14921. "POST", path, headers, nullptr, content_length,
  14922. std::move(content_provider), nullptr, content_type,
  14923. std::move(content_receiver), std::move(progress));
  14924. }
  14925. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14926. ContentProviderWithoutLength content_provider,
  14927. const std::string &content_type,
  14928. UploadProgress progress) {
  14929. return send_with_content_provider_and_receiver(
  14930. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14931. content_type, nullptr, progress);
  14932. }
  14933. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14934. ContentProviderWithoutLength content_provider,
  14935. const std::string &content_type,
  14936. ContentReceiver content_receiver,
  14937. DownloadProgress progress) {
  14938. return send_with_content_provider_and_receiver(
  14939. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14940. content_type, std::move(content_receiver), std::move(progress));
  14941. }
  14942. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14943. const UploadFormDataItems &items,
  14944. const FormDataProviderItems &provider_items,
  14945. UploadProgress progress) {
  14946. const auto &boundary = detail::make_multipart_data_boundary();
  14947. const auto &content_type =
  14948. detail::serialize_multipart_formdata_get_content_type(boundary);
  14949. return send_with_content_provider_and_receiver(
  14950. "POST", path, headers, nullptr, 0, nullptr,
  14951. get_multipart_content_provider(boundary, items, provider_items),
  14952. content_type, nullptr, progress);
  14953. }
  14954. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14955. const std::string &body,
  14956. const std::string &content_type,
  14957. ContentReceiver content_receiver,
  14958. DownloadProgress progress) {
  14959. Request req;
  14960. req.method = "POST";
  14961. req.path = path;
  14962. req.headers = headers;
  14963. req.body = body;
  14964. req.content_receiver =
  14965. [content_receiver](const char *data, size_t data_length,
  14966. size_t /*offset*/, size_t /*total_length*/) {
  14967. return content_receiver(data, data_length);
  14968. };
  14969. req.download_progress = std::move(progress);
  14970. if (max_timeout_msec_ > 0) {
  14971. req.start_time_ = std::chrono::steady_clock::now();
  14972. }
  14973. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14974. return send_(std::move(req));
  14975. }
  14976. inline Result ClientImpl::Put(const std::string &path) {
  14977. return Put(path, std::string(), std::string());
  14978. }
  14979. inline Result ClientImpl::Put(const std::string &path, const Headers &headers) {
  14980. return Put(path, headers, nullptr, 0, std::string());
  14981. }
  14982. inline Result ClientImpl::Put(const std::string &path, const char *body,
  14983. size_t content_length,
  14984. const std::string &content_type,
  14985. UploadProgress progress) {
  14986. return Put(path, Headers(), body, content_length, content_type, progress);
  14987. }
  14988. inline Result ClientImpl::Put(const std::string &path, const std::string &body,
  14989. const std::string &content_type,
  14990. UploadProgress progress) {
  14991. return Put(path, Headers(), body, content_type, progress);
  14992. }
  14993. inline Result ClientImpl::Put(const std::string &path, const Params &params) {
  14994. return Put(path, Headers(), params);
  14995. }
  14996. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14997. ContentProvider content_provider,
  14998. const std::string &content_type,
  14999. UploadProgress progress) {
  15000. return Put(path, Headers(), content_length, std::move(content_provider),
  15001. content_type, progress);
  15002. }
  15003. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  15004. ContentProvider content_provider,
  15005. const std::string &content_type,
  15006. ContentReceiver content_receiver,
  15007. UploadProgress progress) {
  15008. return Put(path, Headers(), content_length, std::move(content_provider),
  15009. content_type, std::move(content_receiver), progress);
  15010. }
  15011. inline Result ClientImpl::Put(const std::string &path,
  15012. ContentProviderWithoutLength content_provider,
  15013. const std::string &content_type,
  15014. UploadProgress progress) {
  15015. return Put(path, Headers(), std::move(content_provider), content_type,
  15016. progress);
  15017. }
  15018. inline Result ClientImpl::Put(const std::string &path,
  15019. ContentProviderWithoutLength content_provider,
  15020. const std::string &content_type,
  15021. ContentReceiver content_receiver,
  15022. UploadProgress progress) {
  15023. return Put(path, Headers(), std::move(content_provider), content_type,
  15024. std::move(content_receiver), progress);
  15025. }
  15026. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15027. const Params &params) {
  15028. auto query = detail::params_to_query_str(params);
  15029. return Put(path, headers, query, "application/x-www-form-urlencoded");
  15030. }
  15031. inline Result ClientImpl::Put(const std::string &path,
  15032. const UploadFormDataItems &items,
  15033. UploadProgress progress) {
  15034. return Put(path, Headers(), items, progress);
  15035. }
  15036. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15037. const UploadFormDataItems &items,
  15038. UploadProgress progress) {
  15039. const auto &boundary = detail::make_multipart_data_boundary();
  15040. const auto &content_type =
  15041. detail::serialize_multipart_formdata_get_content_type(boundary);
  15042. auto content_length = detail::get_multipart_content_length(items, boundary);
  15043. return Put(path, headers, content_length,
  15044. detail::make_multipart_content_provider(items, boundary),
  15045. content_type, progress);
  15046. }
  15047. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15048. const UploadFormDataItems &items,
  15049. const std::string &boundary,
  15050. UploadProgress progress) {
  15051. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  15052. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  15053. }
  15054. const auto &content_type =
  15055. detail::serialize_multipart_formdata_get_content_type(boundary);
  15056. auto content_length = detail::get_multipart_content_length(items, boundary);
  15057. return Put(path, headers, content_length,
  15058. detail::make_multipart_content_provider(items, boundary),
  15059. content_type, progress);
  15060. }
  15061. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15062. const char *body, size_t content_length,
  15063. const std::string &content_type,
  15064. UploadProgress progress) {
  15065. return send_with_content_provider_and_receiver(
  15066. "PUT", path, headers, body, content_length, nullptr, nullptr,
  15067. content_type, nullptr, progress);
  15068. }
  15069. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15070. const std::string &body,
  15071. const std::string &content_type,
  15072. UploadProgress progress) {
  15073. return send_with_content_provider_and_receiver(
  15074. "PUT", path, headers, body.data(), body.size(), nullptr, nullptr,
  15075. content_type, nullptr, progress);
  15076. }
  15077. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15078. size_t content_length,
  15079. ContentProvider content_provider,
  15080. const std::string &content_type,
  15081. UploadProgress progress) {
  15082. return send_with_content_provider_and_receiver(
  15083. "PUT", path, headers, nullptr, content_length,
  15084. std::move(content_provider), nullptr, content_type, nullptr, progress);
  15085. }
  15086. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15087. size_t content_length,
  15088. ContentProvider content_provider,
  15089. const std::string &content_type,
  15090. ContentReceiver content_receiver,
  15091. UploadProgress progress) {
  15092. return send_with_content_provider_and_receiver(
  15093. "PUT", path, headers, nullptr, content_length,
  15094. std::move(content_provider), nullptr, content_type,
  15095. std::move(content_receiver), progress);
  15096. }
  15097. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15098. ContentProviderWithoutLength content_provider,
  15099. const std::string &content_type,
  15100. UploadProgress progress) {
  15101. return send_with_content_provider_and_receiver(
  15102. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15103. content_type, nullptr, progress);
  15104. }
  15105. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15106. ContentProviderWithoutLength content_provider,
  15107. const std::string &content_type,
  15108. ContentReceiver content_receiver,
  15109. UploadProgress progress) {
  15110. return send_with_content_provider_and_receiver(
  15111. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15112. content_type, std::move(content_receiver), progress);
  15113. }
  15114. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15115. const UploadFormDataItems &items,
  15116. const FormDataProviderItems &provider_items,
  15117. UploadProgress progress) {
  15118. const auto &boundary = detail::make_multipart_data_boundary();
  15119. const auto &content_type =
  15120. detail::serialize_multipart_formdata_get_content_type(boundary);
  15121. return send_with_content_provider_and_receiver(
  15122. "PUT", path, headers, nullptr, 0, nullptr,
  15123. get_multipart_content_provider(boundary, items, provider_items),
  15124. content_type, nullptr, progress);
  15125. }
  15126. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15127. const std::string &body,
  15128. const std::string &content_type,
  15129. ContentReceiver content_receiver,
  15130. DownloadProgress progress) {
  15131. Request req;
  15132. req.method = "PUT";
  15133. req.path = path;
  15134. req.headers = headers;
  15135. req.body = body;
  15136. req.content_receiver =
  15137. [content_receiver](const char *data, size_t data_length,
  15138. size_t /*offset*/, size_t /*total_length*/) {
  15139. return content_receiver(data, data_length);
  15140. };
  15141. req.download_progress = std::move(progress);
  15142. if (max_timeout_msec_ > 0) {
  15143. req.start_time_ = std::chrono::steady_clock::now();
  15144. }
  15145. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15146. return send_(std::move(req));
  15147. }
  15148. inline Result ClientImpl::Patch(const std::string &path) {
  15149. return Patch(path, std::string(), std::string());
  15150. }
  15151. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15152. UploadProgress progress) {
  15153. return Patch(path, headers, nullptr, 0, std::string(), progress);
  15154. }
  15155. inline Result ClientImpl::Patch(const std::string &path, const char *body,
  15156. size_t content_length,
  15157. const std::string &content_type,
  15158. UploadProgress progress) {
  15159. return Patch(path, Headers(), body, content_length, content_type, progress);
  15160. }
  15161. inline Result ClientImpl::Patch(const std::string &path,
  15162. const std::string &body,
  15163. const std::string &content_type,
  15164. UploadProgress progress) {
  15165. return Patch(path, Headers(), body, content_type, progress);
  15166. }
  15167. inline Result ClientImpl::Patch(const std::string &path, const Params &params) {
  15168. return Patch(path, Headers(), params);
  15169. }
  15170. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  15171. ContentProvider content_provider,
  15172. const std::string &content_type,
  15173. UploadProgress progress) {
  15174. return Patch(path, Headers(), content_length, std::move(content_provider),
  15175. content_type, progress);
  15176. }
  15177. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  15178. ContentProvider content_provider,
  15179. const std::string &content_type,
  15180. ContentReceiver content_receiver,
  15181. UploadProgress progress) {
  15182. return Patch(path, Headers(), content_length, std::move(content_provider),
  15183. content_type, std::move(content_receiver), progress);
  15184. }
  15185. inline Result ClientImpl::Patch(const std::string &path,
  15186. ContentProviderWithoutLength content_provider,
  15187. const std::string &content_type,
  15188. UploadProgress progress) {
  15189. return Patch(path, Headers(), std::move(content_provider), content_type,
  15190. progress);
  15191. }
  15192. inline Result ClientImpl::Patch(const std::string &path,
  15193. ContentProviderWithoutLength content_provider,
  15194. const std::string &content_type,
  15195. ContentReceiver content_receiver,
  15196. UploadProgress progress) {
  15197. return Patch(path, Headers(), std::move(content_provider), content_type,
  15198. std::move(content_receiver), progress);
  15199. }
  15200. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15201. const Params &params) {
  15202. auto query = detail::params_to_query_str(params);
  15203. return Patch(path, headers, query, "application/x-www-form-urlencoded");
  15204. }
  15205. inline Result ClientImpl::Patch(const std::string &path,
  15206. const UploadFormDataItems &items,
  15207. UploadProgress progress) {
  15208. return Patch(path, Headers(), items, progress);
  15209. }
  15210. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15211. const UploadFormDataItems &items,
  15212. UploadProgress progress) {
  15213. const auto &boundary = detail::make_multipart_data_boundary();
  15214. const auto &content_type =
  15215. detail::serialize_multipart_formdata_get_content_type(boundary);
  15216. auto content_length = detail::get_multipart_content_length(items, boundary);
  15217. return Patch(path, headers, content_length,
  15218. detail::make_multipart_content_provider(items, boundary),
  15219. content_type, progress);
  15220. }
  15221. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15222. const UploadFormDataItems &items,
  15223. const std::string &boundary,
  15224. UploadProgress progress) {
  15225. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  15226. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  15227. }
  15228. const auto &content_type =
  15229. detail::serialize_multipart_formdata_get_content_type(boundary);
  15230. auto content_length = detail::get_multipart_content_length(items, boundary);
  15231. return Patch(path, headers, content_length,
  15232. detail::make_multipart_content_provider(items, boundary),
  15233. content_type, progress);
  15234. }
  15235. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15236. const char *body, size_t content_length,
  15237. const std::string &content_type,
  15238. UploadProgress progress) {
  15239. return send_with_content_provider_and_receiver(
  15240. "PATCH", path, headers, body, content_length, nullptr, nullptr,
  15241. content_type, nullptr, progress);
  15242. }
  15243. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15244. const std::string &body,
  15245. const std::string &content_type,
  15246. UploadProgress progress) {
  15247. return send_with_content_provider_and_receiver(
  15248. "PATCH", path, headers, body.data(), body.size(), nullptr, nullptr,
  15249. content_type, nullptr, progress);
  15250. }
  15251. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15252. size_t content_length,
  15253. ContentProvider content_provider,
  15254. const std::string &content_type,
  15255. UploadProgress progress) {
  15256. return send_with_content_provider_and_receiver(
  15257. "PATCH", path, headers, nullptr, content_length,
  15258. std::move(content_provider), nullptr, content_type, nullptr, progress);
  15259. }
  15260. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15261. size_t content_length,
  15262. ContentProvider content_provider,
  15263. const std::string &content_type,
  15264. ContentReceiver content_receiver,
  15265. UploadProgress progress) {
  15266. return send_with_content_provider_and_receiver(
  15267. "PATCH", path, headers, nullptr, content_length,
  15268. std::move(content_provider), nullptr, content_type,
  15269. std::move(content_receiver), progress);
  15270. }
  15271. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15272. ContentProviderWithoutLength content_provider,
  15273. const std::string &content_type,
  15274. UploadProgress progress) {
  15275. return send_with_content_provider_and_receiver(
  15276. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15277. content_type, nullptr, progress);
  15278. }
  15279. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15280. ContentProviderWithoutLength content_provider,
  15281. const std::string &content_type,
  15282. ContentReceiver content_receiver,
  15283. UploadProgress progress) {
  15284. return send_with_content_provider_and_receiver(
  15285. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15286. content_type, std::move(content_receiver), progress);
  15287. }
  15288. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15289. const UploadFormDataItems &items,
  15290. const FormDataProviderItems &provider_items,
  15291. UploadProgress progress) {
  15292. const auto &boundary = detail::make_multipart_data_boundary();
  15293. const auto &content_type =
  15294. detail::serialize_multipart_formdata_get_content_type(boundary);
  15295. return send_with_content_provider_and_receiver(
  15296. "PATCH", path, headers, nullptr, 0, nullptr,
  15297. get_multipart_content_provider(boundary, items, provider_items),
  15298. content_type, nullptr, progress);
  15299. }
  15300. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15301. const std::string &body,
  15302. const std::string &content_type,
  15303. ContentReceiver content_receiver,
  15304. DownloadProgress progress) {
  15305. Request req;
  15306. req.method = "PATCH";
  15307. req.path = path;
  15308. req.headers = headers;
  15309. req.body = body;
  15310. req.content_receiver =
  15311. [content_receiver](const char *data, size_t data_length,
  15312. size_t /*offset*/, size_t /*total_length*/) {
  15313. return content_receiver(data, data_length);
  15314. };
  15315. req.download_progress = std::move(progress);
  15316. if (max_timeout_msec_ > 0) {
  15317. req.start_time_ = std::chrono::steady_clock::now();
  15318. }
  15319. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15320. return send_(std::move(req));
  15321. }
  15322. inline Result ClientImpl::Delete(const std::string &path,
  15323. DownloadProgress progress) {
  15324. return Delete(path, Headers(), std::string(), std::string(), progress);
  15325. }
  15326. inline Result ClientImpl::Delete(const std::string &path,
  15327. const Headers &headers,
  15328. DownloadProgress progress) {
  15329. return Delete(path, headers, std::string(), std::string(), progress);
  15330. }
  15331. inline Result ClientImpl::Delete(const std::string &path, const char *body,
  15332. size_t content_length,
  15333. const std::string &content_type,
  15334. DownloadProgress progress) {
  15335. return Delete(path, Headers(), body, content_length, content_type, progress);
  15336. }
  15337. inline Result ClientImpl::Delete(const std::string &path,
  15338. const std::string &body,
  15339. const std::string &content_type,
  15340. DownloadProgress progress) {
  15341. return Delete(path, Headers(), body.data(), body.size(), content_type,
  15342. progress);
  15343. }
  15344. inline Result ClientImpl::Delete(const std::string &path,
  15345. const Headers &headers,
  15346. const std::string &body,
  15347. const std::string &content_type,
  15348. DownloadProgress progress) {
  15349. return Delete(path, headers, body.data(), body.size(), content_type,
  15350. progress);
  15351. }
  15352. inline Result ClientImpl::Delete(const std::string &path, const Params &params,
  15353. DownloadProgress progress) {
  15354. return Delete(path, Headers(), params, progress);
  15355. }
  15356. inline Result ClientImpl::Delete(const std::string &path,
  15357. const Headers &headers, const Params &params,
  15358. DownloadProgress progress) {
  15359. auto query = detail::params_to_query_str(params);
  15360. return Delete(path, headers, query, "application/x-www-form-urlencoded",
  15361. progress);
  15362. }
  15363. inline Result ClientImpl::Delete(const std::string &path,
  15364. const Headers &headers, const char *body,
  15365. size_t content_length,
  15366. const std::string &content_type,
  15367. DownloadProgress progress) {
  15368. Request req;
  15369. req.method = "DELETE";
  15370. req.headers = headers;
  15371. req.path = path;
  15372. req.download_progress = std::move(progress);
  15373. if (max_timeout_msec_ > 0) {
  15374. req.start_time_ = std::chrono::steady_clock::now();
  15375. }
  15376. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15377. req.body.assign(body, content_length);
  15378. return send_(std::move(req));
  15379. }
  15380. inline Result ClientImpl::Options(const std::string &path) {
  15381. return Options(path, Headers());
  15382. }
  15383. inline Result ClientImpl::Options(const std::string &path,
  15384. const Headers &headers) {
  15385. Request req;
  15386. req.method = "OPTIONS";
  15387. req.headers = headers;
  15388. req.path = path;
  15389. if (max_timeout_msec_ > 0) {
  15390. req.start_time_ = std::chrono::steady_clock::now();
  15391. }
  15392. return send_(std::move(req));
  15393. }
  15394. inline void ClientImpl::stop() {
  15395. std::lock_guard<std::mutex> guard(socket_mutex_);
  15396. // If there is anything ongoing right now, the ONLY thread-safe thing we can
  15397. // do is to shutdown_socket, so that threads using this socket suddenly
  15398. // discover they can't read/write any more and error out. Everything else
  15399. // (closing the socket, shutting ssl down) is unsafe because these actions
  15400. // are not thread-safe.
  15401. if (socket_requests_in_flight_ > 0) {
  15402. shutdown_socket(socket_);
  15403. // Aside from that, we set a flag for the socket to be closed when we're
  15404. // done.
  15405. socket_should_be_closed_when_request_is_done_ = true;
  15406. return;
  15407. }
  15408. disconnect(/*gracefully=*/true);
  15409. }
  15410. inline std::string ClientImpl::host() const { return host_; }
  15411. inline int ClientImpl::port() const { return port_; }
  15412. inline size_t ClientImpl::is_socket_open() const {
  15413. std::lock_guard<std::mutex> guard(socket_mutex_);
  15414. return socket_.is_open();
  15415. }
  15416. inline socket_t ClientImpl::socket() const { return socket_.sock; }
  15417. inline void ClientImpl::set_connection_timeout(time_t sec, time_t usec) {
  15418. connection_timeout_sec_ = sec;
  15419. connection_timeout_usec_ = usec;
  15420. }
  15421. inline void ClientImpl::set_read_timeout(time_t sec, time_t usec) {
  15422. read_timeout_sec_ = sec;
  15423. read_timeout_usec_ = usec;
  15424. }
  15425. inline void ClientImpl::set_write_timeout(time_t sec, time_t usec) {
  15426. write_timeout_sec_ = sec;
  15427. write_timeout_usec_ = usec;
  15428. }
  15429. inline void ClientImpl::set_max_timeout(time_t msec) {
  15430. max_timeout_msec_ = msec;
  15431. }
  15432. inline void ClientImpl::set_basic_auth(const std::string &username,
  15433. const std::string &password) {
  15434. basic_auth_username_ = username;
  15435. basic_auth_password_ = password;
  15436. }
  15437. inline void ClientImpl::set_bearer_token_auth(const std::string &token) {
  15438. bearer_token_auth_token_ = token;
  15439. }
  15440. inline void ClientImpl::set_keep_alive(bool on) { keep_alive_ = on; }
  15441. inline void ClientImpl::set_follow_location(bool on) { follow_location_ = on; }
  15442. inline void ClientImpl::set_path_encode(bool on) { path_encode_ = on; }
  15443. inline void
  15444. ClientImpl::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15445. set_direct_hostname_addr_map(std::move(addr_map));
  15446. }
  15447. inline void ClientImpl::set_direct_hostname_addr_map(
  15448. std::map<std::string, std::string> addr_map) {
  15449. addr_map_ = std::move(addr_map);
  15450. }
  15451. inline void ClientImpl::set_tunnel_hostname_addr_map(
  15452. std::map<std::string, std::string> addr_map) {
  15453. tunnel_addr_map_ = std::move(addr_map);
  15454. }
  15455. inline void ClientImpl::set_default_headers(Headers headers) {
  15456. default_headers_ = std::move(headers);
  15457. }
  15458. inline void ClientImpl::set_header_writer(
  15459. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15460. header_writer_ = writer;
  15461. }
  15462. inline void ClientImpl::set_address_family(int family) {
  15463. address_family_ = family;
  15464. }
  15465. inline void ClientImpl::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  15466. inline void ClientImpl::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  15467. inline void ClientImpl::set_socket_options(SocketOptions socket_options) {
  15468. socket_options_ = std::move(socket_options);
  15469. }
  15470. inline void ClientImpl::set_compress(bool on) { compress_ = on; }
  15471. inline void ClientImpl::set_decompress(bool on) { decompress_ = on; }
  15472. inline void ClientImpl::set_payload_max_length(size_t length) {
  15473. payload_max_length_ = length;
  15474. has_payload_max_length_ = true;
  15475. }
  15476. inline void ClientImpl::set_interface(const std::string &intf) {
  15477. interface_ = intf;
  15478. }
  15479. inline void ClientImpl::set_proxy(const std::string &host, int port) {
  15480. proxy_host_ = host;
  15481. proxy_port_ = port;
  15482. std::lock_guard<std::mutex> guard(socket_mutex_);
  15483. disconnect(/*gracefully=*/true);
  15484. }
  15485. inline void ClientImpl::set_proxy_basic_auth(const std::string &username,
  15486. const std::string &password) {
  15487. proxy_basic_auth_username_ = username;
  15488. proxy_basic_auth_password_ = password;
  15489. }
  15490. inline void ClientImpl::set_proxy_bearer_token_auth(const std::string &token) {
  15491. proxy_bearer_token_auth_token_ = token;
  15492. }
  15493. inline void ClientImpl::set_no_proxy(const std::vector<std::string> &patterns) {
  15494. no_proxy_entries_ = detail::parse_no_proxy_entries(patterns);
  15495. std::lock_guard<std::mutex> guard(socket_mutex_);
  15496. disconnect(/*gracefully=*/true);
  15497. }
  15498. #ifdef CPPHTTPLIB_SSL_ENABLED
  15499. inline void ClientImpl::set_digest_auth(const std::string &username,
  15500. const std::string &password) {
  15501. digest_auth_username_ = username;
  15502. digest_auth_password_ = password;
  15503. }
  15504. inline void ClientImpl::set_ca_cert_path(const std::string &ca_cert_file_path,
  15505. const std::string &ca_cert_dir_path) {
  15506. ca_cert_file_path_ = ca_cert_file_path;
  15507. ca_cert_dir_path_ = ca_cert_dir_path;
  15508. }
  15509. inline void ClientImpl::set_proxy_digest_auth(const std::string &username,
  15510. const std::string &password) {
  15511. proxy_digest_auth_username_ = username;
  15512. proxy_digest_auth_password_ = password;
  15513. }
  15514. inline void ClientImpl::enable_server_certificate_verification(bool enabled) {
  15515. if (server_certificate_verification_ == enabled) { return; }
  15516. server_certificate_verification_ = enabled;
  15517. tls_settings_changed();
  15518. }
  15519. inline void ClientImpl::enable_server_hostname_verification(bool enabled) {
  15520. if (server_hostname_verification_ == enabled) { return; }
  15521. server_hostname_verification_ = enabled;
  15522. tls_settings_changed();
  15523. }
  15524. inline void ClientImpl::enable_system_ca(bool enabled) {
  15525. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  15526. }
  15527. #endif
  15528. inline void ClientImpl::set_logger(Logger logger) {
  15529. logger_ = std::move(logger);
  15530. }
  15531. inline void ClientImpl::set_error_logger(ErrorLogger error_logger) {
  15532. error_logger_ = std::move(error_logger);
  15533. }
  15534. /*
  15535. * SSL/TLS Common Implementation
  15536. */
  15537. inline ClientConnection::~ClientConnection() {
  15538. #ifdef CPPHTTPLIB_SSL_ENABLED
  15539. if (session) {
  15540. tls::shutdown(session, true);
  15541. tls::free_session(session);
  15542. session = nullptr;
  15543. }
  15544. #endif
  15545. if (sock != INVALID_SOCKET) {
  15546. detail::close_socket(sock);
  15547. sock = INVALID_SOCKET;
  15548. }
  15549. }
  15550. // Universal client implementation
  15551. inline Client::Client(const std::string &scheme_host_port)
  15552. : Client(scheme_host_port, std::string(), std::string()) {}
  15553. inline Client::Client(const std::string &scheme_host_port,
  15554. const std::string &client_cert_path,
  15555. const std::string &client_key_path) {
  15556. detail::UrlComponents uc;
  15557. if (detail::parse_url(scheme_host_port, uc) && !uc.host.empty()) {
  15558. auto &scheme = uc.scheme;
  15559. #ifdef CPPHTTPLIB_SSL_ENABLED
  15560. if (!scheme.empty() && (scheme != "http" && scheme != "https")) {
  15561. #else
  15562. if (!scheme.empty() && scheme != "http") {
  15563. #endif
  15564. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  15565. std::string msg = "'" + scheme + "' scheme is not supported.";
  15566. throw std::invalid_argument(msg);
  15567. #endif
  15568. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15569. return;
  15570. }
  15571. auto is_ssl = scheme == "https";
  15572. auto host = std::move(uc.host);
  15573. auto port = is_ssl ? 443 : 80;
  15574. if (!uc.port.empty() && !detail::parse_port(uc.port, port)) {
  15575. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15576. return;
  15577. }
  15578. if (is_ssl) {
  15579. #ifdef CPPHTTPLIB_SSL_ENABLED
  15580. cli_ = detail::make_unique<SSLClient>(host, port, client_cert_path,
  15581. client_key_path);
  15582. is_ssl_ = is_ssl;
  15583. #endif
  15584. } else {
  15585. cli_ = detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15586. client_key_path);
  15587. }
  15588. } else if (scheme_host_port.compare(0, 2, "//") == 0 ||
  15589. scheme_host_port.find("://") < scheme_host_port.find('/')) {
  15590. // A URL, but not one this client can use, such as one with userinfo. A
  15591. // Unix socket path may have "//" further on.
  15592. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15593. } else {
  15594. // NOTE: Update TEST(UniversalClientImplTest, Ipv6LiteralAddress)
  15595. // if port param below changes.
  15596. cli_ = detail::make_unique<ClientImpl>(scheme_host_port, 80,
  15597. client_cert_path, client_key_path);
  15598. }
  15599. }
  15600. inline Client::Client(const std::string &host, int port)
  15601. : Client(host, port, std::string(), std::string()) {}
  15602. inline Client::Client(const std::string &host, int port,
  15603. const std::string &client_cert_path,
  15604. const std::string &client_key_path)
  15605. : cli_(detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15606. client_key_path)) {}
  15607. inline Client::~Client() = default;
  15608. inline bool Client::is_valid() const {
  15609. return cli_ != nullptr && cli_->is_valid();
  15610. }
  15611. inline Result Client::Get(const std::string &path, DownloadProgress progress) {
  15612. return cli_->Get(path, std::move(progress));
  15613. }
  15614. inline Result Client::Get(const std::string &path, const Headers &headers,
  15615. DownloadProgress progress) {
  15616. return cli_->Get(path, headers, std::move(progress));
  15617. }
  15618. inline Result Client::Get(const std::string &path,
  15619. ContentReceiver content_receiver,
  15620. DownloadProgress progress) {
  15621. return cli_->Get(path, std::move(content_receiver), std::move(progress));
  15622. }
  15623. inline Result Client::Get(const std::string &path, const Headers &headers,
  15624. ContentReceiver content_receiver,
  15625. DownloadProgress progress) {
  15626. return cli_->Get(path, headers, std::move(content_receiver),
  15627. std::move(progress));
  15628. }
  15629. inline Result Client::Get(const std::string &path,
  15630. ResponseHandler response_handler,
  15631. ContentReceiver content_receiver,
  15632. DownloadProgress progress) {
  15633. return cli_->Get(path, std::move(response_handler),
  15634. std::move(content_receiver), std::move(progress));
  15635. }
  15636. inline Result Client::Get(const std::string &path, const Headers &headers,
  15637. ResponseHandler response_handler,
  15638. ContentReceiver content_receiver,
  15639. DownloadProgress progress) {
  15640. return cli_->Get(path, headers, std::move(response_handler),
  15641. std::move(content_receiver), std::move(progress));
  15642. }
  15643. inline Result Client::Get(const std::string &path, const Params &params,
  15644. DownloadProgress progress) {
  15645. return cli_->Get(path, params, std::move(progress));
  15646. }
  15647. inline Result Client::Get(const std::string &path, const Params &params,
  15648. const Headers &headers, DownloadProgress progress) {
  15649. return cli_->Get(path, params, headers, std::move(progress));
  15650. }
  15651. inline Result Client::Get(const std::string &path, const Params &params,
  15652. const Headers &headers,
  15653. ContentReceiver content_receiver,
  15654. DownloadProgress progress) {
  15655. return cli_->Get(path, params, headers, std::move(content_receiver),
  15656. std::move(progress));
  15657. }
  15658. inline Result Client::Get(const std::string &path, const Params &params,
  15659. const Headers &headers,
  15660. ResponseHandler response_handler,
  15661. ContentReceiver content_receiver,
  15662. DownloadProgress progress) {
  15663. return cli_->Get(path, params, headers, std::move(response_handler),
  15664. std::move(content_receiver), std::move(progress));
  15665. }
  15666. inline Result Client::Head(const std::string &path) { return cli_->Head(path); }
  15667. inline Result Client::Head(const std::string &path, const Headers &headers) {
  15668. return cli_->Head(path, headers);
  15669. }
  15670. inline Result Client::Post(const std::string &path) { return cli_->Post(path); }
  15671. inline Result Client::Post(const std::string &path, const Headers &headers) {
  15672. return cli_->Post(path, headers);
  15673. }
  15674. inline Result Client::Post(const std::string &path, const char *body,
  15675. size_t content_length,
  15676. const std::string &content_type,
  15677. UploadProgress progress) {
  15678. return cli_->Post(path, body, content_length, content_type, progress);
  15679. }
  15680. inline Result Client::Post(const std::string &path, const Headers &headers,
  15681. const char *body, size_t content_length,
  15682. const std::string &content_type,
  15683. UploadProgress progress) {
  15684. return cli_->Post(path, headers, body, content_length, content_type,
  15685. progress);
  15686. }
  15687. inline Result Client::Post(const std::string &path, const std::string &body,
  15688. const std::string &content_type,
  15689. UploadProgress progress) {
  15690. return cli_->Post(path, body, content_type, progress);
  15691. }
  15692. inline Result Client::Post(const std::string &path, const Headers &headers,
  15693. const std::string &body,
  15694. const std::string &content_type,
  15695. UploadProgress progress) {
  15696. return cli_->Post(path, headers, body, content_type, progress);
  15697. }
  15698. inline Result Client::Post(const std::string &path, size_t content_length,
  15699. ContentProvider content_provider,
  15700. const std::string &content_type,
  15701. UploadProgress progress) {
  15702. return cli_->Post(path, content_length, std::move(content_provider),
  15703. content_type, progress);
  15704. }
  15705. inline Result Client::Post(const std::string &path, size_t content_length,
  15706. ContentProvider content_provider,
  15707. const std::string &content_type,
  15708. ContentReceiver content_receiver,
  15709. UploadProgress progress) {
  15710. return cli_->Post(path, content_length, std::move(content_provider),
  15711. content_type, std::move(content_receiver), progress);
  15712. }
  15713. inline Result Client::Post(const std::string &path,
  15714. ContentProviderWithoutLength content_provider,
  15715. const std::string &content_type,
  15716. UploadProgress progress) {
  15717. return cli_->Post(path, std::move(content_provider), content_type, progress);
  15718. }
  15719. inline Result Client::Post(const std::string &path,
  15720. ContentProviderWithoutLength content_provider,
  15721. const std::string &content_type,
  15722. ContentReceiver content_receiver,
  15723. UploadProgress progress) {
  15724. return cli_->Post(path, std::move(content_provider), content_type,
  15725. std::move(content_receiver), progress);
  15726. }
  15727. inline Result Client::Post(const std::string &path, const Headers &headers,
  15728. size_t content_length,
  15729. ContentProvider content_provider,
  15730. const std::string &content_type,
  15731. UploadProgress progress) {
  15732. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15733. content_type, progress);
  15734. }
  15735. inline Result Client::Post(const std::string &path, const Headers &headers,
  15736. size_t content_length,
  15737. ContentProvider content_provider,
  15738. const std::string &content_type,
  15739. ContentReceiver content_receiver,
  15740. DownloadProgress progress) {
  15741. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15742. content_type, std::move(content_receiver), progress);
  15743. }
  15744. inline Result Client::Post(const std::string &path, const Headers &headers,
  15745. ContentProviderWithoutLength content_provider,
  15746. const std::string &content_type,
  15747. UploadProgress progress) {
  15748. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15749. progress);
  15750. }
  15751. inline Result Client::Post(const std::string &path, const Headers &headers,
  15752. ContentProviderWithoutLength content_provider,
  15753. const std::string &content_type,
  15754. ContentReceiver content_receiver,
  15755. DownloadProgress progress) {
  15756. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15757. std::move(content_receiver), progress);
  15758. }
  15759. inline Result Client::Post(const std::string &path, const Params &params) {
  15760. return cli_->Post(path, params);
  15761. }
  15762. inline Result Client::Post(const std::string &path, const Headers &headers,
  15763. const Params &params) {
  15764. return cli_->Post(path, headers, params);
  15765. }
  15766. inline Result Client::Post(const std::string &path,
  15767. const UploadFormDataItems &items,
  15768. UploadProgress progress) {
  15769. return cli_->Post(path, items, progress);
  15770. }
  15771. inline Result Client::Post(const std::string &path, const Headers &headers,
  15772. const UploadFormDataItems &items,
  15773. UploadProgress progress) {
  15774. return cli_->Post(path, headers, items, progress);
  15775. }
  15776. inline Result Client::Post(const std::string &path, const Headers &headers,
  15777. const UploadFormDataItems &items,
  15778. const std::string &boundary,
  15779. UploadProgress progress) {
  15780. return cli_->Post(path, headers, items, boundary, progress);
  15781. }
  15782. inline Result Client::Post(const std::string &path, const Headers &headers,
  15783. const UploadFormDataItems &items,
  15784. const FormDataProviderItems &provider_items,
  15785. UploadProgress progress) {
  15786. return cli_->Post(path, headers, items, provider_items, progress);
  15787. }
  15788. inline Result Client::Post(const std::string &path, const Headers &headers,
  15789. const std::string &body,
  15790. const std::string &content_type,
  15791. ContentReceiver content_receiver,
  15792. DownloadProgress progress) {
  15793. return cli_->Post(path, headers, body, content_type,
  15794. std::move(content_receiver), progress);
  15795. }
  15796. inline Result Client::Put(const std::string &path) { return cli_->Put(path); }
  15797. inline Result Client::Put(const std::string &path, const Headers &headers) {
  15798. return cli_->Put(path, headers);
  15799. }
  15800. inline Result Client::Put(const std::string &path, const char *body,
  15801. size_t content_length,
  15802. const std::string &content_type,
  15803. UploadProgress progress) {
  15804. return cli_->Put(path, body, content_length, content_type, progress);
  15805. }
  15806. inline Result Client::Put(const std::string &path, const Headers &headers,
  15807. const char *body, size_t content_length,
  15808. const std::string &content_type,
  15809. UploadProgress progress) {
  15810. return cli_->Put(path, headers, body, content_length, content_type, progress);
  15811. }
  15812. inline Result Client::Put(const std::string &path, const std::string &body,
  15813. const std::string &content_type,
  15814. UploadProgress progress) {
  15815. return cli_->Put(path, body, content_type, progress);
  15816. }
  15817. inline Result Client::Put(const std::string &path, const Headers &headers,
  15818. const std::string &body,
  15819. const std::string &content_type,
  15820. UploadProgress progress) {
  15821. return cli_->Put(path, headers, body, content_type, progress);
  15822. }
  15823. inline Result Client::Put(const std::string &path, size_t content_length,
  15824. ContentProvider content_provider,
  15825. const std::string &content_type,
  15826. UploadProgress progress) {
  15827. return cli_->Put(path, content_length, std::move(content_provider),
  15828. content_type, progress);
  15829. }
  15830. inline Result Client::Put(const std::string &path, size_t content_length,
  15831. ContentProvider content_provider,
  15832. const std::string &content_type,
  15833. ContentReceiver content_receiver,
  15834. UploadProgress progress) {
  15835. return cli_->Put(path, content_length, std::move(content_provider),
  15836. content_type, std::move(content_receiver), progress);
  15837. }
  15838. inline Result Client::Put(const std::string &path,
  15839. ContentProviderWithoutLength content_provider,
  15840. const std::string &content_type,
  15841. UploadProgress progress) {
  15842. return cli_->Put(path, std::move(content_provider), content_type, progress);
  15843. }
  15844. inline Result Client::Put(const std::string &path,
  15845. ContentProviderWithoutLength content_provider,
  15846. const std::string &content_type,
  15847. ContentReceiver content_receiver,
  15848. UploadProgress progress) {
  15849. return cli_->Put(path, std::move(content_provider), content_type,
  15850. std::move(content_receiver), progress);
  15851. }
  15852. inline Result Client::Put(const std::string &path, const Headers &headers,
  15853. size_t content_length,
  15854. ContentProvider content_provider,
  15855. const std::string &content_type,
  15856. UploadProgress progress) {
  15857. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15858. content_type, progress);
  15859. }
  15860. inline Result Client::Put(const std::string &path, const Headers &headers,
  15861. size_t content_length,
  15862. ContentProvider content_provider,
  15863. const std::string &content_type,
  15864. ContentReceiver content_receiver,
  15865. UploadProgress progress) {
  15866. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15867. content_type, std::move(content_receiver), progress);
  15868. }
  15869. inline Result Client::Put(const std::string &path, const Headers &headers,
  15870. ContentProviderWithoutLength content_provider,
  15871. const std::string &content_type,
  15872. UploadProgress progress) {
  15873. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15874. progress);
  15875. }
  15876. inline Result Client::Put(const std::string &path, const Headers &headers,
  15877. ContentProviderWithoutLength content_provider,
  15878. const std::string &content_type,
  15879. ContentReceiver content_receiver,
  15880. UploadProgress progress) {
  15881. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15882. std::move(content_receiver), progress);
  15883. }
  15884. inline Result Client::Put(const std::string &path, const Params &params) {
  15885. return cli_->Put(path, params);
  15886. }
  15887. inline Result Client::Put(const std::string &path, const Headers &headers,
  15888. const Params &params) {
  15889. return cli_->Put(path, headers, params);
  15890. }
  15891. inline Result Client::Put(const std::string &path,
  15892. const UploadFormDataItems &items,
  15893. UploadProgress progress) {
  15894. return cli_->Put(path, items, progress);
  15895. }
  15896. inline Result Client::Put(const std::string &path, const Headers &headers,
  15897. const UploadFormDataItems &items,
  15898. UploadProgress progress) {
  15899. return cli_->Put(path, headers, items, progress);
  15900. }
  15901. inline Result Client::Put(const std::string &path, const Headers &headers,
  15902. const UploadFormDataItems &items,
  15903. const std::string &boundary,
  15904. UploadProgress progress) {
  15905. return cli_->Put(path, headers, items, boundary, progress);
  15906. }
  15907. inline Result Client::Put(const std::string &path, const Headers &headers,
  15908. const UploadFormDataItems &items,
  15909. const FormDataProviderItems &provider_items,
  15910. UploadProgress progress) {
  15911. return cli_->Put(path, headers, items, provider_items, progress);
  15912. }
  15913. inline Result Client::Put(const std::string &path, const Headers &headers,
  15914. const std::string &body,
  15915. const std::string &content_type,
  15916. ContentReceiver content_receiver,
  15917. DownloadProgress progress) {
  15918. return cli_->Put(path, headers, body, content_type, content_receiver,
  15919. progress);
  15920. }
  15921. inline Result Client::Patch(const std::string &path) {
  15922. return cli_->Patch(path);
  15923. }
  15924. inline Result Client::Patch(const std::string &path, const Headers &headers) {
  15925. return cli_->Patch(path, headers);
  15926. }
  15927. inline Result Client::Patch(const std::string &path, const char *body,
  15928. size_t content_length,
  15929. const std::string &content_type,
  15930. UploadProgress progress) {
  15931. return cli_->Patch(path, body, content_length, content_type, progress);
  15932. }
  15933. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15934. const char *body, size_t content_length,
  15935. const std::string &content_type,
  15936. UploadProgress progress) {
  15937. return cli_->Patch(path, headers, body, content_length, content_type,
  15938. progress);
  15939. }
  15940. inline Result Client::Patch(const std::string &path, const std::string &body,
  15941. const std::string &content_type,
  15942. UploadProgress progress) {
  15943. return cli_->Patch(path, body, content_type, progress);
  15944. }
  15945. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15946. const std::string &body,
  15947. const std::string &content_type,
  15948. UploadProgress progress) {
  15949. return cli_->Patch(path, headers, body, content_type, progress);
  15950. }
  15951. inline Result Client::Patch(const std::string &path, size_t content_length,
  15952. ContentProvider content_provider,
  15953. const std::string &content_type,
  15954. UploadProgress progress) {
  15955. return cli_->Patch(path, content_length, std::move(content_provider),
  15956. content_type, progress);
  15957. }
  15958. inline Result Client::Patch(const std::string &path, size_t content_length,
  15959. ContentProvider content_provider,
  15960. const std::string &content_type,
  15961. ContentReceiver content_receiver,
  15962. UploadProgress progress) {
  15963. return cli_->Patch(path, content_length, std::move(content_provider),
  15964. content_type, std::move(content_receiver), progress);
  15965. }
  15966. inline Result Client::Patch(const std::string &path,
  15967. ContentProviderWithoutLength content_provider,
  15968. const std::string &content_type,
  15969. UploadProgress progress) {
  15970. return cli_->Patch(path, std::move(content_provider), content_type, progress);
  15971. }
  15972. inline Result Client::Patch(const std::string &path,
  15973. ContentProviderWithoutLength content_provider,
  15974. const std::string &content_type,
  15975. ContentReceiver content_receiver,
  15976. UploadProgress progress) {
  15977. return cli_->Patch(path, std::move(content_provider), content_type,
  15978. std::move(content_receiver), progress);
  15979. }
  15980. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15981. size_t content_length,
  15982. ContentProvider content_provider,
  15983. const std::string &content_type,
  15984. UploadProgress progress) {
  15985. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15986. content_type, progress);
  15987. }
  15988. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15989. size_t content_length,
  15990. ContentProvider content_provider,
  15991. const std::string &content_type,
  15992. ContentReceiver content_receiver,
  15993. UploadProgress progress) {
  15994. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15995. content_type, std::move(content_receiver), progress);
  15996. }
  15997. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15998. ContentProviderWithoutLength content_provider,
  15999. const std::string &content_type,
  16000. UploadProgress progress) {
  16001. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  16002. progress);
  16003. }
  16004. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16005. ContentProviderWithoutLength content_provider,
  16006. const std::string &content_type,
  16007. ContentReceiver content_receiver,
  16008. UploadProgress progress) {
  16009. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  16010. std::move(content_receiver), progress);
  16011. }
  16012. inline Result Client::Patch(const std::string &path, const Params &params) {
  16013. return cli_->Patch(path, params);
  16014. }
  16015. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16016. const Params &params) {
  16017. return cli_->Patch(path, headers, params);
  16018. }
  16019. inline Result Client::Patch(const std::string &path,
  16020. const UploadFormDataItems &items,
  16021. UploadProgress progress) {
  16022. return cli_->Patch(path, items, progress);
  16023. }
  16024. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16025. const UploadFormDataItems &items,
  16026. UploadProgress progress) {
  16027. return cli_->Patch(path, headers, items, progress);
  16028. }
  16029. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16030. const UploadFormDataItems &items,
  16031. const std::string &boundary,
  16032. UploadProgress progress) {
  16033. return cli_->Patch(path, headers, items, boundary, progress);
  16034. }
  16035. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16036. const UploadFormDataItems &items,
  16037. const FormDataProviderItems &provider_items,
  16038. UploadProgress progress) {
  16039. return cli_->Patch(path, headers, items, provider_items, progress);
  16040. }
  16041. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16042. const std::string &body,
  16043. const std::string &content_type,
  16044. ContentReceiver content_receiver,
  16045. DownloadProgress progress) {
  16046. return cli_->Patch(path, headers, body, content_type, content_receiver,
  16047. progress);
  16048. }
  16049. inline Result Client::Delete(const std::string &path,
  16050. DownloadProgress progress) {
  16051. return cli_->Delete(path, progress);
  16052. }
  16053. inline Result Client::Delete(const std::string &path, const Headers &headers,
  16054. DownloadProgress progress) {
  16055. return cli_->Delete(path, headers, progress);
  16056. }
  16057. inline Result Client::Delete(const std::string &path, const char *body,
  16058. size_t content_length,
  16059. const std::string &content_type,
  16060. DownloadProgress progress) {
  16061. return cli_->Delete(path, body, content_length, content_type, progress);
  16062. }
  16063. inline Result Client::Delete(const std::string &path, const Headers &headers,
  16064. const char *body, size_t content_length,
  16065. const std::string &content_type,
  16066. DownloadProgress progress) {
  16067. return cli_->Delete(path, headers, body, content_length, content_type,
  16068. progress);
  16069. }
  16070. inline Result Client::Delete(const std::string &path, const std::string &body,
  16071. const std::string &content_type,
  16072. DownloadProgress progress) {
  16073. return cli_->Delete(path, body, content_type, progress);
  16074. }
  16075. inline Result Client::Delete(const std::string &path, const Headers &headers,
  16076. const std::string &body,
  16077. const std::string &content_type,
  16078. DownloadProgress progress) {
  16079. return cli_->Delete(path, headers, body, content_type, progress);
  16080. }
  16081. inline Result Client::Delete(const std::string &path, const Params &params,
  16082. DownloadProgress progress) {
  16083. return cli_->Delete(path, params, progress);
  16084. }
  16085. inline Result Client::Delete(const std::string &path, const Headers &headers,
  16086. const Params &params, DownloadProgress progress) {
  16087. return cli_->Delete(path, headers, params, progress);
  16088. }
  16089. inline Result Client::Options(const std::string &path) {
  16090. return cli_->Options(path);
  16091. }
  16092. inline Result Client::Options(const std::string &path, const Headers &headers) {
  16093. return cli_->Options(path, headers);
  16094. }
  16095. inline ClientImpl::StreamHandle
  16096. Client::open_stream(const std::string &method, const std::string &path,
  16097. const Params &params, const Headers &headers,
  16098. const std::string &body, const std::string &content_type) {
  16099. return cli_->open_stream(method, path, params, headers, body, content_type);
  16100. }
  16101. inline bool Client::send(Request &req, Response &res, Error &error) {
  16102. return cli_->send(req, res, error);
  16103. }
  16104. inline Result Client::send(const Request &req) { return cli_->send(req); }
  16105. inline void Client::stop() { cli_->stop(); }
  16106. inline std::string Client::host() const { return cli_->host(); }
  16107. inline int Client::port() const { return cli_->port(); }
  16108. inline size_t Client::is_socket_open() const { return cli_->is_socket_open(); }
  16109. inline socket_t Client::socket() const { return cli_->socket(); }
  16110. inline void
  16111. Client::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  16112. cli_->set_direct_hostname_addr_map(std::move(addr_map));
  16113. }
  16114. inline void Client::set_direct_hostname_addr_map(
  16115. std::map<std::string, std::string> addr_map) {
  16116. cli_->set_direct_hostname_addr_map(std::move(addr_map));
  16117. }
  16118. inline void Client::set_tunnel_hostname_addr_map(
  16119. std::map<std::string, std::string> addr_map) {
  16120. cli_->set_tunnel_hostname_addr_map(std::move(addr_map));
  16121. }
  16122. inline void Client::set_default_headers(Headers headers) {
  16123. cli_->set_default_headers(std::move(headers));
  16124. }
  16125. inline void Client::set_header_writer(
  16126. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  16127. cli_->set_header_writer(writer);
  16128. }
  16129. inline void Client::set_address_family(int family) {
  16130. cli_->set_address_family(family);
  16131. }
  16132. inline void Client::set_tcp_nodelay(bool on) { cli_->set_tcp_nodelay(on); }
  16133. inline void Client::set_socket_options(SocketOptions socket_options) {
  16134. cli_->set_socket_options(std::move(socket_options));
  16135. }
  16136. inline void Client::set_connection_timeout(time_t sec, time_t usec) {
  16137. cli_->set_connection_timeout(sec, usec);
  16138. }
  16139. inline void Client::set_read_timeout(time_t sec, time_t usec) {
  16140. cli_->set_read_timeout(sec, usec);
  16141. }
  16142. inline void Client::set_write_timeout(time_t sec, time_t usec) {
  16143. cli_->set_write_timeout(sec, usec);
  16144. }
  16145. inline void Client::set_basic_auth(const std::string &username,
  16146. const std::string &password) {
  16147. cli_->set_basic_auth(username, password);
  16148. }
  16149. inline void Client::set_bearer_token_auth(const std::string &token) {
  16150. cli_->set_bearer_token_auth(token);
  16151. }
  16152. inline void Client::set_keep_alive(bool on) { cli_->set_keep_alive(on); }
  16153. inline void Client::set_follow_location(bool on) {
  16154. cli_->set_follow_location(on);
  16155. }
  16156. inline void Client::set_path_encode(bool on) { cli_->set_path_encode(on); }
  16157. inline void Client::set_compress(bool on) { cli_->set_compress(on); }
  16158. inline void Client::set_decompress(bool on) { cli_->set_decompress(on); }
  16159. inline void Client::set_payload_max_length(size_t length) {
  16160. cli_->set_payload_max_length(length);
  16161. }
  16162. inline void Client::set_interface(const std::string &intf) {
  16163. cli_->set_interface(intf);
  16164. }
  16165. inline void Client::set_proxy(const std::string &host, int port) {
  16166. cli_->set_proxy(host, port);
  16167. }
  16168. inline void Client::set_proxy_basic_auth(const std::string &username,
  16169. const std::string &password) {
  16170. cli_->set_proxy_basic_auth(username, password);
  16171. }
  16172. inline void Client::set_proxy_bearer_token_auth(const std::string &token) {
  16173. cli_->set_proxy_bearer_token_auth(token);
  16174. }
  16175. inline void Client::set_no_proxy(const std::vector<std::string> &patterns) {
  16176. cli_->set_no_proxy(patterns);
  16177. }
  16178. inline void Client::set_logger(Logger logger) {
  16179. cli_->set_logger(std::move(logger));
  16180. }
  16181. inline void Client::set_error_logger(ErrorLogger error_logger) {
  16182. cli_->set_error_logger(std::move(error_logger));
  16183. }
  16184. /*
  16185. * Group 6: SSL Server and Client implementation
  16186. */
  16187. #ifdef CPPHTTPLIB_SSL_ENABLED
  16188. // SSL HTTP server implementation
  16189. inline SSLServer::SSLServer(const char *cert_path, const char *private_key_path,
  16190. const char *client_ca_cert_file_path,
  16191. const char *client_ca_cert_dir_path,
  16192. const char *private_key_password) {
  16193. using namespace tls;
  16194. ctx_ = create_server_context();
  16195. if (!ctx_) { return; }
  16196. // Load server certificate and private key
  16197. if (!set_server_cert_file(ctx_, cert_path, private_key_path,
  16198. private_key_password)) {
  16199. last_ssl_error_ = static_cast<int>(get_error());
  16200. free_context(ctx_);
  16201. ctx_ = nullptr;
  16202. return;
  16203. }
  16204. // Load client CA certificates for client authentication
  16205. if (client_ca_cert_file_path || client_ca_cert_dir_path) {
  16206. if (!set_client_ca_file(ctx_, client_ca_cert_file_path,
  16207. client_ca_cert_dir_path)) {
  16208. last_ssl_error_ = static_cast<int>(get_error());
  16209. free_context(ctx_);
  16210. ctx_ = nullptr;
  16211. return;
  16212. }
  16213. // Enable client certificate verification
  16214. set_verify_client(ctx_, true);
  16215. }
  16216. }
  16217. inline SSLServer::SSLServer(const PemMemory &pem) {
  16218. using namespace tls;
  16219. ctx_ = create_server_context();
  16220. if (ctx_) {
  16221. std::string cert_buf, key_buf;
  16222. if (!set_server_cert_pem(
  16223. ctx_, detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  16224. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  16225. pem.private_key_password)) {
  16226. last_ssl_error_ = static_cast<int>(get_error());
  16227. free_context(ctx_);
  16228. ctx_ = nullptr;
  16229. } else if (pem.client_ca_pem) {
  16230. auto ca_len = pem.client_ca_pem_len ? pem.client_ca_pem_len
  16231. : strlen(pem.client_ca_pem);
  16232. if (!load_ca_pem(ctx_, pem.client_ca_pem, ca_len)) {
  16233. last_ssl_error_ = static_cast<int>(get_error());
  16234. free_context(ctx_);
  16235. ctx_ = nullptr;
  16236. } else {
  16237. set_verify_client(ctx_, true);
  16238. }
  16239. }
  16240. }
  16241. }
  16242. inline SSLServer::SSLServer(const tls::ContextSetupCallback &setup_callback) {
  16243. using namespace tls;
  16244. ctx_ = create_server_context();
  16245. if (ctx_) {
  16246. if (!setup_callback(ctx_)) {
  16247. free_context(ctx_);
  16248. ctx_ = nullptr;
  16249. }
  16250. }
  16251. }
  16252. inline SSLServer::~SSLServer() {
  16253. if (ctx_) { tls::free_context(ctx_); }
  16254. }
  16255. inline bool SSLServer::is_valid() const {
  16256. return ctx_ != nullptr && Server::is_valid();
  16257. }
  16258. inline bool SSLServer::process_and_close_socket(socket_t sock) {
  16259. using namespace tls;
  16260. session_t session = nullptr;
  16261. {
  16262. std::unique_lock<std::mutex> lock(ctx_mutex_);
  16263. ctx_cv_.wait(lock, [&] { return updates_pending_ == 0; });
  16264. session = create_session(static_cast<ctx_t>(ctx_), sock);
  16265. if (session) { handshakes_in_progress_++; }
  16266. }
  16267. if (!session) {
  16268. last_ssl_error_ = static_cast<int>(get_error());
  16269. detail::shutdown_socket(sock);
  16270. detail::close_socket(sock);
  16271. return false;
  16272. }
  16273. // Use scope_exit to ensure cleanup on all paths (including exceptions)
  16274. bool handshake_done = false;
  16275. bool ret = false;
  16276. bool websocket_upgraded = false;
  16277. auto cleanup = detail::scope_exit([&] {
  16278. if (handshake_done) { shutdown(session, !websocket_upgraded && ret); }
  16279. free_session(session);
  16280. detail::shutdown_socket(sock);
  16281. detail::close_socket(sock);
  16282. });
  16283. // Perform TLS accept handshake with timeout
  16284. TlsError tls_err;
  16285. auto accepted = false;
  16286. {
  16287. auto handshake_left = detail::scope_exit([&] {
  16288. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16289. if (--handshakes_in_progress_ == 0) { ctx_cv_.notify_all(); }
  16290. });
  16291. accepted = accept_nonblocking(session, sock, read_timeout_sec_,
  16292. read_timeout_usec_, &tls_err);
  16293. }
  16294. if (!accepted) {
  16295. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16296. // Map TlsError to legacy ssl_error for backward compatibility
  16297. if (tls_err.code == ErrorCode::WantRead) {
  16298. last_ssl_error_ = SSL_ERROR_WANT_READ;
  16299. } else if (tls_err.code == ErrorCode::WantWrite) {
  16300. last_ssl_error_ = SSL_ERROR_WANT_WRITE;
  16301. } else {
  16302. last_ssl_error_ = SSL_ERROR_SSL;
  16303. }
  16304. #else
  16305. last_ssl_error_ = static_cast<int>(get_error());
  16306. #endif
  16307. return false;
  16308. }
  16309. handshake_done = true;
  16310. std::string remote_addr;
  16311. int remote_port = 0;
  16312. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  16313. std::string local_addr;
  16314. int local_port = 0;
  16315. detail::get_local_ip_and_port(sock, local_addr, local_port);
  16316. ret = serve_guarded([&]() {
  16317. return detail::process_server_socket_ssl(
  16318. svr_sock_, session, sock, keep_alive_max_count_,
  16319. keep_alive_timeout_sec_, read_timeout_sec_, read_timeout_usec_,
  16320. write_timeout_sec_, write_timeout_usec_,
  16321. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  16322. return process_request(
  16323. strm, remote_addr, remote_port, local_addr, local_port,
  16324. close_connection, connection_closed,
  16325. [&](Request &req) { req.ssl = session; }, &websocket_upgraded);
  16326. });
  16327. });
  16328. return ret;
  16329. }
  16330. inline bool SSLServer::update_certs_pem(const char *cert_pem,
  16331. const char *key_pem,
  16332. const char *client_ca_pem,
  16333. const char *password) {
  16334. if (!ctx_) { return false; }
  16335. std::unique_lock<std::mutex> lock(ctx_mutex_);
  16336. updates_pending_++;
  16337. auto se = detail::scope_exit([&] {
  16338. if (--updates_pending_ == 0) { ctx_cv_.notify_all(); }
  16339. });
  16340. ctx_cv_.wait(lock, [&] { return handshakes_in_progress_ == 0; });
  16341. if (!tls::update_server_cert(ctx_, cert_pem, key_pem, password)) {
  16342. return false;
  16343. }
  16344. if (client_ca_pem) {
  16345. if (!tls::update_server_client_ca(ctx_, client_ca_pem)) { return false; }
  16346. // As in the constructors, a client CA makes client certificates required
  16347. tls::set_verify_client(ctx_, true);
  16348. }
  16349. return true;
  16350. }
  16351. // SSL HTTP client implementation
  16352. inline SSLClient::~SSLClient() {
  16353. // Make sure to shut down SSL since shutdown_ssl will resolve to the
  16354. // base function rather than the derived function once we get to the
  16355. // base class destructor, and won't free the SSL (causing a leak).
  16356. // This must happen before the context is freed below: some backends
  16357. // (e.g. mbedTLS) have the SSL session borrow a raw pointer into the
  16358. // context, so freeing the context first leaves close_notify reading
  16359. // freed memory.
  16360. shutdown_ssl_impl(socket_, true);
  16361. if (ctx_) {
  16362. tls::free_context(ctx_);
  16363. ctx_ = nullptr;
  16364. }
  16365. }
  16366. inline bool SSLClient::is_valid() const { return ctx_ != nullptr; }
  16367. inline void SSLClient::shutdown_ssl(Socket &socket, bool shutdown_gracefully) {
  16368. shutdown_ssl_impl(socket, shutdown_gracefully);
  16369. }
  16370. inline void SSLClient::shutdown_ssl_impl(Socket &socket,
  16371. bool shutdown_gracefully) {
  16372. if (socket.sock == INVALID_SOCKET) {
  16373. assert(socket.ssl == nullptr);
  16374. return;
  16375. }
  16376. if (socket.ssl) {
  16377. tls::shutdown(socket.ssl, shutdown_gracefully);
  16378. {
  16379. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16380. tls::free_session(socket.ssl);
  16381. }
  16382. socket.ssl = nullptr;
  16383. }
  16384. assert(socket.ssl == nullptr);
  16385. }
  16386. inline bool SSLClient::process_socket(
  16387. const Socket &socket,
  16388. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16389. std::function<bool(Stream &strm)> callback) {
  16390. assert(socket.ssl);
  16391. return detail::process_client_socket_ssl(
  16392. socket.ssl, socket.sock, read_timeout_sec_, read_timeout_usec_,
  16393. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_, start_time,
  16394. [&](detail::SSLSocketStream &strm) {
  16395. auto ret = callback(strm);
  16396. // A request that failed after the handshake reports Error::Read or
  16397. // Error::Write; keep the TLS error behind it, such as a fatal alert
  16398. // from the server, for Result::ssl_error() and ssl_backend_error()
  16399. const auto &tls_error = strm.tls_error();
  16400. if (!ret && tls_error.code != tls::ErrorCode::Success) {
  16401. last_ssl_error_ = static_cast<int>(tls_error.code);
  16402. last_backend_error_ = tls_error.backend_code;
  16403. }
  16404. return ret;
  16405. });
  16406. }
  16407. inline bool SSLClient::is_ssl() const { return true; }
  16408. inline bool SSLClient::create_and_connect_socket(Socket &socket, Error &error) {
  16409. if (!is_valid()) {
  16410. error = Error::SSLConnection;
  16411. return false;
  16412. }
  16413. return ClientImpl::create_and_connect_socket(socket, error);
  16414. }
  16415. inline bool SSLClient::setup_proxy_connection(
  16416. Socket &socket,
  16417. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16418. Response &res, bool &success, Error &error) {
  16419. if (!is_proxy_enabled_for_host(host_)) { return true; }
  16420. if (!connect_with_proxy(socket, start_time, res, success, error)) {
  16421. return false;
  16422. }
  16423. if (!initialize_ssl(socket, error)) {
  16424. success = false;
  16425. return false;
  16426. }
  16427. return true;
  16428. }
  16429. // Assumes that socket_mutex_ is locked and that there are no requests in
  16430. // flight
  16431. inline bool SSLClient::connect_with_proxy(
  16432. Socket &socket,
  16433. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16434. Response &res, bool &success, Error &error) {
  16435. success = true;
  16436. auto connect_target =
  16437. detail::make_connect_request_target(tunnel_addr_map_, host_, port_);
  16438. auto retargeted = connect_target !=
  16439. detail::make_host_and_port_string_always_port(host_, port_);
  16440. Response proxy_res;
  16441. if (!detail::process_client_socket(
  16442. socket.sock, read_timeout_sec_, read_timeout_usec_,
  16443. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  16444. start_time, [&](Stream &strm) {
  16445. Request req2;
  16446. req2.method = "CONNECT";
  16447. req2.path = connect_target;
  16448. if (retargeted) { req2.set_header("Host", connect_target); }
  16449. if (max_timeout_msec_ > 0) {
  16450. req2.start_time_ = std::chrono::steady_clock::now();
  16451. }
  16452. return process_request(strm, req2, proxy_res, false, error);
  16453. })) {
  16454. // Thread-safe to close everything because we are assuming there are no
  16455. // requests in flight
  16456. shutdown_ssl(socket, true);
  16457. shutdown_socket(socket);
  16458. close_socket(socket);
  16459. success = false;
  16460. return false;
  16461. }
  16462. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  16463. if (!proxy_digest_auth_username_.empty() &&
  16464. !proxy_digest_auth_password_.empty()) {
  16465. std::map<std::string, std::string> auth;
  16466. if (detail::parse_www_authenticate(proxy_res, auth, true)) {
  16467. // Close the current socket and create a new one for the authenticated
  16468. // request
  16469. shutdown_ssl(socket, true);
  16470. shutdown_socket(socket);
  16471. close_socket(socket);
  16472. // Create a new socket for the authenticated CONNECT request
  16473. if (!ensure_socket_connection(socket, error)) {
  16474. success = false;
  16475. return false;
  16476. }
  16477. proxy_res = Response();
  16478. if (!detail::process_client_socket(
  16479. socket.sock, read_timeout_sec_, read_timeout_usec_,
  16480. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  16481. start_time, [&](Stream &strm) {
  16482. Request req3;
  16483. req3.method = "CONNECT";
  16484. req3.path = connect_target;
  16485. if (retargeted) { req3.set_header("Host", connect_target); }
  16486. req3.headers.insert(detail::make_digest_authentication_header(
  16487. req3, make_request_target(req3), auth, 1,
  16488. detail::random_string(10), proxy_digest_auth_username_,
  16489. proxy_digest_auth_password_, true));
  16490. if (max_timeout_msec_ > 0) {
  16491. req3.start_time_ = std::chrono::steady_clock::now();
  16492. }
  16493. return process_request(strm, req3, proxy_res, false, error);
  16494. })) {
  16495. // Thread-safe to close everything because we are assuming there are
  16496. // no requests in flight
  16497. shutdown_ssl(socket, true);
  16498. shutdown_socket(socket);
  16499. close_socket(socket);
  16500. success = false;
  16501. return false;
  16502. }
  16503. }
  16504. }
  16505. }
  16506. // If status code is not 200, proxy request is failed.
  16507. // Set error to ProxyConnection. A 407 is returned as the response of the
  16508. // request, so the caller sees the proxy asks for credentials; any other
  16509. // status would read as the answer of the origin, which it never reached.
  16510. if (proxy_res.status != StatusCode::OK_200) {
  16511. error = Error::ProxyConnection;
  16512. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  16513. res = std::move(proxy_res);
  16514. } else {
  16515. success = false;
  16516. }
  16517. // Thread-safe to close everything because we are assuming there are
  16518. // no requests in flight
  16519. shutdown_ssl(socket, true);
  16520. shutdown_socket(socket);
  16521. close_socket(socket);
  16522. return false;
  16523. }
  16524. return true;
  16525. }
  16526. inline bool SSLClient::ensure_socket_connection(Socket &socket, Error &error) {
  16527. if (!ClientImpl::ensure_socket_connection(socket, error)) { return false; }
  16528. if (is_proxy_enabled_for_host(host_)) { return true; }
  16529. if (!initialize_ssl(socket, error)) {
  16530. shutdown_socket(socket);
  16531. close_socket(socket);
  16532. return false;
  16533. }
  16534. return true;
  16535. }
  16536. // SSL HTTP client implementation
  16537. inline SSLClient::SSLClient(const std::string &host)
  16538. : SSLClient(host, 443, std::string(), std::string()) {}
  16539. inline SSLClient::SSLClient(const std::string &host, int port)
  16540. : SSLClient(host, port, std::string(), std::string()) {}
  16541. inline void SSLClient::init_ctx() {
  16542. ctx_ = tls::create_client_context();
  16543. if (ctx_) { tls::set_min_version(ctx_, tls::Version::TLS1_2); }
  16544. }
  16545. inline void SSLClient::reset_ctx_on_error() {
  16546. last_backend_error_ = tls::get_error();
  16547. tls::free_context(ctx_);
  16548. ctx_ = nullptr;
  16549. }
  16550. inline SSLClient::SSLClient(const std::string &host, int port,
  16551. const std::string &client_cert_path,
  16552. const std::string &client_key_path,
  16553. const std::string &private_key_password)
  16554. : ClientImpl(host, port, client_cert_path, client_key_path) {
  16555. init_ctx();
  16556. if (!ctx_) { return; }
  16557. if (!client_cert_path.empty() && !client_key_path.empty()) {
  16558. const char *password =
  16559. private_key_password.empty() ? nullptr : private_key_password.c_str();
  16560. if (!tls::set_client_cert_file(ctx_, client_cert_path.c_str(),
  16561. client_key_path.c_str(), password)) {
  16562. reset_ctx_on_error();
  16563. }
  16564. }
  16565. }
  16566. inline SSLClient::SSLClient(const std::string &host, int port,
  16567. const PemMemory &pem)
  16568. : ClientImpl(host, port) {
  16569. init_ctx();
  16570. if (!ctx_) { return; }
  16571. if (pem.cert_pem && pem.key_pem) {
  16572. std::string cert_buf, key_buf;
  16573. if (!tls::set_client_cert_pem(
  16574. ctx_, detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  16575. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  16576. pem.private_key_password)) {
  16577. reset_ctx_on_error();
  16578. }
  16579. }
  16580. }
  16581. inline void SSLClient::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16582. if (ca_cert_store && ctx_) {
  16583. // set_ca_store takes ownership of ca_cert_store
  16584. tls::set_ca_store(ctx_, ca_cert_store);
  16585. ca_cert_store_set_ = true;
  16586. } else if (ca_cert_store) {
  16587. tls::free_ca_store(ca_cert_store);
  16588. }
  16589. custom_ca_loaded_ = true;
  16590. tls_settings_changed();
  16591. }
  16592. inline void
  16593. SSLClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16594. if (!ctx_) { return; }
  16595. server_certificate_verifier_ = verifier;
  16596. {
  16597. // Under the lock that creating a session from ctx_ takes
  16598. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16599. tls::set_verify_callback(ctx_, std::move(verifier));
  16600. }
  16601. tls_settings_changed();
  16602. }
  16603. inline void SSLClient::set_session_verifier(
  16604. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16605. session_verifier_ = std::move(verifier);
  16606. tls_settings_changed();
  16607. }
  16608. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16609. inline void SSLClient::enable_windows_certificate_verification(bool enabled) {
  16610. if (enable_windows_cert_verification_ == enabled) { return; }
  16611. enable_windows_cert_verification_ = enabled;
  16612. tls_settings_changed();
  16613. }
  16614. #endif
  16615. inline void SSLClient::load_ca_cert_store(const char *ca_cert,
  16616. std::size_t size) {
  16617. if (ctx_ && ca_cert && size > 0) {
  16618. // Every PEM loaded, for redirect transfer
  16619. if (!ca_cert_pem_.empty() && ca_cert_pem_.back() != '\n') {
  16620. ca_cert_pem_ += '\n';
  16621. }
  16622. ca_cert_pem_.append(ca_cert, size);
  16623. tls::load_ca_pem(ctx_, ca_cert, size);
  16624. }
  16625. custom_ca_loaded_ = true;
  16626. tls_settings_changed();
  16627. }
  16628. inline bool SSLClient::load_certs() {
  16629. auto ret = true;
  16630. // call_once rather than the plain flag WebSocketClient::create_stream() uses:
  16631. // one client is shared across concurrent requests here.
  16632. std::call_once(initialize_cert_, [&]() {
  16633. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16634. ret = detail::load_client_ca_config(ctx_, ca_cert_file_path_,
  16635. ca_cert_dir_path_, custom_ca_loaded_,
  16636. system_ca_mode_, last_backend_error_);
  16637. });
  16638. return ret;
  16639. }
  16640. inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) {
  16641. // Load CA certificates if server verification is enabled
  16642. if (server_certificate_verification_) {
  16643. if (!load_certs()) {
  16644. error = Error::SSLLoadingCerts;
  16645. return false;
  16646. }
  16647. }
  16648. detail::ClientTlsSessionOptions options;
  16649. options.server_hostname_verification = server_hostname_verification_;
  16650. options.session_verifier = session_verifier_;
  16651. options.ctx_mutex = &ctx_mutex_;
  16652. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16653. // Skip Schannel when a custom CA cert is specified, as the Windows
  16654. // certificate store would not know about user-provided CA certificates.
  16655. // Also skip when system CA trust is explicitly disabled.
  16656. options.windows_cert_verification =
  16657. enable_windows_cert_verification_ &&
  16658. system_ca_mode_ != SystemCAMode::Disabled && ca_cert_file_path_.empty() &&
  16659. ca_cert_dir_path_.empty() && !custom_ca_loaded_;
  16660. // Only a verifier set through set_server_certificate_verifier() is seen
  16661. // here, not one installed with tls::set_verify_callback() directly.
  16662. options.server_certificate_verifier_set =
  16663. static_cast<bool>(server_certificate_verifier_);
  16664. #endif
  16665. tls::session_t session = nullptr;
  16666. // Use scope_exit to ensure session is freed on error paths
  16667. bool success = false;
  16668. auto session_guard = detail::scope_exit([&] {
  16669. if (!success) { tls::free_session(session); }
  16670. });
  16671. detail::ClientTlsSessionError tls_error;
  16672. if (!detail::setup_client_tls_session(
  16673. host_, ctx_, session, socket.sock, server_certificate_verification_,
  16674. connection_timeout_sec_, connection_timeout_usec_, &tls_error,
  16675. options)) {
  16676. error = tls_error.error;
  16677. last_ssl_error_ = tls_error.ssl_error;
  16678. last_backend_error_ = tls_error.backend_error;
  16679. return false;
  16680. }
  16681. success = true;
  16682. socket.ssl = session;
  16683. return true;
  16684. }
  16685. inline void Client::set_digest_auth(const std::string &username,
  16686. const std::string &password) {
  16687. cli_->set_digest_auth(username, password);
  16688. }
  16689. inline void Client::set_proxy_digest_auth(const std::string &username,
  16690. const std::string &password) {
  16691. cli_->set_proxy_digest_auth(username, password);
  16692. }
  16693. inline void Client::enable_server_certificate_verification(bool enabled) {
  16694. cli_->enable_server_certificate_verification(enabled);
  16695. }
  16696. inline void Client::enable_server_hostname_verification(bool enabled) {
  16697. cli_->enable_server_hostname_verification(enabled);
  16698. }
  16699. inline void Client::enable_system_ca(bool enabled) {
  16700. cli_->enable_system_ca(enabled);
  16701. }
  16702. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16703. inline void Client::enable_windows_certificate_verification(bool enabled) {
  16704. if (is_ssl_) {
  16705. static_cast<SSLClient &>(*cli_).enable_windows_certificate_verification(
  16706. enabled);
  16707. }
  16708. }
  16709. #endif
  16710. inline void Client::set_ca_cert_path(const std::string &ca_cert_file_path,
  16711. const std::string &ca_cert_dir_path) {
  16712. cli_->set_ca_cert_path(ca_cert_file_path, ca_cert_dir_path);
  16713. }
  16714. inline void Client::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16715. if (is_ssl_) {
  16716. static_cast<SSLClient &>(*cli_).set_ca_cert_store(ca_cert_store);
  16717. } else if (ca_cert_store) {
  16718. tls::free_ca_store(ca_cert_store);
  16719. }
  16720. }
  16721. inline void Client::load_ca_cert_store(const char *ca_cert, std::size_t size) {
  16722. if (is_ssl_) {
  16723. // Use the PEM-based path so the CA data is retained for redirect transfer
  16724. static_cast<SSLClient &>(*cli_).load_ca_cert_store(ca_cert, size);
  16725. }
  16726. }
  16727. inline void
  16728. Client::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16729. if (is_ssl_) {
  16730. static_cast<SSLClient &>(*cli_).set_server_certificate_verifier(
  16731. std::move(verifier));
  16732. }
  16733. }
  16734. inline void Client::set_session_verifier(
  16735. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16736. if (is_ssl_) {
  16737. static_cast<SSLClient &>(*cli_).set_session_verifier(std::move(verifier));
  16738. }
  16739. }
  16740. inline tls::ctx_t Client::tls_context() const {
  16741. if (is_ssl_) { return static_cast<SSLClient &>(*cli_).tls_context(); }
  16742. return nullptr;
  16743. }
  16744. #endif // CPPHTTPLIB_SSL_ENABLED
  16745. /*
  16746. * Group 7: TLS abstraction layer - Common API
  16747. */
  16748. #ifdef CPPHTTPLIB_SSL_ENABLED
  16749. namespace tls {
  16750. // Helper for PeerCert construction
  16751. inline PeerCert get_peer_cert_from_session(const_session_t session) {
  16752. return PeerCert(get_peer_cert(session));
  16753. }
  16754. namespace impl {
  16755. // set_verify_callback() can replace a callback while handshakes on other
  16756. // threads run it, so they share it, and take their reference under this lock.
  16757. inline std::mutex &verify_callback_mutex() {
  16758. static std::mutex mutex;
  16759. return mutex;
  16760. }
  16761. // The TLS libraries are C, so an exception from a verify callback must not
  16762. // unwind through them. It rejects the certificate instead.
  16763. inline bool run_verify_callback(const VerifyCallback &callback,
  16764. const VerifyContext &ctx) {
  16765. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  16766. return callback(ctx);
  16767. #else
  16768. try {
  16769. return callback(ctx);
  16770. } catch (...) { return false; }
  16771. #endif
  16772. }
  16773. // Check if a string is an IPv4 address
  16774. inline bool is_ipv4_address(const std::string &str) {
  16775. int dots = 0;
  16776. for (char c : str) {
  16777. if (c == '.') {
  16778. dots++;
  16779. } else if (!detail::is_ascii_digit(c)) {
  16780. return false;
  16781. }
  16782. }
  16783. return dots == 3;
  16784. }
  16785. // Parse IPv4 address string to bytes
  16786. inline bool parse_ipv4(const std::string &str, unsigned char *out) {
  16787. const char *p = str.c_str();
  16788. for (int i = 0; i < 4; i++) {
  16789. if (i > 0) {
  16790. if (*p != '.') { return false; }
  16791. p++;
  16792. }
  16793. int val = 0;
  16794. int digits = 0;
  16795. while (detail::is_ascii_digit(*p)) {
  16796. val = val * 10 + (*p - '0');
  16797. if (val > 255) { return false; }
  16798. p++;
  16799. digits++;
  16800. }
  16801. if (digits == 0) { return false; }
  16802. // Reject leading zeros (e.g., "01.002.03.04") to prevent ambiguity
  16803. if (digits > 1 && *(p - digits) == '0') { return false; }
  16804. out[i] = static_cast<unsigned char>(val);
  16805. }
  16806. return *p == '\0';
  16807. }
  16808. // Parse an IP literal (IPv4 or IPv6) into raw network-order bytes.
  16809. // `out` must have room for at least 16 bytes. Returns the address length
  16810. // (4 for IPv4, 16 for IPv6) on success, or 0 if the string is not an IP
  16811. // literal. Used to match a host against iPAddress SANs the same way the
  16812. // OpenSSL backend does via X509_check_ip.
  16813. inline size_t parse_ip_address(const std::string &str, unsigned char *out) {
  16814. if (is_ipv4_address(str)) { return parse_ipv4(str, out) ? 4 : 0; }
  16815. struct in6_addr addr6 = {};
  16816. if (inet_pton(AF_INET6, str.c_str(), &addr6) == 1) {
  16817. memcpy(out, &addr6, 16);
  16818. return 16;
  16819. }
  16820. return 0;
  16821. }
  16822. #ifdef _WIN32
  16823. // Enumerate Windows system certificates and call callback with DER data
  16824. template <typename Callback>
  16825. inline bool enumerate_windows_system_certs(Callback cb) {
  16826. bool loaded = false;
  16827. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16828. for (auto store_name : store_names) {
  16829. HCERTSTORE hStore = CertOpenSystemStoreW(0, store_name);
  16830. if (hStore) {
  16831. PCCERT_CONTEXT pContext = nullptr;
  16832. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16833. nullptr) {
  16834. if (cb(pContext->pbCertEncoded, pContext->cbCertEncoded)) {
  16835. loaded = true;
  16836. }
  16837. }
  16838. CertCloseStore(hStore, 0);
  16839. }
  16840. }
  16841. return loaded;
  16842. }
  16843. #endif
  16844. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16845. // The trust a certificate's Trust Settings give it for SSL server
  16846. // verification (SecTrustSettings.h). An empty array trusts it as a root.
  16847. // Otherwise the first usage-constraints dictionary that applies decides: one
  16848. // naming a policy other than SSL, a host name or an application does not
  16849. // apply, and a result left out means TrustRoot. Keychain Access writes "Never
  16850. // Trust" as kSecTrustSettingsResultDeny.
  16851. inline SecTrustSettingsResult
  16852. macos_ssl_trust_settings_result(CFArrayRef trust_settings) {
  16853. auto count = CFArrayGetCount(trust_settings);
  16854. if (count == 0) { return kSecTrustSettingsResultTrustRoot; }
  16855. for (CFIndex i = 0; i < count; i++) {
  16856. auto value = CFArrayGetValueAtIndex(trust_settings, i);
  16857. if (!value || CFGetTypeID(value) != CFDictionaryGetTypeID()) { continue; }
  16858. auto constraint = static_cast<CFDictionaryRef>(value);
  16859. auto policy_value =
  16860. CFDictionaryGetValue(constraint, kSecTrustSettingsPolicy);
  16861. if (policy_value) {
  16862. auto policy = static_cast<SecPolicyRef>(const_cast<void *>(policy_value));
  16863. auto is_ssl = false;
  16864. if (auto properties = SecPolicyCopyProperties(policy)) {
  16865. auto oid = CFDictionaryGetValue(properties, kSecPolicyOid);
  16866. is_ssl = oid && CFEqual(oid, kSecPolicyAppleSSL);
  16867. CFRelease(properties);
  16868. }
  16869. if (!is_ssl) { continue; }
  16870. }
  16871. if (CFDictionaryContainsKey(constraint, kSecTrustSettingsPolicyString) ||
  16872. CFDictionaryContainsKey(constraint, kSecTrustSettingsApplication)) {
  16873. continue;
  16874. }
  16875. auto result = kSecTrustSettingsResultTrustRoot;
  16876. auto number = static_cast<CFNumberRef>(
  16877. CFDictionaryGetValue(constraint, kSecTrustSettingsResult));
  16878. if (number) {
  16879. SInt32 number_value = 0;
  16880. if (!CFNumberGetValue(number, kCFNumberSInt32Type, &number_value)) {
  16881. continue;
  16882. }
  16883. result = static_cast<SecTrustSettingsResult>(number_value);
  16884. }
  16885. if (result == kSecTrustSettingsResultTrustRoot ||
  16886. result == kSecTrustSettingsResultTrustAsRoot ||
  16887. result == kSecTrustSettingsResultDeny) {
  16888. return result;
  16889. }
  16890. }
  16891. return kSecTrustSettingsResultUnspecified;
  16892. }
  16893. // Enumerate the macOS Keychain certificates trusted for SSL and call callback
  16894. // with DER data. A certificate with Trust Settings is not trusted just by
  16895. // having them: the settings say whether it is, and a per-user setting
  16896. // overrides the admin domain's, which overrides the system domain's (whose
  16897. // roots are all trusted). So a system root the user set to "Never Trust" is
  16898. // left out, as is one trusted only for S/MIME or code signing.
  16899. template <typename Callback>
  16900. inline bool enumerate_macos_keychain_certs(Callback cb) {
  16901. const SecTrustSettingsDomain domains[] = {
  16902. kSecTrustSettingsDomainUser,
  16903. kSecTrustSettingsDomainAdmin,
  16904. kSecTrustSettingsDomainSystem,
  16905. };
  16906. std::set<std::string> decided;
  16907. std::vector<std::string> trusted;
  16908. for (auto domain : domains) {
  16909. CFArrayRef certs = nullptr;
  16910. OSStatus status = SecTrustSettingsCopyCertificates(domain, &certs);
  16911. if (status != errSecSuccess || !certs) {
  16912. if (certs) CFRelease(certs);
  16913. continue;
  16914. }
  16915. CFIndex count = CFArrayGetCount(certs);
  16916. for (CFIndex i = 0; i < count; i++) {
  16917. SecCertificateRef cert =
  16918. (SecCertificateRef)CFArrayGetValueAtIndex(certs, i);
  16919. CFDataRef data = SecCertificateCopyData(cert);
  16920. if (!data) { continue; }
  16921. std::string der(reinterpret_cast<const char *>(CFDataGetBytePtr(data)),
  16922. static_cast<size_t>(CFDataGetLength(data)));
  16923. CFRelease(data);
  16924. // Decided by a domain that overrides this one
  16925. if (decided.find(der) != decided.end()) { continue; }
  16926. auto result = kSecTrustSettingsResultTrustRoot;
  16927. if (domain != kSecTrustSettingsDomainSystem) {
  16928. result = kSecTrustSettingsResultUnspecified;
  16929. CFArrayRef trust_settings = nullptr;
  16930. if (SecTrustSettingsCopyTrustSettings(cert, domain, &trust_settings) ==
  16931. errSecSuccess &&
  16932. trust_settings) {
  16933. result = macos_ssl_trust_settings_result(trust_settings);
  16934. }
  16935. if (trust_settings) CFRelease(trust_settings);
  16936. }
  16937. // Neither trusted nor distrusted here; a domain below may decide
  16938. if (result == kSecTrustSettingsResultUnspecified) { continue; }
  16939. decided.insert(der);
  16940. if (result == kSecTrustSettingsResultTrustRoot ||
  16941. result == kSecTrustSettingsResultTrustAsRoot) {
  16942. trusted.push_back(std::move(der));
  16943. }
  16944. }
  16945. CFRelease(certs);
  16946. }
  16947. bool loaded = false;
  16948. for (const auto &der : trusted) {
  16949. if (cb(reinterpret_cast<const unsigned char *>(der.data()), der.size())) {
  16950. loaded = true;
  16951. }
  16952. }
  16953. return loaded;
  16954. }
  16955. #endif
  16956. #if !defined(_WIN32) && !(defined(__APPLE__) && \
  16957. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN))
  16958. // Common CA certificate file paths on Linux/Unix
  16959. inline const char **system_ca_paths() {
  16960. static const char *paths[] = {
  16961. "/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu
  16962. "/etc/pki/tls/certs/ca-bundle.crt", // RHEL/CentOS
  16963. "/etc/ssl/ca-bundle.pem", // OpenSUSE
  16964. "/etc/pki/tls/cacert.pem", // OpenELEC
  16965. "/etc/ssl/cert.pem", // Alpine, FreeBSD
  16966. nullptr};
  16967. return paths;
  16968. }
  16969. // Common CA certificate directory paths on Linux/Unix
  16970. inline const char **system_ca_dirs() {
  16971. static const char *dirs[] = {"/etc/ssl/certs", // Debian/Ubuntu
  16972. "/etc/pki/tls/certs", // RHEL/CentOS
  16973. "/usr/share/ca-certificates", // Other
  16974. nullptr};
  16975. return dirs;
  16976. }
  16977. #endif
  16978. } // namespace impl
  16979. inline bool set_client_ca_file(ctx_t ctx, const char *ca_file,
  16980. const char *ca_dir) {
  16981. if (!ctx) { return false; }
  16982. bool success = true;
  16983. if (ca_file && *ca_file) {
  16984. if (!load_ca_file(ctx, ca_file)) { success = false; }
  16985. }
  16986. if (ca_dir && *ca_dir) {
  16987. if (!load_ca_dir(ctx, ca_dir)) { success = false; }
  16988. }
  16989. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16990. // Set CA list for client certificate request (CertificateRequest message)
  16991. if (ca_file && *ca_file) {
  16992. auto list = SSL_load_client_CA_file(ca_file);
  16993. if (list) { SSL_CTX_set_client_CA_list(static_cast<SSL_CTX *>(ctx), list); }
  16994. }
  16995. #endif
  16996. return success;
  16997. }
  16998. inline bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16999. const char *password) {
  17000. return set_client_cert_pem(ctx, cert, key, password);
  17001. }
  17002. inline bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  17003. const char *key_path, const char *password) {
  17004. return set_client_cert_file(ctx, cert_path, key_path, password);
  17005. }
  17006. // PeerCert implementation
  17007. inline PeerCert::PeerCert() = default;
  17008. inline PeerCert::PeerCert(cert_t cert) : cert_(cert) {}
  17009. inline PeerCert::PeerCert(PeerCert &&other) noexcept : cert_(other.cert_) {
  17010. other.cert_ = nullptr;
  17011. }
  17012. inline PeerCert &PeerCert::operator=(PeerCert &&other) noexcept {
  17013. if (this != &other) {
  17014. if (cert_) { free_cert(cert_); }
  17015. cert_ = other.cert_;
  17016. other.cert_ = nullptr;
  17017. }
  17018. return *this;
  17019. }
  17020. inline PeerCert::~PeerCert() {
  17021. if (cert_) { free_cert(cert_); }
  17022. }
  17023. inline PeerCert::operator bool() const { return cert_ != nullptr; }
  17024. inline std::string PeerCert::subject_cn() const {
  17025. return cert_ ? get_cert_subject_cn(cert_) : std::string();
  17026. }
  17027. inline std::string PeerCert::issuer_name() const {
  17028. return cert_ ? get_cert_issuer_name(cert_) : std::string();
  17029. }
  17030. inline bool PeerCert::check_hostname(const char *hostname) const {
  17031. return cert_ ? verify_hostname(cert_, hostname) : false;
  17032. }
  17033. inline std::vector<SanEntry> PeerCert::sans() const {
  17034. std::vector<SanEntry> result;
  17035. if (cert_) { get_cert_sans(cert_, result); }
  17036. return result;
  17037. }
  17038. inline bool PeerCert::validity(time_t &not_before, time_t &not_after) const {
  17039. return cert_ ? get_cert_validity(cert_, not_before, not_after) : false;
  17040. }
  17041. inline std::string PeerCert::serial() const {
  17042. return cert_ ? get_cert_serial(cert_) : std::string();
  17043. }
  17044. // VerifyContext method implementations
  17045. inline std::string VerifyContext::subject_cn() const {
  17046. return cert ? get_cert_subject_cn(cert) : std::string();
  17047. }
  17048. inline std::string VerifyContext::issuer_name() const {
  17049. return cert ? get_cert_issuer_name(cert) : std::string();
  17050. }
  17051. inline bool VerifyContext::check_hostname(const char *hostname) const {
  17052. return cert ? verify_hostname(cert, hostname) : false;
  17053. }
  17054. inline std::vector<SanEntry> VerifyContext::sans() const {
  17055. std::vector<SanEntry> result;
  17056. if (cert) { get_cert_sans(cert, result); }
  17057. return result;
  17058. }
  17059. inline bool VerifyContext::validity(time_t &not_before,
  17060. time_t &not_after) const {
  17061. return cert ? get_cert_validity(cert, not_before, not_after) : false;
  17062. }
  17063. inline std::string VerifyContext::serial() const {
  17064. return cert ? get_cert_serial(cert) : std::string();
  17065. }
  17066. // TlsError static method implementation
  17067. inline std::string TlsError::verify_error_to_string(long error_code) {
  17068. return verify_error_string(error_code);
  17069. }
  17070. } // namespace tls
  17071. // Request::peer_cert() implementation
  17072. inline tls::PeerCert Request::peer_cert() const {
  17073. return tls::get_peer_cert_from_session(ssl);
  17074. }
  17075. // Request::sni() implementation
  17076. inline std::string Request::sni() const {
  17077. if (!ssl) { return std::string(); }
  17078. const char *s = tls::get_sni(ssl);
  17079. return s ? std::string(s) : std::string();
  17080. }
  17081. #endif // CPPHTTPLIB_SSL_ENABLED
  17082. /*
  17083. * Group 8: TLS abstraction layer - OpenSSL backend
  17084. */
  17085. /*
  17086. * OpenSSL Backend Implementation
  17087. */
  17088. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  17089. namespace tls {
  17090. namespace impl {
  17091. // Helper to map OpenSSL SSL_get_error to ErrorCode
  17092. inline ErrorCode map_ssl_error(int ssl_error, int &out_errno) {
  17093. switch (ssl_error) {
  17094. case SSL_ERROR_NONE: return ErrorCode::Success;
  17095. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  17096. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  17097. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  17098. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  17099. case SSL_ERROR_SSL:
  17100. default: return ErrorCode::Fatal;
  17101. }
  17102. }
  17103. // Fills in a failed SSL_connect(). One that the server certificate's
  17104. // verification stopped reports the verify result, as the other backends and
  17105. // a check after the handshake do.
  17106. inline void fill_connect_error(SSL *ssl, int ret, TlsError &err) {
  17107. auto ssl_err = SSL_get_error(ssl, ret);
  17108. auto error = ERR_get_error();
  17109. err.code = map_ssl_error(ssl_err, err.sys_errno);
  17110. err.backend_code = error;
  17111. if (ssl_err != SSL_ERROR_SSL || ERR_GET_LIB(error) != ERR_LIB_SSL ||
  17112. ERR_GET_REASON(error) != SSL_R_CERTIFICATE_VERIFY_FAILED) {
  17113. return;
  17114. }
  17115. // A certificate only a verify callback turned down carries no verdict of
  17116. // its own, and fails as any other handshake does
  17117. auto verify_result = SSL_get_verify_result(ssl);
  17118. if (verify_result == X509_V_OK || verify_result == X509_V_ERR_UNSPECIFIED) {
  17119. return;
  17120. }
  17121. err.code = verify_result == X509_V_ERR_HOSTNAME_MISMATCH
  17122. ? ErrorCode::HostnameMismatch
  17123. : ErrorCode::CertVerifyFailed;
  17124. err.backend_code = static_cast<uint64_t>(verify_result);
  17125. }
  17126. // Helper: Create client CA list from PEM string
  17127. // Returns a new STACK_OF(X509_NAME)* or nullptr on failure
  17128. // Caller takes ownership of returned list
  17129. inline STACK_OF(X509_NAME) *
  17130. create_client_ca_list_from_pem(const char *ca_pem) {
  17131. if (!ca_pem) { return nullptr; }
  17132. auto ca_list = sk_X509_NAME_new_null();
  17133. if (!ca_list) { return nullptr; }
  17134. BIO *bio = BIO_new_mem_buf(ca_pem, -1);
  17135. if (!bio) {
  17136. sk_X509_NAME_pop_free(ca_list, X509_NAME_free);
  17137. return nullptr;
  17138. }
  17139. X509 *cert = nullptr;
  17140. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  17141. nullptr) {
  17142. const X509_NAME *name = X509_get_subject_name(cert);
  17143. if (name) {
  17144. sk_X509_NAME_push(ca_list, X509_NAME_dup(const_cast<X509_NAME *>(name)));
  17145. }
  17146. X509_free(cert);
  17147. }
  17148. BIO_free(bio);
  17149. return ca_list;
  17150. }
  17151. inline void free_verify_callback(void * /*parent*/, void *ptr,
  17152. CRYPTO_EX_DATA * /*ad*/, int /*idx*/,
  17153. long /*argl*/, void * /*argp*/) {
  17154. delete static_cast<std::shared_ptr<VerifyCallback> *>(ptr);
  17155. }
  17156. // The SSL_CTX owns its verify callback, so each client or server sees only
  17157. // its own, on whichever thread runs the handshake.
  17158. inline int verify_callback_index() {
  17159. static const auto index = SSL_CTX_get_ex_new_index(
  17160. 0, nullptr, nullptr, nullptr, free_verify_callback);
  17161. return index;
  17162. }
  17163. // OpenSSL verify callback wrapper
  17164. inline int openssl_verify_callback(int preverify_ok, X509_STORE_CTX *ctx) {
  17165. // Get SSL object from X509_STORE_CTX
  17166. auto ssl = static_cast<SSL *>(
  17167. X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
  17168. if (!ssl) { return preverify_ok; }
  17169. std::shared_ptr<VerifyCallback> callback;
  17170. {
  17171. std::lock_guard<std::mutex> guard(verify_callback_mutex());
  17172. auto stored = static_cast<std::shared_ptr<VerifyCallback> *>(
  17173. SSL_CTX_get_ex_data(SSL_get_SSL_CTX(ssl), verify_callback_index()));
  17174. if (stored) { callback = *stored; }
  17175. }
  17176. if (!callback) { return preverify_ok; }
  17177. // Get current certificate and depth
  17178. auto cert = X509_STORE_CTX_get_current_cert(ctx);
  17179. int depth = X509_STORE_CTX_get_error_depth(ctx);
  17180. int error = X509_STORE_CTX_get_error(ctx);
  17181. // Build context
  17182. VerifyContext verify_ctx;
  17183. verify_ctx.session = static_cast<session_t>(ssl);
  17184. verify_ctx.cert = static_cast<cert_t>(cert);
  17185. verify_ctx.depth = depth;
  17186. verify_ctx.preverify_ok = (preverify_ok != 0);
  17187. verify_ctx.error_code = error;
  17188. verify_ctx.error_string =
  17189. (error != X509_V_OK) ? X509_verify_cert_error_string(error) : nullptr;
  17190. auto accepted = run_verify_callback(*callback, verify_ctx);
  17191. // A client verifying the server during the handshake, which is what
  17192. // set_verify_client(ctx, true) asks for there, keeps the built-in verdict
  17193. if (!SSL_is_server(ssl) &&
  17194. (SSL_get_verify_mode(ssl) & SSL_VERIFY_FAIL_IF_NO_PEER_CERT)) {
  17195. accepted = accepted && preverify_ok;
  17196. }
  17197. return accepted ? 1 : 0;
  17198. }
  17199. // Sets the verify mode from whether the peer's certificate is required and
  17200. // whether a verify callback is set.
  17201. inline void apply_verify_mode(SSL_CTX *ssl_ctx, bool require) {
  17202. auto has_callback =
  17203. SSL_CTX_get_ex_data(ssl_ctx, verify_callback_index()) != nullptr;
  17204. auto mode = require ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  17205. : (has_callback ? SSL_VERIFY_PEER : SSL_VERIFY_NONE);
  17206. SSL_CTX_set_verify(ssl_ctx, mode,
  17207. has_callback ? openssl_verify_callback : nullptr);
  17208. }
  17209. // X509_STORE_get0_objects is deprecated since OpenSSL 4.0 because it is not
  17210. // thread-safe; X509_STORE_get1_objects (OpenSSL 3.3+) returns a snapshot
  17211. // that must be released with release_store_objects
  17212. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER) && \
  17213. OPENSSL_VERSION_NUMBER >= 0x30300000L
  17214. #define CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  17215. #endif
  17216. inline STACK_OF(X509_OBJECT) * get_store_objects(X509_STORE *store) {
  17217. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  17218. return X509_STORE_get1_objects(store);
  17219. #else
  17220. return X509_STORE_get0_objects(store);
  17221. #endif
  17222. }
  17223. inline void release_store_objects(STACK_OF(X509_OBJECT) * objs) {
  17224. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  17225. sk_X509_OBJECT_pop_free(objs, X509_OBJECT_free);
  17226. #else
  17227. (void)objs; // get0 variant returns an internal pointer; nothing to free
  17228. #endif
  17229. }
  17230. } // namespace impl
  17231. inline ctx_t create_client_context() {
  17232. SSL_CTX *ctx = SSL_CTX_new(TLS_client_method());
  17233. if (ctx) {
  17234. // Disable auto-retry to properly handle non-blocking I/O
  17235. SSL_CTX_clear_mode(ctx, SSL_MODE_AUTO_RETRY);
  17236. // Set minimum TLS version
  17237. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  17238. }
  17239. return static_cast<ctx_t>(ctx);
  17240. }
  17241. inline void free_context(ctx_t ctx) {
  17242. if (ctx) { SSL_CTX_free(static_cast<SSL_CTX *>(ctx)); }
  17243. }
  17244. inline bool set_min_version(ctx_t ctx, Version version) {
  17245. if (!ctx) return false;
  17246. return SSL_CTX_set_min_proto_version(static_cast<SSL_CTX *>(ctx),
  17247. static_cast<uint16_t>(version)) == 1;
  17248. }
  17249. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  17250. if (!ctx || !pem || len == 0) return false;
  17251. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17252. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17253. if (!store) return false;
  17254. auto bio = BIO_new_mem_buf(pem, static_cast<int>(len));
  17255. if (!bio) return false;
  17256. bool ok = true;
  17257. X509 *cert = nullptr;
  17258. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  17259. nullptr) {
  17260. if (X509_STORE_add_cert(store, cert) != 1) {
  17261. // Ignore duplicate errors
  17262. auto err = ERR_peek_last_error();
  17263. if (ERR_GET_REASON(err) != X509_R_CERT_ALREADY_IN_HASH_TABLE) {
  17264. ok = false;
  17265. }
  17266. }
  17267. X509_free(cert);
  17268. if (!ok) break;
  17269. }
  17270. BIO_free(bio);
  17271. // Clear any "no more certificates" errors
  17272. ERR_clear_error();
  17273. return ok;
  17274. }
  17275. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  17276. if (!ctx || !file_path) return false;
  17277. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), file_path,
  17278. nullptr) == 1;
  17279. }
  17280. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  17281. if (!ctx || !dir_path) return false;
  17282. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), nullptr,
  17283. dir_path) == 1;
  17284. }
  17285. inline bool load_system_certs(ctx_t ctx) {
  17286. if (!ctx) return false;
  17287. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17288. #ifdef _WIN32
  17289. // Windows: Load from system certificate store (ROOT and CA)
  17290. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17291. if (!store) return false;
  17292. bool loaded_any = false;
  17293. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  17294. for (auto store_name : store_names) {
  17295. auto hStore = CertOpenSystemStoreW(NULL, store_name);
  17296. if (!hStore) continue;
  17297. PCCERT_CONTEXT pContext = nullptr;
  17298. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  17299. nullptr) {
  17300. const unsigned char *data = pContext->pbCertEncoded;
  17301. auto x509 = d2i_X509(nullptr, &data, pContext->cbCertEncoded);
  17302. if (x509) {
  17303. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  17304. X509_free(x509);
  17305. }
  17306. }
  17307. CertCloseStore(hStore, 0);
  17308. }
  17309. return loaded_any;
  17310. #elif defined(__APPLE__)
  17311. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  17312. // macOS: Load from Keychain
  17313. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17314. if (!store) return false;
  17315. auto loaded_any = impl::enumerate_macos_keychain_certs(
  17316. [&](const unsigned char *data, size_t len) {
  17317. auto x509 = d2i_X509(nullptr, &data, static_cast<long>(len));
  17318. if (!x509) { return false; }
  17319. auto added = X509_STORE_add_cert(store, x509) == 1;
  17320. X509_free(x509);
  17321. return added;
  17322. });
  17323. return loaded_any || SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17324. #else
  17325. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17326. #endif
  17327. #else
  17328. // Other Unix: use default verify paths
  17329. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17330. #endif
  17331. }
  17332. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17333. const char *password) {
  17334. if (!ctx || !cert || !key) return false;
  17335. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17336. // Load certificate
  17337. auto cert_bio = BIO_new_mem_buf(cert, -1);
  17338. if (!cert_bio) return false;
  17339. auto x509 = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  17340. BIO_free(cert_bio);
  17341. if (!x509) return false;
  17342. auto cert_ok = SSL_CTX_use_certificate(ssl_ctx, x509) == 1;
  17343. X509_free(x509);
  17344. if (!cert_ok) return false;
  17345. // Load private key
  17346. auto key_bio = BIO_new_mem_buf(key, -1);
  17347. if (!key_bio) return false;
  17348. auto pkey = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  17349. password ? const_cast<char *>(password)
  17350. : nullptr);
  17351. BIO_free(key_bio);
  17352. if (!pkey) return false;
  17353. auto key_ok = SSL_CTX_use_PrivateKey(ssl_ctx, pkey) == 1;
  17354. EVP_PKEY_free(pkey);
  17355. return key_ok && SSL_CTX_check_private_key(ssl_ctx) == 1;
  17356. }
  17357. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  17358. const char *key_path, const char *password) {
  17359. if (!ctx || !cert_path || !key_path) return false;
  17360. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17361. if (password && password[0] != '\0') {
  17362. SSL_CTX_set_default_passwd_cb_userdata(
  17363. ssl_ctx, reinterpret_cast<void *>(const_cast<char *>(password)));
  17364. }
  17365. return SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_path) == 1 &&
  17366. SSL_CTX_use_PrivateKey_file(ssl_ctx, key_path, SSL_FILETYPE_PEM) == 1;
  17367. }
  17368. inline ctx_t create_server_context() {
  17369. SSL_CTX *ctx = SSL_CTX_new(TLS_server_method());
  17370. if (ctx) {
  17371. // No renegotiation, as on the other backends: it would run a handshake
  17372. // that SSLServer::update_certs_pem() does not wait for
  17373. SSL_CTX_set_options(ctx, SSL_OP_NO_COMPRESSION |
  17374. SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION |
  17375. SSL_OP_NO_RENEGOTIATION);
  17376. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  17377. // Without one, a client resuming its session is sent a fatal alert once
  17378. // client certificates are verified.
  17379. static const unsigned char sid_ctx[] = "cpp-httplib";
  17380. SSL_CTX_set_session_id_context(ctx, sid_ctx, sizeof(sid_ctx) - 1);
  17381. }
  17382. return static_cast<ctx_t>(ctx);
  17383. }
  17384. inline void set_verify_client(ctx_t ctx, bool require) {
  17385. if (!ctx) return;
  17386. impl::apply_verify_mode(static_cast<SSL_CTX *>(ctx), require);
  17387. }
  17388. inline session_t create_session(ctx_t ctx, socket_t sock) {
  17389. if (!ctx || sock == INVALID_SOCKET) return nullptr;
  17390. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17391. SSL *ssl = SSL_new(ssl_ctx);
  17392. if (!ssl) return nullptr;
  17393. // Disable auto-retry for proper non-blocking I/O handling
  17394. SSL_clear_mode(ssl, SSL_MODE_AUTO_RETRY);
  17395. auto bio = BIO_new_socket(static_cast<int>(sock), BIO_NOCLOSE);
  17396. if (!bio) {
  17397. SSL_free(ssl);
  17398. return nullptr;
  17399. }
  17400. SSL_set_bio(ssl, bio, bio);
  17401. return static_cast<session_t>(ssl);
  17402. }
  17403. inline void free_session(session_t session) {
  17404. if (session) { SSL_free(static_cast<SSL *>(session)); }
  17405. }
  17406. inline bool set_sni(session_t session, const char *hostname,
  17407. bool verify_hostname) {
  17408. if (!session || !hostname) return false;
  17409. auto ssl = static_cast<SSL *>(session);
  17410. // The handshake's chain verification then checks the name as well
  17411. if (verify_hostname) {
  17412. auto param = SSL_get0_param(ssl);
  17413. X509_VERIFY_PARAM_set_hostflags(param, X509_CHECK_FLAG_NEVER_CHECK_SUBJECT);
  17414. if (X509_VERIFY_PARAM_set1_host(param, hostname, strlen(hostname)) != 1) {
  17415. return false;
  17416. }
  17417. }
  17418. #if defined(OPENSSL_IS_BORINGSSL)
  17419. return SSL_set_tlsext_host_name(ssl, hostname) == 1;
  17420. #else
  17421. // Direct call instead of macro to suppress -Wold-style-cast warning
  17422. return SSL_ctrl(ssl, SSL_CTRL_SET_TLSEXT_HOSTNAME, TLSEXT_NAMETYPE_host_name,
  17423. static_cast<void *>(const_cast<char *>(hostname))) == 1;
  17424. #endif
  17425. }
  17426. inline TlsError connect(session_t session) {
  17427. if (!session) { return TlsError(); }
  17428. auto ssl = static_cast<SSL *>(session);
  17429. auto ret = SSL_connect(ssl);
  17430. TlsError err;
  17431. if (ret == 1) {
  17432. err.code = ErrorCode::Success;
  17433. } else {
  17434. impl::fill_connect_error(ssl, ret, err);
  17435. }
  17436. return err;
  17437. }
  17438. inline TlsError accept(session_t session) {
  17439. if (!session) { return TlsError(); }
  17440. auto ssl = static_cast<SSL *>(session);
  17441. auto ret = SSL_accept(ssl);
  17442. TlsError err;
  17443. if (ret == 1) {
  17444. err.code = ErrorCode::Success;
  17445. } else {
  17446. auto ssl_err = SSL_get_error(ssl, ret);
  17447. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17448. err.backend_code = ERR_get_error();
  17449. }
  17450. return err;
  17451. }
  17452. inline bool connect_nonblocking(session_t session, socket_t sock,
  17453. time_t timeout_sec, time_t timeout_usec,
  17454. TlsError *err) {
  17455. if (!session) {
  17456. if (err) { err->code = ErrorCode::Fatal; }
  17457. return false;
  17458. }
  17459. auto ssl = static_cast<SSL *>(session);
  17460. auto bio = SSL_get_rbio(ssl);
  17461. // Set non-blocking mode for handshake
  17462. detail::set_nonblocking(sock, true);
  17463. if (bio) { BIO_set_nbio(bio, 1); }
  17464. auto cleanup = detail::scope_exit([&]() {
  17465. // Restore blocking mode after handshake
  17466. if (bio) { BIO_set_nbio(bio, 0); }
  17467. detail::set_nonblocking(sock, false);
  17468. });
  17469. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  17470. auto res = 0;
  17471. while ((res = SSL_connect(ssl)) != 1) {
  17472. auto ssl_err = SSL_get_error(ssl, res);
  17473. switch (ssl_err) {
  17474. case SSL_ERROR_WANT_READ:
  17475. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  17476. break;
  17477. case SSL_ERROR_WANT_WRITE:
  17478. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  17479. break;
  17480. default: break;
  17481. }
  17482. if (err) { impl::fill_connect_error(ssl, res, *err); }
  17483. return false;
  17484. }
  17485. if (err) { err->code = ErrorCode::Success; }
  17486. return true;
  17487. }
  17488. inline bool accept_nonblocking(session_t session, socket_t sock,
  17489. time_t timeout_sec, time_t timeout_usec,
  17490. TlsError *err) {
  17491. if (!session) {
  17492. if (err) { err->code = ErrorCode::Fatal; }
  17493. return false;
  17494. }
  17495. auto ssl = static_cast<SSL *>(session);
  17496. auto bio = SSL_get_rbio(ssl);
  17497. // Set non-blocking mode for handshake
  17498. detail::set_nonblocking(sock, true);
  17499. if (bio) { BIO_set_nbio(bio, 1); }
  17500. auto cleanup = detail::scope_exit([&]() {
  17501. // Restore blocking mode after handshake
  17502. if (bio) { BIO_set_nbio(bio, 0); }
  17503. detail::set_nonblocking(sock, false);
  17504. });
  17505. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  17506. auto res = 0;
  17507. while ((res = SSL_accept(ssl)) != 1) {
  17508. auto ssl_err = SSL_get_error(ssl, res);
  17509. switch (ssl_err) {
  17510. case SSL_ERROR_WANT_READ:
  17511. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  17512. break;
  17513. case SSL_ERROR_WANT_WRITE:
  17514. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  17515. break;
  17516. default: break;
  17517. }
  17518. if (err) {
  17519. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  17520. err->backend_code = ERR_get_error();
  17521. }
  17522. return false;
  17523. }
  17524. if (err) { err->code = ErrorCode::Success; }
  17525. return true;
  17526. }
  17527. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  17528. if (!session || !buf) {
  17529. err.code = ErrorCode::Fatal;
  17530. return -1;
  17531. }
  17532. auto ssl = static_cast<SSL *>(session);
  17533. constexpr auto max_len =
  17534. static_cast<size_t>((std::numeric_limits<int>::max)());
  17535. if (len > max_len) { len = max_len; }
  17536. auto ret = SSL_read(ssl, buf, static_cast<int>(len));
  17537. if (ret > 0) {
  17538. err.code = ErrorCode::Success;
  17539. return ret;
  17540. }
  17541. auto ssl_err = SSL_get_error(ssl, ret);
  17542. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17543. if (err.code == ErrorCode::PeerClosed) {
  17544. return 0;
  17545. } // Gracefully handle the peer closed state.
  17546. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  17547. return -1;
  17548. }
  17549. inline ssize_t write(session_t session, const void *buf, size_t len,
  17550. TlsError &err) {
  17551. if (!session || !buf) {
  17552. err.code = ErrorCode::Fatal;
  17553. return -1;
  17554. }
  17555. auto ssl = static_cast<SSL *>(session);
  17556. auto ret = SSL_write(ssl, buf, static_cast<int>(len));
  17557. if (ret > 0) {
  17558. err.code = ErrorCode::Success;
  17559. return ret;
  17560. }
  17561. auto ssl_err = SSL_get_error(ssl, ret);
  17562. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17563. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  17564. return -1;
  17565. }
  17566. inline int pending(const_session_t session) {
  17567. if (!session) return 0;
  17568. return SSL_pending(static_cast<SSL *>(const_cast<void *>(session)));
  17569. }
  17570. inline void shutdown(session_t session, bool graceful) {
  17571. if (!session) return;
  17572. auto ssl = static_cast<SSL *>(session);
  17573. if (graceful) {
  17574. // Send close_notify without waiting for the peer's. The connection is
  17575. // closed right after this, so a unidirectional shutdown is enough, and an
  17576. // idle peer that never answers would otherwise hold this thread until the
  17577. // read timeout. The other backends do not wait either.
  17578. SSL_shutdown(ssl);
  17579. }
  17580. }
  17581. inline bool is_peer_closed(session_t session, socket_t sock) {
  17582. if (!session) return true;
  17583. // Temporarily set socket to non-blocking to avoid blocking on SSL_peek
  17584. detail::set_nonblocking(sock, true);
  17585. auto se = detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17586. auto ssl = static_cast<SSL *>(session);
  17587. char buf;
  17588. auto ret = SSL_peek(ssl, &buf, 1);
  17589. if (ret > 0) return false;
  17590. auto err = SSL_get_error(ssl, ret);
  17591. return err == SSL_ERROR_ZERO_RETURN;
  17592. }
  17593. inline cert_t get_peer_cert(const_session_t session) {
  17594. if (!session) return nullptr;
  17595. return static_cast<cert_t>(SSL_get1_peer_certificate(
  17596. static_cast<SSL *>(const_cast<void *>(session))));
  17597. }
  17598. inline size_t get_peer_certs(const_session_t session,
  17599. std::vector<cert_t> &certs) {
  17600. certs.clear();
  17601. if (!session) { return 0; }
  17602. auto ssl = static_cast<const SSL *>(session);
  17603. // On the server side, the chain leaves out the peer's own certificate
  17604. if (SSL_is_server(ssl)) {
  17605. if (auto leaf = get_peer_cert(session)) { certs.push_back(leaf); }
  17606. }
  17607. if (auto sk = SSL_get_peer_cert_chain(ssl)) {
  17608. auto count = sk_X509_num(sk);
  17609. for (decltype(count) i = 0; i < count; i++) {
  17610. auto x509 = sk_X509_value(sk, i);
  17611. X509_up_ref(x509);
  17612. certs.push_back(static_cast<cert_t>(x509));
  17613. }
  17614. }
  17615. return certs.size();
  17616. }
  17617. inline void free_cert(cert_t cert) {
  17618. if (cert) { X509_free(static_cast<X509 *>(cert)); }
  17619. }
  17620. inline bool verify_hostname(cert_t cert, const char *hostname) {
  17621. if (!cert || !hostname) return false;
  17622. auto x509 = static_cast<X509 *>(cert);
  17623. // Use X509_check_ip_asc for IP addresses, X509_check_host for DNS names
  17624. if (detail::is_ip_address(hostname)) {
  17625. return X509_check_ip_asc(x509, hostname, 0) == 1;
  17626. }
  17627. return X509_check_host(x509, hostname, strlen(hostname),
  17628. X509_CHECK_FLAG_NEVER_CHECK_SUBJECT, nullptr) == 1;
  17629. }
  17630. inline uint64_t hostname_mismatch_code() {
  17631. return static_cast<uint64_t>(X509_V_ERR_HOSTNAME_MISMATCH);
  17632. }
  17633. inline long get_verify_result(const_session_t session) {
  17634. if (!session) return X509_V_ERR_UNSPECIFIED;
  17635. return SSL_get_verify_result(static_cast<SSL *>(const_cast<void *>(session)));
  17636. }
  17637. inline std::string get_cert_subject_cn(cert_t cert) {
  17638. if (!cert) return "";
  17639. auto x509 = static_cast<X509 *>(cert);
  17640. auto subject_name = X509_get_subject_name(x509);
  17641. if (!subject_name) return "";
  17642. // X509_NAME_get_text_by_NID is deprecated since OpenSSL 4.0
  17643. auto idx = X509_NAME_get_index_by_NID(subject_name, NID_commonName, -1);
  17644. if (idx < 0) return "";
  17645. auto entry = X509_NAME_get_entry(subject_name, idx);
  17646. if (!entry) return "";
  17647. auto data = X509_NAME_ENTRY_get_data(entry);
  17648. if (!data) return "";
  17649. return std::string(
  17650. reinterpret_cast<const char *>(ASN1_STRING_get0_data(data)),
  17651. static_cast<size_t>(ASN1_STRING_length(data)));
  17652. }
  17653. inline std::string get_cert_issuer_name(cert_t cert) {
  17654. if (!cert) return "";
  17655. auto x509 = static_cast<X509 *>(cert);
  17656. auto issuer_name = X509_get_issuer_name(x509);
  17657. if (!issuer_name) return "";
  17658. char buf[256];
  17659. X509_NAME_oneline(issuer_name, buf, sizeof(buf));
  17660. return std::string(buf);
  17661. }
  17662. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  17663. sans.clear();
  17664. if (!cert) return false;
  17665. auto x509 = static_cast<X509 *>(cert);
  17666. auto names = static_cast<GENERAL_NAMES *>(
  17667. X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  17668. if (!names) return true; // No SANs is valid
  17669. auto count = sk_GENERAL_NAME_num(names);
  17670. for (decltype(count) i = 0; i < count; i++) {
  17671. auto gen = sk_GENERAL_NAME_value(names, i);
  17672. if (!gen) continue;
  17673. SanEntry entry;
  17674. switch (gen->type) {
  17675. case GEN_DNS:
  17676. entry.type = SanType::DNS;
  17677. if (gen->d.dNSName) {
  17678. entry.value = std::string(
  17679. reinterpret_cast<const char *>(
  17680. ASN1_STRING_get0_data(gen->d.dNSName)),
  17681. static_cast<size_t>(ASN1_STRING_length(gen->d.dNSName)));
  17682. }
  17683. break;
  17684. case GEN_IPADD:
  17685. entry.type = SanType::IP;
  17686. if (gen->d.iPAddress) {
  17687. auto data = ASN1_STRING_get0_data(gen->d.iPAddress);
  17688. auto len = ASN1_STRING_length(gen->d.iPAddress);
  17689. if (len == 4) {
  17690. // IPv4
  17691. char buf[INET_ADDRSTRLEN];
  17692. inet_ntop(AF_INET, data, buf, sizeof(buf));
  17693. entry.value = buf;
  17694. } else if (len == 16) {
  17695. // IPv6
  17696. char buf[INET6_ADDRSTRLEN];
  17697. inet_ntop(AF_INET6, data, buf, sizeof(buf));
  17698. entry.value = buf;
  17699. }
  17700. }
  17701. break;
  17702. case GEN_EMAIL:
  17703. entry.type = SanType::EMAIL;
  17704. if (gen->d.rfc822Name) {
  17705. entry.value = std::string(
  17706. reinterpret_cast<const char *>(
  17707. ASN1_STRING_get0_data(gen->d.rfc822Name)),
  17708. static_cast<size_t>(ASN1_STRING_length(gen->d.rfc822Name)));
  17709. }
  17710. break;
  17711. case GEN_URI:
  17712. entry.type = SanType::URI;
  17713. if (gen->d.uniformResourceIdentifier) {
  17714. entry.value = std::string(
  17715. reinterpret_cast<const char *>(
  17716. ASN1_STRING_get0_data(gen->d.uniformResourceIdentifier)),
  17717. static_cast<size_t>(
  17718. ASN1_STRING_length(gen->d.uniformResourceIdentifier)));
  17719. }
  17720. break;
  17721. default: entry.type = SanType::OTHER; break;
  17722. }
  17723. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  17724. }
  17725. GENERAL_NAMES_free(names);
  17726. return true;
  17727. }
  17728. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  17729. time_t &not_after) {
  17730. if (!cert) return false;
  17731. auto x509 = static_cast<X509 *>(cert);
  17732. auto nb = X509_get0_notBefore(x509);
  17733. auto na = X509_get0_notAfter(x509);
  17734. if (!nb || !na) return false;
  17735. ASN1_TIME *epoch = ASN1_TIME_new();
  17736. if (!epoch) return false;
  17737. auto se = detail::scope_exit([&] { ASN1_TIME_free(epoch); });
  17738. if (!ASN1_TIME_set(epoch, 0)) return false;
  17739. int pday, psec;
  17740. if (!ASN1_TIME_diff(&pday, &psec, epoch, nb)) return false;
  17741. not_before = 86400 * (time_t)pday + psec;
  17742. if (!ASN1_TIME_diff(&pday, &psec, epoch, na)) return false;
  17743. not_after = 86400 * (time_t)pday + psec;
  17744. return true;
  17745. }
  17746. inline std::string get_cert_serial(cert_t cert) {
  17747. if (!cert) return "";
  17748. auto x509 = static_cast<X509 *>(cert);
  17749. auto serial = X509_get_serialNumber(x509);
  17750. if (!serial) return "";
  17751. auto bn = ASN1_INTEGER_to_BN(serial, nullptr);
  17752. if (!bn) return "";
  17753. auto hex = BN_bn2hex(bn);
  17754. BN_free(bn);
  17755. if (!hex) return "";
  17756. std::string result(hex);
  17757. OPENSSL_free(hex);
  17758. return result;
  17759. }
  17760. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  17761. if (!cert) return false;
  17762. auto x509 = static_cast<X509 *>(cert);
  17763. auto len = i2d_X509(x509, nullptr);
  17764. if (len < 0) return false;
  17765. der.resize(static_cast<size_t>(len));
  17766. auto p = der.data();
  17767. i2d_X509(x509, &p);
  17768. return true;
  17769. }
  17770. inline const char *get_sni(const_session_t session) {
  17771. if (!session) return nullptr;
  17772. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17773. return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
  17774. }
  17775. inline uint64_t peek_error() { return ERR_peek_last_error(); }
  17776. inline uint64_t get_error() { return ERR_get_error(); }
  17777. inline std::string error_string(uint64_t code) {
  17778. char buf[256];
  17779. ERR_error_string_n(static_cast<decltype(ERR_get_error())>(code), buf,
  17780. sizeof(buf));
  17781. return std::string(buf);
  17782. }
  17783. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  17784. auto mem = BIO_new_mem_buf(pem, static_cast<int>(len));
  17785. if (!mem) { return nullptr; }
  17786. auto mem_guard = detail::scope_exit([&] { BIO_free_all(mem); });
  17787. auto inf = PEM_X509_INFO_read_bio(mem, nullptr, nullptr, nullptr);
  17788. if (!inf) { return nullptr; }
  17789. auto store = X509_STORE_new();
  17790. if (store) {
  17791. auto count = sk_X509_INFO_num(inf);
  17792. for (decltype(count) i = 0; i < count; i++) {
  17793. auto itmp = sk_X509_INFO_value(inf, i);
  17794. if (!itmp) { continue; }
  17795. if (itmp->x509) { X509_STORE_add_cert(store, itmp->x509); }
  17796. if (itmp->crl) { X509_STORE_add_crl(store, itmp->crl); }
  17797. }
  17798. }
  17799. sk_X509_INFO_pop_free(inf, X509_INFO_free);
  17800. return static_cast<ca_store_t>(store);
  17801. }
  17802. inline void free_ca_store(ca_store_t store) {
  17803. if (store) { X509_STORE_free(static_cast<X509_STORE *>(store)); }
  17804. }
  17805. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  17806. if (!ctx || !store) { return false; }
  17807. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17808. auto x509_store = static_cast<X509_STORE *>(store);
  17809. // Check if same store is already set
  17810. if (SSL_CTX_get_cert_store(ssl_ctx) == x509_store) { return true; }
  17811. // SSL_CTX_set_cert_store takes ownership and frees the old store
  17812. SSL_CTX_set_cert_store(ssl_ctx, x509_store);
  17813. return true;
  17814. }
  17815. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  17816. certs.clear();
  17817. if (!ctx) { return 0; }
  17818. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17819. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17820. if (!store) { return 0; }
  17821. auto objs = impl::get_store_objects(store);
  17822. if (!objs) { return 0; }
  17823. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  17824. auto count = sk_X509_OBJECT_num(objs);
  17825. for (decltype(count) i = 0; i < count; i++) {
  17826. auto obj = sk_X509_OBJECT_value(objs, i);
  17827. if (!obj) { continue; }
  17828. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  17829. auto x509 = X509_OBJECT_get0_X509(obj);
  17830. if (x509) {
  17831. // Increment reference count so caller can free it
  17832. X509_up_ref(x509);
  17833. certs.push_back(static_cast<cert_t>(x509));
  17834. }
  17835. }
  17836. }
  17837. return certs.size();
  17838. }
  17839. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  17840. std::vector<std::string> names;
  17841. if (!ctx) { return names; }
  17842. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17843. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17844. if (!store) { return names; }
  17845. auto objs = impl::get_store_objects(store);
  17846. if (!objs) { return names; }
  17847. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  17848. auto count = sk_X509_OBJECT_num(objs);
  17849. for (decltype(count) i = 0; i < count; i++) {
  17850. auto obj = sk_X509_OBJECT_value(objs, i);
  17851. if (!obj) { continue; }
  17852. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  17853. auto x509 = X509_OBJECT_get0_X509(obj);
  17854. if (x509) {
  17855. auto subject = X509_get_subject_name(x509);
  17856. if (subject) {
  17857. char buf[512];
  17858. X509_NAME_oneline(subject, buf, sizeof(buf));
  17859. names.push_back(buf);
  17860. }
  17861. }
  17862. }
  17863. }
  17864. return names;
  17865. }
  17866. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  17867. const char *key_pem, const char *password) {
  17868. if (!ctx || !cert_pem || !key_pem) { return false; }
  17869. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17870. // Load certificate from PEM
  17871. auto cert_bio = BIO_new_mem_buf(cert_pem, -1);
  17872. if (!cert_bio) { return false; }
  17873. auto cert = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  17874. BIO_free(cert_bio);
  17875. if (!cert) { return false; }
  17876. // Load private key from PEM
  17877. auto key_bio = BIO_new_mem_buf(key_pem, -1);
  17878. if (!key_bio) {
  17879. X509_free(cert);
  17880. return false;
  17881. }
  17882. auto key = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  17883. password ? const_cast<char *>(password)
  17884. : nullptr);
  17885. BIO_free(key_bio);
  17886. if (!key) {
  17887. X509_free(cert);
  17888. return false;
  17889. }
  17890. // Update certificate and key
  17891. auto ret = SSL_CTX_use_certificate(ssl_ctx, cert) == 1 &&
  17892. SSL_CTX_use_PrivateKey(ssl_ctx, key) == 1;
  17893. X509_free(cert);
  17894. EVP_PKEY_free(key);
  17895. return ret;
  17896. }
  17897. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  17898. if (!ctx || !ca_pem) { return false; }
  17899. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17900. // Create new X509_STORE from PEM
  17901. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  17902. if (!store) { return false; }
  17903. // A resumed session is not verified again, so the ticket keys from before
  17904. // go, or a client verified under the old CAs could go on resuming.
  17905. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  17906. unsigned char ticket_keys[48];
  17907. #else
  17908. unsigned char ticket_keys[80];
  17909. #endif
  17910. if (RAND_bytes(ticket_keys, sizeof(ticket_keys)) != 1 ||
  17911. SSL_CTX_set_tlsext_ticket_keys(ssl_ctx, ticket_keys,
  17912. sizeof(ticket_keys)) != 1) {
  17913. free_ca_store(store);
  17914. return false;
  17915. }
  17916. // SSL_CTX_set_cert_store takes ownership
  17917. SSL_CTX_set_cert_store(ssl_ctx, static_cast<X509_STORE *>(store));
  17918. // Set client CA list for client certificate request
  17919. auto ca_list = impl::create_client_ca_list_from_pem(ca_pem);
  17920. if (ca_list) {
  17921. // SSL_CTX_set_client_CA_list takes ownership of ca_list
  17922. SSL_CTX_set_client_CA_list(ssl_ctx, ca_list);
  17923. }
  17924. // The cached sessions go for the same reason.
  17925. #if OPENSSL_VERSION_NUMBER >= 0x30400000L
  17926. SSL_CTX_flush_sessions_ex(ssl_ctx, (std::numeric_limits<time_t>::max)());
  17927. #else
  17928. SSL_CTX_flush_sessions(ssl_ctx, (std::numeric_limits<long>::max)());
  17929. #endif
  17930. return true;
  17931. }
  17932. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  17933. if (!ctx) { return false; }
  17934. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17935. auto index = impl::verify_callback_index();
  17936. if (index < 0) { return false; }
  17937. std::shared_ptr<VerifyCallback> *stored = nullptr;
  17938. if (callback) {
  17939. stored = new std::shared_ptr<VerifyCallback>(
  17940. std::make_shared<VerifyCallback>(std::move(callback)));
  17941. }
  17942. std::shared_ptr<VerifyCallback> *previous = nullptr;
  17943. {
  17944. std::lock_guard<std::mutex> guard(impl::verify_callback_mutex());
  17945. previous = static_cast<std::shared_ptr<VerifyCallback> *>(
  17946. SSL_CTX_get_ex_data(ssl_ctx, index));
  17947. if (SSL_CTX_set_ex_data(ssl_ctx, index, stored) != 1) {
  17948. delete stored;
  17949. return false;
  17950. }
  17951. }
  17952. // A handshake running the previous callback keeps it until it returns.
  17953. delete previous;
  17954. // A resumed handshake shows no certificate to run the callback on.
  17955. if (stored) {
  17956. SSL_CTX_set_options(ssl_ctx, SSL_OP_NO_TICKET);
  17957. SSL_CTX_set_session_cache_mode(ssl_ctx, SSL_SESS_CACHE_OFF);
  17958. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER)
  17959. // TLS 1.3 tickets, which SSL_OP_NO_TICKET leaves on
  17960. SSL_CTX_set_num_tickets(ssl_ctx, 0);
  17961. #endif
  17962. }
  17963. // Keep requiring the peer's certificate if set_verify_client() asked for it
  17964. auto require =
  17965. (SSL_CTX_get_verify_mode(ssl_ctx) & SSL_VERIFY_FAIL_IF_NO_PEER_CERT) != 0;
  17966. impl::apply_verify_mode(ssl_ctx, require);
  17967. return true;
  17968. }
  17969. inline long get_verify_error(const_session_t session) {
  17970. if (!session) { return -1; }
  17971. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17972. return SSL_get_verify_result(ssl);
  17973. }
  17974. inline std::string verify_error_string(long error_code) {
  17975. if (error_code == X509_V_OK) { return ""; }
  17976. const char *str = X509_verify_cert_error_string(static_cast<int>(error_code));
  17977. return str ? str : "unknown error";
  17978. }
  17979. } // namespace tls
  17980. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  17981. /*
  17982. * Group 9: TLS abstraction layer - Mbed TLS backend
  17983. */
  17984. /*
  17985. * Mbed TLS Backend Implementation
  17986. */
  17987. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  17988. namespace tls {
  17989. namespace impl {
  17990. // Mbed TLS session wrapper
  17991. struct MbedTlsSession {
  17992. mbedtls_ssl_context ssl;
  17993. socket_t sock = INVALID_SOCKET;
  17994. std::string hostname; // For client: set via set_sni
  17995. std::string sni_hostname; // For server: received from client via SNI callback
  17996. // Mbed TLS has no SSL_peek() equivalent, so is_peer_closed() must probe with
  17997. // a real 1-byte mbedtls_ssl_read(). If that probe lands on application data
  17998. // (e.g. a response that arrived while this side was still in its post-write
  17999. // check), the byte is pushed back here and served by the next read().
  18000. unsigned char peeked_byte = 0;
  18001. bool has_peeked_byte = false;
  18002. // Set by set_sni() when the caller disabled hostname verification, so the
  18003. // verify callback can clear the CN/SAN mismatch flag while still enforcing
  18004. // the rest of the chain (Mbed TLS ties SNI and identity checking together;
  18005. // OpenSSL and wolfSSL keep them independent).
  18006. bool suppress_hostname_mismatch = false;
  18007. // Copied from the owning MbedTlsContext at creation, so a handshake only
  18008. // ever runs the callback of its own context.
  18009. VerifyCallback verify_callback;
  18010. bool is_server = false;
  18011. MbedTlsSession() { mbedtls_ssl_init(&ssl); }
  18012. ~MbedTlsSession() { mbedtls_ssl_free(&ssl); }
  18013. MbedTlsSession(const MbedTlsSession &) = delete;
  18014. MbedTlsSession &operator=(const MbedTlsSession &) = delete;
  18015. };
  18016. // Thread-local error code accessor for Mbed TLS (since it doesn't have an error
  18017. // queue)
  18018. inline int &mbedtls_last_error() {
  18019. static thread_local int err = 0;
  18020. return err;
  18021. }
  18022. // Helper to map Mbed TLS error to ErrorCode
  18023. inline ErrorCode map_mbedtls_error(int ret, int &out_errno,
  18024. uint32_t verify_flags) {
  18025. if (ret == 0) { return ErrorCode::Success; }
  18026. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return ErrorCode::WantRead; }
  18027. if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) { return ErrorCode::WantWrite; }
  18028. if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
  18029. return ErrorCode::PeerClosed;
  18030. }
  18031. if (ret == MBEDTLS_ERR_NET_CONN_RESET || ret == MBEDTLS_ERR_NET_SEND_FAILED ||
  18032. ret == MBEDTLS_ERR_NET_RECV_FAILED) {
  18033. out_errno = errno;
  18034. return ErrorCode::SyscallError;
  18035. }
  18036. if (ret == MBEDTLS_ERR_SSL_CONN_EOF) {
  18037. // EOF without close_notify
  18038. out_errno = 0;
  18039. return ErrorCode::SyscallError;
  18040. }
  18041. if (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED) {
  18042. // Unlike OpenSSL/wolfSSL, Mbed TLS folds the CN/SAN identity check into
  18043. // the handshake's chain verification (see set_sni()); a mismatch there
  18044. // is reported the same way as any other verify_flags bit. Report it as
  18045. // HostnameMismatch, matching the other backends and the post-handshake
  18046. // identity check below, but only when naming is the sole problem -
  18047. // if the chain itself is also untrusted/expired/etc., that takes
  18048. // priority over the naming detail.
  18049. if (verify_flags == static_cast<uint32_t>(hostname_mismatch_code())) {
  18050. return ErrorCode::HostnameMismatch;
  18051. }
  18052. return ErrorCode::CertVerifyFailed;
  18053. }
  18054. return ErrorCode::Fatal;
  18055. }
  18056. // Populates a TlsError from a failed (non-zero) mbedtls_ssl_handshake()
  18057. // return value, including the verify-flags-dependent HostnameMismatch
  18058. // mapping; shared by connect() and connect_nonblocking() so the
  18059. // backend_code policy for that mapping only lives in one place.
  18060. inline void fill_mbedtls_tls_error(TlsError &err, mbedtls_ssl_context &ssl,
  18061. int ret) {
  18062. auto verify_flags = mbedtls_ssl_get_verify_result(&ssl);
  18063. err.code = map_mbedtls_error(ret, err.sys_errno, verify_flags);
  18064. err.backend_code = err.code == ErrorCode::HostnameMismatch
  18065. ? static_cast<uint64_t>(verify_flags)
  18066. : static_cast<uint64_t>(-ret);
  18067. }
  18068. // A TLS 1.3 NewSessionTicket (signaled by default on Mbed TLS 4.x) is a
  18069. // non-fatal notification delivered between records, not an error and not
  18070. // application data, so I/O calls that see it should just be retried. Kept in
  18071. // one helper so the retry loops keep an intact "do { } while (...)" instead of
  18072. // splitting the closing brace across an #if.
  18073. inline bool mbedtls_is_session_ticket(int ret) {
  18074. #if defined(MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET)
  18075. return ret == MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
  18076. #else
  18077. (void)ret;
  18078. return false;
  18079. #endif
  18080. }
  18081. // BIO-like send callback for Mbed TLS
  18082. inline int mbedtls_net_send_cb(void *ctx, const unsigned char *buf,
  18083. size_t len) {
  18084. auto sock = *static_cast<socket_t *>(ctx);
  18085. #ifdef _WIN32
  18086. auto ret =
  18087. send(sock, reinterpret_cast<const char *>(buf), static_cast<int>(len), 0);
  18088. if (ret == SOCKET_ERROR) {
  18089. int err = WSAGetLastError();
  18090. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_WRITE; }
  18091. return MBEDTLS_ERR_NET_SEND_FAILED;
  18092. }
  18093. #else
  18094. auto ret = send(sock, buf, len, 0);
  18095. if (ret < 0) {
  18096. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  18097. return MBEDTLS_ERR_SSL_WANT_WRITE;
  18098. }
  18099. return MBEDTLS_ERR_NET_SEND_FAILED;
  18100. }
  18101. #endif
  18102. return static_cast<int>(ret);
  18103. }
  18104. // BIO-like recv callback for Mbed TLS
  18105. inline int mbedtls_net_recv_cb(void *ctx, unsigned char *buf, size_t len) {
  18106. auto sock = *static_cast<socket_t *>(ctx);
  18107. #ifdef _WIN32
  18108. auto ret =
  18109. recv(sock, reinterpret_cast<char *>(buf), static_cast<int>(len), 0);
  18110. if (ret == SOCKET_ERROR) {
  18111. int err = WSAGetLastError();
  18112. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_READ; }
  18113. return MBEDTLS_ERR_NET_RECV_FAILED;
  18114. }
  18115. #else
  18116. auto ret = recv(sock, buf, len, 0);
  18117. if (ret < 0) {
  18118. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  18119. return MBEDTLS_ERR_SSL_WANT_READ;
  18120. }
  18121. return MBEDTLS_ERR_NET_RECV_FAILED;
  18122. }
  18123. #endif
  18124. // EOF is MBEDTLS_ERR_SSL_CONN_EOF; only a close_notify is a clean end
  18125. return static_cast<int>(ret);
  18126. }
  18127. // MbedTlsContext constructor/destructor implementations
  18128. inline MbedTlsContext::MbedTlsContext() {
  18129. mbedtls_ssl_config_init(&conf);
  18130. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18131. mbedtls_entropy_init(&entropy);
  18132. mbedtls_ctr_drbg_init(&ctr_drbg);
  18133. #endif
  18134. mbedtls_x509_crt_init(&ca_chain);
  18135. mbedtls_x509_crt_init(&own_cert);
  18136. mbedtls_pk_init(&own_key);
  18137. }
  18138. inline MbedTlsContext::~MbedTlsContext() {
  18139. mbedtls_pk_free(&own_key);
  18140. mbedtls_x509_crt_free(&own_cert);
  18141. mbedtls_x509_crt_free(&ca_chain);
  18142. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18143. mbedtls_ctr_drbg_free(&ctr_drbg);
  18144. mbedtls_entropy_free(&entropy);
  18145. #endif
  18146. mbedtls_ssl_config_free(&conf);
  18147. }
  18148. // Thread-local storage for SNI captured during handshake
  18149. // This is needed because the SNI callback doesn't have a way to pass
  18150. // session-specific data before the session is fully set up
  18151. inline std::string &mbedpending_sni() {
  18152. static thread_local std::string sni;
  18153. return sni;
  18154. }
  18155. // SNI callback for Mbed TLS server to capture client's SNI hostname
  18156. inline int mbedtls_sni_callback(void *p_ctx, mbedtls_ssl_context *ssl,
  18157. const unsigned char *name, size_t name_len) {
  18158. (void)p_ctx;
  18159. (void)ssl;
  18160. // Store SNI name in thread-local storage
  18161. // It will be retrieved and stored in the session after handshake
  18162. if (name && name_len > 0) {
  18163. mbedpending_sni().assign(reinterpret_cast<const char *>(name), name_len);
  18164. } else {
  18165. mbedpending_sni().clear();
  18166. }
  18167. return 0; // Accept any SNI
  18168. }
  18169. inline void mbedtls_clear_cn_mismatch(uint32_t *flags) {
  18170. *flags &= ~static_cast<uint32_t>(hostname_mismatch_code());
  18171. }
  18172. // MbedTLS verify callback wrapper
  18173. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  18174. int cert_depth, uint32_t *flags) {
  18175. // data points to the MbedTlsSession
  18176. auto *session = static_cast<MbedTlsSession *>(data);
  18177. // set_sni() disabled hostname verification for this session: ignore the
  18178. // CN/SAN mismatch flag, as the OpenSSL/wolfSSL backends do. The final
  18179. // pass/fail decision still comes from the remaining flags (and, below, from
  18180. // the user's own verify callback).
  18181. if (session->suppress_hostname_mismatch) { mbedtls_clear_cn_mismatch(flags); }
  18182. const auto &callback = session->verify_callback;
  18183. if (!callback) { return 0; } // Continue with default verification
  18184. // Build context
  18185. VerifyContext verify_ctx;
  18186. verify_ctx.session = static_cast<session_t>(session);
  18187. verify_ctx.cert = static_cast<cert_t>(crt);
  18188. verify_ctx.depth = cert_depth;
  18189. verify_ctx.preverify_ok = (*flags == 0);
  18190. verify_ctx.error_code = static_cast<long>(*flags);
  18191. // Convert Mbed TLS flags to error string
  18192. static thread_local char error_buf[256];
  18193. if (*flags != 0) {
  18194. mbedtls_x509_crt_verify_info(error_buf, sizeof(error_buf), "", *flags);
  18195. verify_ctx.error_string = error_buf;
  18196. } else {
  18197. verify_ctx.error_string = nullptr;
  18198. }
  18199. bool accepted = run_verify_callback(callback, verify_ctx);
  18200. if (accepted) {
  18201. // Overrides the built-in verification only on a server, as on OpenSSL and
  18202. // wolfSSL, whose clients check the verify result after the handshake
  18203. if (session->is_server) { *flags = 0; }
  18204. return 0;
  18205. }
  18206. return MBEDTLS_ERR_X509_CERT_VERIFY_FAILED;
  18207. }
  18208. // Sets the authentication mode from whether the peer's certificate is required
  18209. // and whether a verify callback is set. OPTIONAL lets the callback run even if
  18210. // verification is not required (matching OpenSSL's SSL_VERIFY_PEER).
  18211. inline void apply_verify_mode(MbedTlsContext &mctx) {
  18212. auto mode = MBEDTLS_SSL_VERIFY_NONE;
  18213. if (mctx.verify_client) {
  18214. mode = MBEDTLS_SSL_VERIFY_REQUIRED;
  18215. } else if (mctx.verify_callback) {
  18216. mode = MBEDTLS_SSL_VERIFY_OPTIONAL;
  18217. }
  18218. mbedtls_ssl_conf_authmode(&mctx.conf, mode);
  18219. }
  18220. } // namespace impl
  18221. inline ctx_t create_client_context() {
  18222. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  18223. if (!ctx) { return nullptr; }
  18224. ctx->is_server = false;
  18225. #ifdef CPPHTTPLIB_MBEDTLS_V4
  18226. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  18227. if (!detail::ensure_mbedtls_psa_crypto()) {
  18228. delete ctx;
  18229. return nullptr;
  18230. }
  18231. int ret;
  18232. #else
  18233. // Seed the random number generator
  18234. const char *pers = "httplib_client";
  18235. int ret = mbedtls_ctr_drbg_seed(
  18236. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  18237. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  18238. if (ret != 0) {
  18239. impl::mbedtls_last_error() = ret;
  18240. delete ctx;
  18241. return nullptr;
  18242. }
  18243. #endif
  18244. // Set up SSL config for client
  18245. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_CLIENT,
  18246. MBEDTLS_SSL_TRANSPORT_STREAM,
  18247. MBEDTLS_SSL_PRESET_DEFAULT);
  18248. if (ret != 0) {
  18249. impl::mbedtls_last_error() = ret;
  18250. delete ctx;
  18251. return nullptr;
  18252. }
  18253. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18254. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  18255. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  18256. #endif
  18257. // Default: verify peer certificate
  18258. ctx->verify_client = true;
  18259. impl::apply_verify_mode(*ctx);
  18260. // Set minimum TLS version to 1.2
  18261. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18262. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  18263. #else
  18264. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  18265. MBEDTLS_SSL_MINOR_VERSION_3);
  18266. #endif
  18267. return static_cast<ctx_t>(ctx);
  18268. }
  18269. inline ctx_t create_server_context() {
  18270. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  18271. if (!ctx) { return nullptr; }
  18272. ctx->is_server = true;
  18273. #ifdef CPPHTTPLIB_MBEDTLS_V4
  18274. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  18275. if (!detail::ensure_mbedtls_psa_crypto()) {
  18276. delete ctx;
  18277. return nullptr;
  18278. }
  18279. int ret;
  18280. #else
  18281. // Seed the random number generator
  18282. const char *pers = "httplib_server";
  18283. int ret = mbedtls_ctr_drbg_seed(
  18284. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  18285. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  18286. if (ret != 0) {
  18287. impl::mbedtls_last_error() = ret;
  18288. delete ctx;
  18289. return nullptr;
  18290. }
  18291. #endif
  18292. // Set up SSL config for server
  18293. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_SERVER,
  18294. MBEDTLS_SSL_TRANSPORT_STREAM,
  18295. MBEDTLS_SSL_PRESET_DEFAULT);
  18296. if (ret != 0) {
  18297. impl::mbedtls_last_error() = ret;
  18298. delete ctx;
  18299. return nullptr;
  18300. }
  18301. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18302. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  18303. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  18304. #endif
  18305. // Default: don't verify client
  18306. impl::apply_verify_mode(*ctx);
  18307. // Set minimum TLS version to 1.2
  18308. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18309. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  18310. #else
  18311. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  18312. MBEDTLS_SSL_MINOR_VERSION_3);
  18313. #endif
  18314. // Set SNI callback to capture client's SNI hostname
  18315. mbedtls_ssl_conf_sni(&ctx->conf, impl::mbedtls_sni_callback, nullptr);
  18316. return static_cast<ctx_t>(ctx);
  18317. }
  18318. inline void free_context(ctx_t ctx) {
  18319. if (ctx) { delete static_cast<impl::MbedTlsContext *>(ctx); }
  18320. }
  18321. inline bool set_min_version(ctx_t ctx, Version version) {
  18322. if (!ctx) { return false; }
  18323. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18324. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18325. // Mbed TLS 3.x uses mbedtls_ssl_protocol_version enum
  18326. mbedtls_ssl_protocol_version min_ver = MBEDTLS_SSL_VERSION_TLS1_2;
  18327. if (version >= Version::TLS1_3) {
  18328. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  18329. min_ver = MBEDTLS_SSL_VERSION_TLS1_3;
  18330. #endif
  18331. }
  18332. mbedtls_ssl_conf_min_tls_version(&mctx->conf, min_ver);
  18333. #else
  18334. // Mbed TLS 2.x uses major/minor version numbers
  18335. int major = MBEDTLS_SSL_MAJOR_VERSION_3;
  18336. int minor = MBEDTLS_SSL_MINOR_VERSION_3; // TLS 1.2
  18337. if (version >= Version::TLS1_3) {
  18338. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  18339. minor = MBEDTLS_SSL_MINOR_VERSION_4; // TLS 1.3
  18340. #else
  18341. minor = MBEDTLS_SSL_MINOR_VERSION_3; // Fall back to TLS 1.2
  18342. #endif
  18343. }
  18344. mbedtls_ssl_conf_min_version(&mctx->conf, major, minor);
  18345. #endif
  18346. return true;
  18347. }
  18348. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  18349. if (!ctx || !pem) { return false; }
  18350. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18351. // mbedtls_x509_crt_parse expects null-terminated string for PEM
  18352. // Add null terminator if not present
  18353. std::string pem_str(pem, len);
  18354. int ret = mbedtls_x509_crt_parse(
  18355. &mctx->ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  18356. pem_str.size() + 1);
  18357. if (ret != 0) {
  18358. impl::mbedtls_last_error() = ret;
  18359. return false;
  18360. }
  18361. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18362. return true;
  18363. }
  18364. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  18365. if (!ctx || !file_path) { return false; }
  18366. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18367. int ret = mbedtls_x509_crt_parse_file(&mctx->ca_chain, file_path);
  18368. if (ret != 0) {
  18369. impl::mbedtls_last_error() = ret;
  18370. return false;
  18371. }
  18372. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18373. return true;
  18374. }
  18375. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  18376. if (!ctx || !dir_path) { return false; }
  18377. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18378. int ret = mbedtls_x509_crt_parse_path(&mctx->ca_chain, dir_path);
  18379. if (ret < 0) { // Returns number of certs on success, negative on error
  18380. impl::mbedtls_last_error() = ret;
  18381. return false;
  18382. }
  18383. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18384. return true;
  18385. }
  18386. inline bool load_system_certs(ctx_t ctx) {
  18387. if (!ctx) { return false; }
  18388. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18389. bool loaded = false;
  18390. #ifdef _WIN32
  18391. loaded = impl::enumerate_windows_system_certs(
  18392. [&](const unsigned char *data, size_t len) {
  18393. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  18394. });
  18395. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  18396. loaded = impl::enumerate_macos_keychain_certs(
  18397. [&](const unsigned char *data, size_t len) {
  18398. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  18399. });
  18400. #else
  18401. for (auto path = impl::system_ca_paths(); *path; ++path) {
  18402. if (mbedtls_x509_crt_parse_file(&mctx->ca_chain, *path) >= 0) {
  18403. loaded = true;
  18404. break;
  18405. }
  18406. }
  18407. if (!loaded) {
  18408. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  18409. if (mbedtls_x509_crt_parse_path(&mctx->ca_chain, *dir) >= 0) {
  18410. loaded = true;
  18411. break;
  18412. }
  18413. }
  18414. }
  18415. #endif
  18416. if (loaded) {
  18417. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18418. }
  18419. return loaded;
  18420. }
  18421. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  18422. const char *password) {
  18423. if (!ctx || !cert || !key) { return false; }
  18424. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18425. // Parse certificate
  18426. std::string cert_str(cert);
  18427. int ret = mbedtls_x509_crt_parse(
  18428. &mctx->own_cert,
  18429. reinterpret_cast<const unsigned char *>(cert_str.c_str()),
  18430. cert_str.size() + 1);
  18431. if (ret != 0) {
  18432. impl::mbedtls_last_error() = ret;
  18433. return false;
  18434. }
  18435. // Parse private key
  18436. std::string key_str(key);
  18437. const unsigned char *pwd =
  18438. password ? reinterpret_cast<const unsigned char *>(password) : nullptr;
  18439. size_t pwd_len = password ? strlen(password) : 0;
  18440. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18441. ret = mbedtls_pk_parse_key(
  18442. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  18443. key_str.size() + 1, pwd, pwd_len, mbedtls_ctr_drbg_random,
  18444. &mctx->ctr_drbg);
  18445. #else
  18446. ret = mbedtls_pk_parse_key(
  18447. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  18448. key_str.size() + 1, pwd, pwd_len);
  18449. #endif
  18450. if (ret != 0) {
  18451. impl::mbedtls_last_error() = ret;
  18452. return false;
  18453. }
  18454. // Verify that the certificate and private key match.
  18455. // Mbed TLS 4.x: mbedtls_pk_check_pair() reports a spurious mismatch for
  18456. // PSA-backed keys, so skip it and let the handshake surface a real mismatch.
  18457. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18458. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18459. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  18460. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18461. #else
  18462. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  18463. #endif
  18464. if (ret != 0) {
  18465. impl::mbedtls_last_error() = ret;
  18466. return false;
  18467. }
  18468. #endif
  18469. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  18470. if (ret != 0) {
  18471. impl::mbedtls_last_error() = ret;
  18472. return false;
  18473. }
  18474. return true;
  18475. }
  18476. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  18477. const char *key_path, const char *password) {
  18478. if (!ctx || !cert_path || !key_path) { return false; }
  18479. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18480. // Parse certificate file
  18481. int ret = mbedtls_x509_crt_parse_file(&mctx->own_cert, cert_path);
  18482. if (ret != 0) {
  18483. impl::mbedtls_last_error() = ret;
  18484. return false;
  18485. }
  18486. // Parse private key file
  18487. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18488. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password,
  18489. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18490. #else
  18491. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password);
  18492. #endif
  18493. if (ret != 0) {
  18494. impl::mbedtls_last_error() = ret;
  18495. return false;
  18496. }
  18497. // Verify that the certificate and private key match.
  18498. // Mbed TLS 4.x: see set_client_cert() — skip the spurious check_pair.
  18499. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18500. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18501. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  18502. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18503. #else
  18504. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  18505. #endif
  18506. if (ret != 0) {
  18507. impl::mbedtls_last_error() = ret;
  18508. return false;
  18509. }
  18510. #endif
  18511. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  18512. if (ret != 0) {
  18513. impl::mbedtls_last_error() = ret;
  18514. return false;
  18515. }
  18516. return true;
  18517. }
  18518. inline void set_verify_client(ctx_t ctx, bool require) {
  18519. if (!ctx) { return; }
  18520. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18521. mctx->verify_client = require;
  18522. impl::apply_verify_mode(*mctx);
  18523. }
  18524. inline session_t create_session(ctx_t ctx, socket_t sock) {
  18525. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  18526. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18527. auto session = new (std::nothrow) impl::MbedTlsSession();
  18528. if (!session) { return nullptr; }
  18529. session->sock = sock;
  18530. int ret = mbedtls_ssl_setup(&session->ssl, &mctx->conf);
  18531. if (ret != 0) {
  18532. impl::mbedtls_last_error() = ret;
  18533. delete session;
  18534. return nullptr;
  18535. }
  18536. // Explicitly opt out of in-handshake hostname verification by default;
  18537. // since Mbed TLS 3.6.4 a client handshake with certificate verification
  18538. // fails outright when no hostname was set. set_sni() installs the real
  18539. // hostname for DNS hosts; for IP hosts (where SNI must not be set) the
  18540. // caller verifies the certificate identity post-handshake via
  18541. // verify_hostname().
  18542. mbedtls_ssl_set_hostname(&session->ssl, nullptr);
  18543. // Set BIO callbacks
  18544. mbedtls_ssl_set_bio(&session->ssl, &session->sock, impl::mbedtls_net_send_cb,
  18545. impl::mbedtls_net_recv_cb, nullptr);
  18546. // Installed always, as it also masks the hostname mismatch that set_sni()
  18547. // may ask for. The session runs its own copy of the user's callback, which
  18548. // set_verify_callback() cannot replace under a handshake.
  18549. session->verify_callback = mctx->verify_callback;
  18550. session->is_server = mctx->is_server;
  18551. mbedtls_ssl_set_verify(&session->ssl, impl::mbedtls_verify_callback, session);
  18552. return static_cast<session_t>(session);
  18553. }
  18554. inline void free_session(session_t session) {
  18555. if (session) { delete static_cast<impl::MbedTlsSession *>(session); }
  18556. }
  18557. inline bool set_sni(session_t session, const char *hostname,
  18558. bool verify_hostname) {
  18559. if (!session || !hostname) { return false; }
  18560. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18561. // mbedtls_ssl_set_hostname() both sends the SNI extension and binds the
  18562. // handshake-time CN/SAN check to `hostname`; the two can't be requested
  18563. // independently, so a disabled hostname check is handled below by masking
  18564. // the resulting mismatch flag instead of skipping this call.
  18565. int ret = mbedtls_ssl_set_hostname(&msession->ssl, hostname);
  18566. if (ret != 0) {
  18567. impl::mbedtls_last_error() = ret;
  18568. return false;
  18569. }
  18570. msession->hostname = hostname;
  18571. if (!verify_hostname) { msession->suppress_hostname_mismatch = true; }
  18572. return true;
  18573. }
  18574. inline TlsError connect(session_t session) {
  18575. TlsError err;
  18576. if (!session) {
  18577. err.code = ErrorCode::Fatal;
  18578. return err;
  18579. }
  18580. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18581. int ret;
  18582. do {
  18583. ret = mbedtls_ssl_handshake(&msession->ssl);
  18584. } while (impl::mbedtls_is_session_ticket(ret));
  18585. if (ret == 0) {
  18586. err.code = ErrorCode::Success;
  18587. } else {
  18588. impl::fill_mbedtls_tls_error(err, msession->ssl, ret);
  18589. impl::mbedtls_last_error() = ret;
  18590. }
  18591. return err;
  18592. }
  18593. inline TlsError accept(session_t session) {
  18594. // A failed handshake leaves its SNI behind, so start without it
  18595. impl::mbedpending_sni().clear();
  18596. // Same as connect for Mbed TLS - handshake works for both client and server
  18597. auto result = connect(session);
  18598. // After successful handshake, capture SNI from thread-local storage
  18599. if (result.code == ErrorCode::Success && session) {
  18600. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18601. msession->sni_hostname = std::move(impl::mbedpending_sni());
  18602. }
  18603. return result;
  18604. }
  18605. inline bool connect_nonblocking(session_t session, socket_t sock,
  18606. time_t timeout_sec, time_t timeout_usec,
  18607. TlsError *err) {
  18608. if (!session) {
  18609. if (err) { err->code = ErrorCode::Fatal; }
  18610. return false;
  18611. }
  18612. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18613. // Set socket to non-blocking mode
  18614. detail::set_nonblocking(sock, true);
  18615. auto cleanup =
  18616. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18617. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  18618. int ret;
  18619. while ((ret = mbedtls_ssl_handshake(&msession->ssl)) != 0) {
  18620. // Non-fatal TLS 1.3 ticket; retry immediately.
  18621. if (impl::mbedtls_is_session_ticket(ret)) { continue; }
  18622. if (ret == MBEDTLS_ERR_SSL_WANT_READ) {
  18623. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  18624. } else if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) {
  18625. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  18626. }
  18627. // TlsError or timeout
  18628. if (err) { impl::fill_mbedtls_tls_error(*err, msession->ssl, ret); }
  18629. impl::mbedtls_last_error() = ret;
  18630. return false;
  18631. }
  18632. if (err) { err->code = ErrorCode::Success; }
  18633. return true;
  18634. }
  18635. inline bool accept_nonblocking(session_t session, socket_t sock,
  18636. time_t timeout_sec, time_t timeout_usec,
  18637. TlsError *err) {
  18638. // A failed handshake leaves its SNI behind, so start without it
  18639. impl::mbedpending_sni().clear();
  18640. // Same implementation as connect for Mbed TLS
  18641. bool result =
  18642. connect_nonblocking(session, sock, timeout_sec, timeout_usec, err);
  18643. // After successful handshake, capture SNI from thread-local storage
  18644. if (result && session) {
  18645. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18646. msession->sni_hostname = std::move(impl::mbedpending_sni());
  18647. }
  18648. return result;
  18649. }
  18650. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  18651. if (!session || !buf) {
  18652. err.code = ErrorCode::Fatal;
  18653. return -1;
  18654. }
  18655. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18656. // Serve a byte consumed by the is_peer_closed() probe before reading more.
  18657. if (msession->has_peeked_byte) {
  18658. if (len == 0) { return 0; }
  18659. auto p = static_cast<unsigned char *>(buf);
  18660. p[0] = msession->peeked_byte;
  18661. msession->has_peeked_byte = false;
  18662. size_t n = 1;
  18663. // Top up with any already-decrypted bytes without risking a block.
  18664. if (len > 1 && mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  18665. int extra = mbedtls_ssl_read(&msession->ssl, p + 1, len - 1);
  18666. if (extra > 0) { n += static_cast<size_t>(extra); }
  18667. }
  18668. err.code = ErrorCode::Success;
  18669. return static_cast<ssize_t>(n);
  18670. }
  18671. int ret;
  18672. do {
  18673. ret = mbedtls_ssl_read(&msession->ssl, static_cast<unsigned char *>(buf),
  18674. len);
  18675. } while (impl::mbedtls_is_session_ticket(ret));
  18676. if (ret > 0) {
  18677. err.code = ErrorCode::Success;
  18678. return static_cast<ssize_t>(ret);
  18679. }
  18680. // 0 means EOF without close_notify, which is an error as on OpenSSL
  18681. if (ret == 0) { ret = MBEDTLS_ERR_SSL_CONN_EOF; }
  18682. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  18683. err.backend_code = static_cast<uint64_t>(-ret);
  18684. impl::mbedtls_last_error() = ret;
  18685. // mbedTLS signals a clean close_notify via a negative error code rather
  18686. // than 0; surface it as a clean EOF the way OpenSSL/wolfSSL do.
  18687. if (err.code == ErrorCode::PeerClosed) { return 0; }
  18688. return -1;
  18689. }
  18690. inline ssize_t write(session_t session, const void *buf, size_t len,
  18691. TlsError &err) {
  18692. if (!session || !buf) {
  18693. err.code = ErrorCode::Fatal;
  18694. return -1;
  18695. }
  18696. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18697. int ret;
  18698. do {
  18699. ret = mbedtls_ssl_write(&msession->ssl,
  18700. static_cast<const unsigned char *>(buf), len);
  18701. } while (impl::mbedtls_is_session_ticket(ret));
  18702. if (ret > 0) {
  18703. err.code = ErrorCode::Success;
  18704. return static_cast<ssize_t>(ret);
  18705. }
  18706. if (ret == 0) {
  18707. err.code = ErrorCode::PeerClosed;
  18708. return 0;
  18709. }
  18710. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  18711. err.backend_code = static_cast<uint64_t>(-ret);
  18712. impl::mbedtls_last_error() = ret;
  18713. return -1;
  18714. }
  18715. inline int pending(const_session_t session) {
  18716. if (!session) { return 0; }
  18717. auto msession =
  18718. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18719. return static_cast<int>(mbedtls_ssl_get_bytes_avail(&msession->ssl)) +
  18720. (msession->has_peeked_byte ? 1 : 0);
  18721. }
  18722. inline void shutdown(session_t session, bool graceful) {
  18723. if (!session) { return; }
  18724. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18725. if (graceful) {
  18726. // Try to send close_notify, but don't block forever
  18727. int ret;
  18728. int attempts = 0;
  18729. while ((ret = mbedtls_ssl_close_notify(&msession->ssl)) != 0 &&
  18730. attempts < 3) {
  18731. if (ret != MBEDTLS_ERR_SSL_WANT_READ &&
  18732. ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
  18733. break;
  18734. }
  18735. attempts++;
  18736. }
  18737. }
  18738. }
  18739. inline bool is_peer_closed(session_t session, socket_t sock) {
  18740. if (!session || sock == INVALID_SOCKET) { return true; }
  18741. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18742. // Check if there's already decrypted or pushed-back data available.
  18743. // If so, the connection is definitely alive.
  18744. if (msession->has_peeked_byte ||
  18745. mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  18746. return false;
  18747. }
  18748. // Set socket to non-blocking to avoid blocking on read
  18749. detail::set_nonblocking(sock, true);
  18750. auto cleanup =
  18751. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18752. // Probe with a 1-byte read (Mbed TLS has no peek API). If the probe lands
  18753. // on application data — e.g. a response that already arrived — push the
  18754. // byte back so the next read() delivers it instead of losing it.
  18755. unsigned char buf;
  18756. int ret;
  18757. do {
  18758. ret = mbedtls_ssl_read(&msession->ssl, &buf, 1);
  18759. } while (impl::mbedtls_is_session_ticket(ret));
  18760. // If we got data or WANT_READ (would block), connection is alive
  18761. if (ret > 0) {
  18762. msession->peeked_byte = buf;
  18763. msession->has_peeked_byte = true;
  18764. return false;
  18765. }
  18766. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return false; }
  18767. // If we get a peer close notify or a connection reset, the peer is closed
  18768. return ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY ||
  18769. ret == MBEDTLS_ERR_NET_CONN_RESET || ret == 0;
  18770. }
  18771. inline cert_t get_peer_cert(const_session_t session) {
  18772. if (!session) { return nullptr; }
  18773. auto msession =
  18774. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18775. // Mbed TLS returns a pointer to the internal peer cert chain.
  18776. // WARNING: This pointer is only valid while the session is active.
  18777. // Do not use the certificate after calling free_session().
  18778. const mbedtls_x509_crt *cert = mbedtls_ssl_get_peer_cert(&msession->ssl);
  18779. return const_cast<mbedtls_x509_crt *>(cert);
  18780. }
  18781. inline size_t get_peer_certs(const_session_t session,
  18782. std::vector<cert_t> &certs) {
  18783. certs.clear();
  18784. // Mbed TLS parses the whole received chain into a list headed by the peer
  18785. // certificate, owned by the session like get_peer_cert()'s result
  18786. for (auto crt = static_cast<mbedtls_x509_crt *>(get_peer_cert(session));
  18787. crt && crt->raw.len > 0; crt = crt->next) {
  18788. certs.push_back(static_cast<cert_t>(crt));
  18789. }
  18790. return certs.size();
  18791. }
  18792. inline void free_cert(cert_t cert) {
  18793. // Mbed TLS: every cert_t handed out points into a session's or a context's
  18794. // chain, so there is nothing to free. Callers still call this for the other
  18795. // backends.
  18796. (void)cert;
  18797. }
  18798. inline bool verify_hostname(cert_t cert, const char *hostname) {
  18799. if (!cert || !hostname) { return false; }
  18800. auto mcert = static_cast<const mbedtls_x509_crt *>(cert);
  18801. std::string host_str(hostname);
  18802. // Check if hostname is an IP address (IPv4 or IPv6)
  18803. unsigned char ip_bytes[16];
  18804. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  18805. auto is_ip = ip_len > 0;
  18806. // Check Subject Alternative Names (SAN). Mbed TLS keeps the GeneralName type
  18807. // in buf.tag and the raw value in buf.p / buf.len.
  18808. for (auto san = &mcert->subject_alt_names; san; san = san->next) {
  18809. if (!san->buf.p || san->buf.len == 0) { continue; }
  18810. const unsigned char *p = san->buf.p;
  18811. size_t len = san->buf.len;
  18812. auto san_type = san->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK;
  18813. if (is_ip) {
  18814. // For an IP host, only a matching iPAddress SAN of the same family
  18815. // (4 bytes for IPv4, 16 bytes for IPv6) may authenticate it.
  18816. if (san_type == MBEDTLS_X509_SAN_IP_ADDRESS && len == ip_len &&
  18817. memcmp(p, ip_bytes, ip_len) == 0) {
  18818. return true;
  18819. }
  18820. } else if (san_type == MBEDTLS_X509_SAN_DNS_NAME) {
  18821. std::string san_name(reinterpret_cast<const char *>(p), len);
  18822. if (detail::match_hostname(san_name, host_str)) { return true; }
  18823. }
  18824. }
  18825. return false;
  18826. }
  18827. inline uint64_t hostname_mismatch_code() {
  18828. return static_cast<uint64_t>(MBEDTLS_X509_BADCERT_CN_MISMATCH);
  18829. }
  18830. inline long get_verify_result(const_session_t session) {
  18831. if (!session) { return -1; }
  18832. auto msession =
  18833. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18834. uint32_t flags = mbedtls_ssl_get_verify_result(&msession->ssl);
  18835. // Return 0 (X509_V_OK equivalent) if verification passed
  18836. return flags == 0 ? 0 : static_cast<long>(flags);
  18837. }
  18838. inline std::string get_cert_subject_cn(cert_t cert) {
  18839. if (!cert) return "";
  18840. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18841. // Find the CN in the subject
  18842. const mbedtls_x509_name *name = &x509->subject;
  18843. while (name != nullptr) {
  18844. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  18845. return std::string(reinterpret_cast<const char *>(name->val.p),
  18846. name->val.len);
  18847. }
  18848. name = name->next;
  18849. }
  18850. return "";
  18851. }
  18852. inline std::string get_cert_issuer_name(cert_t cert) {
  18853. if (!cert) return "";
  18854. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18855. // Build a human-readable issuer name string
  18856. char buf[512];
  18857. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &x509->issuer);
  18858. if (ret < 0) return "";
  18859. return std::string(buf);
  18860. }
  18861. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  18862. sans.clear();
  18863. if (!cert) return false;
  18864. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18865. // Parse the Subject Alternative Name extension
  18866. const mbedtls_x509_sequence *cur = &x509->subject_alt_names;
  18867. while (cur != nullptr) {
  18868. if (cur->buf.len > 0) {
  18869. const unsigned char *p = cur->buf.p;
  18870. size_t value_len = cur->buf.len;
  18871. SanEntry entry;
  18872. switch (cur->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK) {
  18873. case MBEDTLS_X509_SAN_DNS_NAME:
  18874. entry.type = SanType::DNS;
  18875. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18876. break;
  18877. case MBEDTLS_X509_SAN_IP_ADDRESS:
  18878. entry.type = SanType::IP;
  18879. if (value_len == 4) {
  18880. // IPv4
  18881. char buf[16];
  18882. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", p[0], p[1], p[2], p[3]);
  18883. entry.value = buf;
  18884. } else if (value_len == 16) {
  18885. // IPv6
  18886. char buf[64];
  18887. snprintf(buf, sizeof(buf),
  18888. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  18889. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  18890. p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8], p[9],
  18891. p[10], p[11], p[12], p[13], p[14], p[15]);
  18892. entry.value = buf;
  18893. }
  18894. break;
  18895. case MBEDTLS_X509_SAN_RFC822_NAME:
  18896. entry.type = SanType::EMAIL;
  18897. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18898. break;
  18899. case MBEDTLS_X509_SAN_UNIFORM_RESOURCE_IDENTIFIER:
  18900. entry.type = SanType::URI;
  18901. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18902. break;
  18903. default: entry.type = SanType::OTHER; break;
  18904. }
  18905. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  18906. }
  18907. cur = cur->next;
  18908. }
  18909. return true;
  18910. }
  18911. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  18912. time_t &not_after) {
  18913. if (!cert) return false;
  18914. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18915. // Convert mbedtls_x509_time to time_t
  18916. auto to_time_t = [](const mbedtls_x509_time &t) -> time_t {
  18917. struct tm tm_time = {};
  18918. tm_time.tm_year = t.year - 1900;
  18919. tm_time.tm_mon = t.mon - 1;
  18920. tm_time.tm_mday = t.day;
  18921. tm_time.tm_hour = t.hour;
  18922. tm_time.tm_min = t.min;
  18923. tm_time.tm_sec = t.sec;
  18924. #ifdef _WIN32
  18925. return _mkgmtime(&tm_time);
  18926. #else
  18927. return timegm(&tm_time);
  18928. #endif
  18929. };
  18930. not_before = to_time_t(x509->valid_from);
  18931. not_after = to_time_t(x509->valid_to);
  18932. return true;
  18933. }
  18934. inline std::string get_cert_serial(cert_t cert) {
  18935. if (!cert) return "";
  18936. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18937. // Convert serial number to hex string
  18938. std::string result;
  18939. result.reserve(x509->serial.len * 2);
  18940. for (size_t i = 0; i < x509->serial.len; i++) {
  18941. char hex[3];
  18942. snprintf(hex, sizeof(hex), "%02X", x509->serial.p[i]);
  18943. result += hex;
  18944. }
  18945. return result;
  18946. }
  18947. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  18948. if (!cert) return false;
  18949. auto crt = static_cast<mbedtls_x509_crt *>(cert);
  18950. if (!crt->raw.p || crt->raw.len == 0) return false;
  18951. der.assign(crt->raw.p, crt->raw.p + crt->raw.len);
  18952. return true;
  18953. }
  18954. inline const char *get_sni(const_session_t session) {
  18955. if (!session) return nullptr;
  18956. auto msession = static_cast<const impl::MbedTlsSession *>(session);
  18957. // For server: return SNI received from client during handshake
  18958. if (!msession->sni_hostname.empty()) {
  18959. return msession->sni_hostname.c_str();
  18960. }
  18961. // For client: return the hostname set via set_sni
  18962. if (!msession->hostname.empty()) { return msession->hostname.c_str(); }
  18963. return nullptr;
  18964. }
  18965. inline uint64_t peek_error() {
  18966. // Mbed TLS doesn't have an error queue, return the last error
  18967. return static_cast<uint64_t>(-impl::mbedtls_last_error());
  18968. }
  18969. inline uint64_t get_error() {
  18970. // Mbed TLS doesn't have an error queue, return and clear the last error
  18971. uint64_t err = static_cast<uint64_t>(-impl::mbedtls_last_error());
  18972. impl::mbedtls_last_error() = 0;
  18973. return err;
  18974. }
  18975. inline std::string error_string(uint64_t code) {
  18976. char buf[256];
  18977. mbedtls_strerror(-static_cast<int>(code), buf, sizeof(buf));
  18978. return std::string(buf);
  18979. }
  18980. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  18981. #ifdef CPPHTTPLIB_MBEDTLS_V4
  18982. // Parsing certificates needs PSA Crypto, and no context may exist yet
  18983. if (!detail::ensure_mbedtls_psa_crypto()) { return nullptr; }
  18984. #endif
  18985. if (!pem) { return nullptr; }
  18986. // mbedtls_x509_crt_parse expects null-terminated PEM
  18987. std::string pem_str(pem, len);
  18988. auto *ca_chain = new (std::nothrow) mbedtls_x509_crt;
  18989. if (!ca_chain) { return nullptr; }
  18990. mbedtls_x509_crt_init(ca_chain);
  18991. auto ret = mbedtls_x509_crt_parse(
  18992. ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  18993. pem_str.size() + 1);
  18994. if (ret != 0) {
  18995. mbedtls_x509_crt_free(ca_chain);
  18996. delete ca_chain;
  18997. return nullptr;
  18998. }
  18999. return static_cast<ca_store_t>(ca_chain);
  19000. }
  19001. inline void free_ca_store(ca_store_t store) {
  19002. if (store) {
  19003. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  19004. mbedtls_x509_crt_free(ca_chain);
  19005. delete ca_chain;
  19006. }
  19007. }
  19008. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  19009. if (!ctx || !store) { return false; }
  19010. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19011. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  19012. // Free existing CA chain
  19013. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  19014. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  19015. // Copy the CA chain (deep copy)
  19016. // Parse from the raw data of the source cert
  19017. mbedtls_x509_crt *src = ca_chain;
  19018. while (src != nullptr) {
  19019. int ret = mbedtls_x509_crt_parse_der(&mbed_ctx->ca_chain, src->raw.p,
  19020. src->raw.len);
  19021. if (ret != 0) {
  19022. free_ca_store(store);
  19023. return false;
  19024. }
  19025. src = src->next;
  19026. }
  19027. // This function takes ownership of the store; the chain was deep-copied
  19028. // above, so release the source
  19029. free_ca_store(store);
  19030. // Update the SSL config to use the new CA chain
  19031. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  19032. return true;
  19033. }
  19034. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  19035. certs.clear();
  19036. if (!ctx) { return 0; }
  19037. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19038. // Owned by the context; see free_cert()
  19039. for (auto cert = &mbed_ctx->ca_chain; cert && cert->raw.len > 0;
  19040. cert = cert->next) {
  19041. certs.push_back(static_cast<cert_t>(cert));
  19042. }
  19043. return certs.size();
  19044. }
  19045. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  19046. std::vector<std::string> names;
  19047. if (!ctx) { return names; }
  19048. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19049. // Iterate through the CA chain
  19050. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  19051. while (cert != nullptr && cert->raw.len > 0) {
  19052. char buf[512];
  19053. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &cert->subject);
  19054. if (ret > 0) { names.push_back(buf); }
  19055. cert = cert->next;
  19056. }
  19057. return names;
  19058. }
  19059. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  19060. const char *key_pem, const char *password) {
  19061. if (!ctx || !cert_pem || !key_pem) { return false; }
  19062. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19063. // Parse into new objects first, so that a bad pair leaves the old one in
  19064. // place, and swap them in after; the old ones are freed on the way out.
  19065. mbedtls_x509_crt cert;
  19066. mbedtls_pk_context key;
  19067. mbedtls_x509_crt_init(&cert);
  19068. mbedtls_pk_init(&key);
  19069. auto se = detail::scope_exit([&] {
  19070. mbedtls_x509_crt_free(&cert);
  19071. mbedtls_pk_free(&key);
  19072. });
  19073. // Parse certificate PEM
  19074. int ret = mbedtls_x509_crt_parse(
  19075. &cert, reinterpret_cast<const unsigned char *>(cert_pem),
  19076. strlen(cert_pem) + 1);
  19077. if (ret != 0) {
  19078. impl::mbedtls_last_error() = ret;
  19079. return false;
  19080. }
  19081. // Parse private key PEM
  19082. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  19083. ret = mbedtls_pk_parse_key(
  19084. &key, reinterpret_cast<const unsigned char *>(key_pem),
  19085. strlen(key_pem) + 1,
  19086. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  19087. password ? strlen(password) : 0, mbedtls_ctr_drbg_random,
  19088. &mbed_ctx->ctr_drbg);
  19089. #else
  19090. ret = mbedtls_pk_parse_key(
  19091. &key, reinterpret_cast<const unsigned char *>(key_pem),
  19092. strlen(key_pem) + 1,
  19093. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  19094. password ? strlen(password) : 0);
  19095. #endif
  19096. if (ret != 0) {
  19097. impl::mbedtls_last_error() = ret;
  19098. return false;
  19099. }
  19100. std::swap(mbed_ctx->own_cert, cert);
  19101. std::swap(mbed_ctx->own_key, key);
  19102. // Configure SSL to use the new certificate and key
  19103. ret = mbedtls_ssl_conf_own_cert(&mbed_ctx->conf, &mbed_ctx->own_cert,
  19104. &mbed_ctx->own_key);
  19105. if (ret != 0) {
  19106. impl::mbedtls_last_error() = ret;
  19107. return false;
  19108. }
  19109. return true;
  19110. }
  19111. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  19112. if (!ctx || !ca_pem) { return false; }
  19113. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19114. // Parse into a new chain first, so that a bad one leaves the old in place
  19115. mbedtls_x509_crt chain;
  19116. mbedtls_x509_crt_init(&chain);
  19117. auto se = detail::scope_exit([&] { mbedtls_x509_crt_free(&chain); });
  19118. // Parse CA PEM
  19119. int ret = mbedtls_x509_crt_parse(
  19120. &chain, reinterpret_cast<const unsigned char *>(ca_pem),
  19121. strlen(ca_pem) + 1);
  19122. if (ret != 0) {
  19123. impl::mbedtls_last_error() = ret;
  19124. return false;
  19125. }
  19126. std::swap(mbed_ctx->ca_chain, chain);
  19127. // Update SSL config to use new CA chain
  19128. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  19129. return true;
  19130. }
  19131. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  19132. if (!ctx) { return false; }
  19133. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19134. // create_session() hands each session its own copy to run.
  19135. mbed_ctx->verify_callback = std::move(callback);
  19136. impl::apply_verify_mode(*mbed_ctx);
  19137. return true;
  19138. }
  19139. inline long get_verify_error(const_session_t session) {
  19140. if (!session) { return -1; }
  19141. auto *msession =
  19142. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  19143. return static_cast<long>(mbedtls_ssl_get_verify_result(&msession->ssl));
  19144. }
  19145. inline std::string verify_error_string(long error_code) {
  19146. if (error_code == 0) { return ""; }
  19147. char buf[256];
  19148. mbedtls_x509_crt_verify_info(buf, sizeof(buf), "",
  19149. static_cast<uint32_t>(error_code));
  19150. // Remove trailing newline if present
  19151. std::string result(buf);
  19152. while (!result.empty() && (result.back() == '\n' || result.back() == ' ')) {
  19153. result.pop_back();
  19154. }
  19155. return result;
  19156. }
  19157. } // namespace tls
  19158. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  19159. /*
  19160. * Group 10: TLS abstraction layer - wolfSSL backend
  19161. */
  19162. /*
  19163. * wolfSSL Backend Implementation
  19164. */
  19165. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  19166. namespace tls {
  19167. namespace impl {
  19168. // wolfSSL session wrapper
  19169. struct WolfSSLSession {
  19170. WOLFSSL *ssl = nullptr;
  19171. socket_t sock = INVALID_SOCKET;
  19172. std::string hostname; // For client: set via set_sni
  19173. std::string sni_hostname; // For server: received from client via SNI callback
  19174. WolfSSLSession() = default;
  19175. ~WolfSSLSession() {
  19176. if (ssl) { wolfSSL_free(ssl); }
  19177. }
  19178. WolfSSLSession(const WolfSSLSession &) = delete;
  19179. WolfSSLSession &operator=(const WolfSSLSession &) = delete;
  19180. };
  19181. // Thread-local error code accessor for wolfSSL
  19182. inline uint64_t &wolfssl_last_error() {
  19183. static thread_local uint64_t err = 0;
  19184. return err;
  19185. }
  19186. // Helper to map wolfSSL error to ErrorCode.
  19187. // ssl_error is the value from wolfSSL_get_error().
  19188. // raw_ret is the raw return value from the wolfSSL call (for low-level error).
  19189. inline ErrorCode map_wolfssl_error(WOLFSSL *ssl, int ssl_error,
  19190. int &out_errno) {
  19191. switch (ssl_error) {
  19192. case SSL_ERROR_NONE: return ErrorCode::Success;
  19193. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  19194. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  19195. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  19196. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  19197. // EOF without close_notify
  19198. case SOCKET_PEER_CLOSED_E: out_errno = 0; return ErrorCode::SyscallError;
  19199. default:
  19200. if (ssl) {
  19201. // wolfSSL stores the low-level error code as a negative value.
  19202. // DOMAIN_NAME_MISMATCH (-322) indicates hostname verification failure.
  19203. int low_err = ssl_error; // wolfSSL_get_error returns the low-level code
  19204. if (low_err == DOMAIN_NAME_MISMATCH) {
  19205. return ErrorCode::HostnameMismatch;
  19206. }
  19207. // Check verify result to distinguish cert verification from generic SSL
  19208. // errors.
  19209. long vr = wolfSSL_get_verify_result(ssl);
  19210. if (vr != 0) { return ErrorCode::CertVerifyFailed; }
  19211. }
  19212. return ErrorCode::Fatal;
  19213. }
  19214. }
  19215. // WolfSSLContext constructor/destructor implementations
  19216. inline WolfSSLContext::WolfSSLContext() { wolfSSL_Init(); }
  19217. inline WolfSSLContext::~WolfSSLContext() {
  19218. if (ctx) { wolfSSL_CTX_free(ctx); }
  19219. }
  19220. // Thread-local storage for SNI captured during handshake
  19221. inline std::string &wolfssl_pending_sni() {
  19222. static thread_local std::string sni;
  19223. return sni;
  19224. }
  19225. // SNI callback for wolfSSL server to capture client's SNI hostname
  19226. inline int wolfssl_sni_callback(WOLFSSL *ssl, int *ret, void *exArg) {
  19227. (void)ret;
  19228. (void)exArg;
  19229. void *name_data = nullptr;
  19230. unsigned short name_len =
  19231. wolfSSL_SNI_GetRequest(ssl, WOLFSSL_SNI_HOST_NAME, &name_data);
  19232. if (name_data && name_len > 0) {
  19233. wolfssl_pending_sni().assign(static_cast<const char *>(name_data),
  19234. name_len);
  19235. } else {
  19236. wolfssl_pending_sni().clear();
  19237. }
  19238. return 0; // Continue regardless
  19239. }
  19240. // The WOLFSSL_CTX points back to its WolfSSLContext, so a handshake only ever
  19241. // runs the verify callback of its own context.
  19242. inline int context_ex_data_index() {
  19243. static const auto index =
  19244. wolfSSL_CTX_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  19245. return index;
  19246. }
  19247. // Each WOLFSSL points back to its WolfSSLSession, the session_t that every
  19248. // other tls:: function takes.
  19249. inline int session_ex_data_index() {
  19250. static const auto index =
  19251. wolfSSL_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  19252. return index;
  19253. }
  19254. // A resumed session skips the client's certificate, so a server that checks
  19255. // one would let in a certificate checked against another server's CA, as
  19256. // wolfSSL shares its session cache between contexts, or against a CA since
  19257. // replaced by update_server_client_ca().
  19258. inline void disable_server_resumption(WolfSSLContext *wctx) {
  19259. if (!wctx->is_server) { return; }
  19260. wolfSSL_CTX_set_session_cache_mode(wctx->ctx, WOLFSSL_SESS_CACHE_OFF);
  19261. #ifdef HAVE_SESSION_TICKET
  19262. wolfSSL_CTX_NoTicketTLSv12(wctx->ctx);
  19263. #endif
  19264. }
  19265. // wolfSSL verify callback wrapper
  19266. inline int wolfssl_verify_callback(int preverify_ok,
  19267. WOLFSSL_X509_STORE_CTX *x509_ctx) {
  19268. // Get the WOLFSSL object from the X509_STORE_CTX
  19269. WOLFSSL *ssl = static_cast<WOLFSSL *>(wolfSSL_X509_STORE_CTX_get_ex_data(
  19270. x509_ctx, wolfSSL_get_ex_data_X509_STORE_CTX_idx()));
  19271. if (!ssl) { return preverify_ok; }
  19272. auto wctx = static_cast<WolfSSLContext *>(wolfSSL_CTX_get_ex_data(
  19273. wolfSSL_get_SSL_CTX(ssl), context_ex_data_index()));
  19274. if (!wctx) { return preverify_ok; }
  19275. std::shared_ptr<VerifyCallback> callback;
  19276. {
  19277. std::lock_guard<std::mutex> guard(verify_callback_mutex());
  19278. callback = wctx->verify_callback;
  19279. }
  19280. if (!callback) { return preverify_ok; }
  19281. WOLFSSL_X509 *cert = wolfSSL_X509_STORE_CTX_get_current_cert(x509_ctx);
  19282. int depth = wolfSSL_X509_STORE_CTX_get_error_depth(x509_ctx);
  19283. int err = wolfSSL_X509_STORE_CTX_get_error(x509_ctx);
  19284. VerifyContext verify_ctx;
  19285. verify_ctx.session = wolfSSL_get_ex_data(ssl, session_ex_data_index());
  19286. verify_ctx.cert = static_cast<cert_t>(cert);
  19287. verify_ctx.depth = depth;
  19288. verify_ctx.preverify_ok = (preverify_ok != 0);
  19289. verify_ctx.error_code = static_cast<long>(err);
  19290. if (err != 0) {
  19291. verify_ctx.error_string = wolfSSL_X509_verify_cert_error_string(err);
  19292. } else {
  19293. verify_ctx.error_string = nullptr;
  19294. }
  19295. auto accepted = run_verify_callback(*callback, verify_ctx);
  19296. // A client verifying the server during the handshake, which is what
  19297. // set_verify_client(ctx, true) asks for there, keeps the built-in verdict
  19298. if (!wolfSSL_is_server(ssl) &&
  19299. (wolfSSL_get_verify_mode(ssl) & WOLFSSL_VERIFY_FAIL_IF_NO_PEER_CERT)) {
  19300. accepted = accepted && preverify_ok;
  19301. }
  19302. return accepted ? 1 : 0;
  19303. }
  19304. // Sets the verify mode from whether the peer's certificate is required and
  19305. // whether a verify callback is set.
  19306. inline void apply_verify_mode(WolfSSLContext &wctx) {
  19307. auto has_callback = static_cast<bool>(wctx.verify_callback);
  19308. if (wctx.verify_client || has_callback) { disable_server_resumption(&wctx); }
  19309. auto mode = wctx.verify_client
  19310. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  19311. : (has_callback ? SSL_VERIFY_PEER : SSL_VERIFY_NONE);
  19312. wolfSSL_CTX_set_verify(wctx.ctx, mode,
  19313. has_callback ? wolfssl_verify_callback : nullptr);
  19314. }
  19315. inline void set_wolfssl_password_cb(WOLFSSL_CTX *ctx, const char *password) {
  19316. wolfSSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char *>(password));
  19317. wolfSSL_CTX_set_default_passwd_cb(
  19318. ctx, [](char *buf, int size, int /*rwflag*/, void *userdata) -> int {
  19319. auto *pwd = static_cast<const char *>(userdata);
  19320. if (!pwd) return 0;
  19321. auto len = static_cast<int>(strlen(pwd));
  19322. if (len > size) len = size;
  19323. memcpy(buf, pwd, static_cast<size_t>(len));
  19324. return len;
  19325. });
  19326. }
  19327. } // namespace impl
  19328. inline ctx_t create_client_context() {
  19329. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  19330. if (!ctx) { return nullptr; }
  19331. ctx->is_server = false;
  19332. WOLFSSL_METHOD *method = wolfTLSv1_2_client_method();
  19333. if (!method) {
  19334. delete ctx;
  19335. return nullptr;
  19336. }
  19337. ctx->ctx = wolfSSL_CTX_new(method);
  19338. if (!ctx->ctx ||
  19339. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  19340. WOLFSSL_SUCCESS) {
  19341. delete ctx;
  19342. return nullptr;
  19343. }
  19344. // Default: verify peer certificate
  19345. ctx->verify_client = true;
  19346. impl::apply_verify_mode(*ctx);
  19347. return static_cast<ctx_t>(ctx);
  19348. }
  19349. inline ctx_t create_server_context() {
  19350. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  19351. if (!ctx) { return nullptr; }
  19352. ctx->is_server = true;
  19353. WOLFSSL_METHOD *method = wolfTLSv1_2_server_method();
  19354. if (!method) {
  19355. delete ctx;
  19356. return nullptr;
  19357. }
  19358. ctx->ctx = wolfSSL_CTX_new(method);
  19359. if (!ctx->ctx ||
  19360. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  19361. WOLFSSL_SUCCESS) {
  19362. delete ctx;
  19363. return nullptr;
  19364. }
  19365. // Default: don't verify client
  19366. impl::apply_verify_mode(*ctx);
  19367. // Enable SNI on server
  19368. wolfSSL_CTX_SNI_SetOptions(ctx->ctx, WOLFSSL_SNI_HOST_NAME,
  19369. WOLFSSL_SNI_CONTINUE_ON_MISMATCH);
  19370. wolfSSL_CTX_set_servername_callback(ctx->ctx, impl::wolfssl_sni_callback);
  19371. return static_cast<ctx_t>(ctx);
  19372. }
  19373. inline void free_context(ctx_t ctx) {
  19374. if (ctx) { delete static_cast<impl::WolfSSLContext *>(ctx); }
  19375. }
  19376. inline bool set_min_version(ctx_t ctx, Version version) {
  19377. if (!ctx) { return false; }
  19378. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19379. int min_ver = WOLFSSL_TLSV1_2;
  19380. if (version >= Version::TLS1_3) { min_ver = WOLFSSL_TLSV1_3; }
  19381. return wolfSSL_CTX_SetMinVersion(wctx->ctx, min_ver) == WOLFSSL_SUCCESS;
  19382. }
  19383. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  19384. if (!ctx || !pem) { return false; }
  19385. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19386. int ret = wolfSSL_CTX_load_verify_buffer(
  19387. wctx->ctx, reinterpret_cast<const unsigned char *>(pem),
  19388. static_cast<long>(len), SSL_FILETYPE_PEM);
  19389. if (ret != SSL_SUCCESS) {
  19390. impl::wolfssl_last_error() =
  19391. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19392. return false;
  19393. }
  19394. wctx->ca_pem_data_.append(pem, len);
  19395. return true;
  19396. }
  19397. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  19398. if (!ctx || !file_path) { return false; }
  19399. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19400. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, file_path, nullptr);
  19401. if (ret != SSL_SUCCESS) {
  19402. impl::wolfssl_last_error() =
  19403. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19404. return false;
  19405. }
  19406. return true;
  19407. }
  19408. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  19409. if (!ctx || !dir_path) { return false; }
  19410. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19411. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, dir_path);
  19412. // wolfSSL may fail if the directory doesn't contain properly hashed certs.
  19413. // Unlike OpenSSL which lazily loads certs from directories, wolfSSL scans
  19414. // immediately. Return true even on failure since the CA file may have
  19415. // already been loaded, matching OpenSSL's lenient behavior.
  19416. (void)ret;
  19417. return true;
  19418. }
  19419. inline bool load_system_certs(ctx_t ctx) {
  19420. if (!ctx) { return false; }
  19421. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19422. bool loaded = false;
  19423. #ifdef _WIN32
  19424. loaded = impl::enumerate_windows_system_certs(
  19425. [&](const unsigned char *data, size_t len) {
  19426. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  19427. static_cast<long>(len),
  19428. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  19429. });
  19430. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  19431. loaded = impl::enumerate_macos_keychain_certs(
  19432. [&](const unsigned char *data, size_t len) {
  19433. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  19434. static_cast<long>(len),
  19435. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  19436. });
  19437. #else
  19438. for (auto path = impl::system_ca_paths(); *path; ++path) {
  19439. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, *path, nullptr) ==
  19440. SSL_SUCCESS) {
  19441. loaded = true;
  19442. break;
  19443. }
  19444. }
  19445. if (!loaded) {
  19446. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  19447. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, *dir) ==
  19448. SSL_SUCCESS) {
  19449. loaded = true;
  19450. break;
  19451. }
  19452. }
  19453. }
  19454. #endif
  19455. return loaded;
  19456. }
  19457. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  19458. const char *password) {
  19459. if (!ctx || !cert || !key) { return false; }
  19460. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19461. // Load certificate
  19462. int ret = wolfSSL_CTX_use_certificate_buffer(
  19463. wctx->ctx, reinterpret_cast<const unsigned char *>(cert),
  19464. static_cast<long>(strlen(cert)), SSL_FILETYPE_PEM);
  19465. if (ret != SSL_SUCCESS) {
  19466. impl::wolfssl_last_error() =
  19467. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19468. return false;
  19469. }
  19470. // Set password callback if password is provided
  19471. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19472. // Load private key
  19473. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  19474. wctx->ctx, reinterpret_cast<const unsigned char *>(key),
  19475. static_cast<long>(strlen(key)), SSL_FILETYPE_PEM);
  19476. if (ret != SSL_SUCCESS) {
  19477. impl::wolfssl_last_error() =
  19478. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19479. return false;
  19480. }
  19481. // Verify that the certificate and private key match
  19482. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  19483. }
  19484. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  19485. const char *key_path, const char *password) {
  19486. if (!ctx || !cert_path || !key_path) { return false; }
  19487. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19488. // Load certificate file
  19489. int ret =
  19490. wolfSSL_CTX_use_certificate_file(wctx->ctx, cert_path, SSL_FILETYPE_PEM);
  19491. if (ret != SSL_SUCCESS) {
  19492. impl::wolfssl_last_error() =
  19493. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19494. return false;
  19495. }
  19496. // Set password callback if password is provided
  19497. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19498. // Load private key file
  19499. ret = wolfSSL_CTX_use_PrivateKey_file(wctx->ctx, key_path, SSL_FILETYPE_PEM);
  19500. if (ret != SSL_SUCCESS) {
  19501. impl::wolfssl_last_error() =
  19502. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19503. return false;
  19504. }
  19505. // Verify that the certificate and private key match
  19506. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  19507. }
  19508. inline void set_verify_client(ctx_t ctx, bool require) {
  19509. if (!ctx) { return; }
  19510. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19511. wctx->verify_client = require;
  19512. impl::apply_verify_mode(*wctx);
  19513. }
  19514. inline session_t create_session(ctx_t ctx, socket_t sock) {
  19515. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  19516. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19517. auto session = new (std::nothrow) impl::WolfSSLSession();
  19518. if (!session) { return nullptr; }
  19519. session->sock = sock;
  19520. session->ssl = wolfSSL_new(wctx->ctx);
  19521. if (!session->ssl) {
  19522. impl::wolfssl_last_error() =
  19523. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19524. delete session;
  19525. return nullptr;
  19526. }
  19527. if (wolfSSL_set_ex_data(session->ssl, impl::session_ex_data_index(),
  19528. session) != WOLFSSL_SUCCESS) {
  19529. delete session;
  19530. return nullptr;
  19531. }
  19532. wolfSSL_set_fd(session->ssl, static_cast<int>(sock));
  19533. return static_cast<session_t>(session);
  19534. }
  19535. inline void free_session(session_t session) {
  19536. if (session) { delete static_cast<impl::WolfSSLSession *>(session); }
  19537. }
  19538. inline bool set_sni(session_t session, const char *hostname,
  19539. bool verify_hostname) {
  19540. if (!session || !hostname) { return false; }
  19541. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19542. int ret = wolfSSL_UseSNI(wsession->ssl, WOLFSSL_SNI_HOST_NAME, hostname,
  19543. static_cast<word16>(strlen(hostname)));
  19544. if (ret != WOLFSSL_SUCCESS) {
  19545. impl::wolfssl_last_error() =
  19546. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19547. return false;
  19548. }
  19549. // wolfSSL_check_domain_name binds identity checking to the handshake,
  19550. // separately from the SNI extension sent above; skip it when hostname
  19551. // verification is disabled so only the chain is checked, matching OpenSSL.
  19552. if (verify_hostname) { wolfSSL_check_domain_name(wsession->ssl, hostname); }
  19553. wsession->hostname = hostname;
  19554. return true;
  19555. }
  19556. inline TlsError connect(session_t session) {
  19557. TlsError err;
  19558. if (!session) {
  19559. err.code = ErrorCode::Fatal;
  19560. return err;
  19561. }
  19562. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19563. int ret = wolfSSL_connect(wsession->ssl);
  19564. if (ret == SSL_SUCCESS) {
  19565. err.code = ErrorCode::Success;
  19566. } else {
  19567. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19568. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19569. err.backend_code = static_cast<uint64_t>(ssl_error);
  19570. impl::wolfssl_last_error() = err.backend_code;
  19571. }
  19572. return err;
  19573. }
  19574. inline TlsError accept(session_t session) {
  19575. TlsError err;
  19576. if (!session) {
  19577. err.code = ErrorCode::Fatal;
  19578. return err;
  19579. }
  19580. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19581. int ret = wolfSSL_accept(wsession->ssl);
  19582. if (ret == SSL_SUCCESS) {
  19583. err.code = ErrorCode::Success;
  19584. // Capture SNI from thread-local storage after successful handshake
  19585. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  19586. impl::wolfssl_pending_sni().clear();
  19587. } else {
  19588. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19589. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19590. err.backend_code = static_cast<uint64_t>(ssl_error);
  19591. impl::wolfssl_last_error() = err.backend_code;
  19592. }
  19593. return err;
  19594. }
  19595. inline bool connect_nonblocking(session_t session, socket_t sock,
  19596. time_t timeout_sec, time_t timeout_usec,
  19597. TlsError *err) {
  19598. if (!session) {
  19599. if (err) { err->code = ErrorCode::Fatal; }
  19600. return false;
  19601. }
  19602. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19603. // Set socket to non-blocking mode
  19604. detail::set_nonblocking(sock, true);
  19605. auto cleanup =
  19606. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19607. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  19608. int ret;
  19609. while ((ret = wolfSSL_connect(wsession->ssl)) != SSL_SUCCESS) {
  19610. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19611. if (ssl_error == SSL_ERROR_WANT_READ) {
  19612. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  19613. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  19614. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  19615. }
  19616. // Error or timeout
  19617. if (err) {
  19618. err->code =
  19619. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  19620. err->backend_code = static_cast<uint64_t>(ssl_error);
  19621. }
  19622. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  19623. return false;
  19624. }
  19625. if (err) { err->code = ErrorCode::Success; }
  19626. return true;
  19627. }
  19628. inline bool accept_nonblocking(session_t session, socket_t sock,
  19629. time_t timeout_sec, time_t timeout_usec,
  19630. TlsError *err) {
  19631. if (!session) {
  19632. if (err) { err->code = ErrorCode::Fatal; }
  19633. return false;
  19634. }
  19635. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19636. // Set socket to non-blocking mode
  19637. detail::set_nonblocking(sock, true);
  19638. auto cleanup =
  19639. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19640. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  19641. int ret;
  19642. while ((ret = wolfSSL_accept(wsession->ssl)) != SSL_SUCCESS) {
  19643. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19644. if (ssl_error == SSL_ERROR_WANT_READ) {
  19645. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  19646. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  19647. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  19648. }
  19649. // Error or timeout
  19650. if (err) {
  19651. err->code =
  19652. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  19653. err->backend_code = static_cast<uint64_t>(ssl_error);
  19654. }
  19655. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  19656. return false;
  19657. }
  19658. if (err) { err->code = ErrorCode::Success; }
  19659. // Capture SNI from thread-local storage after successful handshake
  19660. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  19661. impl::wolfssl_pending_sni().clear();
  19662. return true;
  19663. }
  19664. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  19665. if (!session || !buf) {
  19666. err.code = ErrorCode::Fatal;
  19667. return -1;
  19668. }
  19669. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19670. int ret = wolfSSL_read(wsession->ssl, buf, static_cast<int>(len));
  19671. if (ret > 0) {
  19672. err.code = ErrorCode::Success;
  19673. return static_cast<ssize_t>(ret);
  19674. }
  19675. // 0 is also returned for EOF without close_notify; get_error tells them apart
  19676. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19677. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19678. if (err.code == ErrorCode::PeerClosed) { return 0; }
  19679. err.backend_code = static_cast<uint64_t>(ssl_error);
  19680. impl::wolfssl_last_error() = err.backend_code;
  19681. return -1;
  19682. }
  19683. inline ssize_t write(session_t session, const void *buf, size_t len,
  19684. TlsError &err) {
  19685. if (!session || !buf) {
  19686. err.code = ErrorCode::Fatal;
  19687. return -1;
  19688. }
  19689. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19690. int ret = wolfSSL_write(wsession->ssl, buf, static_cast<int>(len));
  19691. if (ret > 0) {
  19692. err.code = ErrorCode::Success;
  19693. return static_cast<ssize_t>(ret);
  19694. }
  19695. // wolfSSL_write returns 0 when the peer has sent a close_notify.
  19696. // Treat this as an error (return -1) so callers don't spin in a
  19697. // write loop adding zero to the offset.
  19698. if (ret == 0) {
  19699. err.code = ErrorCode::PeerClosed;
  19700. return -1;
  19701. }
  19702. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19703. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19704. err.backend_code = static_cast<uint64_t>(ssl_error);
  19705. impl::wolfssl_last_error() = err.backend_code;
  19706. return -1;
  19707. }
  19708. inline int pending(const_session_t session) {
  19709. if (!session) { return 0; }
  19710. auto wsession =
  19711. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19712. return wolfSSL_pending(wsession->ssl);
  19713. }
  19714. inline void shutdown(session_t session, bool graceful) {
  19715. if (!session) { return; }
  19716. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19717. if (graceful) {
  19718. int ret;
  19719. int attempts = 0;
  19720. while ((ret = wolfSSL_shutdown(wsession->ssl)) != SSL_SUCCESS &&
  19721. attempts < 3) {
  19722. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19723. if (ssl_error != SSL_ERROR_WANT_READ &&
  19724. ssl_error != SSL_ERROR_WANT_WRITE) {
  19725. break;
  19726. }
  19727. attempts++;
  19728. }
  19729. } else {
  19730. wolfSSL_shutdown(wsession->ssl);
  19731. }
  19732. }
  19733. inline bool is_peer_closed(session_t session, socket_t sock) {
  19734. if (!session || sock == INVALID_SOCKET) { return true; }
  19735. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19736. // Check if there's already decrypted data available
  19737. if (wolfSSL_pending(wsession->ssl) > 0) { return false; }
  19738. // Set socket to non-blocking to avoid blocking on read
  19739. detail::set_nonblocking(sock, true);
  19740. auto cleanup =
  19741. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19742. // Peek 1 byte to check connection status without consuming data
  19743. unsigned char buf;
  19744. int ret = wolfSSL_peek(wsession->ssl, &buf, 1);
  19745. // If we got data or WANT_READ (would block), connection is alive
  19746. if (ret > 0) { return false; }
  19747. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19748. if (ssl_error == SSL_ERROR_WANT_READ) { return false; }
  19749. return ssl_error == SSL_ERROR_ZERO_RETURN || ssl_error == SSL_ERROR_SYSCALL ||
  19750. ret == 0;
  19751. }
  19752. inline cert_t get_peer_cert(const_session_t session) {
  19753. if (!session) { return nullptr; }
  19754. auto wsession =
  19755. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19756. WOLFSSL_X509 *cert = wolfSSL_get_peer_certificate(wsession->ssl);
  19757. return static_cast<cert_t>(cert);
  19758. }
  19759. inline size_t get_peer_certs(const_session_t session,
  19760. std::vector<cert_t> &certs) {
  19761. certs.clear();
  19762. if (!session) { return 0; }
  19763. // wolfSSL keeps the received chain only when built with SESSION_CERTS
  19764. #ifdef SESSION_CERTS
  19765. auto wsession =
  19766. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19767. auto chain = wolfSSL_get_peer_chain(wsession->ssl);
  19768. auto count = chain ? wolfSSL_get_chain_count(chain) : 0;
  19769. for (int i = 0; i < count; i++) {
  19770. auto x509 = wolfSSL_get_chain_X509(chain, i);
  19771. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19772. }
  19773. #endif
  19774. return certs.size();
  19775. }
  19776. inline void free_cert(cert_t cert) {
  19777. if (cert) { wolfSSL_X509_free(static_cast<WOLFSSL_X509 *>(cert)); }
  19778. }
  19779. inline bool verify_hostname(cert_t cert, const char *hostname) {
  19780. if (!cert || !hostname) { return false; }
  19781. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19782. std::string host_str(hostname);
  19783. // Check if hostname is an IP address (IPv4 or IPv6)
  19784. unsigned char ip_bytes[16];
  19785. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  19786. auto is_ip = ip_len > 0;
  19787. // Check Subject Alternative Names
  19788. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  19789. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  19790. if (san_names) {
  19791. int san_count = wolfSSL_sk_num(san_names);
  19792. for (int i = 0; i < san_count; i++) {
  19793. auto *names =
  19794. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  19795. if (!names) continue;
  19796. if (!is_ip && names->type == WOLFSSL_GEN_DNS) {
  19797. // DNS name
  19798. unsigned char *dns_name = nullptr;
  19799. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, names->d.dNSName);
  19800. if (dns_name && dns_len > 0) {
  19801. std::string san_name(reinterpret_cast<char *>(dns_name),
  19802. static_cast<size_t>(dns_len));
  19803. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  19804. if (detail::match_hostname(san_name, host_str)) {
  19805. wolfSSL_sk_free(san_names);
  19806. return true;
  19807. }
  19808. }
  19809. } else if (is_ip && names->type == WOLFSSL_GEN_IPADD) {
  19810. // IP address: only an iPAddress SAN of the same family (4 bytes for
  19811. // IPv4, 16 bytes for IPv6) may authenticate the host.
  19812. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(names->d.iPAddress);
  19813. auto san_ip_len = wolfSSL_ASN1_STRING_length(names->d.iPAddress);
  19814. if (ip_data && san_ip_len == static_cast<int>(ip_len) &&
  19815. memcmp(ip_data, ip_bytes, ip_len) == 0) {
  19816. wolfSSL_sk_free(san_names);
  19817. return true;
  19818. }
  19819. }
  19820. }
  19821. wolfSSL_sk_free(san_names);
  19822. }
  19823. return false;
  19824. }
  19825. inline uint64_t hostname_mismatch_code() {
  19826. return static_cast<uint64_t>(DOMAIN_NAME_MISMATCH);
  19827. }
  19828. inline long get_verify_result(const_session_t session) {
  19829. if (!session) { return -1; }
  19830. auto wsession =
  19831. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19832. long result = wolfSSL_get_verify_result(wsession->ssl);
  19833. return result;
  19834. }
  19835. inline std::string get_cert_subject_cn(cert_t cert) {
  19836. if (!cert) return "";
  19837. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19838. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19839. if (!subject) return "";
  19840. char cn[256] = {};
  19841. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  19842. sizeof(cn));
  19843. if (cn_len <= 0) return "";
  19844. return std::string(cn, static_cast<size_t>(cn_len));
  19845. }
  19846. inline std::string get_cert_issuer_name(cert_t cert) {
  19847. if (!cert) return "";
  19848. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19849. WOLFSSL_X509_NAME *issuer = wolfSSL_X509_get_issuer_name(x509);
  19850. if (!issuer) return "";
  19851. char *name_str = wolfSSL_X509_NAME_oneline(issuer, nullptr, 0);
  19852. if (!name_str) return "";
  19853. std::string result(name_str);
  19854. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19855. return result;
  19856. }
  19857. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  19858. sans.clear();
  19859. if (!cert) return false;
  19860. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19861. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  19862. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  19863. if (!san_names) return true; // No SANs is not an error
  19864. int count = wolfSSL_sk_num(san_names);
  19865. for (int i = 0; i < count; i++) {
  19866. auto *name =
  19867. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  19868. if (!name) continue;
  19869. SanEntry entry;
  19870. switch (name->type) {
  19871. case WOLFSSL_GEN_DNS: {
  19872. entry.type = SanType::DNS;
  19873. unsigned char *dns_name = nullptr;
  19874. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, name->d.dNSName);
  19875. if (dns_name && dns_len > 0) {
  19876. entry.value = std::string(reinterpret_cast<char *>(dns_name),
  19877. static_cast<size_t>(dns_len));
  19878. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  19879. }
  19880. break;
  19881. }
  19882. case WOLFSSL_GEN_IPADD: {
  19883. entry.type = SanType::IP;
  19884. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(name->d.iPAddress);
  19885. int ip_len = wolfSSL_ASN1_STRING_length(name->d.iPAddress);
  19886. if (ip_data && ip_len == 4) {
  19887. char buf[16];
  19888. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", ip_data[0], ip_data[1],
  19889. ip_data[2], ip_data[3]);
  19890. entry.value = buf;
  19891. } else if (ip_data && ip_len == 16) {
  19892. char buf[64];
  19893. snprintf(buf, sizeof(buf),
  19894. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  19895. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  19896. ip_data[0], ip_data[1], ip_data[2], ip_data[3], ip_data[4],
  19897. ip_data[5], ip_data[6], ip_data[7], ip_data[8], ip_data[9],
  19898. ip_data[10], ip_data[11], ip_data[12], ip_data[13],
  19899. ip_data[14], ip_data[15]);
  19900. entry.value = buf;
  19901. }
  19902. break;
  19903. }
  19904. case WOLFSSL_GEN_EMAIL:
  19905. entry.type = SanType::EMAIL;
  19906. {
  19907. unsigned char *email = nullptr;
  19908. int email_len = wolfSSL_ASN1_STRING_to_UTF8(&email, name->d.rfc822Name);
  19909. if (email && email_len > 0) {
  19910. entry.value = std::string(reinterpret_cast<char *>(email),
  19911. static_cast<size_t>(email_len));
  19912. XFREE(email, nullptr, DYNAMIC_TYPE_OPENSSL);
  19913. }
  19914. }
  19915. break;
  19916. case WOLFSSL_GEN_URI:
  19917. entry.type = SanType::URI;
  19918. {
  19919. unsigned char *uri = nullptr;
  19920. int uri_len = wolfSSL_ASN1_STRING_to_UTF8(
  19921. &uri, name->d.uniformResourceIdentifier);
  19922. if (uri && uri_len > 0) {
  19923. entry.value = std::string(reinterpret_cast<char *>(uri),
  19924. static_cast<size_t>(uri_len));
  19925. XFREE(uri, nullptr, DYNAMIC_TYPE_OPENSSL);
  19926. }
  19927. }
  19928. break;
  19929. default: entry.type = SanType::OTHER; break;
  19930. }
  19931. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  19932. }
  19933. wolfSSL_sk_free(san_names);
  19934. return true;
  19935. }
  19936. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  19937. time_t &not_after) {
  19938. if (!cert) return false;
  19939. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19940. const WOLFSSL_ASN1_TIME *nb = wolfSSL_X509_get_notBefore(x509);
  19941. const WOLFSSL_ASN1_TIME *na = wolfSSL_X509_get_notAfter(x509);
  19942. if (!nb || !na) return false;
  19943. // wolfSSL_ASN1_TIME_to_tm is available
  19944. struct tm tm_nb = {}, tm_na = {};
  19945. if (wolfSSL_ASN1_TIME_to_tm(nb, &tm_nb) != WOLFSSL_SUCCESS) return false;
  19946. if (wolfSSL_ASN1_TIME_to_tm(na, &tm_na) != WOLFSSL_SUCCESS) return false;
  19947. #ifdef _WIN32
  19948. not_before = _mkgmtime(&tm_nb);
  19949. not_after = _mkgmtime(&tm_na);
  19950. #else
  19951. not_before = timegm(&tm_nb);
  19952. not_after = timegm(&tm_na);
  19953. #endif
  19954. return true;
  19955. }
  19956. inline std::string get_cert_serial(cert_t cert) {
  19957. if (!cert) return "";
  19958. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19959. WOLFSSL_ASN1_INTEGER *serial_asn1 = wolfSSL_X509_get_serialNumber(x509);
  19960. if (!serial_asn1) return "";
  19961. // Get the serial number data
  19962. int len = serial_asn1->length;
  19963. unsigned char *data = serial_asn1->data;
  19964. if (!data || len <= 0) return "";
  19965. std::string result;
  19966. result.reserve(static_cast<size_t>(len) * 2);
  19967. for (int i = 0; i < len; i++) {
  19968. char hex[3];
  19969. snprintf(hex, sizeof(hex), "%02X", data[i]);
  19970. result += hex;
  19971. }
  19972. return result;
  19973. }
  19974. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  19975. if (!cert) return false;
  19976. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19977. int der_len = 0;
  19978. const unsigned char *der_data = wolfSSL_X509_get_der(x509, &der_len);
  19979. if (!der_data || der_len <= 0) return false;
  19980. der.assign(der_data, der_data + der_len);
  19981. return true;
  19982. }
  19983. inline const char *get_sni(const_session_t session) {
  19984. if (!session) return nullptr;
  19985. auto wsession = static_cast<const impl::WolfSSLSession *>(session);
  19986. // For server: return SNI received from client during handshake
  19987. if (!wsession->sni_hostname.empty()) {
  19988. return wsession->sni_hostname.c_str();
  19989. }
  19990. // For client: return the hostname set via set_sni
  19991. if (!wsession->hostname.empty()) { return wsession->hostname.c_str(); }
  19992. return nullptr;
  19993. }
  19994. inline uint64_t peek_error() {
  19995. return static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19996. }
  19997. inline uint64_t get_error() {
  19998. uint64_t err = impl::wolfssl_last_error();
  19999. impl::wolfssl_last_error() = 0;
  20000. return err;
  20001. }
  20002. inline std::string error_string(uint64_t code) {
  20003. char buf[256];
  20004. wolfSSL_ERR_error_string(static_cast<unsigned long>(code), buf);
  20005. return std::string(buf);
  20006. }
  20007. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  20008. if (!pem || len == 0) { return nullptr; }
  20009. // Validate by attempting to load into a temporary ctx
  20010. WOLFSSL_CTX *tmp_ctx = wolfSSL_CTX_new(wolfTLSv1_2_client_method());
  20011. if (!tmp_ctx) { return nullptr; }
  20012. int ret = wolfSSL_CTX_load_verify_buffer(
  20013. tmp_ctx, reinterpret_cast<const unsigned char *>(pem),
  20014. static_cast<long>(len), SSL_FILETYPE_PEM);
  20015. wolfSSL_CTX_free(tmp_ctx);
  20016. if (ret != SSL_SUCCESS) { return nullptr; }
  20017. return static_cast<ca_store_t>(
  20018. new impl::WolfSSLCAStore{std::string(pem, len)});
  20019. }
  20020. inline void free_ca_store(ca_store_t store) {
  20021. delete static_cast<impl::WolfSSLCAStore *>(store);
  20022. }
  20023. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  20024. if (!ctx || !store) { return false; }
  20025. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20026. auto *ca = static_cast<impl::WolfSSLCAStore *>(store);
  20027. int ret = wolfSSL_CTX_load_verify_buffer(
  20028. wctx->ctx, reinterpret_cast<const unsigned char *>(ca->pem_data.data()),
  20029. static_cast<long>(ca->pem_data.size()), SSL_FILETYPE_PEM);
  20030. if (ret == SSL_SUCCESS) { wctx->ca_pem_data_ += ca->pem_data; }
  20031. // This function takes ownership of the store; the PEM data was copied into
  20032. // the context, so release the source
  20033. free_ca_store(store);
  20034. return ret == SSL_SUCCESS;
  20035. }
  20036. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  20037. certs.clear();
  20038. if (!ctx) { return 0; }
  20039. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20040. if (wctx->ca_pem_data_.empty()) { return 0; }
  20041. const std::string &pem = wctx->ca_pem_data_;
  20042. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  20043. const std::string end_marker = "-----END CERTIFICATE-----";
  20044. size_t pos = 0;
  20045. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  20046. size_t end_pos = pem.find(end_marker, pos);
  20047. if (end_pos == std::string::npos) { break; }
  20048. end_pos += end_marker.size();
  20049. std::string cert_pem = pem.substr(pos, end_pos - pos);
  20050. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  20051. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  20052. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  20053. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  20054. pos = end_pos;
  20055. }
  20056. return certs.size();
  20057. }
  20058. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  20059. std::vector<std::string> names;
  20060. if (!ctx) { return names; }
  20061. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20062. if (wctx->ca_pem_data_.empty()) { return names; }
  20063. const std::string &pem = wctx->ca_pem_data_;
  20064. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  20065. const std::string end_marker = "-----END CERTIFICATE-----";
  20066. size_t pos = 0;
  20067. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  20068. size_t end_pos = pem.find(end_marker, pos);
  20069. if (end_pos == std::string::npos) { break; }
  20070. end_pos += end_marker.size();
  20071. std::string cert_pem = pem.substr(pos, end_pos - pos);
  20072. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  20073. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  20074. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  20075. if (x509) {
  20076. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  20077. if (subject) {
  20078. char *name_str = wolfSSL_X509_NAME_oneline(subject, nullptr, 0);
  20079. if (name_str) {
  20080. names.push_back(name_str);
  20081. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  20082. }
  20083. }
  20084. wolfSSL_X509_free(x509);
  20085. }
  20086. pos = end_pos;
  20087. }
  20088. return names;
  20089. }
  20090. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  20091. const char *key_pem, const char *password) {
  20092. if (!ctx || !cert_pem || !key_pem) { return false; }
  20093. // Try the pair on a scratch context first, so that a bad one leaves the
  20094. // server's certificate and key as they were
  20095. auto tmp = create_server_context();
  20096. if (!tmp) { return false; }
  20097. auto se = detail::scope_exit([&] { free_context(tmp); });
  20098. if (!set_client_cert_pem(tmp, cert_pem, key_pem, password)) { return false; }
  20099. return set_client_cert_pem(ctx, cert_pem, key_pem, password);
  20100. }
  20101. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  20102. if (!ctx || !ca_pem) { return false; }
  20103. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20104. // Replace the CAs rather than add to them, as the other backends do, once
  20105. // the new ones are known to load
  20106. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  20107. if (!store) { return false; }
  20108. free_ca_store(store);
  20109. wolfSSL_CTX_UnloadCAs(wctx->ctx);
  20110. wctx->ca_pem_data_.clear();
  20111. return load_ca_pem(ctx, ca_pem, strlen(ca_pem));
  20112. }
  20113. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  20114. if (!ctx) { return false; }
  20115. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20116. auto stored = callback ? std::make_shared<VerifyCallback>(std::move(callback))
  20117. : nullptr;
  20118. {
  20119. std::lock_guard<std::mutex> guard(impl::verify_callback_mutex());
  20120. // A handshake running the previous callback keeps it until it returns.
  20121. wctx->verify_callback.swap(stored);
  20122. }
  20123. impl::apply_verify_mode(*wctx);
  20124. return true;
  20125. }
  20126. inline long get_verify_error(const_session_t session) {
  20127. if (!session) { return -1; }
  20128. auto *wsession =
  20129. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  20130. return wolfSSL_get_verify_result(wsession->ssl);
  20131. }
  20132. inline std::string verify_error_string(long error_code) {
  20133. if (error_code == 0) { return ""; }
  20134. const char *str =
  20135. wolfSSL_X509_verify_cert_error_string(static_cast<int>(error_code));
  20136. return str ? std::string(str) : std::string();
  20137. }
  20138. } // namespace tls
  20139. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  20140. // WebSocket implementation
  20141. namespace ws {
  20142. inline bool WebSocket::send_frame(Opcode op, const char *data, size_t len,
  20143. bool fin) {
  20144. std::lock_guard<std::mutex> lock(write_mutex_);
  20145. if (closed_) { return false; }
  20146. return detail::write_websocket_frame(strm_, op, data, len, fin, !is_server_);
  20147. }
  20148. inline ReadResult WebSocket::read(std::string &msg) {
  20149. // Answers a control frame; any other opcode here is a protocol error.
  20150. // Returns false when the connection is done.
  20151. auto handle_control = [&](Opcode op, const std::string &payload) -> bool {
  20152. switch (op) {
  20153. case Opcode::Ping: {
  20154. std::lock_guard<std::mutex> lock(write_mutex_);
  20155. detail::write_websocket_frame(strm_, Opcode::Pong, payload.data(),
  20156. payload.size(), true, !is_server_);
  20157. return true;
  20158. }
  20159. case Opcode::Pong: {
  20160. std::lock_guard<std::mutex> lock(ping_mutex_);
  20161. unacked_pings_ = 0;
  20162. return true;
  20163. }
  20164. case Opcode::Close: {
  20165. // RFC 6455 §5.5.1: a Close is echoed back, unless its payload is
  20166. // malformed, which is answered with a protocol error instead.
  20167. if (closed_.exchange(true)) { return false; }
  20168. auto reply = payload;
  20169. if (!impl::is_valid_close_payload(payload)) {
  20170. auto code = static_cast<uint16_t>(CloseStatus::ProtocolError);
  20171. reply = {static_cast<char>(code >> 8), static_cast<char>(code & 0xff)};
  20172. }
  20173. std::lock_guard<std::mutex> lock(write_mutex_);
  20174. detail::write_websocket_frame(strm_, Opcode::Close, reply.data(),
  20175. reply.size(), true, !is_server_);
  20176. return false;
  20177. }
  20178. default: closed_ = true; return false;
  20179. }
  20180. };
  20181. std::unique_lock<std::mutex> read_lock(read_mutex_);
  20182. while (!closed_) {
  20183. Opcode opcode;
  20184. std::string payload;
  20185. bool fin;
  20186. impl::FrameRead r =
  20187. impl::read_websocket_frame(strm_, opcode, payload, fin, is_server_,
  20188. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH);
  20189. // A timeout landed on a frame boundary of an open connection: it is
  20190. // untouched and still usable, so hand control back without closing it.
  20191. // That is only useful to a caller who asked for the timeout; the
  20192. // compile-time default is a backstop against a peer gone quiet, and
  20193. // elapsing it closes the connection so a plain `while (ws.read(msg))` loop
  20194. // ends. A wait that a pong timeout cut short finds the connection closed.
  20195. if (r == impl::FrameRead::Timeout && read_timeout_set_ && !closed_) {
  20196. return Timeout;
  20197. }
  20198. if (r != impl::FrameRead::Ok) {
  20199. closed_ = true;
  20200. return Fail;
  20201. }
  20202. switch (opcode) {
  20203. case Opcode::Text:
  20204. case Opcode::Binary: {
  20205. auto result = opcode == Opcode::Text ? Text : Binary;
  20206. msg = std::move(payload);
  20207. // Handle fragmentation
  20208. if (!fin) {
  20209. while (true) {
  20210. Opcode cont_opcode;
  20211. std::string cont_payload;
  20212. bool cont_fin;
  20213. // Only what is left of the limit, but room for a control frame,
  20214. // which may come between the fragments.
  20215. auto max_len =
  20216. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH == 0
  20217. ? size_t(0)
  20218. : (std::max)(size_t(125),
  20219. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH -
  20220. msg.size());
  20221. // A timeout is not reportable here: half of a fragmented message is
  20222. // already in `msg` and read() has no way to resume it, so it is a
  20223. // failure like any other. Timeouts are only ever seen on a message
  20224. // boundary.
  20225. if (impl::read_websocket_frame(strm_, cont_opcode, cont_payload,
  20226. cont_fin, is_server_,
  20227. max_len) != impl::FrameRead::Ok) {
  20228. closed_ = true;
  20229. return Fail;
  20230. }
  20231. // RFC 6455 5.4: the fragments are continuation frames, with only
  20232. // control frames between them.
  20233. if (cont_opcode != Opcode::Continuation) {
  20234. if (handle_control(cont_opcode, cont_payload)) { continue; }
  20235. return Fail;
  20236. }
  20237. msg += cont_payload;
  20238. if (CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH > 0 &&
  20239. msg.size() > CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) {
  20240. closed_ = true;
  20241. return Fail;
  20242. }
  20243. if (cont_fin) { break; }
  20244. }
  20245. }
  20246. // RFC 6455 Section 5.6: text frames must contain valid UTF-8
  20247. if (result == Text && !impl::is_valid_utf8(msg)) {
  20248. // close() takes the read lock to wait for the peer's Close reply, so
  20249. // it must not run while this thread still holds it.
  20250. read_lock.unlock();
  20251. close(CloseStatus::InvalidPayload, "invalid UTF-8");
  20252. return Fail;
  20253. }
  20254. return result;
  20255. }
  20256. default:
  20257. if (handle_control(opcode, payload)) { continue; }
  20258. return Fail;
  20259. }
  20260. }
  20261. return Fail;
  20262. }
  20263. inline bool WebSocket::send(const std::string &data) {
  20264. return send_frame(Opcode::Text, data.data(), data.size());
  20265. }
  20266. inline bool WebSocket::send(const char *data, size_t len) {
  20267. return send_frame(Opcode::Binary, data, len);
  20268. }
  20269. inline void WebSocket::close(CloseStatus status, const std::string &reason) {
  20270. if (closed_.exchange(true)) { return; }
  20271. ping_cv_.notify_all();
  20272. std::string payload;
  20273. auto code = static_cast<uint16_t>(status);
  20274. payload.push_back(static_cast<char>((code >> 8) & 0xFF));
  20275. payload.push_back(static_cast<char>(code & 0xFF));
  20276. // RFC 6455 Section 5.5: control frame payload must not exceed 125 bytes
  20277. // Close frame has 2-byte status code, so reason is limited to 123 bytes,
  20278. // cut back to a whole UTF-8 character
  20279. auto short_reason = reason.substr(0, 123);
  20280. while (!short_reason.empty() && !impl::is_valid_utf8(short_reason)) {
  20281. short_reason.pop_back();
  20282. }
  20283. payload += short_reason;
  20284. // A code that may not be sent, such as NoStatus, goes without a payload
  20285. if (!impl::is_valid_close_payload(payload)) { payload.clear(); }
  20286. {
  20287. std::lock_guard<std::mutex> lock(write_mutex_);
  20288. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  20289. payload.size(), true, !is_server_);
  20290. }
  20291. // RFC 6455 Section 7.1.1: after sending a Close frame, wait for the peer's
  20292. // Close response before closing the TCP connection.
  20293. //
  20294. // Wait only when no other thread is parsing frames. When one is, it is the
  20295. // thread positioned to see the peer's reply, and reading here would take
  20296. // bytes out of the message it is assembling. Bailing out also leaves the
  20297. // stream, including its read timeout, entirely to that thread.
  20298. std::unique_lock<std::mutex> read_lock(read_mutex_, std::try_to_lock);
  20299. if (!read_lock.owns_lock()) { return; }
  20300. // Use a short timeout to avoid hanging if the peer doesn't respond.
  20301. strm_.set_read_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  20302. Opcode op;
  20303. std::string resp;
  20304. bool fin;
  20305. while (impl::read_websocket_frame(strm_, op, resp, fin, is_server_, 125) ==
  20306. impl::FrameRead::Ok) {
  20307. if (op == Opcode::Close) { break; }
  20308. }
  20309. }
  20310. inline WebSocket::~WebSocket() {
  20311. {
  20312. std::lock_guard<std::mutex> lock(ping_mutex_);
  20313. closed_ = true;
  20314. }
  20315. ping_cv_.notify_all();
  20316. if (ping_thread_.joinable()) { ping_thread_.join(); }
  20317. // A server's stream outlives this object
  20318. strm_.set_read_interrupt(nullptr);
  20319. }
  20320. inline void WebSocket::start_heartbeat() {
  20321. if (ping_interval_sec_ <= 0) { return; }
  20322. // A pong timeout ends a read() blocked on the silent peer
  20323. if (max_missed_pongs_ > 0) {
  20324. strm_.set_read_interrupt([this] { return pong_timed_out_.load(); });
  20325. }
  20326. ping_thread_ = std::thread([this]() {
  20327. std::unique_lock<std::mutex> lock(ping_mutex_);
  20328. // The predicate keeps a spurious wakeup from sending a ping early
  20329. while (!ping_cv_.wait_for(lock, std::chrono::seconds(ping_interval_sec_),
  20330. [this]() { return closed_.load(); })) {
  20331. // If the peer has failed to respond to the previous pings, give up.
  20332. // RFC 6455 does not define a pong-timeout mechanism; this is an
  20333. // opt-in liveness check controlled by max_missed_pongs_.
  20334. if (max_missed_pongs_ > 0 && unacked_pings_ >= max_missed_pongs_) {
  20335. lock.unlock();
  20336. close(CloseStatus::GoingAway, "pong timeout");
  20337. pong_timed_out_ = true;
  20338. return;
  20339. }
  20340. lock.unlock();
  20341. if (!send_frame(Opcode::Ping, nullptr, 0)) {
  20342. lock.lock();
  20343. closed_ = true;
  20344. break;
  20345. }
  20346. lock.lock();
  20347. unacked_pings_++;
  20348. }
  20349. });
  20350. }
  20351. inline const Request &WebSocket::request() const { return req_; }
  20352. inline bool WebSocket::is_open() const { return !closed_; }
  20353. inline void WebSocket::set_read_timeout(time_t sec, time_t usec) {
  20354. // 0 waits forever here, as it does for SO_RCVTIMEO. The stream waits with
  20355. // poll(), where 0 would instead mean "return immediately", so hand it the
  20356. // negative poll uses for an unbounded wait.
  20357. if (sec == 0 && usec == 0) { sec = -1; }
  20358. strm_.set_read_timeout(sec, usec);
  20359. read_timeout_set_ = true;
  20360. }
  20361. // WebSocketClient implementation
  20362. inline WebSocketClient::WebSocketClient(
  20363. const std::string &scheme_host_port_path, const Headers &headers)
  20364. : headers_(headers) {
  20365. detail::UrlComponents uc;
  20366. if (detail::parse_url(scheme_host_port_path, uc) && !uc.scheme.empty() &&
  20367. !uc.host.empty() && !uc.path.empty()) {
  20368. auto &scheme = uc.scheme;
  20369. #ifdef CPPHTTPLIB_SSL_ENABLED
  20370. if (scheme != "ws" && scheme != "wss") {
  20371. #else
  20372. if (scheme != "ws") {
  20373. #endif
  20374. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  20375. std::string msg = "'" + scheme + "' scheme is not supported.";
  20376. throw std::invalid_argument(msg);
  20377. #endif
  20378. return;
  20379. }
  20380. auto is_ssl = scheme == "wss";
  20381. host_ = std::move(uc.host);
  20382. port_ = is_ssl ? 443 : 80;
  20383. if (!uc.port.empty() && !detail::parse_port(uc.port, port_)) { return; }
  20384. path_ = std::move(uc.path);
  20385. if (!uc.query.empty()) { path_ += uc.query; }
  20386. #ifdef CPPHTTPLIB_SSL_ENABLED
  20387. is_ssl_ = is_ssl;
  20388. if (is_ssl_) {
  20389. // The context lives as long as the client so that CA configuration
  20390. // survives reconnects; sessions are created per connection.
  20391. tls_ctx_ = tls::create_client_context();
  20392. if (!tls_ctx_) { return; }
  20393. }
  20394. #else
  20395. if (is_ssl) { return; }
  20396. #endif
  20397. is_valid_ = true;
  20398. }
  20399. }
  20400. #ifdef CPPHTTPLIB_SSL_ENABLED
  20401. inline WebSocketClient::WebSocketClient(
  20402. const std::string &scheme_host_port_path, const PemMemory &pem,
  20403. const Headers &headers)
  20404. : WebSocketClient(scheme_host_port_path, headers) {
  20405. // For ws:// URLs the client certificate is silently ignored, consistent
  20406. // with the TLS-only setters such as set_ca_cert_path().
  20407. if (is_valid_ && is_ssl_ && pem.cert_pem && pem.key_pem) {
  20408. std::string cert_buf, key_buf;
  20409. if (!tls::set_client_cert_pem(
  20410. tls_ctx_,
  20411. detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  20412. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  20413. pem.private_key_password)) {
  20414. tls::free_context(tls_ctx_);
  20415. tls_ctx_ = nullptr;
  20416. is_valid_ = false;
  20417. }
  20418. }
  20419. }
  20420. #endif
  20421. inline WebSocketClient::~WebSocketClient() {
  20422. shutdown_and_close();
  20423. #ifdef CPPHTTPLIB_SSL_ENABLED
  20424. if (tls_ctx_) {
  20425. tls::free_context(tls_ctx_);
  20426. tls_ctx_ = nullptr;
  20427. }
  20428. #endif
  20429. }
  20430. inline bool WebSocketClient::is_valid() const { return is_valid_; }
  20431. inline void WebSocketClient::shutdown_and_close() {
  20432. // Send the close frame while the TLS session is still alive: ws_ holds an
  20433. // SSLSocketStream that keeps a raw pointer to tls_session_, so the session
  20434. // must outlive ws_->close() and ws_.reset() to avoid a use-after-free.
  20435. if (ws_ && ws_->is_open()) { ws_->close(); }
  20436. ws_.reset();
  20437. #ifdef CPPHTTPLIB_SSL_ENABLED
  20438. if (is_ssl_) {
  20439. if (tls_session_) {
  20440. tls::shutdown(tls_session_, true);
  20441. tls::free_session(tls_session_);
  20442. tls_session_ = nullptr;
  20443. }
  20444. }
  20445. #endif
  20446. if (sock_ != INVALID_SOCKET) {
  20447. detail::shutdown_socket(sock_);
  20448. detail::close_socket(sock_);
  20449. sock_ = INVALID_SOCKET;
  20450. }
  20451. }
  20452. // The handshakes belong to establishing the connection, so an unset read
  20453. // timeout leaves them bounded by the connection timeout instead of forever.
  20454. inline std::pair<time_t, time_t> WebSocketClient::handshake_timeout() const {
  20455. if (read_timeout_sec_ == 0 && read_timeout_usec_ == 0) {
  20456. return {connection_timeout_sec_, connection_timeout_usec_};
  20457. }
  20458. return {read_timeout_sec_, read_timeout_usec_};
  20459. }
  20460. inline bool WebSocketClient::create_stream(std::unique_ptr<Stream> &strm,
  20461. Error &error, int &ssl_error,
  20462. uint64_t &ssl_backend_error) {
  20463. // A read timeout of 0 means "wait forever", the way SO_RCVTIMEO reads it.
  20464. // The streams wait with poll(), where 0 instead means "return immediately",
  20465. // so they are given the negative poll uses for an unbounded wait.
  20466. auto unbounded = read_timeout_sec_ == 0 && read_timeout_usec_ == 0;
  20467. time_t strm_read_sec = unbounded ? -1 : read_timeout_sec_;
  20468. time_t strm_read_usec = unbounded ? 0 : read_timeout_usec_;
  20469. #ifdef CPPHTTPLIB_SSL_ENABLED
  20470. if (is_ssl_) {
  20471. // A plain flag rather than SSLClient::load_certs()'s call_once: connect()
  20472. // is not safe to call concurrently on one client to begin with, since
  20473. // nothing else here is guarded either.
  20474. if (server_certificate_verification_ && !certs_loaded_) {
  20475. uint64_t backend_error = 0;
  20476. detail::load_client_ca_config(tls_ctx_, ca_cert_file_path_,
  20477. ca_cert_dir_path_, custom_ca_loaded_,
  20478. system_ca_mode_, backend_error);
  20479. certs_loaded_ = true;
  20480. }
  20481. detail::ClientTlsSessionOptions options;
  20482. options.server_hostname_verification = server_hostname_verification_;
  20483. options.session_verifier = session_verifier_;
  20484. auto timeout = handshake_timeout();
  20485. detail::ClientTlsSessionError tls_error;
  20486. if (!detail::setup_client_tls_session(host_, tls_ctx_, tls_session_, sock_,
  20487. server_certificate_verification_,
  20488. timeout.first, timeout.second,
  20489. &tls_error, options)) {
  20490. error = tls_error.error;
  20491. ssl_error = tls_error.ssl_error;
  20492. ssl_backend_error = tls_error.backend_error;
  20493. return false;
  20494. }
  20495. strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  20496. sock_, tls_session_, strm_read_sec, strm_read_usec, write_timeout_sec_,
  20497. write_timeout_usec_));
  20498. return true;
  20499. }
  20500. #else
  20501. (void)error;
  20502. (void)ssl_error;
  20503. (void)ssl_backend_error;
  20504. #endif
  20505. strm = std::unique_ptr<Stream>(
  20506. new detail::SocketStream(sock_, strm_read_sec, strm_read_usec,
  20507. write_timeout_sec_, write_timeout_usec_));
  20508. return true;
  20509. }
  20510. inline void WebSocketClient::prepare_default_headers(Request &req) {
  20511. #ifdef CPPHTTPLIB_SSL_ENABLED
  20512. auto is_ssl = is_ssl_;
  20513. #else
  20514. auto is_ssl = false;
  20515. #endif
  20516. if (!req.has_header("Host")) {
  20517. req.headers.emplace("Host", detail::make_default_host_header_value(
  20518. host_, port_, is_ssl, address_family_));
  20519. }
  20520. detail::add_default_user_agent_header(req);
  20521. }
  20522. inline Result WebSocketClient::connect() {
  20523. if (!is_valid_) { return Result{Error::Connection, -1, Headers{}}; }
  20524. shutdown_and_close();
  20525. auto error = Error::Success;
  20526. if (!create_and_connect_socket(error)) {
  20527. return Result{error, -1, Headers{}};
  20528. }
  20529. if (is_proxy_enabled()) {
  20530. Response proxy_res;
  20531. if (!connect_with_proxy(proxy_res, error)) {
  20532. shutdown_and_close();
  20533. return Result{error, proxy_res.status, std::move(proxy_res.headers)};
  20534. }
  20535. }
  20536. std::unique_ptr<Stream> strm;
  20537. auto stream_error = Error::SSLConnection;
  20538. int ssl_error = 0;
  20539. uint64_t ssl_backend_error = 0;
  20540. if (!create_stream(strm, stream_error, ssl_error, ssl_backend_error)) {
  20541. shutdown_and_close();
  20542. #ifdef CPPHTTPLIB_SSL_ENABLED
  20543. return Result{stream_error, -1, Headers{}, ssl_error, ssl_backend_error};
  20544. #else
  20545. return Result{stream_error, -1, Headers{}};
  20546. #endif
  20547. }
  20548. Request req;
  20549. req.method = "GET";
  20550. req.path = path_;
  20551. req.headers = headers_;
  20552. prepare_default_headers(req);
  20553. detail::WebSocketUpgradeResponse upgrade;
  20554. if (!detail::perform_websocket_handshake(*strm, req, upgrade)) {
  20555. shutdown_and_close();
  20556. return Result{upgrade.error, upgrade.status, std::move(upgrade.headers)};
  20557. }
  20558. subprotocol_ = std::move(upgrade.selected_subprotocol);
  20559. ws_ = std::unique_ptr<WebSocket>(new WebSocket(std::move(strm), req, false,
  20560. websocket_ping_interval_sec_,
  20561. websocket_max_missed_pongs_));
  20562. // The stream was created with the timeout already; tell the WebSocket
  20563. // whether it came from the caller, so read() knows to report it as Timeout.
  20564. ws_->read_timeout_set_ = read_timeout_set_;
  20565. return Result{Error::Success, upgrade.status, std::move(upgrade.headers)};
  20566. }
  20567. inline ReadResult WebSocketClient::read(std::string &msg) {
  20568. if (!ws_) { return Fail; }
  20569. return ws_->read(msg);
  20570. }
  20571. inline bool WebSocketClient::send(const std::string &data) {
  20572. if (!ws_) { return false; }
  20573. return ws_->send(data);
  20574. }
  20575. inline bool WebSocketClient::send(const char *data, size_t len) {
  20576. if (!ws_) { return false; }
  20577. return ws_->send(data, len);
  20578. }
  20579. inline void WebSocketClient::close(CloseStatus status,
  20580. const std::string &reason) {
  20581. if (ws_) { ws_->close(status, reason); }
  20582. }
  20583. inline bool WebSocketClient::is_open() const { return ws_ && ws_->is_open(); }
  20584. inline const std::string &WebSocketClient::subprotocol() const {
  20585. return subprotocol_;
  20586. }
  20587. inline void WebSocketClient::set_read_timeout(time_t sec, time_t usec) {
  20588. read_timeout_sec_ = sec;
  20589. read_timeout_usec_ = usec;
  20590. read_timeout_set_ = true;
  20591. // The members above only seed the next connect(); read() consults the
  20592. // stream, so an already-open connection has to be told directly.
  20593. if (ws_) { ws_->set_read_timeout(sec, usec); }
  20594. }
  20595. inline void WebSocketClient::set_write_timeout(time_t sec, time_t usec) {
  20596. write_timeout_sec_ = sec;
  20597. write_timeout_usec_ = usec;
  20598. }
  20599. inline void WebSocketClient::set_websocket_ping_interval(time_t sec) {
  20600. websocket_ping_interval_sec_ = sec;
  20601. }
  20602. inline void WebSocketClient::set_websocket_max_missed_pongs(int count) {
  20603. websocket_max_missed_pongs_ = count;
  20604. }
  20605. inline void WebSocketClient::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  20606. inline void WebSocketClient::set_address_family(int family) {
  20607. address_family_ = family;
  20608. }
  20609. inline void WebSocketClient::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  20610. inline void WebSocketClient::set_socket_options(SocketOptions socket_options) {
  20611. socket_options_ = std::move(socket_options);
  20612. }
  20613. inline void WebSocketClient::set_connection_timeout(time_t sec, time_t usec) {
  20614. connection_timeout_sec_ = sec;
  20615. connection_timeout_usec_ = usec;
  20616. }
  20617. inline void WebSocketClient::set_interface(const std::string &intf) {
  20618. interface_ = intf;
  20619. }
  20620. inline void WebSocketClient::set_hostname_addr_map(
  20621. std::map<std::string, std::string> addr_map) {
  20622. set_direct_hostname_addr_map(std::move(addr_map));
  20623. }
  20624. inline void WebSocketClient::set_direct_hostname_addr_map(
  20625. std::map<std::string, std::string> addr_map) {
  20626. addr_map_ = std::move(addr_map);
  20627. }
  20628. inline void WebSocketClient::set_tunnel_hostname_addr_map(
  20629. std::map<std::string, std::string> addr_map) {
  20630. tunnel_addr_map_ = std::move(addr_map);
  20631. }
  20632. inline bool WebSocketClient::is_proxy_enabled() const {
  20633. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  20634. if (no_proxy_entries_.empty()) { return true; }
  20635. return !detail::host_matches_no_proxy(detail::normalize_target(host_),
  20636. no_proxy_entries_);
  20637. }
  20638. inline bool WebSocketClient::create_and_connect_socket(Error &error) {
  20639. std::string connect_host;
  20640. std::string ip;
  20641. auto port = port_;
  20642. if (is_proxy_enabled()) {
  20643. connect_host = proxy_host_;
  20644. port = proxy_port_;
  20645. } else {
  20646. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  20647. }
  20648. sock_ = detail::create_client_socket(
  20649. connect_host, ip, port, address_family_, tcp_nodelay_, ipv6_v6only_,
  20650. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  20651. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  20652. write_timeout_usec_, interface_, error);
  20653. if (sock_ != INVALID_SOCKET) { return true; }
  20654. if (error == Error::Success) { error = Error::Connection; }
  20655. return false;
  20656. }
  20657. inline bool WebSocketClient::send_proxy_connect(Request &req,
  20658. Response &proxy_res,
  20659. Error &error) {
  20660. auto timeout = handshake_timeout();
  20661. detail::SocketStream strm(sock_, timeout.first, timeout.second,
  20662. write_timeout_sec_, write_timeout_usec_);
  20663. if (!detail::write_request_head(strm, req, error)) { return false; }
  20664. if (!detail::read_response_head(strm, proxy_res.status, proxy_res.headers)) {
  20665. error = Error::Read;
  20666. return false;
  20667. }
  20668. return true;
  20669. }
  20670. // RFC 6455 4.1: ws:// is tunnelled with CONNECT as well, since a proxy need not
  20671. // forward an Upgrade request.
  20672. inline bool WebSocketClient::connect_with_proxy(Response &proxy_res,
  20673. Error &error) {
  20674. Request req;
  20675. req.method = "CONNECT";
  20676. req.path =
  20677. detail::make_connect_request_target(tunnel_addr_map_, host_, port_);
  20678. req.headers.emplace("Host", req.path);
  20679. detail::add_default_user_agent_header(req);
  20680. detail::add_authorization_header(req, proxy_basic_auth_username_,
  20681. proxy_basic_auth_password_,
  20682. proxy_bearer_token_auth_token_, true);
  20683. if (!send_proxy_connect(req, proxy_res, error)) { return false; }
  20684. #ifdef CPPHTTPLIB_SSL_ENABLED
  20685. // A Digest challenge gets one retry on a fresh connection, like SSLClient.
  20686. std::map<std::string, std::string> auth;
  20687. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407 &&
  20688. !proxy_digest_auth_username_.empty() &&
  20689. !proxy_digest_auth_password_.empty() &&
  20690. detail::parse_www_authenticate(proxy_res, auth, true)) {
  20691. proxy_res = Response();
  20692. shutdown_and_close();
  20693. if (!create_and_connect_socket(error)) { return false; }
  20694. req.headers.erase("Proxy-Authorization");
  20695. req.headers.insert(detail::make_digest_authentication_header(
  20696. req, req.path, auth, 1, detail::random_string(10),
  20697. proxy_digest_auth_username_, proxy_digest_auth_password_, true));
  20698. if (!send_proxy_connect(req, proxy_res, error)) { return false; }
  20699. }
  20700. #endif
  20701. if (proxy_res.status != StatusCode::OK_200) {
  20702. error = Error::ProxyConnection;
  20703. return false;
  20704. }
  20705. return true;
  20706. }
  20707. inline void WebSocketClient::set_proxy(const std::string &host, int port) {
  20708. proxy_host_ = host;
  20709. proxy_port_ = port;
  20710. }
  20711. inline void WebSocketClient::set_proxy_basic_auth(const std::string &username,
  20712. const std::string &password) {
  20713. proxy_basic_auth_username_ = username;
  20714. proxy_basic_auth_password_ = password;
  20715. }
  20716. inline void
  20717. WebSocketClient::set_proxy_bearer_token_auth(const std::string &token) {
  20718. proxy_bearer_token_auth_token_ = token;
  20719. }
  20720. inline void
  20721. WebSocketClient::set_no_proxy(const std::vector<std::string> &patterns) {
  20722. no_proxy_entries_ = detail::parse_no_proxy_entries(patterns);
  20723. }
  20724. #ifdef CPPHTTPLIB_SSL_ENABLED
  20725. inline void
  20726. WebSocketClient::set_ca_cert_path(const std::string &ca_cert_file_path,
  20727. const std::string &ca_cert_dir_path) {
  20728. ca_cert_file_path_ = ca_cert_file_path;
  20729. ca_cert_dir_path_ = ca_cert_dir_path;
  20730. }
  20731. inline void
  20732. WebSocketClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  20733. if (tls_ctx_) { tls::set_verify_callback(tls_ctx_, std::move(verifier)); }
  20734. }
  20735. inline void WebSocketClient::set_session_verifier(
  20736. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  20737. session_verifier_ = std::move(verifier);
  20738. }
  20739. inline void WebSocketClient::set_ca_cert_store(tls::ca_store_t store) {
  20740. if (store && tls_ctx_) {
  20741. // set_ca_store takes ownership of store
  20742. tls::set_ca_store(tls_ctx_, store);
  20743. } else if (store) {
  20744. tls::free_ca_store(store);
  20745. }
  20746. custom_ca_loaded_ = true;
  20747. }
  20748. inline void WebSocketClient::load_ca_cert_store(const char *ca_cert,
  20749. std::size_t size) {
  20750. if (tls_ctx_ && ca_cert && size > 0) {
  20751. tls::load_ca_pem(tls_ctx_, ca_cert, size);
  20752. }
  20753. custom_ca_loaded_ = true;
  20754. }
  20755. inline void
  20756. WebSocketClient::enable_server_certificate_verification(bool enabled) {
  20757. server_certificate_verification_ = enabled;
  20758. }
  20759. inline void WebSocketClient::enable_server_hostname_verification(bool enabled) {
  20760. server_hostname_verification_ = enabled;
  20761. }
  20762. inline void WebSocketClient::enable_system_ca(bool enabled) {
  20763. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  20764. }
  20765. inline void
  20766. WebSocketClient::set_proxy_digest_auth(const std::string &username,
  20767. const std::string &password) {
  20768. proxy_digest_auth_username_ = username;
  20769. proxy_digest_auth_password_ = password;
  20770. }
  20771. #endif // CPPHTTPLIB_SSL_ENABLED
  20772. } // namespace ws
  20773. // ----------------------------------------------------------------------------
  20774. } // namespace httplib
  20775. #endif // CPPHTTPLIB_HTTPLIB_H