httplib.h 825 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073230742307523076230772307823079230802308123082230832308423085230862308723088230892309023091230922309323094230952309623097230982309923100231012310223103231042310523106231072310823109231102311123112231132311423115231162311723118231192312023121231222312323124231252312623127231282312923130231312313223133231342313523136231372313823139231402314123142231432314423145231462314723148231492315023151231522315323154231552315623157231582315923160231612316223163231642316523166231672316823169231702317123172231732317423175231762317723178231792318023181231822318323184231852318623187231882318923190231912319223193231942319523196231972319823199232002320123202232032320423205232062320723208232092321023211232122321323214232152321623217232182321923220232212322223223232242322523226232272322823229232302323123232232332323423235232362323723238232392324023241232422324323244232452324623247232482324923250232512325223253232542325523256232572325823259232602326123262232632326423265232662326723268232692327023271232722327323274232752327623277232782327923280232812328223283232842328523286232872328823289232902329123292232932329423295232962329723298232992330023301233022330323304233052330623307233082330923310233112331223313233142331523316233172331823319233202332123322233232332423325233262332723328233292333023331233322333323334233352333623337233382333923340233412334223343233442334523346233472334823349233502335123352233532335423355233562335723358233592336023361233622336323364233652336623367233682336923370233712337223373233742337523376233772337823379233802338123382233832338423385233862338723388233892339023391233922339323394233952339623397233982339923400234012340223403234042340523406234072340823409234102341123412234132341423415234162341723418234192342023421234222342323424234252342623427234282342923430234312343223433234342343523436234372343823439234402344123442234432344423445234462344723448234492345023451234522345323454234552345623457234582345923460234612346223463234642346523466234672346823469234702347123472234732347423475234762347723478234792348023481234822348323484234852348623487234882348923490234912349223493234942349523496234972349823499235002350123502235032350423505235062350723508235092351023511235122351323514235152351623517235182351923520235212352223523235242352523526235272352823529235302353123532235332353423535235362353723538235392354023541235422354323544235452354623547235482354923550235512355223553235542355523556235572355823559235602356123562235632356423565235662356723568235692357023571235722357323574235752357623577235782357923580235812358223583235842358523586235872358823589235902359123592235932359423595235962359723598235992360023601236022360323604236052360623607236082360923610236112361223613236142361523616236172361823619236202362123622236232362423625236262362723628236292363023631236322363323634236352363623637236382363923640236412364223643236442364523646236472364823649236502365123652236532365423655236562365723658236592366023661236622366323664236652366623667236682366923670236712367223673236742367523676236772367823679236802368123682236832368423685236862368723688236892369023691236922369323694236952369623697236982369923700237012370223703237042370523706237072370823709237102371123712237132371423715237162371723718237192372023721237222372323724237252372623727237282372923730237312373223733237342373523736237372373823739237402374123742237432374423745237462374723748237492375023751237522375323754237552375623757237582375923760237612376223763237642376523766237672376823769237702377123772237732377423775237762377723778237792378023781237822378323784237852378623787237882378923790237912379223793237942379523796237972379823799238002380123802238032380423805238062380723808238092381023811238122381323814238152381623817238182381923820238212382223823238242382523826238272382823829238302383123832238332383423835238362383723838238392384023841238422384323844238452384623847238482384923850238512385223853238542385523856238572385823859238602386123862238632386423865238662386723868238692387023871238722387323874238752387623877238782387923880238812388223883238842388523886238872388823889238902389123892238932389423895238962389723898238992390023901239022390323904239052390623907239082390923910239112391223913239142391523916239172391823919239202392123922239232392423925239262392723928239292393023931239322393323934239352393623937239382393923940239412394223943239442394523946239472394823949239502395123952239532395423955239562395723958239592396023961239622396323964239652396623967239682396923970239712397223973239742397523976239772397823979239802398123982239832398423985239862398723988239892399023991239922399323994
  1. //
  2. // httplib.h
  3. //
  4. // Copyright (c) 2026 Yuji Hirose. All rights reserved.
  5. // MIT License
  6. //
  7. #ifndef CPPHTTPLIB_HTTPLIB_H
  8. #define CPPHTTPLIB_HTTPLIB_H
  9. #define CPPHTTPLIB_VERSION "0.61.0"
  10. #define CPPHTTPLIB_VERSION_NUM "0x003d00"
  11. #ifdef _WIN32
  12. #if defined(_WIN32_WINNT) && _WIN32_WINNT < 0x0A00
  13. #error \
  14. "cpp-httplib doesn't support Windows 8 or lower. Please use Windows 10 or later."
  15. #endif
  16. #endif
  17. #if defined(__SANITIZE_THREAD__)
  18. #define CPPHTTPLIB_THREAD_SANITIZER
  19. #elif defined(__has_feature)
  20. #if __has_feature(thread_sanitizer)
  21. #define CPPHTTPLIB_THREAD_SANITIZER
  22. #endif
  23. #endif
  24. /*
  25. * Configuration
  26. */
  27. #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND
  28. #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND 5
  29. #endif
  30. #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND
  31. #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND 10000
  32. #endif
  33. #ifndef CPPHTTPLIB_KEEPALIVE_MAX_COUNT
  34. #define CPPHTTPLIB_KEEPALIVE_MAX_COUNT 100
  35. #endif
  36. #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND
  37. #define CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND 300
  38. #endif
  39. #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND
  40. #define CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND 0
  41. #endif
  42. #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND
  43. #define CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND 5
  44. #endif
  45. #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND
  46. #define CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND 0
  47. #endif
  48. #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND
  49. #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND 5
  50. #endif
  51. #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND
  52. #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND 0
  53. #endif
  54. #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND
  55. #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND 300
  56. #endif
  57. #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND
  58. #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND 0
  59. #endif
  60. #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND
  61. #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND 5
  62. #endif
  63. #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND
  64. #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND 0
  65. #endif
  66. #ifndef CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND
  67. #define CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND 0
  68. #endif
  69. #ifndef CPPHTTPLIB_EXPECT_100_THRESHOLD
  70. #define CPPHTTPLIB_EXPECT_100_THRESHOLD 1024
  71. #endif
  72. #ifndef CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND
  73. #define CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND 1000
  74. #endif
  75. #ifndef CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD
  76. #define CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD (1024 * 1024)
  77. #endif
  78. #ifndef CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND
  79. #define CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND 50
  80. #endif
  81. #ifndef CPPHTTPLIB_IDLE_INTERVAL_SECOND
  82. #define CPPHTTPLIB_IDLE_INTERVAL_SECOND 0
  83. #endif
  84. #ifndef CPPHTTPLIB_IDLE_INTERVAL_USECOND
  85. #ifdef _WIN32
  86. #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 1000
  87. #else
  88. #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 0
  89. #endif
  90. #endif
  91. #ifndef CPPHTTPLIB_REQUEST_URI_MAX_LENGTH
  92. #define CPPHTTPLIB_REQUEST_URI_MAX_LENGTH 8192
  93. #endif
  94. #ifndef CPPHTTPLIB_HEADER_MAX_LENGTH
  95. #define CPPHTTPLIB_HEADER_MAX_LENGTH 8192
  96. #endif
  97. #ifndef CPPHTTPLIB_HEADER_MAX_COUNT
  98. #define CPPHTTPLIB_HEADER_MAX_COUNT 100
  99. #endif
  100. #ifndef CPPHTTPLIB_REDIRECT_MAX_COUNT
  101. #define CPPHTTPLIB_REDIRECT_MAX_COUNT 20
  102. #endif
  103. #ifndef CPPHTTPLIB_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. #ifndef CPPHTTPLIB_SSE_MAX_EVENT_LENGTH
  113. #define CPPHTTPLIB_SSE_MAX_EVENT_LENGTH (16 * 1024 * 1024) // 16MB
  114. #endif
  115. #ifndef CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH
  116. #define CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH 8192
  117. #endif
  118. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH
  119. // 1400 rather than a round number: a body that already fits in one 1500-byte
  120. // MTU gains nothing from being made smaller.
  121. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH 1400
  122. #endif
  123. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH
  124. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH (4 * 1024 * 1024) // 4MB
  125. #endif
  126. #ifndef CPPHTTPLIB_RANGE_MAX_COUNT
  127. #define CPPHTTPLIB_RANGE_MAX_COUNT 1024
  128. #endif
  129. // std::regex_match's backtracking implementation (most acutely on libstdc++)
  130. // recurses roughly once per matched character for quantified patterns such
  131. // as "(.*)", so a long enough path can exhaust the calling thread's stack; on
  132. // a default ~8MB thread stack that has been observed to take on the order of
  133. // a couple thousand characters for a simple pattern. 256 leaves a wide safety
  134. // margin below that (well under the 8192-byte request URI limit) while still
  135. // fitting any realistic route segment; raise it if a route legitimately needs
  136. // longer paths. Regex routes are never applied to paths longer than this.
  137. #ifndef CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH
  138. #define CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH 256
  139. #endif
  140. #ifndef CPPHTTPLIB_TCP_NODELAY
  141. #define CPPHTTPLIB_TCP_NODELAY false
  142. #endif
  143. #ifndef CPPHTTPLIB_IPV6_V6ONLY
  144. #define CPPHTTPLIB_IPV6_V6ONLY false
  145. #endif
  146. #ifndef CPPHTTPLIB_RECV_BUFSIZ
  147. #define CPPHTTPLIB_RECV_BUFSIZ size_t(16384u)
  148. #endif
  149. #ifndef CPPHTTPLIB_SEND_BUFSIZ
  150. #define CPPHTTPLIB_SEND_BUFSIZ size_t(16384u)
  151. #endif
  152. #ifndef CPPHTTPLIB_COMPRESSION_BUFSIZ
  153. #define CPPHTTPLIB_COMPRESSION_BUFSIZ size_t(16384u)
  154. #endif
  155. #ifndef CPPHTTPLIB_THREAD_POOL_COUNT
  156. #define CPPHTTPLIB_THREAD_POOL_COUNT \
  157. ((std::max)(8u, std::thread::hardware_concurrency() > 0 \
  158. ? std::thread::hardware_concurrency() - 1 \
  159. : 0))
  160. #endif
  161. #ifndef CPPHTTPLIB_THREAD_POOL_MAX_COUNT
  162. #define CPPHTTPLIB_THREAD_POOL_MAX_COUNT (CPPHTTPLIB_THREAD_POOL_COUNT * 4)
  163. #endif
  164. #ifndef CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT
  165. #define CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT 3 // seconds
  166. #endif
  167. #ifndef CPPHTTPLIB_RECV_FLAGS
  168. #define CPPHTTPLIB_RECV_FLAGS 0
  169. #endif
  170. #ifndef CPPHTTPLIB_SEND_FLAGS
  171. #define CPPHTTPLIB_SEND_FLAGS 0
  172. #endif
  173. #ifndef CPPHTTPLIB_LISTEN_BACKLOG
  174. #define CPPHTTPLIB_LISTEN_BACKLOG 128
  175. #endif
  176. #ifndef CPPHTTPLIB_MAX_LINE_LENGTH
  177. #define CPPHTTPLIB_MAX_LINE_LENGTH 32768
  178. #endif
  179. // These bound the parsing of every request, so 0 cannot lift them.
  180. static_assert(CPPHTTPLIB_REQUEST_URI_MAX_LENGTH > 0,
  181. "CPPHTTPLIB_REQUEST_URI_MAX_LENGTH must be positive");
  182. static_assert(CPPHTTPLIB_HEADER_MAX_LENGTH > 0,
  183. "CPPHTTPLIB_HEADER_MAX_LENGTH must be positive");
  184. static_assert(CPPHTTPLIB_HEADER_MAX_COUNT > 0,
  185. "CPPHTTPLIB_HEADER_MAX_COUNT must be positive");
  186. static_assert(CPPHTTPLIB_MAX_LINE_LENGTH > 0,
  187. "CPPHTTPLIB_MAX_LINE_LENGTH must be positive");
  188. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH
  189. #define CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH 16777216
  190. #endif
  191. // One macro used to set the read timeout for both sides. They want different
  192. // defaults: a client's read timeout is the caller's own tool (it waits forever
  193. // until asked not to), while a server keeps a ceiling that reclaims a worker
  194. // from a peer that has gone quiet. The old name still works and sets both.
  195. #ifdef CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  196. #pragma message( \
  197. "CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND is deprecated; define " \
  198. "CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND and/or " \
  199. "CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND instead")
  200. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  201. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND \
  202. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  203. #endif
  204. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  205. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND \
  206. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  207. #endif
  208. #endif
  209. // 0 waits forever. A read timeout is how a caller gets control back to send on
  210. // the same connection; it is not a liveness check (that is ping/pong). Only a
  211. // timeout set at runtime through set_read_timeout() is reported as
  212. // ws::Timeout; when one of these compile-time defaults elapses, read() returns
  213. // ws::Fail and closes the connection.
  214. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  215. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND 0
  216. #endif
  217. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  218. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND 300
  219. #endif
  220. #ifndef CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND
  221. #define CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND 5
  222. #endif
  223. #ifndef CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND
  224. #define CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND 30
  225. #endif
  226. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS
  227. #define CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS 0
  228. #endif
  229. /*
  230. * Headers
  231. */
  232. #ifdef _WIN32
  233. #ifndef _CRT_SECURE_NO_WARNINGS
  234. #define _CRT_SECURE_NO_WARNINGS
  235. #endif //_CRT_SECURE_NO_WARNINGS
  236. #ifndef _CRT_NONSTDC_NO_DEPRECATE
  237. #define _CRT_NONSTDC_NO_DEPRECATE
  238. #endif //_CRT_NONSTDC_NO_DEPRECATE
  239. #if defined(_MSC_VER)
  240. #if _MSC_VER < 1900
  241. #error Sorry, Visual Studio versions prior to 2015 are not supported
  242. #endif
  243. #pragma comment(lib, "ws2_32.lib")
  244. #ifndef _SSIZE_T_DEFINED
  245. using ssize_t = __int64;
  246. #define _SSIZE_T_DEFINED
  247. #endif
  248. #endif // _MSC_VER
  249. #ifndef S_ISREG
  250. #define S_ISREG(m) (((m) & S_IFREG) == S_IFREG)
  251. #endif // S_ISREG
  252. #ifndef S_ISDIR
  253. #define S_ISDIR(m) (((m) & S_IFDIR) == S_IFDIR)
  254. #endif // S_ISDIR
  255. #ifndef NOMINMAX
  256. #define NOMINMAX
  257. #endif // NOMINMAX
  258. #include <io.h>
  259. #include <winsock2.h>
  260. #include <ws2tcpip.h>
  261. #if defined(__has_include)
  262. #if __has_include(<afunix.h>)
  263. // afunix.h uses types declared in winsock2.h, so has to be included after it.
  264. #include <afunix.h>
  265. #define CPPHTTPLIB_HAVE_AFUNIX_H 1
  266. #endif
  267. #endif
  268. #ifndef WSA_FLAG_NO_HANDLE_INHERIT
  269. #define WSA_FLAG_NO_HANDLE_INHERIT 0x80
  270. #endif
  271. using nfds_t = unsigned long;
  272. using socket_t = SOCKET;
  273. using socklen_t = int;
  274. #else // not _WIN32
  275. #include <arpa/inet.h>
  276. #if !defined(_AIX) && !defined(__MVS__)
  277. #include <ifaddrs.h>
  278. #endif
  279. #ifdef __MVS__
  280. #include <strings.h>
  281. #ifndef NI_MAXHOST
  282. #define NI_MAXHOST 1025
  283. #endif
  284. #endif
  285. #include <net/if.h>
  286. #include <netdb.h>
  287. #include <netinet/in.h>
  288. #ifdef __linux__
  289. #include <resolv.h>
  290. #undef _res // Undefine _res macro to avoid conflicts with user code (#2278)
  291. #endif
  292. #include <csignal>
  293. #include <netinet/tcp.h>
  294. #include <poll.h>
  295. #include <pthread.h>
  296. #include <sys/socket.h>
  297. #include <sys/un.h>
  298. #include <unistd.h>
  299. using socket_t = int;
  300. #ifndef INVALID_SOCKET
  301. #define INVALID_SOCKET (-1)
  302. #endif
  303. #endif //_WIN32
  304. #if defined(__APPLE__)
  305. #include <TargetConditionals.h>
  306. #endif
  307. #include <algorithm>
  308. #include <array>
  309. #include <atomic>
  310. #include <cassert>
  311. #include <chrono>
  312. #include <climits>
  313. #include <condition_variable>
  314. #include <cstdlib>
  315. #include <cstring>
  316. #include <errno.h>
  317. #include <exception>
  318. #include <fcntl.h>
  319. #include <fstream>
  320. #include <functional>
  321. #include <iomanip>
  322. #include <iostream>
  323. #include <iterator>
  324. #include <list>
  325. #include <map>
  326. #include <memory>
  327. #include <mutex>
  328. #include <random>
  329. #include <regex>
  330. #include <set>
  331. #include <sstream>
  332. #include <string>
  333. #include <sys/stat.h>
  334. #include <system_error>
  335. #include <thread>
  336. #include <type_traits>
  337. #include <unordered_map>
  338. #include <unordered_set>
  339. #include <utility>
  340. #include <vector>
  341. // On macOS with a TLS backend, enable Keychain root certificates by default
  342. // unless the user explicitly opts out. Not enabled on iOS/tvOS/watchOS since
  343. // the SecTrustSettings APIs used to enumerate anchor certificates are macOS
  344. // only; on those platforms the user must provide a CA bundle explicitly.
  345. #if defined(__APPLE__) && defined(__clang__) && \
  346. !defined(CPPHTTPLIB_DISABLE_MACOSX_AUTOMATIC_ROOT_CERTIFICATES) && \
  347. (defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  348. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || \
  349. defined(CPPHTTPLIB_WOLFSSL_SUPPORT))
  350. #if TARGET_OS_OSX
  351. #ifndef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  352. #define CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  353. #endif
  354. #endif
  355. #endif
  356. #if defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN) && \
  357. defined(__APPLE__) && !TARGET_OS_OSX
  358. #error \
  359. "CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN is only supported on macOS. On iOS/tvOS/watchOS, supply a CA bundle via set_ca_cert_path()."
  360. #endif
  361. // On Windows, enable Schannel certificate verification by default
  362. // unless the user explicitly opts out.
  363. #if defined(_WIN32) && \
  364. !defined(CPPHTTPLIB_DISABLE_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE)
  365. #define CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  366. #endif
  367. #if defined(CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO) || \
  368. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  369. #if TARGET_OS_MAC && defined(__clang__)
  370. #include <CFNetwork/CFHost.h>
  371. #include <CoreFoundation/CoreFoundation.h>
  372. #endif
  373. #endif
  374. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  375. #ifdef _WIN32
  376. #include <wincrypt.h>
  377. // these are defined in wincrypt.h and it breaks compilation if BoringSSL is
  378. // used
  379. #undef X509_NAME
  380. #undef X509_CERT_PAIR
  381. #undef X509_EXTENSIONS
  382. #undef PKCS7_SIGNER_INFO
  383. #ifdef _MSC_VER
  384. #pragma comment(lib, "crypt32.lib")
  385. #endif
  386. #endif // _WIN32
  387. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  388. #if TARGET_OS_OSX
  389. #include <Security/Security.h>
  390. #endif
  391. #endif
  392. #include <openssl/err.h>
  393. #include <openssl/evp.h>
  394. #include <openssl/rand.h>
  395. #include <openssl/ssl.h>
  396. #include <openssl/x509v3.h>
  397. #if defined(_WIN32) && defined(OPENSSL_USE_APPLINK)
  398. #include <openssl/applink.c>
  399. #endif
  400. #include <iostream>
  401. #include <sstream>
  402. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  403. #if OPENSSL_VERSION_NUMBER < 0x1010107f
  404. #error Please use OpenSSL or a current version of BoringSSL
  405. #endif
  406. #define SSL_get1_peer_certificate SSL_get_peer_certificate
  407. #elif OPENSSL_VERSION_NUMBER < 0x30000000L
  408. #error Sorry, OpenSSL versions prior to 3.0.0 are not supported
  409. #endif
  410. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  411. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  412. // version.h defines MBEDTLS_VERSION_MAJOR (on 2.x/3.x/4.x alike); it is pulled
  413. // in with this first include group so the version gating below can use it.
  414. #include <mbedtls/error.h>
  415. #include <mbedtls/net_sockets.h>
  416. #include <mbedtls/oid.h>
  417. #include <mbedtls/pk.h>
  418. #include <mbedtls/ssl.h>
  419. #include <mbedtls/version.h>
  420. #include <mbedtls/x509_crt.h>
  421. #if MBEDTLS_VERSION_MAJOR >= 4
  422. // Mbed TLS 4.x moved hashing/RNG to PSA Crypto and removed these headers.
  423. #include <psa/crypto.h>
  424. #else
  425. #include <mbedtls/ctr_drbg.h>
  426. #include <mbedtls/entropy.h>
  427. #include <mbedtls/md5.h>
  428. #include <mbedtls/sha1.h>
  429. #include <mbedtls/sha256.h>
  430. #include <mbedtls/sha512.h>
  431. #endif
  432. #ifdef _WIN32
  433. #include <wincrypt.h>
  434. #ifdef _MSC_VER
  435. #pragma comment(lib, "crypt32.lib")
  436. #endif
  437. #endif // _WIN32
  438. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  439. #if TARGET_OS_OSX
  440. #include <Security/Security.h>
  441. #endif
  442. #endif
  443. // Mbed TLS version API compatibility. Note: V4 implies V3 (both defined on
  444. // 4.x), so version-specific 3.x-only code must check V3 && !V4.
  445. #if MBEDTLS_VERSION_MAJOR >= 4
  446. #define CPPHTTPLIB_MBEDTLS_V4
  447. #endif
  448. #if MBEDTLS_VERSION_MAJOR >= 3
  449. #define CPPHTTPLIB_MBEDTLS_V3
  450. #endif
  451. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  452. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  453. #include <wolfssl/options.h>
  454. #include <wolfssl/openssl/x509v3.h>
  455. // Fallback definitions for older wolfSSL versions (e.g., 5.6.6)
  456. #ifndef WOLFSSL_GEN_EMAIL
  457. #define WOLFSSL_GEN_EMAIL 1
  458. #endif
  459. #ifndef WOLFSSL_GEN_DNS
  460. #define WOLFSSL_GEN_DNS 2
  461. #endif
  462. #ifndef WOLFSSL_GEN_URI
  463. #define WOLFSSL_GEN_URI 6
  464. #endif
  465. #ifndef WOLFSSL_GEN_IPADD
  466. #define WOLFSSL_GEN_IPADD 7
  467. #endif
  468. #include <wolfssl/ssl.h>
  469. #include <wolfssl/wolfcrypt/hash.h>
  470. #include <wolfssl/wolfcrypt/md5.h>
  471. #include <wolfssl/wolfcrypt/sha256.h>
  472. #include <wolfssl/wolfcrypt/sha512.h>
  473. #ifdef _WIN32
  474. #include <wincrypt.h>
  475. #ifdef _MSC_VER
  476. #pragma comment(lib, "crypt32.lib")
  477. #endif
  478. #endif // _WIN32
  479. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  480. #if TARGET_OS_OSX
  481. #include <Security/Security.h>
  482. #endif
  483. #endif
  484. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  485. // Define CPPHTTPLIB_SSL_ENABLED if any SSL backend is available
  486. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  487. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  488. #define CPPHTTPLIB_SSL_ENABLED
  489. #endif
  490. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  491. #include <zlib.h>
  492. #endif
  493. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  494. #include <brotli/decode.h>
  495. #include <brotli/encode.h>
  496. #endif
  497. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  498. #include <zstd.h>
  499. #endif
  500. /*
  501. * Declaration
  502. */
  503. namespace httplib {
  504. namespace ws {
  505. class WebSocket;
  506. } // namespace ws
  507. namespace sse {
  508. class SSEClient;
  509. } // namespace sse
  510. namespace detail {
  511. /*
  512. * Backport std::make_unique from C++14.
  513. *
  514. * NOTE: This code came up with the following stackoverflow post:
  515. * https://stackoverflow.com/questions/10149840/c-arrays-and-make-unique
  516. *
  517. */
  518. template <class T, class... Args>
  519. typename std::enable_if<!std::is_array<T>::value, std::unique_ptr<T>>::type
  520. make_unique(Args &&...args) {
  521. return std::unique_ptr<T>(new T(std::forward<Args>(args)...));
  522. }
  523. template <class T>
  524. typename std::enable_if<std::is_array<T>::value, std::unique_ptr<T>>::type
  525. make_unique(std::size_t n) {
  526. typedef typename std::remove_extent<T>::type RT;
  527. return std::unique_ptr<T>(new RT[n]);
  528. }
  529. // Locale-independent ASCII character classification. The <cctype>
  530. // counterparts (std::isalnum, std::isdigit, ...) consult the global C locale,
  531. // so e.g. std::isalnum(0xC5) can return true once an embedder calls
  532. // setlocale(). HTTP grammars are defined over ASCII, so raw bytes must be
  533. // classified without regard to the locale.
  534. inline bool is_ascii_digit(char c) { return '0' <= c && c <= '9'; }
  535. inline bool is_ascii_alpha(char c) {
  536. return ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z');
  537. }
  538. inline bool is_ascii_alnum(char c) {
  539. return is_ascii_digit(c) || is_ascii_alpha(c);
  540. }
  541. namespace case_ignore {
  542. inline unsigned char to_lower(int c) {
  543. const static unsigned char table[256] = {
  544. 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14,
  545. 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29,
  546. 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44,
  547. 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59,
  548. 60, 61, 62, 63, 64, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106,
  549. 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121,
  550. 122, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104,
  551. 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119,
  552. 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134,
  553. 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149,
  554. 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164,
  555. 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179,
  556. 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 224, 225, 226,
  557. 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239, 240, 241,
  558. 242, 243, 244, 245, 246, 215, 248, 249, 250, 251, 252, 253, 254, 223, 224,
  559. 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239,
  560. 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254,
  561. 255,
  562. };
  563. return table[(unsigned char)(char)c];
  564. }
  565. inline std::string to_lower(const std::string &s) {
  566. std::string result = s;
  567. std::transform(
  568. result.begin(), result.end(), result.begin(),
  569. [](unsigned char c) { return static_cast<char>(to_lower(c)); });
  570. return result;
  571. }
  572. inline bool equal(const std::string &a, const std::string &b) {
  573. return a.size() == b.size() &&
  574. std::equal(a.begin(), a.end(), b.begin(), [](char ca, char cb) {
  575. return to_lower(ca) == to_lower(cb);
  576. });
  577. }
  578. // For a literal, without building a std::string from it.
  579. template <size_t N>
  580. inline bool equal(const std::string &a, const char (&b)[N]) {
  581. return a.size() == N - 1 &&
  582. std::equal(a.begin(), a.end(), b, [](char ca, char cb) {
  583. return to_lower(ca) == to_lower(cb);
  584. });
  585. }
  586. struct equal_to {
  587. bool operator()(const std::string &a, const std::string &b) const {
  588. return equal(a, b);
  589. }
  590. };
  591. struct hash {
  592. size_t operator()(const std::string &key) const {
  593. size_t h = 0;
  594. for (auto c : key) {
  595. // Unsets the 6 high bits of h, therefore no overflow happens
  596. h = (((std::numeric_limits<size_t>::max)() >> 6) & h * 33) ^
  597. static_cast<unsigned char>(to_lower(c));
  598. }
  599. return h;
  600. }
  601. };
  602. template <typename T>
  603. using unordered_set = std::unordered_set<T, detail::case_ignore::hash,
  604. detail::case_ignore::equal_to>;
  605. } // namespace case_ignore
  606. // This is based on
  607. // "http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2014/n4189".
  608. struct scope_exit {
  609. explicit scope_exit(std::function<void(void)> &&f)
  610. : exit_function(std::move(f)), execute_on_destruction{true} {}
  611. scope_exit(scope_exit &&rhs) noexcept
  612. : exit_function(std::move(rhs.exit_function)),
  613. execute_on_destruction{rhs.execute_on_destruction} {
  614. rhs.release();
  615. }
  616. ~scope_exit() {
  617. if (execute_on_destruction) { this->exit_function(); }
  618. }
  619. void release() { this->execute_on_destruction = false; }
  620. private:
  621. scope_exit(const scope_exit &) = delete;
  622. void operator=(const scope_exit &) = delete;
  623. scope_exit &operator=(scope_exit &&) = delete;
  624. std::function<void(void)> exit_function;
  625. bool execute_on_destruction;
  626. };
  627. // Simple from_chars implementation for integer and double types (C++17
  628. // substitute)
  629. template <typename T> struct from_chars_result {
  630. const char *ptr;
  631. std::errc ec;
  632. };
  633. template <typename T>
  634. inline from_chars_result<T> from_chars(const char *first, const char *last,
  635. T &value, int base = 10) {
  636. value = 0;
  637. const char *p = first;
  638. bool negative = false;
  639. if (p != last && *p == '-') {
  640. negative = true;
  641. ++p;
  642. }
  643. if (p == last) { return {first, std::errc::invalid_argument}; }
  644. auto radix = static_cast<T>(base);
  645. T result = 0;
  646. for (; p != last; ++p) {
  647. char c = *p;
  648. int digit = -1;
  649. if (is_ascii_digit(c)) {
  650. digit = c - '0';
  651. } else if ('a' <= c && c <= 'z') {
  652. digit = c - 'a' + 10;
  653. } else if ('A' <= c && c <= 'Z') {
  654. digit = c - 'A' + 10;
  655. } else {
  656. break;
  657. }
  658. if (digit < 0 || digit >= base) { break; }
  659. auto d = static_cast<T>(digit);
  660. if (result > ((std::numeric_limits<T>::max)() - d) / radix) {
  661. return {p, std::errc::result_out_of_range};
  662. }
  663. result = result * radix + d;
  664. }
  665. if (p == first || (negative && p == first + 1)) {
  666. return {first, std::errc::invalid_argument};
  667. }
  668. value = negative ? T(0) - result : result;
  669. return {p, std::errc{}};
  670. }
  671. // from_chars for double (hand-written, locale-independent)
  672. //
  673. // The only double consumed by this library is the HTTP quality value, whose
  674. // grammar is (RFC 9110 12.4.2):
  675. // qvalue = ( "0" [ "." 0*3DIGIT ] ) / ( "1" [ "." 0*3("0") ] )
  676. // i.e. a non-negative decimal with no sign, exponent, "inf"/"nan", or wide
  677. // magnitude. So this parser recognizes exactly 1*DIGIT [ "." *DIGIT ] with
  678. // '.' always the decimal separator (std::strtod would instead read it from the
  679. // global C locale, mis-parsing q-values once an embedder calls
  680. // setlocale(LC_ALL, "") into a comma-decimal locale). The caller range-checks
  681. // the result to [0, 1], so inputs outside that range need not be distinguished
  682. // here. Allocation-free, single pass, and free of the overflow/rounding edge
  683. // cases that exponent and wide-range handling would introduce.
  684. inline from_chars_result<double> from_chars(const char *first, const char *last,
  685. double &value) {
  686. value = 0.0;
  687. const char *p = first;
  688. // Each 1eN is exactly representable, so a single final division by the
  689. // matching entry yields a correctly-rounded result.
  690. static const double powers_of_ten[] = {
  691. 1e0, 1e1, 1e2, 1e3, 1e4, 1e5, 1e6, 1e7, 1e8, 1e9,
  692. 1e10, 1e11, 1e12, 1e13, 1e14, 1e15, 1e16, 1e17, 1e18};
  693. const int max_frac_digits =
  694. static_cast<int>(sizeof(powers_of_ten) / sizeof(powers_of_ten[0])) - 1;
  695. // Accumulate digits into a 64-bit integer and remember how many were
  696. // fractional. Two independent caps keep this bounded and safe:
  697. // * accumulation saturates before mantissa could overflow uint64_t, and
  698. // * frac_digits is capped at max_frac_digits so it is always a valid index
  699. // into powers_of_ten (without this an input like "0.000...0" would never
  700. // grow mantissa, so the saturation cap alone would not bound it).
  701. // Both caps only drop digits far beyond the precision a q-value needs; any
  702. // value they would change is well outside [0, 1] and rejected by the caller.
  703. uint64_t mantissa = 0;
  704. int frac_digits = 0;
  705. bool seen_digit = false;
  706. const uint64_t limit = ((std::numeric_limits<uint64_t>::max)() - 9) / 10;
  707. auto accumulate = [&](char c) {
  708. if (mantissa <= limit) {
  709. mantissa = mantissa * 10 + static_cast<uint64_t>(c - '0');
  710. return true;
  711. }
  712. return false;
  713. };
  714. for (; p != last && is_ascii_digit(*p); ++p) {
  715. seen_digit = true;
  716. accumulate(*p);
  717. }
  718. if (p != last && *p == '.') {
  719. ++p;
  720. for (; p != last && is_ascii_digit(*p); ++p) {
  721. seen_digit = true;
  722. if (frac_digits < max_frac_digits && accumulate(*p)) { ++frac_digits; }
  723. }
  724. }
  725. if (!seen_digit) { return {first, std::errc::invalid_argument}; }
  726. value = static_cast<double>(mantissa) / powers_of_ten[frac_digits];
  727. return {p, std::errc{}};
  728. }
  729. inline bool parse_int_in_range(const char *s, size_t len, int lo, int hi,
  730. int &out) {
  731. int val = 0;
  732. auto r = from_chars(s, s + len, val);
  733. if (r.ec != std::errc{} || r.ptr != s + len || val < lo || val > hi) {
  734. return false;
  735. }
  736. out = val;
  737. return true;
  738. }
  739. inline bool parse_port(const char *s, size_t len, int &port) {
  740. return parse_int_in_range(s, len, 1, 65535, port);
  741. }
  742. inline bool parse_port(const std::string &s, int &port) {
  743. return parse_port(s.data(), s.size(), port);
  744. }
  745. struct UrlComponents {
  746. std::string scheme;
  747. std::string host;
  748. std::string port;
  749. std::string path;
  750. std::string query;
  751. };
  752. inline bool parse_url(const std::string &url, UrlComponents &uc) {
  753. uc = {};
  754. size_t pos = 0;
  755. auto sep = url.find("://");
  756. if (sep != std::string::npos) {
  757. uc.scheme = url.substr(0, sep);
  758. // Scheme must be [a-z]+ only
  759. if (uc.scheme.empty()) { return false; }
  760. for (auto c : uc.scheme) {
  761. if (c < 'a' || c > 'z') { return false; }
  762. }
  763. pos = sep + 3;
  764. } else if (url.compare(0, 2, "//") == 0) {
  765. pos = 2;
  766. }
  767. auto has_authority_prefix = pos > 0;
  768. auto has_authority = has_authority_prefix || (!url.empty() && url[0] != '/' &&
  769. url[0] != '?' && url[0] != '#');
  770. if (has_authority) {
  771. // userinfo is not supported, and a backslash that some parsers take for
  772. // '/' would leave them seeing another host than this one.
  773. if (url.find_first_of("@\\", pos) < url.find_first_of("/?#", pos)) {
  774. return false;
  775. }
  776. if (pos < url.size() && url[pos] == '[') {
  777. auto close = url.find(']', pos);
  778. if (close == std::string::npos) { return false; }
  779. uc.host = url.substr(pos + 1, close - pos - 1);
  780. // IPv6 host must be [a-fA-F0-9:]+ only
  781. if (uc.host.empty()) { return false; }
  782. for (auto c : uc.host) {
  783. if (!(is_ascii_digit(c) || (c >= 'a' && c <= 'f') ||
  784. (c >= 'A' && c <= 'F') || c == ':')) {
  785. return false;
  786. }
  787. }
  788. pos = close + 1;
  789. // The IPv6 literal is the whole host, so ']' must be followed by a port,
  790. // path, query or fragment delimiter (or the end of input). Otherwise the
  791. // trailing bytes would be folded into the path while the connection
  792. // still targets the bracketed address.
  793. if (pos < url.size()) {
  794. auto c = url[pos];
  795. if (c != ':' && c != '/' && c != '?' && c != '#') { return false; }
  796. }
  797. } else {
  798. auto end = url.find_first_of(":/?#", pos);
  799. if (end == std::string::npos) { end = url.size(); }
  800. uc.host = url.substr(pos, end - pos);
  801. pos = end;
  802. }
  803. if (pos < url.size() && url[pos] == ':') {
  804. ++pos;
  805. auto end = url.find_first_of("/?#", pos);
  806. if (end == std::string::npos) { end = url.size(); }
  807. uc.port = url.substr(pos, end - pos);
  808. pos = end;
  809. }
  810. // Without :// or //, the entire input must be consumed as host[:port].
  811. // If there is leftover (path, query, etc.), this is not a valid
  812. // host[:port] string — clear and reparse as a plain path.
  813. if (!has_authority_prefix && pos < url.size()) {
  814. uc.host.clear();
  815. uc.port.clear();
  816. pos = 0;
  817. }
  818. }
  819. if (pos < url.size() && url[pos] != '?' && url[pos] != '#') {
  820. auto end = url.find_first_of("?#", pos);
  821. if (end == std::string::npos) { end = url.size(); }
  822. uc.path = url.substr(pos, end - pos);
  823. pos = end;
  824. }
  825. if (pos < url.size() && url[pos] == '?') {
  826. auto end = url.find('#', pos);
  827. if (end == std::string::npos) { end = url.size(); }
  828. uc.query = url.substr(pos, end - pos);
  829. }
  830. return true;
  831. }
  832. // Resolves a relative-path or query-only Location value against the path of
  833. // the request being redirected (RFC 3986 section 5.2). Absolute URIs and
  834. // references starting with '/' are returned unchanged.
  835. inline std::string resolve_relative_location(const std::string &location,
  836. const std::string &base) {
  837. if (location.empty() || location[0] == '/') { return location; }
  838. // A ':' in the first segment means the value has a scheme.
  839. if (location.find(':') < location.find_first_of("/?#")) { return location; }
  840. if (location[0] == '#') { return base.substr(0, base.find('#')) + location; }
  841. auto base_path = base.substr(0, base.find_first_of("?#"));
  842. if (location[0] == '?') { return base_path + location; }
  843. if (base_path.empty() || base_path[0] != '/') { base_path = "/"; }
  844. auto merged = base_path.substr(0, base_path.rfind('/') + 1) + location;
  845. // Remove "." and ".." segments from the merged path.
  846. auto path_end = (std::min)(merged.find_first_of("?#"), merged.size());
  847. std::string path;
  848. size_t i = 0;
  849. while (i < path_end) {
  850. auto next = (std::min)(merged.find('/', i + 1), path_end);
  851. auto segment = merged.substr(i + 1, next - i - 1);
  852. auto is_last = next == path_end;
  853. if (segment == "." || segment == "..") {
  854. if (segment == "..") {
  855. path.erase((std::min)(path.rfind('/'), path.size()));
  856. }
  857. if (is_last) { path += '/'; }
  858. } else {
  859. path += '/';
  860. path += segment;
  861. }
  862. i = next;
  863. }
  864. if (path.empty()) { path = "/"; }
  865. return path + merged.substr(path_end);
  866. }
  867. } // namespace detail
  868. enum class SSLVerifierResponse {
  869. // no decision has been made, use the built-in certificate verifier
  870. NoDecisionMade,
  871. // connection certificate is verified and accepted
  872. CertificateAccepted,
  873. // connection certificate was processed but is rejected
  874. CertificateRejected
  875. };
  876. // System CA loading policy for SSL clients. Auto (the default) loads system
  877. // CA certs only when no custom CA is configured; enable_system_ca() switches
  878. // to an explicit policy.
  879. enum class SystemCAMode { Auto, Enabled, Disabled };
  880. enum StatusCode {
  881. // Information responses
  882. Continue_100 = 100,
  883. SwitchingProtocol_101 = 101,
  884. Processing_102 = 102,
  885. EarlyHints_103 = 103,
  886. // Successful responses
  887. OK_200 = 200,
  888. Created_201 = 201,
  889. Accepted_202 = 202,
  890. NonAuthoritativeInformation_203 = 203,
  891. NoContent_204 = 204,
  892. ResetContent_205 = 205,
  893. PartialContent_206 = 206,
  894. MultiStatus_207 = 207,
  895. AlreadyReported_208 = 208,
  896. IMUsed_226 = 226,
  897. // Redirection messages
  898. MultipleChoices_300 = 300,
  899. MovedPermanently_301 = 301,
  900. Found_302 = 302,
  901. SeeOther_303 = 303,
  902. NotModified_304 = 304,
  903. UseProxy_305 = 305,
  904. unused_306 = 306,
  905. TemporaryRedirect_307 = 307,
  906. PermanentRedirect_308 = 308,
  907. // Client error responses
  908. BadRequest_400 = 400,
  909. Unauthorized_401 = 401,
  910. PaymentRequired_402 = 402,
  911. Forbidden_403 = 403,
  912. NotFound_404 = 404,
  913. MethodNotAllowed_405 = 405,
  914. NotAcceptable_406 = 406,
  915. ProxyAuthenticationRequired_407 = 407,
  916. RequestTimeout_408 = 408,
  917. Conflict_409 = 409,
  918. Gone_410 = 410,
  919. LengthRequired_411 = 411,
  920. PreconditionFailed_412 = 412,
  921. PayloadTooLarge_413 = 413,
  922. UriTooLong_414 = 414,
  923. UnsupportedMediaType_415 = 415,
  924. RangeNotSatisfiable_416 = 416,
  925. ExpectationFailed_417 = 417,
  926. ImATeapot_418 = 418,
  927. MisdirectedRequest_421 = 421,
  928. UnprocessableContent_422 = 422,
  929. Locked_423 = 423,
  930. FailedDependency_424 = 424,
  931. TooEarly_425 = 425,
  932. UpgradeRequired_426 = 426,
  933. PreconditionRequired_428 = 428,
  934. TooManyRequests_429 = 429,
  935. RequestHeaderFieldsTooLarge_431 = 431,
  936. UnavailableForLegalReasons_451 = 451,
  937. // Server error responses
  938. InternalServerError_500 = 500,
  939. NotImplemented_501 = 501,
  940. BadGateway_502 = 502,
  941. ServiceUnavailable_503 = 503,
  942. GatewayTimeout_504 = 504,
  943. HttpVersionNotSupported_505 = 505,
  944. VariantAlsoNegotiates_506 = 506,
  945. InsufficientStorage_507 = 507,
  946. LoopDetected_508 = 508,
  947. NotExtended_510 = 510,
  948. NetworkAuthenticationRequired_511 = 511,
  949. };
  950. namespace detail {
  951. // A multimap that keeps its entries in the order they were inserted.
  952. //
  953. // HTTP needs that order in two places. RFC 9110 5.3 makes the order of header
  954. // fields sharing a field name significant and forbids a proxy from reordering
  955. // them, and a query string's parameters are meaningful in the order the caller
  956. // wrote them. Neither standard container expresses it: std::unordered_multimap
  957. // gives no ordering guarantee at all for equivalent keys (libstdc++ yields
  958. // reverse insertion order, libc++ insertion order), and std::multimap sorts by
  959. // key, which would drop control data such as Host behind whatever else the
  960. // message carries and alphabetise a query string.
  961. //
  962. // Entries are therefore kept in a flat vector, in order. Lookup is a linear
  963. // scan, which beats hashing for the handful of entries a message carries
  964. // (headers are capped at CPPHTTPLIB_HEADER_MAX_COUNT).
  965. //
  966. // KeyEqual compares keys; it is what makes Headers case-insensitive and
  967. // Params, whose parameter names are case-sensitive, not.
  968. template <typename Mapped, typename KeyEqual> class insertion_ordered_multimap {
  969. public:
  970. using key_type = std::string;
  971. using mapped_type = Mapped;
  972. using value_type = std::pair<std::string, Mapped>;
  973. using size_type = std::size_t;
  974. using difference_type = std::ptrdiff_t;
  975. using reference = value_type &;
  976. using const_reference = const value_type &;
  977. private:
  978. static size_type npos() { return static_cast<size_type>(-1); }
  979. static bool keys_equal(const std::string &a, const std::string &b) {
  980. return KeyEqual()(a, b);
  981. }
  982. // Iterating yields every entry in insertion order, but equal_range() and
  983. // find() have to walk only the entries sharing one key, which are not
  984. // adjacent. Both are the same iterator type: key_idx_ selects between the
  985. // two traversals, and since equality compares only the position, an iterator
  986. // restricted to one key still compares equal to end().
  987. template <typename V> class iterator_t {
  988. public:
  989. using iterator_category = std::bidirectional_iterator_tag;
  990. using value_type = insertion_ordered_multimap::value_type;
  991. using difference_type = insertion_ordered_multimap::difference_type;
  992. using pointer = V *;
  993. using reference = V &;
  994. iterator_t() : data_(nullptr), idx_(0), size_(0), key_idx_(npos()) {}
  995. template <typename U,
  996. typename std::enable_if<std::is_convertible<U *, V *>::value,
  997. int>::type = 0>
  998. iterator_t(const iterator_t<U> &rhs)
  999. : data_(rhs.data_), idx_(rhs.idx_), size_(rhs.size_),
  1000. key_idx_(rhs.key_idx_) {}
  1001. reference operator*() const { return data_[idx_]; }
  1002. pointer operator->() const { return data_ + idx_; }
  1003. iterator_t &operator++() {
  1004. // Saturating, so that advancing past the last entry of a key stays at
  1005. // end() instead of running off the container.
  1006. if (idx_ >= size_) { return *this; }
  1007. ++idx_;
  1008. if (key_idx_ != npos()) {
  1009. while (idx_ < size_ && !matches(idx_)) {
  1010. ++idx_;
  1011. }
  1012. }
  1013. return *this;
  1014. }
  1015. iterator_t operator++(int) {
  1016. auto tmp = *this;
  1017. ++*this;
  1018. return tmp;
  1019. }
  1020. iterator_t &operator--() {
  1021. if (idx_ == 0) { return *this; }
  1022. --idx_;
  1023. if (key_idx_ != npos()) {
  1024. while (idx_ > 0 && !matches(idx_)) {
  1025. --idx_;
  1026. }
  1027. }
  1028. return *this;
  1029. }
  1030. iterator_t operator--(int) {
  1031. auto tmp = *this;
  1032. --*this;
  1033. return tmp;
  1034. }
  1035. template <typename U> bool operator==(const iterator_t<U> &rhs) const {
  1036. return idx_ == rhs.idx_;
  1037. }
  1038. template <typename U> bool operator!=(const iterator_t<U> &rhs) const {
  1039. return idx_ != rhs.idx_;
  1040. }
  1041. private:
  1042. friend class insertion_ordered_multimap;
  1043. template <typename> friend class iterator_t;
  1044. iterator_t(V *data, size_type idx, size_type size, size_type key_idx)
  1045. : data_(data), idx_(idx), size_(size), key_idx_(key_idx) {}
  1046. bool matches(size_type i) const {
  1047. return keys_equal(data_[i].first, data_[key_idx_].first);
  1048. }
  1049. V *data_;
  1050. size_type idx_;
  1051. size_type size_;
  1052. size_type key_idx_;
  1053. };
  1054. public:
  1055. using iterator = iterator_t<value_type>;
  1056. using const_iterator = iterator_t<const value_type>;
  1057. insertion_ordered_multimap() = default;
  1058. insertion_ordered_multimap(std::initializer_list<value_type> il)
  1059. : entries_(il) {}
  1060. template <typename InputIt>
  1061. insertion_ordered_multimap(InputIt first, InputIt last)
  1062. : entries_(first, last) {}
  1063. iterator begin() { return make_iter(0, npos()); }
  1064. iterator end() { return make_iter(entries_.size(), npos()); }
  1065. const_iterator begin() const { return make_citer(0, npos()); }
  1066. const_iterator end() const { return make_citer(entries_.size(), npos()); }
  1067. const_iterator cbegin() const { return begin(); }
  1068. const_iterator cend() const { return end(); }
  1069. bool empty() const { return entries_.empty(); }
  1070. size_type size() const { return entries_.size(); }
  1071. void clear() { entries_.clear(); }
  1072. void swap(insertion_ordered_multimap &rhs) { entries_.swap(rhs.entries_); }
  1073. iterator insert(const value_type &val) {
  1074. entries_.push_back(val);
  1075. return make_iter(entries_.size() - 1, npos());
  1076. }
  1077. iterator insert(value_type &&val) {
  1078. entries_.push_back(std::move(val));
  1079. return make_iter(entries_.size() - 1, npos());
  1080. }
  1081. template <typename... Args> iterator emplace(Args &&...args) {
  1082. entries_.emplace_back(std::forward<Args>(args)...);
  1083. return make_iter(entries_.size() - 1, npos());
  1084. }
  1085. // For entries that have to lead the message, such as the Host header field
  1086. // (RFC 9110 5.3 recommends sending control data first).
  1087. template <typename... Args> iterator emplace_front(Args &&...args) {
  1088. entries_.emplace(entries_.begin(), std::forward<Args>(args)...);
  1089. return make_iter(0, npos());
  1090. }
  1091. iterator find(const std::string &key) {
  1092. auto i = index_of(key);
  1093. return i == npos() ? end() : make_iter(i, i);
  1094. }
  1095. const_iterator find(const std::string &key) const {
  1096. auto i = index_of(key);
  1097. return i == npos() ? end() : make_citer(i, i);
  1098. }
  1099. size_type count(const std::string &key) const {
  1100. size_type n = 0;
  1101. for (const auto &entry : entries_) {
  1102. if (keys_equal(entry.first, key)) { n++; }
  1103. }
  1104. return n;
  1105. }
  1106. std::pair<iterator, iterator> equal_range(const std::string &key) {
  1107. auto i = index_of(key);
  1108. return i == npos() ? std::make_pair(end(), end())
  1109. : std::make_pair(make_iter(i, i), end());
  1110. }
  1111. std::pair<const_iterator, const_iterator>
  1112. equal_range(const std::string &key) const {
  1113. auto i = index_of(key);
  1114. return i == npos() ? std::make_pair(end(), end())
  1115. : std::make_pair(make_citer(i, i), end());
  1116. }
  1117. size_type erase(const std::string &key) {
  1118. auto before = entries_.size();
  1119. entries_.erase(std::remove_if(entries_.begin(), entries_.end(),
  1120. [&](const value_type &entry) {
  1121. return keys_equal(entry.first, key);
  1122. }),
  1123. entries_.end());
  1124. return before - entries_.size();
  1125. }
  1126. iterator erase(const_iterator pos) {
  1127. entries_.erase(entries_.begin() + static_cast<difference_type>(pos.idx_));
  1128. return make_iter(pos.idx_, npos());
  1129. }
  1130. // Erases what iterating [first, last) would actually visit, so erasing an
  1131. // equal_range() removes only the entries with that key, not everything
  1132. // positioned between them.
  1133. iterator erase(const_iterator first, const_iterator last) {
  1134. auto from = first.idx_;
  1135. auto to = last.idx_;
  1136. if (from >= to) { return make_iter(from, npos()); }
  1137. auto begin_it = entries_.begin();
  1138. auto from_it = begin_it + static_cast<difference_type>(from);
  1139. auto to_it = begin_it + static_cast<difference_type>(to);
  1140. if (first.key_idx_ == npos()) {
  1141. entries_.erase(from_it, to_it);
  1142. } else {
  1143. auto key = entries_[first.key_idx_].first;
  1144. auto keep = from_it;
  1145. for (auto it = from_it; it != to_it; ++it) {
  1146. if (!keys_equal(it->first, key)) {
  1147. if (keep != it) { *keep = std::move(*it); }
  1148. ++keep;
  1149. }
  1150. }
  1151. if (keep != to_it) {
  1152. keep = std::move(to_it, entries_.end(), keep);
  1153. } else {
  1154. keep = entries_.end();
  1155. }
  1156. entries_.erase(keep, entries_.end());
  1157. }
  1158. return make_iter(from, npos());
  1159. }
  1160. friend bool operator==(const insertion_ordered_multimap &lhs,
  1161. const insertion_ordered_multimap &rhs) {
  1162. return lhs.entries_ == rhs.entries_;
  1163. }
  1164. friend bool operator!=(const insertion_ordered_multimap &lhs,
  1165. const insertion_ordered_multimap &rhs) {
  1166. return !(lhs == rhs);
  1167. }
  1168. private:
  1169. size_type index_of(const std::string &key) const {
  1170. for (size_type i = 0; i < entries_.size(); i++) {
  1171. if (keys_equal(entries_[i].first, key)) { return i; }
  1172. }
  1173. return npos();
  1174. }
  1175. iterator make_iter(size_type idx, size_type key_idx) {
  1176. return iterator(entries_.data(), idx, entries_.size(), key_idx);
  1177. }
  1178. const_iterator make_citer(size_type idx, size_type key_idx) const {
  1179. return const_iterator(entries_.data(), idx, entries_.size(), key_idx);
  1180. }
  1181. std::vector<value_type> entries_;
  1182. };
  1183. } // namespace detail
  1184. using Headers =
  1185. detail::insertion_ordered_multimap<std::string,
  1186. detail::case_ignore::equal_to>;
  1187. // Query parameter names are case-sensitive, unlike header field names.
  1188. using Params =
  1189. detail::insertion_ordered_multimap<std::string, std::equal_to<std::string>>;
  1190. using Match = std::smatch;
  1191. using DownloadProgress = std::function<bool(size_t current, size_t total)>;
  1192. using UploadProgress = std::function<bool(size_t current, size_t total)>;
  1193. /*
  1194. * detail: type-erased storage used by UserData.
  1195. * ABI-stable regardless of C++ standard — always uses this custom
  1196. * implementation instead of std::any.
  1197. */
  1198. namespace detail {
  1199. using any_type_id = const void *;
  1200. template <typename T> any_type_id any_typeid() noexcept {
  1201. static const char id = 0;
  1202. return &id;
  1203. }
  1204. struct any_storage {
  1205. virtual ~any_storage() = default;
  1206. virtual std::unique_ptr<any_storage> clone() const = 0;
  1207. virtual any_type_id type_id() const noexcept = 0;
  1208. };
  1209. template <typename T> struct any_value final : any_storage {
  1210. T value;
  1211. template <typename U> explicit any_value(U &&v) : value(std::forward<U>(v)) {}
  1212. std::unique_ptr<any_storage> clone() const override {
  1213. return std::unique_ptr<any_storage>(new any_value<T>(value));
  1214. }
  1215. any_type_id type_id() const noexcept override { return any_typeid<T>(); }
  1216. };
  1217. } // namespace detail
  1218. class UserData {
  1219. public:
  1220. UserData() = default;
  1221. UserData(UserData &&) noexcept = default;
  1222. UserData &operator=(UserData &&) noexcept = default;
  1223. UserData(const UserData &o) {
  1224. for (const auto &e : o.entries_) {
  1225. if (e.second) { entries_[e.first] = e.second->clone(); }
  1226. }
  1227. }
  1228. UserData &operator=(const UserData &o) {
  1229. if (this != &o) {
  1230. entries_.clear();
  1231. for (const auto &e : o.entries_) {
  1232. if (e.second) { entries_[e.first] = e.second->clone(); }
  1233. }
  1234. }
  1235. return *this;
  1236. }
  1237. template <typename T> void set(const std::string &key, T &&value) {
  1238. using D = typename std::decay<T>::type;
  1239. entries_[key].reset(new detail::any_value<D>(std::forward<T>(value)));
  1240. }
  1241. template <typename T> T *get(const std::string &key) noexcept {
  1242. auto it = entries_.find(key);
  1243. if (it == entries_.end() || !it->second) { return nullptr; }
  1244. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1245. return &static_cast<detail::any_value<T> *>(it->second.get())->value;
  1246. }
  1247. template <typename T> const T *get(const std::string &key) const noexcept {
  1248. auto it = entries_.find(key);
  1249. if (it == entries_.end() || !it->second) { return nullptr; }
  1250. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1251. return &static_cast<const detail::any_value<T> *>(it->second.get())->value;
  1252. }
  1253. bool has(const std::string &key) const noexcept {
  1254. return entries_.find(key) != entries_.end();
  1255. }
  1256. void erase(const std::string &key) { entries_.erase(key); }
  1257. void clear() noexcept { entries_.clear(); }
  1258. private:
  1259. std::unordered_map<std::string, std::unique_ptr<detail::any_storage>>
  1260. entries_;
  1261. };
  1262. struct Response;
  1263. using ResponseHandler = std::function<bool(const Response &response)>;
  1264. struct FormData {
  1265. std::string name;
  1266. std::string content;
  1267. std::string filename;
  1268. std::string content_type;
  1269. Headers headers;
  1270. };
  1271. struct FormField {
  1272. std::string name;
  1273. std::string content;
  1274. Headers headers;
  1275. };
  1276. // RFC 7578 5.2: a form processor "SHOULD send back results in order" and
  1277. // "Intermediaries MUST NOT reorder the results", so a handler walking these
  1278. // should see the parts as they were sent. A std::multimap sorts by field name
  1279. // and loses that. Field names are case-sensitive, hence std::equal_to rather
  1280. // than the case-insensitive predicate Headers uses.
  1281. using FormFields =
  1282. detail::insertion_ordered_multimap<FormField, std::equal_to<std::string>>;
  1283. using FormFiles =
  1284. detail::insertion_ordered_multimap<FormData, std::equal_to<std::string>>;
  1285. struct MultipartFormData {
  1286. FormFields fields; // Text fields from multipart
  1287. FormFiles files; // Files from multipart
  1288. // Text field access
  1289. std::string get_field(const std::string &key, size_t id = 0) const;
  1290. std::vector<std::string> get_fields(const std::string &key) const;
  1291. bool has_field(const std::string &key) const;
  1292. size_t get_field_count(const std::string &key) const;
  1293. // File access
  1294. FormData get_file(const std::string &key, size_t id = 0) const;
  1295. std::vector<FormData> get_files(const std::string &key) const;
  1296. bool has_file(const std::string &key) const;
  1297. size_t get_file_count(const std::string &key) const;
  1298. };
  1299. struct UploadFormData {
  1300. std::string name;
  1301. std::string content;
  1302. std::string filename;
  1303. std::string content_type;
  1304. };
  1305. using UploadFormDataItems = std::vector<UploadFormData>;
  1306. class DataSink {
  1307. public:
  1308. DataSink() : os(&sb_), sb_(*this) {}
  1309. DataSink(const DataSink &) = delete;
  1310. DataSink &operator=(const DataSink &) = delete;
  1311. DataSink(DataSink &&) = delete;
  1312. DataSink &operator=(DataSink &&) = delete;
  1313. std::function<bool(const char *data, size_t data_len)> write;
  1314. // Only `write` is mandatory. The rest are defaulted so that a provider
  1315. // calling one on a writer that does not set it gets sensible behaviour
  1316. // rather than std::bad_function_call thrown from a worker thread. Capturing
  1317. // `this` is safe: DataSink is neither copyable nor movable.
  1318. std::function<bool()> is_writable = []() { return true; };
  1319. std::function<void()> done = []() {};
  1320. std::function<void(const Headers &trailer)> done_with_trailer =
  1321. [this](const Headers & /*trailer*/) { done(); };
  1322. std::ostream os;
  1323. private:
  1324. class data_sink_streambuf final : public std::streambuf {
  1325. public:
  1326. explicit data_sink_streambuf(DataSink &sink) : sink_(sink) {}
  1327. protected:
  1328. std::streamsize xsputn(const char *s, std::streamsize n) override {
  1329. if (sink_.write(s, static_cast<size_t>(n))) { return n; }
  1330. return 0;
  1331. }
  1332. private:
  1333. DataSink &sink_;
  1334. };
  1335. data_sink_streambuf sb_;
  1336. };
  1337. using ContentProvider =
  1338. std::function<bool(size_t offset, size_t length, DataSink &sink)>;
  1339. using ContentProviderWithoutLength =
  1340. std::function<bool(size_t offset, DataSink &sink)>;
  1341. using ContentProviderResourceReleaser = std::function<void(bool success)>;
  1342. struct FormDataProvider {
  1343. std::string name;
  1344. ContentProviderWithoutLength provider;
  1345. std::string filename;
  1346. std::string content_type;
  1347. };
  1348. using FormDataProviderItems = std::vector<FormDataProvider>;
  1349. inline FormDataProvider
  1350. make_file_provider(const std::string &name, const std::string &filepath,
  1351. const std::string &filename = std::string(),
  1352. const std::string &content_type = std::string()) {
  1353. FormDataProvider fdp;
  1354. fdp.name = name;
  1355. fdp.filename = filename.empty() ? filepath : filename;
  1356. fdp.content_type = content_type;
  1357. fdp.provider = [filepath](size_t offset, DataSink &sink) -> bool {
  1358. std::ifstream f(filepath, std::ios::binary);
  1359. if (!f) { return false; }
  1360. if (offset > 0) {
  1361. f.seekg(static_cast<std::streamoff>(offset));
  1362. if (!f.good()) {
  1363. sink.done();
  1364. return true;
  1365. }
  1366. }
  1367. char buf[8192];
  1368. f.read(buf, sizeof(buf));
  1369. auto n = static_cast<size_t>(f.gcount());
  1370. if (n > 0) { return sink.write(buf, n); }
  1371. sink.done(); // EOF
  1372. return true;
  1373. };
  1374. return fdp;
  1375. }
  1376. inline std::pair<size_t, ContentProvider>
  1377. make_file_body(const std::string &filepath) {
  1378. size_t size = 0;
  1379. {
  1380. std::ifstream f(filepath, std::ios::binary | std::ios::ate);
  1381. if (!f) { return {0, ContentProvider{}}; }
  1382. size = static_cast<size_t>(f.tellg());
  1383. }
  1384. ContentProvider provider = [filepath](size_t offset, size_t length,
  1385. DataSink &sink) -> bool {
  1386. std::ifstream f(filepath, std::ios::binary);
  1387. if (!f) { return false; }
  1388. f.seekg(static_cast<std::streamoff>(offset));
  1389. if (!f.good()) { return false; }
  1390. char buf[8192];
  1391. while (length > 0) {
  1392. auto to_read = (std::min)(sizeof(buf), length);
  1393. f.read(buf, static_cast<std::streamsize>(to_read));
  1394. auto n = static_cast<size_t>(f.gcount());
  1395. // The file is shorter than the size make_file_body() measured, which the
  1396. // caller has already committed to as Content-Length. The body cannot be
  1397. // completed, so fail as every other error here does.
  1398. if (n == 0) { return false; }
  1399. if (!sink.write(buf, n)) { return false; }
  1400. length -= n;
  1401. }
  1402. return true;
  1403. };
  1404. return {size, std::move(provider)};
  1405. }
  1406. using ContentReceiverWithProgress = std::function<bool(
  1407. const char *data, size_t data_length, size_t offset, size_t total_length)>;
  1408. using ContentReceiver =
  1409. std::function<bool(const char *data, size_t data_length)>;
  1410. using FormDataHeader = std::function<bool(const FormData &file)>;
  1411. class ContentReader {
  1412. public:
  1413. using Reader = std::function<bool(ContentReceiver receiver)>;
  1414. using FormDataReader =
  1415. std::function<bool(FormDataHeader header, ContentReceiver receiver)>;
  1416. ContentReader(Reader reader, FormDataReader multipart_reader)
  1417. : reader_(std::move(reader)),
  1418. formdata_reader_(std::move(multipart_reader)) {}
  1419. bool operator()(FormDataHeader header, ContentReceiver receiver) const {
  1420. return formdata_reader_(std::move(header), std::move(receiver));
  1421. }
  1422. bool operator()(ContentReceiver receiver) const {
  1423. return reader_(std::move(receiver));
  1424. }
  1425. Reader reader_;
  1426. FormDataReader formdata_reader_;
  1427. };
  1428. using Range = std::pair<ssize_t, ssize_t>;
  1429. using Ranges = std::vector<Range>;
  1430. #ifdef CPPHTTPLIB_SSL_ENABLED
  1431. // TLS abstraction layer - public type definitions and API
  1432. namespace tls {
  1433. // Opaque handles (defined as void* for abstraction)
  1434. using ctx_t = void *;
  1435. using session_t = void *;
  1436. using const_session_t = const void *; // For read-only session access
  1437. using cert_t = void *;
  1438. using ca_store_t = void *;
  1439. // TLS versions
  1440. enum class Version {
  1441. TLS1_2 = 0x0303,
  1442. TLS1_3 = 0x0304,
  1443. };
  1444. // Subject Alternative Names (SAN) entry types
  1445. enum class SanType { DNS, IP, EMAIL, URI, OTHER };
  1446. // SAN entry structure
  1447. struct SanEntry {
  1448. SanType type;
  1449. std::string value;
  1450. };
  1451. // Verification context for certificate verification callback
  1452. struct VerifyContext {
  1453. session_t session; // TLS session handle
  1454. cert_t cert; // Current certificate being verified
  1455. int depth; // Certificate chain depth (0 = leaf)
  1456. bool preverify_ok; // OpenSSL/Mbed TLS pre-verification result
  1457. long error_code; // Backend-specific error code (0 = no error)
  1458. const char *error_string; // Human-readable error description
  1459. // Certificate introspection methods
  1460. std::string subject_cn() const;
  1461. std::string issuer_name() const;
  1462. bool check_hostname(const char *hostname) const;
  1463. std::vector<SanEntry> sans() const;
  1464. bool validity(time_t &not_before, time_t &not_after) const;
  1465. std::string serial() const;
  1466. };
  1467. using VerifyCallback = std::function<bool(const VerifyContext &ctx)>;
  1468. // TlsError codes for TLS operations (backend-independent)
  1469. enum class ErrorCode : int {
  1470. Success = 0,
  1471. WantRead, // Non-blocking: need to wait for read
  1472. WantWrite, // Non-blocking: need to wait for write
  1473. PeerClosed, // Peer closed the connection
  1474. Fatal, // Unrecoverable error
  1475. SyscallError, // System call error (check sys_errno)
  1476. CertVerifyFailed, // Certificate verification failed
  1477. HostnameMismatch, // Hostname verification failed
  1478. };
  1479. // TLS error information
  1480. struct TlsError {
  1481. ErrorCode code = ErrorCode::Fatal;
  1482. uint64_t backend_code = 0; // OpenSSL: ERR_get_error(), mbedTLS: return value
  1483. int sys_errno = 0; // errno when SyscallError
  1484. // Convert verification error code to human-readable string
  1485. static std::string verify_error_to_string(long error_code);
  1486. };
  1487. // RAII wrapper for peer certificate
  1488. class PeerCert {
  1489. public:
  1490. PeerCert();
  1491. PeerCert(PeerCert &&other) noexcept;
  1492. PeerCert &operator=(PeerCert &&other) noexcept;
  1493. ~PeerCert();
  1494. PeerCert(const PeerCert &) = delete;
  1495. PeerCert &operator=(const PeerCert &) = delete;
  1496. explicit operator bool() const;
  1497. std::string subject_cn() const;
  1498. std::string issuer_name() const;
  1499. bool check_hostname(const char *hostname) const;
  1500. std::vector<SanEntry> sans() const;
  1501. bool validity(time_t &not_before, time_t &not_after) const;
  1502. std::string serial() const;
  1503. private:
  1504. explicit PeerCert(cert_t cert);
  1505. cert_t cert_ = nullptr;
  1506. friend PeerCert get_peer_cert_from_session(const_session_t session);
  1507. };
  1508. // Callback for TLS context setup (used by SSLServer constructor)
  1509. using ContextSetupCallback = std::function<bool(ctx_t ctx)>;
  1510. } // namespace tls
  1511. #endif
  1512. struct Request {
  1513. std::string method;
  1514. std::string path;
  1515. std::string matched_route;
  1516. Params params;
  1517. Headers headers;
  1518. Headers trailers;
  1519. std::string body;
  1520. std::string remote_addr;
  1521. int remote_port = -1;
  1522. std::string local_addr;
  1523. int local_port = -1;
  1524. // for server
  1525. std::string version;
  1526. std::string target;
  1527. MultipartFormData form;
  1528. Ranges ranges;
  1529. Match matches;
  1530. std::unordered_map<std::string, std::string> path_params;
  1531. std::function<bool()> is_connection_closed = []() { return true; };
  1532. // for client
  1533. std::vector<std::string> accept_content_types;
  1534. ResponseHandler response_handler;
  1535. ContentReceiverWithProgress content_receiver;
  1536. DownloadProgress download_progress;
  1537. UploadProgress upload_progress;
  1538. bool has_header(const std::string &key) const;
  1539. std::string get_header_value(const std::string &key, const char *def = "",
  1540. size_t id = 0) const;
  1541. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1542. size_t id = 0) const;
  1543. size_t get_header_value_count(const std::string &key) const;
  1544. void set_header(const std::string &key, const std::string &val);
  1545. bool has_trailer(const std::string &key) const;
  1546. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1547. size_t get_trailer_value_count(const std::string &key) const;
  1548. bool has_param(const std::string &key) const;
  1549. std::string get_param_value(const std::string &key, size_t id = 0) const;
  1550. std::vector<std::string> get_param_values(const std::string &key) const;
  1551. size_t get_param_value_count(const std::string &key) const;
  1552. bool is_multipart_form_data() const;
  1553. // private members...
  1554. bool body_read_started_ = false;
  1555. bool body_consumed_ = false;
  1556. bool expect_100_continue_pending_ = false;
  1557. size_t redirect_count_ = CPPHTTPLIB_REDIRECT_MAX_COUNT;
  1558. size_t content_length_ = 0;
  1559. ContentProvider content_provider_;
  1560. bool is_chunked_content_provider_ = false;
  1561. size_t authorization_count_ = 0;
  1562. std::chrono::time_point<std::chrono::steady_clock> start_time_ =
  1563. (std::chrono::steady_clock::time_point::min)();
  1564. #ifdef CPPHTTPLIB_SSL_ENABLED
  1565. tls::const_session_t ssl = nullptr;
  1566. tls::PeerCert peer_cert() const;
  1567. std::string sni() const;
  1568. #endif
  1569. };
  1570. namespace detail {
  1571. // Declared up here, away from the rest of the compression helpers, because
  1572. // `Response` stores one.
  1573. enum class EncodingType { None = 0, Gzip, Brotli, Zstd };
  1574. } // namespace detail
  1575. struct Response {
  1576. std::string version;
  1577. int status = -1;
  1578. std::string reason;
  1579. Headers headers;
  1580. Headers trailers;
  1581. std::string body;
  1582. std::string location; // Redirect location
  1583. // User-defined context — set by pre-routing/pre-request handlers and read
  1584. // by route handlers to pass arbitrary data (e.g. decoded auth tokens).
  1585. UserData user_data;
  1586. bool has_header(const std::string &key) const;
  1587. std::string get_header_value(const std::string &key, const char *def = "",
  1588. size_t id = 0) const;
  1589. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1590. size_t id = 0) const;
  1591. size_t get_header_value_count(const std::string &key) const;
  1592. void set_header(const std::string &key, const std::string &val);
  1593. bool has_trailer(const std::string &key) const;
  1594. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1595. size_t get_trailer_value_count(const std::string &key) const;
  1596. void set_redirect(const std::string &url, int status = StatusCode::Found_302);
  1597. void set_content(const char *s, size_t n, const std::string &content_type);
  1598. void set_content(const std::string &s, const std::string &content_type);
  1599. void set_content(std::string &&s, const std::string &content_type);
  1600. void set_content_provider(
  1601. size_t length, const std::string &content_type, ContentProvider provider,
  1602. ContentProviderResourceReleaser resource_releaser = nullptr);
  1603. void set_content_provider(
  1604. const std::string &content_type, ContentProviderWithoutLength provider,
  1605. ContentProviderResourceReleaser resource_releaser = nullptr);
  1606. void set_chunked_content_provider(
  1607. const std::string &content_type, ContentProviderWithoutLength provider,
  1608. ContentProviderResourceReleaser resource_releaser = nullptr);
  1609. void set_file_content(const std::string &path,
  1610. const std::string &content_type);
  1611. void set_file_content(const std::string &path);
  1612. Response() = default;
  1613. Response(const Response &) = default;
  1614. Response &operator=(const Response &) = default;
  1615. Response(Response &&) = default;
  1616. Response &operator=(Response &&) = default;
  1617. ~Response() {
  1618. if (content_provider_resource_releaser_) {
  1619. content_provider_resource_releaser_(content_provider_success_);
  1620. }
  1621. }
  1622. // private members...
  1623. size_t content_length_ = 0;
  1624. ContentProvider content_provider_;
  1625. ContentProviderResourceReleaser content_provider_resource_releaser_;
  1626. bool is_chunked_content_provider_ = false;
  1627. bool is_file_content_provider_ = false;
  1628. bool content_provider_success_ = false;
  1629. std::string file_content_path_;
  1630. std::string file_content_content_type_;
  1631. // Content coding chosen for the response body, decided once so that the
  1632. // headers and the body cannot disagree: where the file is opened for a
  1633. // file-backed content provider (keeping the ETag honest), and in
  1634. // `apply_ranges()` for a chunked content provider. `EncodingType::None`
  1635. // for every other kind of response.
  1636. detail::EncodingType content_coding_ = detail::EncodingType::None;
  1637. };
  1638. enum class Error {
  1639. Success = 0,
  1640. Unknown,
  1641. Connection,
  1642. BindIPAddress,
  1643. Read,
  1644. Write,
  1645. ExceedRedirectCount,
  1646. Canceled,
  1647. SSLConnection,
  1648. SSLLoadingCerts,
  1649. SSLServerVerification,
  1650. SSLServerHostnameVerification,
  1651. UnsupportedMultipartBoundaryChars,
  1652. Compression,
  1653. ConnectionTimeout,
  1654. ProxyConnection,
  1655. ConnectionClosed,
  1656. Timeout,
  1657. ResourceExhaustion,
  1658. TooManyFormDataFiles,
  1659. ExceedMaxPayloadSize,
  1660. ExceedUriMaxLength,
  1661. ExceedMaxSocketDescriptorCount,
  1662. InvalidRequestLine,
  1663. InvalidHTTPMethod,
  1664. InvalidHTTPVersion,
  1665. InvalidHeaders,
  1666. MultipartParsing,
  1667. OpenFile,
  1668. Listen,
  1669. GetSockName,
  1670. UnsupportedAddressFamily,
  1671. HTTPParsing,
  1672. InvalidRangeHeader,
  1673. UnsupportedContentEncoding,
  1674. WebSocketHandshake,
  1675. UserCallbackException,
  1676. // For internal use only
  1677. SSLPeerCouldBeClosed_,
  1678. };
  1679. std::string to_string(Error error);
  1680. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1681. class Stream {
  1682. public:
  1683. virtual ~Stream() = default;
  1684. virtual bool is_readable() const = 0;
  1685. virtual bool wait_readable() const = 0;
  1686. virtual bool wait_writable() const = 0;
  1687. virtual bool is_peer_alive() const { return wait_writable(); }
  1688. virtual ssize_t read(char *ptr, size_t size) = 0;
  1689. virtual ssize_t write(const char *ptr, size_t size) = 0;
  1690. virtual void get_remote_ip_and_port(std::string &ip, int &port) const = 0;
  1691. virtual void get_local_ip_and_port(std::string &ip, int &port) const = 0;
  1692. virtual socket_t socket() const = 0;
  1693. virtual time_t duration() const = 0;
  1694. virtual void set_read_timeout(time_t sec, time_t usec = 0) {
  1695. (void)sec;
  1696. (void)usec;
  1697. }
  1698. // Bounds the reads from now on to `msec` in total, on top of the timeout of
  1699. // each one. 0 lifts the bound.
  1700. virtual void set_max_timeout(time_t msec) { (void)msec; }
  1701. // Bytes already pulled off the socket and sitting in this stream's own
  1702. // buffer. Exposing them lets a line reader scan for a terminator in one
  1703. // pass instead of asking for a byte at a time. A stream that does no
  1704. // buffering of its own reports none, and readers fall back to read().
  1705. virtual const char *buffered_data(size_t &size) const {
  1706. size = 0;
  1707. return nullptr;
  1708. }
  1709. // Discards `size` bytes previously returned by buffered_data().
  1710. virtual void consume_buffered(size_t size) { (void)size; }
  1711. ssize_t write(const char *ptr);
  1712. ssize_t write(const std::string &s);
  1713. Error get_error() const { return error_; }
  1714. protected:
  1715. Error error_ = Error::Success;
  1716. };
  1717. class TaskQueue {
  1718. public:
  1719. TaskQueue() = default;
  1720. virtual ~TaskQueue() = default;
  1721. virtual bool enqueue(std::function<void()> fn) = 0;
  1722. virtual void shutdown() = 0;
  1723. virtual void on_idle() {}
  1724. };
  1725. class ThreadPool final : public TaskQueue {
  1726. public:
  1727. explicit ThreadPool(
  1728. size_t n, size_t max_n = 0, size_t mqr = 0,
  1729. time_t idle_timeout_sec = CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT);
  1730. ThreadPool(const ThreadPool &) = delete;
  1731. ~ThreadPool() override = default;
  1732. bool enqueue(std::function<void()> fn) override;
  1733. void shutdown() override;
  1734. private:
  1735. void worker(bool is_dynamic);
  1736. void move_to_finished(std::thread::id id);
  1737. void cleanup_finished_threads();
  1738. size_t base_thread_count_;
  1739. size_t max_thread_count_;
  1740. size_t max_queued_requests_;
  1741. time_t idle_timeout_sec_;
  1742. size_t idle_thread_count_;
  1743. bool shutdown_;
  1744. std::list<std::function<void()>> jobs_;
  1745. std::vector<std::thread> threads_; // base threads
  1746. std::list<std::thread> dynamic_threads_; // dynamic threads
  1747. std::vector<std::thread>
  1748. finished_threads_; // exited dynamic threads awaiting join
  1749. std::condition_variable cond_;
  1750. std::mutex mutex_;
  1751. };
  1752. using Logger = std::function<void(const Request &, const Response &)>;
  1753. // Forward declaration for Error type
  1754. enum class Error;
  1755. using ErrorLogger = std::function<void(const Error &, const Request *)>;
  1756. using SocketOptions = std::function<void(socket_t sock)>;
  1757. void default_socket_options(socket_t sock);
  1758. bool set_socket_opt(socket_t sock, int level, int optname, int optval);
  1759. const char *status_message(int status);
  1760. std::string to_string(Error error);
  1761. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1762. std::string get_bearer_token_auth(const Request &req);
  1763. namespace detail {
  1764. class MatcherBase {
  1765. public:
  1766. MatcherBase(std::string pattern) : pattern_(std::move(pattern)) {}
  1767. virtual ~MatcherBase() = default;
  1768. const std::string &pattern() const { return pattern_; }
  1769. // Match request path and populate its matches and
  1770. virtual bool match(Request &request) const = 0;
  1771. private:
  1772. std::string pattern_;
  1773. };
  1774. /**
  1775. * Captures parameters in request path and stores them in Request::path_params
  1776. *
  1777. * Capture name is a substring of a pattern from : to /.
  1778. * The rest of the pattern is matched against the request path directly
  1779. * Parameters are captured starting from the next character after
  1780. * the end of the last matched static pattern fragment until the next /.
  1781. *
  1782. * Example pattern:
  1783. * "/path/fragments/:capture/more/fragments/:second_capture"
  1784. * Static fragments:
  1785. * "/path/fragments/", "more/fragments/"
  1786. *
  1787. * Given the following request path:
  1788. * "/path/fragments/:1/more/fragments/:2"
  1789. * the resulting capture will be
  1790. * {{"capture", "1"}, {"second_capture", "2"}}
  1791. */
  1792. class PathParamsMatcher final : public MatcherBase {
  1793. public:
  1794. PathParamsMatcher(const std::string &pattern);
  1795. bool match(Request &request) const override;
  1796. private:
  1797. // Treat segment separators as the end of path parameter capture
  1798. // Does not need to handle query parameters as they are parsed before path
  1799. // matching
  1800. static constexpr char separator = '/';
  1801. // Contains static path fragments to match against, excluding the '/' after
  1802. // path params
  1803. // Fragments are separated by path params
  1804. std::vector<std::string> static_fragments_;
  1805. // Stores the names of the path parameters to be used as keys in the
  1806. // Request::path_params map
  1807. std::vector<std::string> param_names_;
  1808. };
  1809. /**
  1810. * Performs std::regex_match on request path
  1811. * and stores the result in Request::matches
  1812. *
  1813. * Note that regex match is performed directly on the whole request.
  1814. * This means that wildcard patterns may match multiple path segments with /:
  1815. * "/begin/(.*)/end" will match both "/begin/middle/end" and "/begin/1/2/end".
  1816. */
  1817. class RegexMatcher final : public MatcherBase {
  1818. public:
  1819. RegexMatcher(const std::string &pattern)
  1820. : MatcherBase(pattern), regex_(pattern) {}
  1821. bool match(Request &request) const override;
  1822. private:
  1823. std::regex regex_;
  1824. };
  1825. int close_socket(socket_t sock) noexcept;
  1826. bool is_accept_resource_error();
  1827. bool is_accept_transient_error();
  1828. ssize_t write_headers(Stream &strm, const Headers &headers);
  1829. bool set_socket_opt_time(socket_t sock, int level, int optname, time_t sec,
  1830. time_t usec);
  1831. size_t get_multipart_content_length(const UploadFormDataItems &items,
  1832. const std::string &boundary);
  1833. ContentProvider
  1834. make_multipart_content_provider(const UploadFormDataItems &items,
  1835. const std::string &boundary);
  1836. } // namespace detail
  1837. bool is_valid_multipart_boundary(const std::string &boundary);
  1838. // Serializer for multipart/form-data request bodies. The boundary is owned
  1839. // by the writer so that per-part framing and the final terminator always
  1840. // agree. Field names and filenames are escaped following the WHATWG HTML
  1841. // standard ('"' -> %22, CR -> %0D, LF -> %0A); CR and LF are also escaped
  1842. // in content types.
  1843. class MultipartFormDataWriter {
  1844. public:
  1845. MultipartFormDataWriter();
  1846. // precondition: is_valid_multipart_boundary(boundary)
  1847. explicit MultipartFormDataWriter(std::string boundary);
  1848. const std::string &boundary() const;
  1849. std::string content_type() const;
  1850. // In-memory items -> whole body (known length)
  1851. std::string serialize(const UploadFormDataItems &items) const;
  1852. size_t content_length(const UploadFormDataItems &items) const;
  1853. // Per-part framing for streaming via a content provider
  1854. std::string item_begin(const UploadFormData &item) const;
  1855. static std::string item_end();
  1856. std::string finish() const;
  1857. private:
  1858. std::string boundary_;
  1859. };
  1860. class Server {
  1861. public:
  1862. using Handler = std::function<void(const Request &, Response &)>;
  1863. using ExceptionHandler =
  1864. std::function<void(const Request &, Response &, std::exception_ptr ep)>;
  1865. enum class HandlerResponse {
  1866. Handled,
  1867. Unhandled,
  1868. };
  1869. using HandlerWithResponse =
  1870. std::function<HandlerResponse(const Request &, Response &)>;
  1871. using HandlerWithContentReader = std::function<void(
  1872. const Request &, Response &, const ContentReader &content_reader)>;
  1873. using Expect100ContinueHandler =
  1874. std::function<int(const Request &, Response &)>;
  1875. using StartHandler = std::function<void()>;
  1876. using WebSocketHandler =
  1877. std::function<void(const Request &, ws::WebSocket &)>;
  1878. using SubProtocolSelector =
  1879. std::function<std::string(const std::vector<std::string> &protocols)>;
  1880. Server();
  1881. virtual ~Server();
  1882. virtual bool is_valid() const;
  1883. Server &Get(const std::string &pattern, Handler handler);
  1884. Server &Post(const std::string &pattern, Handler handler);
  1885. Server &Post(const std::string &pattern, HandlerWithContentReader handler);
  1886. Server &Put(const std::string &pattern, Handler handler);
  1887. Server &Put(const std::string &pattern, HandlerWithContentReader handler);
  1888. Server &Patch(const std::string &pattern, Handler handler);
  1889. Server &Patch(const std::string &pattern, HandlerWithContentReader handler);
  1890. Server &Delete(const std::string &pattern, Handler handler);
  1891. Server &Delete(const std::string &pattern, HandlerWithContentReader handler);
  1892. Server &Options(const std::string &pattern, Handler handler);
  1893. // Register a handler for an HTTP method outside the built-in set (e.g. the
  1894. // WebDAV methods from RFC 4918). Registering a method here is what makes the
  1895. // server accept it; an unregistered method is still rejected with 400.
  1896. // `method` must be a valid HTTP method token and must not be one of the
  1897. // built-in methods, which have their own registration functions above. A
  1898. // rejected registration makes is_valid() return false, so listen() fails.
  1899. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1900. Handler handler);
  1901. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1902. HandlerWithContentReader handler);
  1903. Server &WebSocket(const std::string &pattern, WebSocketHandler handler);
  1904. Server &WebSocket(const std::string &pattern, WebSocketHandler handler,
  1905. SubProtocolSelector sub_protocol_selector);
  1906. bool set_base_dir(const std::string &dir,
  1907. const std::string &mount_point = std::string());
  1908. bool set_mount_point(const std::string &mount_point, const std::string &dir,
  1909. Headers headers = Headers());
  1910. bool remove_mount_point(const std::string &mount_point);
  1911. Server &set_file_extension_and_mimetype_mapping(const std::string &ext,
  1912. const std::string &mime);
  1913. Server &set_default_file_mimetype(const std::string &mime);
  1914. Server &set_file_request_handler(Handler handler);
  1915. template <class ErrorHandlerFunc>
  1916. Server &set_error_handler(ErrorHandlerFunc &&handler) {
  1917. return set_error_handler_core(
  1918. std::forward<ErrorHandlerFunc>(handler),
  1919. std::is_convertible<ErrorHandlerFunc, HandlerWithResponse>{});
  1920. }
  1921. Server &set_exception_handler(ExceptionHandler handler);
  1922. Server &set_pre_routing_handler(HandlerWithResponse handler);
  1923. Server &set_post_routing_handler(Handler handler);
  1924. Server &set_pre_request_handler(HandlerWithResponse handler);
  1925. Server &set_expect_100_continue_handler(Expect100ContinueHandler handler);
  1926. Server &set_start_handler(StartHandler handler);
  1927. Server &set_logger(Logger logger);
  1928. Server &set_pre_compression_logger(Logger logger);
  1929. Server &set_error_logger(ErrorLogger error_logger);
  1930. Server &set_address_family(int family);
  1931. Server &set_tcp_nodelay(bool on);
  1932. Server &set_ipv6_v6only(bool on);
  1933. Server &set_socket_options(SocketOptions socket_options);
  1934. Server &set_default_headers(Headers headers);
  1935. Server &
  1936. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  1937. Server &set_trusted_proxies(const std::vector<std::string> &proxies);
  1938. Server &set_keep_alive_max_count(size_t count);
  1939. Server &set_keep_alive_timeout(time_t sec);
  1940. template <class Rep, class Period>
  1941. Server &
  1942. set_keep_alive_timeout(const std::chrono::duration<Rep, Period> &duration);
  1943. Server &set_read_timeout(time_t sec, time_t usec = 0);
  1944. template <class Rep, class Period>
  1945. Server &set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  1946. Server &set_write_timeout(time_t sec, time_t usec = 0);
  1947. template <class Rep, class Period>
  1948. Server &set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  1949. Server &set_idle_interval(time_t sec, time_t usec = 0);
  1950. template <class Rep, class Period>
  1951. Server &set_idle_interval(const std::chrono::duration<Rep, Period> &duration);
  1952. Server &set_payload_max_length(size_t length);
  1953. Server &set_static_file_compression(bool on);
  1954. Server &set_static_file_compression_min_length(size_t length);
  1955. Server &set_static_file_compression_max_length(size_t length);
  1956. Server &set_websocket_ping_interval(time_t sec);
  1957. template <class Rep, class Period>
  1958. Server &set_websocket_ping_interval(
  1959. const std::chrono::duration<Rep, Period> &duration);
  1960. Server &set_websocket_max_missed_pongs(int count);
  1961. bool bind_to_port(const std::string &host, int port, int socket_flags = 0);
  1962. int bind_to_any_port(const std::string &host, int socket_flags = 0);
  1963. bool listen_after_bind();
  1964. bool listen(const std::string &host, int port, int socket_flags = 0);
  1965. bool is_running() const;
  1966. void wait_until_ready() const;
  1967. void stop() noexcept;
  1968. void decommission();
  1969. std::function<TaskQueue *(void)> new_task_queue;
  1970. protected:
  1971. bool process_request(Stream &strm, const std::string &remote_addr,
  1972. int remote_port, const std::string &local_addr,
  1973. int local_port, bool close_connection,
  1974. bool &connection_closed,
  1975. const std::function<void(Request &)> &setup_request,
  1976. bool *websocket_upgraded = nullptr);
  1977. // Runs the per-connection serving loop and stops an exception thrown by a
  1978. // user callback from escaping the worker thread.
  1979. //
  1980. // process_request() wraps only routing() in a try/catch. Content providers,
  1981. // the post-routing, error, logging and expect-100 handlers and WebSocket
  1982. // handlers all run outside it, and the task queue calls the job without a
  1983. // catch, so an exception from any of those would terminate the process.
  1984. //
  1985. // No 500 is possible here: by the time a content provider runs, the status
  1986. // line and headers are already on the wire. Report it through the error
  1987. // logger and drop the connection, which is what the peer observes either
  1988. // way. Other connections are unaffected.
  1989. template <typename Serve> bool serve_guarded(Serve &&serve) const {
  1990. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  1991. return serve();
  1992. #else
  1993. try {
  1994. return serve();
  1995. } catch (...) {
  1996. // The error logger is a user callback too, so it must not be able to
  1997. // throw the guard back open.
  1998. try {
  1999. output_error_log(Error::UserCallbackException, nullptr);
  2000. } catch (...) {}
  2001. return false;
  2002. }
  2003. #endif
  2004. }
  2005. std::atomic<socket_t> svr_sock_{INVALID_SOCKET};
  2006. std::vector<std::string> trusted_proxies_;
  2007. size_t keep_alive_max_count_ = CPPHTTPLIB_KEEPALIVE_MAX_COUNT;
  2008. time_t keep_alive_timeout_sec_ = CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND;
  2009. time_t read_timeout_sec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND;
  2010. time_t read_timeout_usec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND;
  2011. time_t write_timeout_sec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND;
  2012. time_t write_timeout_usec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND;
  2013. time_t idle_interval_sec_ = CPPHTTPLIB_IDLE_INTERVAL_SECOND;
  2014. time_t idle_interval_usec_ = CPPHTTPLIB_IDLE_INTERVAL_USECOND;
  2015. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2016. bool static_file_compression_ = false;
  2017. size_t static_file_compression_min_length_ =
  2018. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH;
  2019. size_t static_file_compression_max_length_ =
  2020. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH;
  2021. time_t websocket_ping_interval_sec_ =
  2022. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  2023. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  2024. private:
  2025. using Handlers =
  2026. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, Handler>>;
  2027. using HandlersForContentReader =
  2028. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>,
  2029. HandlerWithContentReader>>;
  2030. // Both handler tables for one custom method live in a single entry, so that
  2031. // routing() needs only one map lookup per request to reach either of them.
  2032. struct CustomHandlerEntry {
  2033. Handlers handlers;
  2034. HandlersForContentReader handlers_for_content_reader;
  2035. };
  2036. using CustomHandlers = std::map<std::string, CustomHandlerEntry>;
  2037. static std::unique_ptr<detail::MatcherBase>
  2038. make_matcher(const std::string &pattern);
  2039. static const std::set<std::string> &builtin_methods();
  2040. CustomHandlerEntry *custom_entry_for_registration(const std::string &method);
  2041. const CustomHandlerEntry *find_custom_entry(const std::string &method) const;
  2042. template <typename H>
  2043. Server &add_handler(
  2044. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, H>> &handlers,
  2045. const std::string &pattern, H handler) {
  2046. handlers.emplace_back(make_matcher(pattern), std::move(handler));
  2047. return *this;
  2048. }
  2049. Server &set_error_handler_core(HandlerWithResponse handler, std::true_type);
  2050. Server &set_error_handler_core(Handler handler, std::false_type);
  2051. socket_t create_server_socket(const std::string &host, int port,
  2052. int socket_flags,
  2053. SocketOptions socket_options) const;
  2054. int bind_internal(const std::string &host, int port, int socket_flags);
  2055. bool listen_internal();
  2056. bool routing(Request &req, Response &res, Stream &strm);
  2057. bool handle_file_request(Request &req, Response &res);
  2058. bool check_if_not_modified(const Request &req, Response &res,
  2059. const std::string &etag, time_t mtime) const;
  2060. bool check_if_range(Request &req, const std::string &etag,
  2061. time_t mtime) const;
  2062. bool dispatch_request(Request &req, Response &res, const Handlers &handlers,
  2063. Stream &strm);
  2064. bool dispatch_request_for_content_reader(
  2065. Request &req, Response &res, ContentReader content_reader,
  2066. const HandlersForContentReader &handlers) const;
  2067. bool parse_request_line(const char *s, Request &req) const;
  2068. detail::EncodingType static_file_encoding(const Request &req,
  2069. const Response &res,
  2070. const std::string &content_type,
  2071. size_t length) const;
  2072. bool apply_static_file_compression(const Request &req, Response &res) const;
  2073. void apply_ranges(const Request &req, Response &res,
  2074. std::string &content_type, std::string &boundary) const;
  2075. bool write_response(Stream &strm, bool close_connection, Request &req,
  2076. Response &res);
  2077. bool write_response_with_content(Stream &strm, bool close_connection,
  2078. const Request &req, Response &res);
  2079. bool write_response_core(Stream &strm, bool close_connection,
  2080. const Request &req, Response &res,
  2081. bool need_apply_ranges);
  2082. bool write_content_with_provider(Stream &strm, const Request &req,
  2083. Response &res, const std::string &boundary,
  2084. const std::string &content_type);
  2085. bool read_content(Stream &strm, Request &req, Response &res);
  2086. bool read_content_with_content_receiver(Stream &strm, Request &req,
  2087. Response &res,
  2088. ContentReceiver receiver,
  2089. FormDataHeader multipart_header,
  2090. ContentReceiver multipart_receiver);
  2091. bool read_content_core(Stream &strm, Request &req, Response &res,
  2092. ContentReceiver receiver,
  2093. FormDataHeader multipart_header,
  2094. ContentReceiver multipart_receiver) const;
  2095. virtual bool process_and_close_socket(socket_t sock);
  2096. void output_log(const Request &req, const Response &res) const;
  2097. void output_pre_compression_log(const Request &req,
  2098. const Response &res) const;
  2099. void output_error_log(const Error &err, const Request *req) const;
  2100. std::atomic<bool> is_running_{false};
  2101. std::atomic<bool> is_decommissioned{false};
  2102. // Set when CustomRoute() refuses a registration. Written before listen(),
  2103. // read by is_valid() on the same thread, so it needs no synchronization.
  2104. bool has_invalid_registration_ = false;
  2105. struct MountPointEntry {
  2106. std::string mount_point;
  2107. std::string base_dir;
  2108. std::string resolved_base_dir;
  2109. Headers headers;
  2110. };
  2111. std::vector<MountPointEntry> base_dirs_;
  2112. std::map<std::string, std::string> file_extension_and_mimetype_map_;
  2113. std::string default_file_mimetype_ = "application/octet-stream";
  2114. Handler file_request_handler_;
  2115. Handlers get_handlers_;
  2116. Handlers post_handlers_;
  2117. HandlersForContentReader post_handlers_for_content_reader_;
  2118. Handlers put_handlers_;
  2119. HandlersForContentReader put_handlers_for_content_reader_;
  2120. Handlers patch_handlers_;
  2121. HandlersForContentReader patch_handlers_for_content_reader_;
  2122. Handlers delete_handlers_;
  2123. HandlersForContentReader delete_handlers_for_content_reader_;
  2124. Handlers options_handlers_;
  2125. CustomHandlers custom_handlers_;
  2126. struct WebSocketHandlerEntry {
  2127. std::unique_ptr<detail::MatcherBase> matcher;
  2128. WebSocketHandler handler;
  2129. SubProtocolSelector sub_protocol_selector;
  2130. };
  2131. using WebSocketHandlers = std::vector<WebSocketHandlerEntry>;
  2132. WebSocketHandlers websocket_handlers_;
  2133. HandlerWithResponse error_handler_;
  2134. ExceptionHandler exception_handler_;
  2135. HandlerWithResponse pre_routing_handler_;
  2136. Handler post_routing_handler_;
  2137. HandlerWithResponse pre_request_handler_;
  2138. Expect100ContinueHandler expect_100_continue_handler_;
  2139. StartHandler start_handler_;
  2140. mutable std::mutex logger_mutex_;
  2141. Logger logger_;
  2142. Logger pre_compression_logger_;
  2143. ErrorLogger error_logger_;
  2144. int address_family_ = AF_UNSPEC;
  2145. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2146. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2147. SocketOptions socket_options_ = default_socket_options;
  2148. Headers default_headers_;
  2149. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2150. detail::write_headers;
  2151. };
  2152. class Result {
  2153. public:
  2154. Result() = default;
  2155. Result(std::unique_ptr<Response> &&res, Error err,
  2156. Headers &&request_headers = Headers{})
  2157. : res_(std::move(res)), err_(err),
  2158. request_headers_(std::move(request_headers)) {}
  2159. // Response
  2160. operator bool() const { return res_ != nullptr; }
  2161. bool operator==(std::nullptr_t) const { return res_ == nullptr; }
  2162. bool operator!=(std::nullptr_t) const { return res_ != nullptr; }
  2163. const Response &value() const { return *res_; }
  2164. Response &value() { return *res_; }
  2165. const Response &operator*() const { return *res_; }
  2166. Response &operator*() { return *res_; }
  2167. const Response *operator->() const { return res_.get(); }
  2168. Response *operator->() { return res_.get(); }
  2169. // Error
  2170. Error error() const { return err_; }
  2171. // Request Headers
  2172. bool has_request_header(const std::string &key) const;
  2173. std::string get_request_header_value(const std::string &key,
  2174. const char *def = "",
  2175. size_t id = 0) const;
  2176. size_t get_request_header_value_u64(const std::string &key, size_t def = 0,
  2177. size_t id = 0) const;
  2178. size_t get_request_header_value_count(const std::string &key) const;
  2179. private:
  2180. std::unique_ptr<Response> res_;
  2181. Error err_ = Error::Unknown;
  2182. Headers request_headers_;
  2183. #ifdef CPPHTTPLIB_SSL_ENABLED
  2184. public:
  2185. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2186. int ssl_error)
  2187. : res_(std::move(res)), err_(err),
  2188. request_headers_(std::move(request_headers)), ssl_error_(ssl_error) {}
  2189. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2190. int ssl_error, uint64_t ssl_backend_error)
  2191. : res_(std::move(res)), err_(err),
  2192. request_headers_(std::move(request_headers)), ssl_error_(ssl_error),
  2193. ssl_backend_error_(ssl_backend_error) {}
  2194. int ssl_error() const { return ssl_error_; }
  2195. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  2196. private:
  2197. int ssl_error_ = 0;
  2198. uint64_t ssl_backend_error_ = 0;
  2199. #endif
  2200. };
  2201. struct ClientConnection {
  2202. socket_t sock = INVALID_SOCKET;
  2203. bool is_open() const { return sock != INVALID_SOCKET; }
  2204. ClientConnection() = default;
  2205. ~ClientConnection();
  2206. ClientConnection(const ClientConnection &) = delete;
  2207. ClientConnection &operator=(const ClientConnection &) = delete;
  2208. ClientConnection(ClientConnection &&other) noexcept
  2209. : sock(other.sock)
  2210. #ifdef CPPHTTPLIB_SSL_ENABLED
  2211. ,
  2212. session(other.session)
  2213. #endif
  2214. {
  2215. other.sock = INVALID_SOCKET;
  2216. #ifdef CPPHTTPLIB_SSL_ENABLED
  2217. other.session = nullptr;
  2218. #endif
  2219. }
  2220. ClientConnection &operator=(ClientConnection &&other) noexcept {
  2221. if (this != &other) {
  2222. sock = other.sock;
  2223. other.sock = INVALID_SOCKET;
  2224. #ifdef CPPHTTPLIB_SSL_ENABLED
  2225. session = other.session;
  2226. other.session = nullptr;
  2227. #endif
  2228. }
  2229. return *this;
  2230. }
  2231. #ifdef CPPHTTPLIB_SSL_ENABLED
  2232. tls::session_t session = nullptr;
  2233. #endif
  2234. };
  2235. namespace detail {
  2236. struct ChunkedDecoder;
  2237. struct BodyReader {
  2238. Stream *stream = nullptr;
  2239. bool has_content_length = false;
  2240. size_t content_length = 0;
  2241. size_t payload_max_length = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2242. size_t bytes_read = 0;
  2243. bool chunked = false;
  2244. bool eof = false;
  2245. std::unique_ptr<ChunkedDecoder> chunked_decoder;
  2246. Error last_error = Error::Success;
  2247. ssize_t read(char *buf, size_t len);
  2248. bool has_error() const { return last_error != Error::Success; }
  2249. };
  2250. inline ssize_t read_body_content(Stream *stream, BodyReader &br, char *buf,
  2251. size_t len) {
  2252. (void)stream;
  2253. return br.read(buf, len);
  2254. }
  2255. class decompressor;
  2256. enum class NoProxyKind {
  2257. Wildcard, // "*"
  2258. HostnameSuffix, // "example.com" or ".example.com"
  2259. IPv4Cidr, // "10.0.0.0/8" (or single IP, treated as /32)
  2260. IPv6Cidr, // "fe80::/10" (or single IP, treated as /128)
  2261. };
  2262. // Unified 16-byte buffer holding either a v4 (first 4 bytes) or v6 address.
  2263. // Lets one CIDR matcher cover both families.
  2264. using IPBytes = std::array<uint8_t, 16>;
  2265. struct NoProxyEntry {
  2266. NoProxyKind kind = NoProxyKind::Wildcard;
  2267. std::string hostname_pattern; // lowercased, leading/trailing dot stripped
  2268. IPBytes net{};
  2269. int prefix_bits = 0;
  2270. };
  2271. struct NormalizedTarget {
  2272. std::string hostname; // lowercase; brackets and trailing dot removed
  2273. bool is_ipv4 = false;
  2274. bool is_ipv6 = false;
  2275. IPBytes ip{};
  2276. };
  2277. } // namespace detail
  2278. class ClientImpl {
  2279. public:
  2280. explicit ClientImpl(const std::string &host);
  2281. explicit ClientImpl(const std::string &host, int port);
  2282. explicit ClientImpl(const std::string &host, int port,
  2283. const std::string &client_cert_path,
  2284. const std::string &client_key_path);
  2285. virtual ~ClientImpl();
  2286. virtual bool is_valid() const;
  2287. struct StreamHandle {
  2288. std::unique_ptr<Response> response;
  2289. Error error = Error::Success;
  2290. StreamHandle() = default;
  2291. StreamHandle(const StreamHandle &) = delete;
  2292. StreamHandle &operator=(const StreamHandle &) = delete;
  2293. StreamHandle(StreamHandle &&) = default;
  2294. StreamHandle &operator=(StreamHandle &&) = default;
  2295. ~StreamHandle() = default;
  2296. bool is_valid() const {
  2297. return response != nullptr && error == Error::Success;
  2298. }
  2299. ssize_t read(char *buf, size_t len);
  2300. void parse_trailers_if_needed();
  2301. Error get_read_error() const { return body_reader_.last_error; }
  2302. bool has_read_error() const { return body_reader_.has_error(); }
  2303. bool trailers_parsed_ = false;
  2304. private:
  2305. friend class ClientImpl;
  2306. friend class sse::SSEClient;
  2307. ssize_t read_with_decompression(char *buf, size_t len);
  2308. std::unique_ptr<ClientConnection> connection_;
  2309. std::unique_ptr<Stream> socket_stream_;
  2310. Stream *stream_ = nullptr;
  2311. detail::BodyReader body_reader_;
  2312. std::unique_ptr<detail::decompressor> decompressor_;
  2313. std::string decompress_buffer_;
  2314. size_t decompress_offset_ = 0;
  2315. size_t decompressed_bytes_read_ = 0;
  2316. };
  2317. // clang-format off
  2318. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2319. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2320. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2321. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2322. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2323. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2324. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2325. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2326. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2327. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2328. Result Head(const std::string &path);
  2329. Result Head(const std::string &path, const Headers &headers);
  2330. Result Post(const std::string &path);
  2331. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2332. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2333. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2334. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2335. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2336. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2337. Result Post(const std::string &path, const Params &params);
  2338. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2339. Result Post(const std::string &path, const Headers &headers);
  2340. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2341. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2342. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2343. 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);
  2344. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2345. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2346. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2347. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2348. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2349. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2350. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2351. Result Put(const std::string &path);
  2352. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2353. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2354. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2355. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2356. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2357. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2358. Result Put(const std::string &path, const Params &params);
  2359. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2360. Result Put(const std::string &path, const Headers &headers);
  2361. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2362. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2363. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2364. 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);
  2365. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2366. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2367. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2368. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2369. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2370. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2371. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2372. Result Patch(const std::string &path);
  2373. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2374. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2375. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2376. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2377. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2378. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2379. Result Patch(const std::string &path, const Params &params);
  2380. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2381. Result Patch(const std::string &path, const Headers &headers, UploadProgress progress = nullptr);
  2382. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2383. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2384. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2385. 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);
  2386. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2387. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2388. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2389. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2390. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2391. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2392. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2393. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2394. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2395. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2396. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2397. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2398. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2399. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2400. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2401. Result Options(const std::string &path);
  2402. Result Options(const std::string &path, const Headers &headers);
  2403. // clang-format on
  2404. // Streaming API: Open a stream for reading response body incrementally
  2405. // Socket ownership is transferred to StreamHandle for true streaming
  2406. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2407. StreamHandle open_stream(const std::string &method, const std::string &path,
  2408. const Params &params = {},
  2409. const Headers &headers = {},
  2410. const std::string &body = {},
  2411. const std::string &content_type = {});
  2412. bool send(Request &req, Response &res, Error &error);
  2413. Result send(const Request &req);
  2414. void stop();
  2415. std::string host() const;
  2416. int port() const;
  2417. size_t is_socket_open() const;
  2418. socket_t socket() const;
  2419. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2420. void set_default_headers(Headers headers);
  2421. void
  2422. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2423. void set_address_family(int family);
  2424. void set_tcp_nodelay(bool on);
  2425. void set_ipv6_v6only(bool on);
  2426. void set_socket_options(SocketOptions socket_options);
  2427. void set_connection_timeout(time_t sec, time_t usec = 0);
  2428. template <class Rep, class Period>
  2429. void
  2430. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2431. void set_read_timeout(time_t sec, time_t usec = 0);
  2432. template <class Rep, class Period>
  2433. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2434. void set_write_timeout(time_t sec, time_t usec = 0);
  2435. template <class Rep, class Period>
  2436. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2437. void set_max_timeout(time_t msec);
  2438. template <class Rep, class Period>
  2439. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2440. void set_basic_auth(const std::string &username, const std::string &password);
  2441. void set_bearer_token_auth(const std::string &token);
  2442. void set_keep_alive(bool on);
  2443. void set_follow_location(bool on);
  2444. void set_path_encode(bool on);
  2445. void set_compress(bool on);
  2446. void set_decompress(bool on);
  2447. void set_payload_max_length(size_t length);
  2448. void set_interface(const std::string &intf);
  2449. void set_proxy(const std::string &host, int port);
  2450. void set_proxy_basic_auth(const std::string &username,
  2451. const std::string &password);
  2452. void set_proxy_bearer_token_auth(const std::string &token);
  2453. void set_no_proxy(const std::vector<std::string> &patterns);
  2454. void set_logger(Logger logger);
  2455. void set_error_logger(ErrorLogger error_logger);
  2456. protected:
  2457. struct Socket {
  2458. socket_t sock = INVALID_SOCKET;
  2459. // For Mbed TLS compatibility: start_time for request timeout tracking
  2460. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  2461. bool is_open() const { return sock != INVALID_SOCKET; }
  2462. #ifdef CPPHTTPLIB_SSL_ENABLED
  2463. tls::session_t ssl = nullptr;
  2464. #endif
  2465. };
  2466. virtual bool create_and_connect_socket(Socket &socket, Error &error);
  2467. virtual bool ensure_socket_connection(Socket &socket, Error &error);
  2468. virtual bool setup_proxy_connection(
  2469. Socket &socket,
  2470. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2471. Response &res, bool &success, Error &error);
  2472. bool is_proxy_enabled_for_host(const std::string &host) const;
  2473. // All of:
  2474. // shutdown_ssl
  2475. // shutdown_socket
  2476. // close_socket
  2477. // disconnect
  2478. // should ONLY be called when socket_mutex_ is locked, and only when
  2479. // no other thread is using the socket.
  2480. virtual void shutdown_ssl(Socket &socket, bool shutdown_gracefully);
  2481. void shutdown_socket(Socket &socket) const;
  2482. void close_socket(Socket &socket);
  2483. void disconnect(bool gracefully);
  2484. std::string make_request_target(const Request &req) const;
  2485. bool process_request(Stream &strm, Request &req, Response &res,
  2486. bool close_connection, Error &error);
  2487. bool write_content_with_provider(Stream &strm, const Request &req,
  2488. Error &error) const;
  2489. void output_log(const Request &req, const Response &res) const;
  2490. void output_error_log(const Error &err, const Request *req) const;
  2491. // Socket endpoint information
  2492. const std::string host_;
  2493. const int port_;
  2494. // Current open socket
  2495. Socket socket_;
  2496. mutable std::mutex socket_mutex_;
  2497. std::recursive_mutex request_mutex_;
  2498. // These are all protected under socket_mutex
  2499. size_t socket_requests_in_flight_ = 0;
  2500. std::thread::id socket_requests_are_from_thread_ = std::thread::id();
  2501. bool socket_should_be_closed_when_request_is_done_ = false;
  2502. // Hostname to connection target map. The value is an IP literal or another
  2503. // hostname; only the connection target changes, never the identity.
  2504. std::map<std::string, std::string> addr_map_;
  2505. // Default headers
  2506. Headers default_headers_;
  2507. // Header writer
  2508. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2509. detail::write_headers;
  2510. // Settings
  2511. std::string client_cert_path_;
  2512. std::string client_key_path_;
  2513. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  2514. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  2515. time_t read_timeout_sec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND;
  2516. time_t read_timeout_usec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND;
  2517. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  2518. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  2519. time_t max_timeout_msec_ = CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND;
  2520. std::string basic_auth_username_;
  2521. std::string basic_auth_password_;
  2522. std::string bearer_token_auth_token_;
  2523. bool keep_alive_ = false;
  2524. bool follow_location_ = false;
  2525. bool path_encode_ = true;
  2526. int address_family_ = AF_UNSPEC;
  2527. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2528. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2529. SocketOptions socket_options_ = nullptr;
  2530. bool compress_ = false;
  2531. bool decompress_ = true;
  2532. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2533. bool has_payload_max_length_ = false;
  2534. std::string interface_;
  2535. std::string proxy_host_;
  2536. int proxy_port_ = -1;
  2537. std::string proxy_basic_auth_username_;
  2538. std::string proxy_basic_auth_password_;
  2539. std::string proxy_bearer_token_auth_token_;
  2540. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  2541. mutable detail::NormalizedTarget host_normalized_;
  2542. mutable bool host_normalized_valid_ = false;
  2543. mutable std::mutex logger_mutex_;
  2544. Logger logger_;
  2545. ErrorLogger error_logger_;
  2546. private:
  2547. bool send_(Request &req, Response &res, Error &error);
  2548. Result send_(Request &&req);
  2549. socket_t create_client_socket(Error &error) const;
  2550. bool read_response_line(Stream &strm, const Request &req, Response &res,
  2551. bool skip_100_continue = true) const;
  2552. bool write_request(Stream &strm, Request &req, bool close_connection,
  2553. Error &error, bool skip_body, bool &rejected_locally);
  2554. bool write_request_body(Stream &strm, Request &req, Error &error);
  2555. void prepare_default_headers(Request &r, bool for_stream,
  2556. const std::string &ct);
  2557. bool redirect(Request &req, Response &res, Error &error);
  2558. bool create_redirect_client(const std::string &scheme,
  2559. const std::string &host, int port, Request &req,
  2560. Response &res, const std::string &path,
  2561. const std::string &location, Error &error);
  2562. template <typename ClientType> void setup_redirect_client(ClientType &client);
  2563. bool handle_request(Stream &strm, Request &req, Response &res,
  2564. bool close_connection, Error &error);
  2565. std::unique_ptr<Response> send_with_content_provider_and_receiver(
  2566. Request &req, const char *body, size_t content_length,
  2567. ContentProvider content_provider,
  2568. ContentProviderWithoutLength content_provider_without_length,
  2569. const std::string &content_type, ContentReceiver content_receiver,
  2570. Error &error);
  2571. Result send_with_content_provider_and_receiver(
  2572. const std::string &method, const std::string &path,
  2573. const Headers &headers, const char *body, size_t content_length,
  2574. ContentProvider content_provider,
  2575. ContentProviderWithoutLength content_provider_without_length,
  2576. const std::string &content_type, ContentReceiver content_receiver,
  2577. UploadProgress progress);
  2578. ContentProviderWithoutLength get_multipart_content_provider(
  2579. const std::string &boundary, const UploadFormDataItems &items,
  2580. const FormDataProviderItems &provider_items) const;
  2581. virtual bool
  2582. process_socket(const Socket &socket,
  2583. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2584. std::function<bool(Stream &strm)> callback);
  2585. virtual bool is_ssl() const;
  2586. void transfer_socket_ownership_to_handle(StreamHandle &handle);
  2587. #ifdef CPPHTTPLIB_SSL_ENABLED
  2588. public:
  2589. void set_digest_auth(const std::string &username,
  2590. const std::string &password);
  2591. void set_proxy_digest_auth(const std::string &username,
  2592. const std::string &password);
  2593. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2594. const std::string &ca_cert_dir_path = std::string());
  2595. void enable_server_certificate_verification(bool enabled);
  2596. void enable_server_hostname_verification(bool enabled);
  2597. void enable_system_ca(bool enabled);
  2598. protected:
  2599. std::string digest_auth_username_;
  2600. std::string digest_auth_password_;
  2601. std::string proxy_digest_auth_username_;
  2602. std::string proxy_digest_auth_password_;
  2603. std::string ca_cert_file_path_;
  2604. std::string ca_cert_dir_path_;
  2605. bool server_certificate_verification_ = true;
  2606. bool server_hostname_verification_ = true;
  2607. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  2608. std::string ca_cert_pem_; // Store CA cert PEM for redirect transfer
  2609. int last_ssl_error_ = 0;
  2610. uint64_t last_backend_error_ = 0;
  2611. #endif
  2612. };
  2613. namespace detail {
  2614. // Stands in for a client that Client could not make from its arguments, so a
  2615. // request fails rather than going through a null pointer.
  2616. class InvalidClientImpl final : public ClientImpl {
  2617. public:
  2618. InvalidClientImpl() : ClientImpl(std::string(), 0) {}
  2619. bool is_valid() const override { return false; }
  2620. private:
  2621. bool create_and_connect_socket(Socket &, Error &error) override {
  2622. error = Error::Connection;
  2623. return false;
  2624. }
  2625. };
  2626. } // namespace detail
  2627. class Client {
  2628. public:
  2629. // Universal interface
  2630. explicit Client(const std::string &scheme_host_port);
  2631. explicit Client(const std::string &scheme_host_port,
  2632. const std::string &client_cert_path,
  2633. const std::string &client_key_path);
  2634. // HTTP only interface
  2635. explicit Client(const std::string &host, int port);
  2636. explicit Client(const std::string &host, int port,
  2637. const std::string &client_cert_path,
  2638. const std::string &client_key_path);
  2639. Client(Client &&) = default;
  2640. Client &operator=(Client &&) = default;
  2641. ~Client();
  2642. bool is_valid() const;
  2643. // clang-format off
  2644. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2645. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2646. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2647. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2648. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2649. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2650. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2651. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2652. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2653. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2654. Result Head(const std::string &path);
  2655. Result Head(const std::string &path, const Headers &headers);
  2656. Result Post(const std::string &path);
  2657. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2658. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2659. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2660. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2661. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2662. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2663. Result Post(const std::string &path, const Params &params);
  2664. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2665. Result Post(const std::string &path, const Headers &headers);
  2666. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2667. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2668. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2669. 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);
  2670. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2671. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2672. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2673. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2674. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2675. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2676. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2677. Result Put(const std::string &path);
  2678. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2679. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2680. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2681. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2682. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2683. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2684. Result Put(const std::string &path, const Params &params);
  2685. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2686. Result Put(const std::string &path, const Headers &headers);
  2687. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2688. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2689. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2690. 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);
  2691. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2692. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2693. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2694. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2695. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2696. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2697. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2698. Result Patch(const std::string &path);
  2699. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2700. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2701. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2702. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2703. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2704. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2705. Result Patch(const std::string &path, const Params &params);
  2706. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2707. Result Patch(const std::string &path, const Headers &headers);
  2708. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2709. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2710. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2711. 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);
  2712. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2713. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2714. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2715. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2716. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2717. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2718. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2719. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2720. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2721. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2722. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2723. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2724. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2725. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2726. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2727. Result Options(const std::string &path);
  2728. Result Options(const std::string &path, const Headers &headers);
  2729. // clang-format on
  2730. // Streaming API: Open a stream for reading response body incrementally
  2731. // Socket ownership is transferred to StreamHandle for true streaming
  2732. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2733. ClientImpl::StreamHandle open_stream(const std::string &method,
  2734. const std::string &path,
  2735. const Params &params = {},
  2736. const Headers &headers = {},
  2737. const std::string &body = {},
  2738. const std::string &content_type = {});
  2739. bool send(Request &req, Response &res, Error &error);
  2740. Result send(const Request &req);
  2741. void stop();
  2742. std::string host() const;
  2743. int port() const;
  2744. size_t is_socket_open() const;
  2745. socket_t socket() const;
  2746. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2747. void set_default_headers(Headers headers);
  2748. void
  2749. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2750. void set_address_family(int family);
  2751. void set_tcp_nodelay(bool on);
  2752. void set_socket_options(SocketOptions socket_options);
  2753. void set_connection_timeout(time_t sec, time_t usec = 0);
  2754. template <class Rep, class Period>
  2755. void
  2756. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2757. void set_read_timeout(time_t sec, time_t usec = 0);
  2758. template <class Rep, class Period>
  2759. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2760. void set_write_timeout(time_t sec, time_t usec = 0);
  2761. template <class Rep, class Period>
  2762. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2763. void set_max_timeout(time_t msec);
  2764. template <class Rep, class Period>
  2765. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2766. void set_basic_auth(const std::string &username, const std::string &password);
  2767. void set_bearer_token_auth(const std::string &token);
  2768. void set_keep_alive(bool on);
  2769. void set_follow_location(bool on);
  2770. void set_path_encode(bool on);
  2771. void set_compress(bool on);
  2772. void set_decompress(bool on);
  2773. void set_payload_max_length(size_t length);
  2774. void set_interface(const std::string &intf);
  2775. void set_proxy(const std::string &host, int port);
  2776. void set_proxy_basic_auth(const std::string &username,
  2777. const std::string &password);
  2778. void set_proxy_bearer_token_auth(const std::string &token);
  2779. void set_no_proxy(const std::vector<std::string> &patterns);
  2780. void set_logger(Logger logger);
  2781. void set_error_logger(ErrorLogger error_logger);
  2782. private:
  2783. std::unique_ptr<ClientImpl> cli_;
  2784. #ifdef CPPHTTPLIB_SSL_ENABLED
  2785. public:
  2786. void set_digest_auth(const std::string &username,
  2787. const std::string &password);
  2788. void set_proxy_digest_auth(const std::string &username,
  2789. const std::string &password);
  2790. void enable_server_certificate_verification(bool enabled);
  2791. void enable_server_hostname_verification(bool enabled);
  2792. void enable_system_ca(bool enabled);
  2793. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2794. const std::string &ca_cert_dir_path = std::string());
  2795. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2796. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2797. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2798. void set_session_verifier(
  2799. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2800. tls::ctx_t tls_context() const;
  2801. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2802. void enable_windows_certificate_verification(bool enabled);
  2803. #endif
  2804. private:
  2805. bool is_ssl_ = false;
  2806. #endif
  2807. };
  2808. #ifdef CPPHTTPLIB_SSL_ENABLED
  2809. class SSLServer : public Server {
  2810. public:
  2811. SSLServer(const char *cert_path, const char *private_key_path,
  2812. const char *client_ca_cert_file_path = nullptr,
  2813. const char *client_ca_cert_dir_path = nullptr,
  2814. const char *private_key_password = nullptr);
  2815. struct PemMemory {
  2816. const char *cert_pem;
  2817. size_t cert_pem_len;
  2818. const char *key_pem;
  2819. size_t key_pem_len;
  2820. const char *client_ca_pem;
  2821. size_t client_ca_pem_len;
  2822. const char *private_key_password;
  2823. };
  2824. explicit SSLServer(const PemMemory &pem);
  2825. // The callback receives the ctx_t handle which can be cast to the
  2826. // appropriate backend type (SSL_CTX* for OpenSSL,
  2827. // tls::impl::MbedTlsContext* for Mbed TLS)
  2828. explicit SSLServer(const tls::ContextSetupCallback &setup_callback);
  2829. ~SSLServer() override;
  2830. bool is_valid() const override;
  2831. bool update_certs_pem(const char *cert_pem, const char *key_pem,
  2832. const char *client_ca_pem = nullptr,
  2833. const char *password = nullptr);
  2834. tls::ctx_t tls_context() const { return ctx_; }
  2835. int ssl_last_error() const { return last_ssl_error_; }
  2836. private:
  2837. bool process_and_close_socket(socket_t sock) override;
  2838. tls::ctx_t ctx_ = nullptr;
  2839. // update_certs_pem() replaces the certificates and CAs that handshakes read
  2840. // from ctx_, so it waits for the handshakes in progress, which their timeout
  2841. // bounds, and new ones wait while it is pending so that they cannot keep it
  2842. // waiting.
  2843. std::mutex ctx_mutex_;
  2844. std::condition_variable ctx_cv_;
  2845. size_t handshakes_in_progress_ = 0;
  2846. size_t updates_pending_ = 0;
  2847. int last_ssl_error_ = 0;
  2848. };
  2849. class SSLClient final : public ClientImpl {
  2850. public:
  2851. explicit SSLClient(const std::string &host);
  2852. explicit SSLClient(const std::string &host, int port);
  2853. explicit SSLClient(const std::string &host, int port,
  2854. const std::string &client_cert_path,
  2855. const std::string &client_key_path,
  2856. const std::string &private_key_password = std::string());
  2857. struct PemMemory {
  2858. const char *cert_pem;
  2859. size_t cert_pem_len;
  2860. const char *key_pem;
  2861. size_t key_pem_len;
  2862. const char *private_key_password;
  2863. };
  2864. explicit SSLClient(const std::string &host, int port, const PemMemory &pem);
  2865. ~SSLClient() override;
  2866. bool is_valid() const override;
  2867. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2868. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2869. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2870. // Post-handshake session verifier (backend-independent)
  2871. void set_session_verifier(
  2872. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2873. tls::ctx_t tls_context() const { return ctx_; }
  2874. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2875. void enable_windows_certificate_verification(bool enabled);
  2876. #endif
  2877. private:
  2878. bool create_and_connect_socket(Socket &socket, Error &error) override;
  2879. bool ensure_socket_connection(Socket &socket, Error &error) override;
  2880. void shutdown_ssl(Socket &socket, bool shutdown_gracefully) override;
  2881. void shutdown_ssl_impl(Socket &socket, bool shutdown_gracefully);
  2882. bool
  2883. process_socket(const Socket &socket,
  2884. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2885. std::function<bool(Stream &strm)> callback) override;
  2886. bool is_ssl() const override;
  2887. bool setup_proxy_connection(
  2888. Socket &socket,
  2889. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2890. Response &res, bool &success, Error &error) override;
  2891. bool connect_with_proxy(
  2892. Socket &sock,
  2893. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2894. Response &res, bool &success, Error &error);
  2895. bool initialize_ssl(Socket &socket, Error &error);
  2896. void init_ctx();
  2897. void reset_ctx_on_error();
  2898. bool load_certs();
  2899. tls::ctx_t ctx_ = nullptr;
  2900. std::mutex ctx_mutex_;
  2901. std::once_flag initialize_cert_;
  2902. // Tracks whether a custom CA store was applied via set_ca_cert_store(),
  2903. // since the store handle itself is owned by ctx_ and leaves no other trace.
  2904. // Used to keep custom CA configuration exclusive with system CA loading.
  2905. bool ca_cert_store_set_ = false;
  2906. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  2907. // Like ca_cert_store_set_, keeps what ctx_ cannot report back: the verifier
  2908. // set_server_certificate_verifier() installed there.
  2909. tls::VerifyCallback server_certificate_verifier_;
  2910. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2911. bool enable_windows_cert_verification_ = true;
  2912. #endif
  2913. friend class ClientImpl;
  2914. };
  2915. #endif // CPPHTTPLIB_SSL_ENABLED
  2916. namespace detail {
  2917. template <typename T, typename U>
  2918. inline void duration_to_sec_and_usec(const T &duration, U callback) {
  2919. auto sec = std::chrono::duration_cast<std::chrono::seconds>(duration).count();
  2920. auto usec = std::chrono::duration_cast<std::chrono::microseconds>(
  2921. duration - std::chrono::seconds(sec))
  2922. .count();
  2923. callback(static_cast<time_t>(sec), static_cast<time_t>(usec));
  2924. }
  2925. template <size_t N> inline constexpr size_t str_len(const char (&)[N]) {
  2926. return N - 1;
  2927. }
  2928. inline bool is_numeric(const std::string &str) {
  2929. return !str.empty() && std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  2930. }
  2931. // std::ranges::next(first, n, last) for C++11
  2932. template <typename It> inline It bounded_next(It first, size_t n, It last) {
  2933. for (; n > 0 && first != last; --n) {
  2934. ++first;
  2935. }
  2936. return first;
  2937. }
  2938. inline size_t get_header_value_u64(const Headers &headers,
  2939. const std::string &key, size_t def,
  2940. size_t id, bool &is_invalid_value) {
  2941. is_invalid_value = false;
  2942. auto rng = headers.equal_range(key);
  2943. auto it = bounded_next(rng.first, id, rng.second);
  2944. if (it != rng.second) {
  2945. if (is_numeric(it->second)) {
  2946. // Parse at size_t width so an out-of-range Content-Length is reported
  2947. // rather than silently saturated/truncated (a value above 2^32 would
  2948. // otherwise wrap to a small framing length on 32-bit builds). Flag it
  2949. // and return SIZE_MAX so the existing oversized-value guards reject it.
  2950. size_t val = 0;
  2951. const auto &s = it->second;
  2952. auto r = from_chars(s.data(), s.data() + s.size(), val);
  2953. if (r.ec == std::errc::result_out_of_range) {
  2954. is_invalid_value = true;
  2955. return (std::numeric_limits<size_t>::max)();
  2956. }
  2957. return val;
  2958. } else {
  2959. is_invalid_value = true;
  2960. }
  2961. }
  2962. return def;
  2963. }
  2964. inline size_t get_header_value_u64(const Headers &headers,
  2965. const std::string &key, size_t def,
  2966. size_t id) {
  2967. auto dummy = false;
  2968. return get_header_value_u64(headers, key, def, id, dummy);
  2969. }
  2970. } // namespace detail
  2971. template <class Rep, class Period>
  2972. inline Server &
  2973. Server::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2974. detail::duration_to_sec_and_usec(
  2975. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  2976. return *this;
  2977. }
  2978. template <class Rep, class Period>
  2979. inline Server &
  2980. Server::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2981. detail::duration_to_sec_and_usec(
  2982. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  2983. return *this;
  2984. }
  2985. template <class Rep, class Period>
  2986. inline Server &
  2987. Server::set_idle_interval(const std::chrono::duration<Rep, Period> &duration) {
  2988. detail::duration_to_sec_and_usec(
  2989. duration, [&](time_t sec, time_t usec) { set_idle_interval(sec, usec); });
  2990. return *this;
  2991. }
  2992. template <class Rep, class Period>
  2993. inline void ClientImpl::set_connection_timeout(
  2994. const std::chrono::duration<Rep, Period> &duration) {
  2995. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  2996. set_connection_timeout(sec, usec);
  2997. });
  2998. }
  2999. template <class Rep, class Period>
  3000. inline void ClientImpl::set_read_timeout(
  3001. const std::chrono::duration<Rep, Period> &duration) {
  3002. detail::duration_to_sec_and_usec(
  3003. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3004. }
  3005. template <class Rep, class Period>
  3006. inline void ClientImpl::set_write_timeout(
  3007. const std::chrono::duration<Rep, Period> &duration) {
  3008. detail::duration_to_sec_and_usec(
  3009. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3010. }
  3011. template <class Rep, class Period>
  3012. inline void ClientImpl::set_max_timeout(
  3013. const std::chrono::duration<Rep, Period> &duration) {
  3014. auto msec =
  3015. std::chrono::duration_cast<std::chrono::milliseconds>(duration).count();
  3016. set_max_timeout(static_cast<time_t>(msec));
  3017. }
  3018. template <class Rep, class Period>
  3019. inline void Client::set_connection_timeout(
  3020. const std::chrono::duration<Rep, Period> &duration) {
  3021. cli_->set_connection_timeout(duration);
  3022. }
  3023. template <class Rep, class Period>
  3024. inline void
  3025. Client::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3026. cli_->set_read_timeout(duration);
  3027. }
  3028. template <class Rep, class Period>
  3029. inline void
  3030. Client::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3031. cli_->set_write_timeout(duration);
  3032. }
  3033. inline void Client::set_max_timeout(time_t msec) {
  3034. cli_->set_max_timeout(msec);
  3035. }
  3036. template <class Rep, class Period>
  3037. inline void
  3038. Client::set_max_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3039. cli_->set_max_timeout(duration);
  3040. }
  3041. /*
  3042. * Forward declarations and types that will be part of the .h file if split into
  3043. * .h + .cc.
  3044. */
  3045. std::string hosted_at(const std::string &hostname);
  3046. void hosted_at(const std::string &hostname, std::vector<std::string> &addrs);
  3047. // JavaScript-style URL encoding/decoding functions
  3048. std::string encode_uri_component(const std::string &value);
  3049. std::string encode_uri(const std::string &value);
  3050. std::string decode_uri_component(const std::string &value);
  3051. std::string decode_uri(const std::string &value);
  3052. // RFC 3986 compliant URL component encoding/decoding functions
  3053. std::string encode_path_component(const std::string &component);
  3054. std::string decode_path_component(const std::string &component);
  3055. std::string encode_query_component(const std::string &component,
  3056. bool space_as_plus = true);
  3057. std::string decode_query_component(const std::string &component,
  3058. bool plus_as_space = true);
  3059. std::string sanitize_filename(const std::string &filename);
  3060. std::string append_query_params(const std::string &path, const Params &params);
  3061. std::pair<std::string, std::string> make_range_header(const Ranges &ranges);
  3062. std::pair<std::string, std::string>
  3063. make_basic_authentication_header(const std::string &username,
  3064. const std::string &password,
  3065. bool is_proxy = false);
  3066. namespace detail {
  3067. #if defined(_WIN32)
  3068. inline std::wstring u8string_to_wstring(const char *s) {
  3069. if (!s) { return std::wstring(); }
  3070. auto len = static_cast<int>(strlen(s));
  3071. if (!len) { return std::wstring(); }
  3072. auto wlen = ::MultiByteToWideChar(CP_UTF8, 0, s, len, nullptr, 0);
  3073. if (!wlen) { return std::wstring(); }
  3074. std::wstring ws;
  3075. ws.resize(wlen);
  3076. wlen = ::MultiByteToWideChar(
  3077. CP_UTF8, 0, s, len,
  3078. const_cast<LPWSTR>(reinterpret_cast<LPCWSTR>(ws.data())), wlen);
  3079. if (wlen != static_cast<int>(ws.size())) { ws.clear(); }
  3080. return ws;
  3081. }
  3082. #endif
  3083. struct FileStat {
  3084. FileStat(const std::string &path);
  3085. bool is_file() const;
  3086. bool is_dir() const;
  3087. time_t mtime() const;
  3088. size_t size() const;
  3089. private:
  3090. #if defined(_WIN32)
  3091. struct _stat st_;
  3092. #else
  3093. struct stat st_;
  3094. #endif
  3095. int ret_ = -1;
  3096. };
  3097. std::string make_host_and_port_string(const std::string &host, int port,
  3098. bool is_ssl);
  3099. template <typename T>
  3100. bool check_and_write_headers(Stream &strm, Headers &headers, T header_writer,
  3101. Error &error);
  3102. std::string trim_copy(const std::string &s);
  3103. void divide(
  3104. const char *data, std::size_t size, char d,
  3105. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3106. fn);
  3107. void divide(
  3108. const std::string &str, char d,
  3109. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3110. fn);
  3111. void split(const char *b, const char *e, char d,
  3112. std::function<void(const char *, const char *)> fn);
  3113. void split(const char *b, const char *e, char d, size_t m,
  3114. std::function<void(const char *, const char *)> fn);
  3115. bool split_find(const char *b, const char *e, char d,
  3116. std::function<bool(const char *, const char *)> fn);
  3117. bool has_header_token(const Headers &headers, const std::string &key,
  3118. const std::string &token);
  3119. std::string websocket_accept_key(const std::string &client_key);
  3120. bool is_websocket_upgrade(const Request &req);
  3121. bool process_client_socket(
  3122. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  3123. time_t write_timeout_sec, time_t write_timeout_usec,
  3124. time_t max_timeout_msec,
  3125. std::chrono::time_point<std::chrono::steady_clock> start_time,
  3126. std::function<bool(Stream &)> callback);
  3127. socket_t create_client_socket(const std::string &host, const std::string &ip,
  3128. int port, int address_family, bool tcp_nodelay,
  3129. bool ipv6_v6only, SocketOptions socket_options,
  3130. time_t connection_timeout_sec,
  3131. time_t connection_timeout_usec,
  3132. time_t read_timeout_sec, time_t read_timeout_usec,
  3133. time_t write_timeout_sec,
  3134. time_t write_timeout_usec,
  3135. const std::string &intf, Error &error);
  3136. const char *get_header_value(const Headers &headers, const std::string &key,
  3137. const char *def, size_t id);
  3138. std::string get_combined_header_value(const Headers &headers,
  3139. const std::string &key);
  3140. std::string params_to_query_str(const Params &params);
  3141. void parse_query_text(const char *data, std::size_t size, Params &params);
  3142. void parse_query_text(const std::string &s, Params &params);
  3143. bool parse_multipart_boundary(const std::string &content_type,
  3144. std::string &boundary);
  3145. bool parse_range_header(const std::string &s, Ranges &ranges);
  3146. bool parse_accept_header(const std::string &s,
  3147. std::vector<std::string> &content_types);
  3148. void parse_disposition_params(const std::string &s, Params &params);
  3149. ssize_t send_socket(socket_t sock, const void *ptr, size_t size, int flags);
  3150. ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags);
  3151. EncodingType encoding_type(const Request &req, const std::string &content_type);
  3152. EncodingType encoding_type(const Request &req, const Response &res,
  3153. const std::string &content_type);
  3154. EncodingType encoding_type(const Request &req, const Response &res);
  3155. class BufferStream final : public Stream {
  3156. public:
  3157. BufferStream() = default;
  3158. ~BufferStream() override = default;
  3159. bool is_readable() const override;
  3160. bool wait_readable() const override;
  3161. bool wait_writable() const override;
  3162. ssize_t read(char *ptr, size_t size) override;
  3163. ssize_t write(const char *ptr, size_t size) override;
  3164. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  3165. void get_local_ip_and_port(std::string &ip, int &port) const override;
  3166. socket_t socket() const override;
  3167. time_t duration() const override;
  3168. const std::string &get_buffer() const;
  3169. private:
  3170. std::string buffer;
  3171. size_t position = 0;
  3172. };
  3173. class compressor {
  3174. public:
  3175. virtual ~compressor() = default;
  3176. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3177. virtual bool compress(const char *data, size_t data_length, bool last,
  3178. Callback callback) = 0;
  3179. };
  3180. class decompressor {
  3181. public:
  3182. virtual ~decompressor() = default;
  3183. virtual bool is_valid() const = 0;
  3184. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3185. virtual bool decompress(const char *data, size_t data_length,
  3186. Callback callback) = 0;
  3187. };
  3188. class nocompressor final : public compressor {
  3189. public:
  3190. ~nocompressor() override = default;
  3191. bool compress(const char *data, size_t data_length, bool /*last*/,
  3192. Callback callback) override;
  3193. };
  3194. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  3195. class gzip_compressor final : public compressor {
  3196. public:
  3197. gzip_compressor();
  3198. ~gzip_compressor() override;
  3199. bool compress(const char *data, size_t data_length, bool last,
  3200. Callback callback) override;
  3201. private:
  3202. bool is_valid_ = false;
  3203. z_stream strm_;
  3204. };
  3205. class gzip_decompressor final : public decompressor {
  3206. public:
  3207. gzip_decompressor();
  3208. ~gzip_decompressor() override;
  3209. bool is_valid() const override;
  3210. bool decompress(const char *data, size_t data_length,
  3211. Callback callback) override;
  3212. private:
  3213. bool is_valid_ = false;
  3214. z_stream strm_;
  3215. };
  3216. #endif
  3217. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  3218. class brotli_compressor final : public compressor {
  3219. public:
  3220. brotli_compressor();
  3221. ~brotli_compressor();
  3222. bool compress(const char *data, size_t data_length, bool last,
  3223. Callback callback) override;
  3224. private:
  3225. BrotliEncoderState *state_ = nullptr;
  3226. };
  3227. class brotli_decompressor final : public decompressor {
  3228. public:
  3229. brotli_decompressor();
  3230. ~brotli_decompressor();
  3231. bool is_valid() const override;
  3232. bool decompress(const char *data, size_t data_length,
  3233. Callback callback) override;
  3234. private:
  3235. BrotliDecoderResult decoder_r;
  3236. BrotliDecoderState *decoder_s = nullptr;
  3237. };
  3238. #endif
  3239. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  3240. class zstd_compressor : public compressor {
  3241. public:
  3242. zstd_compressor();
  3243. ~zstd_compressor();
  3244. bool compress(const char *data, size_t data_length, bool last,
  3245. Callback callback) override;
  3246. private:
  3247. ZSTD_CCtx *ctx_ = nullptr;
  3248. };
  3249. class zstd_decompressor : public decompressor {
  3250. public:
  3251. zstd_decompressor();
  3252. ~zstd_decompressor();
  3253. bool is_valid() const override;
  3254. bool decompress(const char *data, size_t data_length,
  3255. Callback callback) override;
  3256. private:
  3257. ZSTD_DCtx *ctx_ = nullptr;
  3258. };
  3259. #endif
  3260. // NOTE: until the read size reaches `fixed_buffer_size`, use `fixed_buffer`
  3261. // to store data. The call can set memory on stack for performance.
  3262. class stream_line_reader {
  3263. public:
  3264. stream_line_reader(Stream &strm, char *fixed_buffer,
  3265. size_t fixed_buffer_size);
  3266. const char *ptr() const;
  3267. size_t size() const;
  3268. bool end_with_crlf() const;
  3269. bool getline();
  3270. private:
  3271. void append(char c);
  3272. void append(const char *data, size_t size);
  3273. Stream &strm_;
  3274. char *fixed_buffer_;
  3275. const size_t fixed_buffer_size_;
  3276. size_t fixed_buffer_used_size_ = 0;
  3277. std::string growable_buffer_;
  3278. };
  3279. bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  3280. const Headers &src_headers);
  3281. struct ChunkedDecoder {
  3282. Stream &strm;
  3283. size_t chunk_remaining = 0;
  3284. bool finished = false;
  3285. char line_buf[64];
  3286. size_t last_chunk_total = 0;
  3287. size_t last_chunk_offset = 0;
  3288. explicit ChunkedDecoder(Stream &s);
  3289. ssize_t read_payload(char *buf, size_t len, size_t &out_chunk_offset,
  3290. size_t &out_chunk_total);
  3291. bool parse_trailers_into(Headers &dest, const Headers &src_headers);
  3292. };
  3293. // A regular file opened to be served: mapped on Windows, read with pread()
  3294. // elsewhere.
  3295. class mmap {
  3296. public:
  3297. mmap(const char *path);
  3298. ~mmap();
  3299. bool open(const char *path);
  3300. void close();
  3301. bool is_open() const;
  3302. size_t size() const;
  3303. // Copies up to len bytes from offset into buf and returns how many: fewer,
  3304. // down to 0, if the file has shrunk since it was opened.
  3305. size_t read(size_t offset, char *buf, size_t len) const;
  3306. private:
  3307. #if defined(_WIN32)
  3308. HANDLE hFile_ = NULL;
  3309. HANDLE hMapping_ = NULL;
  3310. void *addr_ = nullptr;
  3311. bool is_open_empty_file = false;
  3312. #else
  3313. int fd_ = -1;
  3314. #endif
  3315. size_t size_ = 0;
  3316. };
  3317. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  3318. namespace fields {
  3319. bool is_token_char(char c);
  3320. bool is_token(const std::string &s);
  3321. bool is_field_name(const std::string &s);
  3322. bool is_vchar(char c);
  3323. bool is_obs_text(char c);
  3324. bool is_field_vchar(char c);
  3325. bool is_field_content(const std::string &s);
  3326. bool is_field_value(const std::string &s);
  3327. bool is_field_valid(const std::string &name, const std::string &value);
  3328. bool is_request_target(const std::string &s);
  3329. bool is_host(const std::string &s);
  3330. } // namespace fields
  3331. } // namespace detail
  3332. /*
  3333. * TLS Abstraction Layer Declarations
  3334. */
  3335. #ifdef CPPHTTPLIB_SSL_ENABLED
  3336. // TLS abstraction layer - backend-specific type declarations
  3337. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  3338. namespace tls {
  3339. namespace impl {
  3340. // Mbed TLS context wrapper (holds config, entropy, DRBG, CA chain, own
  3341. // cert/key). This struct is accessible via tls::impl for use in SSL context
  3342. // setup callbacks (cast ctx_t to tls::impl::MbedTlsContext*).
  3343. struct MbedTlsContext {
  3344. mbedtls_ssl_config conf;
  3345. #ifndef CPPHTTPLIB_MBEDTLS_V4
  3346. // Mbed TLS 4.x uses PSA Crypto's internal RNG; no explicit entropy/DRBG.
  3347. mbedtls_entropy_context entropy;
  3348. mbedtls_ctr_drbg_context ctr_drbg;
  3349. #endif
  3350. mbedtls_x509_crt ca_chain;
  3351. mbedtls_x509_crt own_cert;
  3352. mbedtls_pk_context own_key;
  3353. bool is_server = false;
  3354. // Peer certificate required (set_verify_client()); a client defaults to true
  3355. bool verify_client = false;
  3356. // Set by tls::set_verify_callback().
  3357. VerifyCallback verify_callback;
  3358. MbedTlsContext();
  3359. ~MbedTlsContext();
  3360. MbedTlsContext(const MbedTlsContext &) = delete;
  3361. MbedTlsContext &operator=(const MbedTlsContext &) = delete;
  3362. };
  3363. } // namespace impl
  3364. } // namespace tls
  3365. #endif
  3366. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  3367. namespace tls {
  3368. namespace impl {
  3369. // wolfSSL context wrapper (holds WOLFSSL_CTX and related state).
  3370. // This struct is accessible via tls::impl for use in SSL context
  3371. // setup callbacks (cast ctx_t to tls::impl::WolfSSLContext*).
  3372. struct WolfSSLContext {
  3373. WOLFSSL_CTX *ctx = nullptr;
  3374. bool is_server = false;
  3375. // Peer certificate required (set_verify_client()); a client defaults to true
  3376. bool verify_client = false;
  3377. // Replaced under verify_callback_mutex()
  3378. std::shared_ptr<VerifyCallback> verify_callback;
  3379. std::string ca_pem_data_; // accumulated PEM for get_ca_names/get_ca_certs
  3380. WolfSSLContext();
  3381. ~WolfSSLContext();
  3382. WolfSSLContext(const WolfSSLContext &) = delete;
  3383. WolfSSLContext &operator=(const WolfSSLContext &) = delete;
  3384. };
  3385. // CA store for wolfSSL: holds raw PEM bytes to allow reloading into any ctx
  3386. struct WolfSSLCAStore {
  3387. std::string pem_data;
  3388. };
  3389. } // namespace impl
  3390. } // namespace tls
  3391. #endif
  3392. #endif // CPPHTTPLIB_SSL_ENABLED
  3393. namespace stream {
  3394. class Result {
  3395. public:
  3396. Result();
  3397. explicit Result(ClientImpl::StreamHandle &&handle, size_t chunk_size = 8192);
  3398. Result(Result &&other) noexcept;
  3399. Result &operator=(Result &&other) noexcept;
  3400. Result(const Result &) = delete;
  3401. Result &operator=(const Result &) = delete;
  3402. // Response info
  3403. bool is_valid() const;
  3404. explicit operator bool() const;
  3405. int status() const;
  3406. const Headers &headers() const;
  3407. std::string get_header_value(const std::string &key,
  3408. const char *def = "") const;
  3409. bool has_header(const std::string &key) const;
  3410. Error error() const;
  3411. Error read_error() const;
  3412. bool has_read_error() const;
  3413. // Stream reading
  3414. bool next();
  3415. const char *data() const;
  3416. size_t size() const;
  3417. std::string read_all();
  3418. private:
  3419. ClientImpl::StreamHandle handle_;
  3420. std::string buffer_;
  3421. size_t current_size_ = 0;
  3422. size_t chunk_size_;
  3423. bool finished_ = false;
  3424. };
  3425. // GET
  3426. template <typename ClientType>
  3427. inline Result Get(ClientType &cli, const std::string &path,
  3428. size_t chunk_size = 8192) {
  3429. return Result{cli.open_stream("GET", path), chunk_size};
  3430. }
  3431. template <typename ClientType>
  3432. inline Result Get(ClientType &cli, const std::string &path,
  3433. const Headers &headers, size_t chunk_size = 8192) {
  3434. return Result{cli.open_stream("GET", path, {}, headers), chunk_size};
  3435. }
  3436. template <typename ClientType>
  3437. inline Result Get(ClientType &cli, const std::string &path,
  3438. const Params &params, size_t chunk_size = 8192) {
  3439. return Result{cli.open_stream("GET", path, params), chunk_size};
  3440. }
  3441. template <typename ClientType>
  3442. inline Result Get(ClientType &cli, const std::string &path,
  3443. const Params &params, const Headers &headers,
  3444. size_t chunk_size = 8192) {
  3445. return Result{cli.open_stream("GET", path, params, headers), chunk_size};
  3446. }
  3447. // POST
  3448. template <typename ClientType>
  3449. inline Result Post(ClientType &cli, const std::string &path,
  3450. const std::string &body, const std::string &content_type,
  3451. size_t chunk_size = 8192) {
  3452. return Result{cli.open_stream("POST", path, {}, {}, body, content_type),
  3453. chunk_size};
  3454. }
  3455. template <typename ClientType>
  3456. inline Result Post(ClientType &cli, const std::string &path,
  3457. const Headers &headers, const std::string &body,
  3458. const std::string &content_type, size_t chunk_size = 8192) {
  3459. return Result{cli.open_stream("POST", path, {}, headers, body, content_type),
  3460. chunk_size};
  3461. }
  3462. template <typename ClientType>
  3463. inline Result Post(ClientType &cli, const std::string &path,
  3464. const Params &params, const std::string &body,
  3465. const std::string &content_type, size_t chunk_size = 8192) {
  3466. return Result{cli.open_stream("POST", path, params, {}, body, content_type),
  3467. chunk_size};
  3468. }
  3469. template <typename ClientType>
  3470. inline Result Post(ClientType &cli, const std::string &path,
  3471. const Params &params, const Headers &headers,
  3472. const std::string &body, const std::string &content_type,
  3473. size_t chunk_size = 8192) {
  3474. return Result{
  3475. cli.open_stream("POST", path, params, headers, body, content_type),
  3476. chunk_size};
  3477. }
  3478. // PUT
  3479. template <typename ClientType>
  3480. inline Result Put(ClientType &cli, const std::string &path,
  3481. const std::string &body, const std::string &content_type,
  3482. size_t chunk_size = 8192) {
  3483. return Result{cli.open_stream("PUT", path, {}, {}, body, content_type),
  3484. chunk_size};
  3485. }
  3486. template <typename ClientType>
  3487. inline Result Put(ClientType &cli, const std::string &path,
  3488. const Headers &headers, const std::string &body,
  3489. const std::string &content_type, size_t chunk_size = 8192) {
  3490. return Result{cli.open_stream("PUT", path, {}, headers, body, content_type),
  3491. chunk_size};
  3492. }
  3493. template <typename ClientType>
  3494. inline Result Put(ClientType &cli, const std::string &path,
  3495. const Params &params, const std::string &body,
  3496. const std::string &content_type, size_t chunk_size = 8192) {
  3497. return Result{cli.open_stream("PUT", path, params, {}, body, content_type),
  3498. chunk_size};
  3499. }
  3500. template <typename ClientType>
  3501. inline Result Put(ClientType &cli, const std::string &path,
  3502. const Params &params, const Headers &headers,
  3503. const std::string &body, const std::string &content_type,
  3504. size_t chunk_size = 8192) {
  3505. return Result{
  3506. cli.open_stream("PUT", path, params, headers, body, content_type),
  3507. chunk_size};
  3508. }
  3509. // PATCH
  3510. template <typename ClientType>
  3511. inline Result Patch(ClientType &cli, const std::string &path,
  3512. const std::string &body, const std::string &content_type,
  3513. size_t chunk_size = 8192) {
  3514. return Result{cli.open_stream("PATCH", path, {}, {}, body, content_type),
  3515. chunk_size};
  3516. }
  3517. template <typename ClientType>
  3518. inline Result Patch(ClientType &cli, const std::string &path,
  3519. const Headers &headers, const std::string &body,
  3520. const std::string &content_type, size_t chunk_size = 8192) {
  3521. return Result{cli.open_stream("PATCH", path, {}, headers, body, content_type),
  3522. chunk_size};
  3523. }
  3524. template <typename ClientType>
  3525. inline Result Patch(ClientType &cli, const std::string &path,
  3526. const Params &params, const std::string &body,
  3527. const std::string &content_type, size_t chunk_size = 8192) {
  3528. return Result{cli.open_stream("PATCH", path, params, {}, body, content_type),
  3529. chunk_size};
  3530. }
  3531. template <typename ClientType>
  3532. inline Result Patch(ClientType &cli, const std::string &path,
  3533. const Params &params, const Headers &headers,
  3534. const std::string &body, const std::string &content_type,
  3535. size_t chunk_size = 8192) {
  3536. return Result{
  3537. cli.open_stream("PATCH", path, params, headers, body, content_type),
  3538. chunk_size};
  3539. }
  3540. // DELETE
  3541. template <typename ClientType>
  3542. inline Result Delete(ClientType &cli, const std::string &path,
  3543. size_t chunk_size = 8192) {
  3544. return Result{cli.open_stream("DELETE", path), chunk_size};
  3545. }
  3546. template <typename ClientType>
  3547. inline Result Delete(ClientType &cli, const std::string &path,
  3548. const Headers &headers, size_t chunk_size = 8192) {
  3549. return Result{cli.open_stream("DELETE", path, {}, headers), chunk_size};
  3550. }
  3551. template <typename ClientType>
  3552. inline Result Delete(ClientType &cli, const std::string &path,
  3553. const std::string &body, const std::string &content_type,
  3554. size_t chunk_size = 8192) {
  3555. return Result{cli.open_stream("DELETE", path, {}, {}, body, content_type),
  3556. chunk_size};
  3557. }
  3558. template <typename ClientType>
  3559. inline Result Delete(ClientType &cli, const std::string &path,
  3560. const Headers &headers, const std::string &body,
  3561. const std::string &content_type,
  3562. size_t chunk_size = 8192) {
  3563. return Result{
  3564. cli.open_stream("DELETE", path, {}, headers, body, content_type),
  3565. chunk_size};
  3566. }
  3567. template <typename ClientType>
  3568. inline Result Delete(ClientType &cli, const std::string &path,
  3569. const Params &params, size_t chunk_size = 8192) {
  3570. return Result{cli.open_stream("DELETE", path, params), chunk_size};
  3571. }
  3572. template <typename ClientType>
  3573. inline Result Delete(ClientType &cli, const std::string &path,
  3574. const Params &params, const Headers &headers,
  3575. size_t chunk_size = 8192) {
  3576. return Result{cli.open_stream("DELETE", path, params, headers), chunk_size};
  3577. }
  3578. template <typename ClientType>
  3579. inline Result Delete(ClientType &cli, const std::string &path,
  3580. const Params &params, const std::string &body,
  3581. const std::string &content_type,
  3582. size_t chunk_size = 8192) {
  3583. return Result{cli.open_stream("DELETE", path, params, {}, body, content_type),
  3584. chunk_size};
  3585. }
  3586. template <typename ClientType>
  3587. inline Result Delete(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("DELETE", path, params, headers, body, content_type),
  3593. chunk_size};
  3594. }
  3595. // HEAD
  3596. template <typename ClientType>
  3597. inline Result Head(ClientType &cli, const std::string &path,
  3598. size_t chunk_size = 8192) {
  3599. return Result{cli.open_stream("HEAD", path), chunk_size};
  3600. }
  3601. template <typename ClientType>
  3602. inline Result Head(ClientType &cli, const std::string &path,
  3603. const Headers &headers, size_t chunk_size = 8192) {
  3604. return Result{cli.open_stream("HEAD", path, {}, headers), chunk_size};
  3605. }
  3606. template <typename ClientType>
  3607. inline Result Head(ClientType &cli, const std::string &path,
  3608. const Params &params, size_t chunk_size = 8192) {
  3609. return Result{cli.open_stream("HEAD", path, params), chunk_size};
  3610. }
  3611. template <typename ClientType>
  3612. inline Result Head(ClientType &cli, const std::string &path,
  3613. const Params &params, const Headers &headers,
  3614. size_t chunk_size = 8192) {
  3615. return Result{cli.open_stream("HEAD", path, params, headers), chunk_size};
  3616. }
  3617. // OPTIONS
  3618. template <typename ClientType>
  3619. inline Result Options(ClientType &cli, const std::string &path,
  3620. size_t chunk_size = 8192) {
  3621. return Result{cli.open_stream("OPTIONS", path), chunk_size};
  3622. }
  3623. template <typename ClientType>
  3624. inline Result Options(ClientType &cli, const std::string &path,
  3625. const Headers &headers, size_t chunk_size = 8192) {
  3626. return Result{cli.open_stream("OPTIONS", path, {}, headers), chunk_size};
  3627. }
  3628. template <typename ClientType>
  3629. inline Result Options(ClientType &cli, const std::string &path,
  3630. const Params &params, size_t chunk_size = 8192) {
  3631. return Result{cli.open_stream("OPTIONS", path, params), chunk_size};
  3632. }
  3633. template <typename ClientType>
  3634. inline Result Options(ClientType &cli, const std::string &path,
  3635. const Params &params, const Headers &headers,
  3636. size_t chunk_size = 8192) {
  3637. return Result{cli.open_stream("OPTIONS", path, params, headers), chunk_size};
  3638. }
  3639. } // namespace stream
  3640. namespace sse {
  3641. struct SSEMessage {
  3642. std::string event; // Event type (default: "message")
  3643. std::string data; // Event payload
  3644. std::string id; // Event ID for Last-Event-ID header
  3645. SSEMessage();
  3646. void clear();
  3647. };
  3648. class SSEClient {
  3649. public:
  3650. using MessageHandler = std::function<void(const SSEMessage &)>;
  3651. using ErrorHandler = std::function<void(Error)>;
  3652. using OpenHandler = std::function<void()>;
  3653. SSEClient(Client &client, const std::string &path);
  3654. SSEClient(Client &client, const std::string &path, const Headers &headers);
  3655. ~SSEClient();
  3656. SSEClient(const SSEClient &) = delete;
  3657. SSEClient &operator=(const SSEClient &) = delete;
  3658. // Event handlers
  3659. SSEClient &on_message(MessageHandler handler);
  3660. SSEClient &on_event(const std::string &type, MessageHandler handler);
  3661. SSEClient &on_open(OpenHandler handler);
  3662. SSEClient &on_error(ErrorHandler handler);
  3663. SSEClient &set_reconnect_interval(int ms);
  3664. SSEClient &set_max_reconnect_attempts(int n);
  3665. // Update headers (thread-safe)
  3666. SSEClient &set_headers(const Headers &headers);
  3667. // State accessors
  3668. bool is_connected() const;
  3669. const std::string &last_event_id() const;
  3670. // Blocking start - runs event loop with auto-reconnect
  3671. void start();
  3672. // Non-blocking start - runs in background thread
  3673. void start_async();
  3674. // Stop the client (thread-safe)
  3675. void stop();
  3676. private:
  3677. bool parse_sse_line(const std::string &line, SSEMessage &msg, int &retry_ms,
  3678. bool &has_data, bool &has_id);
  3679. void run_event_loop();
  3680. void dispatch_event(const SSEMessage &msg);
  3681. bool should_reconnect(int count) const;
  3682. void wait_for_reconnect();
  3683. // Client and path
  3684. Client &client_;
  3685. std::string path_;
  3686. Headers headers_;
  3687. mutable std::mutex headers_mutex_;
  3688. // Callbacks
  3689. MessageHandler on_message_;
  3690. std::map<std::string, MessageHandler> event_handlers_;
  3691. OpenHandler on_open_;
  3692. ErrorHandler on_error_;
  3693. // Configuration
  3694. int reconnect_interval_ms_ = 3000;
  3695. int max_reconnect_attempts_ = 0; // 0 = unlimited
  3696. // State
  3697. std::atomic<bool> running_{false};
  3698. std::atomic<bool> connected_{false};
  3699. std::string last_event_id_;
  3700. // Socket of the open stream, for stop() to shut down
  3701. std::mutex stream_mutex_;
  3702. socket_t stream_sock_ = INVALID_SOCKET;
  3703. // Async support
  3704. std::thread async_thread_;
  3705. };
  3706. } // namespace sse
  3707. namespace ws {
  3708. class WebSocketClient;
  3709. enum class Opcode : uint8_t {
  3710. Continuation = 0x0,
  3711. Text = 0x1,
  3712. Binary = 0x2,
  3713. Close = 0x8,
  3714. Ping = 0x9,
  3715. Pong = 0xA,
  3716. };
  3717. enum class CloseStatus : uint16_t {
  3718. Normal = 1000,
  3719. GoingAway = 1001,
  3720. ProtocolError = 1002,
  3721. UnsupportedData = 1003,
  3722. NoStatus = 1005,
  3723. Abnormal = 1006,
  3724. InvalidPayload = 1007,
  3725. PolicyViolation = 1008,
  3726. MessageTooBig = 1009,
  3727. MandatoryExtension = 1010,
  3728. InternalError = 1011,
  3729. };
  3730. // Timeout is returned only when a read timeout was set and it elapsed before
  3731. // any byte of a frame arrived: nothing was consumed and the connection is
  3732. // still open, so the caller can send on it and read again. `msg` is left
  3733. // untouched, so a `while (ws.read(msg))` loop must not treat it as a message.
  3734. enum ReadResult : int { Fail = 0, Text = 1, Binary = 2, Timeout = 3 };
  3735. // Result of WebSocketClient::connect(). Truthy only when the WebSocket
  3736. // upgrade handshake fully succeeded. On failure error() identifies the
  3737. // failing layer; status()/headers() expose the server's upgrade response
  3738. // when one was received (status() is -1 otherwise), or the proxy's reply to
  3739. // CONNECT when error() is ProxyConnection.
  3740. class Result {
  3741. public:
  3742. Result() = default;
  3743. Result(Error err, int status, Headers &&headers)
  3744. : err_(err), status_(status), headers_(std::move(headers)) {}
  3745. explicit operator bool() const { return err_ == Error::Success; }
  3746. Error error() const { return err_; }
  3747. // Upgrade response info
  3748. int status() const { return status_; }
  3749. const Headers &headers() const { return headers_; }
  3750. std::string get_header_value(const std::string &key,
  3751. const char *def = "") const {
  3752. return detail::get_header_value(headers_, key, def, 0);
  3753. }
  3754. bool has_header(const std::string &key) const {
  3755. return headers_.find(key) != headers_.end();
  3756. }
  3757. #ifdef CPPHTTPLIB_SSL_ENABLED
  3758. Result(Error err, int status, Headers &&headers, int ssl_error,
  3759. uint64_t ssl_backend_error)
  3760. : err_(err), status_(status), headers_(std::move(headers)),
  3761. ssl_error_(ssl_error), ssl_backend_error_(ssl_backend_error) {}
  3762. int ssl_error() const { return ssl_error_; }
  3763. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  3764. #endif
  3765. private:
  3766. Error err_ = Error::Unknown; // a default-constructed Result is falsy
  3767. int status_ = -1;
  3768. Headers headers_;
  3769. #ifdef CPPHTTPLIB_SSL_ENABLED
  3770. int ssl_error_ = 0;
  3771. uint64_t ssl_backend_error_ = 0;
  3772. #endif
  3773. };
  3774. class WebSocket {
  3775. public:
  3776. WebSocket(const WebSocket &) = delete;
  3777. WebSocket &operator=(const WebSocket &) = delete;
  3778. ~WebSocket();
  3779. ReadResult read(std::string &msg);
  3780. bool send(const std::string &data);
  3781. bool send(const char *data, size_t len);
  3782. void close(CloseStatus status = CloseStatus::Normal,
  3783. const std::string &reason = "");
  3784. const Request &request() const;
  3785. bool is_open() const;
  3786. // Bound how long read() waits before returning Timeout. 0 waits forever.
  3787. // A server handler owns its connection's timeout this way; a client sets it
  3788. // through WebSocketClient. Safe to call while another thread is in read().
  3789. //
  3790. // Only a timeout set here is reported as Timeout. The compile-time default
  3791. // (CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND) is a backstop rather
  3792. // than a request for control, so when it elapses read() returns Fail and
  3793. // closes the connection, and `while (ws.read(msg))` ends as it always has.
  3794. void set_read_timeout(time_t sec, time_t usec = 0);
  3795. template <class Rep, class Period>
  3796. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3797. private:
  3798. friend class httplib::Server;
  3799. friend class httplib::ws::WebSocketClient;
  3800. WebSocket(
  3801. Stream &strm, const Request &req, bool is_server,
  3802. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3803. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3804. : strm_(strm), req_(req), is_server_(is_server),
  3805. ping_interval_sec_(ping_interval_sec),
  3806. max_missed_pongs_(max_missed_pongs) {
  3807. start_heartbeat();
  3808. }
  3809. WebSocket(
  3810. std::unique_ptr<Stream> &&owned_strm, const Request &req, bool is_server,
  3811. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3812. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3813. : strm_(*owned_strm), owned_strm_(std::move(owned_strm)), req_(req),
  3814. is_server_(is_server), ping_interval_sec_(ping_interval_sec),
  3815. max_missed_pongs_(max_missed_pongs) {
  3816. start_heartbeat();
  3817. }
  3818. void start_heartbeat();
  3819. bool send_frame(Opcode op, const char *data, size_t len, bool fin = true);
  3820. Stream &strm_;
  3821. std::unique_ptr<Stream> owned_strm_;
  3822. Request req_;
  3823. bool is_server_;
  3824. time_t ping_interval_sec_;
  3825. int max_missed_pongs_;
  3826. int unacked_pings_ = 0;
  3827. std::atomic<bool> closed_{false};
  3828. // Set once the caller has bounded read() through set_read_timeout(). Until
  3829. // then the timeout in effect is the compile-time default, and elapsing it
  3830. // is a failure that closes the connection, not a Timeout.
  3831. std::atomic<bool> read_timeout_set_{false};
  3832. std::mutex write_mutex_;
  3833. // Owned by whichever thread is parsing frames off strm_. Only one thread
  3834. // may do so: read_websocket_frame() reads a payload until it has the whole
  3835. // declared length, so a second parser stealing bytes silently corrupts the
  3836. // message the first one is assembling.
  3837. std::mutex read_mutex_;
  3838. std::thread ping_thread_;
  3839. std::mutex ping_mutex_;
  3840. std::condition_variable ping_cv_;
  3841. };
  3842. class WebSocketClient {
  3843. public:
  3844. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3845. const Headers &headers = {});
  3846. ~WebSocketClient();
  3847. WebSocketClient(const WebSocketClient &) = delete;
  3848. WebSocketClient &operator=(const WebSocketClient &) = delete;
  3849. bool is_valid() const;
  3850. Result connect();
  3851. ReadResult read(std::string &msg);
  3852. bool send(const std::string &data);
  3853. bool send(const char *data, size_t len);
  3854. void close(CloseStatus status = CloseStatus::Normal,
  3855. const std::string &reason = "");
  3856. bool is_open() const;
  3857. const std::string &subprotocol() const;
  3858. void set_read_timeout(time_t sec, time_t usec = 0);
  3859. template <class Rep, class Period>
  3860. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3861. void set_write_timeout(time_t sec, time_t usec = 0);
  3862. template <class Rep, class Period>
  3863. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  3864. void set_websocket_ping_interval(time_t sec);
  3865. void set_websocket_max_missed_pongs(int count);
  3866. void set_tcp_nodelay(bool on);
  3867. void set_address_family(int family);
  3868. void set_ipv6_v6only(bool on);
  3869. void set_socket_options(SocketOptions socket_options);
  3870. void set_connection_timeout(time_t sec, time_t usec = 0);
  3871. template <class Rep, class Period>
  3872. void
  3873. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  3874. void set_interface(const std::string &intf);
  3875. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  3876. void set_proxy(const std::string &host, int port);
  3877. void set_proxy_basic_auth(const std::string &username,
  3878. const std::string &password);
  3879. void set_proxy_bearer_token_auth(const std::string &token);
  3880. void set_no_proxy(const std::vector<std::string> &patterns);
  3881. #ifdef CPPHTTPLIB_SSL_ENABLED
  3882. struct PemMemory {
  3883. const char *cert_pem;
  3884. size_t cert_pem_len;
  3885. const char *key_pem;
  3886. size_t key_pem_len;
  3887. const char *private_key_password;
  3888. };
  3889. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3890. const PemMemory &pem, const Headers &headers = {});
  3891. void set_ca_cert_path(const std::string &ca_cert_file_path,
  3892. const std::string &ca_cert_dir_path = std::string());
  3893. void set_ca_cert_store(tls::ca_store_t store);
  3894. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  3895. void enable_server_certificate_verification(bool enabled);
  3896. void enable_server_hostname_verification(bool enabled);
  3897. void enable_system_ca(bool enabled);
  3898. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  3899. void set_session_verifier(
  3900. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  3901. void set_proxy_digest_auth(const std::string &username,
  3902. const std::string &password);
  3903. #endif
  3904. private:
  3905. void shutdown_and_close();
  3906. std::pair<time_t, time_t> handshake_timeout() const;
  3907. bool create_stream(std::unique_ptr<Stream> &strm, Error &error,
  3908. int &ssl_error, uint64_t &ssl_backend_error);
  3909. void prepare_default_headers(Request &req);
  3910. bool is_proxy_enabled() const;
  3911. bool create_and_connect_socket(Error &error);
  3912. bool send_proxy_connect(Request &req, Response &proxy_res, Error &error);
  3913. bool connect_with_proxy(Response &proxy_res, Error &error);
  3914. std::string host_;
  3915. int port_;
  3916. std::string path_;
  3917. Headers headers_;
  3918. std::string subprotocol_;
  3919. bool is_valid_ = false;
  3920. socket_t sock_ = INVALID_SOCKET;
  3921. std::unique_ptr<WebSocket> ws_;
  3922. time_t read_timeout_sec_ = CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND;
  3923. time_t read_timeout_usec_ = 0;
  3924. bool read_timeout_set_ = false; // see WebSocket::read_timeout_set_
  3925. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  3926. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  3927. time_t websocket_ping_interval_sec_ =
  3928. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  3929. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  3930. int address_family_ = AF_UNSPEC;
  3931. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  3932. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  3933. SocketOptions socket_options_ = nullptr;
  3934. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  3935. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  3936. std::string interface_;
  3937. // Hostname to connection target map. The value is an IP literal or another
  3938. // hostname; only the connection target changes, never the identity.
  3939. std::map<std::string, std::string> addr_map_;
  3940. std::string proxy_host_;
  3941. int proxy_port_ = -1;
  3942. std::string proxy_basic_auth_username_;
  3943. std::string proxy_basic_auth_password_;
  3944. std::string proxy_bearer_token_auth_token_;
  3945. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  3946. #ifdef CPPHTTPLIB_SSL_ENABLED
  3947. bool is_ssl_ = false;
  3948. tls::ctx_t tls_ctx_ = nullptr;
  3949. tls::session_t tls_session_ = nullptr;
  3950. std::string ca_cert_file_path_;
  3951. std::string ca_cert_dir_path_;
  3952. bool custom_ca_loaded_ = false;
  3953. bool certs_loaded_ = false;
  3954. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  3955. bool server_certificate_verification_ = true;
  3956. bool server_hostname_verification_ = true;
  3957. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  3958. std::string proxy_digest_auth_username_;
  3959. std::string proxy_digest_auth_password_;
  3960. #endif
  3961. };
  3962. template <class Rep, class Period>
  3963. inline void WebSocket::set_read_timeout(
  3964. const std::chrono::duration<Rep, Period> &duration) {
  3965. detail::duration_to_sec_and_usec(
  3966. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3967. }
  3968. template <class Rep, class Period>
  3969. inline void WebSocketClient::set_read_timeout(
  3970. const std::chrono::duration<Rep, Period> &duration) {
  3971. detail::duration_to_sec_and_usec(
  3972. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3973. }
  3974. template <class Rep, class Period>
  3975. inline void WebSocketClient::set_write_timeout(
  3976. const std::chrono::duration<Rep, Period> &duration) {
  3977. detail::duration_to_sec_and_usec(
  3978. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3979. }
  3980. template <class Rep, class Period>
  3981. inline void WebSocketClient::set_connection_timeout(
  3982. const std::chrono::duration<Rep, Period> &duration) {
  3983. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  3984. set_connection_timeout(sec, usec);
  3985. });
  3986. }
  3987. namespace impl {
  3988. bool is_valid_utf8(const std::string &s);
  3989. // Three states, because a failure that consumed bytes and one that consumed
  3990. // none are not the same thing: the first has left the stream in the middle of
  3991. // a frame and the connection cannot be reused, the second can just be retried.
  3992. enum class FrameRead { Ok, Fail, Timeout };
  3993. FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  3994. std::string &payload, bool &fin,
  3995. bool expect_masked, size_t max_len);
  3996. } // namespace impl
  3997. } // namespace ws
  3998. // ----------------------------------------------------------------------------
  3999. /*
  4000. * Implementation that will be part of the .cc file if split into .h + .cc.
  4001. */
  4002. namespace stream {
  4003. // stream::Result implementations
  4004. inline Result::Result() : chunk_size_(8192) {}
  4005. inline Result::Result(ClientImpl::StreamHandle &&handle, size_t chunk_size)
  4006. : handle_(std::move(handle)), chunk_size_(chunk_size) {}
  4007. inline Result::Result(Result &&other) noexcept
  4008. : handle_(std::move(other.handle_)), buffer_(std::move(other.buffer_)),
  4009. current_size_(other.current_size_), chunk_size_(other.chunk_size_),
  4010. finished_(other.finished_) {
  4011. other.current_size_ = 0;
  4012. other.finished_ = true;
  4013. }
  4014. inline Result &Result::operator=(Result &&other) noexcept {
  4015. if (this != &other) {
  4016. handle_ = std::move(other.handle_);
  4017. buffer_ = std::move(other.buffer_);
  4018. current_size_ = other.current_size_;
  4019. chunk_size_ = other.chunk_size_;
  4020. finished_ = other.finished_;
  4021. other.current_size_ = 0;
  4022. other.finished_ = true;
  4023. }
  4024. return *this;
  4025. }
  4026. inline bool Result::is_valid() const { return handle_.is_valid(); }
  4027. inline Result::operator bool() const { return is_valid(); }
  4028. inline int Result::status() const {
  4029. return handle_.response ? handle_.response->status : -1;
  4030. }
  4031. inline const Headers &Result::headers() const {
  4032. static const Headers empty_headers;
  4033. return handle_.response ? handle_.response->headers : empty_headers;
  4034. }
  4035. inline std::string Result::get_header_value(const std::string &key,
  4036. const char *def) const {
  4037. return handle_.response ? handle_.response->get_header_value(key, def) : def;
  4038. }
  4039. inline bool Result::has_header(const std::string &key) const {
  4040. return handle_.response ? handle_.response->has_header(key) : false;
  4041. }
  4042. inline Error Result::error() const { return handle_.error; }
  4043. inline Error Result::read_error() const { return handle_.get_read_error(); }
  4044. inline bool Result::has_read_error() const { return handle_.has_read_error(); }
  4045. inline bool Result::next() {
  4046. if (!handle_.is_valid() || finished_) { return false; }
  4047. if (buffer_.size() < chunk_size_) { buffer_.resize(chunk_size_); }
  4048. ssize_t n = handle_.read(&buffer_[0], chunk_size_);
  4049. if (n > 0) {
  4050. current_size_ = static_cast<size_t>(n);
  4051. return true;
  4052. }
  4053. current_size_ = 0;
  4054. finished_ = true;
  4055. return false;
  4056. }
  4057. inline const char *Result::data() const { return buffer_.data(); }
  4058. inline size_t Result::size() const { return current_size_; }
  4059. inline std::string Result::read_all() {
  4060. std::string result;
  4061. while (next()) {
  4062. result.append(data(), size());
  4063. }
  4064. return result;
  4065. }
  4066. } // namespace stream
  4067. namespace sse {
  4068. // SSEMessage implementations
  4069. inline SSEMessage::SSEMessage() : event("message") {}
  4070. inline void SSEMessage::clear() {
  4071. event = "message";
  4072. data.clear();
  4073. id.clear();
  4074. }
  4075. // SSEClient implementations
  4076. inline SSEClient::SSEClient(Client &client, const std::string &path)
  4077. : client_(client), path_(path) {}
  4078. inline SSEClient::SSEClient(Client &client, const std::string &path,
  4079. const Headers &headers)
  4080. : client_(client), path_(path), headers_(headers) {}
  4081. inline SSEClient::~SSEClient() { stop(); }
  4082. inline SSEClient &SSEClient::on_message(MessageHandler handler) {
  4083. on_message_ = std::move(handler);
  4084. return *this;
  4085. }
  4086. inline SSEClient &SSEClient::on_event(const std::string &type,
  4087. MessageHandler handler) {
  4088. event_handlers_[type] = std::move(handler);
  4089. return *this;
  4090. }
  4091. inline SSEClient &SSEClient::on_open(OpenHandler handler) {
  4092. on_open_ = std::move(handler);
  4093. return *this;
  4094. }
  4095. inline SSEClient &SSEClient::on_error(ErrorHandler handler) {
  4096. on_error_ = std::move(handler);
  4097. return *this;
  4098. }
  4099. inline SSEClient &SSEClient::set_reconnect_interval(int ms) {
  4100. reconnect_interval_ms_ = ms;
  4101. return *this;
  4102. }
  4103. inline SSEClient &SSEClient::set_max_reconnect_attempts(int n) {
  4104. max_reconnect_attempts_ = n;
  4105. return *this;
  4106. }
  4107. inline SSEClient &SSEClient::set_headers(const Headers &headers) {
  4108. std::lock_guard<std::mutex> lock(headers_mutex_);
  4109. headers_ = headers;
  4110. return *this;
  4111. }
  4112. inline bool SSEClient::is_connected() const { return connected_.load(); }
  4113. inline const std::string &SSEClient::last_event_id() const {
  4114. return last_event_id_;
  4115. }
  4116. inline void SSEClient::start() {
  4117. running_.store(true);
  4118. run_event_loop();
  4119. }
  4120. inline void SSEClient::start_async() {
  4121. running_.store(true);
  4122. async_thread_ = std::thread([this]() { run_event_loop(); });
  4123. }
  4124. inline void SSEClient::stop() {
  4125. running_.store(false);
  4126. {
  4127. // Ends a blocked read. The loop withdraws the socket under this lock
  4128. // before closing it, so it is still open here.
  4129. std::lock_guard<std::mutex> lock(stream_mutex_);
  4130. if (stream_sock_ != INVALID_SOCKET) {
  4131. #ifdef _WIN32
  4132. ::shutdown(stream_sock_, SD_BOTH);
  4133. #else
  4134. // Only the read side, so that the alert TLS sends on the unexpected EOF
  4135. // does not raise SIGPIPE
  4136. ::shutdown(stream_sock_, SHUT_RD);
  4137. #endif
  4138. }
  4139. }
  4140. client_.stop(); // Cancel any pending operations
  4141. if (async_thread_.joinable()) { async_thread_.join(); }
  4142. }
  4143. inline bool SSEClient::parse_sse_line(const std::string &line, SSEMessage &msg,
  4144. int &retry_ms, bool &has_data,
  4145. bool &has_id) {
  4146. // Blank line signals end of event
  4147. if (line.empty()) { return true; }
  4148. // Lines starting with ':' are comments (ignored)
  4149. if (line[0] == ':') { return false; }
  4150. // Find the colon separator
  4151. auto colon_pos = line.find(':');
  4152. auto field = line.substr(0, colon_pos);
  4153. std::string value;
  4154. // Value starts after colon, skip optional single space
  4155. if (colon_pos != std::string::npos && colon_pos + 1 < line.size()) {
  4156. auto value_start = colon_pos + 1;
  4157. if (line[value_start] == ' ') { value_start++; }
  4158. value = line.substr(value_start);
  4159. }
  4160. // Handle known fields
  4161. if (field == "event") {
  4162. msg.event = value;
  4163. } else if (field == "data") {
  4164. // Multiple data lines are concatenated with newlines
  4165. if (has_data) { msg.data += "\n"; }
  4166. msg.data += value;
  4167. has_data = true;
  4168. } else if (field == "id") {
  4169. // An id that cannot be sent back as Last-Event-ID is ignored. Empty id is
  4170. // valid (clears the last event ID)
  4171. if (detail::fields::is_field_value(value)) {
  4172. msg.id = value;
  4173. has_id = true;
  4174. }
  4175. } else if (field == "retry") {
  4176. // Parse retry interval in milliseconds
  4177. // Per the SSE spec, a value that is not all ASCII digits is ignored.
  4178. if (detail::is_numeric(value)) {
  4179. int v = 0;
  4180. auto res =
  4181. detail::from_chars(value.data(), value.data() + value.size(), v);
  4182. if (res.ec == std::errc{}) { retry_ms = v; }
  4183. }
  4184. }
  4185. // Unknown fields are ignored per SSE spec
  4186. return false;
  4187. }
  4188. inline void SSEClient::run_event_loop() {
  4189. auto reconnect_count = 0;
  4190. while (running_.load()) {
  4191. // Build headers, including Last-Event-ID if we have one
  4192. Headers request_headers;
  4193. {
  4194. std::lock_guard<std::mutex> lock(headers_mutex_);
  4195. request_headers = headers_;
  4196. }
  4197. if (!last_event_id_.empty()) {
  4198. request_headers.emplace("Last-Event-ID", last_event_id_);
  4199. }
  4200. // Open streaming connection. An event stream has no end, so each event is
  4201. // bounded instead of the whole body.
  4202. auto handle = client_.open_stream("GET", path_, {}, request_headers);
  4203. handle.body_reader_.payload_max_length = 0;
  4204. auto sock = handle.connection_ ? handle.connection_->sock : INVALID_SOCKET;
  4205. stream::Result result{std::move(handle)};
  4206. // Connection error handling
  4207. if (!result) {
  4208. connected_.store(false);
  4209. if (on_error_) { on_error_(result.error()); }
  4210. if (!should_reconnect(reconnect_count)) { break; }
  4211. wait_for_reconnect();
  4212. reconnect_count++;
  4213. continue;
  4214. }
  4215. if (result.status() != StatusCode::OK_200) {
  4216. connected_.store(false);
  4217. if (on_error_) { on_error_(Error::Connection); }
  4218. // For certain errors, don't reconnect.
  4219. // Note: 401 is intentionally absent so that handlers can refresh
  4220. // credentials via set_headers() and let the client reconnect.
  4221. if (result.status() == StatusCode::NoContent_204 ||
  4222. result.status() == StatusCode::NotFound_404 ||
  4223. result.status() == StatusCode::Forbidden_403) {
  4224. break;
  4225. }
  4226. if (!should_reconnect(reconnect_count)) { break; }
  4227. wait_for_reconnect();
  4228. reconnect_count++;
  4229. continue;
  4230. }
  4231. // Hand the socket to stop(), unless it has already been called
  4232. {
  4233. std::lock_guard<std::mutex> lock(stream_mutex_);
  4234. if (!running_.load()) { break; }
  4235. stream_sock_ = sock;
  4236. }
  4237. // Destroyed before result, so the socket is withdrawn before it is closed
  4238. detail::scope_exit withdraw_sock([this] {
  4239. std::lock_guard<std::mutex> lock(stream_mutex_);
  4240. stream_sock_ = INVALID_SOCKET;
  4241. });
  4242. // Connection successful
  4243. connected_.store(true);
  4244. reconnect_count = 0;
  4245. if (on_open_) { on_open_(); }
  4246. // Event receiving loop
  4247. std::string buffer;
  4248. SSEMessage current_msg;
  4249. auto has_data = false;
  4250. auto has_id = false;
  4251. auto first_line = true;
  4252. auto after_cr = false;
  4253. auto event_too_long = false;
  4254. while (running_.load() && result.next()) {
  4255. // What is left in the buffer has no line ending
  4256. auto search_pos = buffer.size();
  4257. buffer.append(result.data(), result.size());
  4258. // Process complete lines in the buffer. A line ends with \r\n, \n or \r
  4259. // per the SSE spec
  4260. size_t line_start = 0;
  4261. size_t eol_pos;
  4262. while ((eol_pos = buffer.find_first_of("\r\n", search_pos)) !=
  4263. std::string::npos) {
  4264. auto line = buffer.substr(line_start, eol_pos - line_start);
  4265. line_start = eol_pos + 1;
  4266. search_pos = line_start;
  4267. // The \n of a \r\n may arrive in a later chunk than its \r
  4268. auto is_lf_of_crlf =
  4269. after_cr && line.empty() && buffer[eol_pos] == '\n';
  4270. after_cr = buffer[eol_pos] == '\r';
  4271. if (is_lf_of_crlf) { continue; }
  4272. // A UTF-8 BOM at the start of the stream is ignored per the SSE spec
  4273. if (first_line) {
  4274. first_line = false;
  4275. if (line.compare(0, 3, "\xEF\xBB\xBF") == 0) { line.erase(0, 3); }
  4276. }
  4277. // Parse the line and check if event is complete
  4278. auto event_complete = parse_sse_line(
  4279. line, current_msg, reconnect_interval_ms_, has_data, has_id);
  4280. if (event_complete) {
  4281. // Update last_event_id for reconnection, even for an event that
  4282. // has no data. An empty id clears it.
  4283. if (has_id) { last_event_id_ = current_msg.id; }
  4284. // An event without a data field is not dispatched
  4285. if (has_data) { dispatch_event(current_msg); }
  4286. // Reset the message for the next event either way
  4287. current_msg.clear();
  4288. has_data = false;
  4289. has_id = false;
  4290. }
  4291. }
  4292. // Keep unprocessed data in buffer
  4293. buffer.erase(0, line_start);
  4294. // Neither an event nor a line still waiting for its end may grow
  4295. // without bound. 0 means no limit.
  4296. if (CPPHTTPLIB_SSE_MAX_EVENT_LENGTH > 0 &&
  4297. buffer.size() + current_msg.data.size() >
  4298. CPPHTTPLIB_SSE_MAX_EVENT_LENGTH) {
  4299. if (on_error_) { on_error_(Error::ExceedMaxPayloadSize); }
  4300. event_too_long = true;
  4301. break;
  4302. }
  4303. }
  4304. // Connection ended
  4305. connected_.store(false);
  4306. // Reconnecting would only get the same event again
  4307. if (!running_.load() || event_too_long) { break; }
  4308. // Check for read errors
  4309. if (result.has_read_error()) {
  4310. if (on_error_) { on_error_(result.read_error()); }
  4311. }
  4312. if (!should_reconnect(reconnect_count)) { break; }
  4313. wait_for_reconnect();
  4314. reconnect_count++;
  4315. }
  4316. connected_.store(false);
  4317. }
  4318. inline void SSEClient::dispatch_event(const SSEMessage &msg) {
  4319. // Check for specific event type handler first
  4320. auto it = event_handlers_.find(msg.event);
  4321. if (it != event_handlers_.end()) {
  4322. it->second(msg);
  4323. return;
  4324. }
  4325. // Fall back to generic message handler
  4326. if (on_message_) { on_message_(msg); }
  4327. }
  4328. inline bool SSEClient::should_reconnect(int count) const {
  4329. if (!running_.load()) { return false; }
  4330. if (max_reconnect_attempts_ == 0) { return true; } // unlimited
  4331. return count < max_reconnect_attempts_;
  4332. }
  4333. inline void SSEClient::wait_for_reconnect() {
  4334. // Use small increments to check running_ flag frequently.
  4335. // Always wait at least one increment, so that a zero interval (e.g.
  4336. // "retry: 0" from the server) cannot cause a busy reconnect loop.
  4337. const auto step_ms = 100;
  4338. auto interval_ms = (std::max)(reconnect_interval_ms_, step_ms);
  4339. auto waited = 0;
  4340. while (running_.load() && waited < interval_ms) {
  4341. std::this_thread::sleep_for(std::chrono::milliseconds(step_ms));
  4342. waited += step_ms;
  4343. }
  4344. }
  4345. } // namespace sse
  4346. #ifdef CPPHTTPLIB_SSL_ENABLED
  4347. /*
  4348. * TLS abstraction layer - internal function declarations
  4349. * These are implementation details and not part of the public API.
  4350. */
  4351. namespace tls {
  4352. // Client context
  4353. ctx_t create_client_context();
  4354. void free_context(ctx_t ctx);
  4355. bool set_min_version(ctx_t ctx, Version version);
  4356. bool load_ca_pem(ctx_t ctx, const char *pem, size_t len);
  4357. bool load_ca_file(ctx_t ctx, const char *file_path);
  4358. bool load_ca_dir(ctx_t ctx, const char *dir_path);
  4359. bool load_system_certs(ctx_t ctx);
  4360. bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4361. const char *password);
  4362. bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  4363. const char *key_path, const char *password);
  4364. // Server context
  4365. ctx_t create_server_context();
  4366. bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4367. const char *password);
  4368. bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  4369. const char *key_path, const char *password);
  4370. bool set_client_ca_file(ctx_t ctx, const char *ca_file, const char *ca_dir);
  4371. void set_verify_client(ctx_t ctx, bool require);
  4372. // Session management
  4373. session_t create_session(ctx_t ctx, socket_t sock);
  4374. void free_session(session_t session);
  4375. bool set_sni(session_t session, const char *hostname, bool verify_hostname);
  4376. // Handshake (non-blocking capable)
  4377. TlsError connect(session_t session);
  4378. TlsError accept(session_t session);
  4379. // Handshake with timeout (blocking until timeout)
  4380. bool connect_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4381. time_t timeout_usec, TlsError *err);
  4382. bool accept_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4383. time_t timeout_usec, TlsError *err);
  4384. // I/O (non-blocking capable)
  4385. ssize_t read(session_t session, void *buf, size_t len, TlsError &err);
  4386. ssize_t write(session_t session, const void *buf, size_t len, TlsError &err);
  4387. int pending(const_session_t session);
  4388. void shutdown(session_t session, bool graceful);
  4389. // Connection state
  4390. bool is_peer_closed(session_t session, socket_t sock);
  4391. // Certificate verification
  4392. cert_t get_peer_cert(const_session_t session);
  4393. // The certificates the peer sent, leaf first. Free each with free_cert(), and
  4394. // do not use them after free_session(), as with get_peer_cert().
  4395. size_t get_peer_certs(const_session_t session, std::vector<cert_t> &certs);
  4396. void free_cert(cert_t cert);
  4397. bool verify_hostname(cert_t cert, const char *hostname);
  4398. uint64_t hostname_mismatch_code();
  4399. long get_verify_result(const_session_t session);
  4400. // Certificate introspection
  4401. std::string get_cert_subject_cn(cert_t cert);
  4402. std::string get_cert_issuer_name(cert_t cert);
  4403. bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans);
  4404. bool get_cert_validity(cert_t cert, time_t &not_before, time_t &not_after);
  4405. std::string get_cert_serial(cert_t cert);
  4406. bool get_cert_der(cert_t cert, std::vector<unsigned char> &der);
  4407. const char *get_sni(const_session_t session);
  4408. // CA store management
  4409. ca_store_t create_ca_store(const char *pem, size_t len);
  4410. void free_ca_store(ca_store_t store);
  4411. bool set_ca_store(ctx_t ctx, ca_store_t store);
  4412. // Free each with free_cert(), and do not use them once the context's CA
  4413. // certificates change.
  4414. size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs);
  4415. std::vector<std::string> get_ca_names(ctx_t ctx);
  4416. // Dynamic certificate update (for servers)
  4417. bool update_server_cert(ctx_t ctx, const char *cert_pem, const char *key_pem,
  4418. const char *password);
  4419. bool update_server_client_ca(ctx_t ctx, const char *ca_pem);
  4420. // Certificate verification callback
  4421. bool set_verify_callback(ctx_t ctx, VerifyCallback callback);
  4422. long get_verify_error(const_session_t session);
  4423. std::string verify_error_string(long error_code);
  4424. // TlsError information
  4425. uint64_t peek_error();
  4426. uint64_t get_error();
  4427. std::string error_string(uint64_t code);
  4428. } // namespace tls
  4429. #endif // CPPHTTPLIB_SSL_ENABLED
  4430. /*
  4431. * Group 1: detail namespace - Non-SSL utilities
  4432. */
  4433. namespace detail {
  4434. inline bool set_socket_opt_impl(socket_t sock, int level, int optname,
  4435. const void *optval, socklen_t optlen) {
  4436. return setsockopt(sock, level, optname,
  4437. #ifdef _WIN32
  4438. reinterpret_cast<const char *>(optval),
  4439. #else
  4440. optval,
  4441. #endif
  4442. optlen) == 0;
  4443. }
  4444. inline bool set_socket_opt_time(socket_t sock, int level, int optname,
  4445. time_t sec, time_t usec) {
  4446. #ifdef _WIN32
  4447. auto timeout = static_cast<uint32_t>(sec * 1000 + usec / 1000);
  4448. #else
  4449. timeval timeout;
  4450. timeout.tv_sec = static_cast<long>(sec);
  4451. timeout.tv_usec = static_cast<decltype(timeout.tv_usec)>(usec);
  4452. #endif
  4453. return set_socket_opt_impl(sock, level, optname, &timeout, sizeof(timeout));
  4454. }
  4455. inline bool is_hex(char c, int &v) {
  4456. if (is_ascii_digit(c)) {
  4457. v = c - '0';
  4458. return true;
  4459. } else if ('A' <= c && c <= 'F') {
  4460. v = c - 'A' + 10;
  4461. return true;
  4462. } else if ('a' <= c && c <= 'f') {
  4463. v = c - 'a' + 10;
  4464. return true;
  4465. }
  4466. return false;
  4467. }
  4468. inline bool from_hex_to_i(const std::string &s, size_t i, size_t cnt,
  4469. int &val) {
  4470. if (i >= s.size()) { return false; }
  4471. val = 0;
  4472. for (; cnt; i++, cnt--) {
  4473. if (!s[i]) { return false; }
  4474. auto v = 0;
  4475. if (is_hex(s[i], v)) {
  4476. val = val * 16 + v;
  4477. } else {
  4478. return false;
  4479. }
  4480. }
  4481. return true;
  4482. }
  4483. inline std::string from_i_to_hex(size_t n) {
  4484. static const auto charset = "0123456789abcdef";
  4485. std::string ret;
  4486. do {
  4487. ret = charset[n & 15] + ret;
  4488. n >>= 4;
  4489. } while (n > 0);
  4490. return ret;
  4491. }
  4492. // A round trip rather than `n <= SIZE_MAX`, which is always true on 64-bit
  4493. // builds and trips -Wtautological-type-limit-compare.
  4494. inline bool fits_in_size_t(uint64_t n) {
  4495. return static_cast<uint64_t>(static_cast<size_t>(n)) == n;
  4496. }
  4497. inline std::string compute_etag(const FileStat &fs,
  4498. const std::string &suffix = std::string()) {
  4499. if (!fs.is_file()) { return std::string(); }
  4500. // If mtime cannot be determined (negative value indicates an error
  4501. // or sentinel), do not generate an ETag. Returning a neutral / fixed
  4502. // value like 0 could collide with a real file that legitimately has
  4503. // mtime == 0 (epoch) and lead to misleading validators.
  4504. auto mtime_raw = fs.mtime();
  4505. if (mtime_raw < 0) { return std::string(); }
  4506. auto mtime = static_cast<size_t>(mtime_raw);
  4507. auto size = fs.size();
  4508. return std::string("W/\"") + from_i_to_hex(mtime) + "-" +
  4509. from_i_to_hex(size) + suffix + "\"";
  4510. }
  4511. // Format time_t as HTTP-date (RFC 9110 Section 5.6.7): "Sun, 06 Nov 1994
  4512. // 08:49:37 GMT" This implementation is defensive: it validates `mtime`, checks
  4513. // return values from `gmtime_r`/`gmtime_s`, and ensures `strftime` succeeds.
  4514. inline std::string file_mtime_to_http_date(time_t mtime) {
  4515. if (mtime < 0) { return std::string(); }
  4516. struct tm tm_buf;
  4517. #ifdef _WIN32
  4518. if (gmtime_s(&tm_buf, &mtime) != 0) { return std::string(); }
  4519. #else
  4520. if (gmtime_r(&mtime, &tm_buf) == nullptr) { return std::string(); }
  4521. #endif
  4522. char buf[64];
  4523. if (strftime(buf, sizeof(buf), "%a, %d %b %Y %H:%M:%S GMT", &tm_buf) == 0) {
  4524. return std::string();
  4525. }
  4526. return std::string(buf);
  4527. }
  4528. // Parse HTTP-date (RFC 9110 Section 5.6.7) to time_t. Returns -1 on failure.
  4529. inline time_t parse_http_date(const std::string &date_str) {
  4530. struct tm tm_buf;
  4531. // Create a classic locale object once for all parsing attempts
  4532. const std::locale classic_locale = std::locale::classic();
  4533. // Try to parse using std::get_time (C++11, cross-platform)
  4534. auto try_parse = [&](const char *fmt) -> bool {
  4535. std::istringstream ss(date_str);
  4536. ss.imbue(classic_locale);
  4537. memset(&tm_buf, 0, sizeof(tm_buf));
  4538. ss >> std::get_time(&tm_buf, fmt);
  4539. return !ss.fail();
  4540. };
  4541. // RFC 9110 preferred format (HTTP-date): "Sun, 06 Nov 1994 08:49:37 GMT"
  4542. if (!try_parse("%a, %d %b %Y %H:%M:%S")) {
  4543. // RFC 850 format: "Sunday, 06-Nov-94 08:49:37 GMT"
  4544. if (!try_parse("%A, %d-%b-%y %H:%M:%S")) {
  4545. // asctime format: "Sun Nov 6 08:49:37 1994"
  4546. if (!try_parse("%a %b %d %H:%M:%S %Y")) {
  4547. return static_cast<time_t>(-1);
  4548. }
  4549. }
  4550. }
  4551. #ifdef _WIN32
  4552. return _mkgmtime(&tm_buf);
  4553. #elif defined _AIX
  4554. return mktime(&tm_buf);
  4555. #else
  4556. return timegm(&tm_buf);
  4557. #endif
  4558. }
  4559. inline bool is_weak_etag(const std::string &s) {
  4560. // Check if the string is a weak ETag (starts with 'W/"')
  4561. return s.size() > 3 && s[0] == 'W' && s[1] == '/' && s[2] == '"';
  4562. }
  4563. inline bool is_strong_etag(const std::string &s) {
  4564. // Check if the string is a strong ETag (starts and ends with '"', at least 2
  4565. // chars)
  4566. return s.size() >= 2 && s[0] == '"' && s.back() == '"';
  4567. }
  4568. inline size_t to_utf8(int code, char *buff) {
  4569. if (code < 0x0080) {
  4570. buff[0] = static_cast<char>(code & 0x7F);
  4571. return 1;
  4572. } else if (code < 0x0800) {
  4573. buff[0] = static_cast<char>(0xC0 | ((code >> 6) & 0x1F));
  4574. buff[1] = static_cast<char>(0x80 | (code & 0x3F));
  4575. return 2;
  4576. } else if (code < 0xD800) {
  4577. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4578. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4579. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4580. return 3;
  4581. } else if (code < 0xE000) { // D800 - DFFF is invalid...
  4582. return 0;
  4583. } else if (code < 0x10000) {
  4584. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4585. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4586. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4587. return 3;
  4588. } else if (code < 0x110000) {
  4589. buff[0] = static_cast<char>(0xF0 | ((code >> 18) & 0x7));
  4590. buff[1] = static_cast<char>(0x80 | ((code >> 12) & 0x3F));
  4591. buff[2] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4592. buff[3] = static_cast<char>(0x80 | (code & 0x3F));
  4593. return 4;
  4594. }
  4595. // NOTREACHED
  4596. return 0;
  4597. }
  4598. } // namespace detail
  4599. namespace ws {
  4600. namespace impl {
  4601. inline bool is_valid_utf8(const std::string &s) {
  4602. size_t i = 0;
  4603. auto n = s.size();
  4604. while (i < n) {
  4605. auto c = static_cast<unsigned char>(s[i]);
  4606. size_t len;
  4607. uint32_t cp;
  4608. if (c < 0x80) {
  4609. i++;
  4610. continue;
  4611. } else if ((c & 0xE0) == 0xC0) {
  4612. len = 2;
  4613. cp = c & 0x1F;
  4614. } else if ((c & 0xF0) == 0xE0) {
  4615. len = 3;
  4616. cp = c & 0x0F;
  4617. } else if ((c & 0xF8) == 0xF0) {
  4618. len = 4;
  4619. cp = c & 0x07;
  4620. } else {
  4621. return false;
  4622. }
  4623. if (i + len > n) { return false; }
  4624. for (size_t j = 1; j < len; j++) {
  4625. auto b = static_cast<unsigned char>(s[i + j]);
  4626. if ((b & 0xC0) != 0x80) { return false; }
  4627. cp = (cp << 6) | (b & 0x3F);
  4628. }
  4629. // Overlong encoding check
  4630. if (len == 2 && cp < 0x80) { return false; }
  4631. if (len == 3 && cp < 0x800) { return false; }
  4632. if (len == 4 && cp < 0x10000) { return false; }
  4633. // Surrogate halves (U+D800..U+DFFF) and beyond U+10FFFF are invalid
  4634. if (cp >= 0xD800 && cp <= 0xDFFF) { return false; }
  4635. if (cp > 0x10FFFF) { return false; }
  4636. i += len;
  4637. }
  4638. return true;
  4639. }
  4640. } // namespace impl
  4641. } // namespace ws
  4642. namespace detail {
  4643. // NOTE: This code came up with the following stackoverflow post:
  4644. // https://stackoverflow.com/questions/180947/base64-decode-snippet-in-c
  4645. inline std::string base64_encode(const std::string &in) {
  4646. static const auto lookup =
  4647. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4648. std::string out;
  4649. out.reserve(in.size());
  4650. // Unsigned: the accumulator is never masked, so with a signed int the
  4651. // `val << 8` below overflows once enough bytes are folded in (undefined
  4652. // behaviour before C++20). Only the low bits are ever emitted, so the
  4653. // wrap-around of an unsigned accumulator does not affect the output.
  4654. uint32_t val = 0;
  4655. auto valb = -6;
  4656. for (auto c : in) {
  4657. val = (val << 8) + static_cast<uint8_t>(c);
  4658. valb += 8;
  4659. while (valb >= 0) {
  4660. out.push_back(lookup[(val >> valb) & 0x3F]);
  4661. valb -= 6;
  4662. }
  4663. }
  4664. if (valb > -6) { out.push_back(lookup[((val << 8) >> (valb + 8)) & 0x3F]); }
  4665. while (out.size() % 4) {
  4666. out.push_back('=');
  4667. }
  4668. return out;
  4669. }
  4670. inline std::string sha1(const std::string &input) {
  4671. // RFC 3174 SHA-1 implementation
  4672. auto left_rotate = [](uint32_t x, uint32_t n) -> uint32_t {
  4673. return (x << n) | (x >> (32 - n));
  4674. };
  4675. uint32_t h0 = 0x67452301;
  4676. uint32_t h1 = 0xEFCDAB89;
  4677. uint32_t h2 = 0x98BADCFE;
  4678. uint32_t h3 = 0x10325476;
  4679. uint32_t h4 = 0xC3D2E1F0;
  4680. // Pre-processing: adding padding bits
  4681. std::string msg = input;
  4682. uint64_t original_bit_len = static_cast<uint64_t>(msg.size()) * 8;
  4683. msg.push_back(static_cast<char>(0x80u));
  4684. while (msg.size() % 64 != 56) {
  4685. msg.push_back(0);
  4686. }
  4687. // Append original length in bits as 64-bit big-endian
  4688. for (int i = 56; i >= 0; i -= 8) {
  4689. msg.push_back(static_cast<char>((original_bit_len >> i) & 0xFF));
  4690. }
  4691. // Process each 512-bit chunk
  4692. for (size_t offset = 0; offset < msg.size(); offset += 64) {
  4693. uint32_t w[80];
  4694. for (size_t i = 0; i < 16; i++) {
  4695. w[i] =
  4696. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4]))
  4697. << 24) |
  4698. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 1]))
  4699. << 16) |
  4700. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 2]))
  4701. << 8) |
  4702. (static_cast<uint32_t>(
  4703. static_cast<uint8_t>(msg[offset + i * 4 + 3])));
  4704. }
  4705. for (int i = 16; i < 80; i++) {
  4706. w[i] = left_rotate(w[i - 3] ^ w[i - 8] ^ w[i - 14] ^ w[i - 16], 1);
  4707. }
  4708. uint32_t a = h0, b = h1, c = h2, d = h3, e = h4;
  4709. for (int i = 0; i < 80; i++) {
  4710. uint32_t f, k;
  4711. if (i < 20) {
  4712. f = (b & c) | ((~b) & d);
  4713. k = 0x5A827999;
  4714. } else if (i < 40) {
  4715. f = b ^ c ^ d;
  4716. k = 0x6ED9EBA1;
  4717. } else if (i < 60) {
  4718. f = (b & c) | (b & d) | (c & d);
  4719. k = 0x8F1BBCDC;
  4720. } else {
  4721. f = b ^ c ^ d;
  4722. k = 0xCA62C1D6;
  4723. }
  4724. uint32_t temp = left_rotate(a, 5) + f + e + k + w[i];
  4725. e = d;
  4726. d = c;
  4727. c = left_rotate(b, 30);
  4728. b = a;
  4729. a = temp;
  4730. }
  4731. h0 += a;
  4732. h1 += b;
  4733. h2 += c;
  4734. h3 += d;
  4735. h4 += e;
  4736. }
  4737. // Produce the final hash as a 20-byte binary string
  4738. std::string hash(20, '\0');
  4739. for (size_t i = 0; i < 4; i++) {
  4740. hash[i] = static_cast<char>((h0 >> (24 - i * 8)) & 0xFF);
  4741. hash[4 + i] = static_cast<char>((h1 >> (24 - i * 8)) & 0xFF);
  4742. hash[8 + i] = static_cast<char>((h2 >> (24 - i * 8)) & 0xFF);
  4743. hash[12 + i] = static_cast<char>((h3 >> (24 - i * 8)) & 0xFF);
  4744. hash[16 + i] = static_cast<char>((h4 >> (24 - i * 8)) & 0xFF);
  4745. }
  4746. return hash;
  4747. }
  4748. inline std::string websocket_accept_key(const std::string &client_key) {
  4749. const std::string magic = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
  4750. return base64_encode(sha1(client_key + magic));
  4751. }
  4752. inline bool is_websocket_upgrade(const Request &req) {
  4753. if (req.method != "GET") { return false; }
  4754. // Check Upgrade: websocket. RFC 9110 7.8 defines Upgrade as a comma-separated
  4755. // list of protocols and asks recipients to match each name
  4756. // case-insensitively, so look for the token rather than compare the whole
  4757. // field value.
  4758. if (!has_header_token(req.headers, "Upgrade", "websocket")) { return false; }
  4759. // Check Connection: Upgrade
  4760. if (!has_header_token(req.headers, "Connection", "upgrade")) { return false; }
  4761. // Check Sec-WebSocket-Key is a valid base64-encoded 16-byte value (24 chars)
  4762. // RFC 6455 Section 4.2.1
  4763. auto ws_key = req.get_header_value("Sec-WebSocket-Key");
  4764. if (ws_key.size() != 24 || ws_key[22] != '=' || ws_key[23] != '=') {
  4765. return false;
  4766. }
  4767. static const std::string b64chars =
  4768. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4769. for (size_t i = 0; i < 22; i++) {
  4770. if (b64chars.find(ws_key[i]) == std::string::npos) { return false; }
  4771. }
  4772. // Check Sec-WebSocket-Version: 13
  4773. auto version = req.get_header_value("Sec-WebSocket-Version");
  4774. if (version != "13") { return false; }
  4775. return true;
  4776. }
  4777. // Unpredictable bytes for masking keys (RFC 6455 Section 5.3) and nonces
  4778. inline void fill_random_bytes(unsigned char *out, size_t n) {
  4779. thread_local std::random_device rd;
  4780. size_t filled = 0;
  4781. while (filled < n) {
  4782. auto v = rd();
  4783. for (size_t b = 0; b < sizeof(v) && filled < n; ++b, ++filled) {
  4784. out[filled] = static_cast<unsigned char>((v >> (b * 8)) & 0xFFu);
  4785. }
  4786. }
  4787. }
  4788. inline bool write_websocket_frame(Stream &strm, ws::Opcode opcode,
  4789. const char *data, size_t len, bool fin,
  4790. bool mask) {
  4791. // First byte: FIN + opcode
  4792. uint8_t header[2];
  4793. header[0] = static_cast<uint8_t>((fin ? 0x80 : 0x00) |
  4794. (static_cast<uint8_t>(opcode) & 0x0F));
  4795. // Second byte: MASK + payload length
  4796. if (len < 126) {
  4797. header[1] = static_cast<uint8_t>(len);
  4798. if (mask) { header[1] |= 0x80; }
  4799. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4800. } else if (len <= 0xFFFF) {
  4801. header[1] = 126;
  4802. if (mask) { header[1] |= 0x80; }
  4803. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4804. uint8_t ext[2];
  4805. ext[0] = static_cast<uint8_t>((len >> 8) & 0xFF);
  4806. ext[1] = static_cast<uint8_t>(len & 0xFF);
  4807. if (strm.write(reinterpret_cast<char *>(ext), 2) < 0) { return false; }
  4808. } else {
  4809. header[1] = 127;
  4810. if (mask) { header[1] |= 0x80; }
  4811. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4812. uint8_t ext[8];
  4813. for (int i = 7; i >= 0; i--) {
  4814. ext[7 - i] =
  4815. static_cast<uint8_t>((static_cast<uint64_t>(len) >> (i * 8)) & 0xFF);
  4816. }
  4817. if (strm.write(reinterpret_cast<char *>(ext), 8) < 0) { return false; }
  4818. }
  4819. if (mask) {
  4820. // Generate random mask key
  4821. uint8_t mask_key[4];
  4822. fill_random_bytes(mask_key, sizeof(mask_key));
  4823. if (strm.write(reinterpret_cast<char *>(mask_key), 4) < 0) { return false; }
  4824. // Write masked payload in chunks
  4825. const size_t chunk_size = 4096;
  4826. std::vector<char> buf((std::min)(len, chunk_size));
  4827. for (size_t offset = 0; offset < len; offset += chunk_size) {
  4828. size_t n = (std::min)(chunk_size, len - offset);
  4829. for (size_t i = 0; i < n; i++) {
  4830. buf[i] =
  4831. data[offset + i] ^ static_cast<char>(mask_key[(offset + i) % 4]);
  4832. }
  4833. if (strm.write(buf.data(), n) < 0) { return false; }
  4834. }
  4835. } else {
  4836. if (len > 0) {
  4837. if (strm.write(data, len) < 0) { return false; }
  4838. }
  4839. }
  4840. return true;
  4841. }
  4842. } // namespace detail
  4843. namespace ws {
  4844. namespace impl {
  4845. // Read exactly `size` bytes. Stream::read may return less than asked for -- it
  4846. // hands back whatever its buffer already holds -- so every multi-byte field has
  4847. // to loop. Reading a 2-byte header with a single read() fails whenever the
  4848. // header straddles the read buffer's boundary.
  4849. //
  4850. // Timeout is reported only when nothing at all was consumed. Once a byte has
  4851. // been taken the stream sits mid-field and cannot be resumed, so a timeout
  4852. // there is a failure like any other. (When read() fails it always records why,
  4853. // so the error belongs to this call and not to an earlier one.)
  4854. inline FrameRead read_exact(Stream &strm, void *buf, size_t size) {
  4855. auto p = static_cast<char *>(buf);
  4856. size_t total = 0;
  4857. while (total < size) {
  4858. auto n = strm.read(p + total, size - total);
  4859. if (n <= 0) {
  4860. auto timed_out = total == 0 && strm.get_error() == Error::Timeout;
  4861. return timed_out ? FrameRead::Timeout : FrameRead::Fail;
  4862. }
  4863. total += static_cast<size_t>(n);
  4864. }
  4865. return FrameRead::Ok;
  4866. }
  4867. inline FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  4868. std::string &payload, bool &fin,
  4869. bool expect_masked, size_t max_len) {
  4870. // Read first 2 bytes. This is the only read that may report a timeout: it
  4871. // sits on a frame boundary, where nothing has been consumed yet.
  4872. uint8_t header[2];
  4873. FrameRead first = read_exact(strm, header, 2);
  4874. if (first != FrameRead::Ok) { return first; }
  4875. fin = (header[0] & 0x80) != 0;
  4876. // RSV1, RSV2, RSV3 must be 0 when no extension is negotiated
  4877. if (header[0] & 0x70) { return FrameRead::Fail; }
  4878. opcode = static_cast<Opcode>(header[0] & 0x0F);
  4879. bool masked = (header[1] & 0x80) != 0;
  4880. uint64_t payload_len = header[1] & 0x7F;
  4881. // RFC 6455 Section 5.5: control frames MUST NOT be fragmented and
  4882. // MUST have a payload length of 125 bytes or less
  4883. bool is_control = (static_cast<uint8_t>(opcode) & 0x08) != 0;
  4884. if (is_control) {
  4885. if (!fin) { return FrameRead::Fail; }
  4886. if (payload_len > 125) { return FrameRead::Fail; }
  4887. }
  4888. if (masked != expect_masked) { return FrameRead::Fail; }
  4889. // Extended payload length
  4890. if (payload_len == 126) {
  4891. uint8_t ext[2];
  4892. if (read_exact(strm, ext, 2) != FrameRead::Ok) { return FrameRead::Fail; }
  4893. payload_len = (static_cast<uint64_t>(ext[0]) << 8) | ext[1];
  4894. } else if (payload_len == 127) {
  4895. uint8_t ext[8];
  4896. if (read_exact(strm, ext, 8) != FrameRead::Ok) { return FrameRead::Fail; }
  4897. // RFC 6455 Section 5.2: the most significant bit MUST be 0
  4898. if (ext[0] & 0x80) { return FrameRead::Fail; }
  4899. payload_len = 0;
  4900. for (int i = 0; i < 8; i++) {
  4901. payload_len = (payload_len << 8) | ext[i];
  4902. }
  4903. }
  4904. // A max_len of 0 means no limit, as payload_max_length does, and a length
  4905. // size_t cannot hold (32-bit builds) is refused either way.
  4906. if ((max_len > 0 && payload_len > max_len) ||
  4907. !detail::fits_in_size_t(payload_len)) {
  4908. return FrameRead::Fail;
  4909. }
  4910. // Read mask key if present
  4911. uint8_t mask_key[4] = {0};
  4912. if (masked) {
  4913. if (read_exact(strm, mask_key, 4) != FrameRead::Ok) {
  4914. return FrameRead::Fail;
  4915. }
  4916. }
  4917. // Grow the payload only as it arrives, since a header alone can announce
  4918. // max_len bytes that never come.
  4919. payload.clear();
  4920. auto len = static_cast<size_t>(payload_len);
  4921. while (payload.size() < len) {
  4922. auto offset = payload.size();
  4923. auto n = (std::min)(len - offset, CPPHTTPLIB_RECV_BUFSIZ);
  4924. payload.resize(offset + n);
  4925. if (read_exact(strm, &payload[offset], n) != FrameRead::Ok) {
  4926. return FrameRead::Fail;
  4927. }
  4928. }
  4929. // Unmask if needed
  4930. if (masked) {
  4931. for (size_t i = 0; i < payload.size(); i++) {
  4932. payload[i] ^= static_cast<char>(mask_key[i % 4]);
  4933. }
  4934. }
  4935. return FrameRead::Ok;
  4936. }
  4937. // RFC 6455 §5.5.1, §7.4: a Close payload is empty, or a status code that may
  4938. // be sent followed by a UTF-8 reason.
  4939. inline bool is_valid_close_payload(const std::string &payload) {
  4940. if (payload.empty()) { return true; }
  4941. if (payload.size() < 2) { return false; }
  4942. auto code = (static_cast<uint8_t>(payload[0]) << 8) |
  4943. static_cast<uint8_t>(payload[1]);
  4944. auto may_be_sent = (1000 <= code && code <= 1003) ||
  4945. (1007 <= code && code <= 1014) ||
  4946. (3000 <= code && code <= 4999);
  4947. return may_be_sent && is_valid_utf8(payload.substr(2));
  4948. }
  4949. } // namespace impl
  4950. } // namespace ws
  4951. namespace detail {
  4952. inline bool is_valid_path(const std::string &path) {
  4953. size_t level = 0;
  4954. size_t i = 0;
  4955. // Skip slash
  4956. while (i < path.size() && path[i] == '/') {
  4957. i++;
  4958. }
  4959. while (i < path.size()) {
  4960. // Read component
  4961. auto beg = i;
  4962. while (i < path.size() && path[i] != '/') {
  4963. if (path[i] == '\0') {
  4964. return false;
  4965. } else if (path[i] == '\\') {
  4966. return false;
  4967. }
  4968. i++;
  4969. }
  4970. auto len = i - beg;
  4971. assert(len > 0);
  4972. if (!path.compare(beg, len, ".")) {
  4973. ;
  4974. } else if (!path.compare(beg, len, "..")) {
  4975. if (level == 0) { return false; }
  4976. level--;
  4977. } else {
  4978. level++;
  4979. }
  4980. // Skip slash
  4981. while (i < path.size() && path[i] == '/') {
  4982. i++;
  4983. }
  4984. }
  4985. return true;
  4986. }
  4987. inline bool canonicalize_path(const char *path, std::string &resolved) {
  4988. #if defined(_WIN32)
  4989. char buf[_MAX_PATH];
  4990. if (_fullpath(buf, path, _MAX_PATH) == nullptr) { return false; }
  4991. resolved = buf;
  4992. #elif defined(PATH_MAX)
  4993. char buf[PATH_MAX];
  4994. if (realpath(path, buf) == nullptr) { return false; }
  4995. resolved = buf;
  4996. #else
  4997. auto buf = realpath(path, nullptr);
  4998. auto guard = scope_exit([&]() { std::free(buf); });
  4999. if (buf == nullptr) { return false; }
  5000. resolved = buf;
  5001. #endif
  5002. return true;
  5003. }
  5004. inline bool is_path_within_base(const std::string &resolved_path,
  5005. const std::string &resolved_base) {
  5006. #if defined(_WIN32)
  5007. return _strnicmp(resolved_path.c_str(), resolved_base.c_str(),
  5008. resolved_base.size()) == 0;
  5009. #else
  5010. return strncmp(resolved_path.c_str(), resolved_base.c_str(),
  5011. resolved_base.size()) == 0;
  5012. #endif
  5013. }
  5014. inline FileStat::FileStat(const std::string &path) {
  5015. #if defined(_WIN32)
  5016. auto wpath = u8string_to_wstring(path.c_str());
  5017. ret_ = _wstat(wpath.c_str(), &st_);
  5018. #else
  5019. ret_ = stat(path.c_str(), &st_);
  5020. #endif
  5021. }
  5022. inline bool FileStat::is_file() const {
  5023. return ret_ >= 0 && S_ISREG(st_.st_mode);
  5024. }
  5025. inline bool FileStat::is_dir() const {
  5026. return ret_ >= 0 && S_ISDIR(st_.st_mode);
  5027. }
  5028. inline time_t FileStat::mtime() const {
  5029. return ret_ >= 0 ? static_cast<time_t>(st_.st_mtime)
  5030. : static_cast<time_t>(-1);
  5031. }
  5032. inline size_t FileStat::size() const {
  5033. return ret_ >= 0 ? static_cast<size_t>(st_.st_size) : 0;
  5034. }
  5035. inline std::string encode_path(const std::string &s) {
  5036. std::string result;
  5037. result.reserve(s.size());
  5038. for (size_t i = 0; s[i]; i++) {
  5039. switch (s[i]) {
  5040. case ' ': result += "%20"; break;
  5041. case '+': result += "%2B"; break;
  5042. case '\'': result += "%27"; break;
  5043. case ',': result += "%2C"; break;
  5044. // case ':': result += "%3A"; break; // ok? probably...
  5045. case ';': result += "%3B"; break;
  5046. default:
  5047. auto c = static_cast<uint8_t>(s[i]);
  5048. // Control characters (incl. CR/LF) and non-ASCII bytes are not allowed
  5049. // in a request-target as-is.
  5050. if (c < 0x20 || c == 0x7f || c >= 0x80) {
  5051. result += '%';
  5052. char hex[4];
  5053. auto len = snprintf(hex, sizeof(hex) - 1, "%02X", c);
  5054. assert(len == 2);
  5055. result.append(hex, static_cast<size_t>(len));
  5056. } else {
  5057. result += s[i];
  5058. }
  5059. break;
  5060. }
  5061. }
  5062. return result;
  5063. }
  5064. inline std::string file_extension(const std::string &path) {
  5065. auto i = path.size();
  5066. while (i > 0 && is_ascii_alnum(path[i - 1])) {
  5067. i--;
  5068. }
  5069. if (i == path.size() || i == 0 || path[i - 1] != '.') {
  5070. return std::string();
  5071. }
  5072. return path.substr(i);
  5073. }
  5074. inline bool is_space_or_tab(char c) { return c == ' ' || c == '\t'; }
  5075. template <typename T>
  5076. inline bool parse_header(const char *beg, const char *end, T fn);
  5077. template <typename T>
  5078. inline bool parse_header(const char *beg, const char *end, T fn) {
  5079. // Skip trailing spaces and tabs.
  5080. while (beg < end && is_space_or_tab(end[-1])) {
  5081. end--;
  5082. }
  5083. auto p = beg;
  5084. while (p < end && *p != ':') {
  5085. p++;
  5086. }
  5087. auto name = std::string(beg, p);
  5088. if (!detail::fields::is_field_name(name)) { return false; }
  5089. if (p == end) { return false; }
  5090. auto key_end = p;
  5091. if (*p++ != ':') { return false; }
  5092. while (p < end && is_space_or_tab(*p)) {
  5093. p++;
  5094. }
  5095. if (p <= end) {
  5096. auto key_len = key_end - beg;
  5097. if (!key_len) { return false; }
  5098. auto key = std::string(beg, key_end);
  5099. auto val = std::string(p, end);
  5100. if (!detail::fields::is_field_value(val)) { return false; }
  5101. // RFC 9110 §5.5: header field values are opaque octets and MUST NOT be
  5102. // percent-decoded by the recipient. Applications that need to interpret a
  5103. // value as a URI component should call httplib::decode_uri_component()
  5104. // (or decode_path_component()) explicitly.
  5105. fn(key, val);
  5106. return true;
  5107. }
  5108. return false;
  5109. }
  5110. inline bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  5111. const Headers &src_headers) {
  5112. // NOTE: In RFC 9112, '7.1 Chunked Transfer Coding' mentions "The chunked
  5113. // transfer coding is complete when a chunk with a chunk-size of zero is
  5114. // received, possibly followed by a trailer section, and finally terminated by
  5115. // an empty line". https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1
  5116. //
  5117. // In '7.1.3. Decoding Chunked', however, the pseudo-code in the section
  5118. // doesn't care for the existence of the final CRLF. In other words, it seems
  5119. // to be ok whether the final CRLF exists or not in the chunked data.
  5120. // https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1.3
  5121. //
  5122. // According to the reference code in RFC 9112, cpp-httplib now allows
  5123. // chunked transfer coding data without the final CRLF.
  5124. // RFC 7230 Section 4.1.2 - Headers prohibited in trailers
  5125. thread_local case_ignore::unordered_set<std::string> prohibited_trailers = {
  5126. "transfer-encoding",
  5127. "content-length",
  5128. "host",
  5129. "authorization",
  5130. "www-authenticate",
  5131. "proxy-authenticate",
  5132. "proxy-authorization",
  5133. "cookie",
  5134. "set-cookie",
  5135. "cache-control",
  5136. "expect",
  5137. "max-forwards",
  5138. "pragma",
  5139. "range",
  5140. "te",
  5141. "age",
  5142. "expires",
  5143. "date",
  5144. "location",
  5145. "retry-after",
  5146. "vary",
  5147. "warning",
  5148. "content-encoding",
  5149. "content-type",
  5150. "content-range",
  5151. "trailer"};
  5152. case_ignore::unordered_set<std::string> declared_trailers;
  5153. auto trailer_header = get_combined_header_value(src_headers, "Trailer");
  5154. if (!trailer_header.empty()) {
  5155. // split() trims each token and skips empty ones, so the name arrives ready
  5156. // to look up.
  5157. split(trailer_header.data(), trailer_header.data() + trailer_header.size(),
  5158. ',', [&](const char *b, const char *e) {
  5159. // A legitimate message declares only a handful of trailers. Cap the
  5160. // set so a peer cannot grow it without bound: an oversized set only
  5161. // arises from an attempt to force many colliding names into
  5162. // quadratic lookups (case_ignore::hash is unkeyed).
  5163. if (declared_trailers.size() >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  5164. return;
  5165. }
  5166. std::string key(b, e);
  5167. if (prohibited_trailers.find(key) == prohibited_trailers.end()) {
  5168. declared_trailers.insert(key);
  5169. }
  5170. });
  5171. }
  5172. size_t trailer_header_count = 0;
  5173. while (strcmp(line_reader.ptr(), "\r\n") != 0) {
  5174. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  5175. // Count every received trailer field, not only the declared ones stored in
  5176. // dest, so undeclared fields cannot keep this loop running past the limit.
  5177. if (trailer_header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  5178. constexpr auto line_terminator_len = 2;
  5179. auto line_beg = line_reader.ptr();
  5180. auto line_end =
  5181. line_reader.ptr() + line_reader.size() - line_terminator_len;
  5182. if (!parse_header(line_beg, line_end,
  5183. [&](const std::string &key, const std::string &val) {
  5184. if (declared_trailers.find(key) !=
  5185. declared_trailers.end()) {
  5186. dest.emplace(key, val);
  5187. }
  5188. })) {
  5189. return false;
  5190. }
  5191. trailer_header_count++;
  5192. if (!line_reader.getline()) { return false; }
  5193. }
  5194. return true;
  5195. }
  5196. inline std::pair<size_t, size_t> trim(const char *b, const char *e, size_t left,
  5197. size_t right) {
  5198. while (b + left < e && is_space_or_tab(b[left])) {
  5199. left++;
  5200. }
  5201. while (right > 0 && is_space_or_tab(b[right - 1])) {
  5202. right--;
  5203. }
  5204. return std::make_pair(left, right);
  5205. }
  5206. inline std::string trim_copy(const std::string &s) {
  5207. auto r = trim(s.data(), s.data() + s.size(), 0, s.size());
  5208. return s.substr(r.first, r.second - r.first);
  5209. }
  5210. inline std::string trim_double_quotes_copy(const std::string &s) {
  5211. if (s.length() >= 2 && s.front() == '"' && s.back() == '"') {
  5212. return s.substr(1, s.size() - 2);
  5213. }
  5214. return s;
  5215. }
  5216. // Takes the quotes off a parameter value. Only \" and \\ are quoted-pairs
  5217. // here, as browsers send any other backslash, such as one in a Windows path,
  5218. // as it is.
  5219. inline std::string unquote_param(const std::string &s) {
  5220. if (s.size() < 2 || s.front() != '"' || s.back() != '"') { return s; }
  5221. std::string out;
  5222. for (size_t i = 1; i + 1 < s.size(); i++) {
  5223. if (s[i] == '\\' && i + 2 < s.size() &&
  5224. (s[i + 1] == '"' || s[i + 1] == '\\')) {
  5225. i++;
  5226. }
  5227. out += s[i];
  5228. }
  5229. return out;
  5230. }
  5231. inline void
  5232. divide(const char *data, std::size_t size, char d,
  5233. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5234. fn) {
  5235. const auto it = std::find(data, data + size, d);
  5236. const auto found = static_cast<std::size_t>(it != data + size);
  5237. const auto lhs_data = data;
  5238. const auto lhs_size = static_cast<std::size_t>(it - data);
  5239. const auto rhs_data = it + found;
  5240. const auto rhs_size = size - lhs_size - found;
  5241. fn(lhs_data, lhs_size, rhs_data, rhs_size);
  5242. }
  5243. inline void
  5244. divide(const std::string &str, char d,
  5245. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5246. fn) {
  5247. divide(str.data(), str.size(), d, std::move(fn));
  5248. }
  5249. inline void split(const char *b, const char *e, char d,
  5250. std::function<void(const char *, const char *)> fn) {
  5251. return split(b, e, d, (std::numeric_limits<size_t>::max)(), std::move(fn));
  5252. }
  5253. inline void split(const char *b, const char *e, char d, size_t m,
  5254. std::function<void(const char *, const char *)> fn) {
  5255. size_t i = 0;
  5256. size_t beg = 0;
  5257. size_t count = 1;
  5258. while (e ? (b + i < e) : (b[i] != '\0')) {
  5259. if (b[i] == d && count < m) {
  5260. auto r = trim(b, e, beg, i);
  5261. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5262. beg = i + 1;
  5263. count++;
  5264. }
  5265. i++;
  5266. }
  5267. if (i) {
  5268. auto r = trim(b, e, beg, i);
  5269. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5270. }
  5271. }
  5272. // Same contract as split(), except that a delimiter inside a quoted-string is
  5273. // not a delimiter. RFC 9110 Section 5.6.6 lets a parameter value be a
  5274. // quoted-string, and ';' and '=' are legal characters inside one.
  5275. inline void split_unquoted(const char *b, const char *e, char d, size_t m,
  5276. std::function<void(const char *, const char *)> fn) {
  5277. size_t i = 0;
  5278. size_t beg = 0;
  5279. size_t count = 1;
  5280. auto in_quotes = false;
  5281. auto has = [&](size_t j) { return e ? (b + j < e) : (b[j] != '\0'); };
  5282. while (has(i)) {
  5283. if (in_quotes && b[i] == '\\' && has(i + 1)) {
  5284. // A quoted-pair, whose second character does not end the string.
  5285. i++;
  5286. } else if (b[i] == '"') {
  5287. in_quotes = !in_quotes;
  5288. } else if (b[i] == d && !in_quotes && count < m) {
  5289. auto r = trim(b, e, beg, i);
  5290. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5291. beg = i + 1;
  5292. count++;
  5293. }
  5294. i++;
  5295. }
  5296. if (i) {
  5297. auto r = trim(b, e, beg, i);
  5298. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5299. }
  5300. }
  5301. inline void split_unquoted(const char *b, const char *e, char d,
  5302. std::function<void(const char *, const char *)> fn) {
  5303. return split_unquoted(b, e, d, (std::numeric_limits<size_t>::max)(),
  5304. std::move(fn));
  5305. }
  5306. // Divide a header parameter at its first '='. RFC 9110 Section 5.6.6 makes the
  5307. // key a token, so the first '=' is the separator even when the value is a
  5308. // quoted-string carrying more of them.
  5309. inline void divide_param_pair(const char *b, const char *e, std::string &key,
  5310. std::string &val) {
  5311. divide(
  5312. b, static_cast<std::size_t>(e - b), '=',
  5313. [&](const char *kb, std::size_t klen, const char *vb, std::size_t vlen) {
  5314. const auto kr = trim(kb, kb + klen, 0, klen);
  5315. key.assign(kb + kr.first, kb + kr.second);
  5316. const auto vr = trim(vb, vb + vlen, 0, vlen);
  5317. val.assign(vb + vr.first, vb + vr.second);
  5318. });
  5319. }
  5320. inline bool split_find(const char *b, const char *e, char d, size_t m,
  5321. std::function<bool(const char *, const char *)> fn) {
  5322. size_t i = 0;
  5323. size_t beg = 0;
  5324. size_t count = 1;
  5325. while (e ? (b + i < e) : (b[i] != '\0')) {
  5326. if (b[i] == d && count < m) {
  5327. auto r = trim(b, e, beg, i);
  5328. if (r.first < r.second) {
  5329. auto found = fn(&b[r.first], &b[r.second]);
  5330. if (found) { return true; }
  5331. }
  5332. beg = i + 1;
  5333. count++;
  5334. }
  5335. i++;
  5336. }
  5337. if (i) {
  5338. auto r = trim(b, e, beg, i);
  5339. if (r.first < r.second) {
  5340. auto found = fn(&b[r.first], &b[r.second]);
  5341. if (found) { return true; }
  5342. }
  5343. }
  5344. return false;
  5345. }
  5346. inline bool split_find(const char *b, const char *e, char d,
  5347. std::function<bool(const char *, const char *)> fn) {
  5348. return split_find(b, e, d, (std::numeric_limits<size_t>::max)(),
  5349. std::move(fn));
  5350. }
  5351. inline stream_line_reader::stream_line_reader(Stream &strm, char *fixed_buffer,
  5352. size_t fixed_buffer_size)
  5353. : strm_(strm), fixed_buffer_(fixed_buffer),
  5354. fixed_buffer_size_(fixed_buffer_size) {}
  5355. inline const char *stream_line_reader::ptr() const {
  5356. if (growable_buffer_.empty()) {
  5357. return fixed_buffer_;
  5358. } else {
  5359. return growable_buffer_.data();
  5360. }
  5361. }
  5362. inline size_t stream_line_reader::size() const {
  5363. if (growable_buffer_.empty()) {
  5364. return fixed_buffer_used_size_;
  5365. } else {
  5366. return growable_buffer_.size();
  5367. }
  5368. }
  5369. inline bool stream_line_reader::end_with_crlf() const {
  5370. auto end = ptr() + size();
  5371. return size() >= 2 && end[-2] == '\r' && end[-1] == '\n';
  5372. }
  5373. inline bool stream_line_reader::getline() {
  5374. fixed_buffer_used_size_ = 0;
  5375. growable_buffer_.clear();
  5376. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5377. char prev_byte = 0;
  5378. #endif
  5379. for (size_t i = 0;; i++) {
  5380. // Fast path: whatever the stream has already buffered can be scanned for
  5381. // the terminator in one pass. Asking for a byte at a time costs a virtual
  5382. // call, a bounds check and a one-byte copy per character of the request.
  5383. size_t buffered_size = 0;
  5384. if (auto buffered = strm_.buffered_data(buffered_size)) {
  5385. auto take = buffered_size;
  5386. auto terminated = false;
  5387. for (size_t at = 0; at < buffered_size;) {
  5388. auto nl = static_cast<const char *>(
  5389. memchr(buffered + at, '\n', buffered_size - at));
  5390. if (!nl) { break; }
  5391. auto pos = static_cast<size_t>(nl - buffered);
  5392. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5393. take = pos + 1;
  5394. terminated = true;
  5395. break;
  5396. #else
  5397. // A bare LF does not end the line; keep looking for CRLF. The CR may
  5398. // be the last byte of an earlier chunk, hence prev_byte.
  5399. if ((pos > 0 ? buffered[pos - 1] : prev_byte) == '\r') {
  5400. take = pos + 1;
  5401. terminated = true;
  5402. break;
  5403. }
  5404. at = pos + 1;
  5405. #endif
  5406. }
  5407. if (size() + take > CPPHTTPLIB_MAX_LINE_LENGTH) { return false; }
  5408. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5409. prev_byte = buffered[take - 1];
  5410. #endif
  5411. append(buffered, take);
  5412. strm_.consume_buffered(take);
  5413. i += take;
  5414. if (terminated) { return true; }
  5415. continue;
  5416. }
  5417. if (size() >= CPPHTTPLIB_MAX_LINE_LENGTH) {
  5418. // Treat exceptionally long lines as an error to
  5419. // prevent infinite loops/memory exhaustion
  5420. return false;
  5421. }
  5422. char byte;
  5423. auto n = strm_.read(&byte, 1);
  5424. if (n < 0) {
  5425. return false;
  5426. } else if (n == 0) {
  5427. if (i == 0) {
  5428. return false;
  5429. } else {
  5430. break;
  5431. }
  5432. }
  5433. append(byte);
  5434. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5435. if (byte == '\n') { break; }
  5436. #else
  5437. if (prev_byte == '\r' && byte == '\n') { break; }
  5438. prev_byte = byte;
  5439. #endif
  5440. }
  5441. return true;
  5442. }
  5443. inline void stream_line_reader::append(char c) { append(&c, 1); }
  5444. inline void stream_line_reader::append(const char *data, size_t size) {
  5445. // Once the line has outgrown the fixed buffer everything must keep going to
  5446. // the growable one, even if a later chunk would have fit. Without the
  5447. // emptiness check a short append after a long one would land in the fixed
  5448. // buffer, which ptr() and size() no longer look at, and be lost.
  5449. if (growable_buffer_.empty() &&
  5450. fixed_buffer_used_size_ + size < fixed_buffer_size_) {
  5451. memcpy(fixed_buffer_ + fixed_buffer_used_size_, data, size);
  5452. fixed_buffer_used_size_ += size;
  5453. fixed_buffer_[fixed_buffer_used_size_] = '\0';
  5454. } else {
  5455. // Unlike the per-character overload, this can be the very first append of
  5456. // the line, so the fixed buffer may hold nothing and carry no terminator
  5457. // yet. assign() takes an explicit length and does not need one.
  5458. if (growable_buffer_.empty()) {
  5459. growable_buffer_.assign(fixed_buffer_, fixed_buffer_used_size_);
  5460. }
  5461. growable_buffer_.append(data, size);
  5462. }
  5463. }
  5464. inline mmap::mmap(const char *path) { open(path); }
  5465. inline mmap::~mmap() { close(); }
  5466. inline bool mmap::open(const char *path) {
  5467. close();
  5468. #if defined(_WIN32)
  5469. auto wpath = u8string_to_wstring(path);
  5470. if (wpath.empty()) { return false; }
  5471. hFile_ =
  5472. ::CreateFile2(wpath.c_str(), GENERIC_READ,
  5473. FILE_SHARE_READ | FILE_SHARE_WRITE, OPEN_EXISTING, NULL);
  5474. if (hFile_ == INVALID_HANDLE_VALUE) { return false; }
  5475. LARGE_INTEGER size{};
  5476. if (!::GetFileSizeEx(hFile_, &size)) { return false; }
  5477. // If the following line doesn't compile due to QuadPart, update Windows SDK.
  5478. // See:
  5479. // https://github.com/yhirose/cpp-httplib/issues/1903#issuecomment-2316520721
  5480. if (!fits_in_size_t(static_cast<uint64_t>(size.QuadPart))) { return false; }
  5481. size_ = static_cast<size_t>(size.QuadPart);
  5482. hMapping_ =
  5483. ::CreateFileMappingFromApp(hFile_, NULL, PAGE_READONLY, size_, NULL);
  5484. // Special treatment for an empty file...
  5485. if (hMapping_ == NULL && size_ == 0) {
  5486. close();
  5487. is_open_empty_file = true;
  5488. return true;
  5489. }
  5490. if (hMapping_ == NULL) {
  5491. close();
  5492. return false;
  5493. }
  5494. addr_ = ::MapViewOfFileFromApp(hMapping_, FILE_MAP_READ, 0, 0);
  5495. if (addr_ == nullptr) {
  5496. close();
  5497. return false;
  5498. }
  5499. #else
  5500. // O_NONBLOCK so that opening a FIFO does not wait for a writer.
  5501. fd_ = ::open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC);
  5502. if (fd_ == -1) { return false; }
  5503. // Only a regular file has a size to serve, unlike a directory or a device.
  5504. struct stat sb;
  5505. if (fstat(fd_, &sb) == -1 || !S_ISREG(sb.st_mode) ||
  5506. !fits_in_size_t(static_cast<uint64_t>(sb.st_size))) {
  5507. close();
  5508. return false;
  5509. }
  5510. size_ = static_cast<size_t>(sb.st_size);
  5511. #endif
  5512. return true;
  5513. }
  5514. inline bool mmap::is_open() const {
  5515. #if defined(_WIN32)
  5516. return is_open_empty_file ? true : addr_ != nullptr;
  5517. #else
  5518. return fd_ != -1;
  5519. #endif
  5520. }
  5521. inline size_t mmap::size() const { return size_; }
  5522. inline void mmap::close() {
  5523. #if defined(_WIN32)
  5524. if (addr_) {
  5525. ::UnmapViewOfFile(addr_);
  5526. addr_ = nullptr;
  5527. }
  5528. if (hMapping_) {
  5529. ::CloseHandle(hMapping_);
  5530. hMapping_ = NULL;
  5531. }
  5532. if (hFile_ != INVALID_HANDLE_VALUE) {
  5533. ::CloseHandle(hFile_);
  5534. hFile_ = INVALID_HANDLE_VALUE;
  5535. }
  5536. is_open_empty_file = false;
  5537. #else
  5538. if (fd_ != -1) {
  5539. ::close(fd_);
  5540. fd_ = -1;
  5541. }
  5542. #endif
  5543. size_ = 0;
  5544. }
  5545. inline int close_socket(socket_t sock) noexcept {
  5546. #ifdef _WIN32
  5547. return closesocket(sock);
  5548. #else
  5549. return close(sock);
  5550. #endif
  5551. }
  5552. template <typename T> inline ssize_t handle_EINTR(T fn) {
  5553. ssize_t res = 0;
  5554. while (true) {
  5555. res = fn();
  5556. if (res < 0 && errno == EINTR) {
  5557. std::this_thread::sleep_for(std::chrono::microseconds{1});
  5558. continue;
  5559. }
  5560. break;
  5561. }
  5562. return res;
  5563. }
  5564. inline size_t mmap::read(size_t offset, char *buf, size_t len) const {
  5565. if (offset >= size_) { return 0; }
  5566. len = (std::min)(len, size_ - offset);
  5567. #if defined(_WIN32)
  5568. // Windows does not let a mapped file be truncated.
  5569. std::memcpy(buf, static_cast<const char *>(addr_) + offset, len);
  5570. return len;
  5571. #else
  5572. auto n = handle_EINTR(
  5573. [&]() { return ::pread(fd_, buf, len, static_cast<off_t>(offset)); });
  5574. return n > 0 ? static_cast<size_t>(n) : 0;
  5575. #endif
  5576. }
  5577. inline ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags) {
  5578. return handle_EINTR([&]() {
  5579. return recv(sock,
  5580. #ifdef _WIN32
  5581. static_cast<char *>(ptr), static_cast<int>(size),
  5582. #else
  5583. ptr, size,
  5584. #endif
  5585. flags);
  5586. });
  5587. }
  5588. inline ssize_t send_socket(socket_t sock, const void *ptr, size_t size,
  5589. int flags) {
  5590. return handle_EINTR([&]() {
  5591. return send(sock,
  5592. #ifdef _WIN32
  5593. static_cast<const char *>(ptr), static_cast<int>(size),
  5594. #else
  5595. ptr, size,
  5596. #endif
  5597. flags);
  5598. });
  5599. }
  5600. inline int poll_wrapper(struct pollfd *fds, nfds_t nfds, int timeout) {
  5601. #ifdef _WIN32
  5602. return ::WSAPoll(fds, nfds, timeout);
  5603. #else
  5604. return ::poll(fds, nfds, timeout);
  5605. #endif
  5606. }
  5607. inline ssize_t select_impl(socket_t sock, short events, time_t sec,
  5608. time_t usec) {
  5609. struct pollfd pfd;
  5610. pfd.fd = sock;
  5611. pfd.events = events;
  5612. pfd.revents = 0;
  5613. // A negative timeout waits forever, poll's own convention. 0 keeps meaning
  5614. // "return immediately", which callers here rely on to probe a socket.
  5615. auto timeout = sec < 0 ? -1 : static_cast<int>(sec * 1000 + usec / 1000);
  5616. return handle_EINTR([&]() { return poll_wrapper(&pfd, 1, timeout); });
  5617. }
  5618. inline ssize_t select_read(socket_t sock, time_t sec, time_t usec) {
  5619. return select_impl(sock, POLLIN, sec, usec);
  5620. }
  5621. inline ssize_t select_write(socket_t sock, time_t sec, time_t usec) {
  5622. return select_impl(sock, POLLOUT, sec, usec);
  5623. }
  5624. // The point sec and usec from now, for select_until(). A negative sec never
  5625. // comes, as a negative timeout waits forever in select_impl().
  5626. inline std::chrono::steady_clock::time_point deadline_after(time_t sec,
  5627. time_t usec) {
  5628. if (sec < 0) { return (std::chrono::steady_clock::time_point::max)(); }
  5629. return std::chrono::steady_clock::now() + std::chrono::seconds(sec) +
  5630. std::chrono::microseconds(usec);
  5631. }
  5632. // Waits only for the time left until deadline, so that all the waits of one
  5633. // TLS handshake come out of a single timeout.
  5634. inline ssize_t select_until(socket_t sock, short events,
  5635. std::chrono::steady_clock::time_point deadline) {
  5636. if (deadline == (std::chrono::steady_clock::time_point::max)()) {
  5637. return select_impl(sock, events, -1, 0);
  5638. }
  5639. auto left = std::chrono::duration_cast<std::chrono::microseconds>(
  5640. deadline - std::chrono::steady_clock::now())
  5641. .count();
  5642. if (left <= 0) { return 0; }
  5643. return select_impl(sock, events, static_cast<time_t>(left / 1000000),
  5644. static_cast<time_t>(left % 1000000));
  5645. }
  5646. inline Error wait_until_socket_is_ready(socket_t sock, time_t sec,
  5647. time_t usec) {
  5648. struct pollfd pfd_read;
  5649. pfd_read.fd = sock;
  5650. pfd_read.events = POLLIN | POLLOUT;
  5651. pfd_read.revents = 0;
  5652. auto timeout = static_cast<int>(sec * 1000 + usec / 1000);
  5653. auto poll_res =
  5654. handle_EINTR([&]() { return poll_wrapper(&pfd_read, 1, timeout); });
  5655. if (poll_res == 0) { return Error::ConnectionTimeout; }
  5656. if (poll_res > 0 && pfd_read.revents & (POLLIN | POLLOUT)) {
  5657. auto error = 0;
  5658. socklen_t len = sizeof(error);
  5659. auto res = getsockopt(sock, SOL_SOCKET, SO_ERROR,
  5660. reinterpret_cast<char *>(&error), &len);
  5661. auto successful = res >= 0 && !error;
  5662. return successful ? Error::Success : Error::Connection;
  5663. }
  5664. return Error::Connection;
  5665. }
  5666. inline bool is_socket_alive(socket_t sock) {
  5667. const auto val = detail::select_read(sock, 0, 0);
  5668. if (val == 0) {
  5669. return true;
  5670. } else if (val < 0 && errno == EBADF) {
  5671. return false;
  5672. }
  5673. char buf[1];
  5674. return detail::read_socket(sock, &buf[0], sizeof(buf), MSG_PEEK) > 0;
  5675. }
  5676. class SocketStream final : public Stream {
  5677. public:
  5678. SocketStream(socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5679. time_t write_timeout_sec, time_t write_timeout_usec,
  5680. time_t max_timeout_msec = 0,
  5681. std::chrono::time_point<std::chrono::steady_clock> start_time =
  5682. (std::chrono::steady_clock::time_point::min)());
  5683. ~SocketStream() override;
  5684. bool is_readable() const override;
  5685. bool wait_readable() const override;
  5686. bool wait_writable() const override;
  5687. bool is_peer_alive() const override;
  5688. ssize_t read(char *ptr, size_t size) override;
  5689. ssize_t write(const char *ptr, size_t size) override;
  5690. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  5691. void get_local_ip_and_port(std::string &ip, int &port) const override;
  5692. socket_t socket() const override;
  5693. time_t duration() const override;
  5694. void set_read_timeout(time_t sec, time_t usec = 0) override;
  5695. void set_max_timeout(time_t msec) override;
  5696. const char *buffered_data(size_t &size) const override;
  5697. void consume_buffered(size_t size) override;
  5698. // The caller has just seen this socket become readable. Lets the next read
  5699. // skip its own readiness wait, which would otherwise ask the kernel a
  5700. // question that was answered a moment ago. Consumed by that read.
  5701. void set_readable_hint() { readable_hint_ = true; }
  5702. private:
  5703. bool ensure_readable();
  5704. socket_t sock_;
  5705. // Atomic because ws::WebSocket::set_read_timeout() reaches this from another
  5706. // thread while a read is in flight -- that is the point of it, for a caller
  5707. // holding one connection and wanting control back to send on it.
  5708. std::atomic<time_t> read_timeout_sec_;
  5709. std::atomic<time_t> read_timeout_usec_;
  5710. time_t write_timeout_sec_;
  5711. time_t write_timeout_usec_;
  5712. time_t max_timeout_msec_;
  5713. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  5714. std::vector<char> read_buff_;
  5715. size_t read_buff_off_ = 0;
  5716. size_t read_buff_content_size_ = 0;
  5717. bool readable_hint_ = false;
  5718. static const size_t read_buff_size_ = 1024l * 4;
  5719. };
  5720. inline bool keep_alive(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5721. time_t keep_alive_timeout_sec) {
  5722. using namespace std::chrono;
  5723. const auto interval_usec =
  5724. CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND;
  5725. // Avoid expensive `steady_clock::now()` call for the first time
  5726. if (select_read(sock, 0, interval_usec) > 0) { return true; }
  5727. const auto start = steady_clock::now() - microseconds{interval_usec};
  5728. const auto timeout = seconds{keep_alive_timeout_sec};
  5729. while (true) {
  5730. if (svr_sock == INVALID_SOCKET) {
  5731. break; // Server socket is closed
  5732. }
  5733. auto val = select_read(sock, 0, interval_usec);
  5734. if (val < 0) {
  5735. break; // Ssocket error
  5736. } else if (val == 0) {
  5737. if (steady_clock::now() - start > timeout) {
  5738. break; // Timeout
  5739. }
  5740. } else {
  5741. return true; // Ready for read
  5742. }
  5743. }
  5744. return false;
  5745. }
  5746. // `has_buffered_request` reports whether the connection's stream already holds
  5747. // bytes of the next request. A client may pipeline its requests (RFC 9112
  5748. // 9.3.2), so reading one request can pull the start of the next one into the
  5749. // stream's buffer; that request must be served without waiting for the socket
  5750. // to become readable again, since its bytes are no longer on the socket.
  5751. // `callback` is told whether keep_alive() has just seen the socket go readable.
  5752. template <typename P, typename T>
  5753. inline bool process_server_socket_core(const std::atomic<socket_t> &svr_sock,
  5754. socket_t sock,
  5755. size_t keep_alive_max_count,
  5756. time_t keep_alive_timeout_sec,
  5757. P has_buffered_request, T callback) {
  5758. auto ret = false;
  5759. // A keep_alive_max_count of 0 sets no limit.
  5760. for (size_t served = 0;
  5761. keep_alive_max_count == 0 || served < keep_alive_max_count; served++) {
  5762. auto socket_readable = false;
  5763. if (!has_buffered_request()) {
  5764. if (!keep_alive(svr_sock, sock, keep_alive_timeout_sec)) { break; }
  5765. socket_readable = true;
  5766. }
  5767. auto close_connection = served + 1 == keep_alive_max_count;
  5768. auto connection_closed = false;
  5769. ret = callback(socket_readable, close_connection, connection_closed);
  5770. if (!ret || connection_closed) { break; }
  5771. }
  5772. return ret;
  5773. }
  5774. template <typename T>
  5775. inline bool
  5776. process_server_socket(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5777. size_t keep_alive_max_count,
  5778. time_t keep_alive_timeout_sec, time_t read_timeout_sec,
  5779. time_t read_timeout_usec, time_t write_timeout_sec,
  5780. time_t write_timeout_usec, T callback) {
  5781. // One stream per connection: its read buffer can already hold the start of
  5782. // the next, pipelined request.
  5783. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5784. write_timeout_sec, write_timeout_usec);
  5785. return process_server_socket_core(
  5786. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  5787. [&]() { return strm.is_readable(); },
  5788. [&](bool socket_readable, bool close_connection,
  5789. bool &connection_closed) {
  5790. if (socket_readable) { strm.set_readable_hint(); }
  5791. return callback(strm, close_connection, connection_closed);
  5792. });
  5793. }
  5794. inline bool process_client_socket(
  5795. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5796. time_t write_timeout_sec, time_t write_timeout_usec,
  5797. time_t max_timeout_msec,
  5798. std::chrono::time_point<std::chrono::steady_clock> start_time,
  5799. std::function<bool(Stream &)> callback) {
  5800. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5801. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  5802. start_time);
  5803. return callback(strm);
  5804. }
  5805. inline int shutdown_socket(socket_t sock) noexcept {
  5806. #ifdef _WIN32
  5807. return shutdown(sock, SD_BOTH);
  5808. #else
  5809. return shutdown(sock, SHUT_RDWR);
  5810. #endif
  5811. }
  5812. // Half-closes the write side and drains any in-flight/queued bytes before
  5813. // the final shutdown+close. Closing with unread data in the receive queue
  5814. // (or bytes arriving after the receive side is closed) makes the stack send
  5815. // an abortive RST instead of a graceful FIN, which can make the peer see the
  5816. // response as a failed read even though it was fully written.
  5817. inline void drain_and_close_socket(socket_t sock) noexcept {
  5818. #ifdef _WIN32
  5819. shutdown(sock, SD_SEND);
  5820. #else
  5821. shutdown(sock, SHUT_WR);
  5822. #endif
  5823. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  5824. size_t total = 0;
  5825. const auto deadline = std::chrono::steady_clock::now() +
  5826. std::chrono::milliseconds(100); // bound #1
  5827. while (total < size_t(1024u * 1024u)) { // bound #2
  5828. const auto remaining =
  5829. std::chrono::duration_cast<std::chrono::microseconds>(
  5830. deadline - std::chrono::steady_clock::now())
  5831. .count();
  5832. if (remaining <= 0) { break; }
  5833. if (select_read(sock, 0, static_cast<time_t>(remaining)) <= 0) { break; }
  5834. const auto n = read_socket(sock, buf, sizeof(buf), CPPHTTPLIB_RECV_FLAGS);
  5835. if (n <= 0) { break; }
  5836. total += static_cast<size_t>(n);
  5837. }
  5838. shutdown_socket(sock);
  5839. close_socket(sock);
  5840. }
  5841. inline std::string escape_abstract_namespace_unix_domain(const std::string &s) {
  5842. if (s.size() > 1 && s[0] == '\0') {
  5843. auto ret = s;
  5844. ret[0] = '@';
  5845. return ret;
  5846. }
  5847. return s;
  5848. }
  5849. inline std::string
  5850. unescape_abstract_namespace_unix_domain(const std::string &s) {
  5851. if (s.size() > 1 && s[0] == '@') {
  5852. auto ret = s;
  5853. ret[0] = '\0';
  5854. return ret;
  5855. }
  5856. return s;
  5857. }
  5858. inline int getaddrinfo_with_timeout(const char *node, const char *service,
  5859. const struct addrinfo *hints,
  5860. struct addrinfo **res, time_t timeout_sec) {
  5861. #ifdef CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO
  5862. if (timeout_sec <= 0) {
  5863. // No timeout specified, use standard getaddrinfo
  5864. return getaddrinfo(node, service, hints, res);
  5865. }
  5866. #ifdef _WIN32
  5867. // Windows-specific implementation using GetAddrInfoEx with overlapped I/O
  5868. OVERLAPPED overlapped = {};
  5869. HANDLE event = CreateEventW(nullptr, TRUE, FALSE, nullptr);
  5870. if (!event) { return EAI_FAIL; }
  5871. overlapped.hEvent = event;
  5872. PADDRINFOEXW result_addrinfo = nullptr;
  5873. HANDLE cancel_handle = nullptr;
  5874. ADDRINFOEXW hints_ex = {};
  5875. if (hints) {
  5876. hints_ex.ai_flags = hints->ai_flags;
  5877. hints_ex.ai_family = hints->ai_family;
  5878. hints_ex.ai_socktype = hints->ai_socktype;
  5879. hints_ex.ai_protocol = hints->ai_protocol;
  5880. }
  5881. auto wnode = u8string_to_wstring(node);
  5882. auto wservice = u8string_to_wstring(service);
  5883. auto ret = ::GetAddrInfoExW(wnode.data(), wservice.data(), NS_DNS, nullptr,
  5884. hints ? &hints_ex : nullptr, &result_addrinfo,
  5885. nullptr, &overlapped, nullptr, &cancel_handle);
  5886. if (ret == WSA_IO_PENDING) {
  5887. auto wait_result =
  5888. ::WaitForSingleObject(event, static_cast<DWORD>(timeout_sec * 1000));
  5889. if (wait_result == WAIT_TIMEOUT) {
  5890. if (cancel_handle) { ::GetAddrInfoExCancel(&cancel_handle); }
  5891. ::CloseHandle(event);
  5892. return EAI_AGAIN;
  5893. }
  5894. DWORD bytes_returned;
  5895. if (!::GetOverlappedResult((HANDLE)INVALID_SOCKET, &overlapped,
  5896. &bytes_returned, FALSE)) {
  5897. ::CloseHandle(event);
  5898. return ::WSAGetLastError();
  5899. }
  5900. }
  5901. ::CloseHandle(event);
  5902. if (ret == NO_ERROR || ret == WSA_IO_PENDING) {
  5903. *res = reinterpret_cast<struct addrinfo *>(result_addrinfo);
  5904. return 0;
  5905. }
  5906. return ret;
  5907. #elif TARGET_OS_MAC && defined(__clang__)
  5908. if (!node) { return EAI_NONAME; }
  5909. // macOS implementation using CFHost API for asynchronous DNS resolution
  5910. CFStringRef hostname_ref = CFStringCreateWithCString(
  5911. kCFAllocatorDefault, node, kCFStringEncodingUTF8);
  5912. if (!hostname_ref) { return EAI_MEMORY; }
  5913. CFHostRef host_ref = CFHostCreateWithName(kCFAllocatorDefault, hostname_ref);
  5914. CFRelease(hostname_ref);
  5915. if (!host_ref) { return EAI_MEMORY; }
  5916. // Set up context for callback
  5917. struct CFHostContext {
  5918. bool completed = false;
  5919. bool success = false;
  5920. CFArrayRef addresses = nullptr;
  5921. std::mutex mutex;
  5922. std::condition_variable cv;
  5923. } context;
  5924. CFHostClientContext client_context;
  5925. memset(&client_context, 0, sizeof(client_context));
  5926. client_context.info = &context;
  5927. // Set callback
  5928. auto callback = [](CFHostRef theHost, CFHostInfoType /*typeInfo*/,
  5929. const CFStreamError *error, void *info) {
  5930. auto ctx = static_cast<CFHostContext *>(info);
  5931. std::lock_guard<std::mutex> lock(ctx->mutex);
  5932. if (error && error->error != 0) {
  5933. ctx->success = false;
  5934. } else {
  5935. Boolean hasBeenResolved;
  5936. ctx->addresses = CFHostGetAddressing(theHost, &hasBeenResolved);
  5937. if (ctx->addresses && hasBeenResolved) {
  5938. CFRetain(ctx->addresses);
  5939. ctx->success = true;
  5940. } else {
  5941. ctx->success = false;
  5942. }
  5943. }
  5944. ctx->completed = true;
  5945. ctx->cv.notify_one();
  5946. };
  5947. if (!CFHostSetClient(host_ref, callback, &client_context)) {
  5948. CFRelease(host_ref);
  5949. return EAI_SYSTEM;
  5950. }
  5951. // Schedule on run loop
  5952. CFRunLoopRef run_loop = CFRunLoopGetCurrent();
  5953. CFHostScheduleWithRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5954. // Start resolution
  5955. CFStreamError stream_error;
  5956. if (!CFHostStartInfoResolution(host_ref, kCFHostAddresses, &stream_error)) {
  5957. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5958. CFRelease(host_ref);
  5959. return EAI_FAIL;
  5960. }
  5961. // Wait for completion with timeout
  5962. auto timeout_time =
  5963. std::chrono::steady_clock::now() + std::chrono::seconds(timeout_sec);
  5964. bool timed_out = false;
  5965. {
  5966. std::unique_lock<std::mutex> lock(context.mutex);
  5967. while (!context.completed) {
  5968. auto now = std::chrono::steady_clock::now();
  5969. if (now >= timeout_time) {
  5970. timed_out = true;
  5971. break;
  5972. }
  5973. // Run the runloop for a short time
  5974. lock.unlock();
  5975. CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.1, true);
  5976. lock.lock();
  5977. }
  5978. }
  5979. // Clean up
  5980. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5981. CFHostSetClient(host_ref, nullptr, nullptr);
  5982. if (timed_out || !context.completed) {
  5983. CFHostCancelInfoResolution(host_ref, kCFHostAddresses);
  5984. CFRelease(host_ref);
  5985. return EAI_AGAIN;
  5986. }
  5987. if (!context.success || !context.addresses) {
  5988. CFRelease(host_ref);
  5989. return EAI_NODATA;
  5990. }
  5991. // Convert CFArray to addrinfo
  5992. CFIndex count = CFArrayGetCount(context.addresses);
  5993. if (count == 0) {
  5994. CFRelease(context.addresses);
  5995. CFRelease(host_ref);
  5996. return EAI_NODATA;
  5997. }
  5998. struct addrinfo *result_addrinfo = nullptr;
  5999. struct addrinfo **current = &result_addrinfo;
  6000. for (CFIndex i = 0; i < count; i++) {
  6001. CFDataRef addr_data =
  6002. static_cast<CFDataRef>(CFArrayGetValueAtIndex(context.addresses, i));
  6003. if (!addr_data) continue;
  6004. const struct sockaddr *sockaddr_ptr =
  6005. reinterpret_cast<const struct sockaddr *>(CFDataGetBytePtr(addr_data));
  6006. socklen_t sockaddr_len = static_cast<socklen_t>(CFDataGetLength(addr_data));
  6007. // Allocate addrinfo structure
  6008. *current = static_cast<struct addrinfo *>(malloc(sizeof(struct addrinfo)));
  6009. if (!*current) {
  6010. freeaddrinfo(result_addrinfo);
  6011. CFRelease(context.addresses);
  6012. CFRelease(host_ref);
  6013. return EAI_MEMORY;
  6014. }
  6015. memset(*current, 0, sizeof(struct addrinfo));
  6016. // Set up addrinfo fields
  6017. (*current)->ai_family = sockaddr_ptr->sa_family;
  6018. (*current)->ai_socktype = hints ? hints->ai_socktype : SOCK_STREAM;
  6019. (*current)->ai_protocol = hints ? hints->ai_protocol : IPPROTO_TCP;
  6020. (*current)->ai_addrlen = sockaddr_len;
  6021. // Copy sockaddr
  6022. (*current)->ai_addr = static_cast<struct sockaddr *>(malloc(sockaddr_len));
  6023. if (!(*current)->ai_addr) {
  6024. freeaddrinfo(result_addrinfo);
  6025. CFRelease(context.addresses);
  6026. CFRelease(host_ref);
  6027. return EAI_MEMORY;
  6028. }
  6029. memcpy((*current)->ai_addr, sockaddr_ptr, sockaddr_len);
  6030. // Set port if service is specified
  6031. if (service && *service) {
  6032. int port = 0;
  6033. if (parse_port(service, strlen(service), port)) {
  6034. if (sockaddr_ptr->sa_family == AF_INET) {
  6035. reinterpret_cast<struct sockaddr_in *>((*current)->ai_addr)
  6036. ->sin_port = htons(static_cast<uint16_t>(port));
  6037. } else if (sockaddr_ptr->sa_family == AF_INET6) {
  6038. reinterpret_cast<struct sockaddr_in6 *>((*current)->ai_addr)
  6039. ->sin6_port = htons(static_cast<uint16_t>(port));
  6040. }
  6041. }
  6042. }
  6043. current = &((*current)->ai_next);
  6044. }
  6045. CFRelease(context.addresses);
  6046. CFRelease(host_ref);
  6047. *res = result_addrinfo;
  6048. return 0;
  6049. #elif defined(_GNU_SOURCE) && defined(__GLIBC__) && \
  6050. (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 2)) && \
  6051. !defined(CPPHTTPLIB_THREAD_SANITIZER)
  6052. // Skipped under TSan: glibc's internal resolver thread is invisible to it.
  6053. // #2431: gai_cancel() is non-blocking and may return EAI_NOTCANCELED while
  6054. // the resolver worker still references the stack-local gaicb. The cancel
  6055. // path therefore waits (gai_suspend with no timeout) for the worker to
  6056. // actually finish before letting the stack frame go. The trade-off is that
  6057. // a wedged DNS server can hold this thread for the system resolver timeout
  6058. // (~30s by default) past the caller's connection timeout.
  6059. struct gaicb request{};
  6060. struct gaicb *requests[1] = {&request};
  6061. struct sigevent sevp{};
  6062. struct timespec timeout{timeout_sec, 0};
  6063. request.ar_name = node;
  6064. request.ar_service = service;
  6065. request.ar_request = hints;
  6066. sevp.sigev_notify = SIGEV_NONE;
  6067. int rc = getaddrinfo_a(GAI_NOWAIT, requests, 1, &sevp);
  6068. if (rc != 0) { return rc; }
  6069. auto cleanup = scope_exit([&] {
  6070. if (request.ar_result) { freeaddrinfo(request.ar_result); }
  6071. });
  6072. int wait_result = gai_suspend(requests, 1, &timeout);
  6073. if (wait_result == 0 || wait_result == EAI_ALLDONE) {
  6074. int gai_result = gai_error(&request);
  6075. if (gai_result == 0) {
  6076. *res = request.ar_result;
  6077. request.ar_result = nullptr;
  6078. return 0;
  6079. }
  6080. return gai_result;
  6081. }
  6082. gai_cancel(&request);
  6083. while (gai_error(&request) == EAI_INPROGRESS) {
  6084. gai_suspend(requests, 1, nullptr);
  6085. }
  6086. return wait_result;
  6087. #else
  6088. // Fallback implementation using thread-based timeout for other Unix systems.
  6089. struct GetAddrInfoState {
  6090. ~GetAddrInfoState() {
  6091. if (info) { freeaddrinfo(info); }
  6092. }
  6093. std::mutex mutex;
  6094. std::condition_variable result_cv;
  6095. bool completed = false;
  6096. int result = EAI_SYSTEM;
  6097. std::string node;
  6098. std::string service;
  6099. struct addrinfo hints;
  6100. struct addrinfo *info = nullptr;
  6101. };
  6102. // Allocate on the heap, so the resolver thread can keep using the data.
  6103. auto state = std::make_shared<GetAddrInfoState>();
  6104. if (node) { state->node = node; }
  6105. state->service = service;
  6106. state->hints = *hints;
  6107. std::thread resolve_thread([state]() {
  6108. auto thread_result =
  6109. getaddrinfo(state->node.c_str(), state->service.c_str(), &state->hints,
  6110. &state->info);
  6111. std::lock_guard<std::mutex> lock(state->mutex);
  6112. state->result = thread_result;
  6113. state->completed = true;
  6114. state->result_cv.notify_one();
  6115. });
  6116. // Wait for completion or timeout
  6117. std::unique_lock<std::mutex> lock(state->mutex);
  6118. auto finished =
  6119. state->result_cv.wait_for(lock, std::chrono::seconds(timeout_sec),
  6120. [&] { return state->completed; });
  6121. if (finished) {
  6122. // Operation completed within timeout
  6123. resolve_thread.join();
  6124. *res = state->info;
  6125. state->info = nullptr; // Pass ownership to caller
  6126. return state->result;
  6127. } else {
  6128. // Timeout occurred
  6129. resolve_thread.detach(); // Let the thread finish in background
  6130. return EAI_AGAIN; // Return timeout error
  6131. }
  6132. #endif
  6133. #else
  6134. (void)(timeout_sec); // Unused parameter for non-blocking getaddrinfo
  6135. return getaddrinfo(node, service, hints, res);
  6136. #endif
  6137. }
  6138. template <typename BindOrConnect>
  6139. socket_t create_socket(const std::string &host, const std::string &ip, int port,
  6140. int address_family, int socket_flags, bool tcp_nodelay,
  6141. bool ipv6_v6only, SocketOptions socket_options,
  6142. BindOrConnect bind_or_connect, time_t timeout_sec = 0) {
  6143. // Get address info
  6144. const char *node = nullptr;
  6145. struct addrinfo hints;
  6146. struct addrinfo *result;
  6147. memset(&hints, 0, sizeof(struct addrinfo));
  6148. hints.ai_socktype = SOCK_STREAM;
  6149. hints.ai_protocol = IPPROTO_IP;
  6150. if (!ip.empty()) {
  6151. node = ip.c_str();
  6152. // Ask getaddrinfo to convert IP in c-string to address
  6153. hints.ai_family = AF_UNSPEC;
  6154. hints.ai_flags = AI_NUMERICHOST;
  6155. } else {
  6156. if (!host.empty()) { node = host.c_str(); }
  6157. hints.ai_family = address_family;
  6158. hints.ai_flags = socket_flags;
  6159. }
  6160. #if !defined(_WIN32) || defined(CPPHTTPLIB_HAVE_AFUNIX_H)
  6161. if (hints.ai_family == AF_UNIX) {
  6162. const auto addrlen = host.length();
  6163. if (addrlen > sizeof(sockaddr_un::sun_path)) { return INVALID_SOCKET; }
  6164. #ifdef SOCK_CLOEXEC
  6165. auto sock = socket(hints.ai_family, hints.ai_socktype | SOCK_CLOEXEC,
  6166. hints.ai_protocol);
  6167. #else
  6168. auto sock = socket(hints.ai_family, hints.ai_socktype, hints.ai_protocol);
  6169. #endif
  6170. if (sock != INVALID_SOCKET) {
  6171. sockaddr_un addr{};
  6172. addr.sun_family = AF_UNIX;
  6173. auto unescaped_host = unescape_abstract_namespace_unix_domain(host);
  6174. std::copy(unescaped_host.begin(), unescaped_host.end(), addr.sun_path);
  6175. hints.ai_addr = reinterpret_cast<sockaddr *>(&addr);
  6176. hints.ai_addrlen = static_cast<socklen_t>(
  6177. sizeof(addr) - sizeof(addr.sun_path) + addrlen);
  6178. #ifndef SOCK_CLOEXEC
  6179. #ifndef _WIN32
  6180. fcntl(sock, F_SETFD, FD_CLOEXEC);
  6181. #endif
  6182. #endif
  6183. if (socket_options) { socket_options(sock); }
  6184. #ifdef _WIN32
  6185. // Setting SO_REUSEADDR seems not to work well with AF_UNIX on windows, so
  6186. // remove the option.
  6187. set_socket_opt(sock, SOL_SOCKET, SO_REUSEADDR, 0);
  6188. #endif
  6189. bool dummy;
  6190. if (!bind_or_connect(sock, hints, dummy)) {
  6191. close_socket(sock);
  6192. sock = INVALID_SOCKET;
  6193. }
  6194. }
  6195. return sock;
  6196. }
  6197. #endif
  6198. auto service = std::to_string(port);
  6199. if (getaddrinfo_with_timeout(node, service.c_str(), &hints, &result,
  6200. timeout_sec)) {
  6201. #if defined __linux__ && !defined __ANDROID__
  6202. res_init();
  6203. #endif
  6204. return INVALID_SOCKET;
  6205. }
  6206. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6207. for (auto rp = result; rp; rp = rp->ai_next) {
  6208. // Create a socket
  6209. #ifdef _WIN32
  6210. auto sock =
  6211. WSASocketW(rp->ai_family, rp->ai_socktype, rp->ai_protocol, nullptr, 0,
  6212. WSA_FLAG_NO_HANDLE_INHERIT | WSA_FLAG_OVERLAPPED);
  6213. /**
  6214. * Since the WSA_FLAG_NO_HANDLE_INHERIT is only supported on Windows 7 SP1
  6215. * and above the socket creation fails on older Windows Systems.
  6216. *
  6217. * Let's try to create a socket the old way in this case.
  6218. *
  6219. * Reference:
  6220. * https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketa
  6221. *
  6222. * WSA_FLAG_NO_HANDLE_INHERIT:
  6223. * This flag is supported on Windows 7 with SP1, Windows Server 2008 R2 with
  6224. * SP1, and later
  6225. *
  6226. */
  6227. if (sock == INVALID_SOCKET) {
  6228. sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6229. }
  6230. #else
  6231. #ifdef SOCK_CLOEXEC
  6232. auto sock =
  6233. socket(rp->ai_family, rp->ai_socktype | SOCK_CLOEXEC, rp->ai_protocol);
  6234. #else
  6235. auto sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6236. #endif
  6237. #endif
  6238. if (sock == INVALID_SOCKET) { continue; }
  6239. #if !defined _WIN32 && !defined SOCK_CLOEXEC
  6240. if (fcntl(sock, F_SETFD, FD_CLOEXEC) == -1) {
  6241. close_socket(sock);
  6242. continue;
  6243. }
  6244. #endif
  6245. if (tcp_nodelay) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  6246. if (rp->ai_family == AF_INET6) {
  6247. set_socket_opt(sock, IPPROTO_IPV6, IPV6_V6ONLY, ipv6_v6only ? 1 : 0);
  6248. }
  6249. if (socket_options) { socket_options(sock); }
  6250. // bind or connect
  6251. auto quit = false;
  6252. if (bind_or_connect(sock, *rp, quit)) { return sock; }
  6253. close_socket(sock);
  6254. if (quit) { break; }
  6255. }
  6256. return INVALID_SOCKET;
  6257. }
  6258. inline void set_nonblocking(socket_t sock, bool nonblocking) {
  6259. #ifdef _WIN32
  6260. auto flags = nonblocking ? 1UL : 0UL;
  6261. ioctlsocket(sock, FIONBIO, &flags);
  6262. #else
  6263. auto flags = fcntl(sock, F_GETFL, 0);
  6264. fcntl(sock, F_SETFL,
  6265. nonblocking ? (flags | O_NONBLOCK) : (flags & (~O_NONBLOCK)));
  6266. #endif
  6267. }
  6268. inline bool is_connection_error() {
  6269. #ifdef _WIN32
  6270. return WSAGetLastError() != WSAEWOULDBLOCK;
  6271. #else
  6272. return errno != EINPROGRESS;
  6273. #endif
  6274. }
  6275. // accept() failed because the process or the network stack is temporarily out
  6276. // of resources. The listening socket is still usable, so back off briefly and
  6277. // try again.
  6278. inline bool is_accept_resource_error() {
  6279. #ifdef _WIN32
  6280. auto err = WSAGetLastError();
  6281. return err == WSAEMFILE || err == WSAENOBUFS;
  6282. #else
  6283. auto err = errno;
  6284. return err == EMFILE || err == ENFILE || err == ENOBUFS || err == ENOMEM;
  6285. #endif
  6286. }
  6287. // accept() failed for a reason that says nothing about the listening socket:
  6288. // the pending connection went away before it could be accepted, or the call
  6289. // was interrupted. Retry immediately. WSAAccept()'s own documentation omits
  6290. // WSAECONNRESET, but the accept() it wraps reports an aborted pending
  6291. // connection that way.
  6292. inline bool is_accept_transient_error() {
  6293. #ifdef _WIN32
  6294. auto err = WSAGetLastError();
  6295. return err == WSAEINTR || err == WSAEWOULDBLOCK || err == WSAECONNRESET ||
  6296. err == WSAECONNABORTED;
  6297. #else
  6298. auto err = errno;
  6299. return err == EINTR || err == EAGAIN || err == EWOULDBLOCK ||
  6300. err == ECONNABORTED;
  6301. #endif
  6302. }
  6303. inline bool bind_ip_address(socket_t sock, const std::string &host) {
  6304. struct addrinfo hints;
  6305. struct addrinfo *result;
  6306. memset(&hints, 0, sizeof(struct addrinfo));
  6307. hints.ai_family = AF_UNSPEC;
  6308. hints.ai_socktype = SOCK_STREAM;
  6309. hints.ai_protocol = 0;
  6310. if (getaddrinfo_with_timeout(host.c_str(), "0", &hints, &result, 0)) {
  6311. return false;
  6312. }
  6313. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6314. auto ret = false;
  6315. for (auto rp = result; rp; rp = rp->ai_next) {
  6316. const auto &ai = *rp;
  6317. if (!::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  6318. ret = true;
  6319. break;
  6320. }
  6321. }
  6322. return ret;
  6323. }
  6324. #if !defined _WIN32 && !defined ANDROID && !defined _AIX && !defined __MVS__
  6325. #define USE_IF2IP
  6326. #endif
  6327. #ifdef USE_IF2IP
  6328. inline std::string if2ip(int address_family, const std::string &ifn) {
  6329. struct ifaddrs *ifap;
  6330. getifaddrs(&ifap);
  6331. auto se = detail::scope_exit([&] { freeifaddrs(ifap); });
  6332. std::string addr_candidate;
  6333. for (auto ifa = ifap; ifa; ifa = ifa->ifa_next) {
  6334. if (ifa->ifa_addr && ifn == ifa->ifa_name &&
  6335. (AF_UNSPEC == address_family ||
  6336. ifa->ifa_addr->sa_family == address_family)) {
  6337. if (ifa->ifa_addr->sa_family == AF_INET) {
  6338. auto sa = reinterpret_cast<struct sockaddr_in *>(ifa->ifa_addr);
  6339. char buf[INET_ADDRSTRLEN];
  6340. if (inet_ntop(AF_INET, &sa->sin_addr, buf, INET_ADDRSTRLEN)) {
  6341. return std::string(buf, INET_ADDRSTRLEN);
  6342. }
  6343. } else if (ifa->ifa_addr->sa_family == AF_INET6) {
  6344. auto sa = reinterpret_cast<struct sockaddr_in6 *>(ifa->ifa_addr);
  6345. if (!IN6_IS_ADDR_LINKLOCAL(&sa->sin6_addr)) {
  6346. char buf[INET6_ADDRSTRLEN] = {};
  6347. if (inet_ntop(AF_INET6, &sa->sin6_addr, buf, INET6_ADDRSTRLEN)) {
  6348. // equivalent to mac's IN6_IS_ADDR_UNIQUE_LOCAL
  6349. auto s6_addr_head = sa->sin6_addr.s6_addr[0];
  6350. if (s6_addr_head == 0xfc || s6_addr_head == 0xfd) {
  6351. addr_candidate = std::string(buf, INET6_ADDRSTRLEN);
  6352. } else {
  6353. return std::string(buf, INET6_ADDRSTRLEN);
  6354. }
  6355. }
  6356. }
  6357. }
  6358. }
  6359. }
  6360. return addr_candidate;
  6361. }
  6362. #endif
  6363. inline socket_t create_client_socket(
  6364. const std::string &host, const std::string &ip, int port,
  6365. int address_family, bool tcp_nodelay, bool ipv6_v6only,
  6366. SocketOptions socket_options, time_t connection_timeout_sec,
  6367. time_t connection_timeout_usec, time_t read_timeout_sec,
  6368. time_t read_timeout_usec, time_t write_timeout_sec,
  6369. time_t write_timeout_usec, const std::string &intf, Error &error) {
  6370. auto sock = create_socket(
  6371. host, ip, port, address_family, 0, tcp_nodelay, ipv6_v6only,
  6372. std::move(socket_options),
  6373. [&](socket_t sock2, struct addrinfo &ai, bool &quit) -> bool {
  6374. if (!intf.empty()) {
  6375. #ifdef USE_IF2IP
  6376. auto ip_from_if = if2ip(address_family, intf);
  6377. if (ip_from_if.empty()) { ip_from_if = intf; }
  6378. if (!bind_ip_address(sock2, ip_from_if)) {
  6379. error = Error::BindIPAddress;
  6380. return false;
  6381. }
  6382. #endif
  6383. }
  6384. set_nonblocking(sock2, true);
  6385. auto ret =
  6386. ::connect(sock2, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen));
  6387. if (ret < 0) {
  6388. if (is_connection_error()) {
  6389. error = Error::Connection;
  6390. return false;
  6391. }
  6392. error = wait_until_socket_is_ready(sock2, connection_timeout_sec,
  6393. connection_timeout_usec);
  6394. if (error != Error::Success) {
  6395. if (error == Error::ConnectionTimeout) { quit = true; }
  6396. return false;
  6397. }
  6398. }
  6399. set_nonblocking(sock2, false);
  6400. set_socket_opt_time(sock2, SOL_SOCKET, SO_RCVTIMEO, read_timeout_sec,
  6401. read_timeout_usec);
  6402. set_socket_opt_time(sock2, SOL_SOCKET, SO_SNDTIMEO, write_timeout_sec,
  6403. write_timeout_usec);
  6404. error = Error::Success;
  6405. return true;
  6406. },
  6407. connection_timeout_sec); // Pass DNS timeout
  6408. if (sock != INVALID_SOCKET) {
  6409. error = Error::Success;
  6410. } else {
  6411. if (error == Error::Success) { error = Error::Connection; }
  6412. }
  6413. return sock;
  6414. }
  6415. inline bool get_ip_and_port(const struct sockaddr_storage &addr,
  6416. socklen_t addr_len, std::string &ip, int &port) {
  6417. if (addr.ss_family == AF_INET) {
  6418. port = ntohs(reinterpret_cast<const struct sockaddr_in *>(&addr)->sin_port);
  6419. } else if (addr.ss_family == AF_INET6) {
  6420. port =
  6421. ntohs(reinterpret_cast<const struct sockaddr_in6 *>(&addr)->sin6_port);
  6422. } else {
  6423. return false;
  6424. }
  6425. std::array<char, NI_MAXHOST> ipstr{};
  6426. if (getnameinfo(reinterpret_cast<const struct sockaddr *>(&addr), addr_len,
  6427. ipstr.data(), static_cast<socklen_t>(ipstr.size()), nullptr,
  6428. 0, NI_NUMERICHOST)) {
  6429. return false;
  6430. }
  6431. ip = ipstr.data();
  6432. return true;
  6433. }
  6434. inline void get_local_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6435. struct sockaddr_storage addr;
  6436. socklen_t addr_len = sizeof(addr);
  6437. if (!getsockname(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6438. &addr_len)) {
  6439. get_ip_and_port(addr, addr_len, ip, port);
  6440. }
  6441. }
  6442. inline void get_remote_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6443. struct sockaddr_storage addr;
  6444. socklen_t addr_len = sizeof(addr);
  6445. if (!getpeername(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6446. &addr_len)) {
  6447. #ifndef _WIN32
  6448. if (addr.ss_family == AF_UNIX) {
  6449. #if defined(__linux__)
  6450. struct ucred ucred;
  6451. socklen_t len = sizeof(ucred);
  6452. if (getsockopt(sock, SOL_SOCKET, SO_PEERCRED, &ucred, &len) == 0) {
  6453. port = ucred.pid;
  6454. }
  6455. #elif defined(SOL_LOCAL) && defined(SO_PEERPID)
  6456. pid_t pid;
  6457. socklen_t len = sizeof(pid);
  6458. if (getsockopt(sock, SOL_LOCAL, SO_PEERPID, &pid, &len) == 0) {
  6459. port = pid;
  6460. }
  6461. #endif
  6462. return;
  6463. }
  6464. #endif
  6465. get_ip_and_port(addr, addr_len, ip, port);
  6466. }
  6467. }
  6468. inline std::string
  6469. find_content_type(const std::string &path,
  6470. const std::map<std::string, std::string> &user_data,
  6471. const std::string &default_content_type) {
  6472. auto ext = file_extension(path);
  6473. // Extensions are matched regardless of case, as web servers do, with an
  6474. // exact match to a user mapping first
  6475. auto lower_ext = case_ignore::to_lower(ext);
  6476. auto it = user_data.find(ext);
  6477. if (it == user_data.end()) { it = user_data.find(lower_ext); }
  6478. if (it != user_data.end()) { return it->second; }
  6479. static const struct {
  6480. const char *ext;
  6481. const char *type;
  6482. } types[] = {
  6483. {"css", "text/css"},
  6484. {"csv", "text/csv"},
  6485. {"htm", "text/html"},
  6486. {"html", "text/html"},
  6487. {"js", "text/javascript"},
  6488. {"mjs", "text/javascript"},
  6489. {"txt", "text/plain"},
  6490. {"vtt", "text/vtt"},
  6491. {"apng", "image/apng"},
  6492. {"avif", "image/avif"},
  6493. {"bmp", "image/bmp"},
  6494. {"gif", "image/gif"},
  6495. {"png", "image/png"},
  6496. {"svg", "image/svg+xml"},
  6497. {"webp", "image/webp"},
  6498. {"ico", "image/x-icon"},
  6499. {"tif", "image/tiff"},
  6500. {"tiff", "image/tiff"},
  6501. {"jpg", "image/jpeg"},
  6502. {"jpeg", "image/jpeg"},
  6503. {"mp4", "video/mp4"},
  6504. {"mpeg", "video/mpeg"},
  6505. {"webm", "video/webm"},
  6506. {"mp3", "audio/mp3"},
  6507. {"mpga", "audio/mpeg"},
  6508. {"weba", "audio/webm"},
  6509. {"wav", "audio/wave"},
  6510. {"otf", "font/otf"},
  6511. {"ttf", "font/ttf"},
  6512. {"woff", "font/woff"},
  6513. {"woff2", "font/woff2"},
  6514. {"7z", "application/x-7z-compressed"},
  6515. {"atom", "application/atom+xml"},
  6516. {"pdf", "application/pdf"},
  6517. {"json", "application/json"},
  6518. {"rss", "application/rss+xml"},
  6519. {"tar", "application/x-tar"},
  6520. {"xht", "application/xhtml+xml"},
  6521. {"xhtml", "application/xhtml+xml"},
  6522. {"xslt", "application/xslt+xml"},
  6523. {"xml", "application/xml"},
  6524. {"gz", "application/gzip"},
  6525. {"zip", "application/zip"},
  6526. {"wasm", "application/wasm"},
  6527. };
  6528. for (const auto &t : types) {
  6529. if (lower_ext == t.ext) { return t.type; }
  6530. }
  6531. return default_content_type;
  6532. }
  6533. inline std::string
  6534. extract_media_type(const std::string &content_type,
  6535. std::map<std::string, std::string> *params = nullptr) {
  6536. // Extract type/subtype from Content-Type value (RFC 2045)
  6537. // e.g. "application/json; charset=utf-8" -> "application/json"
  6538. auto media_type = content_type;
  6539. auto semicolon_pos = media_type.find(';');
  6540. if (semicolon_pos != std::string::npos) {
  6541. auto param_str = media_type.substr(semicolon_pos + 1);
  6542. media_type = media_type.substr(0, semicolon_pos);
  6543. if (params) {
  6544. // Parse parameters: key=value pairs separated by ';'
  6545. split_unquoted(param_str.data(), param_str.data() + param_str.size(), ';',
  6546. [&](const char *b, const char *e) {
  6547. std::string key;
  6548. std::string val;
  6549. divide_param_pair(b, e, key, val);
  6550. // Parameter names are case-insensitive (RFC 9110
  6551. // §5.6.6)
  6552. if (!key.empty()) {
  6553. params->emplace(case_ignore::to_lower(trim_copy(key)),
  6554. unquote_param(val));
  6555. }
  6556. });
  6557. }
  6558. }
  6559. // Trim whitespace from media type
  6560. return trim_copy(media_type);
  6561. }
  6562. inline bool can_compress_content_type(const std::string &content_type) {
  6563. // Media types are case-insensitive (RFC 9110 §8.3.1)
  6564. auto mime_type = case_ignore::to_lower(extract_media_type(content_type));
  6565. static const char *const compressible[] = {
  6566. "image/svg+xml",
  6567. "application/javascript",
  6568. "application/x-javascript",
  6569. "application/json",
  6570. "application/ld+json",
  6571. "application/xml",
  6572. "application/xhtml+xml",
  6573. "application/rss+xml",
  6574. "application/atom+xml",
  6575. "application/xslt+xml",
  6576. "application/protobuf",
  6577. };
  6578. for (auto type : compressible) {
  6579. if (mime_type == type) { return true; }
  6580. }
  6581. return mime_type != "text/event-stream" && !mime_type.rfind("text/", 0);
  6582. }
  6583. inline bool parse_quality(const char *b, const char *e, std::string &token,
  6584. double &quality) {
  6585. quality = 1.0;
  6586. token.clear();
  6587. // Split on first ';': left = token name, right = parameters
  6588. const char *params_b = nullptr;
  6589. std::size_t params_len = 0;
  6590. divide(
  6591. b, static_cast<std::size_t>(e - b), ';',
  6592. [&](const char *lb, std::size_t llen, const char *rb, std::size_t rlen) {
  6593. auto r = trim(lb, lb + llen, 0, llen);
  6594. if (r.first < r.second) { token.assign(lb + r.first, lb + r.second); }
  6595. params_b = rb;
  6596. params_len = rlen;
  6597. });
  6598. if (token.empty()) { return false; }
  6599. if (params_len == 0) { return true; }
  6600. // Scan parameters for q= (stops on first match)
  6601. bool invalid = false;
  6602. split_find(params_b, params_b + params_len, ';',
  6603. (std::numeric_limits<size_t>::max)(),
  6604. [&](const char *pb, const char *pe) -> bool {
  6605. // Match exactly "q=" or "Q=" (not "query=" etc.)
  6606. auto len = static_cast<size_t>(pe - pb);
  6607. if (len < 2) { return false; }
  6608. if ((pb[0] != 'q' && pb[0] != 'Q') || pb[1] != '=') {
  6609. return false;
  6610. }
  6611. // Trim the value portion
  6612. auto r = trim(pb, pe, 2, len);
  6613. if (r.first >= r.second) {
  6614. invalid = true;
  6615. return true;
  6616. }
  6617. double v = 0.0;
  6618. auto res = from_chars(pb + r.first, pb + r.second, v);
  6619. if (res.ec != std::errc{} || res.ptr != pb + r.second ||
  6620. v < 0.0 || v > 1.0) {
  6621. invalid = true;
  6622. return true;
  6623. }
  6624. quality = v;
  6625. return true;
  6626. });
  6627. return !invalid;
  6628. }
  6629. inline EncodingType encoding_type(const Request &req,
  6630. const std::string &content_type) {
  6631. if (!can_compress_content_type(content_type)) { return EncodingType::None; }
  6632. auto s = get_combined_header_value(req.headers, "Accept-Encoding");
  6633. if (s.empty()) { return EncodingType::None; }
  6634. // Single-pass: iterate tokens and track the best supported encoding.
  6635. // Server preference breaks ties (br > gzip > zstd).
  6636. EncodingType best = EncodingType::None;
  6637. double best_q = 0.0; // q=0 means "not acceptable"
  6638. // Server preference: Brotli > Gzip > Zstd (lower = more preferred)
  6639. auto priority = [](EncodingType t) -> int {
  6640. switch (t) {
  6641. case EncodingType::Brotli: return 0;
  6642. case EncodingType::Gzip: return 1;
  6643. case EncodingType::Zstd: return 2;
  6644. default: return 3;
  6645. }
  6646. };
  6647. std::string name;
  6648. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  6649. double quality = 1.0;
  6650. if (!parse_quality(b, e, name, quality)) { return; }
  6651. if (quality <= 0.0) { return; }
  6652. EncodingType type = EncodingType::None;
  6653. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6654. if (case_ignore::equal(name, "br")) { type = EncodingType::Brotli; }
  6655. #endif
  6656. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6657. if (type == EncodingType::None && case_ignore::equal(name, "gzip")) {
  6658. type = EncodingType::Gzip;
  6659. }
  6660. #endif
  6661. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6662. if (type == EncodingType::None && case_ignore::equal(name, "zstd")) {
  6663. type = EncodingType::Zstd;
  6664. }
  6665. #endif
  6666. if (type == EncodingType::None) { return; }
  6667. // Higher q-value wins; for equal q, server preference breaks ties
  6668. if (quality > best_q ||
  6669. (quality == best_q && priority(type) < priority(best))) {
  6670. best_q = quality;
  6671. best = type;
  6672. }
  6673. });
  6674. return best;
  6675. }
  6676. // `content_type` is taken separately because a file-backed response has not
  6677. // been given one yet when its coding has to be decided.
  6678. inline EncodingType encoding_type(const Request &req, const Response &res,
  6679. const std::string &content_type) {
  6680. // The response already names a content coding of its own: a handler serving
  6681. // a body it encoded itself (pre-compressed static assets, say), or a mount
  6682. // point whose headers name the coding its files are stored in. Applying one
  6683. // on top of that would double-encode the body and append a second
  6684. // `Content-Encoding` field line.
  6685. if (res.has_header("Content-Encoding")) { return EncodingType::None; }
  6686. return encoding_type(req, content_type);
  6687. }
  6688. inline EncodingType encoding_type(const Request &req, const Response &res) {
  6689. return encoding_type(req, res, res.get_header_value("Content-Type"));
  6690. }
  6691. inline std::unique_ptr<compressor> make_compressor(EncodingType type) {
  6692. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6693. if (type == EncodingType::Gzip) {
  6694. return detail::make_unique<gzip_compressor>();
  6695. }
  6696. #endif
  6697. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6698. if (type == EncodingType::Brotli) {
  6699. return detail::make_unique<brotli_compressor>();
  6700. }
  6701. #endif
  6702. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6703. if (type == EncodingType::Zstd) {
  6704. return detail::make_unique<zstd_compressor>();
  6705. }
  6706. #endif
  6707. (void)type;
  6708. return nullptr;
  6709. }
  6710. inline const char *encoding_name(EncodingType type) {
  6711. switch (type) {
  6712. case EncodingType::Gzip: return "gzip";
  6713. case EncodingType::Brotli: return "br";
  6714. case EncodingType::Zstd: return "zstd";
  6715. default: return "";
  6716. }
  6717. }
  6718. inline bool nocompressor::compress(const char *data, size_t data_length,
  6719. bool /*last*/, Callback callback) {
  6720. if (!data_length) { return true; }
  6721. return callback(data, data_length);
  6722. }
  6723. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6724. inline gzip_compressor::gzip_compressor() {
  6725. std::memset(&strm_, 0, sizeof(strm_));
  6726. strm_.zalloc = Z_NULL;
  6727. strm_.zfree = Z_NULL;
  6728. strm_.opaque = Z_NULL;
  6729. is_valid_ = deflateInit2(&strm_, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 31, 8,
  6730. Z_DEFAULT_STRATEGY) == Z_OK;
  6731. }
  6732. inline gzip_compressor::~gzip_compressor() { deflateEnd(&strm_); }
  6733. inline bool gzip_compressor::compress(const char *data, size_t data_length,
  6734. bool last, Callback callback) {
  6735. assert(is_valid_);
  6736. do {
  6737. constexpr size_t max_avail_in =
  6738. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6739. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6740. (std::min)(data_length, max_avail_in));
  6741. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6742. data_length -= strm_.avail_in;
  6743. data += strm_.avail_in;
  6744. auto flush = (last && data_length == 0) ? Z_FINISH : Z_NO_FLUSH;
  6745. auto ret = Z_OK;
  6746. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6747. do {
  6748. strm_.avail_out = static_cast<uInt>(buff.size());
  6749. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6750. ret = deflate(&strm_, flush);
  6751. if (ret == Z_STREAM_ERROR) { return false; }
  6752. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6753. return false;
  6754. }
  6755. } while (strm_.avail_out == 0);
  6756. assert((flush == Z_FINISH && ret == Z_STREAM_END) ||
  6757. (flush == Z_NO_FLUSH && ret == Z_OK));
  6758. assert(strm_.avail_in == 0);
  6759. } while (data_length > 0);
  6760. return true;
  6761. }
  6762. inline gzip_decompressor::gzip_decompressor() {
  6763. std::memset(&strm_, 0, sizeof(strm_));
  6764. strm_.zalloc = Z_NULL;
  6765. strm_.zfree = Z_NULL;
  6766. strm_.opaque = Z_NULL;
  6767. // 15 is the value of wbits, which should be at the maximum possible value
  6768. // to ensure that any gzip stream can be decoded. The offset of 32 specifies
  6769. // that the stream type should be automatically detected either gzip or
  6770. // deflate.
  6771. is_valid_ = inflateInit2(&strm_, 32 + 15) == Z_OK;
  6772. }
  6773. inline gzip_decompressor::~gzip_decompressor() { inflateEnd(&strm_); }
  6774. inline bool gzip_decompressor::is_valid() const { return is_valid_; }
  6775. inline bool gzip_decompressor::decompress(const char *data, size_t data_length,
  6776. Callback callback) {
  6777. assert(is_valid_);
  6778. auto ret = Z_OK;
  6779. do {
  6780. constexpr size_t max_avail_in =
  6781. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6782. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6783. (std::min)(data_length, max_avail_in));
  6784. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6785. data_length -= strm_.avail_in;
  6786. data += strm_.avail_in;
  6787. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6788. while (strm_.avail_in > 0 && ret == Z_OK) {
  6789. strm_.avail_out = static_cast<uInt>(buff.size());
  6790. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6791. ret = inflate(&strm_, Z_NO_FLUSH);
  6792. assert(ret != Z_STREAM_ERROR);
  6793. switch (ret) {
  6794. case Z_NEED_DICT:
  6795. case Z_DATA_ERROR:
  6796. case Z_MEM_ERROR: inflateEnd(&strm_); return false;
  6797. }
  6798. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6799. return false;
  6800. }
  6801. }
  6802. if (ret != Z_OK && ret != Z_STREAM_END) { return false; }
  6803. } while (data_length > 0);
  6804. return true;
  6805. }
  6806. #endif
  6807. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6808. inline brotli_compressor::brotli_compressor() {
  6809. state_ = BrotliEncoderCreateInstance(nullptr, nullptr, nullptr);
  6810. }
  6811. inline brotli_compressor::~brotli_compressor() {
  6812. BrotliEncoderDestroyInstance(state_);
  6813. }
  6814. inline bool brotli_compressor::compress(const char *data, size_t data_length,
  6815. bool last, Callback callback) {
  6816. std::array<uint8_t, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6817. auto operation = last ? BROTLI_OPERATION_FINISH : BROTLI_OPERATION_PROCESS;
  6818. auto available_in = data_length;
  6819. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6820. for (;;) {
  6821. if (last) {
  6822. if (BrotliEncoderIsFinished(state_)) { break; }
  6823. } else {
  6824. if (!available_in) { break; }
  6825. }
  6826. auto available_out = buff.size();
  6827. auto next_out = buff.data();
  6828. if (!BrotliEncoderCompressStream(state_, operation, &available_in, &next_in,
  6829. &available_out, &next_out, nullptr)) {
  6830. return false;
  6831. }
  6832. auto output_bytes = buff.size() - available_out;
  6833. if (output_bytes) {
  6834. callback(reinterpret_cast<const char *>(buff.data()), output_bytes);
  6835. }
  6836. }
  6837. return true;
  6838. }
  6839. inline brotli_decompressor::brotli_decompressor() {
  6840. decoder_s = BrotliDecoderCreateInstance(0, 0, 0);
  6841. decoder_r = decoder_s ? BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT
  6842. : BROTLI_DECODER_RESULT_ERROR;
  6843. }
  6844. inline brotli_decompressor::~brotli_decompressor() {
  6845. if (decoder_s) { BrotliDecoderDestroyInstance(decoder_s); }
  6846. }
  6847. inline bool brotli_decompressor::is_valid() const { return decoder_s; }
  6848. inline bool brotli_decompressor::decompress(const char *data,
  6849. size_t data_length,
  6850. Callback callback) {
  6851. if (decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6852. decoder_r == BROTLI_DECODER_RESULT_ERROR) {
  6853. return 0;
  6854. }
  6855. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6856. size_t avail_in = data_length;
  6857. size_t total_out;
  6858. decoder_r = BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT;
  6859. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6860. while (decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT) {
  6861. char *next_out = buff.data();
  6862. size_t avail_out = buff.size();
  6863. decoder_r = BrotliDecoderDecompressStream(
  6864. decoder_s, &avail_in, &next_in, &avail_out,
  6865. reinterpret_cast<uint8_t **>(&next_out), &total_out);
  6866. if (decoder_r == BROTLI_DECODER_RESULT_ERROR) { return false; }
  6867. if (!callback(buff.data(), buff.size() - avail_out)) { return false; }
  6868. }
  6869. return decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6870. decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT;
  6871. }
  6872. #endif
  6873. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6874. inline zstd_compressor::zstd_compressor() {
  6875. ctx_ = ZSTD_createCCtx();
  6876. ZSTD_CCtx_setParameter(ctx_, ZSTD_c_compressionLevel, ZSTD_fast);
  6877. }
  6878. inline zstd_compressor::~zstd_compressor() { ZSTD_freeCCtx(ctx_); }
  6879. inline bool zstd_compressor::compress(const char *data, size_t data_length,
  6880. bool last, Callback callback) {
  6881. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6882. ZSTD_EndDirective mode = last ? ZSTD_e_end : ZSTD_e_continue;
  6883. ZSTD_inBuffer input = {data, data_length, 0};
  6884. bool finished;
  6885. do {
  6886. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6887. size_t const remaining = ZSTD_compressStream2(ctx_, &output, &input, mode);
  6888. if (ZSTD_isError(remaining)) { return false; }
  6889. if (!callback(buff.data(), output.pos)) { return false; }
  6890. finished = last ? (remaining == 0) : (input.pos == input.size);
  6891. } while (!finished);
  6892. return true;
  6893. }
  6894. inline zstd_decompressor::zstd_decompressor() { ctx_ = ZSTD_createDCtx(); }
  6895. inline zstd_decompressor::~zstd_decompressor() { ZSTD_freeDCtx(ctx_); }
  6896. inline bool zstd_decompressor::is_valid() const { return ctx_ != nullptr; }
  6897. inline bool zstd_decompressor::decompress(const char *data, size_t data_length,
  6898. Callback callback) {
  6899. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6900. ZSTD_inBuffer input = {data, data_length, 0};
  6901. while (input.pos < input.size) {
  6902. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6903. size_t const remaining = ZSTD_decompressStream(ctx_, &output, &input);
  6904. if (ZSTD_isError(remaining)) { return false; }
  6905. if (!callback(buff.data(), output.pos)) { return false; }
  6906. }
  6907. return true;
  6908. }
  6909. #endif
  6910. // Content codings are case-insensitive (RFC 9110 8.4.1). Matching them
  6911. // case-sensitively would make a response labeled e.g. "GZIP" look like an
  6912. // unknown coding, and its payload would be handed back still compressed.
  6913. inline bool is_zlib_encoding(const std::string &encoding) {
  6914. return case_ignore::equal(encoding, "gzip") ||
  6915. case_ignore::equal(encoding, "deflate");
  6916. }
  6917. inline bool is_brotli_encoding(const std::string &encoding) {
  6918. return case_ignore::equal(encoding, "br");
  6919. }
  6920. inline bool is_zstd_encoding(const std::string &encoding) {
  6921. return case_ignore::equal(encoding, "zstd");
  6922. }
  6923. // Returns true if the content coding is one cpp-httplib is able to decompress
  6924. // when the corresponding support is compiled in.
  6925. inline bool is_known_content_encoding(const std::string &encoding) {
  6926. return is_zlib_encoding(encoding) || is_brotli_encoding(encoding) ||
  6927. is_zstd_encoding(encoding);
  6928. }
  6929. inline std::unique_ptr<decompressor>
  6930. create_decompressor(const std::string &encoding) {
  6931. std::unique_ptr<decompressor> decompressor;
  6932. if (is_zlib_encoding(encoding)) {
  6933. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6934. decompressor = detail::make_unique<gzip_decompressor>();
  6935. #endif
  6936. } else if (is_brotli_encoding(encoding)) {
  6937. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6938. decompressor = detail::make_unique<brotli_decompressor>();
  6939. #endif
  6940. } else if (is_zstd_encoding(encoding)) {
  6941. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6942. decompressor = detail::make_unique<zstd_decompressor>();
  6943. #endif
  6944. }
  6945. return decompressor;
  6946. }
  6947. // Returns the best available compressor and its Content-Encoding name.
  6948. // Priority: Brotli > Gzip > Zstd (matches server-side preference).
  6949. inline std::pair<std::unique_ptr<compressor>, const char *>
  6950. create_compressor() {
  6951. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6952. return {detail::make_unique<brotli_compressor>(), "br"};
  6953. #elif defined(CPPHTTPLIB_ZLIB_SUPPORT)
  6954. return {detail::make_unique<gzip_compressor>(), "gzip"};
  6955. #elif defined(CPPHTTPLIB_ZSTD_SUPPORT)
  6956. return {detail::make_unique<zstd_compressor>(), "zstd"};
  6957. #else
  6958. return {nullptr, nullptr};
  6959. #endif
  6960. }
  6961. inline bool is_prohibited_header_name(const std::string &name) {
  6962. // Field names are case-insensitive (RFC 9110 §5.1)
  6963. return case_ignore::equal(name, "REMOTE_ADDR") ||
  6964. case_ignore::equal(name, "REMOTE_PORT") ||
  6965. case_ignore::equal(name, "LOCAL_ADDR") ||
  6966. case_ignore::equal(name, "LOCAL_PORT");
  6967. }
  6968. inline bool has_header(const Headers &headers, const std::string &key) {
  6969. if (is_prohibited_header_name(key)) { return false; }
  6970. return headers.find(key) != headers.end();
  6971. }
  6972. inline const char *get_header_value(const Headers &headers,
  6973. const std::string &key, const char *def,
  6974. size_t id) {
  6975. if (is_prohibited_header_name(key)) {
  6976. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  6977. std::string msg = "Prohibited header name '" + key + "' is specified.";
  6978. throw std::invalid_argument(msg);
  6979. #else
  6980. return "";
  6981. #endif
  6982. }
  6983. auto rng = headers.equal_range(key);
  6984. auto it = bounded_next(rng.first, id, rng.second);
  6985. if (it != rng.second) { return it->second.c_str(); }
  6986. return def;
  6987. }
  6988. inline size_t get_header_value_count(const Headers &headers,
  6989. const std::string &key) {
  6990. return headers.count(key);
  6991. }
  6992. // RFC 9110 Section 5.2 and 5.3: a field that is defined as a comma-separated
  6993. // list may be sent as several field lines, and the combined field value is
  6994. // those values joined by commas in the order they were received. Callers that
  6995. // parse such a list must work on the combined value; reading only the first
  6996. // occurrence silently drops whatever the later field lines carry.
  6997. inline std::string get_combined_header_value(const Headers &headers,
  6998. const std::string &key) {
  6999. std::string combined;
  7000. auto rng = headers.equal_range(key);
  7001. for (auto it = rng.first; it != rng.second; ++it) {
  7002. // RFC 9110 Section 5.6.1.2: a recipient has to parse and ignore empty list
  7003. // elements, so an empty field line must not contribute a bare comma to the
  7004. // combined value.
  7005. if (it->second.empty()) { continue; }
  7006. if (!combined.empty()) { combined += ", "; }
  7007. combined += it->second;
  7008. }
  7009. return combined;
  7010. }
  7011. inline bool has_header_token(const Headers &headers, const std::string &key,
  7012. const std::string &token) {
  7013. // RFC 9110 7.6.1: a comma-separated token list field such as Connection may
  7014. // carry several tokens, and RFC 9110 5.3 lets that list be split across
  7015. // several lines. Match complete tokens rather than searching the raw value,
  7016. // so that a value such as "notupgrade" is not read as the token "upgrade".
  7017. auto rng = headers.equal_range(key);
  7018. for (auto it = rng.first; it != rng.second; ++it) {
  7019. const auto &value = it->second;
  7020. if (split_find(value.data(), value.data() + value.size(), ',',
  7021. [&](const char *b, const char *e) {
  7022. return case_ignore::equal(std::string(b, e), token);
  7023. })) {
  7024. return true;
  7025. }
  7026. }
  7027. return false;
  7028. }
  7029. template <typename Map>
  7030. inline typename Map::mapped_type
  7031. get_multimap_value(const Map &m, const std::string &key, size_t id) {
  7032. auto rng = m.equal_range(key);
  7033. auto it = bounded_next(rng.first, id, rng.second);
  7034. if (it != rng.second) { return it->second; }
  7035. return typename Map::mapped_type();
  7036. }
  7037. inline void set_header(Headers &headers, const std::string &key,
  7038. const std::string &val) {
  7039. if (fields::is_field_valid(key, val)) { headers.emplace(key, val); }
  7040. }
  7041. inline bool read_headers(Stream &strm, Headers &headers) {
  7042. const auto bufsiz = 2048;
  7043. char buf[bufsiz];
  7044. stream_line_reader line_reader(strm, buf, bufsiz);
  7045. size_t header_count = 0;
  7046. for (;;) {
  7047. if (!line_reader.getline()) { return false; }
  7048. // Check if the line ends with CRLF.
  7049. auto line_terminator_len = 2;
  7050. if (line_reader.end_with_crlf()) {
  7051. // Blank line indicates end of headers.
  7052. if (line_reader.size() == 2) { break; }
  7053. } else {
  7054. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  7055. // Blank line indicates end of headers.
  7056. if (line_reader.size() == 1) { break; }
  7057. line_terminator_len = 1;
  7058. #else
  7059. continue; // Skip invalid line.
  7060. #endif
  7061. }
  7062. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  7063. // Check header count limit
  7064. if (header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  7065. // Exclude line terminator
  7066. auto end = line_reader.ptr() + line_reader.size() - line_terminator_len;
  7067. if (!parse_header(line_reader.ptr(), end,
  7068. [&](const std::string &key, const std::string &val) {
  7069. headers.emplace(key, val);
  7070. })) {
  7071. return false;
  7072. }
  7073. header_count++;
  7074. }
  7075. // RFC 9110 Section 8.6: Reject requests with multiple Content-Length
  7076. // headers that have different values to prevent request smuggling.
  7077. auto cl_range = headers.equal_range("Content-Length");
  7078. if (cl_range.first != cl_range.second) {
  7079. const auto &first_val = cl_range.first->second;
  7080. for (auto it = std::next(cl_range.first); it != cl_range.second; ++it) {
  7081. if (it->second != first_val) { return false; }
  7082. }
  7083. }
  7084. return true;
  7085. }
  7086. // Parsed by hand: std::regex_match recurses once per character of the reason
  7087. // phrase, which a server can make as long as a whole line.
  7088. inline bool parse_status_line(const char *line, std::string &version,
  7089. int &status, std::string &reason) {
  7090. if (std::strncmp(line, "HTTP/1.", 7) != 0 ||
  7091. (line[7] != '0' && line[7] != '1') || line[8] != ' ' ||
  7092. !is_ascii_digit(line[9]) || !is_ascii_digit(line[10]) ||
  7093. !is_ascii_digit(line[11])) {
  7094. return false;
  7095. }
  7096. auto p = line + 12;
  7097. auto reason_begin = p;
  7098. if (*p == ' ') {
  7099. reason_begin = ++p;
  7100. p += std::strcspn(p, "\r\n");
  7101. }
  7102. auto reason_end = p;
  7103. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  7104. if (*p == '\r') { p++; }
  7105. #else
  7106. if (*p++ != '\r') { return false; }
  7107. #endif
  7108. if (*p++ != '\n' || *p != '\0') { return false; }
  7109. version.assign(line, 8);
  7110. status = (line[9] - '0') * 100 + (line[10] - '0') * 10 + (line[11] - '0');
  7111. reason.assign(reason_begin, reason_end);
  7112. return true;
  7113. }
  7114. // Everything WebSocketClient::connect() reports about the upgrade exchange.
  7115. // status stays -1 until a status line is parsed, mirroring stream::Result.
  7116. struct WebSocketUpgradeResponse {
  7117. Error error = Error::Success;
  7118. int status = -1;
  7119. Headers headers;
  7120. std::string selected_subprotocol;
  7121. };
  7122. // Reads a response's status line and headers, leaving any body unread. An
  7123. // unparsable status line is no stream error; it just leaves `status` as is.
  7124. inline bool read_response_head(Stream &strm, int &status, Headers &headers) {
  7125. const auto bufsiz = 2048;
  7126. char buf[bufsiz];
  7127. stream_line_reader line_reader(strm, buf, bufsiz);
  7128. if (!line_reader.getline()) { return false; }
  7129. std::string version;
  7130. std::string reason;
  7131. if (!parse_status_line(line_reader.ptr(), version, status, reason)) {
  7132. return true;
  7133. }
  7134. return read_headers(strm, headers);
  7135. }
  7136. inline bool
  7137. read_websocket_upgrade_response(Stream &strm,
  7138. const std::string &expected_accept,
  7139. const std::string &offered_subprotocols,
  7140. WebSocketUpgradeResponse &upgrade) {
  7141. // The headers of a rejection are kept so the caller can see why the server
  7142. // refused the upgrade.
  7143. if (!read_response_head(strm, upgrade.status, upgrade.headers)) {
  7144. upgrade.error = Error::Read;
  7145. return false;
  7146. }
  7147. const auto &headers = upgrade.headers;
  7148. if (upgrade.status != StatusCode::SwitchingProtocol_101) {
  7149. upgrade.error = Error::WebSocketHandshake;
  7150. return false;
  7151. }
  7152. // Verify Upgrade: websocket (a comma-separated list, matched per token)
  7153. if (!has_header_token(headers, "Upgrade", "websocket")) {
  7154. upgrade.error = Error::WebSocketHandshake;
  7155. return false;
  7156. }
  7157. // Verify Connection: Upgrade
  7158. if (!has_header_token(headers, "Connection", "upgrade")) {
  7159. upgrade.error = Error::WebSocketHandshake;
  7160. return false;
  7161. }
  7162. // Verify Sec-WebSocket-Accept header value
  7163. auto it = headers.find("Sec-WebSocket-Accept");
  7164. if (it == headers.end() || it->second != expected_accept) {
  7165. upgrade.error = Error::WebSocketHandshake;
  7166. return false;
  7167. }
  7168. // Extract negotiated subprotocol
  7169. auto proto_it = headers.find("Sec-WebSocket-Protocol");
  7170. if (proto_it != headers.end()) {
  7171. upgrade.selected_subprotocol = proto_it->second;
  7172. }
  7173. // Verify the subprotocol is one the client offered (RFC 6455 4.1)
  7174. if (!upgrade.selected_subprotocol.empty()) {
  7175. auto was_offered = false;
  7176. split(offered_subprotocols.data(),
  7177. offered_subprotocols.data() + offered_subprotocols.size(), ',',
  7178. [&](const char *b, const char *e) {
  7179. if (std::string(b, e) == upgrade.selected_subprotocol) {
  7180. was_offered = true;
  7181. }
  7182. });
  7183. if (!was_offered) {
  7184. upgrade.error = Error::WebSocketHandshake;
  7185. return false;
  7186. }
  7187. }
  7188. return true;
  7189. }
  7190. enum class ReadContentResult {
  7191. Success, // Successfully read the content
  7192. PayloadTooLarge, // The content exceeds the specified payload limit
  7193. Error // An error occurred while reading the content
  7194. };
  7195. inline ReadContentResult read_content_with_length(
  7196. Stream &strm, size_t len, DownloadProgress progress,
  7197. ContentReceiverWithProgress out,
  7198. size_t payload_max_length = (std::numeric_limits<size_t>::max)()) {
  7199. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7200. detail::BodyReader br;
  7201. br.stream = &strm;
  7202. br.has_content_length = true;
  7203. br.content_length = len;
  7204. br.payload_max_length = payload_max_length;
  7205. br.chunked = false;
  7206. br.bytes_read = 0;
  7207. br.last_error = Error::Success;
  7208. size_t r = 0;
  7209. while (r < len) {
  7210. auto read_len = static_cast<size_t>(len - r);
  7211. auto to_read = (std::min)(read_len, CPPHTTPLIB_RECV_BUFSIZ);
  7212. auto n = detail::read_body_content(&strm, br, buf, to_read);
  7213. if (n <= 0) {
  7214. // Check if it was a payload size error
  7215. if (br.last_error == Error::ExceedMaxPayloadSize) {
  7216. return ReadContentResult::PayloadTooLarge;
  7217. }
  7218. return ReadContentResult::Error;
  7219. }
  7220. if (!out(buf, static_cast<size_t>(n), r, len)) {
  7221. return ReadContentResult::Error;
  7222. }
  7223. r += static_cast<size_t>(n);
  7224. if (progress) {
  7225. if (!progress(r, len)) { return ReadContentResult::Error; }
  7226. }
  7227. }
  7228. return ReadContentResult::Success;
  7229. }
  7230. inline ReadContentResult
  7231. read_content_without_length(Stream &strm, size_t payload_max_length,
  7232. ContentReceiverWithProgress out) {
  7233. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7234. size_t r = 0;
  7235. for (;;) {
  7236. auto n = strm.read(buf, CPPHTTPLIB_RECV_BUFSIZ);
  7237. if (n == 0) { return ReadContentResult::Success; }
  7238. if (n < 0) { return ReadContentResult::Error; }
  7239. // Check if adding this data would exceed the payload limit
  7240. if (payload_max_length > 0 &&
  7241. (r > payload_max_length ||
  7242. payload_max_length - r < static_cast<size_t>(n))) {
  7243. return ReadContentResult::PayloadTooLarge;
  7244. }
  7245. if (!out(buf, static_cast<size_t>(n), r, 0)) {
  7246. return ReadContentResult::Error;
  7247. }
  7248. r += static_cast<size_t>(n);
  7249. }
  7250. return ReadContentResult::Success;
  7251. }
  7252. template <typename T>
  7253. inline ReadContentResult read_content_chunked(Stream &strm, T &x,
  7254. size_t payload_max_length,
  7255. ContentReceiverWithProgress out) {
  7256. detail::ChunkedDecoder dec(strm);
  7257. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7258. size_t total_len = 0;
  7259. for (;;) {
  7260. size_t chunk_offset = 0;
  7261. size_t chunk_total = 0;
  7262. auto n = dec.read_payload(buf, sizeof(buf), chunk_offset, chunk_total);
  7263. if (n < 0) { return ReadContentResult::Error; }
  7264. if (n == 0) {
  7265. if (!dec.parse_trailers_into(x.trailers, x.headers)) {
  7266. return ReadContentResult::Error;
  7267. }
  7268. return ReadContentResult::Success;
  7269. }
  7270. if (payload_max_length > 0 &&
  7271. (total_len > payload_max_length ||
  7272. payload_max_length - total_len < static_cast<size_t>(n))) {
  7273. return ReadContentResult::PayloadTooLarge;
  7274. }
  7275. if (!out(buf, static_cast<size_t>(n), chunk_offset, chunk_total)) {
  7276. return ReadContentResult::Error;
  7277. }
  7278. total_len += static_cast<size_t>(n);
  7279. }
  7280. }
  7281. inline bool is_chunked_transfer_encoding(const Headers &headers) {
  7282. // RFC 9112 6.1: a message is framed with the chunked coding when "chunked"
  7283. // is the final transfer coding. A single field value may list several
  7284. // codings ("gzip, chunked"), and RFC 9110 5.3 lets that list be split across
  7285. // several Transfer-Encoding lines, which combine into one comma-separated
  7286. // list in the order the lines were received. Headers preserves that order,
  7287. // so the final coding is the last token of the last line. Match it
  7288. // case-insensitively rather than comparing the whole value against
  7289. // "chunked".
  7290. //
  7291. // Security: reading a chunked message as unframed leaves its body in the
  7292. // socket, where a keep-alive connection parses it as a smuggled request.
  7293. // Server::process_request() answers 400 and closes when the final coding is
  7294. // not chunked, so a request whose framing cannot be determined never
  7295. // reaches the "no body" path.
  7296. auto rng = headers.equal_range("Transfer-Encoding");
  7297. if (rng.first == rng.second) { return false; }
  7298. // Cleared per line, so a trailing line carrying no coding at all leaves the
  7299. // combined list ending in nothing rather than inheriting the line before it.
  7300. std::string last_coding;
  7301. for (auto it = rng.first; it != rng.second; ++it) {
  7302. const auto &value = it->second;
  7303. last_coding.clear();
  7304. split(value.data(), value.data() + value.size(), ',',
  7305. [&](const char *b, const char *e) { last_coding.assign(b, e); });
  7306. }
  7307. return case_ignore::equal(last_coding, "chunked");
  7308. }
  7309. // RFC 9112 6.1: a message framed by Transfer-Encoding next to a Content-Length,
  7310. // or in HTTP/1.0, leaves the connection unfit to carry another one.
  7311. template <typename T> inline bool has_faulty_transfer_encoding(const T &msg) {
  7312. return msg.has_header("Transfer-Encoding") &&
  7313. (msg.has_header("Content-Length") || msg.version == "HTTP/1.0");
  7314. }
  7315. inline bool has_conflicting_content_length(const Headers &headers) {
  7316. // RFC 9112 §6.3: a message carrying both Transfer-Encoding and a non-zero
  7317. // Content-Length is framed ambiguously. The body readers here delimit it by
  7318. // the transfer coding and drop Content-Length, while an intermediary may do
  7319. // the reverse, so the two disagree on where the body ends and a reused
  7320. // connection is desynchronised (request/response smuggling). Content-Length:
  7321. // 0 is tolerated for compatibility with existing peers.
  7322. return has_header(headers, "Transfer-Encoding") &&
  7323. get_header_value_u64(headers, "Content-Length", 0, 0) > 0;
  7324. }
  7325. template <typename T, typename U>
  7326. bool prepare_content_receiver(T &x, int &status,
  7327. ContentReceiverWithProgress receiver,
  7328. bool decompress, size_t payload_max_length,
  7329. bool &exceed_payload_max_length, U callback) {
  7330. if (decompress) {
  7331. auto encoding = get_combined_header_value(x.headers, "Content-Encoding");
  7332. std::unique_ptr<decompressor> decompressor;
  7333. if (!encoding.empty()) {
  7334. // A coding we know about but were not built with is an error. An
  7335. // unrecognized coding (including "identity") is left alone and the
  7336. // payload is passed through as-is, since some servers misuse the header,
  7337. // e.g. by sending a character set such as "Content-Encoding: UTF-8".
  7338. decompressor = detail::create_decompressor(encoding);
  7339. if (!decompressor && detail::is_known_content_encoding(encoding)) {
  7340. status = StatusCode::UnsupportedMediaType_415;
  7341. return false;
  7342. }
  7343. }
  7344. if (decompressor) {
  7345. if (decompressor->is_valid()) {
  7346. size_t decompressed_size = 0;
  7347. ContentReceiverWithProgress out = [&](const char *buf, size_t n,
  7348. size_t off, size_t len) {
  7349. return decompressor->decompress(
  7350. buf, n, [&](const char *buf2, size_t n2) {
  7351. // Guard against zip-bomb: check
  7352. // decompressed size against limit.
  7353. if (payload_max_length > 0 &&
  7354. (decompressed_size >= payload_max_length ||
  7355. n2 > payload_max_length - decompressed_size)) {
  7356. exceed_payload_max_length = true;
  7357. return false;
  7358. }
  7359. decompressed_size += n2;
  7360. return receiver(buf2, n2, off, len);
  7361. });
  7362. };
  7363. return callback(std::move(out));
  7364. } else {
  7365. status = StatusCode::InternalServerError_500;
  7366. return false;
  7367. }
  7368. }
  7369. }
  7370. ContentReceiverWithProgress out = [&](const char *buf, size_t n, size_t off,
  7371. size_t len) {
  7372. return receiver(buf, n, off, len);
  7373. };
  7374. return callback(std::move(out));
  7375. }
  7376. template <typename T>
  7377. bool read_content(Stream &strm, T &x, size_t payload_max_length, int &status,
  7378. DownloadProgress progress,
  7379. ContentReceiverWithProgress receiver, bool decompress) {
  7380. bool exceed_payload_max_length = false;
  7381. return prepare_content_receiver(
  7382. x, status, std::move(receiver), decompress, payload_max_length,
  7383. exceed_payload_max_length, [&](const ContentReceiverWithProgress &out) {
  7384. auto ret = true;
  7385. // Note: exceed_payload_max_length may also be set by the decompressor
  7386. // wrapper in prepare_content_receiver when the decompressed payload
  7387. // size exceeds the limit.
  7388. if (is_chunked_transfer_encoding(x.headers)) {
  7389. auto result = read_content_chunked(strm, x, payload_max_length, out);
  7390. if (result == ReadContentResult::Success) {
  7391. ret = true;
  7392. } else if (result == ReadContentResult::PayloadTooLarge) {
  7393. exceed_payload_max_length = true;
  7394. ret = false;
  7395. } else {
  7396. ret = false;
  7397. }
  7398. } else if (!has_header(x.headers, "Content-Length")) {
  7399. auto result =
  7400. read_content_without_length(strm, payload_max_length, out);
  7401. if (result == ReadContentResult::Success) {
  7402. ret = true;
  7403. } else if (result == ReadContentResult::PayloadTooLarge) {
  7404. exceed_payload_max_length = true;
  7405. ret = false;
  7406. } else {
  7407. ret = false;
  7408. }
  7409. } else {
  7410. auto is_invalid_value = false;
  7411. auto len = get_header_value_u64(x.headers, "Content-Length",
  7412. (std::numeric_limits<size_t>::max)(),
  7413. 0, is_invalid_value);
  7414. if (is_invalid_value) {
  7415. ret = false;
  7416. } else if (len > 0) {
  7417. auto result = read_content_with_length(
  7418. strm, len, std::move(progress), out, payload_max_length);
  7419. ret = (result == ReadContentResult::Success);
  7420. if (result == ReadContentResult::PayloadTooLarge) {
  7421. exceed_payload_max_length = true;
  7422. }
  7423. }
  7424. }
  7425. if (!ret) {
  7426. status = exceed_payload_max_length ? StatusCode::PayloadTooLarge_413
  7427. : StatusCode::BadRequest_400;
  7428. }
  7429. return ret;
  7430. });
  7431. }
  7432. inline ssize_t write_request_line(Stream &strm, const std::string &method,
  7433. const std::string &path) {
  7434. // Neither the method nor the request target may carry CR/LF, SP or other
  7435. // control octets; otherwise a value smuggled into either splits the request
  7436. // line and injects headers or a whole request.
  7437. if (!fields::is_token(method)) { return -1; }
  7438. if (!fields::is_request_target(path)) { return -1; }
  7439. std::string s = method;
  7440. s += ' ';
  7441. s += path;
  7442. s += " HTTP/1.1\r\n";
  7443. return strm.write(s.data(), s.size());
  7444. }
  7445. inline ssize_t write_response_line(Stream &strm, int status) {
  7446. std::string s = "HTTP/1.1 ";
  7447. s += std::to_string(status);
  7448. s += ' ';
  7449. s += httplib::status_message(status);
  7450. s += "\r\n";
  7451. return strm.write(s.data(), s.size());
  7452. }
  7453. inline ssize_t write_headers(Stream &strm, const Headers &headers) {
  7454. ssize_t write_len = 0;
  7455. for (const auto &x : headers) {
  7456. // Skip fields with invalid names or values to prevent response splitting
  7457. // via CR/LF injection, matching set_header(). The client validates request
  7458. // headers up front in check_and_write_headers, but the server passes
  7459. // res.headers straight to this writer, and res.headers is a public field
  7460. // an application can populate directly with request-derived values.
  7461. if (!fields::is_field_valid(x.first, x.second)) { continue; }
  7462. std::string s;
  7463. s = x.first;
  7464. s += ": ";
  7465. s += x.second;
  7466. s += "\r\n";
  7467. auto len = strm.write(s.data(), s.size());
  7468. if (len < 0) { return len; }
  7469. write_len += len;
  7470. }
  7471. auto len = strm.write("\r\n");
  7472. if (len < 0) { return len; }
  7473. write_len += len;
  7474. return write_len;
  7475. }
  7476. inline bool write_data(Stream &strm, const char *d, size_t l) {
  7477. size_t offset = 0;
  7478. while (offset < l) {
  7479. auto length = strm.write(d + offset, l - offset);
  7480. if (length < 0) { return false; }
  7481. offset += static_cast<size_t>(length);
  7482. }
  7483. return true;
  7484. }
  7485. template <typename T>
  7486. inline bool write_content_with_progress(Stream &strm,
  7487. const ContentProvider &content_provider,
  7488. size_t offset, size_t length,
  7489. T is_shutting_down,
  7490. const UploadProgress &upload_progress,
  7491. Error &error) {
  7492. size_t end_offset = offset + length;
  7493. size_t start_offset = offset;
  7494. auto ok = true;
  7495. auto finished = false;
  7496. DataSink data_sink;
  7497. data_sink.write = [&](const char *d, size_t l) -> bool {
  7498. if (ok) {
  7499. // Bytes past `length` would follow the framed body, where the peer reads
  7500. // them as the next message. Write only what fits and fail the rest.
  7501. if (l > end_offset - offset) {
  7502. l = end_offset - offset;
  7503. ok = false;
  7504. }
  7505. if (write_data(strm, d, l)) {
  7506. offset += l;
  7507. if (upload_progress && length > 0) {
  7508. size_t current_written = offset - start_offset;
  7509. if (!upload_progress(current_written, length)) {
  7510. ok = false;
  7511. return false;
  7512. }
  7513. }
  7514. } else {
  7515. ok = false;
  7516. }
  7517. }
  7518. return ok;
  7519. };
  7520. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7521. // The body is framed by `length`, so a provider that reports itself done
  7522. // early has truncated it. Record that and let the short-body check below
  7523. // fail the write, rather than calling the provider again forever.
  7524. data_sink.done = [&]() { finished = true; };
  7525. while (offset < end_offset && !finished && !is_shutting_down()) {
  7526. auto last_offset = offset;
  7527. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7528. error = Error::Write;
  7529. return false;
  7530. } else if (!content_provider(offset, end_offset - offset, data_sink)) {
  7531. error = Error::Canceled;
  7532. return false;
  7533. } else if (!ok) {
  7534. error = Error::Write;
  7535. return false;
  7536. }
  7537. // A provider that reports success without writing anything and without
  7538. // reporting itself done gets handed the same offset and length again on
  7539. // the next pass, so it would spin here for as long as the peer stays
  7540. // connected. Treat making no progress as a short body, like done() early.
  7541. if (!finished && offset == last_offset) {
  7542. error = Error::Write;
  7543. return false;
  7544. }
  7545. }
  7546. if (offset < end_offset) { // done() called early, or is_shutting_down()
  7547. error = Error::Write;
  7548. return false;
  7549. }
  7550. error = Error::Success;
  7551. return true;
  7552. }
  7553. template <typename T>
  7554. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7555. size_t offset, size_t length, T is_shutting_down,
  7556. Error &error) {
  7557. return write_content_with_progress<T>(strm, content_provider, offset, length,
  7558. is_shutting_down, nullptr, error);
  7559. }
  7560. template <typename T>
  7561. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7562. size_t offset, size_t length,
  7563. const T &is_shutting_down) {
  7564. auto error = Error::Success;
  7565. return write_content(strm, content_provider, offset, length, is_shutting_down,
  7566. error);
  7567. }
  7568. template <typename T>
  7569. inline bool
  7570. write_content_without_length(Stream &strm,
  7571. const ContentProvider &content_provider,
  7572. const T &is_shutting_down) {
  7573. size_t offset = 0;
  7574. auto data_available = true;
  7575. auto ok = true;
  7576. DataSink data_sink;
  7577. data_sink.write = [&](const char *d, size_t l) -> bool {
  7578. if (ok) {
  7579. offset += l;
  7580. if (!write_data(strm, d, l)) { ok = false; }
  7581. }
  7582. return ok;
  7583. };
  7584. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7585. data_sink.done = [&](void) { data_available = false; };
  7586. while (data_available && !is_shutting_down()) {
  7587. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7588. return false;
  7589. } else if (!content_provider(offset, 0, data_sink)) {
  7590. return false;
  7591. } else if (!ok) {
  7592. return false;
  7593. }
  7594. }
  7595. return !data_available; // true only if done() was called, false if shutting
  7596. // down
  7597. }
  7598. // Runs a known-length content provider to completion and compresses what it
  7599. // writes into `out`, chunk by chunk, without holding the identity form.
  7600. inline bool compress_content_provider(const ContentProvider &content_provider,
  7601. size_t length, compressor &cmp,
  7602. std::string &out) {
  7603. size_t offset = 0;
  7604. auto ok = true;
  7605. auto finished = false;
  7606. DataSink data_sink;
  7607. auto append = [&](const char *data, size_t data_len) {
  7608. out.append(data, data_len);
  7609. return true;
  7610. };
  7611. data_sink.write = [&](const char *d, size_t l) -> bool {
  7612. if (!ok) { return false; }
  7613. offset += l;
  7614. if (l > 0 && !cmp.compress(d, l, false, append)) { ok = false; }
  7615. return ok;
  7616. };
  7617. // The body is framed by `length`, so a provider that reports itself done
  7618. // early has truncated it; the short-body check below turns that into a
  7619. // failure rather than calling the provider again forever.
  7620. data_sink.done = [&]() { finished = true; };
  7621. while (offset < length && !finished) {
  7622. auto prev_offset = offset;
  7623. if (!content_provider(offset, length - offset, data_sink) || !ok) {
  7624. return false;
  7625. }
  7626. // No Stream to block on here, so a provider that keeps returning true
  7627. // without writing would spin. Treat a pass that made no progress as a
  7628. // failure.
  7629. if (offset == prev_offset) { return false; }
  7630. }
  7631. if (offset != length) { return false; }
  7632. return cmp.compress(nullptr, 0, true, append);
  7633. }
  7634. // Serves `m` as the response body. `set_content_provider()` clears the coding
  7635. // and the file flag, so recording them has to come after; keeping all of it
  7636. // here means a third file-serving path cannot get that order wrong.
  7637. inline void set_file_content_provider(Response &res,
  7638. const std::shared_ptr<mmap> &m,
  7639. const std::string &content_type,
  7640. EncodingType encoding) {
  7641. // One read and one write move up to this much of the file at a time.
  7642. auto buf = std::make_shared<std::vector<char>>(
  7643. (std::min)(m->size(), size_t(256 * 1024)));
  7644. res.set_content_provider(
  7645. m->size(), content_type,
  7646. [m, buf](size_t offset, size_t length, DataSink &sink) -> bool {
  7647. // Never read past the file, which ends the response early if it has
  7648. // shrunk since it was opened.
  7649. auto n = m->read(offset, buf->data(), (std::min)(length, buf->size()));
  7650. if (n == 0) { return false; }
  7651. sink.write(buf->data(), n);
  7652. return true;
  7653. });
  7654. res.is_file_content_provider_ = true;
  7655. res.content_coding_ = encoding;
  7656. }
  7657. template <typename T, typename U>
  7658. inline bool
  7659. write_content_chunked(Stream &strm, const ContentProvider &content_provider,
  7660. const T &is_shutting_down, U &compressor, Error &error) {
  7661. size_t offset = 0;
  7662. auto data_available = true;
  7663. auto ok = true;
  7664. DataSink data_sink;
  7665. data_sink.write = [&](const char *d, size_t l) -> bool {
  7666. // Only done()/done_with_trailer() end a chunked body. A pass with nothing
  7667. // to hand over is ordinary (an empty buffer popped off a queue), and a
  7668. // zero-length chunk is the terminator, so it must not be emitted here.
  7669. if (ok && l > 0) {
  7670. offset += l;
  7671. std::string payload;
  7672. if (compressor.compress(d, l, false,
  7673. [&](const char *data, size_t data_len) {
  7674. payload.append(data, data_len);
  7675. return true;
  7676. })) {
  7677. if (!payload.empty()) {
  7678. // Emit chunked response header and footer for each chunk
  7679. auto chunk =
  7680. from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7681. if (!write_data(strm, chunk.data(), chunk.size())) { ok = false; }
  7682. }
  7683. } else {
  7684. ok = false;
  7685. }
  7686. }
  7687. return ok;
  7688. };
  7689. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7690. auto done_with_trailer = [&](const Headers *trailer) {
  7691. if (!ok) { return; }
  7692. data_available = false;
  7693. std::string payload;
  7694. if (!compressor.compress(nullptr, 0, true,
  7695. [&](const char *data, size_t data_len) {
  7696. payload.append(data, data_len);
  7697. return true;
  7698. })) {
  7699. ok = false;
  7700. return;
  7701. }
  7702. if (!payload.empty()) {
  7703. // Emit chunked response header and footer for each chunk
  7704. auto chunk = from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7705. if (!write_data(strm, chunk.data(), chunk.size())) {
  7706. ok = false;
  7707. return;
  7708. }
  7709. }
  7710. constexpr const char done_marker[] = "0\r\n";
  7711. if (!write_data(strm, done_marker, str_len(done_marker))) { ok = false; }
  7712. // Trailer
  7713. if (trailer) {
  7714. for (const auto &kv : *trailer) {
  7715. // Skip fields with invalid names or values to prevent response
  7716. // splitting via CR/LF injection, matching set_header().
  7717. if (!fields::is_field_valid(kv.first, kv.second)) { continue; }
  7718. std::string field_line = kv.first + ": " + kv.second + "\r\n";
  7719. if (!write_data(strm, field_line.data(), field_line.size())) {
  7720. ok = false;
  7721. }
  7722. }
  7723. }
  7724. constexpr const char crlf[] = "\r\n";
  7725. if (!write_data(strm, crlf, str_len(crlf))) { ok = false; }
  7726. };
  7727. data_sink.done = [&](void) { done_with_trailer(nullptr); };
  7728. data_sink.done_with_trailer = [&](const Headers &trailer) {
  7729. done_with_trailer(&trailer);
  7730. };
  7731. while (data_available && !is_shutting_down()) {
  7732. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7733. error = Error::Write;
  7734. return false;
  7735. } else if (!content_provider(offset, 0, data_sink)) {
  7736. error = Error::Canceled;
  7737. return false;
  7738. } else if (!ok) {
  7739. error = Error::Write;
  7740. return false;
  7741. }
  7742. }
  7743. if (data_available) { // exited due to is_shutting_down(), not done()
  7744. error = Error::Write;
  7745. return false;
  7746. }
  7747. error = Error::Success;
  7748. return true;
  7749. }
  7750. template <typename T, typename U>
  7751. inline bool write_content_chunked(Stream &strm,
  7752. const ContentProvider &content_provider,
  7753. const T &is_shutting_down, U &compressor) {
  7754. auto error = Error::Success;
  7755. return write_content_chunked(strm, content_provider, is_shutting_down,
  7756. compressor, error);
  7757. }
  7758. template <typename T>
  7759. inline bool redirect(T &cli, Request &req, Response &res,
  7760. const std::string &path, const std::string &location,
  7761. Error &error) {
  7762. Request new_req = req;
  7763. new_req.path = path;
  7764. new_req.redirect_count_ -= 1;
  7765. if (res.status == StatusCode::SeeOther_303 &&
  7766. (req.method != "GET" && req.method != "HEAD")) {
  7767. new_req.method = "GET";
  7768. new_req.body.clear();
  7769. new_req.headers.clear();
  7770. new_req.content_length_ = 0;
  7771. new_req.content_provider_ = nullptr;
  7772. new_req.is_chunked_content_provider_ = false;
  7773. }
  7774. Response new_res;
  7775. auto ret = cli.send(new_req, new_res, error);
  7776. if (ret) {
  7777. req = std::move(new_req);
  7778. res = std::move(new_res);
  7779. if (res.location.empty()) { res.location = location; }
  7780. }
  7781. return ret;
  7782. }
  7783. inline std::string params_to_query_str(const Params &params) {
  7784. std::string query;
  7785. for (auto it = params.begin(); it != params.end(); ++it) {
  7786. if (it != params.begin()) { query += '&'; }
  7787. query += encode_query_component(it->first);
  7788. query += '=';
  7789. query += encode_query_component(it->second);
  7790. }
  7791. return query;
  7792. }
  7793. // Splits one "key=value" span of a query string at its first '='. A span with
  7794. // no '=' at all lands entirely in key, leaving val empty, which is how a bare
  7795. // "?flag" keeps its name.
  7796. inline void divide_query_pair(const char *b, const char *e, std::string &key,
  7797. std::string &val) {
  7798. divide(b, static_cast<std::size_t>(e - b), '=',
  7799. [&](const char *lhs_data, std::size_t lhs_size, const char *rhs_data,
  7800. std::size_t rhs_size) {
  7801. key.assign(lhs_data, lhs_size);
  7802. val.assign(rhs_data, rhs_size);
  7803. });
  7804. }
  7805. inline void parse_query_text(const char *data, std::size_t size,
  7806. Params &params) {
  7807. std::set<std::string> cache;
  7808. split(data, data + size, '&', [&](const char *b, const char *e) {
  7809. std::string kv(b, e);
  7810. if (cache.find(kv) != cache.end()) { return; }
  7811. cache.insert(std::move(kv));
  7812. std::string key;
  7813. std::string val;
  7814. divide_query_pair(b, e, key, val);
  7815. if (!key.empty()) {
  7816. params.emplace(decode_query_component(key), decode_query_component(val));
  7817. }
  7818. });
  7819. }
  7820. inline void parse_query_text(const std::string &s, Params &params) {
  7821. parse_query_text(s.data(), s.size(), params);
  7822. }
  7823. // Normalize a query string by decoding and re-encoding each key/value pair
  7824. // while preserving the original parameter order. This avoids double-encoding
  7825. // and ensures consistent encoding. It works on the raw string rather than
  7826. // parsing into Params and re-serializing, because that round trip cannot
  7827. // reproduce the input: params_to_query_str() always emits '=', so a bare
  7828. // "flag" would come back as "flag=", and parse_query_text() drops exactly
  7829. // duplicated pairs.
  7830. inline std::string normalize_query_string(const std::string &query) {
  7831. std::string result;
  7832. split(query.data(), query.data() + query.size(), '&',
  7833. [&](const char *b, const char *e) {
  7834. std::string key;
  7835. std::string val;
  7836. divide_query_pair(b, e, key, val);
  7837. if (!key.empty()) {
  7838. auto dec_key = decode_query_component(key);
  7839. auto dec_val = decode_query_component(val);
  7840. if (!result.empty()) { result += '&'; }
  7841. result += encode_query_component(dec_key);
  7842. if (!val.empty() || std::find(b, e, '=') != e) {
  7843. result += '=';
  7844. result += encode_query_component(dec_val);
  7845. }
  7846. }
  7847. });
  7848. return result;
  7849. }
  7850. // The query of a client's path: what follows '?', up to the fragment.
  7851. inline std::string query_of(const std::string &path) {
  7852. auto fragment_pos = path.find('#');
  7853. auto query_pos = path.find('?');
  7854. return query_pos < fragment_pos
  7855. ? path.substr(query_pos + 1, fragment_pos - query_pos - 1)
  7856. : std::string();
  7857. }
  7858. // Build the request target that goes on the wire from a caller-supplied path.
  7859. // Shared by the buffered send path and the streaming API so that both put the
  7860. // same bytes in the request line for the same input.
  7861. inline std::string encode_request_target(const std::string &uri,
  7862. bool path_encode) {
  7863. // The fragment stays with the client (RFC 9110 §7.1).
  7864. auto target = uri.substr(0, uri.find('#'));
  7865. // `substr(0, npos)` yields the whole string, which is what the no-query
  7866. // case needs.
  7867. auto query_pos = target.find('?');
  7868. auto path_part = target.substr(0, query_pos);
  7869. std::string query_part;
  7870. if (query_pos != std::string::npos) {
  7871. query_part = target.substr(query_pos + 1);
  7872. }
  7873. auto result = path_encode ? encode_path(path_part) : std::move(path_part);
  7874. if (!query_part.empty()) {
  7875. // When path encoding is disabled the caller has supplied an already-encoded
  7876. // target and expects the exact bytes to be sent on the wire, so skip
  7877. // normalization for the query too. Normalizing would decode-then-re-encode
  7878. // it and corrupt pre-encoded binary payloads (e.g. turning `%20` into `+`,
  7879. // which a strict RFC 3986 server decodes back as `+`, not a space).
  7880. if (path_encode) {
  7881. auto normalized = normalize_query_string(query_part);
  7882. if (!normalized.empty()) {
  7883. result += '?';
  7884. result += normalized;
  7885. }
  7886. } else {
  7887. result += '?';
  7888. result += query_part;
  7889. }
  7890. }
  7891. return result;
  7892. }
  7893. inline bool parse_multipart_boundary(const std::string &content_type,
  7894. std::string &boundary) {
  7895. std::map<std::string, std::string> params;
  7896. extract_media_type(content_type, &params);
  7897. auto it = params.find("boundary");
  7898. if (it == params.end()) { return false; }
  7899. boundary = it->second;
  7900. // RFC 2046 5.1.1 caps a boundary at 70 characters. The parser scans the body
  7901. // for "--" + boundary, so a body crafted to repeat that delimiter's leading
  7902. // bytes costs a nearly full comparison at nearly every position: the
  7903. // boundary's length multiplies the worst-case cost of scanning a body.
  7904. return !boundary.empty() && boundary.size() <= 70;
  7905. }
  7906. inline void parse_disposition_params(const std::string &s, Params &params) {
  7907. std::set<std::string> cache;
  7908. split_unquoted(
  7909. s.data(), s.data() + s.size(), ';', [&](const char *b, const char *e) {
  7910. std::string kv(b, e);
  7911. if (cache.find(kv) != cache.end()) { return; }
  7912. cache.insert(kv);
  7913. std::string key;
  7914. std::string val;
  7915. divide_param_pair(b, e, key, val);
  7916. if (!key.empty()) {
  7917. params.emplace(trim_double_quotes_copy(key), unquote_param(val));
  7918. }
  7919. });
  7920. }
  7921. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7922. inline bool parse_range_header(const std::string &s, Ranges &ranges) {
  7923. #else
  7924. inline bool parse_range_header(const std::string &s, Ranges &ranges) try {
  7925. #endif
  7926. auto is_valid = [](const std::string &str) {
  7927. return std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  7928. };
  7929. if (s.size() > 7 && case_ignore::equal(s.substr(0, 6), "bytes=")) {
  7930. const auto pos = static_cast<size_t>(6);
  7931. const auto len = static_cast<size_t>(s.size() - 6);
  7932. auto all_valid_ranges = true;
  7933. split(&s[pos], &s[pos + len], ',', [&](const char *b, const char *e) {
  7934. if (!all_valid_ranges) { return; }
  7935. const auto it = std::find(b, e, '-');
  7936. if (it == e) {
  7937. all_valid_ranges = false;
  7938. return;
  7939. }
  7940. const auto lhs = std::string(b, it);
  7941. const auto rhs = std::string(it + 1, e);
  7942. if (!is_valid(lhs) || !is_valid(rhs)) {
  7943. all_valid_ranges = false;
  7944. return;
  7945. }
  7946. ssize_t first = -1;
  7947. if (!lhs.empty()) {
  7948. // Reject an overflowing first-byte-pos; treating it as absent (-1)
  7949. // would turn the range into a suffix range.
  7950. auto res =
  7951. detail::from_chars(lhs.data(), lhs.data() + lhs.size(), first);
  7952. if (res.ec != std::errc{}) {
  7953. all_valid_ranges = false;
  7954. return;
  7955. }
  7956. }
  7957. ssize_t last = -1;
  7958. if (!rhs.empty()) {
  7959. // An overflowing last-byte-pos is past any content length, so keeping
  7960. // -1 ("remainder", RFC 9110 14.1.2) is correct here.
  7961. ssize_t v;
  7962. auto res = detail::from_chars(rhs.data(), rhs.data() + rhs.size(), v);
  7963. if (res.ec == std::errc{}) { last = v; }
  7964. }
  7965. if ((first == -1 && last == -1) ||
  7966. (first != -1 && last != -1 && first > last)) {
  7967. all_valid_ranges = false;
  7968. return;
  7969. }
  7970. ranges.emplace_back(first, last);
  7971. });
  7972. return all_valid_ranges && !ranges.empty();
  7973. }
  7974. return false;
  7975. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7976. }
  7977. #else
  7978. } catch (...) { return false; }
  7979. #endif
  7980. // Removes each quoted-string, honoring a quoted-pair (RFC 9110 Section 5.6.4)
  7981. inline std::string remove_quoted_strings(const std::string &s) {
  7982. std::string out;
  7983. auto in_quotes = false;
  7984. for (size_t i = 0; i < s.size(); i++) {
  7985. if (s[i] == '"') {
  7986. in_quotes = !in_quotes;
  7987. } else if (!in_quotes) {
  7988. out += s[i];
  7989. } else if (s[i] == '\\') {
  7990. i++;
  7991. }
  7992. }
  7993. return out;
  7994. }
  7995. inline bool parse_accept_header(const std::string &s,
  7996. std::vector<std::string> &content_types) {
  7997. // Parameter values are not used here, so a quoted-string is dropped rather
  7998. // than parsed: a ',' or ';' inside one must not be read as a delimiter.
  7999. if (s.find('"') != std::string::npos) {
  8000. return parse_accept_header(remove_quoted_strings(s), content_types);
  8001. }
  8002. content_types.clear();
  8003. // Empty string is considered valid (no preference)
  8004. if (s.empty()) { return true; }
  8005. struct AcceptEntry {
  8006. std::string media_type;
  8007. double quality;
  8008. int order;
  8009. };
  8010. std::vector<AcceptEntry> entries;
  8011. int order = 0;
  8012. bool has_invalid_entry = false;
  8013. // Split by comma and parse each entry. RFC 9110 Section 5.6.1.2: a recipient
  8014. // has to parse and ignore empty list elements, so a leading, trailing or
  8015. // doubled comma must not turn a legal Accept value into 400 Bad Request.
  8016. // split() skips them, and the header length limit bounds how many a sender
  8017. // can send, so ignoring all of them cannot be used as a denial-of-service
  8018. // vector.
  8019. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  8020. std::string entry(b, e);
  8021. entry = trim_copy(entry);
  8022. AcceptEntry accept_entry;
  8023. accept_entry.order = order++;
  8024. if (!parse_quality(entry.data(), entry.data() + entry.size(),
  8025. accept_entry.media_type, accept_entry.quality)) {
  8026. has_invalid_entry = true;
  8027. return;
  8028. }
  8029. // Remove additional parameters from media type
  8030. accept_entry.media_type = extract_media_type(accept_entry.media_type);
  8031. // Basic validation of media type format
  8032. if (accept_entry.media_type.empty()) {
  8033. has_invalid_entry = true;
  8034. return;
  8035. }
  8036. // Check for basic media type format (should contain '/' or be '*')
  8037. if (accept_entry.media_type != "*" &&
  8038. accept_entry.media_type.find('/') == std::string::npos) {
  8039. has_invalid_entry = true;
  8040. return;
  8041. }
  8042. entries.push_back(std::move(accept_entry));
  8043. });
  8044. // Return false if any invalid entry was found
  8045. if (has_invalid_entry) { return false; }
  8046. // Sort by quality (descending), then by original order (ascending)
  8047. std::sort(entries.begin(), entries.end(),
  8048. [](const AcceptEntry &a, const AcceptEntry &b) {
  8049. if (a.quality != b.quality) {
  8050. return a.quality > b.quality; // Higher quality first
  8051. }
  8052. return a.order < b.order; // Earlier order first for same quality
  8053. });
  8054. // Extract sorted media types
  8055. content_types.reserve(entries.size());
  8056. for (auto &entry : entries) {
  8057. content_types.push_back(std::move(entry.media_type));
  8058. }
  8059. return true;
  8060. }
  8061. class FormDataParser {
  8062. public:
  8063. FormDataParser() = default;
  8064. void set_boundary(std::string &&boundary) {
  8065. boundary_ = std::move(boundary);
  8066. dash_boundary_crlf_ = dash_ + boundary_ + crlf_;
  8067. crlf_dash_boundary_ = crlf_ + dash_ + boundary_;
  8068. }
  8069. bool is_valid() const { return is_valid_; }
  8070. bool parse(const char *buf, size_t n, const FormDataHeader &header_callback,
  8071. const ContentReceiver &content_callback) {
  8072. // Once the close delimiter has been seen the rest of the body is epilogue
  8073. // to be discarded (RFC 2046). Drop it without buffering so a large epilogue
  8074. // spread across reads is not copied in only to be erased right away.
  8075. if (state_ == 5) { return true; }
  8076. buf_append(buf, n);
  8077. while (buf_size() > 0) {
  8078. switch (state_) {
  8079. case 0: { // Initial boundary
  8080. auto pos = buf_find(dash_boundary_crlf_);
  8081. if (pos == buf_size()) {
  8082. // Not found yet: keep only a possible partial boundary at the tail so
  8083. // that a body which never contains the boundary cannot grow the
  8084. // buffer (and get rescanned from the start) without bound.
  8085. auto keep = dash_boundary_crlf_.size() - 1;
  8086. if (buf_size() > keep) { buf_erase(buf_size() - keep); }
  8087. return true;
  8088. }
  8089. buf_erase(pos + dash_boundary_crlf_.size());
  8090. state_ = 1;
  8091. break;
  8092. }
  8093. case 1: { // New entry
  8094. clear_file_info();
  8095. header_searched_ = 0;
  8096. state_ = 2;
  8097. break;
  8098. }
  8099. case 2: { // Headers
  8100. // Resume where the last call stopped looking, so that a line arriving
  8101. // a few bytes at a time is not searched from its start each time.
  8102. auto pos = buf_find(crlf_, header_searched_);
  8103. if (pos > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  8104. while (pos < buf_size()) {
  8105. // Empty line
  8106. if (pos == 0) {
  8107. if (!header_callback(file_)) {
  8108. is_valid_ = false;
  8109. return false;
  8110. }
  8111. buf_erase(crlf_.size());
  8112. state_ = 3;
  8113. break;
  8114. }
  8115. // Check header count limit
  8116. if (header_count_ >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  8117. is_valid_ = false;
  8118. return false;
  8119. }
  8120. header_count_++;
  8121. const auto header = buf_head(pos);
  8122. if (!parse_header(header.data(), header.data() + header.size(),
  8123. [&](const std::string &, const std::string &) {})) {
  8124. is_valid_ = false;
  8125. return false;
  8126. }
  8127. // Parse and emplace space trimmed headers into a map
  8128. if (!parse_header(
  8129. header.data(), header.data() + header.size(),
  8130. [&](const std::string &key, const std::string &val) {
  8131. file_.headers.emplace(key, val);
  8132. })) {
  8133. is_valid_ = false;
  8134. return false;
  8135. }
  8136. constexpr const char header_content_type[] = "Content-Type:";
  8137. if (start_with_case_ignore(header, header_content_type)) {
  8138. file_.content_type =
  8139. trim_copy(header.substr(str_len(header_content_type)));
  8140. } else {
  8141. std::string disposition_params;
  8142. if (parse_content_disposition(header, disposition_params)) {
  8143. Params params;
  8144. parse_disposition_params(disposition_params, params);
  8145. auto it = params.find("name");
  8146. if (it != params.end()) {
  8147. file_.name = it->second;
  8148. } else {
  8149. is_valid_ = false;
  8150. return false;
  8151. }
  8152. it = params.find("filename");
  8153. if (it != params.end()) { file_.filename = it->second; }
  8154. it = params.find("filename*");
  8155. if (it != params.end()) {
  8156. // RFC 5987: only UTF-8 encoding is allowed
  8157. const auto &val = it->second;
  8158. constexpr const char utf8_prefix[] = "UTF-8''";
  8159. constexpr size_t prefix_len = str_len(utf8_prefix);
  8160. if (val.size() > prefix_len &&
  8161. start_with_case_ignore(val, utf8_prefix)) {
  8162. file_.filename = decode_path_component(
  8163. val.substr(prefix_len)); // override...
  8164. } else {
  8165. is_valid_ = false;
  8166. return false;
  8167. }
  8168. }
  8169. }
  8170. }
  8171. buf_erase(pos + crlf_.size());
  8172. pos = buf_find(crlf_);
  8173. }
  8174. if (state_ != 3) {
  8175. // The CR of the CRLF may be the last byte so far.
  8176. header_searched_ = buf_size() > 0 ? buf_size() - 1 : 0;
  8177. return true;
  8178. }
  8179. break;
  8180. }
  8181. case 3: { // Body
  8182. if (crlf_dash_boundary_.size() > buf_size()) { return true; }
  8183. auto pos = buf_find(crlf_dash_boundary_);
  8184. if (pos < buf_size()) {
  8185. if (!content_callback(buf_data(), pos)) {
  8186. is_valid_ = false;
  8187. return false;
  8188. }
  8189. buf_erase(pos + crlf_dash_boundary_.size());
  8190. state_ = 4;
  8191. } else {
  8192. auto len = buf_size() - crlf_dash_boundary_.size();
  8193. if (len > 0) {
  8194. if (!content_callback(buf_data(), len)) {
  8195. is_valid_ = false;
  8196. return false;
  8197. }
  8198. buf_erase(len);
  8199. }
  8200. return true;
  8201. }
  8202. break;
  8203. }
  8204. case 4: { // Boundary
  8205. if (crlf_.size() > buf_size()) { return true; }
  8206. if (buf_start_with(crlf_)) {
  8207. buf_erase(crlf_.size());
  8208. state_ = 1;
  8209. } else if (buf_start_with(dash_)) {
  8210. buf_erase(dash_.size());
  8211. is_valid_ = true;
  8212. state_ = 5;
  8213. } else {
  8214. // Only CRLF (another part follows) and "--" (close-delimiter) are
  8215. // accepted after a boundary; RFC 2046 allows transport-padding in
  8216. // between, but this parser has never supported it. Either way the
  8217. // body is already destined to be rejected, so fail now instead of
  8218. // buffering the rest of it. Both are two bytes, so the check above
  8219. // already guarantees enough buffered data to decide.
  8220. is_valid_ = false;
  8221. return false;
  8222. }
  8223. break;
  8224. }
  8225. case 5: { // Epilogue
  8226. buf_erase(buf_size());
  8227. break;
  8228. }
  8229. }
  8230. }
  8231. return true;
  8232. }
  8233. private:
  8234. void clear_file_info() {
  8235. file_.name.clear();
  8236. file_.filename.clear();
  8237. file_.content_type.clear();
  8238. file_.headers.clear();
  8239. header_count_ = 0;
  8240. }
  8241. bool start_with_case_ignore(const std::string &a, const char *b,
  8242. size_t offset = 0) const {
  8243. const auto b_len = strlen(b);
  8244. if (a.size() < offset + b_len) { return false; }
  8245. for (size_t i = 0; i < b_len; i++) {
  8246. if (case_ignore::to_lower(a[offset + i]) != case_ignore::to_lower(b[i])) {
  8247. return false;
  8248. }
  8249. }
  8250. return true;
  8251. }
  8252. // Parses "Content-Disposition: form-data; <params>" without std::regex.
  8253. // Returns true if header matches, with the params portion in `params_out`.
  8254. bool parse_content_disposition(const std::string &header,
  8255. std::string &params_out) const {
  8256. constexpr const char prefix[] = "Content-Disposition:";
  8257. constexpr size_t prefix_len = str_len(prefix);
  8258. if (!start_with_case_ignore(header, prefix)) { return false; }
  8259. // Skip whitespace after "Content-Disposition:"
  8260. auto pos = prefix_len;
  8261. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8262. pos++;
  8263. }
  8264. // Match "form-data;" (case-insensitive)
  8265. constexpr const char form_data[] = "form-data;";
  8266. constexpr size_t form_data_len = str_len(form_data);
  8267. if (!start_with_case_ignore(header, form_data, pos)) { return false; }
  8268. pos += form_data_len;
  8269. // Skip whitespace after "form-data;"
  8270. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8271. pos++;
  8272. }
  8273. params_out = header.substr(pos);
  8274. return true;
  8275. }
  8276. const std::string dash_ = "--";
  8277. const std::string crlf_ = "\r\n";
  8278. std::string boundary_;
  8279. std::string dash_boundary_crlf_;
  8280. std::string crlf_dash_boundary_;
  8281. size_t state_ = 0;
  8282. bool is_valid_ = false;
  8283. FormData file_;
  8284. size_t header_count_ = 0;
  8285. size_t header_searched_ = 0;
  8286. // Buffer
  8287. bool start_with(const std::string &a, size_t spos, size_t epos,
  8288. const std::string &b) const {
  8289. if (epos - spos < b.size()) { return false; }
  8290. for (size_t i = 0; i < b.size(); i++) {
  8291. if (a[i + spos] != b[i]) { return false; }
  8292. }
  8293. return true;
  8294. }
  8295. size_t buf_size() const { return buf_epos_ - buf_spos_; }
  8296. const char *buf_data() const { return &buf_[buf_spos_]; }
  8297. std::string buf_head(size_t l) const { return buf_.substr(buf_spos_, l); }
  8298. bool buf_start_with(const std::string &s) const {
  8299. return start_with(buf_, buf_spos_, buf_epos_, s);
  8300. }
  8301. size_t buf_find(const std::string &s, size_t from = 0) const {
  8302. auto c = s.front();
  8303. size_t off = buf_spos_ + from;
  8304. while (off < buf_epos_) {
  8305. auto pos = off;
  8306. while (true) {
  8307. if (pos == buf_epos_) { return buf_size(); }
  8308. if (buf_[pos] == c) { break; }
  8309. pos++;
  8310. }
  8311. auto remaining_size = buf_epos_ - pos;
  8312. if (s.size() > remaining_size) { return buf_size(); }
  8313. if (start_with(buf_, pos, buf_epos_, s)) { return pos - buf_spos_; }
  8314. off = pos + 1;
  8315. }
  8316. return buf_size();
  8317. }
  8318. void buf_append(const char *data, size_t n) {
  8319. auto remaining_size = buf_size();
  8320. if (remaining_size > 0 && buf_spos_ > 0) {
  8321. for (size_t i = 0; i < remaining_size; i++) {
  8322. buf_[i] = buf_[buf_spos_ + i];
  8323. }
  8324. }
  8325. buf_spos_ = 0;
  8326. buf_epos_ = remaining_size;
  8327. if (remaining_size + n > buf_.size()) { buf_.resize(remaining_size + n); }
  8328. for (size_t i = 0; i < n; i++) {
  8329. buf_[buf_epos_ + i] = data[i];
  8330. }
  8331. buf_epos_ += n;
  8332. }
  8333. void buf_erase(size_t size) { buf_spos_ += size; }
  8334. std::string buf_;
  8335. size_t buf_spos_ = 0;
  8336. size_t buf_epos_ = 0;
  8337. };
  8338. inline std::string random_string(size_t length) {
  8339. constexpr const char data[] =
  8340. "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
  8341. std::string result(length, '\0');
  8342. fill_random_bytes(reinterpret_cast<unsigned char *>(&result[0]), length);
  8343. for (auto &c : result) {
  8344. c = data[static_cast<unsigned char>(c) % (sizeof(data) - 1)];
  8345. }
  8346. return result;
  8347. }
  8348. inline std::string make_multipart_data_boundary() {
  8349. return "--cpp-httplib-multipart-data-" + detail::random_string(16);
  8350. }
  8351. inline bool is_multipart_boundary_chars_valid(const std::string &boundary) {
  8352. auto valid = true;
  8353. for (size_t i = 0; i < boundary.size(); i++) {
  8354. auto c = boundary[i];
  8355. if (!is_ascii_alnum(c) && c != '-' && c != '_') {
  8356. valid = false;
  8357. break;
  8358. }
  8359. }
  8360. return valid;
  8361. }
  8362. // Escape a multipart field name/filename following the WHATWG HTML standard
  8363. // ("escape a multipart form-data name"): '"' -> %22, CR -> %0D, LF -> %0A.
  8364. // As the value is a quoted-string, '\' -> '\\' too, which browsers leave out.
  8365. // With quoted = false, only CR and LF are escaped; this is for header values
  8366. // outside a quoted-string (e.g. Content-Type), where '"' and '\' are legal.
  8367. inline std::string escape_multipart_field(const std::string &s,
  8368. bool quoted = true) {
  8369. std::string result;
  8370. result.reserve(s.size());
  8371. for (auto c : s) {
  8372. switch (c) {
  8373. case '"':
  8374. if (quoted) {
  8375. result += "%22";
  8376. } else {
  8377. result += c;
  8378. }
  8379. break;
  8380. case '\\':
  8381. // A lone backslash would escape the character after it (RFC 9110
  8382. // 5.6.4).
  8383. if (quoted) { result += '\\'; }
  8384. result += c;
  8385. break;
  8386. case '\r': result += "%0D"; break;
  8387. case '\n': result += "%0A"; break;
  8388. default: result += c; break;
  8389. }
  8390. }
  8391. return result;
  8392. }
  8393. template <typename T>
  8394. inline std::string
  8395. serialize_multipart_formdata_item_begin(const T &item,
  8396. const std::string &boundary) {
  8397. std::string body = "--" + boundary + "\r\n";
  8398. body += "Content-Disposition: form-data; name=\"" +
  8399. escape_multipart_field(item.name) + "\"";
  8400. if (!item.filename.empty()) {
  8401. body += "; filename=\"" + escape_multipart_field(item.filename) + "\"";
  8402. }
  8403. body += "\r\n";
  8404. if (!item.content_type.empty()) {
  8405. body +=
  8406. "Content-Type: " + escape_multipart_field(item.content_type, false) +
  8407. "\r\n";
  8408. }
  8409. body += "\r\n";
  8410. return body;
  8411. }
  8412. inline std::string serialize_multipart_formdata_item_end() { return "\r\n"; }
  8413. inline std::string
  8414. serialize_multipart_formdata_finish(const std::string &boundary) {
  8415. return "--" + boundary + "--\r\n";
  8416. }
  8417. inline std::string
  8418. serialize_multipart_formdata_get_content_type(const std::string &boundary) {
  8419. return "multipart/form-data; boundary=" + boundary;
  8420. }
  8421. inline std::string
  8422. serialize_multipart_formdata(const UploadFormDataItems &items,
  8423. const std::string &boundary, bool finish = true) {
  8424. std::string body;
  8425. for (const auto &item : items) {
  8426. body += serialize_multipart_formdata_item_begin(item, boundary);
  8427. body += item.content + serialize_multipart_formdata_item_end();
  8428. }
  8429. if (finish) { body += serialize_multipart_formdata_finish(boundary); }
  8430. return body;
  8431. }
  8432. inline size_t get_multipart_content_length(const UploadFormDataItems &items,
  8433. const std::string &boundary) {
  8434. size_t total = 0;
  8435. for (const auto &item : items) {
  8436. total += serialize_multipart_formdata_item_begin(item, boundary).size();
  8437. total += item.content.size();
  8438. total += serialize_multipart_formdata_item_end().size();
  8439. }
  8440. total += serialize_multipart_formdata_finish(boundary).size();
  8441. return total;
  8442. }
  8443. struct MultipartSegment {
  8444. const char *data;
  8445. size_t size;
  8446. };
  8447. // NOTE: items must outlive the returned ContentProvider
  8448. // (safe for synchronous use inside Post/Put/Patch)
  8449. inline ContentProvider
  8450. make_multipart_content_provider(const UploadFormDataItems &items,
  8451. const std::string &boundary) {
  8452. // Own the per-item header strings and the finish string
  8453. std::vector<std::string> owned;
  8454. owned.reserve(items.size() + 1);
  8455. for (const auto &item : items)
  8456. owned.push_back(serialize_multipart_formdata_item_begin(item, boundary));
  8457. owned.push_back(serialize_multipart_formdata_finish(boundary));
  8458. // Flat segment list: [header, content, "\r\n"] * N + [finish]
  8459. std::vector<MultipartSegment> segs;
  8460. segs.reserve(items.size() * 3 + 1);
  8461. static const char crlf[] = "\r\n";
  8462. for (size_t i = 0; i < items.size(); i++) {
  8463. segs.push_back({owned[i].data(), owned[i].size()});
  8464. segs.push_back({items[i].content.data(), items[i].content.size()});
  8465. segs.push_back({crlf, 2});
  8466. }
  8467. segs.push_back({owned.back().data(), owned.back().size()});
  8468. struct MultipartState {
  8469. std::vector<std::string> owned;
  8470. std::vector<MultipartSegment> segs;
  8471. std::vector<char> buf = std::vector<char>(CPPHTTPLIB_SEND_BUFSIZ);
  8472. };
  8473. auto state = std::make_shared<MultipartState>();
  8474. state->owned = std::move(owned);
  8475. // `segs` holds raw pointers into owned strings; std::string move preserves
  8476. // the data pointer, so these pointers remain valid after the move above.
  8477. state->segs = std::move(segs);
  8478. return [state](size_t offset, size_t length, DataSink &sink) -> bool {
  8479. // Buffer multiple small segments into fewer, larger writes to avoid
  8480. // excessive TCP packets when there are many form data items (#2410)
  8481. auto &buf = state->buf;
  8482. auto buf_size = buf.size();
  8483. size_t buf_len = 0;
  8484. size_t remaining = length;
  8485. // Find the first segment containing 'offset'
  8486. size_t pos = 0;
  8487. size_t seg_idx = 0;
  8488. for (; seg_idx < state->segs.size(); seg_idx++) {
  8489. const auto &seg = state->segs[seg_idx];
  8490. if (seg.size > 0 && offset - pos < seg.size) { break; }
  8491. pos += seg.size;
  8492. }
  8493. size_t seg_offset = (seg_idx < state->segs.size()) ? offset - pos : 0;
  8494. for (; seg_idx < state->segs.size() && remaining > 0; seg_idx++) {
  8495. const auto &seg = state->segs[seg_idx];
  8496. size_t available = seg.size - seg_offset;
  8497. size_t to_copy = (std::min)(available, remaining);
  8498. const char *src = seg.data + seg_offset;
  8499. seg_offset = 0; // only the first segment has a non-zero offset
  8500. while (to_copy > 0) {
  8501. size_t space = buf_size - buf_len;
  8502. size_t chunk = (std::min)(to_copy, space);
  8503. std::memcpy(buf.data() + buf_len, src, chunk);
  8504. buf_len += chunk;
  8505. src += chunk;
  8506. to_copy -= chunk;
  8507. remaining -= chunk;
  8508. if (buf_len == buf_size) {
  8509. if (!sink.write(buf.data(), buf_len)) { return false; }
  8510. buf_len = 0;
  8511. }
  8512. }
  8513. }
  8514. if (buf_len > 0) { return sink.write(buf.data(), buf_len); }
  8515. return true;
  8516. };
  8517. }
  8518. inline void coalesce_ranges(Ranges &ranges, size_t content_length) {
  8519. if (ranges.size() <= 1) return;
  8520. // Sort ranges by start position
  8521. std::sort(ranges.begin(), ranges.end(),
  8522. [](const Range &a, const Range &b) { return a.first < b.first; });
  8523. Ranges coalesced;
  8524. coalesced.reserve(ranges.size());
  8525. for (auto &r : ranges) {
  8526. auto first_pos = r.first;
  8527. auto last_pos = r.second;
  8528. // Handle special cases like in range_error
  8529. if (first_pos == -1 && last_pos == -1) {
  8530. first_pos = 0;
  8531. last_pos = static_cast<ssize_t>(content_length);
  8532. }
  8533. if (first_pos == -1) {
  8534. first_pos = static_cast<ssize_t>(content_length) - last_pos;
  8535. last_pos = static_cast<ssize_t>(content_length) - 1;
  8536. }
  8537. if (last_pos == -1 || last_pos >= static_cast<ssize_t>(content_length)) {
  8538. last_pos = static_cast<ssize_t>(content_length) - 1;
  8539. }
  8540. // Skip invalid ranges
  8541. if (!(0 <= first_pos && first_pos <= last_pos &&
  8542. last_pos < static_cast<ssize_t>(content_length))) {
  8543. continue;
  8544. }
  8545. // Coalesce with previous range if overlapping or adjacent (but not
  8546. // identical)
  8547. if (!coalesced.empty()) {
  8548. auto &prev = coalesced.back();
  8549. // Check if current range overlaps or is adjacent to previous range
  8550. // but don't coalesce identical ranges (allow duplicates)
  8551. if (first_pos <= prev.second + 1 &&
  8552. !(first_pos == prev.first && last_pos == prev.second)) {
  8553. // Extend the previous range
  8554. prev.second = (std::max)(prev.second, last_pos);
  8555. continue;
  8556. }
  8557. }
  8558. // Add new range
  8559. coalesced.emplace_back(first_pos, last_pos);
  8560. }
  8561. ranges = std::move(coalesced);
  8562. }
  8563. inline bool range_error(Request &req, Response &res) {
  8564. if (!req.ranges.empty() && 200 <= res.status && res.status < 300) {
  8565. if (res.body.empty() && res.content_provider_ && res.content_length_ == 0) {
  8566. req.ranges.clear();
  8567. if (res.status == StatusCode::PartialContent_206) {
  8568. res.status = StatusCode::OK_200;
  8569. }
  8570. return false;
  8571. }
  8572. ssize_t content_len = static_cast<ssize_t>(
  8573. res.content_length_ ? res.content_length_ : res.body.size());
  8574. std::vector<std::pair<ssize_t, ssize_t>> processed_ranges;
  8575. size_t overwrapping_count = 0;
  8576. // NOTE: The following Range check is based on '14.2. Range' in RFC 9110
  8577. // 'HTTP Semantics' to avoid potential denial-of-service attacks.
  8578. // https://www.rfc-editor.org/rfc/rfc9110#section-14.2
  8579. // Too many ranges
  8580. if (CPPHTTPLIB_RANGE_MAX_COUNT > 0 &&
  8581. req.ranges.size() > CPPHTTPLIB_RANGE_MAX_COUNT) {
  8582. return true;
  8583. }
  8584. for (auto &r : req.ranges) {
  8585. auto &first_pos = r.first;
  8586. auto &last_pos = r.second;
  8587. if (first_pos == -1 && last_pos == -1) {
  8588. first_pos = 0;
  8589. last_pos = content_len;
  8590. }
  8591. // RFC 9110 14.1.2: a suffix-length longer than the representation
  8592. // selects the entire representation.
  8593. if (first_pos == -1) {
  8594. first_pos = (std::max)(static_cast<ssize_t>(0), content_len - last_pos);
  8595. last_pos = content_len - 1;
  8596. }
  8597. // NOTE: RFC-9110 '14.1.2. Byte Ranges':
  8598. // A client can limit the number of bytes requested without knowing the
  8599. // size of the selected representation. If the last-pos value is absent,
  8600. // or if the value is greater than or equal to the current length of the
  8601. // representation data, the byte range is interpreted as the remainder of
  8602. // the representation (i.e., the server replaces the value of last-pos
  8603. // with a value that is one less than the current length of the selected
  8604. // representation).
  8605. // https://www.rfc-editor.org/rfc/rfc9110.html#section-14.1.2-6
  8606. if (last_pos == -1 || last_pos >= content_len) {
  8607. last_pos = content_len - 1;
  8608. }
  8609. // Range must be within content length
  8610. if (!(0 <= first_pos && first_pos <= last_pos &&
  8611. last_pos <= content_len - 1)) {
  8612. return true;
  8613. }
  8614. // Request must not have more than two overlapping ranges
  8615. for (const auto &processed_range : processed_ranges) {
  8616. if (!(last_pos < processed_range.first ||
  8617. first_pos > processed_range.second)) {
  8618. overwrapping_count++;
  8619. if (overwrapping_count > 2) { return true; }
  8620. break; // Only count once per range
  8621. }
  8622. }
  8623. processed_ranges.emplace_back(first_pos, last_pos);
  8624. }
  8625. // After validation, coalesce overlapping ranges as per RFC 9110
  8626. coalesce_ranges(req.ranges, static_cast<size_t>(content_len));
  8627. }
  8628. return false;
  8629. }
  8630. inline std::pair<size_t, size_t>
  8631. get_range_offset_and_length(Range r, size_t content_length) {
  8632. assert(r.first != -1 && r.second != -1);
  8633. assert(0 <= r.first && r.first < static_cast<ssize_t>(content_length));
  8634. assert(r.first <= r.second &&
  8635. r.second < static_cast<ssize_t>(content_length));
  8636. (void)(content_length);
  8637. return std::make_pair(static_cast<size_t>(r.first),
  8638. static_cast<size_t>(r.second - r.first) + 1);
  8639. }
  8640. inline std::string make_content_range_header_field(
  8641. const std::pair<size_t, size_t> &offset_and_length, size_t content_length) {
  8642. auto st = offset_and_length.first;
  8643. auto ed = st + offset_and_length.second - 1;
  8644. std::string field = "bytes ";
  8645. field += std::to_string(st);
  8646. field += '-';
  8647. field += std::to_string(ed);
  8648. field += '/';
  8649. field += std::to_string(content_length);
  8650. return field;
  8651. }
  8652. template <typename SToken, typename CToken, typename Content>
  8653. bool process_multipart_ranges_data(const Request &req,
  8654. const std::string &boundary,
  8655. const std::string &content_type,
  8656. size_t content_length, SToken stoken,
  8657. CToken ctoken, Content content) {
  8658. for (size_t i = 0; i < req.ranges.size(); i++) {
  8659. ctoken("--");
  8660. stoken(boundary);
  8661. ctoken("\r\n");
  8662. if (!content_type.empty()) {
  8663. ctoken("Content-Type: ");
  8664. stoken(content_type);
  8665. ctoken("\r\n");
  8666. }
  8667. auto offset_and_length =
  8668. get_range_offset_and_length(req.ranges[i], content_length);
  8669. ctoken("Content-Range: ");
  8670. stoken(make_content_range_header_field(offset_and_length, content_length));
  8671. ctoken("\r\n");
  8672. ctoken("\r\n");
  8673. if (!content(offset_and_length.first, offset_and_length.second)) {
  8674. return false;
  8675. }
  8676. ctoken("\r\n");
  8677. }
  8678. ctoken("--");
  8679. stoken(boundary);
  8680. ctoken("--");
  8681. return true;
  8682. }
  8683. inline void make_multipart_ranges_data(const Request &req, Response &res,
  8684. const std::string &boundary,
  8685. const std::string &content_type,
  8686. size_t content_length,
  8687. std::string &data) {
  8688. process_multipart_ranges_data(
  8689. req, boundary, content_type, content_length,
  8690. [&](const std::string &token) { data += token; },
  8691. [&](const std::string &token) { data += token; },
  8692. [&](size_t offset, size_t length) {
  8693. assert(offset + length <= content_length);
  8694. data += res.body.substr(offset, length);
  8695. return true;
  8696. });
  8697. }
  8698. inline size_t get_multipart_ranges_data_length(const Request &req,
  8699. const std::string &boundary,
  8700. const std::string &content_type,
  8701. size_t content_length) {
  8702. size_t data_length = 0;
  8703. process_multipart_ranges_data(
  8704. req, boundary, content_type, content_length,
  8705. [&](const std::string &token) { data_length += token.size(); },
  8706. [&](const std::string &token) { data_length += token.size(); },
  8707. [&](size_t /*offset*/, size_t length) {
  8708. data_length += length;
  8709. return true;
  8710. });
  8711. return data_length;
  8712. }
  8713. template <typename T>
  8714. inline bool
  8715. write_multipart_ranges_data(Stream &strm, const Request &req, Response &res,
  8716. const std::string &boundary,
  8717. const std::string &content_type,
  8718. size_t content_length, const T &is_shutting_down) {
  8719. return process_multipart_ranges_data(
  8720. req, boundary, content_type, content_length,
  8721. [&](const std::string &token) { strm.write(token); },
  8722. [&](const std::string &token) { strm.write(token); },
  8723. [&](size_t offset, size_t length) {
  8724. return write_content(strm, res.content_provider_, offset, length,
  8725. is_shutting_down);
  8726. });
  8727. }
  8728. inline bool has_framed_body(const Request &req) {
  8729. return is_chunked_transfer_encoding(req.headers) ||
  8730. req.get_header_value_u64("Content-Length") > 0;
  8731. }
  8732. inline bool is_connection_persistent(const Request &req) {
  8733. if (has_header_token(req.headers, "Connection", "close")) { return false; }
  8734. if (req.version == "HTTP/1.0" &&
  8735. !has_header_token(req.headers, "Connection", "keep-alive")) {
  8736. return false;
  8737. }
  8738. return true;
  8739. }
  8740. inline bool expect_content(const Request &req) {
  8741. if (req.method == "POST" || req.method == "PUT" || req.method == "PATCH" ||
  8742. req.method == "DELETE") {
  8743. return true;
  8744. }
  8745. return has_framed_body(req);
  8746. }
  8747. #ifdef _WIN32
  8748. class WSInit {
  8749. public:
  8750. WSInit() {
  8751. WSADATA wsaData;
  8752. if (WSAStartup(0x0002, &wsaData) == 0) is_valid_ = true;
  8753. }
  8754. ~WSInit() {
  8755. if (is_valid_) WSACleanup();
  8756. }
  8757. bool is_valid_ = false;
  8758. };
  8759. static WSInit wsinit_;
  8760. #endif
  8761. inline std::string unescape_quoted_pairs(const std::string &s) {
  8762. std::string out;
  8763. out.reserve(s.size());
  8764. for (size_t i = 0; i < s.size(); i++) {
  8765. if (s[i] == '\\' && i + 1 < s.size()) {
  8766. out += s[++i];
  8767. } else {
  8768. out += s[i];
  8769. }
  8770. }
  8771. return out;
  8772. }
  8773. // Inverse of unescape_quoted_pairs: prepares a value to sit inside a
  8774. // quoted-string. RFC 9110 §5.6.4 requires a literal '\' or '"' to be sent as a
  8775. // quoted-pair, so the recipient recovers the original value.
  8776. inline std::string escape_quoted_pairs(const std::string &s) {
  8777. std::string out;
  8778. out.reserve(s.size());
  8779. for (auto c : s) {
  8780. if (c == '\\' || c == '"') { out += '\\'; }
  8781. out += c;
  8782. }
  8783. return out;
  8784. }
  8785. // RFC 9110 Section 11.6.1 defines a challenge list as
  8786. // WWW-Authenticate = #challenge
  8787. // challenge = auth-scheme [ 1*SP ( token68 / [ #auth-param ] ) ]
  8788. // auth-param = token BWS "=" BWS ( token / quoted-string )
  8789. // so a server may offer several schemes, each with its own comma-separated
  8790. // auth-param list, in either order and either as separate field lines or
  8791. // packed into one. Splitting on every comma would break apart a challenge's
  8792. // own param list; splitting only on the first space would miss a Digest
  8793. // challenge that isn't first. Split on commas that aren't inside a
  8794. // quoted-string instead (split_unquoted), then track which scheme each
  8795. // resulting segment belongs to: a segment whose text before "=" contains
  8796. // whitespace (or that has no "=" at all) starts a new challenge named by its
  8797. // leading token.
  8798. inline bool parse_www_authenticate(const Response &res,
  8799. std::map<std::string, std::string> &auth,
  8800. bool is_proxy) {
  8801. auto auth_key = is_proxy ? "Proxy-Authenticate" : "WWW-Authenticate";
  8802. auto combined = get_combined_header_value(res.headers, auth_key);
  8803. if (combined.empty()) { return false; }
  8804. auto found_digest = false;
  8805. auto in_digest_challenge = false;
  8806. split_unquoted(
  8807. combined.data(), combined.data() + combined.size(), ',',
  8808. [&](const char *b, const char *e) {
  8809. std::string segment(b, e);
  8810. auto eq_pos = segment.find('=');
  8811. // BWS is allowed on both sides of "=", so the text naming the key (or,
  8812. // for the first segment of a challenge, "<scheme> <key>") must be
  8813. // trimmed before its boundaries are inspected.
  8814. auto key_part = trim_copy(
  8815. eq_pos == std::string::npos ? segment : segment.substr(0, eq_pos));
  8816. auto space_pos = key_part.find_last_of(" \t");
  8817. if (space_pos != std::string::npos || eq_pos == std::string::npos) {
  8818. // "<scheme>[ <key>]" starts a new challenge.
  8819. auto scheme_end =
  8820. space_pos == std::string::npos ? key_part.size() : space_pos;
  8821. // RFC 7616 Section 3.7: a server may offer more than one Digest
  8822. // challenge (e.g. SHA-256 and MD5); keep only the first so a nonce
  8823. // from one challenge is never paired with another's algorithm.
  8824. in_digest_challenge =
  8825. !found_digest &&
  8826. case_ignore::equal(key_part.substr(0, scheme_end), "Digest");
  8827. if (in_digest_challenge) { found_digest = true; }
  8828. if (space_pos == std::string::npos) {
  8829. // Bare scheme (or a token68), no auth-param on this segment.
  8830. return;
  8831. }
  8832. key_part = key_part.substr(space_pos + 1);
  8833. }
  8834. if (!in_digest_challenge) { return; }
  8835. auto val = trim_copy(segment.substr(eq_pos + 1));
  8836. auto unquoted = trim_double_quotes_copy(val);
  8837. if (unquoted.size() != val.size()) {
  8838. unquoted = unescape_quoted_pairs(unquoted);
  8839. }
  8840. auth[std::move(key_part)] = std::move(unquoted);
  8841. });
  8842. // RFC 7616 Section 3.3 requires realm and nonce on every Digest challenge;
  8843. // make_digest_authentication_header() dereferences both unconditionally, so
  8844. // a challenge missing either can't produce a usable Authorization header.
  8845. // Treat it the same as no Digest challenge at all.
  8846. return found_digest && auth.find("realm") != auth.end() &&
  8847. auth.find("nonce") != auth.end();
  8848. }
  8849. class ContentProviderAdapter {
  8850. public:
  8851. explicit ContentProviderAdapter(
  8852. ContentProviderWithoutLength &&content_provider)
  8853. : content_provider_(std::move(content_provider)) {}
  8854. bool operator()(size_t offset, size_t, DataSink &sink) {
  8855. return content_provider_(offset, sink);
  8856. }
  8857. private:
  8858. ContentProviderWithoutLength content_provider_;
  8859. };
  8860. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  8861. namespace fields {
  8862. inline bool is_token_char(char c) {
  8863. return is_ascii_alnum(c) || c == '!' || c == '#' || c == '$' || c == '%' ||
  8864. c == '&' || c == '\'' || c == '*' || c == '+' || c == '-' ||
  8865. c == '.' || c == '^' || c == '_' || c == '`' || c == '|' || c == '~';
  8866. }
  8867. inline bool is_token(const std::string &s) {
  8868. if (s.empty()) { return false; }
  8869. for (auto c : s) {
  8870. if (!is_token_char(c)) { return false; }
  8871. }
  8872. return true;
  8873. }
  8874. inline bool is_field_name(const std::string &s) { return is_token(s); }
  8875. inline bool is_vchar(char c) { return c >= 33 && c <= 126; }
  8876. inline bool is_obs_text(char c) { return 128 <= static_cast<unsigned char>(c); }
  8877. inline bool is_field_vchar(char c) { return is_vchar(c) || is_obs_text(c); }
  8878. inline bool is_field_content(const std::string &s) {
  8879. if (s.empty()) { return true; }
  8880. if (s.size() == 1) {
  8881. return is_field_vchar(s[0]);
  8882. } else if (s.size() == 2) {
  8883. return is_field_vchar(s[0]) && is_field_vchar(s[1]);
  8884. } else {
  8885. size_t i = 0;
  8886. if (!is_field_vchar(s[i])) { return false; }
  8887. i++;
  8888. while (i < s.size() - 1) {
  8889. auto c = s[i++];
  8890. if (c == ' ' || c == '\t' || is_field_vchar(c)) {
  8891. } else {
  8892. return false;
  8893. }
  8894. }
  8895. return is_field_vchar(s[i]);
  8896. }
  8897. }
  8898. inline bool is_field_value(const std::string &s) { return is_field_content(s); }
  8899. inline bool is_field_valid(const std::string &name, const std::string &value) {
  8900. return is_field_name(name) && is_field_value(value);
  8901. }
  8902. // RFC 9112 §2.2/§3.2: the request-target has no SP, HTAB or other control
  8903. // characters (incl. bare CR). obs-text (raw UTF-8) is allowed.
  8904. inline bool is_request_target(const std::string &s) {
  8905. return std::all_of(s.begin(), s.end(), is_field_vchar);
  8906. }
  8907. // RFC 9110 §7.2: the bytes of uri-host [ ":" port ], i.e. unreserved,
  8908. // sub-delims, "%", ":" and the IP-literal brackets. An empty value is valid.
  8909. inline bool is_host(const std::string &s) {
  8910. return std::all_of(s.begin(), s.end(), [](char c) {
  8911. return is_ascii_alnum(c) || c == '-' || c == '.' || c == '_' || c == '~' ||
  8912. c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  8913. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  8914. c == '=' || c == '%' || c == ':' || c == '[' || c == ']';
  8915. });
  8916. }
  8917. } // namespace fields
  8918. // Built in memory first, like ClientImpl::write_request, so a rejected header
  8919. // never leaves a partial request on the wire.
  8920. inline bool write_request_head(Stream &strm, Request &req, Error &error) {
  8921. BufferStream bstrm;
  8922. if (write_request_line(bstrm, req.method, req.path) < 0) {
  8923. error = Error::Write;
  8924. return false;
  8925. }
  8926. if (!check_and_write_headers(bstrm, req.headers, write_headers, error)) {
  8927. return false;
  8928. }
  8929. const auto &data = bstrm.get_buffer();
  8930. if (!write_data(strm, data.data(), data.size())) {
  8931. error = Error::Write;
  8932. return false;
  8933. }
  8934. return true;
  8935. }
  8936. inline bool perform_websocket_handshake(Stream &strm, Request &req,
  8937. WebSocketUpgradeResponse &upgrade) {
  8938. // Generate a random 16-byte Sec-WebSocket-Key (RFC 6455 Section 4.1)
  8939. std::string key_bytes(16, '\0');
  8940. fill_random_bytes(reinterpret_cast<unsigned char *>(&key_bytes[0]),
  8941. key_bytes.size());
  8942. auto client_key = base64_encode(key_bytes);
  8943. req.headers.erase("Upgrade");
  8944. req.headers.erase("Connection");
  8945. req.headers.erase("Sec-WebSocket-Key");
  8946. req.headers.erase("Sec-WebSocket-Version");
  8947. req.headers.emplace("Upgrade", "websocket");
  8948. req.headers.emplace("Connection", "Upgrade");
  8949. req.headers.emplace("Sec-WebSocket-Key", client_key);
  8950. req.headers.emplace("Sec-WebSocket-Version", "13");
  8951. if (!write_request_head(strm, req, upgrade.error)) { return false; }
  8952. // Verify 101 response and Sec-WebSocket-Accept header
  8953. auto expected_accept = websocket_accept_key(client_key);
  8954. auto offered_subprotocols =
  8955. get_combined_header_value(req.headers, "Sec-WebSocket-Protocol");
  8956. return read_websocket_upgrade_response(strm, expected_accept,
  8957. offered_subprotocols, upgrade);
  8958. }
  8959. inline bool is_ip_address(const std::string &host) {
  8960. struct in_addr addr4;
  8961. struct in6_addr addr6;
  8962. return inet_pton(AF_INET, host.c_str(), &addr4) == 1 ||
  8963. inet_pton(AF_INET6, host.c_str(), &addr6) == 1;
  8964. }
  8965. // Resolve where a client should connect for `host`, honoring a user-supplied
  8966. // hostname-to-address map. `host` itself is never rewritten, so it keeps
  8967. // supplying the Host header and SNI; only the connection target changes.
  8968. //
  8969. // A mapped IP literal goes to `ip`, which keeps create_socket's AI_NUMERICHOST
  8970. // path. Anything else goes to `connect_host`, which create_socket resolves as
  8971. // a name, or uses as the socket path when the address family is AF_UNIX. An
  8972. // absent or empty mapping leaves `host` as the connection target; without the
  8973. // empty check the value would reach getaddrinfo as a null node and silently
  8974. // resolve to loopback.
  8975. inline void apply_addr_map(const std::map<std::string, std::string> &addr_map,
  8976. const std::string &host, std::string &connect_host,
  8977. std::string &ip) {
  8978. connect_host = host;
  8979. ip.clear();
  8980. auto it = addr_map.find(host);
  8981. if (it == addr_map.end() || it->second.empty()) { return; }
  8982. if (is_ip_address(it->second)) {
  8983. ip = it->second;
  8984. } else {
  8985. connect_host = it->second;
  8986. }
  8987. }
  8988. } // namespace detail
  8989. /*
  8990. * Group 2: detail namespace - SSL common utilities
  8991. */
  8992. #ifdef CPPHTTPLIB_SSL_ENABLED
  8993. namespace detail {
  8994. class SSLSocketStream final : public Stream {
  8995. public:
  8996. SSLSocketStream(
  8997. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  8998. time_t read_timeout_usec, time_t write_timeout_sec,
  8999. time_t write_timeout_usec, time_t max_timeout_msec = 0,
  9000. std::chrono::time_point<std::chrono::steady_clock> start_time =
  9001. (std::chrono::steady_clock::time_point::min)());
  9002. ~SSLSocketStream() override;
  9003. bool is_readable() const override;
  9004. bool wait_readable() const override;
  9005. bool wait_writable() const override;
  9006. bool is_peer_alive() const override;
  9007. ssize_t read(char *ptr, size_t size) override;
  9008. ssize_t write(const char *ptr, size_t size) override;
  9009. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  9010. void get_local_ip_and_port(std::string &ip, int &port) const override;
  9011. socket_t socket() const override;
  9012. time_t duration() const override;
  9013. void set_read_timeout(time_t sec, time_t usec = 0) override;
  9014. void set_max_timeout(time_t msec) override;
  9015. // See SocketStream::set_readable_hint().
  9016. void set_readable_hint() { readable_hint_ = true; }
  9017. // The error from the last read() or write() that failed in the TLS layer,
  9018. // with code Success if none did
  9019. const tls::TlsError &tls_error() const { return tls_error_; }
  9020. private:
  9021. bool ensure_readable();
  9022. socket_t sock_;
  9023. tls::session_t session_;
  9024. time_t read_timeout_sec_;
  9025. time_t read_timeout_usec_;
  9026. time_t write_timeout_sec_;
  9027. time_t write_timeout_usec_;
  9028. time_t max_timeout_msec_;
  9029. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  9030. bool readable_hint_ = false;
  9031. tls::TlsError tls_error_;
  9032. };
  9033. // A TLS stream for WebSocket connections, where the receive path and the
  9034. // send path (application send() plus the heartbeat ping thread) run on
  9035. // different threads. A single TLS session must never be entered
  9036. // concurrently, so every call into the session is serialized by one mutex.
  9037. //
  9038. // Unlike SSLSocketStream, the socket is kept non-blocking for the stream's
  9039. // whole lifetime and each read()/write() performs a single non-blocking TLS
  9040. // call under the lock, then waits for readiness with select() outside the
  9041. // lock. The lock is therefore held only for CPU-bound work, so a reader
  9042. // blocked waiting for data never stalls a concurrent sender.
  9043. //
  9044. // This stream is used only for wss:// connections. Plain ws:// and ordinary
  9045. // HTTP/HTTPS keep using SocketStream/SSLSocketStream unchanged.
  9046. class WebSocketSSLStream final : public Stream {
  9047. public:
  9048. WebSocketSSLStream(socket_t sock, tls::session_t session,
  9049. time_t read_timeout_sec, time_t read_timeout_usec,
  9050. time_t write_timeout_sec, time_t write_timeout_usec);
  9051. ~WebSocketSSLStream() override;
  9052. bool is_readable() const override;
  9053. bool wait_readable() const override;
  9054. bool wait_writable() const override;
  9055. ssize_t read(char *ptr, size_t size) override;
  9056. ssize_t write(const char *ptr, size_t size) override;
  9057. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  9058. void get_local_ip_and_port(std::string &ip, int &port) const override;
  9059. socket_t socket() const override;
  9060. time_t duration() const override;
  9061. void set_read_timeout(time_t sec, time_t usec = 0) override;
  9062. private:
  9063. mutable std::mutex session_mutex_;
  9064. socket_t sock_;
  9065. tls::session_t session_;
  9066. // WebSocket::close() shortens the read timeout from the closing thread
  9067. // while the receive thread is inside wait_readable(), so these two are read
  9068. // and written concurrently. The write timeouts are never mutated.
  9069. std::atomic<time_t> read_timeout_sec_;
  9070. std::atomic<time_t> read_timeout_usec_;
  9071. time_t write_timeout_sec_;
  9072. time_t write_timeout_usec_;
  9073. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  9074. };
  9075. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  9076. inline std::string message_digest(const std::string &s, const EVP_MD *algo) {
  9077. auto context = std::unique_ptr<EVP_MD_CTX, decltype(&EVP_MD_CTX_free)>(
  9078. EVP_MD_CTX_new(), EVP_MD_CTX_free);
  9079. unsigned int hash_length = 0;
  9080. unsigned char hash[EVP_MAX_MD_SIZE];
  9081. EVP_DigestInit_ex(context.get(), algo, nullptr);
  9082. EVP_DigestUpdate(context.get(), s.c_str(), s.size());
  9083. EVP_DigestFinal_ex(context.get(), hash, &hash_length);
  9084. std::stringstream ss;
  9085. for (auto i = 0u; i < hash_length; ++i) {
  9086. ss << std::hex << std::setw(2) << std::setfill('0')
  9087. << static_cast<unsigned int>(hash[i]);
  9088. }
  9089. return ss.str();
  9090. }
  9091. inline std::string MD5(const std::string &s) {
  9092. return message_digest(s, EVP_md5());
  9093. }
  9094. inline std::string SHA_256(const std::string &s) {
  9095. return message_digest(s, EVP_sha256());
  9096. }
  9097. inline std::string SHA_512(const std::string &s) {
  9098. return message_digest(s, EVP_sha512());
  9099. }
  9100. #elif defined(CPPHTTPLIB_MBEDTLS_SUPPORT)
  9101. namespace {
  9102. template <size_t N>
  9103. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  9104. std::stringstream ss;
  9105. for (size_t i = 0; i < N; ++i) {
  9106. ss << std::hex << std::setw(2) << std::setfill('0')
  9107. << static_cast<unsigned int>(hash[i]);
  9108. }
  9109. return ss.str();
  9110. }
  9111. } // namespace
  9112. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9113. // Mbed TLS 4.x provides hashing (and TLS RNG) via PSA Crypto, which must be
  9114. // initialized once. PSA state is process-global; do not free it.
  9115. inline bool ensure_mbedtls_psa_crypto() {
  9116. static std::once_flag once;
  9117. static bool ok = false;
  9118. std::call_once(once, []() { ok = (psa_crypto_init() == PSA_SUCCESS); });
  9119. return ok;
  9120. }
  9121. inline bool psa_hash(psa_algorithm_t alg, const std::string &s,
  9122. unsigned char *out, size_t out_size) {
  9123. if (!ensure_mbedtls_psa_crypto()) { return false; }
  9124. size_t olen = 0;
  9125. return psa_hash_compute(alg, reinterpret_cast<const uint8_t *>(s.data()),
  9126. s.size(), out, out_size, &olen) == PSA_SUCCESS &&
  9127. olen == out_size;
  9128. }
  9129. #endif
  9130. inline std::string MD5(const std::string &s) {
  9131. unsigned char hash[16];
  9132. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9133. if (!psa_hash(PSA_ALG_MD5, s, hash, sizeof(hash))) { return {}; }
  9134. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9135. mbedtls_md5(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9136. hash);
  9137. #else
  9138. mbedtls_md5_ret(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9139. hash);
  9140. #endif
  9141. return hash_to_hex(hash);
  9142. }
  9143. inline std::string SHA_256(const std::string &s) {
  9144. unsigned char hash[32];
  9145. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9146. if (!psa_hash(PSA_ALG_SHA_256, s, hash, sizeof(hash))) { return {}; }
  9147. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9148. mbedtls_sha256(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9149. hash, 0);
  9150. #else
  9151. mbedtls_sha256_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9152. s.size(), hash, 0);
  9153. #endif
  9154. return hash_to_hex(hash);
  9155. }
  9156. inline std::string SHA_512(const std::string &s) {
  9157. unsigned char hash[64];
  9158. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9159. if (!psa_hash(PSA_ALG_SHA_512, s, hash, sizeof(hash))) { return {}; }
  9160. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9161. mbedtls_sha512(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9162. hash, 0);
  9163. #else
  9164. mbedtls_sha512_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9165. s.size(), hash, 0);
  9166. #endif
  9167. return hash_to_hex(hash);
  9168. }
  9169. #elif defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9170. namespace {
  9171. template <size_t N>
  9172. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  9173. std::stringstream ss;
  9174. for (size_t i = 0; i < N; ++i) {
  9175. ss << std::hex << std::setw(2) << std::setfill('0')
  9176. << static_cast<unsigned int>(hash[i]);
  9177. }
  9178. return ss.str();
  9179. }
  9180. } // namespace
  9181. inline std::string MD5(const std::string &s) {
  9182. unsigned char hash[WC_MD5_DIGEST_SIZE];
  9183. wc_Md5Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9184. static_cast<word32>(s.size()), hash);
  9185. return hash_to_hex(hash);
  9186. }
  9187. inline std::string SHA_256(const std::string &s) {
  9188. unsigned char hash[WC_SHA256_DIGEST_SIZE];
  9189. wc_Sha256Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9190. static_cast<word32>(s.size()), hash);
  9191. return hash_to_hex(hash);
  9192. }
  9193. inline std::string SHA_512(const std::string &s) {
  9194. unsigned char hash[WC_SHA512_DIGEST_SIZE];
  9195. wc_Sha512Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9196. static_cast<word32>(s.size()), hash);
  9197. return hash_to_hex(hash);
  9198. }
  9199. #endif
  9200. template <typename T>
  9201. inline bool process_server_socket_ssl(
  9202. const std::atomic<socket_t> &svr_sock, tls::session_t session,
  9203. socket_t sock, size_t keep_alive_max_count, time_t keep_alive_timeout_sec,
  9204. time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec,
  9205. time_t write_timeout_usec, T callback) {
  9206. // See process_server_socket(). The TLS library keeps already decrypted bytes
  9207. // of a pipelined request, which keep_alive() cannot see on the socket.
  9208. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9209. write_timeout_sec, write_timeout_usec);
  9210. return process_server_socket_core(
  9211. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  9212. [&]() { return strm.is_readable(); },
  9213. [&](bool socket_readable, bool close_connection,
  9214. bool &connection_closed) {
  9215. if (socket_readable) { strm.set_readable_hint(); }
  9216. return callback(strm, close_connection, connection_closed);
  9217. });
  9218. }
  9219. template <typename T>
  9220. inline bool process_client_socket_ssl(
  9221. tls::session_t session, socket_t sock, time_t read_timeout_sec,
  9222. time_t read_timeout_usec, time_t write_timeout_sec,
  9223. time_t write_timeout_usec, time_t max_timeout_msec,
  9224. std::chrono::time_point<std::chrono::steady_clock> start_time, T callback) {
  9225. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9226. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  9227. start_time);
  9228. return callback(strm);
  9229. }
  9230. // `uri` is req's request-target in origin form, as curl sends it, also when
  9231. // the request line carries the absolute form for a proxy.
  9232. inline std::pair<std::string, std::string> make_digest_authentication_header(
  9233. const Request &req, const std::string &uri,
  9234. const std::map<std::string, std::string> &auth, size_t cnonce_count,
  9235. const std::string &cnonce, const std::string &username,
  9236. const std::string &password, bool is_proxy = false) {
  9237. std::string nc;
  9238. {
  9239. std::stringstream ss;
  9240. ss << std::setfill('0') << std::setw(8) << std::hex << cnonce_count;
  9241. nc = ss.str();
  9242. }
  9243. std::string qop;
  9244. if (auth.find("qop") != auth.end()) {
  9245. qop = auth.at("qop");
  9246. if (qop.find("auth-int") != std::string::npos) {
  9247. qop = "auth-int";
  9248. } else if (qop.find("auth") != std::string::npos) {
  9249. qop = "auth";
  9250. } else {
  9251. qop.clear();
  9252. }
  9253. }
  9254. std::string algo = "MD5";
  9255. if (auth.find("algorithm") != auth.end()) {
  9256. // algorithm is an unquoted token (RFC 7616 §3.4). A server value that is
  9257. // not a token would otherwise be emitted verbatim and could carry commas
  9258. // or quotes that inject further auth-params into the header below.
  9259. const auto &a = auth.at("algorithm");
  9260. if (fields::is_token(a)) { algo = a; }
  9261. }
  9262. std::string response;
  9263. {
  9264. auto H = algo == "SHA-256" ? detail::SHA_256
  9265. : algo == "SHA-512" ? detail::SHA_512
  9266. : detail::MD5;
  9267. auto A1 = username + ":" + auth.at("realm") + ":" + password;
  9268. auto A2 = req.method + ":" + uri;
  9269. if (qop == "auth-int") { A2 += ":" + H(req.body); }
  9270. if (qop.empty()) {
  9271. response = H(H(A1) + ":" + auth.at("nonce") + ":" + H(A2));
  9272. } else {
  9273. response = H(H(A1) + ":" + auth.at("nonce") + ":" + nc + ":" + cnonce +
  9274. ":" + qop + ":" + H(A2));
  9275. }
  9276. }
  9277. auto opaque = (auth.find("opaque") != auth.end()) ? auth.at("opaque") : "";
  9278. // Every value placed inside a quoted-string is escaped so a '"' in it cannot
  9279. // close the string early. realm, nonce and opaque come straight from the
  9280. // server's challenge (parse_www_authenticate() already de-escaped them), so
  9281. // without this a crafted challenge injects extra auth-params into the header.
  9282. auto field =
  9283. "Digest username=\"" + detail::escape_quoted_pairs(username) +
  9284. "\", realm=\"" + detail::escape_quoted_pairs(auth.at("realm")) +
  9285. "\", nonce=\"" + detail::escape_quoted_pairs(auth.at("nonce")) +
  9286. "\", uri=\"" + detail::escape_quoted_pairs(uri) +
  9287. "\", algorithm=" + algo +
  9288. (qop.empty() ? ", response=\""
  9289. : ", qop=" + qop + ", nc=" + nc + ", cnonce=\"" + cnonce +
  9290. "\", response=\"") +
  9291. response + "\"" +
  9292. (opaque.empty()
  9293. ? ""
  9294. : ", opaque=\"" + detail::escape_quoted_pairs(opaque) + "\"");
  9295. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9296. return std::make_pair(key, field);
  9297. }
  9298. // Follows X509_check_host, which the OpenSSL backend uses, so that every
  9299. // backend accepts the same names.
  9300. inline bool match_hostname(const std::string &pattern,
  9301. const std::string &hostname) {
  9302. // A trailing dot on the host is ignored
  9303. auto host = hostname;
  9304. if (host.size() > 1 && host.back() == '.') { host.pop_back(); }
  9305. // Exact match (case-insensitive)
  9306. if (detail::case_ignore::equal(host, pattern)) { return true; }
  9307. // Split both pattern and hostname into components by '.', keeping any empty
  9308. // one, which no name may have
  9309. auto labels = [](const std::string &s) {
  9310. std::vector<std::string> v;
  9311. size_t b = 0;
  9312. while (true) {
  9313. auto e = s.find('.', b);
  9314. v.push_back(s.substr(b, e - b));
  9315. if (e == std::string::npos) { return v; }
  9316. b = e + 1;
  9317. }
  9318. };
  9319. auto pattern_components = labels(pattern);
  9320. auto host_components = labels(host);
  9321. auto has_empty_label = [](const std::vector<std::string> &v) {
  9322. return std::any_of(v.begin(), v.end(),
  9323. [](const std::string &l) { return l.empty(); });
  9324. };
  9325. if (has_empty_label(pattern_components) || has_empty_label(host_components)) {
  9326. return false;
  9327. }
  9328. // Component count must match
  9329. if (host_components.size() != pattern_components.size()) { return false; }
  9330. // A wildcard needs two labels after it, so that "*.com" matches nothing,
  9331. // and an IDNA label may not have one
  9332. const auto &leftmost = pattern_components.front();
  9333. if (leftmost.find('*') != std::string::npos &&
  9334. (pattern_components.size() < 3 ||
  9335. case_ignore::equal(leftmost.substr(0, 4), "xn--"))) {
  9336. return false;
  9337. }
  9338. // Compare each component with wildcard support
  9339. // Supports: "*" (full wildcard), "prefix*" (partial wildcard)
  9340. // https://bugs.launchpad.net/ubuntu/+source/firefox-3.0/+bug/376484
  9341. // Only the leftmost label may carry a wildcard (RFC 6125 6.4.3)
  9342. auto itr = pattern_components.begin();
  9343. for (const auto &h : host_components) {
  9344. auto &p = *itr;
  9345. auto is_leftmost = itr == pattern_components.begin();
  9346. if (!detail::case_ignore::equal(p, h) && !(is_leftmost && p == "*")) {
  9347. bool partial_match = false;
  9348. if (is_leftmost && !p.empty() && p[p.size() - 1] == '*') {
  9349. const auto prefix_length = p.size() - 1;
  9350. if (prefix_length == 0) {
  9351. partial_match = true;
  9352. } else if (h.size() >= prefix_length) {
  9353. partial_match =
  9354. std::equal(p.begin(),
  9355. p.begin() + static_cast<std::string::difference_type>(
  9356. prefix_length),
  9357. h.begin(), [](const char ca, const char cb) {
  9358. return detail::case_ignore::to_lower(ca) ==
  9359. detail::case_ignore::to_lower(cb);
  9360. });
  9361. }
  9362. }
  9363. if (!partial_match) { return false; }
  9364. }
  9365. ++itr;
  9366. }
  9367. return true;
  9368. }
  9369. #ifdef _WIN32
  9370. // Verify certificate using Windows CertGetCertificateChain API.
  9371. // This provides real-time certificate validation with Windows Update
  9372. // integration, independent of the TLS backend.
  9373. inline bool verify_cert_with_windows_schannel(
  9374. const std::vector<unsigned char> &der_cert, const std::string &hostname,
  9375. bool verify_hostname, uint64_t &out_error, tls::const_session_t session) {
  9376. if (der_cert.empty()) { return false; }
  9377. out_error = 0;
  9378. // Create Windows certificate context from DER data
  9379. auto cert_context = CertCreateCertificateContext(
  9380. X509_ASN_ENCODING | PKCS_7_ASN_ENCODING, der_cert.data(),
  9381. static_cast<DWORD>(der_cert.size()));
  9382. if (!cert_context) {
  9383. out_error = GetLastError();
  9384. return false;
  9385. }
  9386. auto cert_guard =
  9387. scope_exit([&] { CertFreeCertificateContext(cert_context); });
  9388. // Give CryptoAPI the certificates the server sent. Without them it follows
  9389. // the leaf's AIA URL, which may lead to an issuer under an untrusted root.
  9390. std::vector<tls::cert_t> peer_certs;
  9391. tls::get_peer_certs(session, peer_certs);
  9392. auto store = CertOpenStore(CERT_STORE_PROV_MEMORY, 0, 0, 0, nullptr);
  9393. auto store_guard = scope_exit([&] {
  9394. for (auto cert : peer_certs) {
  9395. tls::free_cert(cert);
  9396. }
  9397. if (store) { CertCloseStore(store, 0); }
  9398. });
  9399. for (auto cert : peer_certs) {
  9400. std::vector<unsigned char> der;
  9401. if (store && tls::get_cert_der(cert, der)) {
  9402. CertAddEncodedCertificateToStore(store, X509_ASN_ENCODING, der.data(),
  9403. static_cast<DWORD>(der.size()),
  9404. CERT_STORE_ADD_USE_EXISTING, nullptr);
  9405. }
  9406. }
  9407. // Setup chain parameters
  9408. CERT_CHAIN_PARA chain_para = {};
  9409. chain_para.cbSize = sizeof(chain_para);
  9410. // Require the server authentication usage along the chain, which also
  9411. // rejects roots that Windows trusts only for other purposes.
  9412. LPSTR server_auth = const_cast<LPSTR>(szOID_PKIX_KP_SERVER_AUTH);
  9413. chain_para.RequestedUsage.dwType = USAGE_MATCH_TYPE_AND;
  9414. chain_para.RequestedUsage.Usage.cUsageIdentifier = 1;
  9415. chain_para.RequestedUsage.Usage.rgpszUsageIdentifier = &server_auth;
  9416. // Build certificate chain with revocation checking
  9417. PCCERT_CHAIN_CONTEXT chain_context = nullptr;
  9418. auto chain_result = CertGetCertificateChain(
  9419. nullptr, cert_context, nullptr, store, &chain_para,
  9420. CERT_CHAIN_CACHE_END_CERT | CERT_CHAIN_REVOCATION_CHECK_END_CERT |
  9421. CERT_CHAIN_REVOCATION_ACCUMULATIVE_TIMEOUT,
  9422. nullptr, &chain_context);
  9423. if (!chain_result || !chain_context) {
  9424. out_error = GetLastError();
  9425. return false;
  9426. }
  9427. auto chain_guard =
  9428. scope_exit([&] { CertFreeCertificateChain(chain_context); });
  9429. // Verify SSL policy
  9430. SSL_EXTRA_CERT_CHAIN_POLICY_PARA extra_policy_para = {};
  9431. extra_policy_para.cbSize = sizeof(extra_policy_para);
  9432. #ifdef AUTHTYPE_SERVER
  9433. extra_policy_para.dwAuthType = AUTHTYPE_SERVER;
  9434. #endif
  9435. std::wstring whost;
  9436. if (verify_hostname) {
  9437. whost = u8string_to_wstring(hostname.c_str());
  9438. extra_policy_para.pwszServerName = const_cast<wchar_t *>(whost.c_str());
  9439. }
  9440. CERT_CHAIN_POLICY_PARA policy_para = {};
  9441. policy_para.cbSize = sizeof(policy_para);
  9442. #ifdef CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS
  9443. policy_para.dwFlags = CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS;
  9444. #else
  9445. policy_para.dwFlags = 0;
  9446. #endif
  9447. policy_para.pvExtraPolicyPara = &extra_policy_para;
  9448. CERT_CHAIN_POLICY_STATUS policy_status = {};
  9449. policy_status.cbSize = sizeof(policy_status);
  9450. if (!CertVerifyCertificateChainPolicy(CERT_CHAIN_POLICY_SSL, chain_context,
  9451. &policy_para, &policy_status)) {
  9452. out_error = GetLastError();
  9453. return false;
  9454. }
  9455. if (policy_status.dwError != 0) {
  9456. out_error = policy_status.dwError;
  9457. return false;
  9458. }
  9459. return true;
  9460. }
  9461. #endif // _WIN32
  9462. // Loads CA file/dir configuration and applies the system CA policy to a
  9463. // client TLS context. PEM data and native stores are applied to the context
  9464. // directly at set time; has_custom_store reflects them for the Auto policy
  9465. // decision.
  9466. inline bool load_client_ca_config(tls::ctx_t ctx,
  9467. const std::string &ca_cert_file_path,
  9468. const std::string &ca_cert_dir_path,
  9469. bool has_custom_store, SystemCAMode mode,
  9470. uint64_t &backend_error) {
  9471. auto ret = true;
  9472. if (!ca_cert_file_path.empty()) {
  9473. if (!tls::load_ca_file(ctx, ca_cert_file_path.c_str())) {
  9474. backend_error = tls::get_error();
  9475. ret = false;
  9476. }
  9477. } else if (!ca_cert_dir_path.empty()) {
  9478. if (!tls::load_ca_dir(ctx, ca_cert_dir_path.c_str())) {
  9479. backend_error = tls::get_error();
  9480. ret = false;
  9481. }
  9482. }
  9483. auto has_custom_ca = !ca_cert_file_path.empty() ||
  9484. !ca_cert_dir_path.empty() || has_custom_store;
  9485. if (mode == SystemCAMode::Enabled ||
  9486. (mode == SystemCAMode::Auto && !has_custom_ca)) {
  9487. if (!tls::load_system_certs(ctx)) { backend_error = tls::get_error(); }
  9488. }
  9489. return ret;
  9490. }
  9491. // Serializes the CA certificates installed in ctx as PEM, so they can be
  9492. // loaded into another context.
  9493. inline std::string ca_certs_to_pem(tls::ctx_t ctx) {
  9494. std::string pem;
  9495. std::vector<tls::cert_t> certs;
  9496. tls::get_ca_certs(ctx, certs);
  9497. for (auto cert : certs) {
  9498. std::vector<unsigned char> der;
  9499. if (tls::get_cert_der(cert, der)) {
  9500. auto b64 = base64_encode(std::string(der.begin(), der.end()));
  9501. pem += "-----BEGIN CERTIFICATE-----\n";
  9502. for (size_t i = 0; i < b64.size(); i += 64) {
  9503. pem += b64.substr(i, 64);
  9504. pem += '\n';
  9505. }
  9506. pem += "-----END CERTIFICATE-----\n";
  9507. }
  9508. tls::free_cert(cert);
  9509. }
  9510. return pem;
  9511. }
  9512. // Returns a PemMemory field as a NUL-terminated string: its first len bytes,
  9513. // copied to buf, or pem itself when len is 0.
  9514. inline const char *pem_c_str(const char *pem, size_t len, std::string &buf) {
  9515. if (!pem || len == 0) { return pem; }
  9516. buf.assign(pem, len);
  9517. return buf.c_str();
  9518. }
  9519. // The parts of session setup that only SSLClient needs, plus the handful
  9520. // WebSocketClient also exposes; everything else takes the defaults, which is
  9521. // what keeps the two clients on one implementation.
  9522. struct ClientTlsSessionOptions {
  9523. // Both SSLClient and WebSocketClient expose this independently of
  9524. // certificate verification.
  9525. bool server_hostname_verification = true;
  9526. std::function<SSLVerifierResponse(tls::session_t)> session_verifier;
  9527. // When non-null, guards session creation against concurrent use of the
  9528. // context. A WebSocketClient is not safe to use from several threads to
  9529. // begin with, so it passes nothing.
  9530. std::mutex *ctx_mutex = nullptr;
  9531. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9532. // The caller decides whether Schannel has anything to say about this
  9533. // connection; see SSLClient::initialize_ssl().
  9534. bool windows_cert_verification = false;
  9535. // A server certificate verifier works on the backend's chain verification,
  9536. // so the backend keeps deciding and Schannel only adds its own check.
  9537. bool server_certificate_verifier_set = false;
  9538. #endif
  9539. };
  9540. // Filled in on failure for callers that report error details.
  9541. struct ClientTlsSessionError {
  9542. Error error = Error::Success;
  9543. int ssl_error = 0;
  9544. uint64_t backend_error = 0;
  9545. };
  9546. // Establishes a client TLS session on an already connected socket. On failure
  9547. // the session is left for the caller to free: SSLClient frees it right away,
  9548. // WebSocketClient keeps it in a member that shutdown_and_close() cleans up.
  9549. inline bool setup_client_tls_session(
  9550. const std::string &host, tls::ctx_t ctx, tls::session_t &session,
  9551. socket_t sock, bool server_certificate_verification, time_t timeout_sec,
  9552. time_t timeout_usec, ClientTlsSessionError *out_error = nullptr,
  9553. const ClientTlsSessionOptions &options = ClientTlsSessionOptions()) {
  9554. using namespace tls;
  9555. auto fail = [&](Error error, int ssl_error, uint64_t backend_error) {
  9556. if (out_error) {
  9557. out_error->error = error;
  9558. out_error->ssl_error = ssl_error;
  9559. out_error->backend_error = backend_error;
  9560. }
  9561. return false;
  9562. };
  9563. if (!ctx) {
  9564. session = nullptr;
  9565. return fail(Error::SSLConnection, 0, 0);
  9566. }
  9567. // With Windows verification on and no server certificate verifier set,
  9568. // Schannel is the only chain verifier. The backend's trust store is a
  9569. // snapshot of the Windows stores that lacks the roots Windows fetches on
  9570. // demand, so the backend's verdict is not used.
  9571. auto windows_verifies_chain = false;
  9572. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9573. windows_verifies_chain = options.windows_cert_verification &&
  9574. !options.server_certificate_verifier_set;
  9575. #endif
  9576. {
  9577. std::unique_lock<std::mutex> guard;
  9578. if (options.ctx_mutex) {
  9579. guard = std::unique_lock<std::mutex>(*options.ctx_mutex);
  9580. }
  9581. #if defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9582. // Mbed TLS and wolfSSL need the verification mode set explicitly, on the
  9583. // context, so under the same lock; OpenSSL uses SSL_VERIFY_NONE and does
  9584. // all verification post-handshake. Unless Schannel verifies the chain
  9585. // instead, chain verification happens during the handshake even for IP
  9586. // hosts; the certificate identity is verified post-handshake via
  9587. // verify_hostname().
  9588. set_verify_client(ctx, server_certificate_verification &&
  9589. !windows_verifies_chain);
  9590. #endif
  9591. session = create_session(ctx, sock);
  9592. }
  9593. if (!session) { return fail(Error::SSLConnection, 0, get_error()); }
  9594. // RFC 6066: SNI must not be set for IP addresses; skip it for IP hosts, so
  9595. // their identity is checked post-handshake below instead. On Mbed TLS and
  9596. // wolfSSL, set_sni also drives handshake-time hostname verification, so
  9597. // options.server_hostname_verification is threaded through here.
  9598. if (!is_ip_address(host)) {
  9599. if (!set_sni(session, host.c_str(), options.server_hostname_verification)) {
  9600. return fail(Error::SSLConnection, 0, get_error());
  9601. }
  9602. }
  9603. TlsError tls_err;
  9604. if (!connect_nonblocking(session, sock, timeout_sec, timeout_usec,
  9605. &tls_err)) {
  9606. auto error = Error::SSLConnection;
  9607. if (tls_err.code == ErrorCode::CertVerifyFailed) {
  9608. error = Error::SSLServerVerification;
  9609. } else if (tls_err.code == ErrorCode::HostnameMismatch) {
  9610. error = Error::SSLServerHostnameVerification;
  9611. }
  9612. return fail(error, static_cast<int>(tls_err.code), tls_err.backend_code);
  9613. }
  9614. auto verification_status = SSLVerifierResponse::NoDecisionMade;
  9615. if (options.session_verifier) {
  9616. verification_status = options.session_verifier(session);
  9617. }
  9618. if (verification_status == SSLVerifierResponse::CertificateRejected) {
  9619. return fail(Error::SSLServerVerification, 0, get_error());
  9620. }
  9621. if (verification_status == SSLVerifierResponse::NoDecisionMade &&
  9622. server_certificate_verification) {
  9623. if (!windows_verifies_chain) {
  9624. auto verify_result = get_verify_result(session);
  9625. if (verify_result != 0) {
  9626. return fail(Error::SSLServerVerification, 0,
  9627. static_cast<uint64_t>(verify_result));
  9628. }
  9629. }
  9630. auto server_cert = get_peer_cert(session);
  9631. if (!server_cert) {
  9632. return fail(Error::SSLServerVerification, 0, get_error());
  9633. }
  9634. auto cert_guard = detail::scope_exit([&] { free_cert(server_cert); });
  9635. // Identity check against the peer certificate, post-handshake for all
  9636. // backends. For IP hosts this is the only identity verification, since no
  9637. // hostname is bound during the handshake.
  9638. if (options.server_hostname_verification) {
  9639. if (!verify_hostname(server_cert, host.c_str())) {
  9640. return fail(Error::SSLServerHostnameVerification, 0,
  9641. hostname_mismatch_code());
  9642. }
  9643. }
  9644. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9645. // Windows Schannel verification, which lets Windows fetch missing roots
  9646. // and intermediates on demand. It must not be skipped: unless a server
  9647. // certificate verifier is set, it is the only chain check.
  9648. if (options.windows_cert_verification) {
  9649. std::vector<unsigned char> der;
  9650. uint64_t wincrypt_error = 0;
  9651. if (!get_cert_der(server_cert, der) ||
  9652. !verify_cert_with_windows_schannel(
  9653. der, host, options.server_hostname_verification, wincrypt_error,
  9654. session)) {
  9655. return fail(Error::SSLServerVerification, 0, wincrypt_error);
  9656. }
  9657. }
  9658. #endif
  9659. }
  9660. return true;
  9661. }
  9662. } // namespace detail
  9663. #endif // CPPHTTPLIB_SSL_ENABLED
  9664. /*
  9665. * Group 3: httplib namespace - Non-SSL public API implementations
  9666. */
  9667. inline void default_socket_options(socket_t sock) {
  9668. set_socket_opt(sock, SOL_SOCKET,
  9669. #ifdef SO_REUSEPORT
  9670. SO_REUSEPORT,
  9671. #else
  9672. SO_REUSEADDR,
  9673. #endif
  9674. 1);
  9675. }
  9676. inline bool set_socket_opt(socket_t sock, int level, int optname, int optval) {
  9677. return detail::set_socket_opt_impl(sock, level, optname, &optval,
  9678. sizeof(optval));
  9679. }
  9680. inline std::string get_bearer_token_auth(const Request &req) {
  9681. // The auth scheme is case-insensitive (RFC 9110 11.1), and a value shorter
  9682. // than the prefix carries no token.
  9683. constexpr const char bearer_prefix[] = "Bearer ";
  9684. constexpr auto bearer_prefix_len = detail::str_len(bearer_prefix);
  9685. auto value = req.get_header_value("Authorization");
  9686. if (value.size() >= bearer_prefix_len &&
  9687. detail::case_ignore::equal(value.substr(0, bearer_prefix_len),
  9688. bearer_prefix)) {
  9689. return value.substr(bearer_prefix_len);
  9690. }
  9691. return "";
  9692. }
  9693. inline const char *status_message(int status) {
  9694. switch (status) {
  9695. case StatusCode::Continue_100: return "Continue";
  9696. case StatusCode::SwitchingProtocol_101: return "Switching Protocol";
  9697. case StatusCode::Processing_102: return "Processing";
  9698. case StatusCode::EarlyHints_103: return "Early Hints";
  9699. case StatusCode::OK_200: return "OK";
  9700. case StatusCode::Created_201: return "Created";
  9701. case StatusCode::Accepted_202: return "Accepted";
  9702. case StatusCode::NonAuthoritativeInformation_203:
  9703. return "Non-Authoritative Information";
  9704. case StatusCode::NoContent_204: return "No Content";
  9705. case StatusCode::ResetContent_205: return "Reset Content";
  9706. case StatusCode::PartialContent_206: return "Partial Content";
  9707. case StatusCode::MultiStatus_207: return "Multi-Status";
  9708. case StatusCode::AlreadyReported_208: return "Already Reported";
  9709. case StatusCode::IMUsed_226: return "IM Used";
  9710. case StatusCode::MultipleChoices_300: return "Multiple Choices";
  9711. case StatusCode::MovedPermanently_301: return "Moved Permanently";
  9712. case StatusCode::Found_302: return "Found";
  9713. case StatusCode::SeeOther_303: return "See Other";
  9714. case StatusCode::NotModified_304: return "Not Modified";
  9715. case StatusCode::UseProxy_305: return "Use Proxy";
  9716. case StatusCode::unused_306: return "unused";
  9717. case StatusCode::TemporaryRedirect_307: return "Temporary Redirect";
  9718. case StatusCode::PermanentRedirect_308: return "Permanent Redirect";
  9719. case StatusCode::BadRequest_400: return "Bad Request";
  9720. case StatusCode::Unauthorized_401: return "Unauthorized";
  9721. case StatusCode::PaymentRequired_402: return "Payment Required";
  9722. case StatusCode::Forbidden_403: return "Forbidden";
  9723. case StatusCode::NotFound_404: return "Not Found";
  9724. case StatusCode::MethodNotAllowed_405: return "Method Not Allowed";
  9725. case StatusCode::NotAcceptable_406: return "Not Acceptable";
  9726. case StatusCode::ProxyAuthenticationRequired_407:
  9727. return "Proxy Authentication Required";
  9728. case StatusCode::RequestTimeout_408: return "Request Timeout";
  9729. case StatusCode::Conflict_409: return "Conflict";
  9730. case StatusCode::Gone_410: return "Gone";
  9731. case StatusCode::LengthRequired_411: return "Length Required";
  9732. case StatusCode::PreconditionFailed_412: return "Precondition Failed";
  9733. case StatusCode::PayloadTooLarge_413: return "Payload Too Large";
  9734. case StatusCode::UriTooLong_414: return "URI Too Long";
  9735. case StatusCode::UnsupportedMediaType_415: return "Unsupported Media Type";
  9736. case StatusCode::RangeNotSatisfiable_416: return "Range Not Satisfiable";
  9737. case StatusCode::ExpectationFailed_417: return "Expectation Failed";
  9738. case StatusCode::ImATeapot_418: return "I'm a teapot";
  9739. case StatusCode::MisdirectedRequest_421: return "Misdirected Request";
  9740. case StatusCode::UnprocessableContent_422: return "Unprocessable Content";
  9741. case StatusCode::Locked_423: return "Locked";
  9742. case StatusCode::FailedDependency_424: return "Failed Dependency";
  9743. case StatusCode::TooEarly_425: return "Too Early";
  9744. case StatusCode::UpgradeRequired_426: return "Upgrade Required";
  9745. case StatusCode::PreconditionRequired_428: return "Precondition Required";
  9746. case StatusCode::TooManyRequests_429: return "Too Many Requests";
  9747. case StatusCode::RequestHeaderFieldsTooLarge_431:
  9748. return "Request Header Fields Too Large";
  9749. case StatusCode::UnavailableForLegalReasons_451:
  9750. return "Unavailable For Legal Reasons";
  9751. case StatusCode::NotImplemented_501: return "Not Implemented";
  9752. case StatusCode::BadGateway_502: return "Bad Gateway";
  9753. case StatusCode::ServiceUnavailable_503: return "Service Unavailable";
  9754. case StatusCode::GatewayTimeout_504: return "Gateway Timeout";
  9755. case StatusCode::HttpVersionNotSupported_505:
  9756. return "HTTP Version Not Supported";
  9757. case StatusCode::VariantAlsoNegotiates_506: return "Variant Also Negotiates";
  9758. case StatusCode::InsufficientStorage_507: return "Insufficient Storage";
  9759. case StatusCode::LoopDetected_508: return "Loop Detected";
  9760. case StatusCode::NotExtended_510: return "Not Extended";
  9761. case StatusCode::NetworkAuthenticationRequired_511:
  9762. return "Network Authentication Required";
  9763. default:
  9764. case StatusCode::InternalServerError_500: return "Internal Server Error";
  9765. }
  9766. }
  9767. inline std::string to_string(const Error error) {
  9768. switch (error) {
  9769. case Error::Success: return "Success (no error)";
  9770. case Error::Unknown: return "Unknown";
  9771. case Error::Connection: return "Could not establish connection";
  9772. case Error::BindIPAddress: return "Failed to bind IP address";
  9773. case Error::Read: return "Failed to read connection";
  9774. case Error::Write: return "Failed to write connection";
  9775. case Error::ExceedRedirectCount: return "Maximum redirect count exceeded";
  9776. case Error::Canceled: return "Connection handling canceled";
  9777. case Error::SSLConnection: return "SSL connection failed";
  9778. case Error::SSLLoadingCerts: return "SSL certificate loading failed";
  9779. case Error::SSLServerVerification: return "SSL server verification failed";
  9780. case Error::SSLServerHostnameVerification:
  9781. return "SSL server hostname verification failed";
  9782. case Error::UnsupportedMultipartBoundaryChars:
  9783. return "Unsupported HTTP multipart boundary characters";
  9784. case Error::Compression: return "Compression failed";
  9785. case Error::ConnectionTimeout: return "Connection timed out";
  9786. case Error::ProxyConnection: return "Proxy connection failed";
  9787. case Error::ConnectionClosed: return "Connection closed by server";
  9788. case Error::Timeout: return "Read timeout";
  9789. case Error::ResourceExhaustion: return "Resource exhaustion";
  9790. case Error::TooManyFormDataFiles: return "Too many form data files";
  9791. case Error::ExceedMaxPayloadSize: return "Exceeded maximum payload size";
  9792. case Error::ExceedUriMaxLength: return "Exceeded maximum URI length";
  9793. case Error::ExceedMaxSocketDescriptorCount:
  9794. return "Exceeded maximum socket descriptor count";
  9795. case Error::InvalidRequestLine: return "Invalid request line";
  9796. case Error::InvalidHTTPMethod: return "Invalid HTTP method";
  9797. case Error::InvalidHTTPVersion: return "Invalid HTTP version";
  9798. case Error::InvalidHeaders: return "Invalid headers";
  9799. case Error::MultipartParsing: return "Multipart parsing failed";
  9800. case Error::OpenFile: return "Failed to open file";
  9801. case Error::Listen: return "Failed to listen on socket";
  9802. case Error::GetSockName: return "Failed to get socket name";
  9803. case Error::UnsupportedAddressFamily: return "Unsupported address family";
  9804. case Error::HTTPParsing: return "HTTP parsing failed";
  9805. case Error::InvalidRangeHeader: return "Invalid Range header";
  9806. case Error::UnsupportedContentEncoding: return "Unsupported Content-Encoding";
  9807. case Error::WebSocketHandshake: return "WebSocket handshake failed";
  9808. case Error::UserCallbackException: return "User callback threw an exception";
  9809. default: break;
  9810. }
  9811. return "Invalid";
  9812. }
  9813. inline std::ostream &operator<<(std::ostream &os, const Error &obj) {
  9814. os << to_string(obj);
  9815. os << " (" << static_cast<std::underlying_type<Error>::type>(obj) << ')';
  9816. return os;
  9817. }
  9818. inline std::string hosted_at(const std::string &hostname) {
  9819. std::vector<std::string> addrs;
  9820. hosted_at(hostname, addrs);
  9821. if (addrs.empty()) { return std::string(); }
  9822. return addrs[0];
  9823. }
  9824. inline void hosted_at(const std::string &hostname,
  9825. std::vector<std::string> &addrs) {
  9826. struct addrinfo hints;
  9827. struct addrinfo *result;
  9828. memset(&hints, 0, sizeof(struct addrinfo));
  9829. hints.ai_family = AF_UNSPEC;
  9830. hints.ai_socktype = SOCK_STREAM;
  9831. hints.ai_protocol = 0;
  9832. if (detail::getaddrinfo_with_timeout(hostname.c_str(), nullptr, &hints,
  9833. &result, 0)) {
  9834. #if defined __linux__ && !defined __ANDROID__
  9835. res_init();
  9836. #endif
  9837. return;
  9838. }
  9839. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  9840. for (auto rp = result; rp; rp = rp->ai_next) {
  9841. const auto &addr =
  9842. *reinterpret_cast<struct sockaddr_storage *>(rp->ai_addr);
  9843. std::string ip;
  9844. auto dummy = -1;
  9845. if (detail::get_ip_and_port(addr, sizeof(struct sockaddr_storage), ip,
  9846. dummy)) {
  9847. addrs.emplace_back(std::move(ip));
  9848. }
  9849. }
  9850. }
  9851. inline std::string encode_uri_component(const std::string &value) {
  9852. std::ostringstream escaped;
  9853. escaped.fill('0');
  9854. escaped << std::hex;
  9855. for (auto c : value) {
  9856. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9857. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')') {
  9858. escaped << c;
  9859. } else {
  9860. escaped << std::uppercase;
  9861. escaped << '%' << std::setw(2)
  9862. << static_cast<int>(static_cast<unsigned char>(c));
  9863. escaped << std::nouppercase;
  9864. }
  9865. }
  9866. return escaped.str();
  9867. }
  9868. inline std::string encode_uri(const std::string &value) {
  9869. std::ostringstream escaped;
  9870. escaped.fill('0');
  9871. escaped << std::hex;
  9872. for (auto c : value) {
  9873. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9874. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')' ||
  9875. c == ';' || c == '/' || c == '?' || c == ':' || c == '@' || c == '&' ||
  9876. c == '=' || c == '+' || c == '$' || c == ',' || c == '#') {
  9877. escaped << c;
  9878. } else {
  9879. escaped << std::uppercase;
  9880. escaped << '%' << std::setw(2)
  9881. << static_cast<int>(static_cast<unsigned char>(c));
  9882. escaped << std::nouppercase;
  9883. }
  9884. }
  9885. return escaped.str();
  9886. }
  9887. inline std::string decode_uri_component(const std::string &value) {
  9888. std::string result;
  9889. for (size_t i = 0; i < value.size(); i++) {
  9890. if (value[i] == '%' && i + 2 < value.size()) {
  9891. auto val = 0;
  9892. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9893. result += static_cast<char>(val);
  9894. i += 2;
  9895. } else {
  9896. result += value[i];
  9897. }
  9898. } else {
  9899. result += value[i];
  9900. }
  9901. }
  9902. return result;
  9903. }
  9904. inline std::string decode_uri(const std::string &value) {
  9905. std::string result;
  9906. for (size_t i = 0; i < value.size(); i++) {
  9907. if (value[i] == '%' && i + 2 < value.size()) {
  9908. auto val = 0;
  9909. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9910. auto c = static_cast<char>(val);
  9911. // Keep escapes of the reserved characters that encode_uri leaves
  9912. // literal, so decode_uri is the inverse of encode_uri and an escaped
  9913. // delimiter is not promoted into a real one (as with JS decodeURI).
  9914. if (c == ';' || c == '/' || c == '?' || c == ':' || c == '@' ||
  9915. c == '&' || c == '=' || c == '+' || c == '$' || c == ',' ||
  9916. c == '#') {
  9917. result += value[i];
  9918. result += value[i + 1];
  9919. result += value[i + 2];
  9920. } else {
  9921. result += c;
  9922. }
  9923. i += 2;
  9924. } else {
  9925. result += value[i];
  9926. }
  9927. } else {
  9928. result += value[i];
  9929. }
  9930. }
  9931. return result;
  9932. }
  9933. inline std::string encode_path_component(const std::string &component) {
  9934. std::string result;
  9935. result.reserve(component.size() * 3);
  9936. for (size_t i = 0; i < component.size(); i++) {
  9937. auto c = static_cast<unsigned char>(component[i]);
  9938. // Unreserved characters per RFC 3986: ALPHA / DIGIT / "-" / "." / "_" / "~"
  9939. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9940. c == '_' || c == '~') {
  9941. result += static_cast<char>(c);
  9942. }
  9943. // Path-safe sub-delimiters: "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" /
  9944. // "," / ";" / "="
  9945. else if (c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  9946. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  9947. c == '=') {
  9948. result += static_cast<char>(c);
  9949. }
  9950. // Colon is allowed in path segments except first segment
  9951. else if (c == ':') {
  9952. result += static_cast<char>(c);
  9953. }
  9954. // @ is allowed in path
  9955. else if (c == '@') {
  9956. result += static_cast<char>(c);
  9957. } else {
  9958. result += '%';
  9959. char hex[3];
  9960. snprintf(hex, sizeof(hex), "%02X", c);
  9961. result.append(hex, 2);
  9962. }
  9963. }
  9964. return result;
  9965. }
  9966. inline std::string decode_path_component(const std::string &component) {
  9967. std::string result;
  9968. result.reserve(component.size());
  9969. for (size_t i = 0; i < component.size(); i++) {
  9970. if (component[i] == '%' && i + 1 < component.size()) {
  9971. if (component[i + 1] == 'u') {
  9972. // Unicode %uXXXX encoding
  9973. auto val = 0;
  9974. // 4 digits Unicode codes: val is 0x0000-0xFFFF (from 4 hex digits),
  9975. // so to_utf8 writes at most 3 bytes. buff[4] is safe.
  9976. char buff[4];
  9977. size_t len = 0;
  9978. if (detail::from_hex_to_i(component, i + 2, 4, val) &&
  9979. (len = detail::to_utf8(val, buff)) > 0) {
  9980. result.append(buff, len);
  9981. i += 5; // 'u0000'
  9982. } else {
  9983. // Not 4 hex digits, or a surrogate, which is no character: the
  9984. // escape is kept as it is rather than joining its neighbours
  9985. result += component[i];
  9986. }
  9987. } else {
  9988. // Standard %XX encoding
  9989. auto val = 0;
  9990. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9991. // 2 digits hex codes
  9992. result += static_cast<char>(val);
  9993. i += 2; // 'XX'
  9994. } else {
  9995. result += component[i];
  9996. }
  9997. }
  9998. } else {
  9999. result += component[i];
  10000. }
  10001. }
  10002. return result;
  10003. }
  10004. inline std::string encode_query_component(const std::string &component,
  10005. bool space_as_plus) {
  10006. std::string result;
  10007. result.reserve(component.size() * 3);
  10008. for (size_t i = 0; i < component.size(); i++) {
  10009. auto c = static_cast<unsigned char>(component[i]);
  10010. // Unreserved characters per RFC 3986
  10011. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  10012. c == '_' || c == '~') {
  10013. result += static_cast<char>(c);
  10014. }
  10015. // Space handling
  10016. else if (c == ' ') {
  10017. if (space_as_plus) {
  10018. result += '+';
  10019. } else {
  10020. result += "%20";
  10021. }
  10022. }
  10023. // Plus sign handling
  10024. else if (c == '+') {
  10025. if (space_as_plus) {
  10026. result += "%2B";
  10027. } else {
  10028. result += static_cast<char>(c);
  10029. }
  10030. }
  10031. // Query-safe sub-delimiters (excluding & and = which are query delimiters)
  10032. else if (c == '!' || c == '$' || c == '\'' || c == '(' || c == ')' ||
  10033. c == '*' || c == ',' || c == ';') {
  10034. result += static_cast<char>(c);
  10035. }
  10036. // Colon and @ are allowed in query
  10037. else if (c == ':' || c == '@') {
  10038. result += static_cast<char>(c);
  10039. }
  10040. // Forward slash is allowed in query values
  10041. else if (c == '/') {
  10042. result += static_cast<char>(c);
  10043. }
  10044. // Question mark is allowed in query values (after first ?)
  10045. else if (c == '?') {
  10046. result += static_cast<char>(c);
  10047. } else {
  10048. result += '%';
  10049. char hex[3];
  10050. snprintf(hex, sizeof(hex), "%02X", c);
  10051. result.append(hex, 2);
  10052. }
  10053. }
  10054. return result;
  10055. }
  10056. inline std::string decode_query_component(const std::string &component,
  10057. bool plus_as_space) {
  10058. std::string result;
  10059. result.reserve(component.size());
  10060. for (size_t i = 0; i < component.size(); i++) {
  10061. if (component[i] == '%' && i + 2 < component.size()) {
  10062. auto val = 0;
  10063. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  10064. result += static_cast<char>(val);
  10065. i += 2;
  10066. } else {
  10067. result += component[i];
  10068. }
  10069. } else if (component[i] == '+' && plus_as_space) {
  10070. result += ' '; // + becomes space in form-urlencoded
  10071. } else {
  10072. result += component[i];
  10073. }
  10074. }
  10075. return result;
  10076. }
  10077. inline std::string sanitize_filename(const std::string &filename) {
  10078. // Extract basename: find the last path separator (/ or \)
  10079. auto pos = filename.find_last_of("/\\");
  10080. auto result =
  10081. (pos != std::string::npos) ? filename.substr(pos + 1) : filename;
  10082. // Strip null bytes
  10083. result.erase(std::remove(result.begin(), result.end(), '\0'), result.end());
  10084. // Trim whitespace
  10085. {
  10086. auto start = result.find_first_not_of(" \t");
  10087. auto end = result.find_last_not_of(" \t");
  10088. result = (start == std::string::npos)
  10089. ? ""
  10090. : result.substr(start, end - start + 1);
  10091. }
  10092. // Reject . and ..
  10093. if (result == "." || result == "..") { return ""; }
  10094. return result;
  10095. }
  10096. inline std::string append_query_params(const std::string &path,
  10097. const Params &params) {
  10098. // The query ends at the fragment (RFC 3986 3.5), so the params go before it.
  10099. auto fragment_pos = path.find('#');
  10100. auto path_with_query = path.substr(0, fragment_pos);
  10101. path_with_query += path_with_query.find('?') == std::string::npos ? '?' : '&';
  10102. path_with_query += detail::params_to_query_str(params);
  10103. if (fragment_pos != std::string::npos) {
  10104. path_with_query.append(path, fragment_pos, std::string::npos);
  10105. }
  10106. return path_with_query;
  10107. }
  10108. // Header utilities
  10109. inline std::pair<std::string, std::string>
  10110. make_range_header(const Ranges &ranges) {
  10111. std::string field = "bytes=";
  10112. auto i = 0;
  10113. for (const auto &r : ranges) {
  10114. if (i != 0) { field += ", "; }
  10115. if (r.first != -1) { field += std::to_string(r.first); }
  10116. field += '-';
  10117. if (r.second != -1) { field += std::to_string(r.second); }
  10118. i++;
  10119. }
  10120. return std::make_pair("Range", std::move(field));
  10121. }
  10122. inline std::pair<std::string, std::string>
  10123. make_basic_authentication_header(const std::string &username,
  10124. const std::string &password, bool is_proxy) {
  10125. auto field = "Basic " + detail::base64_encode(username + ":" + password);
  10126. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  10127. return std::make_pair(key, std::move(field));
  10128. }
  10129. inline std::pair<std::string, std::string>
  10130. make_bearer_token_authentication_header(const std::string &token,
  10131. bool is_proxy = false) {
  10132. auto field = "Bearer " + token;
  10133. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  10134. return std::make_pair(key, std::move(field));
  10135. }
  10136. namespace detail {
  10137. // Basic auth when a username or password is set, otherwise a bearer token,
  10138. // unless the request already carries the header.
  10139. inline void add_authorization_header(Request &req, const std::string &username,
  10140. const std::string &password,
  10141. const std::string &token, bool is_proxy) {
  10142. if (req.has_header(is_proxy ? "Proxy-Authorization" : "Authorization")) {
  10143. return;
  10144. }
  10145. if (!username.empty() || !password.empty()) {
  10146. req.headers.insert(
  10147. make_basic_authentication_header(username, password, is_proxy));
  10148. } else if (!token.empty()) {
  10149. req.headers.insert(
  10150. make_bearer_token_authentication_header(token, is_proxy));
  10151. }
  10152. }
  10153. } // namespace detail
  10154. // Request implementation
  10155. inline size_t Request::get_header_value_u64(const std::string &key, size_t def,
  10156. size_t id) const {
  10157. return detail::get_header_value_u64(headers, key, def, id);
  10158. }
  10159. inline bool Request::has_header(const std::string &key) const {
  10160. return detail::has_header(headers, key);
  10161. }
  10162. inline std::string Request::get_header_value(const std::string &key,
  10163. const char *def, size_t id) const {
  10164. return detail::get_header_value(headers, key, def, id);
  10165. }
  10166. inline size_t Request::get_header_value_count(const std::string &key) const {
  10167. return detail::get_header_value_count(headers, key);
  10168. }
  10169. inline void Request::set_header(const std::string &key,
  10170. const std::string &val) {
  10171. detail::set_header(headers, key, val);
  10172. }
  10173. inline bool Request::has_trailer(const std::string &key) const {
  10174. return trailers.find(key) != trailers.end();
  10175. }
  10176. inline std::string Request::get_trailer_value(const std::string &key,
  10177. size_t id) const {
  10178. return detail::get_multimap_value(trailers, key, id);
  10179. }
  10180. inline size_t Request::get_trailer_value_count(const std::string &key) const {
  10181. return trailers.count(key);
  10182. }
  10183. inline bool Request::has_param(const std::string &key) const {
  10184. return params.find(key) != params.end();
  10185. }
  10186. inline std::string Request::get_param_value(const std::string &key,
  10187. size_t id) const {
  10188. return detail::get_multimap_value(params, key, id);
  10189. }
  10190. inline std::vector<std::string>
  10191. Request::get_param_values(const std::string &key) const {
  10192. auto rng = params.equal_range(key);
  10193. std::vector<std::string> values;
  10194. values.reserve(static_cast<size_t>(std::distance(rng.first, rng.second)));
  10195. for (auto it = rng.first; it != rng.second; ++it) {
  10196. values.push_back(it->second);
  10197. }
  10198. return values;
  10199. }
  10200. inline size_t Request::get_param_value_count(const std::string &key) const {
  10201. return params.count(key);
  10202. }
  10203. inline bool Request::is_multipart_form_data() const {
  10204. const auto &content_type = get_header_value("Content-Type");
  10205. return detail::case_ignore::equal(detail::extract_media_type(content_type),
  10206. "multipart/form-data");
  10207. }
  10208. // Multipart FormData implementation
  10209. inline std::string MultipartFormData::get_field(const std::string &key,
  10210. size_t id) const {
  10211. auto rng = fields.equal_range(key);
  10212. auto it = detail::bounded_next(rng.first, id, rng.second);
  10213. if (it != rng.second) { return it->second.content; }
  10214. return std::string();
  10215. }
  10216. inline std::vector<std::string>
  10217. MultipartFormData::get_fields(const std::string &key) const {
  10218. std::vector<std::string> values;
  10219. auto rng = fields.equal_range(key);
  10220. for (auto it = rng.first; it != rng.second; it++) {
  10221. values.push_back(it->second.content);
  10222. }
  10223. return values;
  10224. }
  10225. inline bool MultipartFormData::has_field(const std::string &key) const {
  10226. return fields.find(key) != fields.end();
  10227. }
  10228. inline size_t MultipartFormData::get_field_count(const std::string &key) const {
  10229. return fields.count(key);
  10230. }
  10231. inline FormData MultipartFormData::get_file(const std::string &key,
  10232. size_t id) const {
  10233. return detail::get_multimap_value(files, key, id);
  10234. }
  10235. inline std::vector<FormData>
  10236. MultipartFormData::get_files(const std::string &key) const {
  10237. std::vector<FormData> values;
  10238. auto rng = files.equal_range(key);
  10239. for (auto it = rng.first; it != rng.second; it++) {
  10240. values.push_back(it->second);
  10241. }
  10242. return values;
  10243. }
  10244. inline bool MultipartFormData::has_file(const std::string &key) const {
  10245. return files.find(key) != files.end();
  10246. }
  10247. inline size_t MultipartFormData::get_file_count(const std::string &key) const {
  10248. return files.count(key);
  10249. }
  10250. // Multipart FormData writer implementation
  10251. inline bool is_valid_multipart_boundary(const std::string &boundary) {
  10252. return detail::is_multipart_boundary_chars_valid(boundary);
  10253. }
  10254. inline MultipartFormDataWriter::MultipartFormDataWriter()
  10255. : boundary_(detail::make_multipart_data_boundary()) {}
  10256. inline MultipartFormDataWriter::MultipartFormDataWriter(std::string boundary)
  10257. : boundary_(std::move(boundary)) {}
  10258. inline const std::string &MultipartFormDataWriter::boundary() const {
  10259. return boundary_;
  10260. }
  10261. inline std::string MultipartFormDataWriter::content_type() const {
  10262. return detail::serialize_multipart_formdata_get_content_type(boundary_);
  10263. }
  10264. inline std::string
  10265. MultipartFormDataWriter::serialize(const UploadFormDataItems &items) const {
  10266. return detail::serialize_multipart_formdata(items, boundary_);
  10267. }
  10268. inline size_t MultipartFormDataWriter::content_length(
  10269. const UploadFormDataItems &items) const {
  10270. return detail::get_multipart_content_length(items, boundary_);
  10271. }
  10272. inline std::string
  10273. MultipartFormDataWriter::item_begin(const UploadFormData &item) const {
  10274. return detail::serialize_multipart_formdata_item_begin(item, boundary_);
  10275. }
  10276. inline std::string MultipartFormDataWriter::item_end() {
  10277. return detail::serialize_multipart_formdata_item_end();
  10278. }
  10279. inline std::string MultipartFormDataWriter::finish() const {
  10280. return detail::serialize_multipart_formdata_finish(boundary_);
  10281. }
  10282. // Response implementation
  10283. namespace detail {
  10284. // A response has one content source: `body`, a content provider, or a file.
  10285. // Each content setter calls this so that the one called last wins.
  10286. inline void clear_content_provider(Response &res) {
  10287. auto releaser = std::move(res.content_provider_resource_releaser_);
  10288. auto success = res.content_provider_success_;
  10289. res.content_length_ = 0;
  10290. res.content_provider_ = nullptr;
  10291. res.content_provider_resource_releaser_ = nullptr;
  10292. res.is_chunked_content_provider_ = false;
  10293. res.is_file_content_provider_ = false;
  10294. res.content_provider_success_ = false;
  10295. res.content_coding_ = EncodingType::None;
  10296. res.file_content_path_.clear();
  10297. res.file_content_content_type_.clear();
  10298. if (releaser) { releaser(success); }
  10299. }
  10300. inline void clear_content(Response &res) {
  10301. res.body.clear();
  10302. clear_content_provider(res);
  10303. }
  10304. // The Content-Type of the old content goes with it.
  10305. inline void set_content_type(Response &res, const std::string &content_type) {
  10306. res.headers.erase("Content-Type");
  10307. res.set_header("Content-Type", content_type);
  10308. }
  10309. // `body` is public, so it can be assigned directly after a provider or a file
  10310. // was set. It came last, so it wins.
  10311. inline void prefer_assigned_body(Response &res) {
  10312. if (!res.body.empty() &&
  10313. (res.content_provider_ || !res.file_content_path_.empty())) {
  10314. clear_content_provider(res);
  10315. }
  10316. }
  10317. // RFC 9112 6.3: a 1xx, 204 or 304 response ends with its header section.
  10318. inline bool body_allowed_for_status(int status) {
  10319. return status >= 200 && status != StatusCode::NoContent_204 &&
  10320. status != StatusCode::NotModified_304;
  10321. }
  10322. // Only a 206 response is served as a partial representation. range_error()
  10323. // validates `req.ranges` only for a 2xx status, so slicing under any other
  10324. // status would start from an unchecked offset.
  10325. inline bool is_partial_content(const Request &req, const Response &res) {
  10326. return !req.ranges.empty() && res.status == StatusCode::PartialContent_206;
  10327. }
  10328. // Sets the Content-Length or Transfer-Encoding framing the body that
  10329. // Server::write_response_core() writes, or closes the connection after a body
  10330. // that has neither. Only the library sets them: one from a handler would go
  10331. // out next to it, or describe some other body.
  10332. inline void set_framing_headers(const Request &req, Response &res,
  10333. const std::string &boundary,
  10334. const std::string &content_type) {
  10335. // A HEAD response may give the length a GET would have had (RFC 9110 9.3.2).
  10336. auto head_length = req.method == "HEAD"
  10337. ? res.get_header_value("Content-Length")
  10338. : std::string();
  10339. res.headers.erase("Content-Length");
  10340. res.headers.erase("Transfer-Encoding");
  10341. if (!body_allowed_for_status(res.status)) { return; }
  10342. if (res.content_provider_) {
  10343. if (res.content_length_ == 0) {
  10344. if (res.is_chunked_content_provider_) {
  10345. res.set_header("Transfer-Encoding", "chunked");
  10346. } else if (req.method != "HEAD") {
  10347. // RFC 9112 6.3: a body with neither ends where the connection does.
  10348. res.headers.erase("Keep-Alive");
  10349. if (!has_header_token(res.headers, "Connection", "close")) {
  10350. res.set_header("Connection", "close");
  10351. }
  10352. }
  10353. return;
  10354. }
  10355. // The part Server::write_content_with_provider() writes.
  10356. auto length = res.content_length_;
  10357. if (is_partial_content(req, res)) {
  10358. length = req.ranges.size() == 1
  10359. ? get_range_offset_and_length(req.ranges[0], length).second
  10360. : get_multipart_ranges_data_length(req, boundary,
  10361. content_type, length);
  10362. }
  10363. res.set_header("Content-Length", std::to_string(length));
  10364. } else if (!res.body.empty()) {
  10365. res.set_header("Content-Length", std::to_string(res.body.size()));
  10366. } else {
  10367. res.set_header("Content-Length", head_length.empty() ? "0" : head_length);
  10368. }
  10369. }
  10370. } // namespace detail
  10371. inline size_t Response::get_header_value_u64(const std::string &key, size_t def,
  10372. size_t id) const {
  10373. return detail::get_header_value_u64(headers, key, def, id);
  10374. }
  10375. inline bool Response::has_header(const std::string &key) const {
  10376. return headers.find(key) != headers.end();
  10377. }
  10378. inline std::string Response::get_header_value(const std::string &key,
  10379. const char *def,
  10380. size_t id) const {
  10381. return detail::get_header_value(headers, key, def, id);
  10382. }
  10383. inline size_t Response::get_header_value_count(const std::string &key) const {
  10384. return detail::get_header_value_count(headers, key);
  10385. }
  10386. inline void Response::set_header(const std::string &key,
  10387. const std::string &val) {
  10388. detail::set_header(headers, key, val);
  10389. }
  10390. inline bool Response::has_trailer(const std::string &key) const {
  10391. return trailers.find(key) != trailers.end();
  10392. }
  10393. inline std::string Response::get_trailer_value(const std::string &key,
  10394. size_t id) const {
  10395. return detail::get_multimap_value(trailers, key, id);
  10396. }
  10397. inline size_t Response::get_trailer_value_count(const std::string &key) const {
  10398. return trailers.count(key);
  10399. }
  10400. inline void Response::set_redirect(const std::string &url, int stat) {
  10401. if (detail::fields::is_field_value(url)) {
  10402. set_header("Location", url);
  10403. if (300 <= stat && stat < 400) {
  10404. this->status = stat;
  10405. } else {
  10406. this->status = StatusCode::Found_302;
  10407. }
  10408. }
  10409. }
  10410. inline void Response::set_content(const char *s, size_t n,
  10411. const std::string &content_type) {
  10412. body.assign(s, n); // Before the releaser runs; it may own `s`.
  10413. detail::clear_content_provider(*this);
  10414. detail::set_content_type(*this, content_type);
  10415. }
  10416. inline void Response::set_content(const std::string &s,
  10417. const std::string &content_type) {
  10418. set_content(s.data(), s.size(), content_type);
  10419. }
  10420. inline void Response::set_content(std::string &&s,
  10421. const std::string &content_type) {
  10422. body = std::move(s);
  10423. detail::clear_content_provider(*this);
  10424. detail::set_content_type(*this, content_type);
  10425. }
  10426. inline void Response::set_content_provider(
  10427. size_t in_length, const std::string &content_type, ContentProvider provider,
  10428. ContentProviderResourceReleaser resource_releaser) {
  10429. detail::clear_content(*this);
  10430. detail::set_content_type(*this, content_type);
  10431. content_length_ = in_length;
  10432. if (in_length > 0) { content_provider_ = std::move(provider); }
  10433. content_provider_resource_releaser_ = std::move(resource_releaser);
  10434. }
  10435. inline void Response::set_content_provider(
  10436. const std::string &content_type, ContentProviderWithoutLength provider,
  10437. ContentProviderResourceReleaser resource_releaser) {
  10438. detail::clear_content(*this);
  10439. detail::set_content_type(*this, content_type);
  10440. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  10441. content_provider_resource_releaser_ = std::move(resource_releaser);
  10442. }
  10443. inline void Response::set_chunked_content_provider(
  10444. const std::string &content_type, ContentProviderWithoutLength provider,
  10445. ContentProviderResourceReleaser resource_releaser) {
  10446. set_content_provider(content_type, std::move(provider),
  10447. std::move(resource_releaser));
  10448. is_chunked_content_provider_ = true;
  10449. }
  10450. inline void Response::set_file_content(const std::string &path,
  10451. const std::string &content_type) {
  10452. detail::clear_content(*this);
  10453. headers.erase("Content-Type");
  10454. file_content_path_ = path;
  10455. file_content_content_type_ = content_type;
  10456. }
  10457. inline void Response::set_file_content(const std::string &path) {
  10458. set_file_content(path, std::string());
  10459. }
  10460. // Result implementation
  10461. inline size_t Result::get_request_header_value_u64(const std::string &key,
  10462. size_t def,
  10463. size_t id) const {
  10464. return detail::get_header_value_u64(request_headers_, key, def, id);
  10465. }
  10466. inline bool Result::has_request_header(const std::string &key) const {
  10467. return request_headers_.find(key) != request_headers_.end();
  10468. }
  10469. inline std::string Result::get_request_header_value(const std::string &key,
  10470. const char *def,
  10471. size_t id) const {
  10472. return detail::get_header_value(request_headers_, key, def, id);
  10473. }
  10474. inline size_t
  10475. Result::get_request_header_value_count(const std::string &key) const {
  10476. return request_headers_.count(key);
  10477. }
  10478. // Stream implementation
  10479. inline ssize_t Stream::write(const char *ptr) {
  10480. return write(ptr, strlen(ptr));
  10481. }
  10482. inline ssize_t Stream::write(const std::string &s) {
  10483. return write(s.data(), s.size());
  10484. }
  10485. // BodyReader implementation
  10486. inline ssize_t detail::BodyReader::read(char *buf, size_t len) {
  10487. if (!stream) {
  10488. last_error = Error::Connection;
  10489. return -1;
  10490. }
  10491. if (eof) { return 0; }
  10492. if (!chunked) {
  10493. // Content-Length based reading
  10494. if (has_content_length && bytes_read >= content_length) {
  10495. eof = true;
  10496. return 0;
  10497. }
  10498. auto to_read = len;
  10499. if (has_content_length) {
  10500. auto remaining = content_length - bytes_read;
  10501. to_read = (std::min)(len, remaining);
  10502. }
  10503. auto n = stream->read(buf, to_read);
  10504. // Without Content-Length the body ends when the connection closes
  10505. // (RFC 9112 §6.3); with one, an EOF here came too early
  10506. if (n < 0 || (n == 0 && has_content_length)) {
  10507. last_error = stream->get_error();
  10508. if (last_error == Error::Success) { last_error = Error::Read; }
  10509. }
  10510. if (n <= 0) {
  10511. eof = true;
  10512. return n;
  10513. }
  10514. bytes_read += static_cast<size_t>(n);
  10515. if (has_content_length && bytes_read >= content_length) { eof = true; }
  10516. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10517. last_error = Error::ExceedMaxPayloadSize;
  10518. eof = true;
  10519. return -1;
  10520. }
  10521. return n;
  10522. }
  10523. // Chunked transfer encoding: delegate to shared decoder instance.
  10524. if (!chunked_decoder) { chunked_decoder.reset(new ChunkedDecoder(*stream)); }
  10525. size_t chunk_offset = 0;
  10526. size_t chunk_total = 0;
  10527. auto n = chunked_decoder->read_payload(buf, len, chunk_offset, chunk_total);
  10528. if (n < 0) {
  10529. last_error = stream->get_error();
  10530. if (last_error == Error::Success) { last_error = Error::Read; }
  10531. eof = true;
  10532. return n;
  10533. }
  10534. if (n == 0) {
  10535. // Final chunk observed. Leave trailer parsing to the caller (StreamHandle).
  10536. eof = true;
  10537. return 0;
  10538. }
  10539. bytes_read += static_cast<size_t>(n);
  10540. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10541. last_error = Error::ExceedMaxPayloadSize;
  10542. eof = true;
  10543. return -1;
  10544. }
  10545. return n;
  10546. }
  10547. // ThreadPool implementation
  10548. inline ThreadPool::ThreadPool(size_t n, size_t max_n, size_t mqr,
  10549. time_t idle_timeout_sec)
  10550. : base_thread_count_(n), max_queued_requests_(mqr),
  10551. idle_timeout_sec_(idle_timeout_sec), idle_thread_count_(0),
  10552. shutdown_(false) {
  10553. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10554. if (max_n != 0 && max_n < n) {
  10555. std::string msg = "max_threads must be >= base_threads";
  10556. throw std::invalid_argument(msg);
  10557. }
  10558. #endif
  10559. max_thread_count_ = max_n == 0 ? n : max_n;
  10560. threads_.reserve(base_thread_count_);
  10561. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10562. try {
  10563. #endif
  10564. for (size_t i = 0; i < base_thread_count_; i++) {
  10565. threads_.emplace_back(std::thread([this]() { worker(false); }));
  10566. }
  10567. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10568. } catch (...) {
  10569. // If thread creation fails partway (e.g., pthread_create returns EAGAIN),
  10570. // signal the workers we already spawned to exit and join them so the
  10571. // vector destructor does not see joinable threads (which would call
  10572. // std::terminate). Then rethrow so the caller learns of the failure.
  10573. {
  10574. std::unique_lock<std::mutex> lock(mutex_);
  10575. shutdown_ = true;
  10576. }
  10577. cond_.notify_all();
  10578. for (auto &t : threads_) {
  10579. if (t.joinable()) { t.join(); }
  10580. }
  10581. throw;
  10582. }
  10583. #endif
  10584. }
  10585. inline bool ThreadPool::enqueue(std::function<void()> fn) {
  10586. {
  10587. std::unique_lock<std::mutex> lock(mutex_);
  10588. if (shutdown_) { return false; }
  10589. if (max_queued_requests_ > 0 && jobs_.size() >= max_queued_requests_) {
  10590. return false;
  10591. }
  10592. jobs_.push_back(std::move(fn));
  10593. // Spawn a dynamic thread if jobs outnumber idle threads and under max
  10594. if (jobs_.size() > idle_thread_count_ &&
  10595. threads_.size() + dynamic_threads_.size() < max_thread_count_) {
  10596. cleanup_finished_threads();
  10597. dynamic_threads_.emplace_back(std::thread([this]() { worker(true); }));
  10598. }
  10599. }
  10600. cond_.notify_one();
  10601. return true;
  10602. }
  10603. inline void ThreadPool::shutdown() {
  10604. {
  10605. std::unique_lock<std::mutex> lock(mutex_);
  10606. shutdown_ = true;
  10607. }
  10608. cond_.notify_all();
  10609. for (auto &t : threads_) {
  10610. if (t.joinable()) { t.join(); }
  10611. }
  10612. // Move dynamic_threads_ to a local list under the lock to avoid racing
  10613. // with worker threads that call move_to_finished() concurrently.
  10614. std::list<std::thread> remaining_dynamic;
  10615. {
  10616. std::unique_lock<std::mutex> lock(mutex_);
  10617. remaining_dynamic = std::move(dynamic_threads_);
  10618. }
  10619. for (auto &t : remaining_dynamic) {
  10620. if (t.joinable()) { t.join(); }
  10621. }
  10622. std::unique_lock<std::mutex> lock(mutex_);
  10623. cleanup_finished_threads();
  10624. }
  10625. inline void ThreadPool::move_to_finished(std::thread::id id) {
  10626. // Must be called with mutex_ held
  10627. for (auto it = dynamic_threads_.begin(); it != dynamic_threads_.end(); ++it) {
  10628. if (it->get_id() == id) {
  10629. finished_threads_.push_back(std::move(*it));
  10630. dynamic_threads_.erase(it);
  10631. return;
  10632. }
  10633. }
  10634. }
  10635. inline void ThreadPool::cleanup_finished_threads() {
  10636. // Must be called with mutex_ held
  10637. for (auto &t : finished_threads_) {
  10638. if (t.joinable()) { t.join(); }
  10639. }
  10640. finished_threads_.clear();
  10641. }
  10642. inline void ThreadPool::worker(bool is_dynamic) {
  10643. for (;;) {
  10644. std::function<void()> fn;
  10645. {
  10646. std::unique_lock<std::mutex> lock(mutex_);
  10647. idle_thread_count_++;
  10648. if (is_dynamic) {
  10649. auto has_work =
  10650. cond_.wait_for(lock, std::chrono::seconds(idle_timeout_sec_),
  10651. [&] { return !jobs_.empty() || shutdown_; });
  10652. if (!has_work) {
  10653. // Timed out with no work - exit this dynamic thread
  10654. idle_thread_count_--;
  10655. move_to_finished(std::this_thread::get_id());
  10656. break;
  10657. }
  10658. } else {
  10659. cond_.wait(lock, [&] { return !jobs_.empty() || shutdown_; });
  10660. }
  10661. idle_thread_count_--;
  10662. if (shutdown_ && jobs_.empty()) { break; }
  10663. fn = std::move(jobs_.front());
  10664. jobs_.pop_front();
  10665. }
  10666. assert(true == static_cast<bool>(fn));
  10667. fn();
  10668. }
  10669. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(OPENSSL_IS_BORINGSSL) && \
  10670. !defined(LIBRESSL_VERSION_NUMBER)
  10671. OPENSSL_thread_stop();
  10672. #endif
  10673. }
  10674. /*
  10675. * Group 1 (continued): detail namespace - Stream implementations
  10676. */
  10677. namespace detail {
  10678. inline void calc_actual_timeout(time_t max_timeout_msec, time_t duration_msec,
  10679. time_t timeout_sec, time_t timeout_usec,
  10680. time_t &actual_timeout_sec,
  10681. time_t &actual_timeout_usec) {
  10682. auto timeout_msec = (timeout_sec * 1000) + (timeout_usec / 1000);
  10683. auto actual_timeout_msec =
  10684. (std::min)(max_timeout_msec - duration_msec, timeout_msec);
  10685. if (actual_timeout_msec < 0) { actual_timeout_msec = 0; }
  10686. actual_timeout_sec = actual_timeout_msec / 1000;
  10687. actual_timeout_usec = (actual_timeout_msec % 1000) * 1000;
  10688. }
  10689. // Socket stream implementation
  10690. inline SocketStream::SocketStream(
  10691. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  10692. time_t write_timeout_sec, time_t write_timeout_usec,
  10693. time_t max_timeout_msec,
  10694. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10695. : sock_(sock), read_timeout_sec_(read_timeout_sec),
  10696. read_timeout_usec_(read_timeout_usec),
  10697. write_timeout_sec_(write_timeout_sec),
  10698. write_timeout_usec_(write_timeout_usec),
  10699. max_timeout_msec_(max_timeout_msec), start_time_(start_time),
  10700. read_buff_(read_buff_size_, 0) {}
  10701. inline SocketStream::~SocketStream() = default;
  10702. inline bool SocketStream::is_readable() const {
  10703. return read_buff_off_ < read_buff_content_size_;
  10704. }
  10705. inline bool SocketStream::wait_readable() const {
  10706. if (max_timeout_msec_ <= 0) {
  10707. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10708. }
  10709. time_t read_timeout_sec;
  10710. time_t read_timeout_usec;
  10711. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10712. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10713. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  10714. }
  10715. inline bool SocketStream::wait_writable() const {
  10716. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10717. }
  10718. inline bool SocketStream::ensure_readable() {
  10719. if (readable_hint_) {
  10720. readable_hint_ = false;
  10721. return true;
  10722. }
  10723. return wait_readable();
  10724. }
  10725. inline const char *SocketStream::buffered_data(size_t &size) const {
  10726. size = read_buff_content_size_ - read_buff_off_;
  10727. return size ? read_buff_.data() + read_buff_off_ : nullptr;
  10728. }
  10729. inline void SocketStream::consume_buffered(size_t size) {
  10730. assert(size <= read_buff_content_size_ - read_buff_off_);
  10731. read_buff_off_ += size;
  10732. }
  10733. inline bool SocketStream::is_peer_alive() const {
  10734. return detail::is_socket_alive(sock_);
  10735. }
  10736. inline ssize_t SocketStream::read(char *ptr, size_t size) {
  10737. #ifdef _WIN32
  10738. size =
  10739. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10740. #else
  10741. size = (std::min)(size,
  10742. static_cast<size_t>((std::numeric_limits<ssize_t>::max)()));
  10743. #endif
  10744. if (read_buff_off_ < read_buff_content_size_) {
  10745. auto remaining_size = read_buff_content_size_ - read_buff_off_;
  10746. if (size <= remaining_size) {
  10747. memcpy(ptr, read_buff_.data() + read_buff_off_, size);
  10748. read_buff_off_ += size;
  10749. return static_cast<ssize_t>(size);
  10750. } else {
  10751. memcpy(ptr, read_buff_.data() + read_buff_off_, remaining_size);
  10752. read_buff_off_ += remaining_size;
  10753. return static_cast<ssize_t>(remaining_size);
  10754. }
  10755. }
  10756. if (!ensure_readable()) {
  10757. error_ = Error::Timeout;
  10758. return -1;
  10759. }
  10760. read_buff_off_ = 0;
  10761. read_buff_content_size_ = 0;
  10762. if (size < read_buff_size_) {
  10763. auto n = read_socket(sock_, read_buff_.data(), read_buff_size_,
  10764. CPPHTTPLIB_RECV_FLAGS);
  10765. if (n <= 0) {
  10766. if (n == 0) {
  10767. error_ = Error::ConnectionClosed;
  10768. } else {
  10769. error_ = Error::Read;
  10770. }
  10771. return n;
  10772. } else if (n <= static_cast<ssize_t>(size)) {
  10773. memcpy(ptr, read_buff_.data(), static_cast<size_t>(n));
  10774. return n;
  10775. } else {
  10776. memcpy(ptr, read_buff_.data(), size);
  10777. read_buff_off_ = size;
  10778. read_buff_content_size_ = static_cast<size_t>(n);
  10779. return static_cast<ssize_t>(size);
  10780. }
  10781. } else {
  10782. auto n = read_socket(sock_, ptr, size, CPPHTTPLIB_RECV_FLAGS);
  10783. if (n <= 0) {
  10784. if (n == 0) {
  10785. error_ = Error::ConnectionClosed;
  10786. } else {
  10787. error_ = Error::Read;
  10788. }
  10789. }
  10790. return n;
  10791. }
  10792. }
  10793. inline ssize_t SocketStream::write(const char *ptr, size_t size) {
  10794. if (!wait_writable()) { return -1; }
  10795. #if defined(_WIN32) && !defined(_WIN64)
  10796. size =
  10797. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10798. #endif
  10799. return send_socket(sock_, ptr, size, CPPHTTPLIB_SEND_FLAGS);
  10800. }
  10801. inline void SocketStream::get_remote_ip_and_port(std::string &ip,
  10802. int &port) const {
  10803. return detail::get_remote_ip_and_port(sock_, ip, port);
  10804. }
  10805. inline void SocketStream::get_local_ip_and_port(std::string &ip,
  10806. int &port) const {
  10807. return detail::get_local_ip_and_port(sock_, ip, port);
  10808. }
  10809. inline socket_t SocketStream::socket() const { return sock_; }
  10810. inline time_t SocketStream::duration() const {
  10811. return static_cast<time_t>(
  10812. std::chrono::duration_cast<std::chrono::milliseconds>(
  10813. std::chrono::steady_clock::now() - start_time_)
  10814. .count());
  10815. }
  10816. inline void SocketStream::set_read_timeout(time_t sec, time_t usec) {
  10817. read_timeout_sec_ = sec;
  10818. read_timeout_usec_ = usec;
  10819. }
  10820. inline void SocketStream::set_max_timeout(time_t msec) {
  10821. max_timeout_msec_ = msec;
  10822. start_time_ = std::chrono::steady_clock::now();
  10823. }
  10824. // Buffer stream implementation
  10825. inline bool BufferStream::is_readable() const { return true; }
  10826. inline bool BufferStream::wait_readable() const { return true; }
  10827. inline bool BufferStream::wait_writable() const { return true; }
  10828. inline ssize_t BufferStream::read(char *ptr, size_t size) {
  10829. #if defined(_MSC_VER) && _MSC_VER < 1910
  10830. auto len_read = buffer._Copy_s(ptr, size, size, position);
  10831. #else
  10832. auto len_read = buffer.copy(ptr, size, position);
  10833. #endif
  10834. position += static_cast<size_t>(len_read);
  10835. return static_cast<ssize_t>(len_read);
  10836. }
  10837. inline ssize_t BufferStream::write(const char *ptr, size_t size) {
  10838. buffer.append(ptr, size);
  10839. return static_cast<ssize_t>(size);
  10840. }
  10841. inline void BufferStream::get_remote_ip_and_port(std::string & /*ip*/,
  10842. int & /*port*/) const {}
  10843. inline void BufferStream::get_local_ip_and_port(std::string & /*ip*/,
  10844. int & /*port*/) const {}
  10845. inline socket_t BufferStream::socket() const { return 0; }
  10846. inline time_t BufferStream::duration() const { return 0; }
  10847. inline const std::string &BufferStream::get_buffer() const { return buffer; }
  10848. inline PathParamsMatcher::PathParamsMatcher(const std::string &pattern)
  10849. : MatcherBase(pattern) {
  10850. constexpr const char marker[] = "/:";
  10851. // One past the last ending position of a path param substring
  10852. std::size_t last_param_end = 0;
  10853. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10854. // Needed to ensure that parameter names are unique during matcher
  10855. // construction
  10856. // If exceptions are disabled, only last duplicate path
  10857. // parameter will be set
  10858. std::unordered_set<std::string> param_name_set;
  10859. #endif
  10860. while (true) {
  10861. const auto marker_pos = pattern.find(
  10862. marker, last_param_end == 0 ? last_param_end : last_param_end - 1);
  10863. if (marker_pos == std::string::npos) { break; }
  10864. static_fragments_.push_back(
  10865. pattern.substr(last_param_end, marker_pos - last_param_end + 1));
  10866. const auto param_name_start = marker_pos + str_len(marker);
  10867. auto sep_pos = pattern.find(separator, param_name_start);
  10868. if (sep_pos == std::string::npos) { sep_pos = pattern.length(); }
  10869. auto param_name =
  10870. pattern.substr(param_name_start, sep_pos - param_name_start);
  10871. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10872. if (param_name_set.find(param_name) != param_name_set.cend()) {
  10873. std::string msg = "Encountered path parameter '" + param_name +
  10874. "' multiple times in route pattern '" + pattern + "'.";
  10875. throw std::invalid_argument(msg);
  10876. }
  10877. #endif
  10878. param_names_.push_back(std::move(param_name));
  10879. last_param_end = sep_pos + 1;
  10880. }
  10881. if (last_param_end < pattern.length()) {
  10882. static_fragments_.push_back(pattern.substr(last_param_end));
  10883. }
  10884. }
  10885. inline bool PathParamsMatcher::match(Request &request) const {
  10886. request.matches = std::smatch();
  10887. request.path_params.clear();
  10888. // A pattern without parameters is just a literal path to compare against
  10889. if (param_names_.empty()) { return request.path == pattern(); }
  10890. request.path_params.reserve(param_names_.size());
  10891. // One past the position at which the path matched the pattern last time
  10892. std::size_t starting_pos = 0;
  10893. for (size_t i = 0; i < static_fragments_.size(); ++i) {
  10894. const auto &fragment = static_fragments_[i];
  10895. if (starting_pos + fragment.length() > request.path.length()) {
  10896. return false;
  10897. }
  10898. // Avoid unnecessary allocation by using strncmp instead of substr +
  10899. // comparison
  10900. if (std::strncmp(request.path.c_str() + starting_pos, fragment.c_str(),
  10901. fragment.length()) != 0) {
  10902. return false;
  10903. }
  10904. starting_pos += fragment.length();
  10905. // Should only happen when we have a static fragment after a param
  10906. // Example: '/users/:id/subscriptions'
  10907. // The 'subscriptions' fragment here does not have a corresponding param
  10908. if (i >= param_names_.size()) { continue; }
  10909. auto sep_pos = request.path.find(separator, starting_pos);
  10910. if (sep_pos == std::string::npos) { sep_pos = request.path.length(); }
  10911. const auto &param_name = param_names_[i];
  10912. request.path_params.emplace(
  10913. param_name, request.path.substr(starting_pos, sep_pos - starting_pos));
  10914. // Mark everything up to '/' as matched
  10915. starting_pos = sep_pos + 1;
  10916. }
  10917. // Returns false if the path is longer than the pattern
  10918. return starting_pos >= request.path.length();
  10919. }
  10920. inline bool RegexMatcher::match(Request &request) const {
  10921. request.path_params.clear();
  10922. // See CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH: an overlong path is treated as
  10923. // a non-match rather than risking a stack overflow in std::regex_match.
  10924. if (request.path.length() > CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH) {
  10925. return false;
  10926. }
  10927. return std::regex_match(request.path, request.matches, regex_);
  10928. }
  10929. // Enclose IPv6 address in brackets if needed
  10930. inline std::string prepare_host_string(const std::string &host) {
  10931. // Enclose IPv6 address in brackets (but not if already enclosed)
  10932. if (host.find(':') == std::string::npos ||
  10933. (!host.empty() && host[0] == '[')) {
  10934. // IPv4, hostname, or already bracketed IPv6
  10935. return host;
  10936. } else {
  10937. // IPv6 address without brackets
  10938. return "[" + host + "]";
  10939. }
  10940. }
  10941. inline std::string make_host_and_port_string(const std::string &host, int port,
  10942. bool is_ssl) {
  10943. auto result = prepare_host_string(host);
  10944. // Append port if not default
  10945. if ((!is_ssl && port == 80) || (is_ssl && port == 443)) {
  10946. ; // do nothing
  10947. } else {
  10948. result += ":" + std::to_string(port);
  10949. }
  10950. return result;
  10951. }
  10952. // Create "host:port" string always including port number (for CONNECT method)
  10953. inline std::string
  10954. make_host_and_port_string_always_port(const std::string &host, int port) {
  10955. return prepare_host_string(host) + ":" + std::to_string(port);
  10956. }
  10957. // Value for the Host header a client sends when the caller supplied none.
  10958. // Only the value: callers decide where in their header list it goes.
  10959. inline std::string make_default_host_header_value(const std::string &host,
  10960. int port, bool is_ssl,
  10961. int address_family) {
  10962. if (address_family == AF_UNIX) { return "localhost"; }
  10963. return make_host_and_port_string(host, port, is_ssl);
  10964. }
  10965. inline void add_default_user_agent_header(Request &req) {
  10966. #ifndef CPPHTTPLIB_NO_DEFAULT_USER_AGENT
  10967. if (!req.has_header("User-Agent")) {
  10968. req.set_header("User-Agent",
  10969. std::string("cpp-httplib/") + CPPHTTPLIB_VERSION);
  10970. }
  10971. #else
  10972. (void)req;
  10973. #endif
  10974. }
  10975. bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out);
  10976. NormalizedTarget normalize_target(const std::string &host);
  10977. bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits);
  10978. bool host_matches_no_proxy(const NormalizedTarget &target,
  10979. const std::vector<NoProxyEntry> &entries);
  10980. inline bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits) {
  10981. if (prefix_bits < 0 || prefix_bits > 128) { return false; }
  10982. if (prefix_bits == 0) { return true; }
  10983. int full_bytes = prefix_bits / 8;
  10984. int rem_bits = prefix_bits % 8;
  10985. if (full_bytes > 0 && std::memcmp(ip.data(), net.data(),
  10986. static_cast<size_t>(full_bytes)) != 0) {
  10987. return false;
  10988. }
  10989. if (rem_bits == 0) { return true; }
  10990. auto i = static_cast<size_t>(full_bytes);
  10991. auto mask = static_cast<uint8_t>(0xFFu << (8 - rem_bits));
  10992. return (ip[i] & mask) == (net[i] & mask);
  10993. }
  10994. inline bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out) {
  10995. if (token.empty()) { return false; }
  10996. if (token == "*") {
  10997. out.kind = NoProxyKind::Wildcard;
  10998. return true;
  10999. }
  11000. auto slash = token.find('/');
  11001. std::string addr_part =
  11002. (slash == std::string::npos) ? token : token.substr(0, slash);
  11003. std::string prefix_part =
  11004. (slash == std::string::npos) ? std::string() : token.substr(slash + 1);
  11005. // A bare slash or trailing-slash CIDR like "10.0.0.0/" is malformed;
  11006. // don't silently treat it as a /32 (or /128).
  11007. if (slash != std::string::npos && prefix_part.empty()) { return false; }
  11008. // Accept the bracketed IPv6 form ("[::1]", "[fe80::]/10") as well as the
  11009. // bare form. Brackets have no meaning for IPv4, so skip the IPv4 attempt
  11010. // when brackets are present.
  11011. bool bracketed = addr_part.size() >= 2 && addr_part.front() == '[' &&
  11012. addr_part.back() == ']';
  11013. if (bracketed) { addr_part = addr_part.substr(1, addr_part.size() - 2); }
  11014. if (!bracketed) {
  11015. struct in_addr v4;
  11016. if (inet_pton(AF_INET, addr_part.c_str(), &v4) == 1) {
  11017. int prefix = 32;
  11018. if (!prefix_part.empty() &&
  11019. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 32,
  11020. prefix)) {
  11021. return false;
  11022. }
  11023. out.kind = NoProxyKind::IPv4Cidr;
  11024. std::memcpy(out.net.data(), &v4, sizeof(v4));
  11025. out.prefix_bits = prefix;
  11026. return true;
  11027. }
  11028. }
  11029. struct in6_addr v6;
  11030. if (inet_pton(AF_INET6, addr_part.c_str(), &v6) == 1) {
  11031. int prefix = 128;
  11032. if (!prefix_part.empty() &&
  11033. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 128,
  11034. prefix)) {
  11035. return false;
  11036. }
  11037. out.kind = NoProxyKind::IPv6Cidr;
  11038. std::memcpy(out.net.data(), &v6, sizeof(v6));
  11039. out.prefix_bits = prefix;
  11040. return true;
  11041. }
  11042. // Bracketed entries can only be IPv6. If the IPv6 parse above failed,
  11043. // the entry is malformed — don't fall through to the hostname branch.
  11044. if (bracketed) { return false; }
  11045. // A '/' on a non-IP token means a CIDR prefix without an address. Reject.
  11046. if (slash != std::string::npos) { return false; }
  11047. // Port-specific entries (host:port) are not supported.
  11048. if (token.find(':') != std::string::npos) { return false; }
  11049. std::string hostname = case_ignore::to_lower(token);
  11050. while (!hostname.empty() && hostname.front() == '.') {
  11051. hostname.erase(hostname.begin());
  11052. }
  11053. while (!hostname.empty() && hostname.back() == '.') {
  11054. hostname.pop_back();
  11055. }
  11056. if (hostname.empty()) { return false; }
  11057. out.kind = NoProxyKind::HostnameSuffix;
  11058. out.hostname_pattern = std::move(hostname);
  11059. return true;
  11060. }
  11061. inline std::vector<NoProxyEntry>
  11062. parse_no_proxy_entries(const std::vector<std::string> &patterns) {
  11063. std::vector<NoProxyEntry> entries;
  11064. entries.reserve(patterns.size());
  11065. for (const auto &p : patterns) {
  11066. auto trimmed = trim_copy(p);
  11067. if (trimmed.empty()) { continue; }
  11068. NoProxyEntry entry;
  11069. if (parse_no_proxy_entry(trimmed, entry)) {
  11070. entries.push_back(std::move(entry));
  11071. }
  11072. }
  11073. return entries;
  11074. }
  11075. inline NormalizedTarget normalize_target(const std::string &host) {
  11076. NormalizedTarget t;
  11077. std::string h = host;
  11078. if (h.size() >= 2 && h.front() == '[' && h.back() == ']') {
  11079. h = h.substr(1, h.size() - 2);
  11080. }
  11081. // Strip a single trailing dot so "example.com." canonicalizes to
  11082. // "example.com".
  11083. if (!h.empty() && h.back() == '.') { h.pop_back(); }
  11084. t.hostname = case_ignore::to_lower(h);
  11085. if (!t.hostname.empty()) {
  11086. struct in_addr v4;
  11087. struct in6_addr v6;
  11088. if (inet_pton(AF_INET, t.hostname.c_str(), &v4) == 1) {
  11089. t.is_ipv4 = true;
  11090. std::memcpy(t.ip.data(), &v4, sizeof(v4));
  11091. } else if (inet_pton(AF_INET6, t.hostname.c_str(), &v6) == 1) {
  11092. t.is_ipv6 = true;
  11093. std::memcpy(t.ip.data(), &v6, sizeof(v6));
  11094. }
  11095. }
  11096. return t;
  11097. }
  11098. inline bool host_matches_no_proxy(const NormalizedTarget &target,
  11099. const std::vector<NoProxyEntry> &entries) {
  11100. if (target.hostname.empty()) { return false; }
  11101. for (const auto &e : entries) {
  11102. switch (e.kind) {
  11103. case NoProxyKind::Wildcard: return true;
  11104. case NoProxyKind::IPv4Cidr:
  11105. if (target.is_ipv4 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  11106. return true;
  11107. }
  11108. break;
  11109. case NoProxyKind::IPv6Cidr:
  11110. if (target.is_ipv6 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  11111. return true;
  11112. }
  11113. break;
  11114. case NoProxyKind::HostnameSuffix:
  11115. if (target.is_ipv4 || target.is_ipv6) { break; }
  11116. if (target.hostname == e.hostname_pattern) { return true; }
  11117. // Dot-boundary suffix match: prevents "evilexample.com" from matching
  11118. // an entry of "example.com".
  11119. if (target.hostname.size() > e.hostname_pattern.size() + 1) {
  11120. auto offset = target.hostname.size() - e.hostname_pattern.size();
  11121. if (target.hostname[offset - 1] == '.' &&
  11122. target.hostname.compare(offset, e.hostname_pattern.size(),
  11123. e.hostname_pattern) == 0) {
  11124. return true;
  11125. }
  11126. }
  11127. break;
  11128. }
  11129. }
  11130. return false;
  11131. }
  11132. template <typename T>
  11133. inline bool check_and_write_headers(Stream &strm, Headers &headers,
  11134. T header_writer, Error &error) {
  11135. for (const auto &h : headers) {
  11136. if (!detail::fields::is_field_valid(h.first, h.second)) {
  11137. error = Error::InvalidHeaders;
  11138. return false;
  11139. }
  11140. }
  11141. if (header_writer(strm, headers) <= 0) {
  11142. error = Error::Write;
  11143. return false;
  11144. }
  11145. return true;
  11146. }
  11147. } // namespace detail
  11148. /*
  11149. * Group 2 (continued): detail namespace - SSLSocketStream implementation
  11150. */
  11151. #ifdef CPPHTTPLIB_SSL_ENABLED
  11152. namespace detail {
  11153. // SSL socket stream implementation
  11154. inline SSLSocketStream::SSLSocketStream(
  11155. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  11156. time_t read_timeout_usec, time_t write_timeout_sec,
  11157. time_t write_timeout_usec, time_t max_timeout_msec,
  11158. std::chrono::time_point<std::chrono::steady_clock> start_time)
  11159. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  11160. read_timeout_usec_(read_timeout_usec),
  11161. write_timeout_sec_(write_timeout_sec),
  11162. write_timeout_usec_(write_timeout_usec),
  11163. max_timeout_msec_(max_timeout_msec), start_time_(start_time) {
  11164. tls_error_.code = tls::ErrorCode::Success;
  11165. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  11166. // Clear AUTO_RETRY for proper non-blocking I/O timeout handling
  11167. // Note: create_session() also clears this, but SSLClient currently
  11168. // uses ssl_new() which does not. Until full TLS API migration is complete,
  11169. // we need to ensure AUTO_RETRY is cleared here regardless of how the
  11170. // SSL session was created.
  11171. SSL_clear_mode(static_cast<SSL *>(session), SSL_MODE_AUTO_RETRY);
  11172. #endif
  11173. }
  11174. inline SSLSocketStream::~SSLSocketStream() = default;
  11175. inline bool SSLSocketStream::is_readable() const {
  11176. return tls::pending(session_) > 0;
  11177. }
  11178. inline bool SSLSocketStream::wait_readable() const {
  11179. if (max_timeout_msec_ <= 0) {
  11180. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  11181. }
  11182. time_t read_timeout_sec;
  11183. time_t read_timeout_usec;
  11184. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  11185. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  11186. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  11187. }
  11188. inline bool SSLSocketStream::wait_writable() const {
  11189. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0 &&
  11190. !tls::is_peer_closed(session_, sock_);
  11191. }
  11192. inline bool SSLSocketStream::ensure_readable() {
  11193. if (readable_hint_) {
  11194. readable_hint_ = false;
  11195. return true;
  11196. }
  11197. return wait_readable();
  11198. }
  11199. inline bool SSLSocketStream::is_peer_alive() const {
  11200. return !tls::is_peer_closed(session_, sock_);
  11201. }
  11202. inline ssize_t SSLSocketStream::read(char *ptr, size_t size) {
  11203. if (tls::pending(session_) > 0) {
  11204. tls::TlsError err;
  11205. auto ret = tls::read(session_, ptr, size, err);
  11206. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11207. error_ = Error::ConnectionClosed;
  11208. } else if (ret < 0) {
  11209. tls_error_ = err;
  11210. }
  11211. return ret;
  11212. } else if (ensure_readable()) {
  11213. tls::TlsError err;
  11214. auto ret = tls::read(session_, ptr, size, err);
  11215. if (ret < 0) {
  11216. auto n = 1000;
  11217. #ifdef _WIN32
  11218. while (--n >= 0 && (err.code == tls::ErrorCode::WantRead ||
  11219. (err.code == tls::ErrorCode::SyscallError &&
  11220. WSAGetLastError() == WSAETIMEDOUT))) {
  11221. #else
  11222. while (--n >= 0 && err.code == tls::ErrorCode::WantRead) {
  11223. #endif
  11224. if (tls::pending(session_) > 0) {
  11225. ret = tls::read(session_, ptr, size, err);
  11226. if (ret >= 0) { return ret; }
  11227. break;
  11228. } else if (wait_readable()) {
  11229. std::this_thread::sleep_for(std::chrono::microseconds{10});
  11230. ret = tls::read(session_, ptr, size, err);
  11231. if (ret >= 0) { return ret; }
  11232. } else {
  11233. break;
  11234. }
  11235. }
  11236. assert(ret < 0);
  11237. tls_error_ = err;
  11238. } else if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11239. error_ = Error::ConnectionClosed;
  11240. }
  11241. return ret;
  11242. } else {
  11243. error_ = Error::Timeout;
  11244. return -1;
  11245. }
  11246. }
  11247. inline ssize_t SSLSocketStream::write(const char *ptr, size_t size) {
  11248. if (wait_writable()) {
  11249. auto handle_size =
  11250. std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11251. tls::TlsError err;
  11252. auto ret = tls::write(session_, ptr, handle_size, err);
  11253. if (ret < 0) {
  11254. auto n = 1000;
  11255. #ifdef _WIN32
  11256. while (--n >= 0 && (err.code == tls::ErrorCode::WantWrite ||
  11257. (err.code == tls::ErrorCode::SyscallError &&
  11258. WSAGetLastError() == WSAETIMEDOUT))) {
  11259. #else
  11260. while (--n >= 0 && err.code == tls::ErrorCode::WantWrite) {
  11261. #endif
  11262. if (wait_writable()) {
  11263. std::this_thread::sleep_for(std::chrono::microseconds{10});
  11264. ret = tls::write(session_, ptr, handle_size, err);
  11265. if (ret >= 0) { return ret; }
  11266. } else {
  11267. break;
  11268. }
  11269. }
  11270. assert(ret < 0);
  11271. tls_error_ = err;
  11272. }
  11273. return ret;
  11274. }
  11275. return -1;
  11276. }
  11277. inline void SSLSocketStream::get_remote_ip_and_port(std::string &ip,
  11278. int &port) const {
  11279. detail::get_remote_ip_and_port(sock_, ip, port);
  11280. }
  11281. inline void SSLSocketStream::get_local_ip_and_port(std::string &ip,
  11282. int &port) const {
  11283. detail::get_local_ip_and_port(sock_, ip, port);
  11284. }
  11285. inline socket_t SSLSocketStream::socket() const { return sock_; }
  11286. inline time_t SSLSocketStream::duration() const {
  11287. return static_cast<time_t>(
  11288. std::chrono::duration_cast<std::chrono::milliseconds>(
  11289. std::chrono::steady_clock::now() - start_time_)
  11290. .count());
  11291. }
  11292. inline void SSLSocketStream::set_read_timeout(time_t sec, time_t usec) {
  11293. read_timeout_sec_ = sec;
  11294. read_timeout_usec_ = usec;
  11295. }
  11296. inline void SSLSocketStream::set_max_timeout(time_t msec) {
  11297. max_timeout_msec_ = msec;
  11298. start_time_ = std::chrono::steady_clock::now();
  11299. }
  11300. inline WebSocketSSLStream::WebSocketSSLStream(socket_t sock,
  11301. tls::session_t session,
  11302. time_t read_timeout_sec,
  11303. time_t read_timeout_usec,
  11304. time_t write_timeout_sec,
  11305. time_t write_timeout_usec)
  11306. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  11307. read_timeout_usec_(read_timeout_usec),
  11308. write_timeout_sec_(write_timeout_sec),
  11309. write_timeout_usec_(write_timeout_usec),
  11310. start_time_(std::chrono::steady_clock::now()) {
  11311. // The receive and send paths run on different threads, so each TLS call is
  11312. // driven in non-blocking mode and readiness is awaited with select()
  11313. // outside the session lock. Set the socket non-blocking once here; it is
  11314. // never flipped back, so no thread races on the flag.
  11315. detail::set_nonblocking(sock_, true);
  11316. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  11317. SSL_clear_mode(static_cast<SSL *>(session_), SSL_MODE_AUTO_RETRY);
  11318. #endif
  11319. }
  11320. inline WebSocketSSLStream::~WebSocketSSLStream() = default;
  11321. inline bool WebSocketSSLStream::is_readable() const {
  11322. std::lock_guard<std::mutex> guard(session_mutex_);
  11323. return tls::pending(session_) > 0;
  11324. }
  11325. inline bool WebSocketSSLStream::wait_readable() const {
  11326. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  11327. }
  11328. inline bool WebSocketSSLStream::wait_writable() const {
  11329. // Unlike SSLSocketStream, this deliberately does not call is_peer_closed():
  11330. // that probe toggles the socket's blocking flag, which would race with the
  11331. // concurrent reader on a permanently non-blocking socket.
  11332. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  11333. }
  11334. inline ssize_t WebSocketSSLStream::read(char *ptr, size_t size) {
  11335. tls::TlsError err;
  11336. auto n = 1000;
  11337. while (--n >= 0) {
  11338. {
  11339. std::lock_guard<std::mutex> guard(session_mutex_);
  11340. auto ret = tls::read(session_, ptr, size, err);
  11341. if (ret > 0) { return ret; }
  11342. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11343. error_ = Error::ConnectionClosed;
  11344. return ret;
  11345. }
  11346. }
  11347. // ret < 0. On a non-blocking socket a TLS read can stop needing either
  11348. // direction: the send path shares this session, so output it left pending
  11349. // has to be flushed before more input can be decrypted. Anything else is
  11350. // a hard error.
  11351. auto needs_readable = err.code == tls::ErrorCode::WantRead;
  11352. #ifdef _WIN32
  11353. // On Windows a socket timeout surfaces as a syscall error, not WantRead.
  11354. needs_readable =
  11355. needs_readable || (err.code == tls::ErrorCode::SyscallError &&
  11356. WSAGetLastError() == WSAETIMEDOUT);
  11357. #endif
  11358. if (!needs_readable && err.code != tls::ErrorCode::WantWrite) {
  11359. error_ = Error::Read;
  11360. return -1;
  11361. }
  11362. if (!(needs_readable ? wait_readable() : wait_writable())) {
  11363. error_ = Error::Timeout;
  11364. return -1;
  11365. }
  11366. }
  11367. // Out of retries. Recording a reason matters: a caller that reads get_error()
  11368. // to tell a timeout from a close would otherwise see whatever the previous
  11369. // failure left behind (error_ is never cleared on success).
  11370. error_ = Error::Read;
  11371. return -1;
  11372. }
  11373. inline ssize_t WebSocketSSLStream::write(const char *ptr, size_t size) {
  11374. auto handle_size = std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11375. tls::TlsError err;
  11376. auto n = 1000;
  11377. while (--n >= 0) {
  11378. {
  11379. std::lock_guard<std::mutex> guard(session_mutex_);
  11380. auto ret = tls::write(session_, ptr, handle_size, err);
  11381. if (ret >= 0) { return ret; }
  11382. }
  11383. // ret < 0. As in read(), either direction can be needed: a renegotiation
  11384. // or a post-handshake message must be consumed before the record goes
  11385. // out. Anything else is a hard error.
  11386. auto needs_writable = err.code == tls::ErrorCode::WantWrite;
  11387. #ifdef _WIN32
  11388. // On Windows a socket timeout surfaces as a syscall error, not WantWrite.
  11389. needs_writable =
  11390. needs_writable || (err.code == tls::ErrorCode::SyscallError &&
  11391. WSAGetLastError() == WSAETIMEDOUT);
  11392. #endif
  11393. if (!needs_writable && err.code != tls::ErrorCode::WantRead) { return -1; }
  11394. if (!(needs_writable ? wait_writable() : wait_readable())) { return -1; }
  11395. }
  11396. return -1;
  11397. }
  11398. inline void WebSocketSSLStream::get_remote_ip_and_port(std::string &ip,
  11399. int &port) const {
  11400. detail::get_remote_ip_and_port(sock_, ip, port);
  11401. }
  11402. inline void WebSocketSSLStream::get_local_ip_and_port(std::string &ip,
  11403. int &port) const {
  11404. detail::get_local_ip_and_port(sock_, ip, port);
  11405. }
  11406. inline socket_t WebSocketSSLStream::socket() const { return sock_; }
  11407. inline time_t WebSocketSSLStream::duration() const {
  11408. return static_cast<time_t>(
  11409. std::chrono::duration_cast<std::chrono::milliseconds>(
  11410. std::chrono::steady_clock::now() - start_time_)
  11411. .count());
  11412. }
  11413. inline void WebSocketSSLStream::set_read_timeout(time_t sec, time_t usec) {
  11414. read_timeout_sec_ = sec;
  11415. read_timeout_usec_ = usec;
  11416. }
  11417. } // namespace detail
  11418. #endif // CPPHTTPLIB_SSL_ENABLED
  11419. /*
  11420. * Group 4: Server implementation
  11421. */
  11422. // HTTP server implementation
  11423. inline Server::Server()
  11424. : new_task_queue([] {
  11425. return new ThreadPool(CPPHTTPLIB_THREAD_POOL_COUNT,
  11426. CPPHTTPLIB_THREAD_POOL_MAX_COUNT);
  11427. }) {
  11428. #ifndef _WIN32
  11429. signal(SIGPIPE, SIG_IGN);
  11430. #endif
  11431. }
  11432. inline Server::~Server() = default;
  11433. inline std::unique_ptr<detail::MatcherBase>
  11434. Server::make_matcher(const std::string &pattern) {
  11435. // Path params take precedence, so "/users/:id/(.*)" keeps being matched as
  11436. // a path params pattern
  11437. if (pattern.find("/:") != std::string::npos) {
  11438. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11439. }
  11440. // A pattern with no regex metacharacter only has to be compared literally,
  11441. // which is what PathParamsMatcher already does when it captures no
  11442. // parameter, so std::regex is only worth building for the patterns that
  11443. // actually need it
  11444. if (pattern.find_first_of(".^$|()[]{}*+?\\") == std::string::npos) {
  11445. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11446. }
  11447. return detail::make_unique<detail::RegexMatcher>(pattern);
  11448. }
  11449. inline Server &Server::Get(const std::string &pattern, Handler handler) {
  11450. return add_handler(get_handlers_, pattern, std::move(handler));
  11451. }
  11452. inline Server &Server::Post(const std::string &pattern, Handler handler) {
  11453. return add_handler(post_handlers_, pattern, std::move(handler));
  11454. }
  11455. inline Server &Server::Post(const std::string &pattern,
  11456. HandlerWithContentReader handler) {
  11457. return add_handler(post_handlers_for_content_reader_, pattern,
  11458. std::move(handler));
  11459. }
  11460. inline Server &Server::Put(const std::string &pattern, Handler handler) {
  11461. return add_handler(put_handlers_, pattern, std::move(handler));
  11462. }
  11463. inline Server &Server::Put(const std::string &pattern,
  11464. HandlerWithContentReader handler) {
  11465. return add_handler(put_handlers_for_content_reader_, pattern,
  11466. std::move(handler));
  11467. }
  11468. inline Server &Server::Patch(const std::string &pattern, Handler handler) {
  11469. return add_handler(patch_handlers_, pattern, std::move(handler));
  11470. }
  11471. inline Server &Server::Patch(const std::string &pattern,
  11472. HandlerWithContentReader handler) {
  11473. return add_handler(patch_handlers_for_content_reader_, pattern,
  11474. std::move(handler));
  11475. }
  11476. inline Server &Server::Delete(const std::string &pattern, Handler handler) {
  11477. return add_handler(delete_handlers_, pattern, std::move(handler));
  11478. }
  11479. inline Server &Server::Delete(const std::string &pattern,
  11480. HandlerWithContentReader handler) {
  11481. return add_handler(delete_handlers_for_content_reader_, pattern,
  11482. std::move(handler));
  11483. }
  11484. inline Server &Server::Options(const std::string &pattern, Handler handler) {
  11485. return add_handler(options_handlers_, pattern, std::move(handler));
  11486. }
  11487. inline const std::set<std::string> &Server::builtin_methods() {
  11488. thread_local const std::set<std::string> methods{
  11489. "GET", "HEAD", "POST", "PUT", "DELETE",
  11490. "CONNECT", "OPTIONS", "TRACE", "PATCH", "PRI"};
  11491. return methods;
  11492. }
  11493. inline Server::CustomHandlerEntry *
  11494. Server::custom_entry_for_registration(const std::string &method) {
  11495. // Built-in methods are refused for two different reasons. GET, HEAD, POST,
  11496. // PUT, DELETE, OPTIONS and PATCH are dispatched by the if/else chain in
  11497. // routing() before the custom tables are consulted, so a route registered
  11498. // for one of them could never fire. CONNECT, TRACE and PRI have no branch
  11499. // there and would be reachable, but they carry protocol-level meaning
  11500. // (tunnel setup, request echo, the HTTP/2 connection preface) that this
  11501. // library does not route.
  11502. if (!detail::fields::is_token(method) || builtin_methods().count(method)) {
  11503. output_error_log(Error::InvalidHTTPMethod, nullptr);
  11504. has_invalid_registration_ = true;
  11505. return nullptr;
  11506. }
  11507. return &custom_handlers_[method];
  11508. }
  11509. inline Server &Server::CustomRoute(const std::string &method,
  11510. const std::string &pattern,
  11511. Handler handler) {
  11512. auto *entry = custom_entry_for_registration(method);
  11513. if (!entry) { return *this; }
  11514. return add_handler(entry->handlers, pattern, std::move(handler));
  11515. }
  11516. inline Server &Server::CustomRoute(const std::string &method,
  11517. const std::string &pattern,
  11518. HandlerWithContentReader handler) {
  11519. auto *entry = custom_entry_for_registration(method);
  11520. if (!entry) { return *this; }
  11521. return add_handler(entry->handlers_for_content_reader, pattern,
  11522. std::move(handler));
  11523. }
  11524. inline const Server::CustomHandlerEntry *
  11525. Server::find_custom_entry(const std::string &method) const {
  11526. // find() alone would be correct here. The empty() check is what keeps the
  11527. // per-request cost off servers that never call CustomRoute(), which is the
  11528. // overwhelmingly common case; keep it rather than walking into the tree.
  11529. if (custom_handlers_.empty()) { return nullptr; }
  11530. auto it = custom_handlers_.find(method);
  11531. return it == custom_handlers_.end() ? nullptr : &it->second;
  11532. }
  11533. inline Server &Server::WebSocket(const std::string &pattern,
  11534. WebSocketHandler handler) {
  11535. websocket_handlers_.push_back(
  11536. {make_matcher(pattern), std::move(handler), nullptr});
  11537. return *this;
  11538. }
  11539. inline Server &Server::WebSocket(const std::string &pattern,
  11540. WebSocketHandler handler,
  11541. SubProtocolSelector sub_protocol_selector) {
  11542. websocket_handlers_.push_back({make_matcher(pattern), std::move(handler),
  11543. std::move(sub_protocol_selector)});
  11544. return *this;
  11545. }
  11546. inline bool Server::set_base_dir(const std::string &dir,
  11547. const std::string &mount_point) {
  11548. return set_mount_point(mount_point, dir);
  11549. }
  11550. inline bool Server::set_mount_point(const std::string &mount_point,
  11551. const std::string &dir, Headers headers) {
  11552. detail::FileStat stat(dir);
  11553. if (stat.is_dir()) {
  11554. std::string mnt = !mount_point.empty() ? mount_point : "/";
  11555. if (!mnt.empty() && mnt[0] == '/') {
  11556. // Without the resolved directory, a file could not be checked to be
  11557. // inside it.
  11558. std::string resolved_base;
  11559. if (!detail::canonicalize_path(dir.c_str(), resolved_base)) {
  11560. return false;
  11561. }
  11562. #if defined(_WIN32)
  11563. if (resolved_base.back() != '\\' && resolved_base.back() != '/') {
  11564. resolved_base += '\\';
  11565. }
  11566. #else
  11567. if (resolved_base.back() != '/') { resolved_base += '/'; }
  11568. #endif
  11569. base_dirs_.push_back(
  11570. {std::move(mnt), dir, std::move(resolved_base), std::move(headers)});
  11571. return true;
  11572. }
  11573. }
  11574. return false;
  11575. }
  11576. inline bool Server::remove_mount_point(const std::string &mount_point) {
  11577. for (auto it = base_dirs_.begin(); it != base_dirs_.end(); ++it) {
  11578. if (it->mount_point == mount_point) {
  11579. base_dirs_.erase(it);
  11580. return true;
  11581. }
  11582. }
  11583. return false;
  11584. }
  11585. inline Server &
  11586. Server::set_file_extension_and_mimetype_mapping(const std::string &ext,
  11587. const std::string &mime) {
  11588. file_extension_and_mimetype_map_[ext] = mime;
  11589. return *this;
  11590. }
  11591. inline Server &Server::set_default_file_mimetype(const std::string &mime) {
  11592. default_file_mimetype_ = mime;
  11593. return *this;
  11594. }
  11595. inline Server &Server::set_file_request_handler(Handler handler) {
  11596. file_request_handler_ = std::move(handler);
  11597. return *this;
  11598. }
  11599. inline Server &Server::set_error_handler_core(HandlerWithResponse handler,
  11600. std::true_type) {
  11601. error_handler_ = std::move(handler);
  11602. return *this;
  11603. }
  11604. inline Server &Server::set_error_handler_core(Handler handler,
  11605. std::false_type) {
  11606. error_handler_ = [handler](const Request &req, Response &res) {
  11607. handler(req, res);
  11608. return HandlerResponse::Handled;
  11609. };
  11610. return *this;
  11611. }
  11612. inline Server &Server::set_exception_handler(ExceptionHandler handler) {
  11613. exception_handler_ = std::move(handler);
  11614. return *this;
  11615. }
  11616. inline Server &Server::set_pre_routing_handler(HandlerWithResponse handler) {
  11617. pre_routing_handler_ = std::move(handler);
  11618. return *this;
  11619. }
  11620. inline Server &Server::set_post_routing_handler(Handler handler) {
  11621. post_routing_handler_ = std::move(handler);
  11622. return *this;
  11623. }
  11624. inline Server &Server::set_pre_request_handler(HandlerWithResponse handler) {
  11625. pre_request_handler_ = std::move(handler);
  11626. return *this;
  11627. }
  11628. inline Server &Server::set_logger(Logger logger) {
  11629. logger_ = std::move(logger);
  11630. return *this;
  11631. }
  11632. inline Server &Server::set_error_logger(ErrorLogger error_logger) {
  11633. error_logger_ = std::move(error_logger);
  11634. return *this;
  11635. }
  11636. inline Server &Server::set_pre_compression_logger(Logger logger) {
  11637. pre_compression_logger_ = std::move(logger);
  11638. return *this;
  11639. }
  11640. inline Server &
  11641. Server::set_expect_100_continue_handler(Expect100ContinueHandler handler) {
  11642. expect_100_continue_handler_ = std::move(handler);
  11643. return *this;
  11644. }
  11645. inline Server &Server::set_start_handler(StartHandler handler) {
  11646. start_handler_ = std::move(handler);
  11647. return *this;
  11648. }
  11649. inline Server &Server::set_address_family(int family) {
  11650. address_family_ = family;
  11651. return *this;
  11652. }
  11653. inline Server &Server::set_tcp_nodelay(bool on) {
  11654. tcp_nodelay_ = on;
  11655. return *this;
  11656. }
  11657. inline Server &Server::set_ipv6_v6only(bool on) {
  11658. ipv6_v6only_ = on;
  11659. return *this;
  11660. }
  11661. inline Server &Server::set_socket_options(SocketOptions socket_options) {
  11662. socket_options_ = std::move(socket_options);
  11663. return *this;
  11664. }
  11665. inline Server &Server::set_default_headers(Headers headers) {
  11666. default_headers_ = std::move(headers);
  11667. return *this;
  11668. }
  11669. inline Server &Server::set_header_writer(
  11670. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  11671. header_writer_ = writer;
  11672. return *this;
  11673. }
  11674. inline Server &
  11675. Server::set_trusted_proxies(const std::vector<std::string> &proxies) {
  11676. trusted_proxies_ = proxies;
  11677. return *this;
  11678. }
  11679. inline Server &Server::set_keep_alive_max_count(size_t count) {
  11680. keep_alive_max_count_ = count;
  11681. return *this;
  11682. }
  11683. inline Server &Server::set_keep_alive_timeout(time_t sec) {
  11684. keep_alive_timeout_sec_ = sec;
  11685. return *this;
  11686. }
  11687. template <class Rep, class Period>
  11688. inline Server &Server::set_keep_alive_timeout(
  11689. const std::chrono::duration<Rep, Period> &duration) {
  11690. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11691. set_keep_alive_timeout(sec);
  11692. });
  11693. return *this;
  11694. }
  11695. inline Server &Server::set_read_timeout(time_t sec, time_t usec) {
  11696. read_timeout_sec_ = sec;
  11697. read_timeout_usec_ = usec;
  11698. return *this;
  11699. }
  11700. inline Server &Server::set_write_timeout(time_t sec, time_t usec) {
  11701. write_timeout_sec_ = sec;
  11702. write_timeout_usec_ = usec;
  11703. return *this;
  11704. }
  11705. inline Server &Server::set_idle_interval(time_t sec, time_t usec) {
  11706. idle_interval_sec_ = sec;
  11707. idle_interval_usec_ = usec;
  11708. return *this;
  11709. }
  11710. inline Server &Server::set_payload_max_length(size_t length) {
  11711. payload_max_length_ = length;
  11712. return *this;
  11713. }
  11714. inline Server &Server::set_static_file_compression(bool on) {
  11715. static_file_compression_ = on;
  11716. return *this;
  11717. }
  11718. inline Server &Server::set_static_file_compression_min_length(size_t length) {
  11719. static_file_compression_min_length_ = length;
  11720. return *this;
  11721. }
  11722. inline Server &Server::set_static_file_compression_max_length(size_t length) {
  11723. static_file_compression_max_length_ = length;
  11724. return *this;
  11725. }
  11726. inline Server &Server::set_websocket_max_missed_pongs(int count) {
  11727. websocket_max_missed_pongs_ = count;
  11728. return *this;
  11729. }
  11730. inline Server &Server::set_websocket_ping_interval(time_t sec) {
  11731. websocket_ping_interval_sec_ = sec;
  11732. return *this;
  11733. }
  11734. template <class Rep, class Period>
  11735. inline Server &Server::set_websocket_ping_interval(
  11736. const std::chrono::duration<Rep, Period> &duration) {
  11737. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11738. set_websocket_ping_interval(sec);
  11739. });
  11740. return *this;
  11741. }
  11742. inline bool Server::bind_to_port(const std::string &host, int port,
  11743. int socket_flags) {
  11744. auto ret = bind_internal(host, port, socket_flags);
  11745. if (ret == -1) { is_decommissioned = true; }
  11746. return ret >= 0;
  11747. }
  11748. inline int Server::bind_to_any_port(const std::string &host, int socket_flags) {
  11749. auto ret = bind_internal(host, 0, socket_flags);
  11750. if (ret == -1) { is_decommissioned = true; }
  11751. return ret;
  11752. }
  11753. inline bool Server::listen_after_bind() { return listen_internal(); }
  11754. inline bool Server::listen(const std::string &host, int port,
  11755. int socket_flags) {
  11756. return bind_to_port(host, port, socket_flags) && listen_internal();
  11757. }
  11758. inline bool Server::is_running() const { return is_running_; }
  11759. inline void Server::wait_until_ready() const {
  11760. while (!is_running_ && !is_decommissioned) {
  11761. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  11762. }
  11763. }
  11764. inline void Server::stop() noexcept {
  11765. // Release the listening socket whether or not the accept loop is running:
  11766. // bind_to_port() without listen_after_bind() still owns the descriptor. The
  11767. // exchange is what makes this safe to call concurrently with the accept loop.
  11768. socket_t sock = svr_sock_.exchange(INVALID_SOCKET);
  11769. if (sock != INVALID_SOCKET) {
  11770. detail::shutdown_socket(sock);
  11771. detail::close_socket(sock);
  11772. }
  11773. is_decommissioned = false;
  11774. }
  11775. inline void Server::decommission() { is_decommissioned = true; }
  11776. inline bool Server::parse_request_line(const char *s, Request &req) const {
  11777. auto len = strlen(s);
  11778. if (len < 2 || s[len - 2] != '\r' || s[len - 1] != '\n') { return false; }
  11779. len -= 2;
  11780. {
  11781. // RFC 9112 §3: exactly one SP between the method, the target and the
  11782. // version. Taking other whitespace as a separator too lets recipients
  11783. // that parse more strictly see a different request.
  11784. auto end = s + len;
  11785. if (std::count(s, end, ' ') != 2) { return false; }
  11786. auto sp1 = std::find(s, end, ' ');
  11787. auto sp2 = std::find(sp1 + 1, end, ' ');
  11788. if (sp1 == s || sp2 == sp1 + 1 || sp2 + 1 == end) { return false; }
  11789. req.method.assign(s, sp1);
  11790. req.target.assign(sp1 + 1, sp2);
  11791. req.version.assign(sp2 + 1, end);
  11792. }
  11793. // A method outside the built-in set is accepted only when a handler has been
  11794. // registered for it with CustomRoute().
  11795. const auto &methods = builtin_methods();
  11796. if (methods.find(req.method) == methods.end() &&
  11797. !find_custom_entry(req.method)) {
  11798. output_error_log(Error::InvalidHTTPMethod, &req);
  11799. return false;
  11800. }
  11801. if (req.version != "HTTP/1.1" && req.version != "HTTP/1.0") {
  11802. output_error_log(Error::InvalidHTTPVersion, &req);
  11803. return false;
  11804. }
  11805. // A request-target has no fragment (RFC 9112 §3.2), and one stripped here
  11806. // would leave this server routing a different path than a cache or a
  11807. // filter in front of it sees.
  11808. if (!detail::fields::is_request_target(req.target) ||
  11809. req.target.find('#') != std::string::npos) {
  11810. return false;
  11811. }
  11812. {
  11813. detail::divide(req.target, '?',
  11814. [&](const char *lhs_data, std::size_t lhs_size,
  11815. const char *rhs_data, std::size_t rhs_size) {
  11816. req.path =
  11817. decode_path_component(std::string(lhs_data, lhs_size));
  11818. detail::parse_query_text(rhs_data, rhs_size, req.params);
  11819. });
  11820. }
  11821. return true;
  11822. }
  11823. inline bool Server::write_response(Stream &strm, bool close_connection,
  11824. Request &req, Response &res) {
  11825. // NOTE: `req.ranges` should be empty, otherwise it will be applied
  11826. // incorrectly to the error content.
  11827. req.ranges.clear();
  11828. return write_response_core(strm, close_connection, req, res, false);
  11829. }
  11830. inline bool Server::write_response_with_content(Stream &strm,
  11831. bool close_connection,
  11832. const Request &req,
  11833. Response &res) {
  11834. return write_response_core(strm, close_connection, req, res, true);
  11835. }
  11836. inline bool Server::write_response_core(Stream &strm, bool close_connection,
  11837. const Request &req, Response &res,
  11838. bool need_apply_ranges) {
  11839. assert(res.status != -1);
  11840. if (400 <= res.status && error_handler_ &&
  11841. error_handler_(req, res) == HandlerResponse::Handled) {
  11842. need_apply_ranges = true;
  11843. }
  11844. if (!detail::body_allowed_for_status(res.status)) {
  11845. detail::clear_content(res);
  11846. }
  11847. detail::prefer_assigned_body(res);
  11848. std::string content_type;
  11849. std::string boundary;
  11850. if (need_apply_ranges) { apply_ranges(req, res, content_type, boundary); }
  11851. // Prepare additional headers
  11852. if (close_connection ||
  11853. detail::has_header_token(req.headers, "Connection", "close") ||
  11854. 400 <= res.status || // Don't leave connections open after errors
  11855. // The client withholds the body until `100 Continue`, which was never
  11856. // sent, so whether and when the body follows is unknown.
  11857. (req.expect_100_continue_pending_ && detail::has_framed_body(req)) ||
  11858. // The body was left partway, e.g. by a content receiver that returned
  11859. // false, so the rest of it cannot be told from the next request.
  11860. (req.body_read_started_ && !req.body_consumed_)) {
  11861. res.set_header("Connection", "close");
  11862. } else {
  11863. std::string s = "timeout=";
  11864. s += std::to_string(keep_alive_timeout_sec_);
  11865. if (keep_alive_max_count_ > 0) {
  11866. s += ", max=";
  11867. s += std::to_string(keep_alive_max_count_);
  11868. }
  11869. res.set_header("Keep-Alive", s);
  11870. }
  11871. if ((!res.body.empty() || res.content_length_ > 0 || res.content_provider_) &&
  11872. !res.has_header("Content-Type")) {
  11873. res.set_header("Content-Type", "text/plain");
  11874. }
  11875. detail::set_framing_headers(req, res, boundary, content_type);
  11876. if (req.method == "HEAD" && !res.has_header("Accept-Ranges")) {
  11877. res.set_header("Accept-Ranges", "bytes");
  11878. }
  11879. if (post_routing_handler_) {
  11880. post_routing_handler_(req, res);
  11881. // Again, for a body or framing headers the handler changed.
  11882. detail::set_framing_headers(req, res, boundary, content_type);
  11883. }
  11884. // Response line and headers
  11885. detail::BufferStream bstrm;
  11886. if (!detail::write_response_line(bstrm, res.status)) { return false; }
  11887. if (header_writer_(bstrm, res.headers) <= 0) { return false; }
  11888. // Combine a small body with the headers so the whole response leaves in a
  11889. // single write. A large body is written on its own instead: a copy of it
  11890. // costs more than the extra write saves.
  11891. auto send_body =
  11892. req.method != "HEAD" && detail::body_allowed_for_status(res.status);
  11893. auto body_is_separate = false;
  11894. auto provider_done = false;
  11895. if (send_body && !res.body.empty() && !res.content_provider_) {
  11896. if (res.body.size() < CPPHTTPLIB_SEND_BUFSIZ) {
  11897. bstrm.write(res.body.data(), res.body.size());
  11898. } else {
  11899. body_is_separate = true;
  11900. }
  11901. } else if (send_body && res.content_provider_ &&
  11902. res.is_file_content_provider_ &&
  11903. res.content_length_ < CPPHTTPLIB_SEND_BUFSIZ) {
  11904. // A small file is read into the same buffer. Other providers may produce
  11905. // their data over time, so they are never held back.
  11906. if (!write_content_with_provider(bstrm, req, res, boundary, content_type)) {
  11907. return false;
  11908. }
  11909. provider_done = true;
  11910. }
  11911. // Log before writing to avoid race condition with client-side code that
  11912. // accesses logger-captured data immediately after receiving the response.
  11913. output_log(req, res);
  11914. // Flush buffer
  11915. auto &data = bstrm.get_buffer();
  11916. if (!detail::write_data(strm, data.data(), data.size())) { return false; }
  11917. if (body_is_separate) {
  11918. return detail::write_data(strm, res.body.data(), res.body.size());
  11919. }
  11920. // Streaming body
  11921. if (send_body && res.content_provider_) {
  11922. if (!provider_done &&
  11923. !write_content_with_provider(strm, req, res, boundary, content_type)) {
  11924. return false;
  11925. }
  11926. res.content_provider_success_ = true;
  11927. }
  11928. return true;
  11929. }
  11930. inline bool
  11931. Server::write_content_with_provider(Stream &strm, const Request &req,
  11932. Response &res, const std::string &boundary,
  11933. const std::string &content_type) {
  11934. auto is_shutting_down = [this]() {
  11935. return this->svr_sock_ == INVALID_SOCKET;
  11936. };
  11937. if (res.content_length_ > 0) {
  11938. if (!detail::is_partial_content(req, res)) {
  11939. return detail::write_content(strm, res.content_provider_, 0,
  11940. res.content_length_, is_shutting_down);
  11941. } else if (req.ranges.size() == 1) {
  11942. auto offset_and_length = detail::get_range_offset_and_length(
  11943. req.ranges[0], res.content_length_);
  11944. return detail::write_content(strm, res.content_provider_,
  11945. offset_and_length.first,
  11946. offset_and_length.second, is_shutting_down);
  11947. } else {
  11948. return detail::write_multipart_ranges_data(
  11949. strm, req, res, boundary, content_type, res.content_length_,
  11950. is_shutting_down);
  11951. }
  11952. } else {
  11953. if (res.is_chunked_content_provider_) {
  11954. // Use the coding `apply_ranges()` chose when it wrote the headers;
  11955. // re-negotiating here would disagree with them, e.g. once a handler's
  11956. // own Content-Encoding header suppresses the negotiation.
  11957. auto compressor = detail::make_compressor(res.content_coding_);
  11958. if (!compressor) {
  11959. compressor = detail::make_unique<detail::nocompressor>();
  11960. }
  11961. return detail::write_content_chunked(strm, res.content_provider_,
  11962. is_shutting_down, *compressor);
  11963. } else {
  11964. return detail::write_content_without_length(strm, res.content_provider_,
  11965. is_shutting_down);
  11966. }
  11967. }
  11968. }
  11969. inline bool Server::read_content(Stream &strm, Request &req, Response &res) {
  11970. FormFields::iterator cur_field;
  11971. FormFiles::iterator cur_file;
  11972. auto is_text_field = false;
  11973. size_t count = 0;
  11974. if (read_content_core(
  11975. strm, req, res,
  11976. // Regular
  11977. [&](const char *buf, size_t n) {
  11978. // Prevent arithmetic overflow when checking sizes.
  11979. // Avoid computing (req.body.size() + n) directly because
  11980. // adding two unsigned `size_t` values can wrap around and
  11981. // produce a small result instead of indicating overflow.
  11982. // Instead, check using subtraction: ensure `n` does not
  11983. // exceed the remaining capacity `max_size() - size()`.
  11984. if (req.body.size() >= req.body.max_size() ||
  11985. n > req.body.max_size() - req.body.size()) {
  11986. return false;
  11987. }
  11988. // Limit decompressed body size to payload_max_length_ to protect
  11989. // against "zip bomb" attacks where a small compressed payload
  11990. // decompresses to a massive size.
  11991. if (payload_max_length_ > 0 &&
  11992. (req.body.size() >= payload_max_length_ ||
  11993. n > payload_max_length_ - req.body.size())) {
  11994. return false;
  11995. }
  11996. req.body.append(buf, n);
  11997. return true;
  11998. },
  11999. // Multipart FormData
  12000. [&](const FormData &file) {
  12001. if (CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT > 0 &&
  12002. count++ == CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT) {
  12003. output_error_log(Error::TooManyFormDataFiles, &req);
  12004. return false;
  12005. }
  12006. if (file.filename.empty()) {
  12007. cur_field = req.form.fields.emplace(
  12008. file.name, FormField{file.name, file.content, file.headers});
  12009. is_text_field = true;
  12010. } else {
  12011. cur_file = req.form.files.emplace(file.name, file);
  12012. is_text_field = false;
  12013. }
  12014. return true;
  12015. },
  12016. [&](const char *buf, size_t n) {
  12017. if (is_text_field) {
  12018. auto &content = cur_field->second.content;
  12019. if (content.size() + n > content.max_size()) { return false; }
  12020. content.append(buf, n);
  12021. } else {
  12022. auto &content = cur_file->second.content;
  12023. if (content.size() + n > content.max_size()) { return false; }
  12024. content.append(buf, n);
  12025. }
  12026. return true;
  12027. })) {
  12028. const auto &content_type = req.get_header_value("Content-Type");
  12029. if (detail::case_ignore::equal(detail::extract_media_type(content_type),
  12030. "application/x-www-form-urlencoded")) {
  12031. if (CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH > 0 &&
  12032. req.body.size() > CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH) {
  12033. res.status = StatusCode::PayloadTooLarge_413; // NOTE: should be 414?
  12034. output_error_log(Error::ExceedMaxPayloadSize, &req);
  12035. return false;
  12036. }
  12037. detail::parse_query_text(req.body, req.params);
  12038. }
  12039. return true;
  12040. }
  12041. return false;
  12042. }
  12043. inline bool Server::read_content_with_content_receiver(
  12044. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  12045. FormDataHeader multipart_header, ContentReceiver multipart_receiver) {
  12046. return read_content_core(strm, req, res, std::move(receiver),
  12047. std::move(multipart_header),
  12048. std::move(multipart_receiver));
  12049. }
  12050. inline bool Server::read_content_core(
  12051. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  12052. FormDataHeader multipart_header, ContentReceiver multipart_receiver) const {
  12053. detail::FormDataParser multipart_form_data_parser;
  12054. ContentReceiverWithProgress out;
  12055. if (req.is_multipart_form_data()) {
  12056. const auto &content_type = req.get_header_value("Content-Type");
  12057. std::string boundary;
  12058. if (!detail::parse_multipart_boundary(content_type, boundary)) {
  12059. res.status = StatusCode::BadRequest_400;
  12060. output_error_log(Error::MultipartParsing, &req);
  12061. return false;
  12062. }
  12063. multipart_form_data_parser.set_boundary(std::move(boundary));
  12064. out = [&](const char *buf, size_t n, size_t /*off*/, size_t /*len*/) {
  12065. return multipart_form_data_parser.parse(buf, n, multipart_header,
  12066. multipart_receiver);
  12067. };
  12068. } else {
  12069. out = [receiver](const char *buf, size_t n, size_t /*off*/,
  12070. size_t /*len*/) { return receiver(buf, n); };
  12071. }
  12072. // RFC 9112 §6: no Transfer-Encoding and no Content-Length means no body.
  12073. // For non-SSL builds we still scan non-persistent connections for stray
  12074. // body bytes so the payload limit is enforced (413). On keep-alive,
  12075. // pending bytes may be the next request (issue #2450), so skip.
  12076. #if !defined(CPPHTTPLIB_SSL_ENABLED)
  12077. if (!req.has_header("Content-Length") &&
  12078. !detail::is_chunked_transfer_encoding(req.headers)) {
  12079. if (!detail::is_connection_persistent(req) && payload_max_length_ > 0 &&
  12080. payload_max_length_ < (std::numeric_limits<size_t>::max)()) {
  12081. auto has_data = strm.is_readable();
  12082. if (!has_data) {
  12083. auto s = strm.socket();
  12084. if (s != INVALID_SOCKET) {
  12085. has_data = detail::select_read(s, 0, 0) > 0;
  12086. }
  12087. }
  12088. if (has_data) {
  12089. // Route through the same decompressing reader used by the
  12090. // length-framed and chunked paths below, so payload_max_length_ is
  12091. // enforced on the decompressed size here too instead of only on the
  12092. // compressed wire bytes.
  12093. return detail::read_content(strm, req, payload_max_length_, res.status,
  12094. nullptr, out, true);
  12095. }
  12096. }
  12097. return true;
  12098. }
  12099. #else
  12100. if (!req.has_header("Content-Length") &&
  12101. !detail::is_chunked_transfer_encoding(req.headers)) {
  12102. return true;
  12103. }
  12104. #endif
  12105. // A second read would start where the first one stopped, or in the next
  12106. // request.
  12107. if (req.body_read_started_) { return false; }
  12108. // The client is waiting for this before it sends the body.
  12109. if (req.expect_100_continue_pending_) {
  12110. req.expect_100_continue_pending_ = false;
  12111. detail::write_response_line(strm, StatusCode::Continue_100);
  12112. strm.write("\r\n");
  12113. }
  12114. // Set before reading, since a receiver may also stop by throwing.
  12115. req.body_read_started_ = true;
  12116. if (!detail::read_content(strm, req, payload_max_length_, res.status, nullptr,
  12117. out, true)) {
  12118. return false;
  12119. }
  12120. req.body_consumed_ = true;
  12121. if (req.is_multipart_form_data()) {
  12122. if (!multipart_form_data_parser.is_valid()) {
  12123. res.status = StatusCode::BadRequest_400;
  12124. output_error_log(Error::MultipartParsing, &req);
  12125. return false;
  12126. }
  12127. }
  12128. return true;
  12129. }
  12130. inline bool Server::handle_file_request(Request &req, Response &res) {
  12131. for (const auto &entry : base_dirs_) {
  12132. // Prefix match, on a path segment boundary. A mount point of "/mount"
  12133. // covers "/mount" and "/mount/...", but must not swallow "/mountdir/...".
  12134. // One that already ends in '/' (the root mount among them) carries its own
  12135. // boundary; set_mount_point() guarantees the mount point is not empty.
  12136. if (!req.path.compare(0, entry.mount_point.size(), entry.mount_point) &&
  12137. (entry.mount_point.back() == '/' ||
  12138. req.path.size() == entry.mount_point.size() ||
  12139. req.path[entry.mount_point.size()] == '/')) {
  12140. std::string sub_path = "/" + req.path.substr(entry.mount_point.size());
  12141. if (detail::is_valid_path(sub_path)) {
  12142. auto path = entry.base_dir + sub_path;
  12143. if (path.back() == '/') { path += "index.html"; }
  12144. // Defense-in-depth: is_valid_path blocks ".." traversal in the URL,
  12145. // but symlinks/junctions can still escape the base directory. A path
  12146. // that cannot be resolved, which includes one that does not exist, is
  12147. // not served from here.
  12148. std::string resolved_path;
  12149. if (!detail::canonicalize_path(path.c_str(), resolved_path)) {
  12150. continue;
  12151. }
  12152. if (!detail::is_path_within_base(resolved_path,
  12153. entry.resolved_base_dir)) {
  12154. res.status = StatusCode::Forbidden_403;
  12155. return true;
  12156. }
  12157. detail::FileStat stat(path);
  12158. if (stat.is_dir()) {
  12159. // Relative, so "//dir" cannot name another host; "./" keeps a ':'
  12160. // in the name from reading as a scheme.
  12161. auto name = req.path.substr(req.path.rfind('/') + 1);
  12162. res.set_redirect("./" + encode_path_component(name) + "/",
  12163. StatusCode::MovedPermanently_301);
  12164. return true;
  12165. }
  12166. if (stat.is_file()) {
  12167. for (const auto &kv : entry.headers) {
  12168. res.set_header(kv.first, kv.second);
  12169. }
  12170. auto content_type = detail::find_content_type(
  12171. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  12172. auto encoding = detail::EncodingType::None;
  12173. if (static_file_compression_) {
  12174. encoding =
  12175. static_file_encoding(req, res, content_type, stat.size());
  12176. }
  12177. // The ETag names the representation actually sent, so a client that
  12178. // cached the compressed form revalidates against the compressed ETag
  12179. // and still gets a 304, while one that took identity keeps the plain
  12180. // ETag.
  12181. auto etag = detail::compute_etag(
  12182. stat, encoding == detail::EncodingType::None
  12183. ? std::string()
  12184. : std::string("-") + detail::encoding_name(encoding));
  12185. if (!etag.empty()) { res.set_header("ETag", etag); }
  12186. auto mtime = stat.mtime();
  12187. auto last_modified = detail::file_mtime_to_http_date(mtime);
  12188. if (!last_modified.empty()) {
  12189. res.set_header("Last-Modified", last_modified);
  12190. }
  12191. if (check_if_not_modified(req, res, etag, mtime)) { return true; }
  12192. check_if_range(req, etag, mtime);
  12193. auto mm = std::make_shared<detail::mmap>(path.c_str());
  12194. if (!mm->is_open()) {
  12195. output_error_log(Error::OpenFile, &req);
  12196. return false;
  12197. }
  12198. detail::set_file_content_provider(res, mm, content_type, encoding);
  12199. if (req.method != "HEAD" && file_request_handler_) {
  12200. file_request_handler_(req, res);
  12201. }
  12202. return true;
  12203. } else {
  12204. output_error_log(Error::OpenFile, &req);
  12205. }
  12206. }
  12207. }
  12208. }
  12209. return false;
  12210. }
  12211. inline bool Server::check_if_not_modified(const Request &req, Response &res,
  12212. const std::string &etag,
  12213. time_t mtime) const {
  12214. // Handle conditional GET:
  12215. // 1. If-None-Match takes precedence (RFC 9110 Section 13.1.2)
  12216. // 2. If-Modified-Since is checked only when If-None-Match is absent
  12217. if (req.has_header("If-None-Match")) {
  12218. if (!etag.empty()) {
  12219. auto val =
  12220. detail::get_combined_header_value(req.headers, "If-None-Match");
  12221. // NOTE: We use exact string matching here. This works correctly
  12222. // because our server always generates weak ETags (W/"..."), and
  12223. // clients typically send back the same ETag they received.
  12224. // RFC 9110 Section 8.8.3.2 allows weak comparison for
  12225. // If-None-Match, where W/"x" and "x" would match, but this
  12226. // simplified implementation requires exact matches.
  12227. auto ret = detail::split_find(val.data(), val.data() + val.size(), ',',
  12228. [&](const char *b, const char *e) {
  12229. auto seg_len = static_cast<size_t>(e - b);
  12230. return (seg_len == 1 && *b == '*') ||
  12231. (seg_len == etag.size() &&
  12232. std::equal(b, e, etag.begin()));
  12233. });
  12234. if (ret) {
  12235. res.status = StatusCode::NotModified_304;
  12236. return true;
  12237. }
  12238. }
  12239. } else if (req.has_header("If-Modified-Since")) {
  12240. auto val = req.get_header_value("If-Modified-Since");
  12241. auto t = detail::parse_http_date(val);
  12242. if (t != static_cast<time_t>(-1) && mtime <= t) {
  12243. res.status = StatusCode::NotModified_304;
  12244. return true;
  12245. }
  12246. }
  12247. return false;
  12248. }
  12249. inline bool Server::check_if_range(Request &req, const std::string &etag,
  12250. time_t mtime) const {
  12251. // Handle If-Range for partial content requests (RFC 9110
  12252. // Section 13.1.5). If-Range is only evaluated when Range header is
  12253. // present. If the validator matches, serve partial content; otherwise
  12254. // serve full content.
  12255. if (!req.ranges.empty() && req.has_header("If-Range")) {
  12256. auto val = req.get_header_value("If-Range");
  12257. auto is_valid_range = [&]() {
  12258. if (detail::is_strong_etag(val)) {
  12259. // RFC 9110 Section 13.1.5: If-Range requires strong ETag
  12260. // comparison.
  12261. return (!etag.empty() && val == etag);
  12262. } else if (detail::is_weak_etag(val)) {
  12263. // Weak ETags are not valid for If-Range (RFC 9110 Section 13.1.5)
  12264. return false;
  12265. } else {
  12266. // HTTP-date comparison
  12267. auto t = detail::parse_http_date(val);
  12268. return (t != static_cast<time_t>(-1) && mtime <= t);
  12269. }
  12270. };
  12271. if (!is_valid_range()) {
  12272. // Validator doesn't match: ignore Range and serve full content
  12273. req.ranges.clear();
  12274. return false;
  12275. }
  12276. }
  12277. return true;
  12278. }
  12279. inline socket_t
  12280. Server::create_server_socket(const std::string &host, int port,
  12281. int socket_flags,
  12282. SocketOptions socket_options) const {
  12283. return detail::create_socket(
  12284. host, std::string(), port, address_family_, socket_flags, tcp_nodelay_,
  12285. ipv6_v6only_, std::move(socket_options),
  12286. [&](socket_t sock, struct addrinfo &ai, bool & /*quit*/) -> bool {
  12287. if (::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  12288. output_error_log(Error::BindIPAddress, nullptr);
  12289. return false;
  12290. }
  12291. if (::listen(sock, CPPHTTPLIB_LISTEN_BACKLOG)) {
  12292. output_error_log(Error::Listen, nullptr);
  12293. return false;
  12294. }
  12295. return true;
  12296. });
  12297. }
  12298. inline int Server::bind_internal(const std::string &host, int port,
  12299. int socket_flags) {
  12300. if (is_decommissioned) { return -1; }
  12301. if (!is_valid()) { return -1; }
  12302. svr_sock_ = create_server_socket(host, port, socket_flags, socket_options_);
  12303. if (svr_sock_ == INVALID_SOCKET) { return -1; }
  12304. if (port == 0) {
  12305. struct sockaddr_storage addr;
  12306. socklen_t addr_len = sizeof(addr);
  12307. if (getsockname(svr_sock_, reinterpret_cast<struct sockaddr *>(&addr),
  12308. &addr_len) == -1) {
  12309. output_error_log(Error::GetSockName, nullptr);
  12310. return -1;
  12311. }
  12312. if (addr.ss_family == AF_INET) {
  12313. return ntohs(reinterpret_cast<struct sockaddr_in *>(&addr)->sin_port);
  12314. } else if (addr.ss_family == AF_INET6) {
  12315. return ntohs(reinterpret_cast<struct sockaddr_in6 *>(&addr)->sin6_port);
  12316. } else {
  12317. output_error_log(Error::UnsupportedAddressFamily, nullptr);
  12318. return -1;
  12319. }
  12320. } else {
  12321. return port;
  12322. }
  12323. }
  12324. inline bool Server::listen_internal() {
  12325. // A stop() between bind and listen leaves nothing to accept on. Report
  12326. // failure instead of returning success without ever serving, and mark the
  12327. // server decommissioned the way any failed listen does so that a concurrent
  12328. // wait_until_ready() wakes up instead of spinning forever.
  12329. if (is_decommissioned || svr_sock_ == INVALID_SOCKET) {
  12330. is_decommissioned = true;
  12331. return false;
  12332. }
  12333. auto ret = true;
  12334. is_running_ = true;
  12335. auto se = detail::scope_exit([&]() { is_running_ = false; });
  12336. if (start_handler_) { start_handler_(); }
  12337. {
  12338. std::unique_ptr<TaskQueue> task_queue(new_task_queue());
  12339. while (svr_sock_ != INVALID_SOCKET) {
  12340. #ifndef _WIN32
  12341. if (idle_interval_sec_ > 0 || idle_interval_usec_ > 0) {
  12342. #endif
  12343. auto val = detail::select_read(svr_sock_, idle_interval_sec_,
  12344. idle_interval_usec_);
  12345. if (val == 0) { // Timeout
  12346. task_queue->on_idle();
  12347. continue;
  12348. }
  12349. #ifndef _WIN32
  12350. }
  12351. #endif
  12352. #if defined _WIN32
  12353. // sockets connected via WASAccept inherit flags NO_HANDLE_INHERIT,
  12354. // OVERLAPPED
  12355. socket_t sock = WSAAccept(svr_sock_, nullptr, nullptr, nullptr, 0);
  12356. #elif defined SOCK_CLOEXEC
  12357. socket_t sock = accept4(svr_sock_, nullptr, nullptr, SOCK_CLOEXEC);
  12358. #else
  12359. socket_t sock = accept(svr_sock_, nullptr, nullptr);
  12360. #endif
  12361. if (sock == INVALID_SOCKET) {
  12362. // NOTE: Winsock reports failures through WSAGetLastError() and never
  12363. // touches the CRT errno, so the two have to be asked platform by
  12364. // platform rather than by testing errno here.
  12365. if (detail::is_accept_resource_error()) {
  12366. // The per-process descriptor limit or the network stack's buffer
  12367. // space has been reached. Try to accept new connections after a
  12368. // short sleep.
  12369. std::this_thread::sleep_for(std::chrono::microseconds{1});
  12370. continue;
  12371. } else if (detail::is_accept_transient_error()) {
  12372. continue;
  12373. }
  12374. // Take the descriptor out of svr_sock_ before closing it: a later
  12375. // stop() would otherwise shutdown()/close() a value the OS may have
  12376. // reused, and keep_alive() watches svr_sock_ to notice the server is
  12377. // gone. The exchange also settles the race with a concurrent stop(),
  12378. // since whichever side takes the descriptor closes it exactly once.
  12379. auto listen_sock = svr_sock_.exchange(INVALID_SOCKET);
  12380. if (listen_sock != INVALID_SOCKET) {
  12381. detail::close_socket(listen_sock);
  12382. ret = false;
  12383. output_error_log(Error::Connection, nullptr);
  12384. } else {
  12385. ; // The server socket was closed by user.
  12386. }
  12387. break;
  12388. }
  12389. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO,
  12390. read_timeout_sec_, read_timeout_usec_);
  12391. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_SNDTIMEO,
  12392. write_timeout_sec_, write_timeout_usec_);
  12393. if (tcp_nodelay_) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  12394. if (!task_queue->enqueue(
  12395. [this, sock]() { process_and_close_socket(sock); })) {
  12396. output_error_log(Error::ResourceExhaustion, nullptr);
  12397. detail::shutdown_socket(sock);
  12398. detail::close_socket(sock);
  12399. }
  12400. }
  12401. task_queue->shutdown();
  12402. }
  12403. is_decommissioned = !ret;
  12404. return ret;
  12405. }
  12406. inline bool Server::routing(Request &req, Response &res, Stream &strm) {
  12407. if (pre_routing_handler_ &&
  12408. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12409. return true;
  12410. }
  12411. // File handler
  12412. if ((req.method == "GET" || req.method == "HEAD") &&
  12413. handle_file_request(req, res)) {
  12414. return true;
  12415. }
  12416. const auto *custom = find_custom_entry(req.method);
  12417. // The second clause mirrors what expect_content() does unconditionally for
  12418. // POST/PUT/PATCH/DELETE: a content reader route fires even when the request
  12419. // carries no body. Without it a body-less PROPFIND (RFC 4918 treats one as
  12420. // `allprop`) would skip its handler and fall through to 404.
  12421. if (detail::expect_content(req) ||
  12422. (custom && !custom->handlers_for_content_reader.empty())) {
  12423. // Content reader handler
  12424. {
  12425. // Track whether the ContentReader was aborted due to the decompressed
  12426. // payload exceeding `payload_max_length_`.
  12427. // The user handler runs after the lambda returns, so we must restore the
  12428. // 413 status if the handler overwrites it.
  12429. bool content_reader_payload_too_large = false;
  12430. ContentReader reader(
  12431. [&](ContentReceiver receiver) {
  12432. auto result = read_content_with_content_receiver(
  12433. strm, req, res, std::move(receiver), nullptr, nullptr);
  12434. if (!result) {
  12435. output_error_log(Error::Read, &req);
  12436. if (res.status == StatusCode::PayloadTooLarge_413) {
  12437. content_reader_payload_too_large = true;
  12438. }
  12439. }
  12440. return result;
  12441. },
  12442. [&](FormDataHeader header, ContentReceiver receiver) {
  12443. auto result = read_content_with_content_receiver(
  12444. strm, req, res, nullptr, std::move(header),
  12445. std::move(receiver));
  12446. if (!result) {
  12447. output_error_log(Error::Read, &req);
  12448. if (res.status == StatusCode::PayloadTooLarge_413) {
  12449. content_reader_payload_too_large = true;
  12450. }
  12451. }
  12452. return result;
  12453. });
  12454. bool dispatched = false;
  12455. if (req.method == "POST") {
  12456. dispatched = dispatch_request_for_content_reader(
  12457. req, res, std::move(reader), post_handlers_for_content_reader_);
  12458. } else if (req.method == "PUT") {
  12459. dispatched = dispatch_request_for_content_reader(
  12460. req, res, std::move(reader), put_handlers_for_content_reader_);
  12461. } else if (req.method == "PATCH") {
  12462. dispatched = dispatch_request_for_content_reader(
  12463. req, res, std::move(reader), patch_handlers_for_content_reader_);
  12464. } else if (req.method == "DELETE") {
  12465. dispatched = dispatch_request_for_content_reader(
  12466. req, res, std::move(reader), delete_handlers_for_content_reader_);
  12467. } else if (custom) {
  12468. dispatched = dispatch_request_for_content_reader(
  12469. req, res, std::move(reader), custom->handlers_for_content_reader);
  12470. }
  12471. if (dispatched) {
  12472. if (content_reader_payload_too_large) {
  12473. // Enforce the limit: override any status the handler may have set
  12474. // and return false so the error path sends a plain 413 response.
  12475. res.status = StatusCode::PayloadTooLarge_413;
  12476. detail::clear_content(res);
  12477. return false;
  12478. }
  12479. return true;
  12480. }
  12481. }
  12482. // NOTE: `req.body` is not read here. For a regular handler the body is
  12483. // read inside dispatch_request(), after the route has matched and the
  12484. // pre-request handler has approved the request, so that a rejected
  12485. // request (e.g. failed authentication) never forces us to buffer a
  12486. // potentially large body.
  12487. }
  12488. // Regular handler
  12489. if (req.method == "GET" || req.method == "HEAD") {
  12490. return dispatch_request(req, res, get_handlers_, strm);
  12491. } else if (req.method == "POST") {
  12492. return dispatch_request(req, res, post_handlers_, strm);
  12493. } else if (req.method == "PUT") {
  12494. return dispatch_request(req, res, put_handlers_, strm);
  12495. } else if (req.method == "DELETE") {
  12496. return dispatch_request(req, res, delete_handlers_, strm);
  12497. } else if (req.method == "OPTIONS") {
  12498. return dispatch_request(req, res, options_handlers_, strm);
  12499. } else if (req.method == "PATCH") {
  12500. return dispatch_request(req, res, patch_handlers_, strm);
  12501. } else if (custom) {
  12502. return dispatch_request(req, res, custom->handlers, strm);
  12503. }
  12504. res.status = StatusCode::BadRequest_400;
  12505. return false;
  12506. }
  12507. inline bool Server::dispatch_request(Request &req, Response &res,
  12508. const Handlers &handlers, Stream &strm) {
  12509. for (const auto &x : handlers) {
  12510. const auto &matcher = x.first;
  12511. const auto &handler = x.second;
  12512. if (matcher->match(req)) {
  12513. req.matched_route = matcher->pattern();
  12514. // Run the pre-request handler before reading the body so a rejected
  12515. // request (e.g. failed authentication) never forces us to buffer a
  12516. // potentially large body. `req.matched_route` is available here.
  12517. if (pre_request_handler_ &&
  12518. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12519. return true;
  12520. }
  12521. // The route matched and the request was approved; read the body now.
  12522. if (detail::expect_content(req) && !read_content(strm, req, res)) {
  12523. output_error_log(Error::Read, &req);
  12524. return false;
  12525. }
  12526. handler(req, res);
  12527. return true;
  12528. }
  12529. }
  12530. return false;
  12531. }
  12532. // Decides the content coding for a response served straight from a file. Both
  12533. // the ETag, which has to name the representation actually sent, and
  12534. // `apply_static_file_compression()` go through this, so the two cannot drift
  12535. // apart.
  12536. inline detail::EncodingType
  12537. Server::static_file_encoding(const Request &req, const Response &res,
  12538. const std::string &content_type,
  12539. size_t length) const {
  12540. if (!static_file_compression_) { return detail::EncodingType::None; }
  12541. // Nothing to compress, and an empty file already answers with
  12542. // `Content-Length: 0`. Checked on its own so that a zero floor still cannot
  12543. // turn an empty body into a 20-byte gzip stream.
  12544. if (length == 0) { return detail::EncodingType::None; }
  12545. // A file that already fits in a single packet gains nothing from being made
  12546. // smaller, since it still travels in that one segment, and a file of a few
  12547. // bytes comes out larger than it went in.
  12548. if (length < static_file_compression_min_length_) {
  12549. return detail::EncodingType::None;
  12550. }
  12551. // RFC 9110 applies Range to the representation after content coding, so a
  12552. // compressed 206 would mean compressing the whole file and then slicing it.
  12553. // Serve ranges from the identity representation instead.
  12554. if (!req.ranges.empty()) { return detail::EncodingType::None; }
  12555. if (static_file_compression_max_length_ > 0 &&
  12556. length > static_file_compression_max_length_) {
  12557. return detail::EncodingType::None;
  12558. }
  12559. return detail::encoding_type(req, res, content_type);
  12560. }
  12561. // Compresses a file-backed content provider into `res.body`. Returns false when
  12562. // the response is left untouched.
  12563. inline bool Server::apply_static_file_compression(const Request &req,
  12564. Response &res) const {
  12565. auto type = res.content_coding_;
  12566. if (type == detail::EncodingType::None || !res.content_provider_) {
  12567. return false;
  12568. }
  12569. auto compressor = detail::make_compressor(type);
  12570. if (!compressor) { return false; }
  12571. output_pre_compression_log(req, res);
  12572. std::string compressed;
  12573. if (!detail::compress_content_provider(res.content_provider_,
  12574. res.content_length_, *compressor,
  12575. compressed)) {
  12576. return false;
  12577. }
  12578. res.body.swap(compressed);
  12579. // The provider was consumed in full, so its releaser hears about a success.
  12580. res.content_provider_success_ = true;
  12581. detail::clear_content_provider(res);
  12582. res.set_header("Content-Encoding", detail::encoding_name(type));
  12583. res.set_header("Vary", "Accept-Encoding");
  12584. return true;
  12585. }
  12586. inline void Server::apply_ranges(const Request &req, Response &res,
  12587. std::string &content_type,
  12588. std::string &boundary) const {
  12589. // A known-length content provider leaves `res.body` empty, so the compressor
  12590. // at the end of this function never runs for one (issue #2545). A file-backed
  12591. // provider is fully readable right here, so compress it and answer with an
  12592. // ordinary body: `Content-Length` and HEAD keep working, and the response
  12593. // takes the same path as `set_content()` from here on. Range requests never
  12594. // get a content coding, so `Content-Range` still names identity bytes and
  12595. // none of the range handling below applies.
  12596. if (apply_static_file_compression(req, res)) { return; }
  12597. if (req.ranges.size() > 1 && res.status == StatusCode::PartialContent_206) {
  12598. auto it = res.headers.find("Content-Type");
  12599. if (it != res.headers.end()) {
  12600. content_type = it->second;
  12601. res.headers.erase(it);
  12602. }
  12603. boundary = detail::make_multipart_data_boundary();
  12604. res.set_header("Content-Type",
  12605. "multipart/byteranges; boundary=" + boundary);
  12606. }
  12607. auto type = detail::encoding_type(req, res);
  12608. if (res.body.empty()) {
  12609. if (res.content_length_ > 0 && req.ranges.size() == 1 &&
  12610. res.status == StatusCode::PartialContent_206) {
  12611. auto offset_and_length = detail::get_range_offset_and_length(
  12612. req.ranges[0], res.content_length_);
  12613. auto content_range = detail::make_content_range_header_field(
  12614. offset_and_length, res.content_length_);
  12615. res.set_header("Content-Range", content_range);
  12616. } else if (res.is_chunked_content_provider_) {
  12617. res.content_coding_ = type;
  12618. if (type != detail::EncodingType::None) {
  12619. res.set_header("Content-Encoding", detail::encoding_name(type));
  12620. res.set_header("Vary", "Accept-Encoding");
  12621. }
  12622. }
  12623. } else {
  12624. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12625. ;
  12626. } else if (req.ranges.size() == 1) {
  12627. auto offset_and_length =
  12628. detail::get_range_offset_and_length(req.ranges[0], res.body.size());
  12629. auto offset = offset_and_length.first;
  12630. auto length = offset_and_length.second;
  12631. auto content_range = detail::make_content_range_header_field(
  12632. offset_and_length, res.body.size());
  12633. res.set_header("Content-Range", content_range);
  12634. assert(offset + length <= res.body.size());
  12635. res.body = res.body.substr(offset, length);
  12636. } else {
  12637. std::string data;
  12638. detail::make_multipart_ranges_data(req, res, boundary, content_type,
  12639. res.body.size(), data);
  12640. res.body.swap(data);
  12641. }
  12642. if (type != detail::EncodingType::None) {
  12643. output_pre_compression_log(req, res);
  12644. if (auto compressor = detail::make_compressor(type)) {
  12645. std::string compressed;
  12646. if (compressor->compress(res.body.data(), res.body.size(), true,
  12647. [&](const char *data, size_t data_len) {
  12648. compressed.append(data, data_len);
  12649. return true;
  12650. })) {
  12651. res.body.swap(compressed);
  12652. res.set_header("Content-Encoding", detail::encoding_name(type));
  12653. res.set_header("Vary", "Accept-Encoding");
  12654. }
  12655. }
  12656. }
  12657. res.content_length_ = res.body.size();
  12658. }
  12659. }
  12660. inline bool Server::dispatch_request_for_content_reader(
  12661. Request &req, Response &res, ContentReader content_reader,
  12662. const HandlersForContentReader &handlers) const {
  12663. for (const auto &x : handlers) {
  12664. const auto &matcher = x.first;
  12665. const auto &handler = x.second;
  12666. if (matcher->match(req)) {
  12667. req.matched_route = matcher->pattern();
  12668. if (!pre_request_handler_ ||
  12669. pre_request_handler_(req, res) != HandlerResponse::Handled) {
  12670. handler(req, res, content_reader);
  12671. }
  12672. return true;
  12673. }
  12674. }
  12675. return false;
  12676. }
  12677. inline std::string
  12678. get_client_ip(const std::string &x_forwarded_for,
  12679. const std::vector<std::string> &trusted_proxies) {
  12680. // X-Forwarded-For is a comma-separated list per RFC 7239
  12681. std::vector<std::string> ip_list;
  12682. detail::split(x_forwarded_for.data(),
  12683. x_forwarded_for.data() + x_forwarded_for.size(), ',',
  12684. [&](const char *b, const char *e) {
  12685. auto r = detail::trim(b, e, 0, static_cast<size_t>(e - b));
  12686. ip_list.emplace_back(std::string(b + r.first, b + r.second));
  12687. });
  12688. // A malformed X-Forwarded-For (empty, comma-only, whitespace-only) yields
  12689. // no segments. Signal "no client IP derived" with an empty string so the
  12690. // caller can fall back to the connection-level remote address.
  12691. if (ip_list.empty()) { return std::string(); }
  12692. // Each hop appends the address it received the request from, so the rightmost
  12693. // entries are the ones written by our own infrastructure while the leftmost
  12694. // are whatever the original client chose to send. Walk from the right and
  12695. // skip trusted proxies; the first address that is not a trusted proxy is the
  12696. // furthest point still attributable to a real hop, i.e. the client. Scanning
  12697. // from the left instead lets a client forge an arbitrary address by following
  12698. // it with a trusted proxy's address, which the left-to-right scan then
  12699. // returned as the client.
  12700. for (size_t i = ip_list.size(); i-- > 0;) {
  12701. const auto &ip = ip_list[i];
  12702. auto is_trusted_proxy =
  12703. std::any_of(trusted_proxies.begin(), trusted_proxies.end(),
  12704. [&](const std::string &proxy) { return ip == proxy; });
  12705. if (!is_trusted_proxy) { return ip; }
  12706. }
  12707. // Every hop was a trusted proxy; fall back to the first entry.
  12708. return ip_list.front();
  12709. }
  12710. inline bool
  12711. Server::process_request(Stream &strm, const std::string &remote_addr,
  12712. int remote_port, const std::string &local_addr,
  12713. int local_port, bool close_connection,
  12714. bool &connection_closed,
  12715. const std::function<void(Request &)> &setup_request,
  12716. bool *websocket_upgraded) {
  12717. std::array<char, 2048> buf{};
  12718. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12719. // The read timeout bounds the request line and headers as a whole, so a
  12720. // client sending them a byte at a time cannot hold the worker any longer.
  12721. strm.set_max_timeout(read_timeout_sec_ * 1000 + read_timeout_usec_ / 1000);
  12722. // Connection has been closed on client
  12723. if (!line_reader.getline()) { return false; }
  12724. // RFC 9112 2.2: ignore an empty line received before the request-line. Some
  12725. // clients send an extra CRLF after a request body, which would otherwise be
  12726. // parsed as the next request on a persistent connection.
  12727. if (strcmp(line_reader.ptr(), "\r\n") == 0 && !line_reader.getline()) {
  12728. return false;
  12729. }
  12730. Request req;
  12731. req.start_time_ = std::chrono::steady_clock::now();
  12732. req.remote_addr = remote_addr;
  12733. req.remote_port = remote_port;
  12734. req.local_addr = local_addr;
  12735. req.local_port = local_port;
  12736. Response res;
  12737. res.version = "HTTP/1.1";
  12738. res.headers = default_headers_;
  12739. // RFC 9112 §9.6: a server that sends the "close" connection option must
  12740. // close the connection after that response, whichever path wrote it (an
  12741. // error status, a handler, or a rejected request). Reading on would also
  12742. // parse whatever the client sent next on a connection it considers done.
  12743. auto honor_connection_close = detail::scope_exit([&] {
  12744. if (detail::has_header_token(res.headers, "Connection", "close")) {
  12745. connection_closed = true;
  12746. }
  12747. });
  12748. // Request line and headers. A rejected message leaves the rest of it (and
  12749. // any body) unread, so the connection cannot be reused: the leftover bytes
  12750. // would be parsed as the next request.
  12751. if (!parse_request_line(line_reader.ptr(), req)) {
  12752. connection_closed = true;
  12753. res.status = StatusCode::BadRequest_400;
  12754. output_error_log(Error::InvalidRequestLine, &req);
  12755. return write_response(strm, close_connection, req, res);
  12756. }
  12757. // Request headers
  12758. if (!detail::read_headers(strm, req.headers)) {
  12759. connection_closed = true;
  12760. res.status = StatusCode::BadRequest_400;
  12761. output_error_log(Error::InvalidHeaders, &req);
  12762. return write_response(strm, close_connection, req, res);
  12763. }
  12764. strm.set_max_timeout(0);
  12765. // RFC 9112 §6.3: Reject requests whose framing is invalid or ambiguous,
  12766. // which would otherwise let an intermediary and this parser disagree on
  12767. // where the body ends and enable request smuggling. Three cases: a
  12768. // Content-Length that is not a valid decimal length (e.g. "42, 42", "+42"
  12769. // or empty), which would otherwise be read as "no body"; a non-zero
  12770. // Content-Length alongside any Transfer-Encoding (Content-Length: 0 is
  12771. // tolerated for compatibility with existing clients); and a
  12772. // Transfer-Encoding whose final coding is not chunked, which leaves the body
  12773. // length undeterminable. None of them may fall through to the "no body"
  12774. // path, or the body bytes are parsed as the next request on a persistent
  12775. // connection.
  12776. auto is_invalid_content_length = false;
  12777. detail::get_header_value_u64(req.headers, "Content-Length", 0, 0,
  12778. is_invalid_content_length);
  12779. if (is_invalid_content_length ||
  12780. detail::has_conflicting_content_length(req.headers) ||
  12781. (req.has_header("Transfer-Encoding") &&
  12782. !detail::is_chunked_transfer_encoding(req.headers))) {
  12783. connection_closed = true;
  12784. res.status = StatusCode::BadRequest_400;
  12785. return write_response(strm, close_connection, req, res);
  12786. }
  12787. // RFC 9112 §6.1: a Transfer-Encoding alongside a Content-Length, or in an
  12788. // HTTP/1.0 request, is honoured, but the connection closes after the
  12789. // response.
  12790. if (detail::has_faulty_transfer_encoding(req)) { connection_closed = true; }
  12791. // RFC 9112 §3.2: Reject more than one Host field line, an invalid Host
  12792. // value, or none in HTTP/1.1, so that every recipient of the request sees
  12793. // the same authority.
  12794. auto host_count = req.get_header_value_count("Host");
  12795. if (host_count > 1 || (host_count == 0 && req.version == "HTTP/1.1") ||
  12796. !detail::fields::is_host(req.get_header_value("Host"))) {
  12797. connection_closed = true;
  12798. res.status = StatusCode::BadRequest_400;
  12799. output_error_log(Error::InvalidHeaders, &req);
  12800. return write_response(strm, close_connection, req, res);
  12801. }
  12802. // Check if the request URI doesn't exceed the limit
  12803. if (req.target.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  12804. connection_closed = true;
  12805. res.status = StatusCode::UriTooLong_414;
  12806. output_error_log(Error::ExceedUriMaxLength, &req);
  12807. return write_response(strm, close_connection, req, res);
  12808. }
  12809. if (detail::has_header_token(req.headers, "Connection", "close")) {
  12810. connection_closed = true;
  12811. }
  12812. if (req.version == "HTTP/1.0" &&
  12813. !detail::has_header_token(req.headers, "Connection", "keep-alive")) {
  12814. connection_closed = true;
  12815. }
  12816. // Only honor X-Forwarded-For if the peer on the actual TCP connection is
  12817. // itself a trusted proxy. Otherwise any direct client could spoof
  12818. // remote_addr simply by sending an arbitrary X-Forwarded-For header.
  12819. auto is_trusted_peer = std::any_of(
  12820. trusted_proxies_.begin(), trusted_proxies_.end(),
  12821. [&](const std::string &proxy) { return proxy == remote_addr; });
  12822. if (is_trusted_peer && req.has_header("X-Forwarded-For")) {
  12823. // Some proxies append the address they observed as a separate
  12824. // X-Forwarded-For field line instead of extending the one the client sent
  12825. // (e.g. HAProxy's "option forwardfor"), so the whole combined value has to
  12826. // be scanned. Reading only the first occurrence would hand back the
  12827. // client-supplied, and therefore forgeable, value.
  12828. auto x_forwarded_for =
  12829. detail::get_combined_header_value(req.headers, "X-Forwarded-For");
  12830. auto derived = get_client_ip(x_forwarded_for, trusted_proxies_);
  12831. req.remote_addr = derived.empty() ? remote_addr : derived;
  12832. } else {
  12833. req.remote_addr = remote_addr;
  12834. }
  12835. req.remote_port = remote_port;
  12836. req.local_addr = local_addr;
  12837. req.local_port = local_port;
  12838. if (req.has_header("Accept")) {
  12839. auto accept_header =
  12840. detail::get_combined_header_value(req.headers, "Accept");
  12841. if (!detail::parse_accept_header(accept_header, req.accept_content_types)) {
  12842. connection_closed = true;
  12843. res.status = StatusCode::BadRequest_400;
  12844. output_error_log(Error::HTTPParsing, &req);
  12845. return write_response(strm, close_connection, req, res);
  12846. }
  12847. }
  12848. if (req.has_header("Range")) {
  12849. const auto &range_header_value = req.get_header_value("Range");
  12850. if (!detail::parse_range_header(range_header_value, req.ranges)) {
  12851. connection_closed = true;
  12852. res.status = StatusCode::RangeNotSatisfiable_416;
  12853. output_error_log(Error::InvalidRangeHeader, &req);
  12854. return write_response(strm, close_connection, req, res);
  12855. }
  12856. }
  12857. if (setup_request) { setup_request(req); }
  12858. // RFC 9110 10.1.1: Expect is a comma-separated list whose value is
  12859. // case-insensitive, and a 100-continue expectation in an HTTP/1.0 request
  12860. // must be ignored. An expectation we do not recognize is left alone; the
  12861. // 417 the section allows for one is a MAY, not a requirement.
  12862. //
  12863. // `100 Continue` itself is deferred until the body is actually read (see
  12864. // read_content_core), so a request rejected by a later handler never
  12865. // invites the client to send a body nobody will read.
  12866. if (req.version != "HTTP/1.0" &&
  12867. detail::has_header_token(req.headers, "Expect", "100-continue")) {
  12868. int status = StatusCode::Continue_100;
  12869. if (expect_100_continue_handler_) {
  12870. status = expect_100_continue_handler_(req, res);
  12871. }
  12872. if (status == StatusCode::Continue_100) {
  12873. req.expect_100_continue_pending_ = true;
  12874. } else {
  12875. if (res.status == -1) { res.status = status; }
  12876. connection_closed = true;
  12877. return write_response(strm, true, req, res);
  12878. }
  12879. }
  12880. // Setup `is_connection_closed` method
  12881. auto sock = strm.socket();
  12882. req.is_connection_closed = [sock]() {
  12883. return !detail::is_socket_alive(sock);
  12884. };
  12885. // WebSocket upgrade
  12886. // Run pre_routing_handler_ and pre_request_handler_ before upgrading so
  12887. // that authentication and other middleware can reject the request with an
  12888. // HTTP response (e.g., 401) before the protocol switches.
  12889. // The response says so when this connection closes after it.
  12890. auto close_after_response = close_connection || connection_closed;
  12891. if (detail::is_websocket_upgrade(req)) {
  12892. if (pre_routing_handler_ &&
  12893. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12894. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12895. return write_response_with_content(strm, close_after_response, req, res);
  12896. }
  12897. // Find matching WebSocket handler
  12898. for (const auto &entry : websocket_handlers_) {
  12899. if (entry.matcher->match(req)) {
  12900. req.matched_route = entry.matcher->pattern();
  12901. if (pre_request_handler_ &&
  12902. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12903. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12904. return write_response_with_content(strm, close_after_response, req,
  12905. res);
  12906. }
  12907. // Compute accept key
  12908. auto client_key = req.get_header_value("Sec-WebSocket-Key");
  12909. auto accept_key = detail::websocket_accept_key(client_key);
  12910. // Negotiate subprotocol
  12911. std::string selected_subprotocol;
  12912. if (entry.sub_protocol_selector) {
  12913. auto protocol_header = detail::get_combined_header_value(
  12914. req.headers, "Sec-WebSocket-Protocol");
  12915. if (!protocol_header.empty()) {
  12916. std::vector<std::string> protocols;
  12917. detail::split(protocol_header.data(),
  12918. protocol_header.data() + protocol_header.size(), ',',
  12919. [&](const char *b, const char *e) {
  12920. protocols.emplace_back(b, e);
  12921. });
  12922. selected_subprotocol = entry.sub_protocol_selector(protocols);
  12923. // Ignore a selection the client did not offer (RFC 6455 4.2.2)
  12924. if (std::find(protocols.begin(), protocols.end(),
  12925. selected_subprotocol) == protocols.end()) {
  12926. selected_subprotocol.clear();
  12927. }
  12928. }
  12929. }
  12930. // Send 101 Switching Protocols
  12931. std::string handshake_response = "HTTP/1.1 101 Switching Protocols\r\n"
  12932. "Upgrade: websocket\r\n"
  12933. "Connection: Upgrade\r\n"
  12934. "Sec-WebSocket-Accept: " +
  12935. accept_key + "\r\n";
  12936. if (!selected_subprotocol.empty()) {
  12937. if (!detail::fields::is_field_value(selected_subprotocol)) {
  12938. return false;
  12939. }
  12940. handshake_response +=
  12941. "Sec-WebSocket-Protocol: " + selected_subprotocol + "\r\n";
  12942. }
  12943. handshake_response += "\r\n";
  12944. if (strm.write(handshake_response.data(), handshake_response.size()) <
  12945. 0) {
  12946. return false;
  12947. }
  12948. connection_closed = true;
  12949. if (websocket_upgraded) { *websocket_upgraded = true; }
  12950. {
  12951. #ifdef CPPHTTPLIB_SSL_ENABLED
  12952. if (req.ssl) {
  12953. // wss: the heartbeat ping thread and the read path enter the same
  12954. // TLS session from different threads. Hand the WebSocket a stream
  12955. // that serializes every TLS call, so the shared SSLSocketStream on
  12956. // the plain HTTP/HTTPS paths stays untouched.
  12957. auto ws_strm =
  12958. std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  12959. strm.socket(), const_cast<tls::session_t>(req.ssl),
  12960. CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0,
  12961. write_timeout_sec_, write_timeout_usec_));
  12962. ws::WebSocket ws(std::move(ws_strm), req, true,
  12963. websocket_ping_interval_sec_,
  12964. websocket_max_missed_pongs_);
  12965. entry.handler(req, ws);
  12966. return true;
  12967. }
  12968. #endif
  12969. // Use WebSocket-specific read timeout instead of HTTP timeout
  12970. strm.set_read_timeout(CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND,
  12971. 0);
  12972. ws::WebSocket ws(strm, req, true, websocket_ping_interval_sec_,
  12973. websocket_max_missed_pongs_);
  12974. entry.handler(req, ws);
  12975. }
  12976. return true;
  12977. }
  12978. }
  12979. // No matching handler - fall through to 404
  12980. }
  12981. // Routing
  12982. auto routed = false;
  12983. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  12984. routed = routing(req, res, strm);
  12985. #else
  12986. try {
  12987. routed = routing(req, res, strm);
  12988. } catch (std::exception &) {
  12989. if (exception_handler_) {
  12990. auto ep = std::current_exception();
  12991. exception_handler_(req, res, ep);
  12992. routed = true;
  12993. } else {
  12994. res.status = StatusCode::InternalServerError_500;
  12995. }
  12996. } catch (...) {
  12997. if (exception_handler_) {
  12998. auto ep = std::current_exception();
  12999. exception_handler_(req, res, ep);
  13000. routed = true;
  13001. } else {
  13002. res.status = StatusCode::InternalServerError_500;
  13003. }
  13004. }
  13005. #endif
  13006. auto ret = false;
  13007. if (routed) {
  13008. if (res.status == -1) {
  13009. res.status = req.ranges.empty() ? StatusCode::OK_200
  13010. : StatusCode::PartialContent_206;
  13011. }
  13012. // Before the Range checks below, so they see the body's own length.
  13013. detail::prefer_assigned_body(res);
  13014. // Serve file content by using a content provider
  13015. auto file_open_error = false;
  13016. if (!res.file_content_path_.empty()) {
  13017. const auto &path = res.file_content_path_;
  13018. auto mm = std::make_shared<detail::mmap>(path.c_str());
  13019. if (!mm->is_open()) {
  13020. res.status = StatusCode::NotFound_404;
  13021. output_error_log(Error::OpenFile, &req);
  13022. file_open_error = true;
  13023. } else {
  13024. auto content_type = res.file_content_content_type_;
  13025. if (content_type.empty()) {
  13026. // One the handler set after set_file_content()
  13027. content_type = res.get_header_value("Content-Type");
  13028. }
  13029. if (content_type.empty()) {
  13030. content_type = detail::find_content_type(
  13031. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  13032. }
  13033. detail::set_file_content_provider(
  13034. res, mm, content_type,
  13035. static_file_encoding(req, res, content_type, mm->size()));
  13036. }
  13037. }
  13038. if (file_open_error) {
  13039. ret = write_response(strm, close_after_response, req, res);
  13040. } else if (detail::range_error(req, res)) {
  13041. detail::clear_content(res);
  13042. res.status = StatusCode::RangeNotSatisfiable_416;
  13043. ret = write_response(strm, close_after_response, req, res);
  13044. } else {
  13045. ret = write_response_with_content(strm, close_after_response, req, res);
  13046. }
  13047. } else {
  13048. if (res.status == -1) { res.status = StatusCode::NotFound_404; }
  13049. ret = write_response(strm, close_after_response, req, res);
  13050. }
  13051. // Drain any unconsumed framed body to prevent request smuggling on
  13052. // keep-alive. Without framing there is no body to drain — reading would
  13053. // consume the next request (issue #2450). If the response has committed the
  13054. // connection to close, there is no next request to protect. A body read in
  13055. // part cannot be drained from where it stopped, so the connection closes.
  13056. if (!req.body_consumed_ && detail::has_framed_body(req) &&
  13057. !detail::has_header_token(res.headers, "Connection", "close")) {
  13058. int dummy_status;
  13059. if (req.body_read_started_ ||
  13060. !detail::read_content(
  13061. strm, req, payload_max_length_, dummy_status, nullptr,
  13062. [](const char *, size_t, size_t, size_t) { return true; }, false)) {
  13063. connection_closed = true;
  13064. }
  13065. }
  13066. return ret;
  13067. }
  13068. inline bool Server::is_valid() const { return !has_invalid_registration_; }
  13069. inline bool Server::process_and_close_socket(socket_t sock) {
  13070. std::string remote_addr;
  13071. int remote_port = 0;
  13072. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  13073. std::string local_addr;
  13074. int local_port = 0;
  13075. detail::get_local_ip_and_port(sock, local_addr, local_port);
  13076. bool websocket_upgraded = false;
  13077. auto ret = serve_guarded([&]() {
  13078. return detail::process_server_socket(
  13079. svr_sock_, sock, keep_alive_max_count_, keep_alive_timeout_sec_,
  13080. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13081. write_timeout_usec_,
  13082. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  13083. return process_request(strm, remote_addr, remote_port, local_addr,
  13084. local_port, close_connection,
  13085. connection_closed, nullptr,
  13086. &websocket_upgraded);
  13087. });
  13088. });
  13089. detail::drain_and_close_socket(sock);
  13090. return ret;
  13091. }
  13092. inline void Server::output_log(const Request &req, const Response &res) const {
  13093. if (logger_) {
  13094. std::lock_guard<std::mutex> guard(logger_mutex_);
  13095. logger_(req, res);
  13096. }
  13097. }
  13098. inline void Server::output_pre_compression_log(const Request &req,
  13099. const Response &res) const {
  13100. if (pre_compression_logger_) {
  13101. std::lock_guard<std::mutex> guard(logger_mutex_);
  13102. pre_compression_logger_(req, res);
  13103. }
  13104. }
  13105. inline void Server::output_error_log(const Error &err,
  13106. const Request *req) const {
  13107. if (error_logger_) {
  13108. std::lock_guard<std::mutex> guard(logger_mutex_);
  13109. error_logger_(err, req);
  13110. }
  13111. }
  13112. /*
  13113. * Group 5: ClientImpl and Client (Universal) implementation
  13114. */
  13115. // HTTP client implementation
  13116. inline ClientImpl::ClientImpl(const std::string &host)
  13117. : ClientImpl(host, 80, std::string(), std::string()) {}
  13118. inline ClientImpl::ClientImpl(const std::string &host, int port)
  13119. : ClientImpl(host, port, std::string(), std::string()) {}
  13120. inline ClientImpl::ClientImpl(const std::string &host, int port,
  13121. const std::string &client_cert_path,
  13122. const std::string &client_key_path)
  13123. : host_(detail::escape_abstract_namespace_unix_domain(host)), port_(port),
  13124. client_cert_path_(client_cert_path), client_key_path_(client_key_path) {}
  13125. inline ClientImpl::~ClientImpl() {
  13126. // Wait until all the requests in flight are handled.
  13127. size_t retry_count = 10;
  13128. while (retry_count-- > 0) {
  13129. {
  13130. std::lock_guard<std::mutex> guard(socket_mutex_);
  13131. if (socket_requests_in_flight_ == 0) { break; }
  13132. }
  13133. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  13134. }
  13135. std::lock_guard<std::mutex> guard(socket_mutex_);
  13136. shutdown_socket(socket_);
  13137. close_socket(socket_);
  13138. }
  13139. inline bool ClientImpl::is_valid() const { return true; }
  13140. inline bool
  13141. ClientImpl::is_proxy_enabled_for_host(const std::string &host) const {
  13142. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  13143. if (no_proxy_entries_.empty()) { return true; }
  13144. // host_ is const so its normalized form is invariant; cache it. The
  13145. // cross-host path (setup_redirect_client passing next_host) re-normalizes.
  13146. if (host == host_) {
  13147. if (!host_normalized_valid_) {
  13148. host_normalized_ = detail::normalize_target(host_);
  13149. host_normalized_valid_ = true;
  13150. }
  13151. return !detail::host_matches_no_proxy(host_normalized_, no_proxy_entries_);
  13152. }
  13153. auto target = detail::normalize_target(host);
  13154. return !detail::host_matches_no_proxy(target, no_proxy_entries_);
  13155. }
  13156. inline socket_t ClientImpl::create_client_socket(Error &error) const {
  13157. if (is_proxy_enabled_for_host(host_)) {
  13158. return detail::create_client_socket(
  13159. proxy_host_, std::string(), proxy_port_, address_family_, tcp_nodelay_,
  13160. ipv6_v6only_, socket_options_, connection_timeout_sec_,
  13161. connection_timeout_usec_, read_timeout_sec_, read_timeout_usec_,
  13162. write_timeout_sec_, write_timeout_usec_, interface_, error);
  13163. }
  13164. // Check is custom IP or hostname specified for host_
  13165. std::string connect_host;
  13166. std::string ip;
  13167. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  13168. return detail::create_client_socket(
  13169. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  13170. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  13171. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13172. write_timeout_usec_, interface_, error);
  13173. }
  13174. inline bool ClientImpl::create_and_connect_socket(Socket &socket,
  13175. Error &error) {
  13176. auto sock = create_client_socket(error);
  13177. if (sock == INVALID_SOCKET) { return false; }
  13178. socket.sock = sock;
  13179. return true;
  13180. }
  13181. inline bool ClientImpl::ensure_socket_connection(Socket &socket, Error &error) {
  13182. return create_and_connect_socket(socket, error);
  13183. }
  13184. inline bool ClientImpl::setup_proxy_connection(
  13185. Socket & /*socket*/,
  13186. std::chrono::time_point<std::chrono::steady_clock> /*start_time*/,
  13187. Response & /*res*/, bool & /*success*/, Error & /*error*/) {
  13188. return true;
  13189. }
  13190. inline void ClientImpl::shutdown_ssl(Socket & /*socket*/,
  13191. bool /*shutdown_gracefully*/) {
  13192. // If there are any requests in flight from threads other than us, then it's
  13193. // a thread-unsafe race because individual ssl* objects are not thread-safe.
  13194. assert(socket_requests_in_flight_ == 0 ||
  13195. socket_requests_are_from_thread_ == std::this_thread::get_id());
  13196. }
  13197. inline void ClientImpl::shutdown_socket(Socket &socket) const {
  13198. if (socket.sock == INVALID_SOCKET) { return; }
  13199. detail::shutdown_socket(socket.sock);
  13200. }
  13201. inline void ClientImpl::close_socket(Socket &socket) {
  13202. // If there are requests in flight in another thread, usually closing
  13203. // the socket will be fine and they will simply receive an error when
  13204. // using the closed socket, but it is still a bug since rarely the OS
  13205. // may reassign the socket id to be used for a new socket, and then
  13206. // suddenly they will be operating on a live socket that is different
  13207. // than the one they intended!
  13208. assert(socket_requests_in_flight_ == 0 ||
  13209. socket_requests_are_from_thread_ == std::this_thread::get_id());
  13210. // It is also a bug if this happens while SSL is still active
  13211. #ifdef CPPHTTPLIB_SSL_ENABLED
  13212. assert(socket.ssl == nullptr);
  13213. #endif
  13214. if (socket.sock == INVALID_SOCKET) { return; }
  13215. detail::close_socket(socket.sock);
  13216. socket.sock = INVALID_SOCKET;
  13217. }
  13218. inline void ClientImpl::disconnect(bool gracefully) {
  13219. shutdown_ssl(socket_, gracefully);
  13220. shutdown_socket(socket_);
  13221. close_socket(socket_);
  13222. }
  13223. inline bool ClientImpl::read_response_line(Stream &strm, const Request &req,
  13224. Response &res,
  13225. bool skip_100_continue) const {
  13226. std::array<char, 2048> buf{};
  13227. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  13228. if (!line_reader.getline()) { return false; }
  13229. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  13230. res.reason)) {
  13231. return req.method == "CONNECT";
  13232. }
  13233. // Skip interim (1xx) responses along with their header fields, except a 100
  13234. // Continue the caller handles itself for Expect: 100-continue. 101 ends
  13235. // HTTP on the connection, so it is final. A server sending them without end
  13236. // would hold the client, so there may be only so many.
  13237. size_t interim_count = 0;
  13238. while (100 <= res.status && res.status < 200 &&
  13239. res.status != StatusCode::SwitchingProtocol_101 &&
  13240. (skip_100_continue || res.status != StatusCode::Continue_100)) {
  13241. if (++interim_count > CPPHTTPLIB_INTERIM_RESPONSE_MAX_COUNT) {
  13242. return false;
  13243. }
  13244. Headers interim_headers;
  13245. if (!detail::read_headers(strm, interim_headers)) { return false; }
  13246. if (!line_reader.getline()) { return false; } // next response line
  13247. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  13248. res.reason)) {
  13249. return false;
  13250. }
  13251. }
  13252. return true;
  13253. }
  13254. inline bool ClientImpl::send(Request &req, Response &res, Error &error) {
  13255. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  13256. auto ret = send_(req, res, error);
  13257. if (error == Error::SSLPeerCouldBeClosed_) {
  13258. assert(!ret);
  13259. ret = send_(req, res, error);
  13260. // If still failing with SSLPeerCouldBeClosed_, convert to Read error
  13261. if (error == Error::SSLPeerCouldBeClosed_) { error = Error::Read; }
  13262. }
  13263. return ret;
  13264. }
  13265. inline bool ClientImpl::send_(Request &req, Response &res, Error &error) {
  13266. #ifdef CPPHTTPLIB_SSL_ENABLED
  13267. // Don't let an earlier attempt's TLS error show up in this one's Result. A
  13268. // client that failed to set up its TLS context keeps reporting why.
  13269. if (is_valid()) {
  13270. last_ssl_error_ = 0;
  13271. last_backend_error_ = 0;
  13272. }
  13273. #endif
  13274. {
  13275. std::lock_guard<std::mutex> guard(socket_mutex_);
  13276. // Set this to false immediately - if it ever gets set to true by the end
  13277. // of the request, we know another thread instructed us to close the
  13278. // socket.
  13279. socket_should_be_closed_when_request_is_done_ = false;
  13280. auto is_alive = false;
  13281. if (socket_.is_open()) {
  13282. is_alive = detail::is_socket_alive(socket_.sock);
  13283. #ifdef CPPHTTPLIB_SSL_ENABLED
  13284. if (is_alive && is_ssl()) {
  13285. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13286. is_alive = false;
  13287. }
  13288. }
  13289. #endif
  13290. if (!is_alive) {
  13291. // Peer seems gone — non-graceful shutdown to avoid SIGPIPE.
  13292. disconnect(/*gracefully=*/false);
  13293. }
  13294. }
  13295. if (!is_alive) {
  13296. if (!ensure_socket_connection(socket_, error)) {
  13297. output_error_log(error, &req);
  13298. return false;
  13299. }
  13300. {
  13301. auto success = true;
  13302. if (!setup_proxy_connection(socket_, req.start_time_, res, success,
  13303. error)) {
  13304. if (!success) { output_error_log(error, &req); }
  13305. return success;
  13306. }
  13307. }
  13308. }
  13309. // Mark the current socket as being in use so that it cannot be closed by
  13310. // anyone else while this request is ongoing, even though we will be
  13311. // releasing the mutex.
  13312. if (socket_requests_in_flight_ > 1) {
  13313. assert(socket_requests_are_from_thread_ == std::this_thread::get_id());
  13314. }
  13315. socket_requests_in_flight_ += 1;
  13316. socket_requests_are_from_thread_ = std::this_thread::get_id();
  13317. }
  13318. for (const auto &header : default_headers_) {
  13319. if (req.headers.find(header.first) == req.headers.end()) {
  13320. req.headers.insert(header);
  13321. }
  13322. }
  13323. auto ret = false;
  13324. auto close_connection = !keep_alive_;
  13325. auto se = detail::scope_exit([&]() {
  13326. // Briefly lock mutex in order to mark that a request is no longer ongoing
  13327. std::lock_guard<std::mutex> guard(socket_mutex_);
  13328. socket_requests_in_flight_ -= 1;
  13329. if (socket_requests_in_flight_ <= 0) {
  13330. assert(socket_requests_in_flight_ == 0);
  13331. socket_requests_are_from_thread_ = std::thread::id();
  13332. }
  13333. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  13334. !ret) {
  13335. disconnect(/*gracefully=*/true);
  13336. }
  13337. });
  13338. ret = process_socket(socket_, req.start_time_, [&](Stream &strm) {
  13339. return handle_request(strm, req, res, close_connection, error);
  13340. });
  13341. if (!ret) {
  13342. if (error == Error::Success) {
  13343. error = Error::Unknown;
  13344. output_error_log(error, &req);
  13345. }
  13346. }
  13347. return ret;
  13348. }
  13349. inline Result ClientImpl::send(const Request &req) {
  13350. auto req2 = req;
  13351. return send_(std::move(req2));
  13352. }
  13353. inline Result ClientImpl::send_(Request &&req) {
  13354. auto res = detail::make_unique<Response>();
  13355. auto error = Error::Success;
  13356. #ifdef CPPHTTPLIB_SSL_ENABLED
  13357. // Hold the request lock until the Result has read this request's TLS error
  13358. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  13359. #endif
  13360. auto ret = send(req, *res, error);
  13361. #ifdef CPPHTTPLIB_SSL_ENABLED
  13362. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers),
  13363. last_ssl_error_, last_backend_error_};
  13364. #else
  13365. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers)};
  13366. #endif
  13367. }
  13368. inline void ClientImpl::prepare_default_headers(Request &r, bool for_stream,
  13369. const std::string &ct) {
  13370. (void)for_stream;
  13371. // Default headers are meant for the origin and may carry its credentials, so
  13372. // keep them off the CONNECT request the proxy reads.
  13373. if (r.method != "CONNECT") {
  13374. for (const auto &header : default_headers_) {
  13375. if (!r.has_header(header.first)) { r.headers.insert(header); }
  13376. }
  13377. }
  13378. // RFC 9110 5.3 recommends sending control data such as Host first, so
  13379. // prepend it rather than appending it after the caller's own fields.
  13380. if (!r.has_header("Host")) {
  13381. r.headers.emplace_front(
  13382. "Host", detail::make_default_host_header_value(host_, port_, is_ssl(),
  13383. address_family_));
  13384. }
  13385. if (!r.has_header("Accept")) { r.headers.emplace("Accept", "*/*"); }
  13386. if (!r.content_receiver) {
  13387. if (!r.has_header("Accept-Encoding")) {
  13388. std::string accept_encoding;
  13389. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  13390. accept_encoding = "br";
  13391. #endif
  13392. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  13393. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13394. accept_encoding += "gzip, deflate";
  13395. #endif
  13396. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  13397. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13398. accept_encoding += "zstd";
  13399. #endif
  13400. r.set_header("Accept-Encoding", accept_encoding);
  13401. }
  13402. detail::add_default_user_agent_header(r);
  13403. }
  13404. if (!r.body.empty()) {
  13405. if (!ct.empty() && !r.has_header("Content-Type")) {
  13406. r.headers.emplace("Content-Type", ct);
  13407. }
  13408. if (!r.has_header("Content-Length")) {
  13409. r.headers.emplace("Content-Length", std::to_string(r.body.size()));
  13410. }
  13411. }
  13412. }
  13413. inline ClientImpl::StreamHandle
  13414. ClientImpl::open_stream(const std::string &method, const std::string &path,
  13415. const Params &params, const Headers &headers,
  13416. const std::string &body,
  13417. const std::string &content_type) {
  13418. StreamHandle handle;
  13419. handle.response = detail::make_unique<Response>();
  13420. handle.error = Error::Success;
  13421. // Encode the target exactly like the buffered send path does, so that the
  13422. // same `path` produces the same request line through either API.
  13423. auto raw_query_path =
  13424. params.empty() ? path : append_query_params(path, params);
  13425. auto query_path = detail::encode_request_target(raw_query_path, path_encode_);
  13426. handle.connection_ = detail::make_unique<ClientConnection>();
  13427. {
  13428. std::lock_guard<std::mutex> guard(socket_mutex_);
  13429. auto is_alive = false;
  13430. if (socket_.is_open()) {
  13431. is_alive = detail::is_socket_alive(socket_.sock);
  13432. #ifdef CPPHTTPLIB_SSL_ENABLED
  13433. if (is_alive && is_ssl()) {
  13434. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13435. is_alive = false;
  13436. }
  13437. }
  13438. #endif
  13439. if (!is_alive) { disconnect(/*gracefully=*/false); }
  13440. }
  13441. if (!is_alive) {
  13442. if (!ensure_socket_connection(socket_, handle.error)) {
  13443. handle.response.reset();
  13444. return handle;
  13445. }
  13446. {
  13447. auto success = true;
  13448. auto start_time = std::chrono::steady_clock::now();
  13449. if (!setup_proxy_connection(socket_, start_time, *handle.response,
  13450. success, handle.error)) {
  13451. if (!success) { handle.response.reset(); }
  13452. return handle;
  13453. }
  13454. }
  13455. }
  13456. transfer_socket_ownership_to_handle(handle);
  13457. }
  13458. #ifdef CPPHTTPLIB_SSL_ENABLED
  13459. if (is_ssl() && handle.connection_->session) {
  13460. handle.socket_stream_ = detail::make_unique<detail::SSLSocketStream>(
  13461. handle.connection_->sock, handle.connection_->session,
  13462. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13463. write_timeout_usec_);
  13464. } else {
  13465. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13466. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13467. write_timeout_sec_, write_timeout_usec_);
  13468. }
  13469. #else
  13470. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13471. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13472. write_timeout_sec_, write_timeout_usec_);
  13473. #endif
  13474. handle.stream_ = handle.socket_stream_.get();
  13475. Request req;
  13476. req.method = method;
  13477. req.path = query_path;
  13478. req.headers = headers;
  13479. req.body = body;
  13480. prepare_default_headers(req, true, content_type);
  13481. auto &strm = *handle.stream_;
  13482. // Build the request line and headers in memory first, like write_request()
  13483. // does, so that a rejected header leaves nothing on the wire.
  13484. {
  13485. detail::BufferStream bstrm;
  13486. if (detail::write_request_line(bstrm, req.method, req.path) < 0) {
  13487. handle.error = Error::Write;
  13488. handle.response.reset();
  13489. return handle;
  13490. }
  13491. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13492. handle.error)) {
  13493. handle.response.reset();
  13494. return handle;
  13495. }
  13496. const auto &data = bstrm.get_buffer();
  13497. if (!detail::write_data(strm, data.data(), data.size())) {
  13498. handle.error = Error::Write;
  13499. handle.response.reset();
  13500. return handle;
  13501. }
  13502. }
  13503. if (!body.empty()) {
  13504. if (strm.write(body.data(), body.size()) < 0) {
  13505. handle.error = Error::Write;
  13506. handle.response.reset();
  13507. return handle;
  13508. }
  13509. }
  13510. if (!read_response_line(strm, req, *handle.response) ||
  13511. !detail::read_headers(strm, handle.response->headers)) {
  13512. handle.error = Error::Read;
  13513. handle.response.reset();
  13514. return handle;
  13515. }
  13516. // Same framing check as ClientImpl::process_request(). A HEAD or bodyless
  13517. // (204/304) response legitimately carries framing headers with no body.
  13518. if (method != "HEAD" &&
  13519. handle.response->status != StatusCode::NoContent_204 &&
  13520. handle.response->status != StatusCode::NotModified_304 &&
  13521. detail::has_conflicting_content_length(handle.response->headers)) {
  13522. handle.error = Error::Read;
  13523. handle.response.reset();
  13524. return handle;
  13525. }
  13526. handle.body_reader_.stream = handle.stream_;
  13527. handle.body_reader_.payload_max_length = payload_max_length_;
  13528. if (handle.response->has_header("Content-Length")) {
  13529. bool is_invalid = false;
  13530. auto content_length = detail::get_header_value_u64(
  13531. handle.response->headers, "Content-Length", 0, 0, is_invalid);
  13532. if (is_invalid) {
  13533. handle.error = Error::Read;
  13534. handle.response.reset();
  13535. return handle;
  13536. }
  13537. handle.body_reader_.has_content_length = true;
  13538. handle.body_reader_.content_length = content_length;
  13539. }
  13540. handle.body_reader_.chunked =
  13541. detail::is_chunked_transfer_encoding(handle.response->headers);
  13542. auto content_encoding = detail::get_combined_header_value(
  13543. handle.response->headers, "Content-Encoding");
  13544. if (!content_encoding.empty()) {
  13545. // Same policy as prepare_content_receiver(): reject a coding we know about
  13546. // but were not built with, pass an unrecognized one through as-is.
  13547. handle.decompressor_ = detail::create_decompressor(content_encoding);
  13548. if (!handle.decompressor_) {
  13549. if (detail::is_known_content_encoding(content_encoding)) {
  13550. handle.error = Error::UnsupportedContentEncoding;
  13551. handle.response.reset();
  13552. return handle;
  13553. }
  13554. } else if (!handle.decompressor_->is_valid()) {
  13555. handle.error = Error::Compression;
  13556. handle.response.reset();
  13557. return handle;
  13558. }
  13559. }
  13560. return handle;
  13561. }
  13562. inline ssize_t ClientImpl::StreamHandle::read(char *buf, size_t len) {
  13563. if (!is_valid() || !response) { return -1; }
  13564. if (decompressor_) { return read_with_decompression(buf, len); }
  13565. auto n = detail::read_body_content(stream_, body_reader_, buf, len);
  13566. if (n <= 0 && body_reader_.chunked && !trailers_parsed_ && stream_) {
  13567. trailers_parsed_ = true;
  13568. if (body_reader_.chunked_decoder) {
  13569. if (!body_reader_.chunked_decoder->parse_trailers_into(
  13570. response->trailers, response->headers)) {
  13571. return n;
  13572. }
  13573. } else {
  13574. detail::ChunkedDecoder dec(*stream_);
  13575. if (!dec.parse_trailers_into(response->trailers, response->headers)) {
  13576. return n;
  13577. }
  13578. }
  13579. }
  13580. return n;
  13581. }
  13582. inline ssize_t ClientImpl::StreamHandle::read_with_decompression(char *buf,
  13583. size_t len) {
  13584. if (decompress_offset_ < decompress_buffer_.size()) {
  13585. auto available = decompress_buffer_.size() - decompress_offset_;
  13586. auto to_copy = (std::min)(len, available);
  13587. std::memcpy(buf, decompress_buffer_.data() + decompress_offset_, to_copy);
  13588. decompress_offset_ += to_copy;
  13589. decompressed_bytes_read_ += to_copy;
  13590. return static_cast<ssize_t>(to_copy);
  13591. }
  13592. decompress_buffer_.clear();
  13593. decompress_offset_ = 0;
  13594. constexpr size_t kDecompressionBufferSize = 8192;
  13595. char compressed_buf[kDecompressionBufferSize];
  13596. while (true) {
  13597. auto n = detail::read_body_content(stream_, body_reader_, compressed_buf,
  13598. sizeof(compressed_buf));
  13599. if (n <= 0) { return n; }
  13600. auto exceeded = false;
  13601. bool decompress_ok = decompressor_->decompress(
  13602. compressed_buf, static_cast<size_t>(n),
  13603. [&](const char *data, size_t data_len) {
  13604. decompress_buffer_.append(data, data_len);
  13605. auto limit = body_reader_.payload_max_length;
  13606. exceeded =
  13607. limit > 0 &&
  13608. decompressed_bytes_read_ + decompress_buffer_.size() > limit;
  13609. return !exceeded;
  13610. });
  13611. if (!decompress_ok) {
  13612. body_reader_.last_error =
  13613. exceeded ? Error::ExceedMaxPayloadSize : Error::Read;
  13614. return -1;
  13615. }
  13616. if (!decompress_buffer_.empty()) { break; }
  13617. }
  13618. auto to_copy = (std::min)(len, decompress_buffer_.size());
  13619. std::memcpy(buf, decompress_buffer_.data(), to_copy);
  13620. decompress_offset_ = to_copy;
  13621. decompressed_bytes_read_ += to_copy;
  13622. return static_cast<ssize_t>(to_copy);
  13623. }
  13624. inline void ClientImpl::StreamHandle::parse_trailers_if_needed() {
  13625. if (!response || !stream_ || !body_reader_.chunked || trailers_parsed_) {
  13626. return;
  13627. }
  13628. trailers_parsed_ = true;
  13629. const auto bufsiz = 128;
  13630. char line_buf[bufsiz];
  13631. detail::stream_line_reader line_reader(*stream_, line_buf, bufsiz);
  13632. if (!line_reader.getline()) { return; }
  13633. if (!detail::parse_trailers(line_reader, response->trailers,
  13634. response->headers)) {
  13635. return;
  13636. }
  13637. }
  13638. namespace detail {
  13639. inline ChunkedDecoder::ChunkedDecoder(Stream &s) : strm(s) {}
  13640. inline ssize_t ChunkedDecoder::read_payload(char *buf, size_t len,
  13641. size_t &out_chunk_offset,
  13642. size_t &out_chunk_total) {
  13643. if (finished) { return 0; }
  13644. if (chunk_remaining == 0) {
  13645. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13646. if (!lr.getline()) { return -1; }
  13647. // Everything below is bounded by eol rather than by the buffer's NUL, so
  13648. // the line terminator is never mistaken for line content.
  13649. const char *eol = lr.ptr() + lr.size();
  13650. if (lr.end_with_crlf()) {
  13651. eol -= 2;
  13652. } else if (eol != lr.ptr() && eol[-1] == '\n') {
  13653. // Only reachable under CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR, where
  13654. // getline() ends the line on a bare LF. That LF is the terminator, so it
  13655. // has to come off here or the check below would reject the line.
  13656. eol -= 1;
  13657. }
  13658. // RFC 9112 §7.1: chunk-size = 1*HEXDIG
  13659. const char *p = lr.ptr();
  13660. int v = 0;
  13661. if (p == eol || !is_hex(*p, v)) { return -1; }
  13662. size_t chunk_len = 0;
  13663. constexpr size_t chunk_len_max = (std::numeric_limits<size_t>::max)();
  13664. for (; p < eol && is_hex(*p, v); ++p) {
  13665. if (chunk_len > (chunk_len_max >> 4)) { return -1; }
  13666. chunk_len = (chunk_len << 4) | static_cast<size_t>(v);
  13667. }
  13668. while (p < eol && is_space_or_tab(*p)) {
  13669. ++p;
  13670. }
  13671. // RFC 9112 §7.1.1: only a chunk-ext may sit between the size and the line
  13672. // terminator, and it is built from tokens and quoted-strings, so it never
  13673. // holds a CR, LF or any other control character. getline() reads up to the
  13674. // CRLF, so a bare LF left in here would be swallowed as extension text
  13675. // while an intermediary that ends the line on it delimits the chunks
  13676. // differently, and the two disagree on where the body ends (request
  13677. // smuggling).
  13678. if (p < eol && *p != ';') { return -1; }
  13679. for (; p < eol; ++p) {
  13680. if (!is_space_or_tab(*p) && !fields::is_field_vchar(*p)) { return -1; }
  13681. }
  13682. if (chunk_len == 0) {
  13683. chunk_remaining = 0;
  13684. finished = true;
  13685. out_chunk_offset = 0;
  13686. out_chunk_total = 0;
  13687. return 0;
  13688. }
  13689. chunk_remaining = chunk_len;
  13690. last_chunk_total = chunk_remaining;
  13691. last_chunk_offset = 0;
  13692. }
  13693. auto to_read = (std::min)(chunk_remaining, len);
  13694. auto n = strm.read(buf, to_read);
  13695. if (n <= 0) { return -1; }
  13696. auto offset_before = last_chunk_offset;
  13697. last_chunk_offset += static_cast<size_t>(n);
  13698. chunk_remaining -= static_cast<size_t>(n);
  13699. out_chunk_offset = offset_before;
  13700. out_chunk_total = last_chunk_total;
  13701. if (chunk_remaining == 0) {
  13702. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13703. if (!lr.getline()) { return -1; }
  13704. if (std::strcmp(lr.ptr(), "\r\n") != 0) { return -1; }
  13705. }
  13706. return n;
  13707. }
  13708. inline bool ChunkedDecoder::parse_trailers_into(Headers &dest,
  13709. const Headers &src_headers) {
  13710. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13711. if (!lr.getline()) { return false; }
  13712. return parse_trailers(lr, dest, src_headers);
  13713. }
  13714. // A 3xx without a Location, such as a 304, is a final response
  13715. inline bool is_redirect(const Response &res) {
  13716. return 300 < res.status && res.status < 400 &&
  13717. !res.get_header_value("Location").empty();
  13718. }
  13719. } // namespace detail
  13720. inline void
  13721. ClientImpl::transfer_socket_ownership_to_handle(StreamHandle &handle) {
  13722. handle.connection_->sock = socket_.sock;
  13723. #ifdef CPPHTTPLIB_SSL_ENABLED
  13724. handle.connection_->session = socket_.ssl;
  13725. socket_.ssl = nullptr;
  13726. #endif
  13727. socket_.sock = INVALID_SOCKET;
  13728. }
  13729. inline bool ClientImpl::handle_request(Stream &strm, Request &req,
  13730. Response &res, bool close_connection,
  13731. Error &error) {
  13732. if (req.path.empty()) {
  13733. error = Error::Connection;
  13734. output_error_log(error, &req);
  13735. return false;
  13736. }
  13737. auto req_save = req;
  13738. bool ret;
  13739. if (!is_ssl() && is_proxy_enabled_for_host(host_)) {
  13740. auto req2 = req;
  13741. req2.path = "http://" +
  13742. detail::make_host_and_port_string(host_, port_, false) +
  13743. req.path;
  13744. ret = process_request(strm, req2, res, close_connection, error);
  13745. req = std::move(req2);
  13746. req.path = req_save.path;
  13747. } else {
  13748. ret = process_request(strm, req, res, close_connection, error);
  13749. }
  13750. if (!ret) { return false; }
  13751. {
  13752. // NOTE: this requires a not-entirely-obvious chain of calls to be correct
  13753. // for this to be safe.
  13754. // This is safe to call because handle_request is only called by send_
  13755. // which locks the request mutex during the process. It would be a bug
  13756. // to call it from a different thread since it's a thread-safety issue
  13757. // to do these things to the socket if another thread is using the socket.
  13758. std::lock_guard<std::mutex> guard(socket_mutex_);
  13759. // Also when the request asked for it (e.g. a body that was never sent),
  13760. // so that a redirect or an auth retry below does not reuse the socket.
  13761. if (socket_should_be_closed_when_request_is_done_ ||
  13762. detail::has_header_token(res.headers, "Connection", "close") ||
  13763. (res.version == "HTTP/1.0" && res.reason != "Connection established")) {
  13764. disconnect(/*gracefully=*/true);
  13765. }
  13766. }
  13767. if (follow_location_ && detail::is_redirect(res)) {
  13768. req = std::move(req_save);
  13769. // The client that followed the redirect has answered any challenge it
  13770. // could. Retrying below would sign another host's challenge and send it
  13771. // here.
  13772. return redirect(req, res, error);
  13773. }
  13774. #ifdef CPPHTTPLIB_SSL_ENABLED
  13775. if ((res.status == StatusCode::Unauthorized_401 ||
  13776. res.status == StatusCode::ProxyAuthenticationRequired_407) &&
  13777. req.authorization_count_ < 5) {
  13778. auto is_proxy = res.status == StatusCode::ProxyAuthenticationRequired_407;
  13779. // Only retry when the 407 actually came from a proxy hop: plain HTTP
  13780. // through an enabled proxy. HTTPS via CONNECT tunnels the 407 from the
  13781. // origin (#2457); direct/bypassed origins have no proxy hop at all.
  13782. if (is_proxy && !(!is_ssl() && is_proxy_enabled_for_host(host_))) {
  13783. return ret;
  13784. }
  13785. const auto &username =
  13786. is_proxy ? proxy_digest_auth_username_ : digest_auth_username_;
  13787. const auto &password =
  13788. is_proxy ? proxy_digest_auth_password_ : digest_auth_password_;
  13789. if (!username.empty() && !password.empty()) {
  13790. std::map<std::string, std::string> auth;
  13791. if (detail::parse_www_authenticate(res, auth, is_proxy)) {
  13792. Request new_req = req;
  13793. new_req.authorization_count_ += 1;
  13794. new_req.headers.erase(is_proxy ? "Proxy-Authorization"
  13795. : "Authorization");
  13796. new_req.headers.insert(detail::make_digest_authentication_header(
  13797. req, make_request_target(req), auth, new_req.authorization_count_,
  13798. detail::random_string(10), username, password, is_proxy));
  13799. Response new_res;
  13800. ret = send(new_req, new_res, error);
  13801. if (ret) { res = std::move(new_res); }
  13802. }
  13803. }
  13804. }
  13805. #endif
  13806. return ret;
  13807. }
  13808. inline bool ClientImpl::redirect(Request &req, Response &res, Error &error) {
  13809. if (req.redirect_count_ == 0) {
  13810. error = Error::ExceedRedirectCount;
  13811. output_error_log(error, &req);
  13812. return false;
  13813. }
  13814. auto location = res.get_header_value("location");
  13815. if (location.empty()) { return false; }
  13816. detail::UrlComponents uc;
  13817. if (!detail::parse_url(detail::resolve_relative_location(location, req.path),
  13818. uc)) {
  13819. return false;
  13820. }
  13821. // Only follow http/https redirects
  13822. if (!uc.scheme.empty() && uc.scheme != "http" && uc.scheme != "https") {
  13823. return false;
  13824. }
  13825. auto scheme = is_ssl() ? "https" : "http";
  13826. auto next_scheme = std::move(uc.scheme);
  13827. auto next_host = std::move(uc.host);
  13828. auto port_str = std::move(uc.port);
  13829. auto next_path = std::move(uc.path);
  13830. auto next_query = std::move(uc.query);
  13831. auto next_port = port_;
  13832. if (!port_str.empty()) {
  13833. if (!detail::parse_port(port_str, next_port)) { return false; }
  13834. } else if (!next_scheme.empty()) {
  13835. next_port = next_scheme == "https" ? 443 : 80;
  13836. }
  13837. if (next_scheme.empty()) { next_scheme = scheme; }
  13838. if (next_host.empty()) { next_host = host_; }
  13839. if (next_path.empty()) { next_path = "/"; }
  13840. auto path = std::move(next_path) + next_query;
  13841. // Same host redirect - use current client
  13842. if (next_scheme == scheme && next_host == host_ && next_port == port_) {
  13843. return detail::redirect(*this, req, res, path, location, error);
  13844. }
  13845. // Cross-host/scheme redirect - create new client with robust setup
  13846. return create_redirect_client(next_scheme, next_host, next_port, req, res,
  13847. path, location, error);
  13848. }
  13849. // New method for robust redirect client creation
  13850. inline bool ClientImpl::create_redirect_client(
  13851. const std::string &scheme, const std::string &host, int port, Request &req,
  13852. Response &res, const std::string &path, const std::string &location,
  13853. Error &error) {
  13854. // Determine if we need SSL
  13855. auto need_ssl = (scheme == "https");
  13856. // Clean up request headers that are host/client specific
  13857. // Remove headers that should not be carried over to new host
  13858. auto headers_to_remove = std::vector<std::string>{
  13859. "Host", "Proxy-Authorization", "Authorization", "Cookie", "Cookie2"};
  13860. for (const auto &header_name : headers_to_remove) {
  13861. auto it = req.headers.find(header_name);
  13862. while (it != req.headers.end()) {
  13863. it = req.headers.erase(it);
  13864. it = req.headers.find(header_name);
  13865. }
  13866. }
  13867. // Create appropriate client type and handle redirect
  13868. if (need_ssl) {
  13869. #ifdef CPPHTTPLIB_SSL_ENABLED
  13870. // Create SSL client for HTTPS redirect
  13871. SSLClient redirect_client(host, port);
  13872. // Setup basic client configuration first
  13873. setup_redirect_client(redirect_client);
  13874. redirect_client.enable_server_certificate_verification(
  13875. server_certificate_verification_);
  13876. redirect_client.enable_server_hostname_verification(
  13877. server_hostname_verification_);
  13878. redirect_client.system_ca_mode_ = system_ca_mode_;
  13879. // Transfer CA certificate to redirect client
  13880. redirect_client.set_ca_cert_path(ca_cert_file_path_, ca_cert_dir_path_);
  13881. if (is_ssl()) {
  13882. auto &self = static_cast<SSLClient &>(*this);
  13883. // A store given to set_ca_cert_store() lives only in this client's
  13884. // context, which then holds all that is trusted.
  13885. if (self.ca_cert_store_set_) {
  13886. std::string pem;
  13887. {
  13888. std::lock_guard<std::mutex> guard(self.ctx_mutex_);
  13889. pem = detail::ca_certs_to_pem(self.ctx_);
  13890. }
  13891. redirect_client.load_ca_cert_store(pem.data(), pem.size());
  13892. redirect_client.ca_cert_store_set_ = true;
  13893. } else {
  13894. redirect_client.load_ca_cert_store(ca_cert_pem_.c_str(),
  13895. ca_cert_pem_.size());
  13896. }
  13897. redirect_client.set_session_verifier(self.session_verifier_);
  13898. if (self.server_certificate_verifier_) {
  13899. redirect_client.set_server_certificate_verifier(
  13900. self.server_certificate_verifier_);
  13901. }
  13902. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  13903. redirect_client.enable_windows_cert_verification_ =
  13904. self.enable_windows_cert_verification_;
  13905. #endif
  13906. }
  13907. // Client certificates are set through constructor for SSLClient
  13908. // NOTE: SSLClient constructor already takes client_cert_path and
  13909. // client_key_path so we need to create it properly if client certs are
  13910. // needed
  13911. // Execute the redirect
  13912. return detail::redirect(redirect_client, req, res, path, location, error);
  13913. #else
  13914. // SSL not supported - set appropriate error
  13915. error = Error::SSLConnection;
  13916. output_error_log(error, &req);
  13917. return false;
  13918. #endif
  13919. } else {
  13920. // HTTP redirect
  13921. ClientImpl redirect_client(host, port);
  13922. // Setup client with robust configuration
  13923. setup_redirect_client(redirect_client);
  13924. // Execute the redirect
  13925. return detail::redirect(redirect_client, req, res, path, location, error);
  13926. }
  13927. }
  13928. // New method for robust client setup (based on basic_manual_redirect.cpp
  13929. // logic)
  13930. template <typename ClientType>
  13931. inline void ClientImpl::setup_redirect_client(ClientType &client) {
  13932. // Copy basic settings first
  13933. client.set_connection_timeout(connection_timeout_sec_,
  13934. connection_timeout_usec_);
  13935. client.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  13936. client.set_write_timeout(write_timeout_sec_, write_timeout_usec_);
  13937. client.set_max_timeout(max_timeout_msec_);
  13938. if (has_payload_max_length_) {
  13939. client.set_payload_max_length(payload_max_length_);
  13940. }
  13941. client.set_keep_alive(keep_alive_);
  13942. client.set_follow_location(
  13943. true); // Enable redirects to handle multi-step redirects
  13944. client.set_path_encode(path_encode_);
  13945. client.set_compress(compress_);
  13946. client.set_decompress(decompress_);
  13947. // NOTE: Authentication credentials (basic auth, bearer token, digest auth)
  13948. // are intentionally NOT copied to the redirect client. Per RFC 9110 Section
  13949. // 15.4, credentials must not be forwarded when redirecting to a different
  13950. // host. This function is only called for cross-host redirects; same-host
  13951. // redirects are handled directly in ClientImpl::redirect().
  13952. // Copy the proxy configuration unconditionally; the per-target bypass is
  13953. // re-evaluated at send time, so a later hop to a non-bypassed host can
  13954. // still use the proxy.
  13955. client.no_proxy_entries_ = no_proxy_entries_;
  13956. if (!proxy_host_.empty() && proxy_port_ != -1) {
  13957. client.set_proxy(proxy_host_, proxy_port_);
  13958. if (!proxy_basic_auth_username_.empty() ||
  13959. !proxy_basic_auth_password_.empty()) {
  13960. client.set_proxy_basic_auth(proxy_basic_auth_username_,
  13961. proxy_basic_auth_password_);
  13962. }
  13963. if (!proxy_bearer_token_auth_token_.empty()) {
  13964. client.set_proxy_bearer_token_auth(proxy_bearer_token_auth_token_);
  13965. }
  13966. #ifdef CPPHTTPLIB_SSL_ENABLED
  13967. if (!proxy_digest_auth_username_.empty()) {
  13968. client.set_proxy_digest_auth(proxy_digest_auth_username_,
  13969. proxy_digest_auth_password_);
  13970. }
  13971. #endif
  13972. }
  13973. // Copy network and socket settings
  13974. client.addr_map_ = addr_map_;
  13975. client.set_address_family(address_family_);
  13976. client.set_tcp_nodelay(tcp_nodelay_);
  13977. client.set_ipv6_v6only(ipv6_v6only_);
  13978. if (socket_options_) { client.set_socket_options(socket_options_); }
  13979. if (!interface_.empty()) { client.set_interface(interface_); }
  13980. // Copy logging and headers
  13981. if (logger_) { client.set_logger(logger_); }
  13982. if (error_logger_) { client.set_error_logger(error_logger_); }
  13983. // NOTE: DO NOT copy default_headers_ as they may contain stale Host headers
  13984. // Each new client should generate its own headers based on its target host
  13985. }
  13986. inline bool ClientImpl::write_content_with_provider(Stream &strm,
  13987. const Request &req,
  13988. Error &error) const {
  13989. auto is_shutting_down = []() { return false; };
  13990. if (req.is_chunked_content_provider_) {
  13991. auto compressor = compress_ ? detail::create_compressor().first
  13992. : std::unique_ptr<detail::compressor>();
  13993. if (!compressor) {
  13994. compressor = detail::make_unique<detail::nocompressor>();
  13995. }
  13996. return detail::write_content_chunked(strm, req.content_provider_,
  13997. is_shutting_down, *compressor, error);
  13998. } else {
  13999. return detail::write_content_with_progress(
  14000. strm, req.content_provider_, 0, req.content_length_, is_shutting_down,
  14001. req.upload_progress, error);
  14002. }
  14003. }
  14004. // What goes on the request line for req: its path, encoded and without the
  14005. // fragment, with `req.params` as the query when the path has none.
  14006. inline std::string ClientImpl::make_request_target(const Request &req) const {
  14007. auto target = detail::encode_request_target(req.path, path_encode_);
  14008. if (detail::query_of(req.path).empty() && !req.params.empty()) {
  14009. target = append_query_params(target, req.params);
  14010. }
  14011. return target;
  14012. }
  14013. inline bool ClientImpl::write_request(Stream &strm, Request &req,
  14014. bool close_connection, Error &error,
  14015. bool skip_body, bool &rejected_locally) {
  14016. rejected_locally = false;
  14017. // Prepare additional headers
  14018. if (close_connection) {
  14019. if (!req.has_header("Connection")) {
  14020. req.set_header("Connection", "close");
  14021. }
  14022. }
  14023. std::string ct_for_defaults;
  14024. if (!req.has_header("Content-Type") && !req.body.empty()) {
  14025. ct_for_defaults = "text/plain";
  14026. }
  14027. prepare_default_headers(req, false, ct_for_defaults);
  14028. if (req.body.empty()) {
  14029. if (req.content_provider_) {
  14030. if (!req.is_chunked_content_provider_) {
  14031. if (!req.has_header("Content-Length")) {
  14032. auto length = std::to_string(req.content_length_);
  14033. req.set_header("Content-Length", length);
  14034. }
  14035. }
  14036. } else {
  14037. if (req.method == "POST" || req.method == "PUT" ||
  14038. req.method == "PATCH") {
  14039. req.set_header("Content-Length", "0");
  14040. }
  14041. }
  14042. }
  14043. // A CONNECT request is read by the proxy; everything sent through the tunnel
  14044. // it opens is read by the origin. Each credential goes only to its own hop.
  14045. auto is_connect = req.method == "CONNECT";
  14046. if (!is_connect) {
  14047. detail::add_authorization_header(req, basic_auth_username_,
  14048. basic_auth_password_,
  14049. bearer_token_auth_token_, false);
  14050. }
  14051. // Proxy-Authorization is only sent when the proxy reads this message —
  14052. // otherwise NO_PROXY-matched requests, and requests inside a TLS tunnel,
  14053. // would leak proxy credentials to the destination server.
  14054. if (is_proxy_enabled_for_host(host_) && (!is_ssl() || is_connect)) {
  14055. detail::add_authorization_header(req, proxy_basic_auth_username_,
  14056. proxy_basic_auth_password_,
  14057. proxy_bearer_token_auth_token_, true);
  14058. }
  14059. // Request line and headers
  14060. {
  14061. detail::BufferStream bstrm;
  14062. auto path_with_query = make_request_target(req);
  14063. // The query already came in through `req.path`; still populate
  14064. // `req.params` for handlers/users who read them.
  14065. auto query_part = detail::query_of(req.path);
  14066. if (!query_part.empty()) {
  14067. detail::parse_query_text(query_part, req.params);
  14068. }
  14069. // Write request line and headers
  14070. if (detail::write_request_line(bstrm, req.method, path_with_query) < 0) {
  14071. // A rejected method (not a token, e.g. carrying CR/LF) or target (e.g.
  14072. // CR/LF in a caller-supplied path under set_path_encode(false)) must
  14073. // fail the request cleanly instead of emitting a request-line-less,
  14074. // header-injecting request.
  14075. error = Error::Write;
  14076. rejected_locally = true;
  14077. output_error_log(error, &req);
  14078. return false;
  14079. }
  14080. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  14081. error)) {
  14082. rejected_locally = true;
  14083. output_error_log(error, &req);
  14084. return false;
  14085. }
  14086. // Flush buffer
  14087. auto &data = bstrm.get_buffer();
  14088. if (!detail::write_data(strm, data.data(), data.size())) {
  14089. error = Error::Write;
  14090. output_error_log(error, &req);
  14091. return false;
  14092. }
  14093. }
  14094. // After sending request line and headers, wait briefly for an early server
  14095. // response (e.g. 4xx) and avoid sending a potentially large request body
  14096. // unnecessarily. This workaround is only enabled on Windows because Unix
  14097. // platforms surface write errors (EPIPE) earlier; on Windows kernel send
  14098. // buffering can accept large writes even when the peer already responded.
  14099. // Check the stream first (which covers SSL via `is_readable()`), then
  14100. // fall back to select on the socket. Only perform the wait for very large
  14101. // request bodies to avoid interfering with normal small requests and
  14102. // reduce side-effects. Poll briefly (up to 50ms as default) for an early
  14103. // response. Skip this check when using Expect: 100-continue, as the protocol
  14104. // handles early responses properly.
  14105. #if defined(_WIN32)
  14106. if (!skip_body &&
  14107. req.body.size() > CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD &&
  14108. req.path.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  14109. auto start = std::chrono::high_resolution_clock::now();
  14110. for (;;) {
  14111. // Prefer socket-level readiness to avoid SSL_pending() false-positives
  14112. // from SSL internals. If the underlying socket is readable, assume an
  14113. // early response may be present.
  14114. auto sock = strm.socket();
  14115. if (sock != INVALID_SOCKET && detail::select_read(sock, 0, 0) > 0) {
  14116. return false;
  14117. }
  14118. // Fallback to stream-level check for non-socket streams or when the
  14119. // socket isn't reporting readable. Avoid using `is_readable()` for
  14120. // SSL, since `SSL_pending()` may report buffered records that do not
  14121. // indicate a complete application-level response yet.
  14122. if (!is_ssl() && strm.is_readable()) { return false; }
  14123. auto now = std::chrono::high_resolution_clock::now();
  14124. auto elapsed =
  14125. std::chrono::duration_cast<std::chrono::milliseconds>(now - start)
  14126. .count();
  14127. if (elapsed >= CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND) {
  14128. break;
  14129. }
  14130. std::this_thread::sleep_for(std::chrono::milliseconds(1));
  14131. }
  14132. }
  14133. #endif
  14134. // Body
  14135. if (skip_body) { return true; }
  14136. return write_request_body(strm, req, error);
  14137. }
  14138. inline bool ClientImpl::write_request_body(Stream &strm, Request &req,
  14139. Error &error) {
  14140. if (req.body.empty()) {
  14141. return write_content_with_provider(strm, req, error);
  14142. }
  14143. if (req.upload_progress) {
  14144. auto body_size = req.body.size();
  14145. size_t written = 0;
  14146. auto data = req.body.data();
  14147. while (written < body_size) {
  14148. size_t to_write = (std::min)(CPPHTTPLIB_SEND_BUFSIZ, body_size - written);
  14149. if (!detail::write_data(strm, data + written, to_write)) {
  14150. error = Error::Write;
  14151. output_error_log(error, &req);
  14152. return false;
  14153. }
  14154. written += to_write;
  14155. if (!req.upload_progress(written, body_size)) {
  14156. error = Error::Canceled;
  14157. output_error_log(error, &req);
  14158. return false;
  14159. }
  14160. }
  14161. } else {
  14162. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  14163. error = Error::Write;
  14164. output_error_log(error, &req);
  14165. return false;
  14166. }
  14167. }
  14168. return true;
  14169. }
  14170. inline std::unique_ptr<Response>
  14171. ClientImpl::send_with_content_provider_and_receiver(
  14172. Request &req, const char *body, size_t content_length,
  14173. ContentProvider content_provider,
  14174. ContentProviderWithoutLength content_provider_without_length,
  14175. const std::string &content_type, ContentReceiver content_receiver,
  14176. Error &error) {
  14177. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14178. auto enc = compress_
  14179. ? detail::create_compressor()
  14180. : std::pair<std::unique_ptr<detail::compressor>, const char *>(
  14181. nullptr, nullptr);
  14182. if (enc.second) { req.set_header("Content-Encoding", enc.second); }
  14183. if (enc.first && !content_provider_without_length) {
  14184. auto &compressor = enc.first;
  14185. if (content_provider) {
  14186. auto ok = true;
  14187. auto finished = false;
  14188. size_t offset = 0;
  14189. DataSink data_sink;
  14190. data_sink.write = [&](const char *data, size_t data_len) -> bool {
  14191. if (ok) {
  14192. auto last = offset + data_len == content_length;
  14193. auto ret = compressor->compress(
  14194. data, data_len, last,
  14195. [&](const char *compressed_data, size_t compressed_data_len) {
  14196. req.body.append(compressed_data, compressed_data_len);
  14197. return true;
  14198. });
  14199. if (ret) {
  14200. offset += data_len;
  14201. } else {
  14202. ok = false;
  14203. }
  14204. }
  14205. return ok;
  14206. };
  14207. // As in detail::write_content_with_progress(): the body is framed by
  14208. // content_length, so a provider that finishes early has truncated it.
  14209. // Stop and report that instead of calling the provider forever.
  14210. data_sink.done = [&]() { finished = true; };
  14211. while (ok && !finished && offset < content_length) {
  14212. if (!content_provider(offset, content_length - offset, data_sink)) {
  14213. error = Error::Canceled;
  14214. output_error_log(error, &req);
  14215. return nullptr;
  14216. }
  14217. }
  14218. // A short body here means either the provider stopped early or the
  14219. // compressor gave up. The branch below reports a failing compressor as
  14220. // Error::Compression, so keep the two distinguishable.
  14221. if (offset < content_length) {
  14222. error = ok ? Error::Write : Error::Compression;
  14223. output_error_log(error, &req);
  14224. return nullptr;
  14225. }
  14226. } else {
  14227. if (!compressor->compress(body, content_length, true,
  14228. [&](const char *data, size_t data_len) {
  14229. req.body.append(data, data_len);
  14230. return true;
  14231. })) {
  14232. error = Error::Compression;
  14233. output_error_log(error, &req);
  14234. return nullptr;
  14235. }
  14236. }
  14237. } else {
  14238. if (content_provider) {
  14239. req.content_length_ = content_length;
  14240. req.content_provider_ = std::move(content_provider);
  14241. req.is_chunked_content_provider_ = false;
  14242. } else if (content_provider_without_length) {
  14243. req.content_length_ = 0;
  14244. req.content_provider_ = detail::ContentProviderAdapter(
  14245. std::move(content_provider_without_length));
  14246. req.is_chunked_content_provider_ = true;
  14247. req.set_header("Transfer-Encoding", "chunked");
  14248. } else {
  14249. req.body.assign(body, content_length);
  14250. }
  14251. }
  14252. if (content_receiver) {
  14253. req.content_receiver =
  14254. [content_receiver](const char *data, size_t data_length,
  14255. size_t /*offset*/, size_t /*total_length*/) {
  14256. return content_receiver(data, data_length);
  14257. };
  14258. }
  14259. auto res = detail::make_unique<Response>();
  14260. return send(req, *res, error) ? std::move(res) : nullptr;
  14261. }
  14262. inline Result ClientImpl::send_with_content_provider_and_receiver(
  14263. const std::string &method, const std::string &path, const Headers &headers,
  14264. const char *body, size_t content_length, ContentProvider content_provider,
  14265. ContentProviderWithoutLength content_provider_without_length,
  14266. const std::string &content_type, ContentReceiver content_receiver,
  14267. UploadProgress progress) {
  14268. Request req;
  14269. req.method = method;
  14270. req.headers = headers;
  14271. req.path = path;
  14272. req.upload_progress = std::move(progress);
  14273. if (max_timeout_msec_ > 0) {
  14274. req.start_time_ = std::chrono::steady_clock::now();
  14275. }
  14276. auto error = Error::Success;
  14277. #ifdef CPPHTTPLIB_SSL_ENABLED
  14278. // Hold the request lock until the Result has read this request's TLS error
  14279. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  14280. #endif
  14281. auto res = send_with_content_provider_and_receiver(
  14282. req, body, content_length, std::move(content_provider),
  14283. std::move(content_provider_without_length), content_type,
  14284. std::move(content_receiver), error);
  14285. #ifdef CPPHTTPLIB_SSL_ENABLED
  14286. return Result{std::move(res), error, std::move(req.headers), last_ssl_error_,
  14287. last_backend_error_};
  14288. #else
  14289. return Result{std::move(res), error, std::move(req.headers)};
  14290. #endif
  14291. }
  14292. inline void ClientImpl::output_log(const Request &req,
  14293. const Response &res) const {
  14294. if (logger_) {
  14295. std::lock_guard<std::mutex> guard(logger_mutex_);
  14296. logger_(req, res);
  14297. }
  14298. }
  14299. inline void ClientImpl::output_error_log(const Error &err,
  14300. const Request *req) const {
  14301. if (error_logger_) {
  14302. std::lock_guard<std::mutex> guard(logger_mutex_);
  14303. error_logger_(err, req);
  14304. }
  14305. }
  14306. inline bool ClientImpl::process_request(Stream &strm, Request &req,
  14307. Response &res, bool close_connection,
  14308. Error &error) {
  14309. // Auto-add Expect: 100-continue for large bodies
  14310. if (CPPHTTPLIB_EXPECT_100_THRESHOLD > 0 && !req.has_header("Expect")) {
  14311. auto body_size = req.body.empty() ? req.content_length_ : req.body.size();
  14312. if (body_size >= CPPHTTPLIB_EXPECT_100_THRESHOLD) {
  14313. req.set_header("Expect", "100-continue");
  14314. }
  14315. }
  14316. // Check for Expect: 100-continue
  14317. auto expect_100_continue =
  14318. detail::has_header_token(req.headers, "Expect", "100-continue");
  14319. // Send request (skip body if using Expect: 100-continue)
  14320. auto rejected_locally = false;
  14321. auto write_request_success =
  14322. write_request(strm, req, close_connection, error, expect_100_continue,
  14323. rejected_locally);
  14324. // A failed write normally still reads the response below, since the server
  14325. // may have answered early (e.g. 413/414) and closed while the body was being
  14326. // sent. A request rejected before any byte reached the socket gets no such
  14327. // response, and waiting for one would block until the read timeout.
  14328. if (rejected_locally) { return false; }
  14329. #ifdef CPPHTTPLIB_SSL_ENABLED
  14330. if (is_ssl() && !expect_100_continue) {
  14331. auto is_proxy_enabled = is_proxy_enabled_for_host(host_);
  14332. if (!is_proxy_enabled) {
  14333. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  14334. error = Error::SSLPeerCouldBeClosed_;
  14335. output_error_log(error, &req);
  14336. return false;
  14337. }
  14338. }
  14339. }
  14340. #endif
  14341. // Handle Expect: 100-continue.
  14342. //
  14343. // Wait for an interim/early response by attempting to read the status line
  14344. // under a short timeout, instead of trusting raw socket readability. Over
  14345. // TLS, post-handshake records (e.g. session tickets) make the socket
  14346. // readable without any HTTP response being available; relying on
  14347. // `select_read` there caused the body to be withheld forever and the
  14348. // request to fail with `Read` (#2458). If no status line arrives within the
  14349. // timeout, send the body anyway (matching curl's behavior).
  14350. auto status_line_read = false;
  14351. if (expect_100_continue && write_request_success) {
  14352. if (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND > 0) {
  14353. time_t sec = CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND / 1000;
  14354. time_t usec = (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND % 1000) * 1000;
  14355. strm.set_read_timeout(sec, usec);
  14356. status_line_read = read_response_line(strm, req, res, false);
  14357. strm.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  14358. }
  14359. if (!status_line_read) {
  14360. // No interim response within the timeout: send the body and handle the
  14361. // response as usual.
  14362. if (!write_request_body(strm, req, error)) { return false; }
  14363. expect_100_continue = false; // Switch to normal response handling
  14364. }
  14365. }
  14366. // Receive response and headers
  14367. // When using Expect: 100-continue, don't auto-skip `100 Continue` response
  14368. if ((!status_line_read &&
  14369. !read_response_line(strm, req, res, !expect_100_continue)) ||
  14370. !detail::read_headers(strm, res.headers)) {
  14371. if (write_request_success) { error = Error::Read; }
  14372. output_error_log(error, &req);
  14373. return false;
  14374. }
  14375. if (!write_request_success) { return false; }
  14376. // Handle Expect: 100-continue response
  14377. if (expect_100_continue) {
  14378. if (res.status == StatusCode::Continue_100) {
  14379. // Server accepted, send the body
  14380. if (!write_request_body(strm, req, error)) { return false; }
  14381. // Read the actual response
  14382. res.headers.clear();
  14383. res.body.clear();
  14384. if (!read_response_line(strm, req, res) ||
  14385. !detail::read_headers(strm, res.headers)) {
  14386. error = Error::Read;
  14387. output_error_log(error, &req);
  14388. return false;
  14389. }
  14390. } else {
  14391. // A final response came first, so the body this request declared was
  14392. // never sent, and the server may still be waiting for it. The
  14393. // connection cannot carry another request.
  14394. std::lock_guard<std::mutex> guard(socket_mutex_);
  14395. socket_should_be_closed_when_request_is_done_ = true;
  14396. }
  14397. }
  14398. // Body
  14399. if ((res.status != StatusCode::NoContent_204) && req.method != "HEAD" &&
  14400. req.method != "CONNECT") {
  14401. // Reject ambiguous framing (RFC 9112 §6.3). Unlike a request, a response
  14402. // whose final transfer coding is not chunked is not ambiguous: its body
  14403. // runs until the server closes the connection, so it is not rejected.
  14404. // HEAD/204 are excluded above and a 304 carries no body.
  14405. if (res.status != StatusCode::NotModified_304) {
  14406. if (detail::has_conflicting_content_length(res.headers)) {
  14407. error = Error::Read;
  14408. output_error_log(error, &req);
  14409. return false;
  14410. }
  14411. if (detail::has_faulty_transfer_encoding(res)) {
  14412. std::lock_guard<std::mutex> guard(socket_mutex_);
  14413. socket_should_be_closed_when_request_is_done_ = true;
  14414. }
  14415. }
  14416. auto redirect = follow_location_ && detail::is_redirect(res) &&
  14417. res.status != StatusCode::NotModified_304;
  14418. if (req.response_handler && !redirect) {
  14419. if (!req.response_handler(res)) {
  14420. error = Error::Canceled;
  14421. output_error_log(error, &req);
  14422. return false;
  14423. }
  14424. }
  14425. auto out =
  14426. req.content_receiver
  14427. ? static_cast<ContentReceiverWithProgress>(
  14428. [&](const char *buf, size_t n, size_t off, size_t len) {
  14429. if (redirect) { return true; }
  14430. auto ret = req.content_receiver(buf, n, off, len);
  14431. if (!ret) {
  14432. error = Error::Canceled;
  14433. output_error_log(error, &req);
  14434. }
  14435. return ret;
  14436. })
  14437. : static_cast<ContentReceiverWithProgress>(
  14438. [&](const char *buf, size_t n, size_t /*off*/,
  14439. size_t /*len*/) {
  14440. assert(res.body.size() + n <= res.body.max_size());
  14441. if (payload_max_length_ > 0 &&
  14442. (res.body.size() >= payload_max_length_ ||
  14443. n > payload_max_length_ - res.body.size())) {
  14444. return false;
  14445. }
  14446. res.body.append(buf, n);
  14447. return true;
  14448. });
  14449. auto progress = [&](size_t current, size_t total) {
  14450. if (!req.download_progress || redirect) { return true; }
  14451. auto ret = req.download_progress(current, total);
  14452. if (!ret) {
  14453. error = Error::Canceled;
  14454. output_error_log(error, &req);
  14455. }
  14456. return ret;
  14457. };
  14458. if (res.has_header("Content-Length")) {
  14459. if (!req.content_receiver) {
  14460. auto len = res.get_header_value_u64("Content-Length");
  14461. if (len > res.body.max_size()) {
  14462. error = Error::Read;
  14463. output_error_log(error, &req);
  14464. return false;
  14465. }
  14466. // Content-Length is only the server's claim, so reserve no more than
  14467. // payload_max_length_ allows, nor more than 1 MiB before any of the
  14468. // body has arrived. A longer body grows as it is read.
  14469. auto reserve_len =
  14470. (std::min)(static_cast<size_t>(len), size_t(1024 * 1024));
  14471. if (payload_max_length_ > 0) {
  14472. reserve_len = (std::min)(reserve_len, payload_max_length_);
  14473. }
  14474. res.body.reserve(reserve_len);
  14475. }
  14476. }
  14477. if (res.status != StatusCode::NotModified_304) {
  14478. auto content_status = 0;
  14479. auto max_length = (!has_payload_max_length_ && req.content_receiver)
  14480. ? (std::numeric_limits<size_t>::max)()
  14481. : payload_max_length_;
  14482. if (!detail::read_content(strm, res, max_length, content_status,
  14483. std::move(progress), std::move(out),
  14484. decompress_)) {
  14485. if (error != Error::Canceled) {
  14486. // Tell the caller apart from a plain read failure when the body could
  14487. // not be decoded because of its Content-Encoding.
  14488. switch (content_status) {
  14489. case StatusCode::UnsupportedMediaType_415:
  14490. error = Error::UnsupportedContentEncoding;
  14491. break;
  14492. case StatusCode::InternalServerError_500:
  14493. error = Error::Compression;
  14494. break;
  14495. default: error = Error::Read; break;
  14496. }
  14497. }
  14498. output_error_log(error, &req);
  14499. return false;
  14500. }
  14501. }
  14502. }
  14503. // Log
  14504. output_log(req, res);
  14505. return true;
  14506. }
  14507. inline ContentProviderWithoutLength ClientImpl::get_multipart_content_provider(
  14508. const std::string &boundary, const UploadFormDataItems &items,
  14509. const FormDataProviderItems &provider_items) const {
  14510. size_t cur_item = 0;
  14511. size_t cur_start = 0;
  14512. // cur_item and cur_start are copied to within the std::function and
  14513. // maintain state between successive calls
  14514. return [&, cur_item, cur_start](size_t offset,
  14515. DataSink &sink) mutable -> bool {
  14516. if (!offset && !items.empty()) {
  14517. sink.os << detail::serialize_multipart_formdata(items, boundary, false);
  14518. return true;
  14519. } else if (cur_item < provider_items.size()) {
  14520. if (!cur_start) {
  14521. const auto &begin = detail::serialize_multipart_formdata_item_begin(
  14522. provider_items[cur_item], boundary);
  14523. offset += begin.size();
  14524. cur_start = offset;
  14525. sink.os << begin;
  14526. }
  14527. DataSink cur_sink;
  14528. auto has_data = true;
  14529. cur_sink.write = sink.write;
  14530. // Forward is_writable so a provider item asking whether it may keep
  14531. // going gets the outer sink's answer rather than the default `true`.
  14532. cur_sink.is_writable = sink.is_writable;
  14533. cur_sink.done = [&]() { has_data = false; };
  14534. if (!provider_items[cur_item].provider(offset - cur_start, cur_sink)) {
  14535. return false;
  14536. }
  14537. if (!has_data) {
  14538. sink.os << detail::serialize_multipart_formdata_item_end();
  14539. cur_item++;
  14540. cur_start = 0;
  14541. }
  14542. return true;
  14543. } else {
  14544. sink.os << detail::serialize_multipart_formdata_finish(boundary);
  14545. sink.done();
  14546. return true;
  14547. }
  14548. };
  14549. }
  14550. inline bool ClientImpl::process_socket(
  14551. const Socket &socket,
  14552. std::chrono::time_point<std::chrono::steady_clock> start_time,
  14553. std::function<bool(Stream &strm)> callback) {
  14554. return detail::process_client_socket(
  14555. socket.sock, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  14556. write_timeout_usec_, max_timeout_msec_, start_time, std::move(callback));
  14557. }
  14558. inline bool ClientImpl::is_ssl() const { return false; }
  14559. inline Result ClientImpl::Get(const std::string &path,
  14560. DownloadProgress progress) {
  14561. return Get(path, Headers(), std::move(progress));
  14562. }
  14563. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14564. DownloadProgress progress) {
  14565. return Get(path, params, Headers(), std::move(progress));
  14566. }
  14567. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14568. const Headers &headers,
  14569. DownloadProgress progress) {
  14570. if (params.empty()) { return Get(path, headers); }
  14571. std::string path_with_query = append_query_params(path, params);
  14572. return Get(path_with_query, headers, std::move(progress));
  14573. }
  14574. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14575. DownloadProgress progress) {
  14576. Request req;
  14577. req.method = "GET";
  14578. req.path = path;
  14579. req.headers = headers;
  14580. req.download_progress = std::move(progress);
  14581. if (max_timeout_msec_ > 0) {
  14582. req.start_time_ = std::chrono::steady_clock::now();
  14583. }
  14584. return send_(std::move(req));
  14585. }
  14586. inline Result ClientImpl::Get(const std::string &path,
  14587. ContentReceiver content_receiver,
  14588. DownloadProgress progress) {
  14589. return Get(path, Headers(), nullptr, std::move(content_receiver),
  14590. std::move(progress));
  14591. }
  14592. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14593. ContentReceiver content_receiver,
  14594. DownloadProgress progress) {
  14595. return Get(path, headers, nullptr, std::move(content_receiver),
  14596. std::move(progress));
  14597. }
  14598. inline Result ClientImpl::Get(const std::string &path,
  14599. ResponseHandler response_handler,
  14600. ContentReceiver content_receiver,
  14601. DownloadProgress progress) {
  14602. return Get(path, Headers(), std::move(response_handler),
  14603. std::move(content_receiver), std::move(progress));
  14604. }
  14605. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14606. ResponseHandler response_handler,
  14607. ContentReceiver content_receiver,
  14608. DownloadProgress progress) {
  14609. Request req;
  14610. req.method = "GET";
  14611. req.path = path;
  14612. req.headers = headers;
  14613. req.response_handler = std::move(response_handler);
  14614. req.content_receiver =
  14615. [content_receiver](const char *data, size_t data_length,
  14616. size_t /*offset*/, size_t /*total_length*/) {
  14617. return content_receiver(data, data_length);
  14618. };
  14619. req.download_progress = std::move(progress);
  14620. if (max_timeout_msec_ > 0) {
  14621. req.start_time_ = std::chrono::steady_clock::now();
  14622. }
  14623. return send_(std::move(req));
  14624. }
  14625. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14626. const Headers &headers,
  14627. ContentReceiver content_receiver,
  14628. DownloadProgress progress) {
  14629. return Get(path, params, headers, nullptr, std::move(content_receiver),
  14630. std::move(progress));
  14631. }
  14632. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14633. const Headers &headers,
  14634. ResponseHandler response_handler,
  14635. ContentReceiver content_receiver,
  14636. DownloadProgress progress) {
  14637. if (params.empty()) {
  14638. return Get(path, headers, std::move(response_handler),
  14639. std::move(content_receiver), std::move(progress));
  14640. }
  14641. std::string path_with_query = append_query_params(path, params);
  14642. return Get(path_with_query, headers, std::move(response_handler),
  14643. std::move(content_receiver), std::move(progress));
  14644. }
  14645. inline Result ClientImpl::Head(const std::string &path) {
  14646. return Head(path, Headers());
  14647. }
  14648. inline Result ClientImpl::Head(const std::string &path,
  14649. const Headers &headers) {
  14650. Request req;
  14651. req.method = "HEAD";
  14652. req.headers = headers;
  14653. req.path = path;
  14654. if (max_timeout_msec_ > 0) {
  14655. req.start_time_ = std::chrono::steady_clock::now();
  14656. }
  14657. return send_(std::move(req));
  14658. }
  14659. inline Result ClientImpl::Post(const std::string &path) {
  14660. return Post(path, std::string(), std::string());
  14661. }
  14662. inline Result ClientImpl::Post(const std::string &path,
  14663. const Headers &headers) {
  14664. return Post(path, headers, nullptr, 0, std::string());
  14665. }
  14666. inline Result ClientImpl::Post(const std::string &path, const char *body,
  14667. size_t content_length,
  14668. const std::string &content_type,
  14669. UploadProgress progress) {
  14670. return Post(path, Headers(), body, content_length, content_type, progress);
  14671. }
  14672. inline Result ClientImpl::Post(const std::string &path, const std::string &body,
  14673. const std::string &content_type,
  14674. UploadProgress progress) {
  14675. return Post(path, Headers(), body, content_type, progress);
  14676. }
  14677. inline Result ClientImpl::Post(const std::string &path, const Params &params) {
  14678. return Post(path, Headers(), params);
  14679. }
  14680. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14681. ContentProvider content_provider,
  14682. const std::string &content_type,
  14683. UploadProgress progress) {
  14684. return Post(path, Headers(), content_length, std::move(content_provider),
  14685. content_type, progress);
  14686. }
  14687. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14688. ContentProvider content_provider,
  14689. const std::string &content_type,
  14690. ContentReceiver content_receiver,
  14691. UploadProgress progress) {
  14692. return Post(path, Headers(), content_length, std::move(content_provider),
  14693. content_type, std::move(content_receiver), progress);
  14694. }
  14695. inline Result ClientImpl::Post(const std::string &path,
  14696. ContentProviderWithoutLength content_provider,
  14697. const std::string &content_type,
  14698. UploadProgress progress) {
  14699. return Post(path, Headers(), std::move(content_provider), content_type,
  14700. progress);
  14701. }
  14702. inline Result ClientImpl::Post(const std::string &path,
  14703. ContentProviderWithoutLength content_provider,
  14704. const std::string &content_type,
  14705. ContentReceiver content_receiver,
  14706. UploadProgress progress) {
  14707. return Post(path, Headers(), std::move(content_provider), content_type,
  14708. std::move(content_receiver), progress);
  14709. }
  14710. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14711. const Params &params) {
  14712. auto query = detail::params_to_query_str(params);
  14713. return Post(path, headers, query, "application/x-www-form-urlencoded");
  14714. }
  14715. inline Result ClientImpl::Post(const std::string &path,
  14716. const UploadFormDataItems &items,
  14717. UploadProgress progress) {
  14718. return Post(path, Headers(), items, progress);
  14719. }
  14720. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14721. const UploadFormDataItems &items,
  14722. UploadProgress progress) {
  14723. const auto &boundary = detail::make_multipart_data_boundary();
  14724. const auto &content_type =
  14725. detail::serialize_multipart_formdata_get_content_type(boundary);
  14726. auto content_length = detail::get_multipart_content_length(items, boundary);
  14727. return Post(path, headers, content_length,
  14728. detail::make_multipart_content_provider(items, boundary),
  14729. content_type, progress);
  14730. }
  14731. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14732. const UploadFormDataItems &items,
  14733. const std::string &boundary,
  14734. UploadProgress progress) {
  14735. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14736. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14737. }
  14738. const auto &content_type =
  14739. detail::serialize_multipart_formdata_get_content_type(boundary);
  14740. auto content_length = detail::get_multipart_content_length(items, boundary);
  14741. return Post(path, headers, content_length,
  14742. detail::make_multipart_content_provider(items, boundary),
  14743. content_type, progress);
  14744. }
  14745. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14746. const char *body, size_t content_length,
  14747. const std::string &content_type,
  14748. UploadProgress progress) {
  14749. return send_with_content_provider_and_receiver(
  14750. "POST", path, headers, body, content_length, nullptr, nullptr,
  14751. content_type, nullptr, progress);
  14752. }
  14753. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14754. const std::string &body,
  14755. const std::string &content_type,
  14756. UploadProgress progress) {
  14757. return send_with_content_provider_and_receiver(
  14758. "POST", path, headers, body.data(), body.size(), nullptr, nullptr,
  14759. content_type, nullptr, progress);
  14760. }
  14761. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14762. size_t content_length,
  14763. ContentProvider content_provider,
  14764. const std::string &content_type,
  14765. UploadProgress progress) {
  14766. return send_with_content_provider_and_receiver(
  14767. "POST", path, headers, nullptr, content_length,
  14768. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14769. }
  14770. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14771. size_t content_length,
  14772. ContentProvider content_provider,
  14773. const std::string &content_type,
  14774. ContentReceiver content_receiver,
  14775. DownloadProgress progress) {
  14776. return send_with_content_provider_and_receiver(
  14777. "POST", path, headers, nullptr, content_length,
  14778. std::move(content_provider), nullptr, content_type,
  14779. std::move(content_receiver), std::move(progress));
  14780. }
  14781. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14782. ContentProviderWithoutLength content_provider,
  14783. const std::string &content_type,
  14784. UploadProgress progress) {
  14785. return send_with_content_provider_and_receiver(
  14786. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14787. content_type, nullptr, progress);
  14788. }
  14789. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14790. ContentProviderWithoutLength content_provider,
  14791. const std::string &content_type,
  14792. ContentReceiver content_receiver,
  14793. DownloadProgress progress) {
  14794. return send_with_content_provider_and_receiver(
  14795. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14796. content_type, std::move(content_receiver), std::move(progress));
  14797. }
  14798. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14799. const UploadFormDataItems &items,
  14800. const FormDataProviderItems &provider_items,
  14801. UploadProgress progress) {
  14802. const auto &boundary = detail::make_multipart_data_boundary();
  14803. const auto &content_type =
  14804. detail::serialize_multipart_formdata_get_content_type(boundary);
  14805. return send_with_content_provider_and_receiver(
  14806. "POST", path, headers, nullptr, 0, nullptr,
  14807. get_multipart_content_provider(boundary, items, provider_items),
  14808. content_type, nullptr, progress);
  14809. }
  14810. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14811. const std::string &body,
  14812. const std::string &content_type,
  14813. ContentReceiver content_receiver,
  14814. DownloadProgress progress) {
  14815. Request req;
  14816. req.method = "POST";
  14817. req.path = path;
  14818. req.headers = headers;
  14819. req.body = body;
  14820. req.content_receiver =
  14821. [content_receiver](const char *data, size_t data_length,
  14822. size_t /*offset*/, size_t /*total_length*/) {
  14823. return content_receiver(data, data_length);
  14824. };
  14825. req.download_progress = std::move(progress);
  14826. if (max_timeout_msec_ > 0) {
  14827. req.start_time_ = std::chrono::steady_clock::now();
  14828. }
  14829. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14830. return send_(std::move(req));
  14831. }
  14832. inline Result ClientImpl::Put(const std::string &path) {
  14833. return Put(path, std::string(), std::string());
  14834. }
  14835. inline Result ClientImpl::Put(const std::string &path, const Headers &headers) {
  14836. return Put(path, headers, nullptr, 0, std::string());
  14837. }
  14838. inline Result ClientImpl::Put(const std::string &path, const char *body,
  14839. size_t content_length,
  14840. const std::string &content_type,
  14841. UploadProgress progress) {
  14842. return Put(path, Headers(), body, content_length, content_type, progress);
  14843. }
  14844. inline Result ClientImpl::Put(const std::string &path, const std::string &body,
  14845. const std::string &content_type,
  14846. UploadProgress progress) {
  14847. return Put(path, Headers(), body, content_type, progress);
  14848. }
  14849. inline Result ClientImpl::Put(const std::string &path, const Params &params) {
  14850. return Put(path, Headers(), params);
  14851. }
  14852. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14853. ContentProvider content_provider,
  14854. const std::string &content_type,
  14855. UploadProgress progress) {
  14856. return Put(path, Headers(), content_length, std::move(content_provider),
  14857. content_type, progress);
  14858. }
  14859. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14860. ContentProvider content_provider,
  14861. const std::string &content_type,
  14862. ContentReceiver content_receiver,
  14863. UploadProgress progress) {
  14864. return Put(path, Headers(), content_length, std::move(content_provider),
  14865. content_type, std::move(content_receiver), progress);
  14866. }
  14867. inline Result ClientImpl::Put(const std::string &path,
  14868. ContentProviderWithoutLength content_provider,
  14869. const std::string &content_type,
  14870. UploadProgress progress) {
  14871. return Put(path, Headers(), std::move(content_provider), content_type,
  14872. progress);
  14873. }
  14874. inline Result ClientImpl::Put(const std::string &path,
  14875. ContentProviderWithoutLength content_provider,
  14876. const std::string &content_type,
  14877. ContentReceiver content_receiver,
  14878. UploadProgress progress) {
  14879. return Put(path, Headers(), std::move(content_provider), content_type,
  14880. std::move(content_receiver), progress);
  14881. }
  14882. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14883. const Params &params) {
  14884. auto query = detail::params_to_query_str(params);
  14885. return Put(path, headers, query, "application/x-www-form-urlencoded");
  14886. }
  14887. inline Result ClientImpl::Put(const std::string &path,
  14888. const UploadFormDataItems &items,
  14889. UploadProgress progress) {
  14890. return Put(path, Headers(), items, progress);
  14891. }
  14892. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14893. const UploadFormDataItems &items,
  14894. UploadProgress progress) {
  14895. const auto &boundary = detail::make_multipart_data_boundary();
  14896. const auto &content_type =
  14897. detail::serialize_multipart_formdata_get_content_type(boundary);
  14898. auto content_length = detail::get_multipart_content_length(items, boundary);
  14899. return Put(path, headers, content_length,
  14900. detail::make_multipart_content_provider(items, boundary),
  14901. content_type, progress);
  14902. }
  14903. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14904. const UploadFormDataItems &items,
  14905. const std::string &boundary,
  14906. UploadProgress progress) {
  14907. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14908. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14909. }
  14910. const auto &content_type =
  14911. detail::serialize_multipart_formdata_get_content_type(boundary);
  14912. auto content_length = detail::get_multipart_content_length(items, boundary);
  14913. return Put(path, headers, content_length,
  14914. detail::make_multipart_content_provider(items, boundary),
  14915. content_type, progress);
  14916. }
  14917. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14918. const char *body, size_t content_length,
  14919. const std::string &content_type,
  14920. UploadProgress progress) {
  14921. return send_with_content_provider_and_receiver(
  14922. "PUT", path, headers, body, content_length, nullptr, nullptr,
  14923. content_type, nullptr, progress);
  14924. }
  14925. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14926. const std::string &body,
  14927. const std::string &content_type,
  14928. UploadProgress progress) {
  14929. return send_with_content_provider_and_receiver(
  14930. "PUT", path, headers, body.data(), body.size(), nullptr, nullptr,
  14931. content_type, nullptr, progress);
  14932. }
  14933. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14934. size_t content_length,
  14935. ContentProvider content_provider,
  14936. const std::string &content_type,
  14937. UploadProgress progress) {
  14938. return send_with_content_provider_and_receiver(
  14939. "PUT", path, headers, nullptr, content_length,
  14940. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14941. }
  14942. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14943. size_t content_length,
  14944. ContentProvider content_provider,
  14945. const std::string &content_type,
  14946. ContentReceiver content_receiver,
  14947. UploadProgress progress) {
  14948. return send_with_content_provider_and_receiver(
  14949. "PUT", path, headers, nullptr, content_length,
  14950. std::move(content_provider), nullptr, content_type,
  14951. std::move(content_receiver), progress);
  14952. }
  14953. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14954. ContentProviderWithoutLength content_provider,
  14955. const std::string &content_type,
  14956. UploadProgress progress) {
  14957. return send_with_content_provider_and_receiver(
  14958. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14959. content_type, nullptr, progress);
  14960. }
  14961. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14962. ContentProviderWithoutLength content_provider,
  14963. const std::string &content_type,
  14964. ContentReceiver content_receiver,
  14965. UploadProgress progress) {
  14966. return send_with_content_provider_and_receiver(
  14967. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14968. content_type, std::move(content_receiver), progress);
  14969. }
  14970. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14971. const UploadFormDataItems &items,
  14972. const FormDataProviderItems &provider_items,
  14973. UploadProgress progress) {
  14974. const auto &boundary = detail::make_multipart_data_boundary();
  14975. const auto &content_type =
  14976. detail::serialize_multipart_formdata_get_content_type(boundary);
  14977. return send_with_content_provider_and_receiver(
  14978. "PUT", path, headers, nullptr, 0, nullptr,
  14979. get_multipart_content_provider(boundary, items, provider_items),
  14980. content_type, nullptr, progress);
  14981. }
  14982. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14983. const std::string &body,
  14984. const std::string &content_type,
  14985. ContentReceiver content_receiver,
  14986. DownloadProgress progress) {
  14987. Request req;
  14988. req.method = "PUT";
  14989. req.path = path;
  14990. req.headers = headers;
  14991. req.body = body;
  14992. req.content_receiver =
  14993. [content_receiver](const char *data, size_t data_length,
  14994. size_t /*offset*/, size_t /*total_length*/) {
  14995. return content_receiver(data, data_length);
  14996. };
  14997. req.download_progress = std::move(progress);
  14998. if (max_timeout_msec_ > 0) {
  14999. req.start_time_ = std::chrono::steady_clock::now();
  15000. }
  15001. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15002. return send_(std::move(req));
  15003. }
  15004. inline Result ClientImpl::Patch(const std::string &path) {
  15005. return Patch(path, std::string(), std::string());
  15006. }
  15007. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15008. UploadProgress progress) {
  15009. return Patch(path, headers, nullptr, 0, std::string(), progress);
  15010. }
  15011. inline Result ClientImpl::Patch(const std::string &path, const char *body,
  15012. size_t content_length,
  15013. const std::string &content_type,
  15014. UploadProgress progress) {
  15015. return Patch(path, Headers(), body, content_length, content_type, progress);
  15016. }
  15017. inline Result ClientImpl::Patch(const std::string &path,
  15018. const std::string &body,
  15019. const std::string &content_type,
  15020. UploadProgress progress) {
  15021. return Patch(path, Headers(), body, content_type, progress);
  15022. }
  15023. inline Result ClientImpl::Patch(const std::string &path, const Params &params) {
  15024. return Patch(path, Headers(), params);
  15025. }
  15026. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  15027. ContentProvider content_provider,
  15028. const std::string &content_type,
  15029. UploadProgress progress) {
  15030. return Patch(path, Headers(), content_length, std::move(content_provider),
  15031. content_type, progress);
  15032. }
  15033. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  15034. ContentProvider content_provider,
  15035. const std::string &content_type,
  15036. ContentReceiver content_receiver,
  15037. UploadProgress progress) {
  15038. return Patch(path, Headers(), content_length, std::move(content_provider),
  15039. content_type, std::move(content_receiver), progress);
  15040. }
  15041. inline Result ClientImpl::Patch(const std::string &path,
  15042. ContentProviderWithoutLength content_provider,
  15043. const std::string &content_type,
  15044. UploadProgress progress) {
  15045. return Patch(path, Headers(), std::move(content_provider), content_type,
  15046. progress);
  15047. }
  15048. inline Result ClientImpl::Patch(const std::string &path,
  15049. ContentProviderWithoutLength content_provider,
  15050. const std::string &content_type,
  15051. ContentReceiver content_receiver,
  15052. UploadProgress progress) {
  15053. return Patch(path, Headers(), std::move(content_provider), content_type,
  15054. std::move(content_receiver), progress);
  15055. }
  15056. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15057. const Params &params) {
  15058. auto query = detail::params_to_query_str(params);
  15059. return Patch(path, headers, query, "application/x-www-form-urlencoded");
  15060. }
  15061. inline Result ClientImpl::Patch(const std::string &path,
  15062. const UploadFormDataItems &items,
  15063. UploadProgress progress) {
  15064. return Patch(path, Headers(), items, progress);
  15065. }
  15066. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15067. const UploadFormDataItems &items,
  15068. UploadProgress progress) {
  15069. const auto &boundary = detail::make_multipart_data_boundary();
  15070. const auto &content_type =
  15071. detail::serialize_multipart_formdata_get_content_type(boundary);
  15072. auto content_length = detail::get_multipart_content_length(items, boundary);
  15073. return Patch(path, headers, content_length,
  15074. detail::make_multipart_content_provider(items, boundary),
  15075. content_type, progress);
  15076. }
  15077. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15078. const UploadFormDataItems &items,
  15079. const std::string &boundary,
  15080. UploadProgress progress) {
  15081. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  15082. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  15083. }
  15084. const auto &content_type =
  15085. detail::serialize_multipart_formdata_get_content_type(boundary);
  15086. auto content_length = detail::get_multipart_content_length(items, boundary);
  15087. return Patch(path, headers, content_length,
  15088. detail::make_multipart_content_provider(items, boundary),
  15089. content_type, progress);
  15090. }
  15091. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15092. const char *body, size_t content_length,
  15093. const std::string &content_type,
  15094. UploadProgress progress) {
  15095. return send_with_content_provider_and_receiver(
  15096. "PATCH", path, headers, body, content_length, nullptr, nullptr,
  15097. content_type, nullptr, progress);
  15098. }
  15099. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15100. const std::string &body,
  15101. const std::string &content_type,
  15102. UploadProgress progress) {
  15103. return send_with_content_provider_and_receiver(
  15104. "PATCH", path, headers, body.data(), body.size(), nullptr, nullptr,
  15105. content_type, nullptr, progress);
  15106. }
  15107. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15108. size_t content_length,
  15109. ContentProvider content_provider,
  15110. const std::string &content_type,
  15111. UploadProgress progress) {
  15112. return send_with_content_provider_and_receiver(
  15113. "PATCH", path, headers, nullptr, content_length,
  15114. std::move(content_provider), nullptr, content_type, nullptr, progress);
  15115. }
  15116. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15117. size_t content_length,
  15118. ContentProvider content_provider,
  15119. const std::string &content_type,
  15120. ContentReceiver content_receiver,
  15121. UploadProgress progress) {
  15122. return send_with_content_provider_and_receiver(
  15123. "PATCH", path, headers, nullptr, content_length,
  15124. std::move(content_provider), nullptr, content_type,
  15125. std::move(content_receiver), progress);
  15126. }
  15127. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15128. ContentProviderWithoutLength content_provider,
  15129. const std::string &content_type,
  15130. UploadProgress progress) {
  15131. return send_with_content_provider_and_receiver(
  15132. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15133. content_type, nullptr, progress);
  15134. }
  15135. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15136. ContentProviderWithoutLength content_provider,
  15137. const std::string &content_type,
  15138. ContentReceiver content_receiver,
  15139. UploadProgress progress) {
  15140. return send_with_content_provider_and_receiver(
  15141. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15142. content_type, std::move(content_receiver), progress);
  15143. }
  15144. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15145. const UploadFormDataItems &items,
  15146. const FormDataProviderItems &provider_items,
  15147. UploadProgress progress) {
  15148. const auto &boundary = detail::make_multipart_data_boundary();
  15149. const auto &content_type =
  15150. detail::serialize_multipart_formdata_get_content_type(boundary);
  15151. return send_with_content_provider_and_receiver(
  15152. "PATCH", path, headers, nullptr, 0, nullptr,
  15153. get_multipart_content_provider(boundary, items, provider_items),
  15154. content_type, nullptr, progress);
  15155. }
  15156. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15157. const std::string &body,
  15158. const std::string &content_type,
  15159. ContentReceiver content_receiver,
  15160. DownloadProgress progress) {
  15161. Request req;
  15162. req.method = "PATCH";
  15163. req.path = path;
  15164. req.headers = headers;
  15165. req.body = body;
  15166. req.content_receiver =
  15167. [content_receiver](const char *data, size_t data_length,
  15168. size_t /*offset*/, size_t /*total_length*/) {
  15169. return content_receiver(data, data_length);
  15170. };
  15171. req.download_progress = std::move(progress);
  15172. if (max_timeout_msec_ > 0) {
  15173. req.start_time_ = std::chrono::steady_clock::now();
  15174. }
  15175. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15176. return send_(std::move(req));
  15177. }
  15178. inline Result ClientImpl::Delete(const std::string &path,
  15179. DownloadProgress progress) {
  15180. return Delete(path, Headers(), std::string(), std::string(), progress);
  15181. }
  15182. inline Result ClientImpl::Delete(const std::string &path,
  15183. const Headers &headers,
  15184. DownloadProgress progress) {
  15185. return Delete(path, headers, std::string(), std::string(), progress);
  15186. }
  15187. inline Result ClientImpl::Delete(const std::string &path, const char *body,
  15188. size_t content_length,
  15189. const std::string &content_type,
  15190. DownloadProgress progress) {
  15191. return Delete(path, Headers(), body, content_length, content_type, progress);
  15192. }
  15193. inline Result ClientImpl::Delete(const std::string &path,
  15194. const std::string &body,
  15195. const std::string &content_type,
  15196. DownloadProgress progress) {
  15197. return Delete(path, Headers(), body.data(), body.size(), content_type,
  15198. progress);
  15199. }
  15200. inline Result ClientImpl::Delete(const std::string &path,
  15201. const Headers &headers,
  15202. const std::string &body,
  15203. const std::string &content_type,
  15204. DownloadProgress progress) {
  15205. return Delete(path, headers, body.data(), body.size(), content_type,
  15206. progress);
  15207. }
  15208. inline Result ClientImpl::Delete(const std::string &path, const Params &params,
  15209. DownloadProgress progress) {
  15210. return Delete(path, Headers(), params, progress);
  15211. }
  15212. inline Result ClientImpl::Delete(const std::string &path,
  15213. const Headers &headers, const Params &params,
  15214. DownloadProgress progress) {
  15215. auto query = detail::params_to_query_str(params);
  15216. return Delete(path, headers, query, "application/x-www-form-urlencoded",
  15217. progress);
  15218. }
  15219. inline Result ClientImpl::Delete(const std::string &path,
  15220. const Headers &headers, const char *body,
  15221. size_t content_length,
  15222. const std::string &content_type,
  15223. DownloadProgress progress) {
  15224. Request req;
  15225. req.method = "DELETE";
  15226. req.headers = headers;
  15227. req.path = path;
  15228. req.download_progress = std::move(progress);
  15229. if (max_timeout_msec_ > 0) {
  15230. req.start_time_ = std::chrono::steady_clock::now();
  15231. }
  15232. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15233. req.body.assign(body, content_length);
  15234. return send_(std::move(req));
  15235. }
  15236. inline Result ClientImpl::Options(const std::string &path) {
  15237. return Options(path, Headers());
  15238. }
  15239. inline Result ClientImpl::Options(const std::string &path,
  15240. const Headers &headers) {
  15241. Request req;
  15242. req.method = "OPTIONS";
  15243. req.headers = headers;
  15244. req.path = path;
  15245. if (max_timeout_msec_ > 0) {
  15246. req.start_time_ = std::chrono::steady_clock::now();
  15247. }
  15248. return send_(std::move(req));
  15249. }
  15250. inline void ClientImpl::stop() {
  15251. std::lock_guard<std::mutex> guard(socket_mutex_);
  15252. // If there is anything ongoing right now, the ONLY thread-safe thing we can
  15253. // do is to shutdown_socket, so that threads using this socket suddenly
  15254. // discover they can't read/write any more and error out. Everything else
  15255. // (closing the socket, shutting ssl down) is unsafe because these actions
  15256. // are not thread-safe.
  15257. if (socket_requests_in_flight_ > 0) {
  15258. shutdown_socket(socket_);
  15259. // Aside from that, we set a flag for the socket to be closed when we're
  15260. // done.
  15261. socket_should_be_closed_when_request_is_done_ = true;
  15262. return;
  15263. }
  15264. disconnect(/*gracefully=*/true);
  15265. }
  15266. inline std::string ClientImpl::host() const { return host_; }
  15267. inline int ClientImpl::port() const { return port_; }
  15268. inline size_t ClientImpl::is_socket_open() const {
  15269. std::lock_guard<std::mutex> guard(socket_mutex_);
  15270. return socket_.is_open();
  15271. }
  15272. inline socket_t ClientImpl::socket() const { return socket_.sock; }
  15273. inline void ClientImpl::set_connection_timeout(time_t sec, time_t usec) {
  15274. connection_timeout_sec_ = sec;
  15275. connection_timeout_usec_ = usec;
  15276. }
  15277. inline void ClientImpl::set_read_timeout(time_t sec, time_t usec) {
  15278. read_timeout_sec_ = sec;
  15279. read_timeout_usec_ = usec;
  15280. }
  15281. inline void ClientImpl::set_write_timeout(time_t sec, time_t usec) {
  15282. write_timeout_sec_ = sec;
  15283. write_timeout_usec_ = usec;
  15284. }
  15285. inline void ClientImpl::set_max_timeout(time_t msec) {
  15286. max_timeout_msec_ = msec;
  15287. }
  15288. inline void ClientImpl::set_basic_auth(const std::string &username,
  15289. const std::string &password) {
  15290. basic_auth_username_ = username;
  15291. basic_auth_password_ = password;
  15292. }
  15293. inline void ClientImpl::set_bearer_token_auth(const std::string &token) {
  15294. bearer_token_auth_token_ = token;
  15295. }
  15296. inline void ClientImpl::set_keep_alive(bool on) { keep_alive_ = on; }
  15297. inline void ClientImpl::set_follow_location(bool on) { follow_location_ = on; }
  15298. inline void ClientImpl::set_path_encode(bool on) { path_encode_ = on; }
  15299. inline void
  15300. ClientImpl::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15301. addr_map_ = std::move(addr_map);
  15302. }
  15303. inline void ClientImpl::set_default_headers(Headers headers) {
  15304. default_headers_ = std::move(headers);
  15305. }
  15306. inline void ClientImpl::set_header_writer(
  15307. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15308. header_writer_ = writer;
  15309. }
  15310. inline void ClientImpl::set_address_family(int family) {
  15311. address_family_ = family;
  15312. }
  15313. inline void ClientImpl::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  15314. inline void ClientImpl::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  15315. inline void ClientImpl::set_socket_options(SocketOptions socket_options) {
  15316. socket_options_ = std::move(socket_options);
  15317. }
  15318. inline void ClientImpl::set_compress(bool on) { compress_ = on; }
  15319. inline void ClientImpl::set_decompress(bool on) { decompress_ = on; }
  15320. inline void ClientImpl::set_payload_max_length(size_t length) {
  15321. payload_max_length_ = length;
  15322. has_payload_max_length_ = true;
  15323. }
  15324. inline void ClientImpl::set_interface(const std::string &intf) {
  15325. interface_ = intf;
  15326. }
  15327. inline void ClientImpl::set_proxy(const std::string &host, int port) {
  15328. proxy_host_ = host;
  15329. proxy_port_ = port;
  15330. std::lock_guard<std::mutex> guard(socket_mutex_);
  15331. disconnect(/*gracefully=*/true);
  15332. }
  15333. inline void ClientImpl::set_proxy_basic_auth(const std::string &username,
  15334. const std::string &password) {
  15335. proxy_basic_auth_username_ = username;
  15336. proxy_basic_auth_password_ = password;
  15337. }
  15338. inline void ClientImpl::set_proxy_bearer_token_auth(const std::string &token) {
  15339. proxy_bearer_token_auth_token_ = token;
  15340. }
  15341. inline void ClientImpl::set_no_proxy(const std::vector<std::string> &patterns) {
  15342. no_proxy_entries_ = detail::parse_no_proxy_entries(patterns);
  15343. std::lock_guard<std::mutex> guard(socket_mutex_);
  15344. disconnect(/*gracefully=*/true);
  15345. }
  15346. #ifdef CPPHTTPLIB_SSL_ENABLED
  15347. inline void ClientImpl::set_digest_auth(const std::string &username,
  15348. const std::string &password) {
  15349. digest_auth_username_ = username;
  15350. digest_auth_password_ = password;
  15351. }
  15352. inline void ClientImpl::set_ca_cert_path(const std::string &ca_cert_file_path,
  15353. const std::string &ca_cert_dir_path) {
  15354. ca_cert_file_path_ = ca_cert_file_path;
  15355. ca_cert_dir_path_ = ca_cert_dir_path;
  15356. }
  15357. inline void ClientImpl::set_proxy_digest_auth(const std::string &username,
  15358. const std::string &password) {
  15359. proxy_digest_auth_username_ = username;
  15360. proxy_digest_auth_password_ = password;
  15361. }
  15362. inline void ClientImpl::enable_server_certificate_verification(bool enabled) {
  15363. server_certificate_verification_ = enabled;
  15364. }
  15365. inline void ClientImpl::enable_server_hostname_verification(bool enabled) {
  15366. server_hostname_verification_ = enabled;
  15367. }
  15368. inline void ClientImpl::enable_system_ca(bool enabled) {
  15369. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  15370. }
  15371. #endif
  15372. inline void ClientImpl::set_logger(Logger logger) {
  15373. logger_ = std::move(logger);
  15374. }
  15375. inline void ClientImpl::set_error_logger(ErrorLogger error_logger) {
  15376. error_logger_ = std::move(error_logger);
  15377. }
  15378. /*
  15379. * SSL/TLS Common Implementation
  15380. */
  15381. inline ClientConnection::~ClientConnection() {
  15382. #ifdef CPPHTTPLIB_SSL_ENABLED
  15383. if (session) {
  15384. tls::shutdown(session, true);
  15385. tls::free_session(session);
  15386. session = nullptr;
  15387. }
  15388. #endif
  15389. if (sock != INVALID_SOCKET) {
  15390. detail::close_socket(sock);
  15391. sock = INVALID_SOCKET;
  15392. }
  15393. }
  15394. // Universal client implementation
  15395. inline Client::Client(const std::string &scheme_host_port)
  15396. : Client(scheme_host_port, std::string(), std::string()) {}
  15397. inline Client::Client(const std::string &scheme_host_port,
  15398. const std::string &client_cert_path,
  15399. const std::string &client_key_path) {
  15400. detail::UrlComponents uc;
  15401. if (detail::parse_url(scheme_host_port, uc) && !uc.host.empty()) {
  15402. auto &scheme = uc.scheme;
  15403. #ifdef CPPHTTPLIB_SSL_ENABLED
  15404. if (!scheme.empty() && (scheme != "http" && scheme != "https")) {
  15405. #else
  15406. if (!scheme.empty() && scheme != "http") {
  15407. #endif
  15408. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  15409. std::string msg = "'" + scheme + "' scheme is not supported.";
  15410. throw std::invalid_argument(msg);
  15411. #endif
  15412. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15413. return;
  15414. }
  15415. auto is_ssl = scheme == "https";
  15416. auto host = std::move(uc.host);
  15417. auto port = is_ssl ? 443 : 80;
  15418. if (!uc.port.empty() && !detail::parse_port(uc.port, port)) {
  15419. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15420. return;
  15421. }
  15422. if (is_ssl) {
  15423. #ifdef CPPHTTPLIB_SSL_ENABLED
  15424. cli_ = detail::make_unique<SSLClient>(host, port, client_cert_path,
  15425. client_key_path);
  15426. is_ssl_ = is_ssl;
  15427. #endif
  15428. } else {
  15429. cli_ = detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15430. client_key_path);
  15431. }
  15432. } else if (scheme_host_port.compare(0, 2, "//") == 0 ||
  15433. scheme_host_port.find("://") < scheme_host_port.find('/')) {
  15434. // A URL, but not one this client can use, such as one with userinfo. A
  15435. // Unix socket path may have "//" further on.
  15436. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15437. } else {
  15438. // NOTE: Update TEST(UniversalClientImplTest, Ipv6LiteralAddress)
  15439. // if port param below changes.
  15440. cli_ = detail::make_unique<ClientImpl>(scheme_host_port, 80,
  15441. client_cert_path, client_key_path);
  15442. }
  15443. }
  15444. inline Client::Client(const std::string &host, int port)
  15445. : Client(host, port, std::string(), std::string()) {}
  15446. inline Client::Client(const std::string &host, int port,
  15447. const std::string &client_cert_path,
  15448. const std::string &client_key_path)
  15449. : cli_(detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15450. client_key_path)) {}
  15451. inline Client::~Client() = default;
  15452. inline bool Client::is_valid() const {
  15453. return cli_ != nullptr && cli_->is_valid();
  15454. }
  15455. inline Result Client::Get(const std::string &path, DownloadProgress progress) {
  15456. return cli_->Get(path, std::move(progress));
  15457. }
  15458. inline Result Client::Get(const std::string &path, const Headers &headers,
  15459. DownloadProgress progress) {
  15460. return cli_->Get(path, headers, std::move(progress));
  15461. }
  15462. inline Result Client::Get(const std::string &path,
  15463. ContentReceiver content_receiver,
  15464. DownloadProgress progress) {
  15465. return cli_->Get(path, std::move(content_receiver), std::move(progress));
  15466. }
  15467. inline Result Client::Get(const std::string &path, const Headers &headers,
  15468. ContentReceiver content_receiver,
  15469. DownloadProgress progress) {
  15470. return cli_->Get(path, headers, std::move(content_receiver),
  15471. std::move(progress));
  15472. }
  15473. inline Result Client::Get(const std::string &path,
  15474. ResponseHandler response_handler,
  15475. ContentReceiver content_receiver,
  15476. DownloadProgress progress) {
  15477. return cli_->Get(path, std::move(response_handler),
  15478. std::move(content_receiver), std::move(progress));
  15479. }
  15480. inline Result Client::Get(const std::string &path, const Headers &headers,
  15481. ResponseHandler response_handler,
  15482. ContentReceiver content_receiver,
  15483. DownloadProgress progress) {
  15484. return cli_->Get(path, headers, std::move(response_handler),
  15485. std::move(content_receiver), std::move(progress));
  15486. }
  15487. inline Result Client::Get(const std::string &path, const Params &params,
  15488. DownloadProgress progress) {
  15489. return cli_->Get(path, params, std::move(progress));
  15490. }
  15491. inline Result Client::Get(const std::string &path, const Params &params,
  15492. const Headers &headers, DownloadProgress progress) {
  15493. return cli_->Get(path, params, headers, std::move(progress));
  15494. }
  15495. inline Result Client::Get(const std::string &path, const Params &params,
  15496. const Headers &headers,
  15497. ContentReceiver content_receiver,
  15498. DownloadProgress progress) {
  15499. return cli_->Get(path, params, headers, std::move(content_receiver),
  15500. std::move(progress));
  15501. }
  15502. inline Result Client::Get(const std::string &path, const Params &params,
  15503. const Headers &headers,
  15504. ResponseHandler response_handler,
  15505. ContentReceiver content_receiver,
  15506. DownloadProgress progress) {
  15507. return cli_->Get(path, params, headers, std::move(response_handler),
  15508. std::move(content_receiver), std::move(progress));
  15509. }
  15510. inline Result Client::Head(const std::string &path) { return cli_->Head(path); }
  15511. inline Result Client::Head(const std::string &path, const Headers &headers) {
  15512. return cli_->Head(path, headers);
  15513. }
  15514. inline Result Client::Post(const std::string &path) { return cli_->Post(path); }
  15515. inline Result Client::Post(const std::string &path, const Headers &headers) {
  15516. return cli_->Post(path, headers);
  15517. }
  15518. inline Result Client::Post(const std::string &path, const char *body,
  15519. size_t content_length,
  15520. const std::string &content_type,
  15521. UploadProgress progress) {
  15522. return cli_->Post(path, body, content_length, content_type, progress);
  15523. }
  15524. inline Result Client::Post(const std::string &path, const Headers &headers,
  15525. const char *body, size_t content_length,
  15526. const std::string &content_type,
  15527. UploadProgress progress) {
  15528. return cli_->Post(path, headers, body, content_length, content_type,
  15529. progress);
  15530. }
  15531. inline Result Client::Post(const std::string &path, const std::string &body,
  15532. const std::string &content_type,
  15533. UploadProgress progress) {
  15534. return cli_->Post(path, body, content_type, progress);
  15535. }
  15536. inline Result Client::Post(const std::string &path, const Headers &headers,
  15537. const std::string &body,
  15538. const std::string &content_type,
  15539. UploadProgress progress) {
  15540. return cli_->Post(path, headers, body, content_type, progress);
  15541. }
  15542. inline Result Client::Post(const std::string &path, size_t content_length,
  15543. ContentProvider content_provider,
  15544. const std::string &content_type,
  15545. UploadProgress progress) {
  15546. return cli_->Post(path, content_length, std::move(content_provider),
  15547. content_type, progress);
  15548. }
  15549. inline Result Client::Post(const std::string &path, size_t content_length,
  15550. ContentProvider content_provider,
  15551. const std::string &content_type,
  15552. ContentReceiver content_receiver,
  15553. UploadProgress progress) {
  15554. return cli_->Post(path, content_length, std::move(content_provider),
  15555. content_type, std::move(content_receiver), progress);
  15556. }
  15557. inline Result Client::Post(const std::string &path,
  15558. ContentProviderWithoutLength content_provider,
  15559. const std::string &content_type,
  15560. UploadProgress progress) {
  15561. return cli_->Post(path, std::move(content_provider), content_type, progress);
  15562. }
  15563. inline Result Client::Post(const std::string &path,
  15564. ContentProviderWithoutLength content_provider,
  15565. const std::string &content_type,
  15566. ContentReceiver content_receiver,
  15567. UploadProgress progress) {
  15568. return cli_->Post(path, std::move(content_provider), content_type,
  15569. std::move(content_receiver), progress);
  15570. }
  15571. inline Result Client::Post(const std::string &path, const Headers &headers,
  15572. size_t content_length,
  15573. ContentProvider content_provider,
  15574. const std::string &content_type,
  15575. UploadProgress progress) {
  15576. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15577. content_type, progress);
  15578. }
  15579. inline Result Client::Post(const std::string &path, const Headers &headers,
  15580. size_t content_length,
  15581. ContentProvider content_provider,
  15582. const std::string &content_type,
  15583. ContentReceiver content_receiver,
  15584. DownloadProgress progress) {
  15585. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15586. content_type, std::move(content_receiver), progress);
  15587. }
  15588. inline Result Client::Post(const std::string &path, const Headers &headers,
  15589. ContentProviderWithoutLength content_provider,
  15590. const std::string &content_type,
  15591. UploadProgress progress) {
  15592. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15593. progress);
  15594. }
  15595. inline Result Client::Post(const std::string &path, const Headers &headers,
  15596. ContentProviderWithoutLength content_provider,
  15597. const std::string &content_type,
  15598. ContentReceiver content_receiver,
  15599. DownloadProgress progress) {
  15600. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15601. std::move(content_receiver), progress);
  15602. }
  15603. inline Result Client::Post(const std::string &path, const Params &params) {
  15604. return cli_->Post(path, params);
  15605. }
  15606. inline Result Client::Post(const std::string &path, const Headers &headers,
  15607. const Params &params) {
  15608. return cli_->Post(path, headers, params);
  15609. }
  15610. inline Result Client::Post(const std::string &path,
  15611. const UploadFormDataItems &items,
  15612. UploadProgress progress) {
  15613. return cli_->Post(path, items, progress);
  15614. }
  15615. inline Result Client::Post(const std::string &path, const Headers &headers,
  15616. const UploadFormDataItems &items,
  15617. UploadProgress progress) {
  15618. return cli_->Post(path, headers, items, progress);
  15619. }
  15620. inline Result Client::Post(const std::string &path, const Headers &headers,
  15621. const UploadFormDataItems &items,
  15622. const std::string &boundary,
  15623. UploadProgress progress) {
  15624. return cli_->Post(path, headers, items, boundary, progress);
  15625. }
  15626. inline Result Client::Post(const std::string &path, const Headers &headers,
  15627. const UploadFormDataItems &items,
  15628. const FormDataProviderItems &provider_items,
  15629. UploadProgress progress) {
  15630. return cli_->Post(path, headers, items, provider_items, progress);
  15631. }
  15632. inline Result Client::Post(const std::string &path, const Headers &headers,
  15633. const std::string &body,
  15634. const std::string &content_type,
  15635. ContentReceiver content_receiver,
  15636. DownloadProgress progress) {
  15637. return cli_->Post(path, headers, body, content_type,
  15638. std::move(content_receiver), progress);
  15639. }
  15640. inline Result Client::Put(const std::string &path) { return cli_->Put(path); }
  15641. inline Result Client::Put(const std::string &path, const Headers &headers) {
  15642. return cli_->Put(path, headers);
  15643. }
  15644. inline Result Client::Put(const std::string &path, const char *body,
  15645. size_t content_length,
  15646. const std::string &content_type,
  15647. UploadProgress progress) {
  15648. return cli_->Put(path, body, content_length, content_type, progress);
  15649. }
  15650. inline Result Client::Put(const std::string &path, const Headers &headers,
  15651. const char *body, size_t content_length,
  15652. const std::string &content_type,
  15653. UploadProgress progress) {
  15654. return cli_->Put(path, headers, body, content_length, content_type, progress);
  15655. }
  15656. inline Result Client::Put(const std::string &path, const std::string &body,
  15657. const std::string &content_type,
  15658. UploadProgress progress) {
  15659. return cli_->Put(path, body, content_type, progress);
  15660. }
  15661. inline Result Client::Put(const std::string &path, const Headers &headers,
  15662. const std::string &body,
  15663. const std::string &content_type,
  15664. UploadProgress progress) {
  15665. return cli_->Put(path, headers, body, content_type, progress);
  15666. }
  15667. inline Result Client::Put(const std::string &path, size_t content_length,
  15668. ContentProvider content_provider,
  15669. const std::string &content_type,
  15670. UploadProgress progress) {
  15671. return cli_->Put(path, content_length, std::move(content_provider),
  15672. content_type, progress);
  15673. }
  15674. inline Result Client::Put(const std::string &path, size_t content_length,
  15675. ContentProvider content_provider,
  15676. const std::string &content_type,
  15677. ContentReceiver content_receiver,
  15678. UploadProgress progress) {
  15679. return cli_->Put(path, content_length, std::move(content_provider),
  15680. content_type, std::move(content_receiver), progress);
  15681. }
  15682. inline Result Client::Put(const std::string &path,
  15683. ContentProviderWithoutLength content_provider,
  15684. const std::string &content_type,
  15685. UploadProgress progress) {
  15686. return cli_->Put(path, std::move(content_provider), content_type, progress);
  15687. }
  15688. inline Result Client::Put(const std::string &path,
  15689. ContentProviderWithoutLength content_provider,
  15690. const std::string &content_type,
  15691. ContentReceiver content_receiver,
  15692. UploadProgress progress) {
  15693. return cli_->Put(path, std::move(content_provider), content_type,
  15694. std::move(content_receiver), progress);
  15695. }
  15696. inline Result Client::Put(const std::string &path, const Headers &headers,
  15697. size_t content_length,
  15698. ContentProvider content_provider,
  15699. const std::string &content_type,
  15700. UploadProgress progress) {
  15701. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15702. content_type, progress);
  15703. }
  15704. inline Result Client::Put(const std::string &path, const Headers &headers,
  15705. size_t content_length,
  15706. ContentProvider content_provider,
  15707. const std::string &content_type,
  15708. ContentReceiver content_receiver,
  15709. UploadProgress progress) {
  15710. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15711. content_type, std::move(content_receiver), progress);
  15712. }
  15713. inline Result Client::Put(const std::string &path, const Headers &headers,
  15714. ContentProviderWithoutLength content_provider,
  15715. const std::string &content_type,
  15716. UploadProgress progress) {
  15717. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15718. progress);
  15719. }
  15720. inline Result Client::Put(const std::string &path, const Headers &headers,
  15721. ContentProviderWithoutLength content_provider,
  15722. const std::string &content_type,
  15723. ContentReceiver content_receiver,
  15724. UploadProgress progress) {
  15725. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15726. std::move(content_receiver), progress);
  15727. }
  15728. inline Result Client::Put(const std::string &path, const Params &params) {
  15729. return cli_->Put(path, params);
  15730. }
  15731. inline Result Client::Put(const std::string &path, const Headers &headers,
  15732. const Params &params) {
  15733. return cli_->Put(path, headers, params);
  15734. }
  15735. inline Result Client::Put(const std::string &path,
  15736. const UploadFormDataItems &items,
  15737. UploadProgress progress) {
  15738. return cli_->Put(path, items, progress);
  15739. }
  15740. inline Result Client::Put(const std::string &path, const Headers &headers,
  15741. const UploadFormDataItems &items,
  15742. UploadProgress progress) {
  15743. return cli_->Put(path, headers, items, progress);
  15744. }
  15745. inline Result Client::Put(const std::string &path, const Headers &headers,
  15746. const UploadFormDataItems &items,
  15747. const std::string &boundary,
  15748. UploadProgress progress) {
  15749. return cli_->Put(path, headers, items, boundary, progress);
  15750. }
  15751. inline Result Client::Put(const std::string &path, const Headers &headers,
  15752. const UploadFormDataItems &items,
  15753. const FormDataProviderItems &provider_items,
  15754. UploadProgress progress) {
  15755. return cli_->Put(path, headers, items, provider_items, progress);
  15756. }
  15757. inline Result Client::Put(const std::string &path, const Headers &headers,
  15758. const std::string &body,
  15759. const std::string &content_type,
  15760. ContentReceiver content_receiver,
  15761. DownloadProgress progress) {
  15762. return cli_->Put(path, headers, body, content_type, content_receiver,
  15763. progress);
  15764. }
  15765. inline Result Client::Patch(const std::string &path) {
  15766. return cli_->Patch(path);
  15767. }
  15768. inline Result Client::Patch(const std::string &path, const Headers &headers) {
  15769. return cli_->Patch(path, headers);
  15770. }
  15771. inline Result Client::Patch(const std::string &path, const char *body,
  15772. size_t content_length,
  15773. const std::string &content_type,
  15774. UploadProgress progress) {
  15775. return cli_->Patch(path, body, content_length, content_type, progress);
  15776. }
  15777. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15778. const char *body, size_t content_length,
  15779. const std::string &content_type,
  15780. UploadProgress progress) {
  15781. return cli_->Patch(path, headers, body, content_length, content_type,
  15782. progress);
  15783. }
  15784. inline Result Client::Patch(const std::string &path, const std::string &body,
  15785. const std::string &content_type,
  15786. UploadProgress progress) {
  15787. return cli_->Patch(path, body, content_type, progress);
  15788. }
  15789. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15790. const std::string &body,
  15791. const std::string &content_type,
  15792. UploadProgress progress) {
  15793. return cli_->Patch(path, headers, body, content_type, progress);
  15794. }
  15795. inline Result Client::Patch(const std::string &path, size_t content_length,
  15796. ContentProvider content_provider,
  15797. const std::string &content_type,
  15798. UploadProgress progress) {
  15799. return cli_->Patch(path, content_length, std::move(content_provider),
  15800. content_type, progress);
  15801. }
  15802. inline Result Client::Patch(const std::string &path, size_t content_length,
  15803. ContentProvider content_provider,
  15804. const std::string &content_type,
  15805. ContentReceiver content_receiver,
  15806. UploadProgress progress) {
  15807. return cli_->Patch(path, content_length, std::move(content_provider),
  15808. content_type, std::move(content_receiver), progress);
  15809. }
  15810. inline Result Client::Patch(const std::string &path,
  15811. ContentProviderWithoutLength content_provider,
  15812. const std::string &content_type,
  15813. UploadProgress progress) {
  15814. return cli_->Patch(path, std::move(content_provider), content_type, progress);
  15815. }
  15816. inline Result Client::Patch(const std::string &path,
  15817. ContentProviderWithoutLength content_provider,
  15818. const std::string &content_type,
  15819. ContentReceiver content_receiver,
  15820. UploadProgress progress) {
  15821. return cli_->Patch(path, std::move(content_provider), content_type,
  15822. std::move(content_receiver), progress);
  15823. }
  15824. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15825. size_t content_length,
  15826. ContentProvider content_provider,
  15827. const std::string &content_type,
  15828. UploadProgress progress) {
  15829. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15830. content_type, progress);
  15831. }
  15832. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15833. size_t content_length,
  15834. ContentProvider content_provider,
  15835. const std::string &content_type,
  15836. ContentReceiver content_receiver,
  15837. UploadProgress progress) {
  15838. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15839. content_type, std::move(content_receiver), progress);
  15840. }
  15841. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15842. ContentProviderWithoutLength content_provider,
  15843. const std::string &content_type,
  15844. UploadProgress progress) {
  15845. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15846. progress);
  15847. }
  15848. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15849. ContentProviderWithoutLength content_provider,
  15850. const std::string &content_type,
  15851. ContentReceiver content_receiver,
  15852. UploadProgress progress) {
  15853. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15854. std::move(content_receiver), progress);
  15855. }
  15856. inline Result Client::Patch(const std::string &path, const Params &params) {
  15857. return cli_->Patch(path, params);
  15858. }
  15859. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15860. const Params &params) {
  15861. return cli_->Patch(path, headers, params);
  15862. }
  15863. inline Result Client::Patch(const std::string &path,
  15864. const UploadFormDataItems &items,
  15865. UploadProgress progress) {
  15866. return cli_->Patch(path, items, progress);
  15867. }
  15868. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15869. const UploadFormDataItems &items,
  15870. UploadProgress progress) {
  15871. return cli_->Patch(path, headers, items, progress);
  15872. }
  15873. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15874. const UploadFormDataItems &items,
  15875. const std::string &boundary,
  15876. UploadProgress progress) {
  15877. return cli_->Patch(path, headers, items, boundary, progress);
  15878. }
  15879. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15880. const UploadFormDataItems &items,
  15881. const FormDataProviderItems &provider_items,
  15882. UploadProgress progress) {
  15883. return cli_->Patch(path, headers, items, provider_items, progress);
  15884. }
  15885. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15886. const std::string &body,
  15887. const std::string &content_type,
  15888. ContentReceiver content_receiver,
  15889. DownloadProgress progress) {
  15890. return cli_->Patch(path, headers, body, content_type, content_receiver,
  15891. progress);
  15892. }
  15893. inline Result Client::Delete(const std::string &path,
  15894. DownloadProgress progress) {
  15895. return cli_->Delete(path, progress);
  15896. }
  15897. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15898. DownloadProgress progress) {
  15899. return cli_->Delete(path, headers, progress);
  15900. }
  15901. inline Result Client::Delete(const std::string &path, const char *body,
  15902. size_t content_length,
  15903. const std::string &content_type,
  15904. DownloadProgress progress) {
  15905. return cli_->Delete(path, body, content_length, content_type, progress);
  15906. }
  15907. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15908. const char *body, size_t content_length,
  15909. const std::string &content_type,
  15910. DownloadProgress progress) {
  15911. return cli_->Delete(path, headers, body, content_length, content_type,
  15912. progress);
  15913. }
  15914. inline Result Client::Delete(const std::string &path, const std::string &body,
  15915. const std::string &content_type,
  15916. DownloadProgress progress) {
  15917. return cli_->Delete(path, body, content_type, progress);
  15918. }
  15919. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15920. const std::string &body,
  15921. const std::string &content_type,
  15922. DownloadProgress progress) {
  15923. return cli_->Delete(path, headers, body, content_type, progress);
  15924. }
  15925. inline Result Client::Delete(const std::string &path, const Params &params,
  15926. DownloadProgress progress) {
  15927. return cli_->Delete(path, params, progress);
  15928. }
  15929. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15930. const Params &params, DownloadProgress progress) {
  15931. return cli_->Delete(path, headers, params, progress);
  15932. }
  15933. inline Result Client::Options(const std::string &path) {
  15934. return cli_->Options(path);
  15935. }
  15936. inline Result Client::Options(const std::string &path, const Headers &headers) {
  15937. return cli_->Options(path, headers);
  15938. }
  15939. inline ClientImpl::StreamHandle
  15940. Client::open_stream(const std::string &method, const std::string &path,
  15941. const Params &params, const Headers &headers,
  15942. const std::string &body, const std::string &content_type) {
  15943. return cli_->open_stream(method, path, params, headers, body, content_type);
  15944. }
  15945. inline bool Client::send(Request &req, Response &res, Error &error) {
  15946. return cli_->send(req, res, error);
  15947. }
  15948. inline Result Client::send(const Request &req) { return cli_->send(req); }
  15949. inline void Client::stop() { cli_->stop(); }
  15950. inline std::string Client::host() const { return cli_->host(); }
  15951. inline int Client::port() const { return cli_->port(); }
  15952. inline size_t Client::is_socket_open() const { return cli_->is_socket_open(); }
  15953. inline socket_t Client::socket() const { return cli_->socket(); }
  15954. inline void
  15955. Client::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15956. cli_->set_hostname_addr_map(std::move(addr_map));
  15957. }
  15958. inline void Client::set_default_headers(Headers headers) {
  15959. cli_->set_default_headers(std::move(headers));
  15960. }
  15961. inline void Client::set_header_writer(
  15962. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15963. cli_->set_header_writer(writer);
  15964. }
  15965. inline void Client::set_address_family(int family) {
  15966. cli_->set_address_family(family);
  15967. }
  15968. inline void Client::set_tcp_nodelay(bool on) { cli_->set_tcp_nodelay(on); }
  15969. inline void Client::set_socket_options(SocketOptions socket_options) {
  15970. cli_->set_socket_options(std::move(socket_options));
  15971. }
  15972. inline void Client::set_connection_timeout(time_t sec, time_t usec) {
  15973. cli_->set_connection_timeout(sec, usec);
  15974. }
  15975. inline void Client::set_read_timeout(time_t sec, time_t usec) {
  15976. cli_->set_read_timeout(sec, usec);
  15977. }
  15978. inline void Client::set_write_timeout(time_t sec, time_t usec) {
  15979. cli_->set_write_timeout(sec, usec);
  15980. }
  15981. inline void Client::set_basic_auth(const std::string &username,
  15982. const std::string &password) {
  15983. cli_->set_basic_auth(username, password);
  15984. }
  15985. inline void Client::set_bearer_token_auth(const std::string &token) {
  15986. cli_->set_bearer_token_auth(token);
  15987. }
  15988. inline void Client::set_keep_alive(bool on) { cli_->set_keep_alive(on); }
  15989. inline void Client::set_follow_location(bool on) {
  15990. cli_->set_follow_location(on);
  15991. }
  15992. inline void Client::set_path_encode(bool on) { cli_->set_path_encode(on); }
  15993. inline void Client::set_compress(bool on) { cli_->set_compress(on); }
  15994. inline void Client::set_decompress(bool on) { cli_->set_decompress(on); }
  15995. inline void Client::set_payload_max_length(size_t length) {
  15996. cli_->set_payload_max_length(length);
  15997. }
  15998. inline void Client::set_interface(const std::string &intf) {
  15999. cli_->set_interface(intf);
  16000. }
  16001. inline void Client::set_proxy(const std::string &host, int port) {
  16002. cli_->set_proxy(host, port);
  16003. }
  16004. inline void Client::set_proxy_basic_auth(const std::string &username,
  16005. const std::string &password) {
  16006. cli_->set_proxy_basic_auth(username, password);
  16007. }
  16008. inline void Client::set_proxy_bearer_token_auth(const std::string &token) {
  16009. cli_->set_proxy_bearer_token_auth(token);
  16010. }
  16011. inline void Client::set_no_proxy(const std::vector<std::string> &patterns) {
  16012. cli_->set_no_proxy(patterns);
  16013. }
  16014. inline void Client::set_logger(Logger logger) {
  16015. cli_->set_logger(std::move(logger));
  16016. }
  16017. inline void Client::set_error_logger(ErrorLogger error_logger) {
  16018. cli_->set_error_logger(std::move(error_logger));
  16019. }
  16020. /*
  16021. * Group 6: SSL Server and Client implementation
  16022. */
  16023. #ifdef CPPHTTPLIB_SSL_ENABLED
  16024. // SSL HTTP server implementation
  16025. inline SSLServer::SSLServer(const char *cert_path, const char *private_key_path,
  16026. const char *client_ca_cert_file_path,
  16027. const char *client_ca_cert_dir_path,
  16028. const char *private_key_password) {
  16029. using namespace tls;
  16030. ctx_ = create_server_context();
  16031. if (!ctx_) { return; }
  16032. // Load server certificate and private key
  16033. if (!set_server_cert_file(ctx_, cert_path, private_key_path,
  16034. private_key_password)) {
  16035. last_ssl_error_ = static_cast<int>(get_error());
  16036. free_context(ctx_);
  16037. ctx_ = nullptr;
  16038. return;
  16039. }
  16040. // Load client CA certificates for client authentication
  16041. if (client_ca_cert_file_path || client_ca_cert_dir_path) {
  16042. if (!set_client_ca_file(ctx_, client_ca_cert_file_path,
  16043. client_ca_cert_dir_path)) {
  16044. last_ssl_error_ = static_cast<int>(get_error());
  16045. free_context(ctx_);
  16046. ctx_ = nullptr;
  16047. return;
  16048. }
  16049. // Enable client certificate verification
  16050. set_verify_client(ctx_, true);
  16051. }
  16052. }
  16053. inline SSLServer::SSLServer(const PemMemory &pem) {
  16054. using namespace tls;
  16055. ctx_ = create_server_context();
  16056. if (ctx_) {
  16057. std::string cert_buf, key_buf;
  16058. if (!set_server_cert_pem(
  16059. ctx_, detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  16060. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  16061. pem.private_key_password)) {
  16062. last_ssl_error_ = static_cast<int>(get_error());
  16063. free_context(ctx_);
  16064. ctx_ = nullptr;
  16065. } else if (pem.client_ca_pem && pem.client_ca_pem_len > 0) {
  16066. if (!load_ca_pem(ctx_, pem.client_ca_pem, pem.client_ca_pem_len)) {
  16067. last_ssl_error_ = static_cast<int>(get_error());
  16068. free_context(ctx_);
  16069. ctx_ = nullptr;
  16070. } else {
  16071. set_verify_client(ctx_, true);
  16072. }
  16073. }
  16074. }
  16075. }
  16076. inline SSLServer::SSLServer(const tls::ContextSetupCallback &setup_callback) {
  16077. using namespace tls;
  16078. ctx_ = create_server_context();
  16079. if (ctx_) {
  16080. if (!setup_callback(ctx_)) {
  16081. free_context(ctx_);
  16082. ctx_ = nullptr;
  16083. }
  16084. }
  16085. }
  16086. inline SSLServer::~SSLServer() {
  16087. if (ctx_) { tls::free_context(ctx_); }
  16088. }
  16089. inline bool SSLServer::is_valid() const {
  16090. return ctx_ != nullptr && Server::is_valid();
  16091. }
  16092. inline bool SSLServer::process_and_close_socket(socket_t sock) {
  16093. using namespace tls;
  16094. session_t session = nullptr;
  16095. {
  16096. std::unique_lock<std::mutex> lock(ctx_mutex_);
  16097. ctx_cv_.wait(lock, [&] { return updates_pending_ == 0; });
  16098. session = create_session(static_cast<ctx_t>(ctx_), sock);
  16099. if (session) { handshakes_in_progress_++; }
  16100. }
  16101. if (!session) {
  16102. last_ssl_error_ = static_cast<int>(get_error());
  16103. detail::shutdown_socket(sock);
  16104. detail::close_socket(sock);
  16105. return false;
  16106. }
  16107. // Use scope_exit to ensure cleanup on all paths (including exceptions)
  16108. bool handshake_done = false;
  16109. bool ret = false;
  16110. bool websocket_upgraded = false;
  16111. auto cleanup = detail::scope_exit([&] {
  16112. if (handshake_done) { shutdown(session, !websocket_upgraded && ret); }
  16113. free_session(session);
  16114. detail::shutdown_socket(sock);
  16115. detail::close_socket(sock);
  16116. });
  16117. // Perform TLS accept handshake with timeout
  16118. TlsError tls_err;
  16119. auto accepted = false;
  16120. {
  16121. auto handshake_left = detail::scope_exit([&] {
  16122. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16123. if (--handshakes_in_progress_ == 0) { ctx_cv_.notify_all(); }
  16124. });
  16125. accepted = accept_nonblocking(session, sock, read_timeout_sec_,
  16126. read_timeout_usec_, &tls_err);
  16127. }
  16128. if (!accepted) {
  16129. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16130. // Map TlsError to legacy ssl_error for backward compatibility
  16131. if (tls_err.code == ErrorCode::WantRead) {
  16132. last_ssl_error_ = SSL_ERROR_WANT_READ;
  16133. } else if (tls_err.code == ErrorCode::WantWrite) {
  16134. last_ssl_error_ = SSL_ERROR_WANT_WRITE;
  16135. } else {
  16136. last_ssl_error_ = SSL_ERROR_SSL;
  16137. }
  16138. #else
  16139. last_ssl_error_ = static_cast<int>(get_error());
  16140. #endif
  16141. return false;
  16142. }
  16143. handshake_done = true;
  16144. std::string remote_addr;
  16145. int remote_port = 0;
  16146. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  16147. std::string local_addr;
  16148. int local_port = 0;
  16149. detail::get_local_ip_and_port(sock, local_addr, local_port);
  16150. ret = serve_guarded([&]() {
  16151. return detail::process_server_socket_ssl(
  16152. svr_sock_, session, sock, keep_alive_max_count_,
  16153. keep_alive_timeout_sec_, read_timeout_sec_, read_timeout_usec_,
  16154. write_timeout_sec_, write_timeout_usec_,
  16155. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  16156. return process_request(
  16157. strm, remote_addr, remote_port, local_addr, local_port,
  16158. close_connection, connection_closed,
  16159. [&](Request &req) { req.ssl = session; }, &websocket_upgraded);
  16160. });
  16161. });
  16162. return ret;
  16163. }
  16164. inline bool SSLServer::update_certs_pem(const char *cert_pem,
  16165. const char *key_pem,
  16166. const char *client_ca_pem,
  16167. const char *password) {
  16168. if (!ctx_) { return false; }
  16169. std::unique_lock<std::mutex> lock(ctx_mutex_);
  16170. updates_pending_++;
  16171. auto se = detail::scope_exit([&] {
  16172. if (--updates_pending_ == 0) { ctx_cv_.notify_all(); }
  16173. });
  16174. ctx_cv_.wait(lock, [&] { return handshakes_in_progress_ == 0; });
  16175. if (!tls::update_server_cert(ctx_, cert_pem, key_pem, password)) {
  16176. return false;
  16177. }
  16178. if (client_ca_pem) {
  16179. return tls::update_server_client_ca(ctx_, client_ca_pem);
  16180. }
  16181. return true;
  16182. }
  16183. // SSL HTTP client implementation
  16184. inline SSLClient::~SSLClient() {
  16185. // Make sure to shut down SSL since shutdown_ssl will resolve to the
  16186. // base function rather than the derived function once we get to the
  16187. // base class destructor, and won't free the SSL (causing a leak).
  16188. // This must happen before the context is freed below: some backends
  16189. // (e.g. mbedTLS) have the SSL session borrow a raw pointer into the
  16190. // context, so freeing the context first leaves close_notify reading
  16191. // freed memory.
  16192. shutdown_ssl_impl(socket_, true);
  16193. if (ctx_) {
  16194. tls::free_context(ctx_);
  16195. ctx_ = nullptr;
  16196. }
  16197. }
  16198. inline bool SSLClient::is_valid() const { return ctx_ != nullptr; }
  16199. inline void SSLClient::shutdown_ssl(Socket &socket, bool shutdown_gracefully) {
  16200. shutdown_ssl_impl(socket, shutdown_gracefully);
  16201. }
  16202. inline void SSLClient::shutdown_ssl_impl(Socket &socket,
  16203. bool shutdown_gracefully) {
  16204. if (socket.sock == INVALID_SOCKET) {
  16205. assert(socket.ssl == nullptr);
  16206. return;
  16207. }
  16208. if (socket.ssl) {
  16209. tls::shutdown(socket.ssl, shutdown_gracefully);
  16210. {
  16211. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16212. tls::free_session(socket.ssl);
  16213. }
  16214. socket.ssl = nullptr;
  16215. }
  16216. assert(socket.ssl == nullptr);
  16217. }
  16218. inline bool SSLClient::process_socket(
  16219. const Socket &socket,
  16220. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16221. std::function<bool(Stream &strm)> callback) {
  16222. assert(socket.ssl);
  16223. return detail::process_client_socket_ssl(
  16224. socket.ssl, socket.sock, read_timeout_sec_, read_timeout_usec_,
  16225. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_, start_time,
  16226. [&](detail::SSLSocketStream &strm) {
  16227. auto ret = callback(strm);
  16228. // A request that failed after the handshake reports Error::Read or
  16229. // Error::Write; keep the TLS error behind it, such as a fatal alert
  16230. // from the server, for Result::ssl_error() and ssl_backend_error()
  16231. const auto &tls_error = strm.tls_error();
  16232. if (!ret && tls_error.code != tls::ErrorCode::Success) {
  16233. last_ssl_error_ = static_cast<int>(tls_error.code);
  16234. last_backend_error_ = tls_error.backend_code;
  16235. }
  16236. return ret;
  16237. });
  16238. }
  16239. inline bool SSLClient::is_ssl() const { return true; }
  16240. inline bool SSLClient::create_and_connect_socket(Socket &socket, Error &error) {
  16241. if (!is_valid()) {
  16242. error = Error::SSLConnection;
  16243. return false;
  16244. }
  16245. return ClientImpl::create_and_connect_socket(socket, error);
  16246. }
  16247. inline bool SSLClient::setup_proxy_connection(
  16248. Socket &socket,
  16249. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16250. Response &res, bool &success, Error &error) {
  16251. if (!is_proxy_enabled_for_host(host_)) { return true; }
  16252. if (!connect_with_proxy(socket, start_time, res, success, error)) {
  16253. return false;
  16254. }
  16255. if (!initialize_ssl(socket, error)) {
  16256. success = false;
  16257. return false;
  16258. }
  16259. return true;
  16260. }
  16261. // Assumes that socket_mutex_ is locked and that there are no requests in
  16262. // flight
  16263. inline bool SSLClient::connect_with_proxy(
  16264. Socket &socket,
  16265. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16266. Response &res, bool &success, Error &error) {
  16267. success = true;
  16268. Response proxy_res;
  16269. if (!detail::process_client_socket(
  16270. socket.sock, read_timeout_sec_, read_timeout_usec_,
  16271. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  16272. start_time, [&](Stream &strm) {
  16273. Request req2;
  16274. req2.method = "CONNECT";
  16275. req2.path =
  16276. detail::make_host_and_port_string_always_port(host_, port_);
  16277. if (max_timeout_msec_ > 0) {
  16278. req2.start_time_ = std::chrono::steady_clock::now();
  16279. }
  16280. return process_request(strm, req2, proxy_res, false, error);
  16281. })) {
  16282. // Thread-safe to close everything because we are assuming there are no
  16283. // requests in flight
  16284. shutdown_ssl(socket, true);
  16285. shutdown_socket(socket);
  16286. close_socket(socket);
  16287. success = false;
  16288. return false;
  16289. }
  16290. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  16291. if (!proxy_digest_auth_username_.empty() &&
  16292. !proxy_digest_auth_password_.empty()) {
  16293. std::map<std::string, std::string> auth;
  16294. if (detail::parse_www_authenticate(proxy_res, auth, true)) {
  16295. // Close the current socket and create a new one for the authenticated
  16296. // request
  16297. shutdown_ssl(socket, true);
  16298. shutdown_socket(socket);
  16299. close_socket(socket);
  16300. // Create a new socket for the authenticated CONNECT request
  16301. if (!ensure_socket_connection(socket, error)) {
  16302. success = false;
  16303. output_error_log(error, nullptr);
  16304. return false;
  16305. }
  16306. proxy_res = Response();
  16307. if (!detail::process_client_socket(
  16308. socket.sock, read_timeout_sec_, read_timeout_usec_,
  16309. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  16310. start_time, [&](Stream &strm) {
  16311. Request req3;
  16312. req3.method = "CONNECT";
  16313. req3.path = detail::make_host_and_port_string_always_port(
  16314. host_, port_);
  16315. req3.headers.insert(detail::make_digest_authentication_header(
  16316. req3, make_request_target(req3), auth, 1,
  16317. detail::random_string(10), proxy_digest_auth_username_,
  16318. proxy_digest_auth_password_, true));
  16319. if (max_timeout_msec_ > 0) {
  16320. req3.start_time_ = std::chrono::steady_clock::now();
  16321. }
  16322. return process_request(strm, req3, proxy_res, false, error);
  16323. })) {
  16324. // Thread-safe to close everything because we are assuming there are
  16325. // no requests in flight
  16326. shutdown_ssl(socket, true);
  16327. shutdown_socket(socket);
  16328. close_socket(socket);
  16329. success = false;
  16330. return false;
  16331. }
  16332. }
  16333. }
  16334. }
  16335. // If status code is not 200, proxy request is failed.
  16336. // Set error to ProxyConnection. A 407 is returned as the response of the
  16337. // request, so the caller sees the proxy asks for credentials; any other
  16338. // status would read as the answer of the origin, which it never reached.
  16339. if (proxy_res.status != StatusCode::OK_200) {
  16340. error = Error::ProxyConnection;
  16341. output_error_log(error, nullptr);
  16342. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  16343. res = std::move(proxy_res);
  16344. } else {
  16345. success = false;
  16346. }
  16347. // Thread-safe to close everything because we are assuming there are
  16348. // no requests in flight
  16349. shutdown_ssl(socket, true);
  16350. shutdown_socket(socket);
  16351. close_socket(socket);
  16352. return false;
  16353. }
  16354. return true;
  16355. }
  16356. inline bool SSLClient::ensure_socket_connection(Socket &socket, Error &error) {
  16357. if (!ClientImpl::ensure_socket_connection(socket, error)) { return false; }
  16358. if (is_proxy_enabled_for_host(host_)) { return true; }
  16359. if (!initialize_ssl(socket, error)) {
  16360. shutdown_socket(socket);
  16361. close_socket(socket);
  16362. return false;
  16363. }
  16364. return true;
  16365. }
  16366. // SSL HTTP client implementation
  16367. inline SSLClient::SSLClient(const std::string &host)
  16368. : SSLClient(host, 443, std::string(), std::string()) {}
  16369. inline SSLClient::SSLClient(const std::string &host, int port)
  16370. : SSLClient(host, port, std::string(), std::string()) {}
  16371. inline void SSLClient::init_ctx() {
  16372. ctx_ = tls::create_client_context();
  16373. if (ctx_) { tls::set_min_version(ctx_, tls::Version::TLS1_2); }
  16374. }
  16375. inline void SSLClient::reset_ctx_on_error() {
  16376. last_backend_error_ = tls::get_error();
  16377. tls::free_context(ctx_);
  16378. ctx_ = nullptr;
  16379. }
  16380. inline SSLClient::SSLClient(const std::string &host, int port,
  16381. const std::string &client_cert_path,
  16382. const std::string &client_key_path,
  16383. const std::string &private_key_password)
  16384. : ClientImpl(host, port, client_cert_path, client_key_path) {
  16385. init_ctx();
  16386. if (!ctx_) { return; }
  16387. if (!client_cert_path.empty() && !client_key_path.empty()) {
  16388. const char *password =
  16389. private_key_password.empty() ? nullptr : private_key_password.c_str();
  16390. if (!tls::set_client_cert_file(ctx_, client_cert_path.c_str(),
  16391. client_key_path.c_str(), password)) {
  16392. reset_ctx_on_error();
  16393. }
  16394. }
  16395. }
  16396. inline SSLClient::SSLClient(const std::string &host, int port,
  16397. const PemMemory &pem)
  16398. : ClientImpl(host, port) {
  16399. init_ctx();
  16400. if (!ctx_) { return; }
  16401. if (pem.cert_pem && pem.key_pem) {
  16402. std::string cert_buf, key_buf;
  16403. if (!tls::set_client_cert_pem(
  16404. ctx_, detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  16405. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  16406. pem.private_key_password)) {
  16407. reset_ctx_on_error();
  16408. }
  16409. }
  16410. }
  16411. inline void SSLClient::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16412. if (ca_cert_store && ctx_) {
  16413. // set_ca_store takes ownership of ca_cert_store
  16414. tls::set_ca_store(ctx_, ca_cert_store);
  16415. ca_cert_store_set_ = true;
  16416. } else if (ca_cert_store) {
  16417. tls::free_ca_store(ca_cert_store);
  16418. }
  16419. }
  16420. inline void
  16421. SSLClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16422. if (!ctx_) { return; }
  16423. server_certificate_verifier_ = verifier;
  16424. // Under the lock that creating a session from ctx_ takes
  16425. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16426. tls::set_verify_callback(ctx_, std::move(verifier));
  16427. }
  16428. inline void SSLClient::set_session_verifier(
  16429. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16430. session_verifier_ = std::move(verifier);
  16431. }
  16432. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16433. inline void SSLClient::enable_windows_certificate_verification(bool enabled) {
  16434. enable_windows_cert_verification_ = enabled;
  16435. }
  16436. #endif
  16437. inline void SSLClient::load_ca_cert_store(const char *ca_cert,
  16438. std::size_t size) {
  16439. if (ctx_ && ca_cert && size > 0) {
  16440. // Every PEM loaded, for redirect transfer
  16441. if (!ca_cert_pem_.empty() && ca_cert_pem_.back() != '\n') {
  16442. ca_cert_pem_ += '\n';
  16443. }
  16444. ca_cert_pem_.append(ca_cert, size);
  16445. tls::load_ca_pem(ctx_, ca_cert, size);
  16446. }
  16447. }
  16448. inline bool SSLClient::load_certs() {
  16449. auto ret = true;
  16450. // call_once rather than the plain flag WebSocketClient::create_stream() uses:
  16451. // one client is shared across concurrent requests here.
  16452. std::call_once(initialize_cert_, [&]() {
  16453. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16454. ret = detail::load_client_ca_config(
  16455. ctx_, ca_cert_file_path_, ca_cert_dir_path_,
  16456. !ca_cert_pem_.empty() || ca_cert_store_set_, system_ca_mode_,
  16457. last_backend_error_);
  16458. });
  16459. return ret;
  16460. }
  16461. inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) {
  16462. // Load CA certificates if server verification is enabled
  16463. if (server_certificate_verification_) {
  16464. if (!load_certs()) {
  16465. error = Error::SSLLoadingCerts;
  16466. output_error_log(error, nullptr);
  16467. return false;
  16468. }
  16469. }
  16470. detail::ClientTlsSessionOptions options;
  16471. options.server_hostname_verification = server_hostname_verification_;
  16472. options.session_verifier = session_verifier_;
  16473. options.ctx_mutex = &ctx_mutex_;
  16474. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16475. // Skip Schannel when a custom CA cert is specified, as the Windows
  16476. // certificate store would not know about user-provided CA certificates.
  16477. // Also skip when system CA trust is explicitly disabled.
  16478. options.windows_cert_verification =
  16479. enable_windows_cert_verification_ &&
  16480. system_ca_mode_ != SystemCAMode::Disabled && ca_cert_file_path_.empty() &&
  16481. ca_cert_dir_path_.empty() && ca_cert_pem_.empty() && !ca_cert_store_set_;
  16482. // Only a verifier set through set_server_certificate_verifier() is seen
  16483. // here, not one installed with tls::set_verify_callback() directly.
  16484. options.server_certificate_verifier_set =
  16485. static_cast<bool>(server_certificate_verifier_);
  16486. #endif
  16487. tls::session_t session = nullptr;
  16488. // Use scope_exit to ensure session is freed on error paths
  16489. bool success = false;
  16490. auto session_guard = detail::scope_exit([&] {
  16491. if (!success) { tls::free_session(session); }
  16492. });
  16493. detail::ClientTlsSessionError tls_error;
  16494. if (!detail::setup_client_tls_session(
  16495. host_, ctx_, session, socket.sock, server_certificate_verification_,
  16496. connection_timeout_sec_, connection_timeout_usec_, &tls_error,
  16497. options)) {
  16498. error = tls_error.error;
  16499. last_ssl_error_ = tls_error.ssl_error;
  16500. last_backend_error_ = tls_error.backend_error;
  16501. output_error_log(error, nullptr);
  16502. return false;
  16503. }
  16504. success = true;
  16505. socket.ssl = session;
  16506. return true;
  16507. }
  16508. inline void Client::set_digest_auth(const std::string &username,
  16509. const std::string &password) {
  16510. cli_->set_digest_auth(username, password);
  16511. }
  16512. inline void Client::set_proxy_digest_auth(const std::string &username,
  16513. const std::string &password) {
  16514. cli_->set_proxy_digest_auth(username, password);
  16515. }
  16516. inline void Client::enable_server_certificate_verification(bool enabled) {
  16517. cli_->enable_server_certificate_verification(enabled);
  16518. }
  16519. inline void Client::enable_server_hostname_verification(bool enabled) {
  16520. cli_->enable_server_hostname_verification(enabled);
  16521. }
  16522. inline void Client::enable_system_ca(bool enabled) {
  16523. cli_->enable_system_ca(enabled);
  16524. }
  16525. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16526. inline void Client::enable_windows_certificate_verification(bool enabled) {
  16527. if (is_ssl_) {
  16528. static_cast<SSLClient &>(*cli_).enable_windows_certificate_verification(
  16529. enabled);
  16530. }
  16531. }
  16532. #endif
  16533. inline void Client::set_ca_cert_path(const std::string &ca_cert_file_path,
  16534. const std::string &ca_cert_dir_path) {
  16535. cli_->set_ca_cert_path(ca_cert_file_path, ca_cert_dir_path);
  16536. }
  16537. inline void Client::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16538. if (is_ssl_) {
  16539. static_cast<SSLClient &>(*cli_).set_ca_cert_store(ca_cert_store);
  16540. } else if (ca_cert_store) {
  16541. tls::free_ca_store(ca_cert_store);
  16542. }
  16543. }
  16544. inline void Client::load_ca_cert_store(const char *ca_cert, std::size_t size) {
  16545. if (is_ssl_) {
  16546. // Use the PEM-based path so the CA data is retained for redirect transfer
  16547. static_cast<SSLClient &>(*cli_).load_ca_cert_store(ca_cert, size);
  16548. }
  16549. }
  16550. inline void
  16551. Client::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16552. if (is_ssl_) {
  16553. static_cast<SSLClient &>(*cli_).set_server_certificate_verifier(
  16554. std::move(verifier));
  16555. }
  16556. }
  16557. inline void Client::set_session_verifier(
  16558. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16559. if (is_ssl_) {
  16560. static_cast<SSLClient &>(*cli_).set_session_verifier(std::move(verifier));
  16561. }
  16562. }
  16563. inline tls::ctx_t Client::tls_context() const {
  16564. if (is_ssl_) { return static_cast<SSLClient &>(*cli_).tls_context(); }
  16565. return nullptr;
  16566. }
  16567. #endif // CPPHTTPLIB_SSL_ENABLED
  16568. /*
  16569. * Group 7: TLS abstraction layer - Common API
  16570. */
  16571. #ifdef CPPHTTPLIB_SSL_ENABLED
  16572. namespace tls {
  16573. // Helper for PeerCert construction
  16574. inline PeerCert get_peer_cert_from_session(const_session_t session) {
  16575. return PeerCert(get_peer_cert(session));
  16576. }
  16577. namespace impl {
  16578. // set_verify_callback() can replace a callback while handshakes on other
  16579. // threads run it, so they share it, and take their reference under this lock.
  16580. inline std::mutex &verify_callback_mutex() {
  16581. static std::mutex mutex;
  16582. return mutex;
  16583. }
  16584. // The TLS libraries are C, so an exception from a verify callback must not
  16585. // unwind through them. It rejects the certificate instead.
  16586. inline bool run_verify_callback(const VerifyCallback &callback,
  16587. const VerifyContext &ctx) {
  16588. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  16589. return callback(ctx);
  16590. #else
  16591. try {
  16592. return callback(ctx);
  16593. } catch (...) { return false; }
  16594. #endif
  16595. }
  16596. // Check if a string is an IPv4 address
  16597. inline bool is_ipv4_address(const std::string &str) {
  16598. int dots = 0;
  16599. for (char c : str) {
  16600. if (c == '.') {
  16601. dots++;
  16602. } else if (!detail::is_ascii_digit(c)) {
  16603. return false;
  16604. }
  16605. }
  16606. return dots == 3;
  16607. }
  16608. // Parse IPv4 address string to bytes
  16609. inline bool parse_ipv4(const std::string &str, unsigned char *out) {
  16610. const char *p = str.c_str();
  16611. for (int i = 0; i < 4; i++) {
  16612. if (i > 0) {
  16613. if (*p != '.') { return false; }
  16614. p++;
  16615. }
  16616. int val = 0;
  16617. int digits = 0;
  16618. while (detail::is_ascii_digit(*p)) {
  16619. val = val * 10 + (*p - '0');
  16620. if (val > 255) { return false; }
  16621. p++;
  16622. digits++;
  16623. }
  16624. if (digits == 0) { return false; }
  16625. // Reject leading zeros (e.g., "01.002.03.04") to prevent ambiguity
  16626. if (digits > 1 && *(p - digits) == '0') { return false; }
  16627. out[i] = static_cast<unsigned char>(val);
  16628. }
  16629. return *p == '\0';
  16630. }
  16631. // Parse an IP literal (IPv4 or IPv6) into raw network-order bytes.
  16632. // `out` must have room for at least 16 bytes. Returns the address length
  16633. // (4 for IPv4, 16 for IPv6) on success, or 0 if the string is not an IP
  16634. // literal. Used to match a host against iPAddress SANs the same way the
  16635. // OpenSSL backend does via X509_check_ip.
  16636. inline size_t parse_ip_address(const std::string &str, unsigned char *out) {
  16637. if (is_ipv4_address(str)) { return parse_ipv4(str, out) ? 4 : 0; }
  16638. struct in6_addr addr6 = {};
  16639. if (inet_pton(AF_INET6, str.c_str(), &addr6) == 1) {
  16640. memcpy(out, &addr6, 16);
  16641. return 16;
  16642. }
  16643. return 0;
  16644. }
  16645. #ifdef _WIN32
  16646. // Enumerate Windows system certificates and call callback with DER data
  16647. template <typename Callback>
  16648. inline bool enumerate_windows_system_certs(Callback cb) {
  16649. bool loaded = false;
  16650. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16651. for (auto store_name : store_names) {
  16652. HCERTSTORE hStore = CertOpenSystemStoreW(0, store_name);
  16653. if (hStore) {
  16654. PCCERT_CONTEXT pContext = nullptr;
  16655. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16656. nullptr) {
  16657. if (cb(pContext->pbCertEncoded, pContext->cbCertEncoded)) {
  16658. loaded = true;
  16659. }
  16660. }
  16661. CertCloseStore(hStore, 0);
  16662. }
  16663. }
  16664. return loaded;
  16665. }
  16666. #endif
  16667. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16668. // Enumerate macOS Keychain certificates and call callback with DER data
  16669. template <typename Callback>
  16670. inline bool enumerate_macos_keychain_certs(Callback cb) {
  16671. bool loaded = false;
  16672. const SecTrustSettingsDomain domains[] = {
  16673. kSecTrustSettingsDomainSystem,
  16674. kSecTrustSettingsDomainAdmin,
  16675. kSecTrustSettingsDomainUser,
  16676. };
  16677. for (auto domain : domains) {
  16678. CFArrayRef certs = nullptr;
  16679. OSStatus status = SecTrustSettingsCopyCertificates(domain, &certs);
  16680. if (status != errSecSuccess || !certs) {
  16681. if (certs) CFRelease(certs);
  16682. continue;
  16683. }
  16684. CFIndex count = CFArrayGetCount(certs);
  16685. for (CFIndex i = 0; i < count; i++) {
  16686. SecCertificateRef cert =
  16687. (SecCertificateRef)CFArrayGetValueAtIndex(certs, i);
  16688. CFDataRef data = SecCertificateCopyData(cert);
  16689. if (data) {
  16690. if (cb(CFDataGetBytePtr(data),
  16691. static_cast<size_t>(CFDataGetLength(data)))) {
  16692. loaded = true;
  16693. }
  16694. CFRelease(data);
  16695. }
  16696. }
  16697. CFRelease(certs);
  16698. }
  16699. return loaded;
  16700. }
  16701. #endif
  16702. #if !defined(_WIN32) && !(defined(__APPLE__) && \
  16703. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN))
  16704. // Common CA certificate file paths on Linux/Unix
  16705. inline const char **system_ca_paths() {
  16706. static const char *paths[] = {
  16707. "/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu
  16708. "/etc/pki/tls/certs/ca-bundle.crt", // RHEL/CentOS
  16709. "/etc/ssl/ca-bundle.pem", // OpenSUSE
  16710. "/etc/pki/tls/cacert.pem", // OpenELEC
  16711. "/etc/ssl/cert.pem", // Alpine, FreeBSD
  16712. nullptr};
  16713. return paths;
  16714. }
  16715. // Common CA certificate directory paths on Linux/Unix
  16716. inline const char **system_ca_dirs() {
  16717. static const char *dirs[] = {"/etc/ssl/certs", // Debian/Ubuntu
  16718. "/etc/pki/tls/certs", // RHEL/CentOS
  16719. "/usr/share/ca-certificates", // Other
  16720. nullptr};
  16721. return dirs;
  16722. }
  16723. #endif
  16724. } // namespace impl
  16725. inline bool set_client_ca_file(ctx_t ctx, const char *ca_file,
  16726. const char *ca_dir) {
  16727. if (!ctx) { return false; }
  16728. bool success = true;
  16729. if (ca_file && *ca_file) {
  16730. if (!load_ca_file(ctx, ca_file)) { success = false; }
  16731. }
  16732. if (ca_dir && *ca_dir) {
  16733. if (!load_ca_dir(ctx, ca_dir)) { success = false; }
  16734. }
  16735. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16736. // Set CA list for client certificate request (CertificateRequest message)
  16737. if (ca_file && *ca_file) {
  16738. auto list = SSL_load_client_CA_file(ca_file);
  16739. if (list) { SSL_CTX_set_client_CA_list(static_cast<SSL_CTX *>(ctx), list); }
  16740. }
  16741. #endif
  16742. return success;
  16743. }
  16744. inline bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16745. const char *password) {
  16746. return set_client_cert_pem(ctx, cert, key, password);
  16747. }
  16748. inline bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  16749. const char *key_path, const char *password) {
  16750. return set_client_cert_file(ctx, cert_path, key_path, password);
  16751. }
  16752. // PeerCert implementation
  16753. inline PeerCert::PeerCert() = default;
  16754. inline PeerCert::PeerCert(cert_t cert) : cert_(cert) {}
  16755. inline PeerCert::PeerCert(PeerCert &&other) noexcept : cert_(other.cert_) {
  16756. other.cert_ = nullptr;
  16757. }
  16758. inline PeerCert &PeerCert::operator=(PeerCert &&other) noexcept {
  16759. if (this != &other) {
  16760. if (cert_) { free_cert(cert_); }
  16761. cert_ = other.cert_;
  16762. other.cert_ = nullptr;
  16763. }
  16764. return *this;
  16765. }
  16766. inline PeerCert::~PeerCert() {
  16767. if (cert_) { free_cert(cert_); }
  16768. }
  16769. inline PeerCert::operator bool() const { return cert_ != nullptr; }
  16770. inline std::string PeerCert::subject_cn() const {
  16771. return cert_ ? get_cert_subject_cn(cert_) : std::string();
  16772. }
  16773. inline std::string PeerCert::issuer_name() const {
  16774. return cert_ ? get_cert_issuer_name(cert_) : std::string();
  16775. }
  16776. inline bool PeerCert::check_hostname(const char *hostname) const {
  16777. return cert_ ? verify_hostname(cert_, hostname) : false;
  16778. }
  16779. inline std::vector<SanEntry> PeerCert::sans() const {
  16780. std::vector<SanEntry> result;
  16781. if (cert_) { get_cert_sans(cert_, result); }
  16782. return result;
  16783. }
  16784. inline bool PeerCert::validity(time_t &not_before, time_t &not_after) const {
  16785. return cert_ ? get_cert_validity(cert_, not_before, not_after) : false;
  16786. }
  16787. inline std::string PeerCert::serial() const {
  16788. return cert_ ? get_cert_serial(cert_) : std::string();
  16789. }
  16790. // VerifyContext method implementations
  16791. inline std::string VerifyContext::subject_cn() const {
  16792. return cert ? get_cert_subject_cn(cert) : std::string();
  16793. }
  16794. inline std::string VerifyContext::issuer_name() const {
  16795. return cert ? get_cert_issuer_name(cert) : std::string();
  16796. }
  16797. inline bool VerifyContext::check_hostname(const char *hostname) const {
  16798. return cert ? verify_hostname(cert, hostname) : false;
  16799. }
  16800. inline std::vector<SanEntry> VerifyContext::sans() const {
  16801. std::vector<SanEntry> result;
  16802. if (cert) { get_cert_sans(cert, result); }
  16803. return result;
  16804. }
  16805. inline bool VerifyContext::validity(time_t &not_before,
  16806. time_t &not_after) const {
  16807. return cert ? get_cert_validity(cert, not_before, not_after) : false;
  16808. }
  16809. inline std::string VerifyContext::serial() const {
  16810. return cert ? get_cert_serial(cert) : std::string();
  16811. }
  16812. // TlsError static method implementation
  16813. inline std::string TlsError::verify_error_to_string(long error_code) {
  16814. return verify_error_string(error_code);
  16815. }
  16816. } // namespace tls
  16817. // Request::peer_cert() implementation
  16818. inline tls::PeerCert Request::peer_cert() const {
  16819. return tls::get_peer_cert_from_session(ssl);
  16820. }
  16821. // Request::sni() implementation
  16822. inline std::string Request::sni() const {
  16823. if (!ssl) { return std::string(); }
  16824. const char *s = tls::get_sni(ssl);
  16825. return s ? std::string(s) : std::string();
  16826. }
  16827. #endif // CPPHTTPLIB_SSL_ENABLED
  16828. /*
  16829. * Group 8: TLS abstraction layer - OpenSSL backend
  16830. */
  16831. /*
  16832. * OpenSSL Backend Implementation
  16833. */
  16834. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16835. namespace tls {
  16836. namespace impl {
  16837. // Helper to map OpenSSL SSL_get_error to ErrorCode
  16838. inline ErrorCode map_ssl_error(int ssl_error, int &out_errno) {
  16839. switch (ssl_error) {
  16840. case SSL_ERROR_NONE: return ErrorCode::Success;
  16841. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  16842. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  16843. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  16844. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  16845. case SSL_ERROR_SSL:
  16846. default: return ErrorCode::Fatal;
  16847. }
  16848. }
  16849. // Helper: Create client CA list from PEM string
  16850. // Returns a new STACK_OF(X509_NAME)* or nullptr on failure
  16851. // Caller takes ownership of returned list
  16852. inline STACK_OF(X509_NAME) *
  16853. create_client_ca_list_from_pem(const char *ca_pem) {
  16854. if (!ca_pem) { return nullptr; }
  16855. auto ca_list = sk_X509_NAME_new_null();
  16856. if (!ca_list) { return nullptr; }
  16857. BIO *bio = BIO_new_mem_buf(ca_pem, -1);
  16858. if (!bio) {
  16859. sk_X509_NAME_pop_free(ca_list, X509_NAME_free);
  16860. return nullptr;
  16861. }
  16862. X509 *cert = nullptr;
  16863. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16864. nullptr) {
  16865. const X509_NAME *name = X509_get_subject_name(cert);
  16866. if (name) {
  16867. sk_X509_NAME_push(ca_list, X509_NAME_dup(const_cast<X509_NAME *>(name)));
  16868. }
  16869. X509_free(cert);
  16870. }
  16871. BIO_free(bio);
  16872. return ca_list;
  16873. }
  16874. inline void free_verify_callback(void * /*parent*/, void *ptr,
  16875. CRYPTO_EX_DATA * /*ad*/, int /*idx*/,
  16876. long /*argl*/, void * /*argp*/) {
  16877. delete static_cast<std::shared_ptr<VerifyCallback> *>(ptr);
  16878. }
  16879. // The SSL_CTX owns its verify callback, so each client or server sees only
  16880. // its own, on whichever thread runs the handshake.
  16881. inline int verify_callback_index() {
  16882. static const auto index = SSL_CTX_get_ex_new_index(
  16883. 0, nullptr, nullptr, nullptr, free_verify_callback);
  16884. return index;
  16885. }
  16886. // OpenSSL verify callback wrapper
  16887. inline int openssl_verify_callback(int preverify_ok, X509_STORE_CTX *ctx) {
  16888. // Get SSL object from X509_STORE_CTX
  16889. auto ssl = static_cast<SSL *>(
  16890. X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
  16891. if (!ssl) { return preverify_ok; }
  16892. std::shared_ptr<VerifyCallback> callback;
  16893. {
  16894. std::lock_guard<std::mutex> guard(verify_callback_mutex());
  16895. auto stored = static_cast<std::shared_ptr<VerifyCallback> *>(
  16896. SSL_CTX_get_ex_data(SSL_get_SSL_CTX(ssl), verify_callback_index()));
  16897. if (stored) { callback = *stored; }
  16898. }
  16899. if (!callback) { return preverify_ok; }
  16900. // Get current certificate and depth
  16901. auto cert = X509_STORE_CTX_get_current_cert(ctx);
  16902. int depth = X509_STORE_CTX_get_error_depth(ctx);
  16903. int error = X509_STORE_CTX_get_error(ctx);
  16904. // Build context
  16905. VerifyContext verify_ctx;
  16906. verify_ctx.session = static_cast<session_t>(ssl);
  16907. verify_ctx.cert = static_cast<cert_t>(cert);
  16908. verify_ctx.depth = depth;
  16909. verify_ctx.preverify_ok = (preverify_ok != 0);
  16910. verify_ctx.error_code = error;
  16911. verify_ctx.error_string =
  16912. (error != X509_V_OK) ? X509_verify_cert_error_string(error) : nullptr;
  16913. return run_verify_callback(*callback, verify_ctx) ? 1 : 0;
  16914. }
  16915. // Sets the verify mode from whether the peer's certificate is required and
  16916. // whether a verify callback is set.
  16917. inline void apply_verify_mode(SSL_CTX *ssl_ctx, bool require) {
  16918. auto has_callback =
  16919. SSL_CTX_get_ex_data(ssl_ctx, verify_callback_index()) != nullptr;
  16920. auto mode = require ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  16921. : (has_callback ? SSL_VERIFY_PEER : SSL_VERIFY_NONE);
  16922. SSL_CTX_set_verify(ssl_ctx, mode,
  16923. has_callback ? openssl_verify_callback : nullptr);
  16924. }
  16925. // X509_STORE_get0_objects is deprecated since OpenSSL 4.0 because it is not
  16926. // thread-safe; X509_STORE_get1_objects (OpenSSL 3.3+) returns a snapshot
  16927. // that must be released with release_store_objects
  16928. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER) && \
  16929. OPENSSL_VERSION_NUMBER >= 0x30300000L
  16930. #define CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16931. #endif
  16932. inline STACK_OF(X509_OBJECT) * get_store_objects(X509_STORE *store) {
  16933. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16934. return X509_STORE_get1_objects(store);
  16935. #else
  16936. return X509_STORE_get0_objects(store);
  16937. #endif
  16938. }
  16939. inline void release_store_objects(STACK_OF(X509_OBJECT) * objs) {
  16940. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16941. sk_X509_OBJECT_pop_free(objs, X509_OBJECT_free);
  16942. #else
  16943. (void)objs; // get0 variant returns an internal pointer; nothing to free
  16944. #endif
  16945. }
  16946. } // namespace impl
  16947. inline ctx_t create_client_context() {
  16948. SSL_CTX *ctx = SSL_CTX_new(TLS_client_method());
  16949. if (ctx) {
  16950. // Disable auto-retry to properly handle non-blocking I/O
  16951. SSL_CTX_clear_mode(ctx, SSL_MODE_AUTO_RETRY);
  16952. // Set minimum TLS version
  16953. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16954. }
  16955. return static_cast<ctx_t>(ctx);
  16956. }
  16957. inline void free_context(ctx_t ctx) {
  16958. if (ctx) { SSL_CTX_free(static_cast<SSL_CTX *>(ctx)); }
  16959. }
  16960. inline bool set_min_version(ctx_t ctx, Version version) {
  16961. if (!ctx) return false;
  16962. return SSL_CTX_set_min_proto_version(static_cast<SSL_CTX *>(ctx),
  16963. static_cast<uint16_t>(version)) == 1;
  16964. }
  16965. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  16966. if (!ctx || !pem || len == 0) return false;
  16967. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16968. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16969. if (!store) return false;
  16970. auto bio = BIO_new_mem_buf(pem, static_cast<int>(len));
  16971. if (!bio) return false;
  16972. bool ok = true;
  16973. X509 *cert = nullptr;
  16974. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16975. nullptr) {
  16976. if (X509_STORE_add_cert(store, cert) != 1) {
  16977. // Ignore duplicate errors
  16978. auto err = ERR_peek_last_error();
  16979. if (ERR_GET_REASON(err) != X509_R_CERT_ALREADY_IN_HASH_TABLE) {
  16980. ok = false;
  16981. }
  16982. }
  16983. X509_free(cert);
  16984. if (!ok) break;
  16985. }
  16986. BIO_free(bio);
  16987. // Clear any "no more certificates" errors
  16988. ERR_clear_error();
  16989. return ok;
  16990. }
  16991. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  16992. if (!ctx || !file_path) return false;
  16993. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), file_path,
  16994. nullptr) == 1;
  16995. }
  16996. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  16997. if (!ctx || !dir_path) return false;
  16998. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), nullptr,
  16999. dir_path) == 1;
  17000. }
  17001. inline bool load_system_certs(ctx_t ctx) {
  17002. if (!ctx) return false;
  17003. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17004. #ifdef _WIN32
  17005. // Windows: Load from system certificate store (ROOT and CA)
  17006. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17007. if (!store) return false;
  17008. bool loaded_any = false;
  17009. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  17010. for (auto store_name : store_names) {
  17011. auto hStore = CertOpenSystemStoreW(NULL, store_name);
  17012. if (!hStore) continue;
  17013. PCCERT_CONTEXT pContext = nullptr;
  17014. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  17015. nullptr) {
  17016. const unsigned char *data = pContext->pbCertEncoded;
  17017. auto x509 = d2i_X509(nullptr, &data, pContext->cbCertEncoded);
  17018. if (x509) {
  17019. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  17020. X509_free(x509);
  17021. }
  17022. }
  17023. CertCloseStore(hStore, 0);
  17024. }
  17025. return loaded_any;
  17026. #elif defined(__APPLE__)
  17027. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  17028. // macOS: Load from Keychain
  17029. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17030. if (!store) return false;
  17031. bool loaded_any = false;
  17032. const SecTrustSettingsDomain domains[] = {
  17033. kSecTrustSettingsDomainSystem,
  17034. kSecTrustSettingsDomainAdmin,
  17035. kSecTrustSettingsDomainUser,
  17036. };
  17037. for (auto domain : domains) {
  17038. CFArrayRef certs = nullptr;
  17039. if (SecTrustSettingsCopyCertificates(domain, &certs) != errSecSuccess ||
  17040. !certs) {
  17041. if (certs) CFRelease(certs);
  17042. continue;
  17043. }
  17044. auto count = CFArrayGetCount(certs);
  17045. for (CFIndex i = 0; i < count; i++) {
  17046. auto cert = reinterpret_cast<SecCertificateRef>(
  17047. const_cast<void *>(CFArrayGetValueAtIndex(certs, i)));
  17048. CFDataRef der = SecCertificateCopyData(cert);
  17049. if (der) {
  17050. const unsigned char *data = CFDataGetBytePtr(der);
  17051. auto x509 = d2i_X509(nullptr, &data, CFDataGetLength(der));
  17052. if (x509) {
  17053. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  17054. X509_free(x509);
  17055. }
  17056. CFRelease(der);
  17057. }
  17058. }
  17059. CFRelease(certs);
  17060. }
  17061. return loaded_any || SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17062. #else
  17063. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17064. #endif
  17065. #else
  17066. // Other Unix: use default verify paths
  17067. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17068. #endif
  17069. }
  17070. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17071. const char *password) {
  17072. if (!ctx || !cert || !key) return false;
  17073. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17074. // Load certificate
  17075. auto cert_bio = BIO_new_mem_buf(cert, -1);
  17076. if (!cert_bio) return false;
  17077. auto x509 = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  17078. BIO_free(cert_bio);
  17079. if (!x509) return false;
  17080. auto cert_ok = SSL_CTX_use_certificate(ssl_ctx, x509) == 1;
  17081. X509_free(x509);
  17082. if (!cert_ok) return false;
  17083. // Load private key
  17084. auto key_bio = BIO_new_mem_buf(key, -1);
  17085. if (!key_bio) return false;
  17086. auto pkey = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  17087. password ? const_cast<char *>(password)
  17088. : nullptr);
  17089. BIO_free(key_bio);
  17090. if (!pkey) return false;
  17091. auto key_ok = SSL_CTX_use_PrivateKey(ssl_ctx, pkey) == 1;
  17092. EVP_PKEY_free(pkey);
  17093. return key_ok && SSL_CTX_check_private_key(ssl_ctx) == 1;
  17094. }
  17095. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  17096. const char *key_path, const char *password) {
  17097. if (!ctx || !cert_path || !key_path) return false;
  17098. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17099. if (password && password[0] != '\0') {
  17100. SSL_CTX_set_default_passwd_cb_userdata(
  17101. ssl_ctx, reinterpret_cast<void *>(const_cast<char *>(password)));
  17102. }
  17103. return SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_path) == 1 &&
  17104. SSL_CTX_use_PrivateKey_file(ssl_ctx, key_path, SSL_FILETYPE_PEM) == 1;
  17105. }
  17106. inline ctx_t create_server_context() {
  17107. SSL_CTX *ctx = SSL_CTX_new(TLS_server_method());
  17108. if (ctx) {
  17109. // No renegotiation, as on the other backends: it would run a handshake
  17110. // that SSLServer::update_certs_pem() does not wait for
  17111. SSL_CTX_set_options(ctx, SSL_OP_NO_COMPRESSION |
  17112. SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION |
  17113. SSL_OP_NO_RENEGOTIATION);
  17114. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  17115. // Without one, a client resuming its session is sent a fatal alert once
  17116. // client certificates are verified.
  17117. static const unsigned char sid_ctx[] = "cpp-httplib";
  17118. SSL_CTX_set_session_id_context(ctx, sid_ctx, sizeof(sid_ctx) - 1);
  17119. }
  17120. return static_cast<ctx_t>(ctx);
  17121. }
  17122. inline void set_verify_client(ctx_t ctx, bool require) {
  17123. if (!ctx) return;
  17124. impl::apply_verify_mode(static_cast<SSL_CTX *>(ctx), require);
  17125. }
  17126. inline session_t create_session(ctx_t ctx, socket_t sock) {
  17127. if (!ctx || sock == INVALID_SOCKET) return nullptr;
  17128. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17129. SSL *ssl = SSL_new(ssl_ctx);
  17130. if (!ssl) return nullptr;
  17131. // Disable auto-retry for proper non-blocking I/O handling
  17132. SSL_clear_mode(ssl, SSL_MODE_AUTO_RETRY);
  17133. auto bio = BIO_new_socket(static_cast<int>(sock), BIO_NOCLOSE);
  17134. if (!bio) {
  17135. SSL_free(ssl);
  17136. return nullptr;
  17137. }
  17138. SSL_set_bio(ssl, bio, bio);
  17139. return static_cast<session_t>(ssl);
  17140. }
  17141. inline void free_session(session_t session) {
  17142. if (session) { SSL_free(static_cast<SSL *>(session)); }
  17143. }
  17144. inline bool set_sni(session_t session, const char *hostname,
  17145. bool /*verify_hostname*/) {
  17146. if (!session || !hostname) return false;
  17147. auto ssl = static_cast<SSL *>(session);
  17148. // Set SNI (Server Name Indication) only - does not enable verification.
  17149. // OpenSSL never binds identity checking to SNI (that happens post-
  17150. // handshake in setup_client_tls_session()), so verify_hostname is unused.
  17151. #if defined(OPENSSL_IS_BORINGSSL)
  17152. return SSL_set_tlsext_host_name(ssl, hostname) == 1;
  17153. #else
  17154. // Direct call instead of macro to suppress -Wold-style-cast warning
  17155. return SSL_ctrl(ssl, SSL_CTRL_SET_TLSEXT_HOSTNAME, TLSEXT_NAMETYPE_host_name,
  17156. static_cast<void *>(const_cast<char *>(hostname))) == 1;
  17157. #endif
  17158. }
  17159. inline TlsError connect(session_t session) {
  17160. if (!session) { return TlsError(); }
  17161. auto ssl = static_cast<SSL *>(session);
  17162. auto ret = SSL_connect(ssl);
  17163. TlsError err;
  17164. if (ret == 1) {
  17165. err.code = ErrorCode::Success;
  17166. } else {
  17167. auto ssl_err = SSL_get_error(ssl, ret);
  17168. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17169. err.backend_code = ERR_get_error();
  17170. }
  17171. return err;
  17172. }
  17173. inline TlsError accept(session_t session) {
  17174. if (!session) { return TlsError(); }
  17175. auto ssl = static_cast<SSL *>(session);
  17176. auto ret = SSL_accept(ssl);
  17177. TlsError err;
  17178. if (ret == 1) {
  17179. err.code = ErrorCode::Success;
  17180. } else {
  17181. auto ssl_err = SSL_get_error(ssl, ret);
  17182. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17183. err.backend_code = ERR_get_error();
  17184. }
  17185. return err;
  17186. }
  17187. inline bool connect_nonblocking(session_t session, socket_t sock,
  17188. time_t timeout_sec, time_t timeout_usec,
  17189. TlsError *err) {
  17190. if (!session) {
  17191. if (err) { err->code = ErrorCode::Fatal; }
  17192. return false;
  17193. }
  17194. auto ssl = static_cast<SSL *>(session);
  17195. auto bio = SSL_get_rbio(ssl);
  17196. // Set non-blocking mode for handshake
  17197. detail::set_nonblocking(sock, true);
  17198. if (bio) { BIO_set_nbio(bio, 1); }
  17199. auto cleanup = detail::scope_exit([&]() {
  17200. // Restore blocking mode after handshake
  17201. if (bio) { BIO_set_nbio(bio, 0); }
  17202. detail::set_nonblocking(sock, false);
  17203. });
  17204. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  17205. auto res = 0;
  17206. while ((res = SSL_connect(ssl)) != 1) {
  17207. auto ssl_err = SSL_get_error(ssl, res);
  17208. switch (ssl_err) {
  17209. case SSL_ERROR_WANT_READ:
  17210. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  17211. break;
  17212. case SSL_ERROR_WANT_WRITE:
  17213. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  17214. break;
  17215. default: break;
  17216. }
  17217. if (err) {
  17218. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  17219. err->backend_code = ERR_get_error();
  17220. }
  17221. return false;
  17222. }
  17223. if (err) { err->code = ErrorCode::Success; }
  17224. return true;
  17225. }
  17226. inline bool accept_nonblocking(session_t session, socket_t sock,
  17227. time_t timeout_sec, time_t timeout_usec,
  17228. TlsError *err) {
  17229. if (!session) {
  17230. if (err) { err->code = ErrorCode::Fatal; }
  17231. return false;
  17232. }
  17233. auto ssl = static_cast<SSL *>(session);
  17234. auto bio = SSL_get_rbio(ssl);
  17235. // Set non-blocking mode for handshake
  17236. detail::set_nonblocking(sock, true);
  17237. if (bio) { BIO_set_nbio(bio, 1); }
  17238. auto cleanup = detail::scope_exit([&]() {
  17239. // Restore blocking mode after handshake
  17240. if (bio) { BIO_set_nbio(bio, 0); }
  17241. detail::set_nonblocking(sock, false);
  17242. });
  17243. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  17244. auto res = 0;
  17245. while ((res = SSL_accept(ssl)) != 1) {
  17246. auto ssl_err = SSL_get_error(ssl, res);
  17247. switch (ssl_err) {
  17248. case SSL_ERROR_WANT_READ:
  17249. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  17250. break;
  17251. case SSL_ERROR_WANT_WRITE:
  17252. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  17253. break;
  17254. default: break;
  17255. }
  17256. if (err) {
  17257. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  17258. err->backend_code = ERR_get_error();
  17259. }
  17260. return false;
  17261. }
  17262. if (err) { err->code = ErrorCode::Success; }
  17263. return true;
  17264. }
  17265. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  17266. if (!session || !buf) {
  17267. err.code = ErrorCode::Fatal;
  17268. return -1;
  17269. }
  17270. auto ssl = static_cast<SSL *>(session);
  17271. constexpr auto max_len =
  17272. static_cast<size_t>((std::numeric_limits<int>::max)());
  17273. if (len > max_len) { len = max_len; }
  17274. auto ret = SSL_read(ssl, buf, static_cast<int>(len));
  17275. if (ret > 0) {
  17276. err.code = ErrorCode::Success;
  17277. return ret;
  17278. }
  17279. auto ssl_err = SSL_get_error(ssl, ret);
  17280. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17281. if (err.code == ErrorCode::PeerClosed) {
  17282. return 0;
  17283. } // Gracefully handle the peer closed state.
  17284. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  17285. return -1;
  17286. }
  17287. inline ssize_t write(session_t session, const void *buf, size_t len,
  17288. TlsError &err) {
  17289. if (!session || !buf) {
  17290. err.code = ErrorCode::Fatal;
  17291. return -1;
  17292. }
  17293. auto ssl = static_cast<SSL *>(session);
  17294. auto ret = SSL_write(ssl, buf, static_cast<int>(len));
  17295. if (ret > 0) {
  17296. err.code = ErrorCode::Success;
  17297. return ret;
  17298. }
  17299. auto ssl_err = SSL_get_error(ssl, ret);
  17300. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17301. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  17302. return -1;
  17303. }
  17304. inline int pending(const_session_t session) {
  17305. if (!session) return 0;
  17306. return SSL_pending(static_cast<SSL *>(const_cast<void *>(session)));
  17307. }
  17308. inline void shutdown(session_t session, bool graceful) {
  17309. if (!session) return;
  17310. auto ssl = static_cast<SSL *>(session);
  17311. if (graceful) {
  17312. // Send close_notify without waiting for the peer's. The connection is
  17313. // closed right after this, so a unidirectional shutdown is enough, and an
  17314. // idle peer that never answers would otherwise hold this thread until the
  17315. // read timeout. The other backends do not wait either.
  17316. SSL_shutdown(ssl);
  17317. }
  17318. }
  17319. inline bool is_peer_closed(session_t session, socket_t sock) {
  17320. if (!session) return true;
  17321. // Temporarily set socket to non-blocking to avoid blocking on SSL_peek
  17322. detail::set_nonblocking(sock, true);
  17323. auto se = detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17324. auto ssl = static_cast<SSL *>(session);
  17325. char buf;
  17326. auto ret = SSL_peek(ssl, &buf, 1);
  17327. if (ret > 0) return false;
  17328. auto err = SSL_get_error(ssl, ret);
  17329. return err == SSL_ERROR_ZERO_RETURN;
  17330. }
  17331. inline cert_t get_peer_cert(const_session_t session) {
  17332. if (!session) return nullptr;
  17333. return static_cast<cert_t>(SSL_get1_peer_certificate(
  17334. static_cast<SSL *>(const_cast<void *>(session))));
  17335. }
  17336. inline size_t get_peer_certs(const_session_t session,
  17337. std::vector<cert_t> &certs) {
  17338. certs.clear();
  17339. if (!session) { return 0; }
  17340. auto ssl = static_cast<const SSL *>(session);
  17341. // On the server side, the chain leaves out the peer's own certificate
  17342. if (SSL_is_server(ssl)) {
  17343. if (auto leaf = get_peer_cert(session)) { certs.push_back(leaf); }
  17344. }
  17345. if (auto sk = SSL_get_peer_cert_chain(ssl)) {
  17346. auto count = sk_X509_num(sk);
  17347. for (decltype(count) i = 0; i < count; i++) {
  17348. auto x509 = sk_X509_value(sk, i);
  17349. X509_up_ref(x509);
  17350. certs.push_back(static_cast<cert_t>(x509));
  17351. }
  17352. }
  17353. return certs.size();
  17354. }
  17355. inline void free_cert(cert_t cert) {
  17356. if (cert) { X509_free(static_cast<X509 *>(cert)); }
  17357. }
  17358. inline bool verify_hostname(cert_t cert, const char *hostname) {
  17359. if (!cert || !hostname) return false;
  17360. auto x509 = static_cast<X509 *>(cert);
  17361. // Use X509_check_ip_asc for IP addresses, X509_check_host for DNS names
  17362. if (detail::is_ip_address(hostname)) {
  17363. return X509_check_ip_asc(x509, hostname, 0) == 1;
  17364. }
  17365. return X509_check_host(x509, hostname, strlen(hostname), 0, nullptr) == 1;
  17366. }
  17367. inline uint64_t hostname_mismatch_code() {
  17368. return static_cast<uint64_t>(X509_V_ERR_HOSTNAME_MISMATCH);
  17369. }
  17370. inline long get_verify_result(const_session_t session) {
  17371. if (!session) return X509_V_ERR_UNSPECIFIED;
  17372. return SSL_get_verify_result(static_cast<SSL *>(const_cast<void *>(session)));
  17373. }
  17374. inline std::string get_cert_subject_cn(cert_t cert) {
  17375. if (!cert) return "";
  17376. auto x509 = static_cast<X509 *>(cert);
  17377. auto subject_name = X509_get_subject_name(x509);
  17378. if (!subject_name) return "";
  17379. // X509_NAME_get_text_by_NID is deprecated since OpenSSL 4.0
  17380. auto idx = X509_NAME_get_index_by_NID(subject_name, NID_commonName, -1);
  17381. if (idx < 0) return "";
  17382. auto entry = X509_NAME_get_entry(subject_name, idx);
  17383. if (!entry) return "";
  17384. auto data = X509_NAME_ENTRY_get_data(entry);
  17385. if (!data) return "";
  17386. return std::string(
  17387. reinterpret_cast<const char *>(ASN1_STRING_get0_data(data)),
  17388. static_cast<size_t>(ASN1_STRING_length(data)));
  17389. }
  17390. inline std::string get_cert_issuer_name(cert_t cert) {
  17391. if (!cert) return "";
  17392. auto x509 = static_cast<X509 *>(cert);
  17393. auto issuer_name = X509_get_issuer_name(x509);
  17394. if (!issuer_name) return "";
  17395. char buf[256];
  17396. X509_NAME_oneline(issuer_name, buf, sizeof(buf));
  17397. return std::string(buf);
  17398. }
  17399. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  17400. sans.clear();
  17401. if (!cert) return false;
  17402. auto x509 = static_cast<X509 *>(cert);
  17403. auto names = static_cast<GENERAL_NAMES *>(
  17404. X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  17405. if (!names) return true; // No SANs is valid
  17406. auto count = sk_GENERAL_NAME_num(names);
  17407. for (decltype(count) i = 0; i < count; i++) {
  17408. auto gen = sk_GENERAL_NAME_value(names, i);
  17409. if (!gen) continue;
  17410. SanEntry entry;
  17411. switch (gen->type) {
  17412. case GEN_DNS:
  17413. entry.type = SanType::DNS;
  17414. if (gen->d.dNSName) {
  17415. entry.value = std::string(
  17416. reinterpret_cast<const char *>(
  17417. ASN1_STRING_get0_data(gen->d.dNSName)),
  17418. static_cast<size_t>(ASN1_STRING_length(gen->d.dNSName)));
  17419. }
  17420. break;
  17421. case GEN_IPADD:
  17422. entry.type = SanType::IP;
  17423. if (gen->d.iPAddress) {
  17424. auto data = ASN1_STRING_get0_data(gen->d.iPAddress);
  17425. auto len = ASN1_STRING_length(gen->d.iPAddress);
  17426. if (len == 4) {
  17427. // IPv4
  17428. char buf[INET_ADDRSTRLEN];
  17429. inet_ntop(AF_INET, data, buf, sizeof(buf));
  17430. entry.value = buf;
  17431. } else if (len == 16) {
  17432. // IPv6
  17433. char buf[INET6_ADDRSTRLEN];
  17434. inet_ntop(AF_INET6, data, buf, sizeof(buf));
  17435. entry.value = buf;
  17436. }
  17437. }
  17438. break;
  17439. case GEN_EMAIL:
  17440. entry.type = SanType::EMAIL;
  17441. if (gen->d.rfc822Name) {
  17442. entry.value = std::string(
  17443. reinterpret_cast<const char *>(
  17444. ASN1_STRING_get0_data(gen->d.rfc822Name)),
  17445. static_cast<size_t>(ASN1_STRING_length(gen->d.rfc822Name)));
  17446. }
  17447. break;
  17448. case GEN_URI:
  17449. entry.type = SanType::URI;
  17450. if (gen->d.uniformResourceIdentifier) {
  17451. entry.value = std::string(
  17452. reinterpret_cast<const char *>(
  17453. ASN1_STRING_get0_data(gen->d.uniformResourceIdentifier)),
  17454. static_cast<size_t>(
  17455. ASN1_STRING_length(gen->d.uniformResourceIdentifier)));
  17456. }
  17457. break;
  17458. default: entry.type = SanType::OTHER; break;
  17459. }
  17460. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  17461. }
  17462. GENERAL_NAMES_free(names);
  17463. return true;
  17464. }
  17465. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  17466. time_t &not_after) {
  17467. if (!cert) return false;
  17468. auto x509 = static_cast<X509 *>(cert);
  17469. auto nb = X509_get0_notBefore(x509);
  17470. auto na = X509_get0_notAfter(x509);
  17471. if (!nb || !na) return false;
  17472. ASN1_TIME *epoch = ASN1_TIME_new();
  17473. if (!epoch) return false;
  17474. auto se = detail::scope_exit([&] { ASN1_TIME_free(epoch); });
  17475. if (!ASN1_TIME_set(epoch, 0)) return false;
  17476. int pday, psec;
  17477. if (!ASN1_TIME_diff(&pday, &psec, epoch, nb)) return false;
  17478. not_before = 86400 * (time_t)pday + psec;
  17479. if (!ASN1_TIME_diff(&pday, &psec, epoch, na)) return false;
  17480. not_after = 86400 * (time_t)pday + psec;
  17481. return true;
  17482. }
  17483. inline std::string get_cert_serial(cert_t cert) {
  17484. if (!cert) return "";
  17485. auto x509 = static_cast<X509 *>(cert);
  17486. auto serial = X509_get_serialNumber(x509);
  17487. if (!serial) return "";
  17488. auto bn = ASN1_INTEGER_to_BN(serial, nullptr);
  17489. if (!bn) return "";
  17490. auto hex = BN_bn2hex(bn);
  17491. BN_free(bn);
  17492. if (!hex) return "";
  17493. std::string result(hex);
  17494. OPENSSL_free(hex);
  17495. return result;
  17496. }
  17497. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  17498. if (!cert) return false;
  17499. auto x509 = static_cast<X509 *>(cert);
  17500. auto len = i2d_X509(x509, nullptr);
  17501. if (len < 0) return false;
  17502. der.resize(static_cast<size_t>(len));
  17503. auto p = der.data();
  17504. i2d_X509(x509, &p);
  17505. return true;
  17506. }
  17507. inline const char *get_sni(const_session_t session) {
  17508. if (!session) return nullptr;
  17509. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17510. return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
  17511. }
  17512. inline uint64_t peek_error() { return ERR_peek_last_error(); }
  17513. inline uint64_t get_error() { return ERR_get_error(); }
  17514. inline std::string error_string(uint64_t code) {
  17515. char buf[256];
  17516. ERR_error_string_n(static_cast<decltype(ERR_get_error())>(code), buf,
  17517. sizeof(buf));
  17518. return std::string(buf);
  17519. }
  17520. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  17521. auto mem = BIO_new_mem_buf(pem, static_cast<int>(len));
  17522. if (!mem) { return nullptr; }
  17523. auto mem_guard = detail::scope_exit([&] { BIO_free_all(mem); });
  17524. auto inf = PEM_X509_INFO_read_bio(mem, nullptr, nullptr, nullptr);
  17525. if (!inf) { return nullptr; }
  17526. auto store = X509_STORE_new();
  17527. if (store) {
  17528. auto count = sk_X509_INFO_num(inf);
  17529. for (decltype(count) i = 0; i < count; i++) {
  17530. auto itmp = sk_X509_INFO_value(inf, i);
  17531. if (!itmp) { continue; }
  17532. if (itmp->x509) { X509_STORE_add_cert(store, itmp->x509); }
  17533. if (itmp->crl) { X509_STORE_add_crl(store, itmp->crl); }
  17534. }
  17535. }
  17536. sk_X509_INFO_pop_free(inf, X509_INFO_free);
  17537. return static_cast<ca_store_t>(store);
  17538. }
  17539. inline void free_ca_store(ca_store_t store) {
  17540. if (store) { X509_STORE_free(static_cast<X509_STORE *>(store)); }
  17541. }
  17542. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  17543. if (!ctx || !store) { return false; }
  17544. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17545. auto x509_store = static_cast<X509_STORE *>(store);
  17546. // Check if same store is already set
  17547. if (SSL_CTX_get_cert_store(ssl_ctx) == x509_store) { return true; }
  17548. // SSL_CTX_set_cert_store takes ownership and frees the old store
  17549. SSL_CTX_set_cert_store(ssl_ctx, x509_store);
  17550. return true;
  17551. }
  17552. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  17553. certs.clear();
  17554. if (!ctx) { return 0; }
  17555. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17556. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17557. if (!store) { return 0; }
  17558. auto objs = impl::get_store_objects(store);
  17559. if (!objs) { return 0; }
  17560. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  17561. auto count = sk_X509_OBJECT_num(objs);
  17562. for (decltype(count) i = 0; i < count; i++) {
  17563. auto obj = sk_X509_OBJECT_value(objs, i);
  17564. if (!obj) { continue; }
  17565. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  17566. auto x509 = X509_OBJECT_get0_X509(obj);
  17567. if (x509) {
  17568. // Increment reference count so caller can free it
  17569. X509_up_ref(x509);
  17570. certs.push_back(static_cast<cert_t>(x509));
  17571. }
  17572. }
  17573. }
  17574. return certs.size();
  17575. }
  17576. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  17577. std::vector<std::string> names;
  17578. if (!ctx) { return names; }
  17579. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17580. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17581. if (!store) { return names; }
  17582. auto objs = impl::get_store_objects(store);
  17583. if (!objs) { return names; }
  17584. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  17585. auto count = sk_X509_OBJECT_num(objs);
  17586. for (decltype(count) i = 0; i < count; i++) {
  17587. auto obj = sk_X509_OBJECT_value(objs, i);
  17588. if (!obj) { continue; }
  17589. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  17590. auto x509 = X509_OBJECT_get0_X509(obj);
  17591. if (x509) {
  17592. auto subject = X509_get_subject_name(x509);
  17593. if (subject) {
  17594. char buf[512];
  17595. X509_NAME_oneline(subject, buf, sizeof(buf));
  17596. names.push_back(buf);
  17597. }
  17598. }
  17599. }
  17600. }
  17601. return names;
  17602. }
  17603. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  17604. const char *key_pem, const char *password) {
  17605. if (!ctx || !cert_pem || !key_pem) { return false; }
  17606. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17607. // Load certificate from PEM
  17608. auto cert_bio = BIO_new_mem_buf(cert_pem, -1);
  17609. if (!cert_bio) { return false; }
  17610. auto cert = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  17611. BIO_free(cert_bio);
  17612. if (!cert) { return false; }
  17613. // Load private key from PEM
  17614. auto key_bio = BIO_new_mem_buf(key_pem, -1);
  17615. if (!key_bio) {
  17616. X509_free(cert);
  17617. return false;
  17618. }
  17619. auto key = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  17620. password ? const_cast<char *>(password)
  17621. : nullptr);
  17622. BIO_free(key_bio);
  17623. if (!key) {
  17624. X509_free(cert);
  17625. return false;
  17626. }
  17627. // Update certificate and key
  17628. auto ret = SSL_CTX_use_certificate(ssl_ctx, cert) == 1 &&
  17629. SSL_CTX_use_PrivateKey(ssl_ctx, key) == 1;
  17630. X509_free(cert);
  17631. EVP_PKEY_free(key);
  17632. return ret;
  17633. }
  17634. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  17635. if (!ctx || !ca_pem) { return false; }
  17636. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17637. // Create new X509_STORE from PEM
  17638. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  17639. if (!store) { return false; }
  17640. // A resumed session is not verified again, so the ticket keys from before
  17641. // go, or a client verified under the old CAs could go on resuming.
  17642. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  17643. unsigned char ticket_keys[48];
  17644. #else
  17645. unsigned char ticket_keys[80];
  17646. #endif
  17647. if (RAND_bytes(ticket_keys, sizeof(ticket_keys)) != 1 ||
  17648. SSL_CTX_set_tlsext_ticket_keys(ssl_ctx, ticket_keys,
  17649. sizeof(ticket_keys)) != 1) {
  17650. free_ca_store(store);
  17651. return false;
  17652. }
  17653. // SSL_CTX_set_cert_store takes ownership
  17654. SSL_CTX_set_cert_store(ssl_ctx, static_cast<X509_STORE *>(store));
  17655. // Set client CA list for client certificate request
  17656. auto ca_list = impl::create_client_ca_list_from_pem(ca_pem);
  17657. if (ca_list) {
  17658. // SSL_CTX_set_client_CA_list takes ownership of ca_list
  17659. SSL_CTX_set_client_CA_list(ssl_ctx, ca_list);
  17660. }
  17661. // The cached sessions go for the same reason.
  17662. #if OPENSSL_VERSION_NUMBER >= 0x30400000L
  17663. SSL_CTX_flush_sessions_ex(ssl_ctx, (std::numeric_limits<time_t>::max)());
  17664. #else
  17665. SSL_CTX_flush_sessions(ssl_ctx, (std::numeric_limits<long>::max)());
  17666. #endif
  17667. return true;
  17668. }
  17669. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  17670. if (!ctx) { return false; }
  17671. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17672. auto index = impl::verify_callback_index();
  17673. if (index < 0) { return false; }
  17674. std::shared_ptr<VerifyCallback> *stored = nullptr;
  17675. if (callback) {
  17676. stored = new std::shared_ptr<VerifyCallback>(
  17677. std::make_shared<VerifyCallback>(std::move(callback)));
  17678. }
  17679. std::shared_ptr<VerifyCallback> *previous = nullptr;
  17680. {
  17681. std::lock_guard<std::mutex> guard(impl::verify_callback_mutex());
  17682. previous = static_cast<std::shared_ptr<VerifyCallback> *>(
  17683. SSL_CTX_get_ex_data(ssl_ctx, index));
  17684. if (SSL_CTX_set_ex_data(ssl_ctx, index, stored) != 1) {
  17685. delete stored;
  17686. return false;
  17687. }
  17688. }
  17689. // A handshake running the previous callback keeps it until it returns.
  17690. delete previous;
  17691. // A resumed handshake shows no certificate to run the callback on.
  17692. if (stored) {
  17693. SSL_CTX_set_options(ssl_ctx, SSL_OP_NO_TICKET);
  17694. SSL_CTX_set_session_cache_mode(ssl_ctx, SSL_SESS_CACHE_OFF);
  17695. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER)
  17696. // TLS 1.3 tickets, which SSL_OP_NO_TICKET leaves on
  17697. SSL_CTX_set_num_tickets(ssl_ctx, 0);
  17698. #endif
  17699. }
  17700. // Keep requiring the peer's certificate if set_verify_client() asked for it
  17701. auto require =
  17702. (SSL_CTX_get_verify_mode(ssl_ctx) & SSL_VERIFY_FAIL_IF_NO_PEER_CERT) != 0;
  17703. impl::apply_verify_mode(ssl_ctx, require);
  17704. return true;
  17705. }
  17706. inline long get_verify_error(const_session_t session) {
  17707. if (!session) { return -1; }
  17708. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17709. return SSL_get_verify_result(ssl);
  17710. }
  17711. inline std::string verify_error_string(long error_code) {
  17712. if (error_code == X509_V_OK) { return ""; }
  17713. const char *str = X509_verify_cert_error_string(static_cast<int>(error_code));
  17714. return str ? str : "unknown error";
  17715. }
  17716. } // namespace tls
  17717. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  17718. /*
  17719. * Group 9: TLS abstraction layer - Mbed TLS backend
  17720. */
  17721. /*
  17722. * Mbed TLS Backend Implementation
  17723. */
  17724. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  17725. namespace tls {
  17726. namespace impl {
  17727. // Mbed TLS session wrapper
  17728. struct MbedTlsSession {
  17729. mbedtls_ssl_context ssl;
  17730. socket_t sock = INVALID_SOCKET;
  17731. std::string hostname; // For client: set via set_sni
  17732. std::string sni_hostname; // For server: received from client via SNI callback
  17733. // Mbed TLS has no SSL_peek() equivalent, so is_peer_closed() must probe with
  17734. // a real 1-byte mbedtls_ssl_read(). If that probe lands on application data
  17735. // (e.g. a response that arrived while this side was still in its post-write
  17736. // check), the byte is pushed back here and served by the next read().
  17737. unsigned char peeked_byte = 0;
  17738. bool has_peeked_byte = false;
  17739. // Set by set_sni() when the caller disabled hostname verification, so the
  17740. // verify callback can clear the CN/SAN mismatch flag while still enforcing
  17741. // the rest of the chain (Mbed TLS ties SNI and identity checking together;
  17742. // OpenSSL and wolfSSL keep them independent).
  17743. bool suppress_hostname_mismatch = false;
  17744. // Copied from the owning MbedTlsContext at creation, so a handshake only
  17745. // ever runs the callback of its own context.
  17746. VerifyCallback verify_callback;
  17747. bool is_server = false;
  17748. MbedTlsSession() { mbedtls_ssl_init(&ssl); }
  17749. ~MbedTlsSession() { mbedtls_ssl_free(&ssl); }
  17750. MbedTlsSession(const MbedTlsSession &) = delete;
  17751. MbedTlsSession &operator=(const MbedTlsSession &) = delete;
  17752. };
  17753. // Thread-local error code accessor for Mbed TLS (since it doesn't have an error
  17754. // queue)
  17755. inline int &mbedtls_last_error() {
  17756. static thread_local int err = 0;
  17757. return err;
  17758. }
  17759. // Helper to map Mbed TLS error to ErrorCode
  17760. inline ErrorCode map_mbedtls_error(int ret, int &out_errno,
  17761. uint32_t verify_flags) {
  17762. if (ret == 0) { return ErrorCode::Success; }
  17763. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return ErrorCode::WantRead; }
  17764. if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) { return ErrorCode::WantWrite; }
  17765. if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
  17766. return ErrorCode::PeerClosed;
  17767. }
  17768. if (ret == MBEDTLS_ERR_NET_CONN_RESET || ret == MBEDTLS_ERR_NET_SEND_FAILED ||
  17769. ret == MBEDTLS_ERR_NET_RECV_FAILED) {
  17770. out_errno = errno;
  17771. return ErrorCode::SyscallError;
  17772. }
  17773. if (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED) {
  17774. // Unlike OpenSSL/wolfSSL, Mbed TLS folds the CN/SAN identity check into
  17775. // the handshake's chain verification (see set_sni()); a mismatch there
  17776. // is reported the same way as any other verify_flags bit. Report it as
  17777. // HostnameMismatch, matching the other backends and the post-handshake
  17778. // identity check below, but only when naming is the sole problem -
  17779. // if the chain itself is also untrusted/expired/etc., that takes
  17780. // priority over the naming detail.
  17781. if (verify_flags == static_cast<uint32_t>(hostname_mismatch_code())) {
  17782. return ErrorCode::HostnameMismatch;
  17783. }
  17784. return ErrorCode::CertVerifyFailed;
  17785. }
  17786. return ErrorCode::Fatal;
  17787. }
  17788. // Populates a TlsError from a failed (non-zero) mbedtls_ssl_handshake()
  17789. // return value, including the verify-flags-dependent HostnameMismatch
  17790. // mapping; shared by connect() and connect_nonblocking() so the
  17791. // backend_code policy for that mapping only lives in one place.
  17792. inline void fill_mbedtls_tls_error(TlsError &err, mbedtls_ssl_context &ssl,
  17793. int ret) {
  17794. auto verify_flags = mbedtls_ssl_get_verify_result(&ssl);
  17795. err.code = map_mbedtls_error(ret, err.sys_errno, verify_flags);
  17796. err.backend_code = err.code == ErrorCode::HostnameMismatch
  17797. ? static_cast<uint64_t>(verify_flags)
  17798. : static_cast<uint64_t>(-ret);
  17799. }
  17800. // A TLS 1.3 NewSessionTicket (signaled by default on Mbed TLS 4.x) is a
  17801. // non-fatal notification delivered between records, not an error and not
  17802. // application data, so I/O calls that see it should just be retried. Kept in
  17803. // one helper so the retry loops keep an intact "do { } while (...)" instead of
  17804. // splitting the closing brace across an #if.
  17805. inline bool mbedtls_is_session_ticket(int ret) {
  17806. #if defined(MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET)
  17807. return ret == MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
  17808. #else
  17809. (void)ret;
  17810. return false;
  17811. #endif
  17812. }
  17813. // BIO-like send callback for Mbed TLS
  17814. inline int mbedtls_net_send_cb(void *ctx, const unsigned char *buf,
  17815. size_t len) {
  17816. auto sock = *static_cast<socket_t *>(ctx);
  17817. #ifdef _WIN32
  17818. auto ret =
  17819. send(sock, reinterpret_cast<const char *>(buf), static_cast<int>(len), 0);
  17820. if (ret == SOCKET_ERROR) {
  17821. int err = WSAGetLastError();
  17822. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_WRITE; }
  17823. return MBEDTLS_ERR_NET_SEND_FAILED;
  17824. }
  17825. #else
  17826. auto ret = send(sock, buf, len, 0);
  17827. if (ret < 0) {
  17828. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17829. return MBEDTLS_ERR_SSL_WANT_WRITE;
  17830. }
  17831. return MBEDTLS_ERR_NET_SEND_FAILED;
  17832. }
  17833. #endif
  17834. return static_cast<int>(ret);
  17835. }
  17836. // BIO-like recv callback for Mbed TLS
  17837. inline int mbedtls_net_recv_cb(void *ctx, unsigned char *buf, size_t len) {
  17838. auto sock = *static_cast<socket_t *>(ctx);
  17839. #ifdef _WIN32
  17840. auto ret =
  17841. recv(sock, reinterpret_cast<char *>(buf), static_cast<int>(len), 0);
  17842. if (ret == SOCKET_ERROR) {
  17843. int err = WSAGetLastError();
  17844. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_READ; }
  17845. return MBEDTLS_ERR_NET_RECV_FAILED;
  17846. }
  17847. #else
  17848. auto ret = recv(sock, buf, len, 0);
  17849. if (ret < 0) {
  17850. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17851. return MBEDTLS_ERR_SSL_WANT_READ;
  17852. }
  17853. return MBEDTLS_ERR_NET_RECV_FAILED;
  17854. }
  17855. #endif
  17856. if (ret == 0) { return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY; }
  17857. return static_cast<int>(ret);
  17858. }
  17859. // MbedTlsContext constructor/destructor implementations
  17860. inline MbedTlsContext::MbedTlsContext() {
  17861. mbedtls_ssl_config_init(&conf);
  17862. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17863. mbedtls_entropy_init(&entropy);
  17864. mbedtls_ctr_drbg_init(&ctr_drbg);
  17865. #endif
  17866. mbedtls_x509_crt_init(&ca_chain);
  17867. mbedtls_x509_crt_init(&own_cert);
  17868. mbedtls_pk_init(&own_key);
  17869. }
  17870. inline MbedTlsContext::~MbedTlsContext() {
  17871. mbedtls_pk_free(&own_key);
  17872. mbedtls_x509_crt_free(&own_cert);
  17873. mbedtls_x509_crt_free(&ca_chain);
  17874. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17875. mbedtls_ctr_drbg_free(&ctr_drbg);
  17876. mbedtls_entropy_free(&entropy);
  17877. #endif
  17878. mbedtls_ssl_config_free(&conf);
  17879. }
  17880. // Thread-local storage for SNI captured during handshake
  17881. // This is needed because the SNI callback doesn't have a way to pass
  17882. // session-specific data before the session is fully set up
  17883. inline std::string &mbedpending_sni() {
  17884. static thread_local std::string sni;
  17885. return sni;
  17886. }
  17887. // SNI callback for Mbed TLS server to capture client's SNI hostname
  17888. inline int mbedtls_sni_callback(void *p_ctx, mbedtls_ssl_context *ssl,
  17889. const unsigned char *name, size_t name_len) {
  17890. (void)p_ctx;
  17891. (void)ssl;
  17892. // Store SNI name in thread-local storage
  17893. // It will be retrieved and stored in the session after handshake
  17894. if (name && name_len > 0) {
  17895. mbedpending_sni().assign(reinterpret_cast<const char *>(name), name_len);
  17896. } else {
  17897. mbedpending_sni().clear();
  17898. }
  17899. return 0; // Accept any SNI
  17900. }
  17901. inline void mbedtls_clear_cn_mismatch(uint32_t *flags) {
  17902. *flags &= ~static_cast<uint32_t>(hostname_mismatch_code());
  17903. }
  17904. // MbedTLS verify callback wrapper
  17905. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  17906. int cert_depth, uint32_t *flags) {
  17907. // data points to the MbedTlsSession
  17908. auto *session = static_cast<MbedTlsSession *>(data);
  17909. // set_sni() disabled hostname verification for this session: ignore the
  17910. // CN/SAN mismatch flag, as the OpenSSL/wolfSSL backends do. The final
  17911. // pass/fail decision still comes from the remaining flags (and, below, from
  17912. // the user's own verify callback).
  17913. if (session->suppress_hostname_mismatch) { mbedtls_clear_cn_mismatch(flags); }
  17914. const auto &callback = session->verify_callback;
  17915. if (!callback) { return 0; } // Continue with default verification
  17916. // Build context
  17917. VerifyContext verify_ctx;
  17918. verify_ctx.session = static_cast<session_t>(session);
  17919. verify_ctx.cert = static_cast<cert_t>(crt);
  17920. verify_ctx.depth = cert_depth;
  17921. verify_ctx.preverify_ok = (*flags == 0);
  17922. verify_ctx.error_code = static_cast<long>(*flags);
  17923. // Convert Mbed TLS flags to error string
  17924. static thread_local char error_buf[256];
  17925. if (*flags != 0) {
  17926. mbedtls_x509_crt_verify_info(error_buf, sizeof(error_buf), "", *flags);
  17927. verify_ctx.error_string = error_buf;
  17928. } else {
  17929. verify_ctx.error_string = nullptr;
  17930. }
  17931. bool accepted = run_verify_callback(callback, verify_ctx);
  17932. if (accepted) {
  17933. // Overrides the built-in verification only on a server, as on OpenSSL and
  17934. // wolfSSL, whose clients check the verify result after the handshake
  17935. if (session->is_server) { *flags = 0; }
  17936. return 0;
  17937. }
  17938. return MBEDTLS_ERR_X509_CERT_VERIFY_FAILED;
  17939. }
  17940. // Sets the authentication mode from whether the peer's certificate is required
  17941. // and whether a verify callback is set. OPTIONAL lets the callback run even if
  17942. // verification is not required (matching OpenSSL's SSL_VERIFY_PEER).
  17943. inline void apply_verify_mode(MbedTlsContext &mctx) {
  17944. auto mode = MBEDTLS_SSL_VERIFY_NONE;
  17945. if (mctx.verify_client) {
  17946. mode = MBEDTLS_SSL_VERIFY_REQUIRED;
  17947. } else if (mctx.verify_callback) {
  17948. mode = MBEDTLS_SSL_VERIFY_OPTIONAL;
  17949. }
  17950. mbedtls_ssl_conf_authmode(&mctx.conf, mode);
  17951. }
  17952. } // namespace impl
  17953. inline ctx_t create_client_context() {
  17954. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17955. if (!ctx) { return nullptr; }
  17956. ctx->is_server = false;
  17957. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17958. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17959. if (!detail::ensure_mbedtls_psa_crypto()) {
  17960. delete ctx;
  17961. return nullptr;
  17962. }
  17963. int ret;
  17964. #else
  17965. // Seed the random number generator
  17966. const char *pers = "httplib_client";
  17967. int ret = mbedtls_ctr_drbg_seed(
  17968. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  17969. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  17970. if (ret != 0) {
  17971. impl::mbedtls_last_error() = ret;
  17972. delete ctx;
  17973. return nullptr;
  17974. }
  17975. #endif
  17976. // Set up SSL config for client
  17977. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_CLIENT,
  17978. MBEDTLS_SSL_TRANSPORT_STREAM,
  17979. MBEDTLS_SSL_PRESET_DEFAULT);
  17980. if (ret != 0) {
  17981. impl::mbedtls_last_error() = ret;
  17982. delete ctx;
  17983. return nullptr;
  17984. }
  17985. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17986. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17987. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17988. #endif
  17989. // Default: verify peer certificate
  17990. ctx->verify_client = true;
  17991. impl::apply_verify_mode(*ctx);
  17992. // Set minimum TLS version to 1.2
  17993. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17994. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17995. #else
  17996. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17997. MBEDTLS_SSL_MINOR_VERSION_3);
  17998. #endif
  17999. return static_cast<ctx_t>(ctx);
  18000. }
  18001. inline ctx_t create_server_context() {
  18002. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  18003. if (!ctx) { return nullptr; }
  18004. ctx->is_server = true;
  18005. #ifdef CPPHTTPLIB_MBEDTLS_V4
  18006. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  18007. if (!detail::ensure_mbedtls_psa_crypto()) {
  18008. delete ctx;
  18009. return nullptr;
  18010. }
  18011. int ret;
  18012. #else
  18013. // Seed the random number generator
  18014. const char *pers = "httplib_server";
  18015. int ret = mbedtls_ctr_drbg_seed(
  18016. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  18017. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  18018. if (ret != 0) {
  18019. impl::mbedtls_last_error() = ret;
  18020. delete ctx;
  18021. return nullptr;
  18022. }
  18023. #endif
  18024. // Set up SSL config for server
  18025. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_SERVER,
  18026. MBEDTLS_SSL_TRANSPORT_STREAM,
  18027. MBEDTLS_SSL_PRESET_DEFAULT);
  18028. if (ret != 0) {
  18029. impl::mbedtls_last_error() = ret;
  18030. delete ctx;
  18031. return nullptr;
  18032. }
  18033. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18034. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  18035. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  18036. #endif
  18037. // Default: don't verify client
  18038. impl::apply_verify_mode(*ctx);
  18039. // Set minimum TLS version to 1.2
  18040. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18041. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  18042. #else
  18043. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  18044. MBEDTLS_SSL_MINOR_VERSION_3);
  18045. #endif
  18046. // Set SNI callback to capture client's SNI hostname
  18047. mbedtls_ssl_conf_sni(&ctx->conf, impl::mbedtls_sni_callback, nullptr);
  18048. return static_cast<ctx_t>(ctx);
  18049. }
  18050. inline void free_context(ctx_t ctx) {
  18051. if (ctx) { delete static_cast<impl::MbedTlsContext *>(ctx); }
  18052. }
  18053. inline bool set_min_version(ctx_t ctx, Version version) {
  18054. if (!ctx) { return false; }
  18055. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18056. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18057. // Mbed TLS 3.x uses mbedtls_ssl_protocol_version enum
  18058. mbedtls_ssl_protocol_version min_ver = MBEDTLS_SSL_VERSION_TLS1_2;
  18059. if (version >= Version::TLS1_3) {
  18060. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  18061. min_ver = MBEDTLS_SSL_VERSION_TLS1_3;
  18062. #endif
  18063. }
  18064. mbedtls_ssl_conf_min_tls_version(&mctx->conf, min_ver);
  18065. #else
  18066. // Mbed TLS 2.x uses major/minor version numbers
  18067. int major = MBEDTLS_SSL_MAJOR_VERSION_3;
  18068. int minor = MBEDTLS_SSL_MINOR_VERSION_3; // TLS 1.2
  18069. if (version >= Version::TLS1_3) {
  18070. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  18071. minor = MBEDTLS_SSL_MINOR_VERSION_4; // TLS 1.3
  18072. #else
  18073. minor = MBEDTLS_SSL_MINOR_VERSION_3; // Fall back to TLS 1.2
  18074. #endif
  18075. }
  18076. mbedtls_ssl_conf_min_version(&mctx->conf, major, minor);
  18077. #endif
  18078. return true;
  18079. }
  18080. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  18081. if (!ctx || !pem) { return false; }
  18082. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18083. // mbedtls_x509_crt_parse expects null-terminated string for PEM
  18084. // Add null terminator if not present
  18085. std::string pem_str(pem, len);
  18086. int ret = mbedtls_x509_crt_parse(
  18087. &mctx->ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  18088. pem_str.size() + 1);
  18089. if (ret != 0) {
  18090. impl::mbedtls_last_error() = ret;
  18091. return false;
  18092. }
  18093. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18094. return true;
  18095. }
  18096. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  18097. if (!ctx || !file_path) { return false; }
  18098. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18099. int ret = mbedtls_x509_crt_parse_file(&mctx->ca_chain, file_path);
  18100. if (ret != 0) {
  18101. impl::mbedtls_last_error() = ret;
  18102. return false;
  18103. }
  18104. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18105. return true;
  18106. }
  18107. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  18108. if (!ctx || !dir_path) { return false; }
  18109. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18110. int ret = mbedtls_x509_crt_parse_path(&mctx->ca_chain, dir_path);
  18111. if (ret < 0) { // Returns number of certs on success, negative on error
  18112. impl::mbedtls_last_error() = ret;
  18113. return false;
  18114. }
  18115. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18116. return true;
  18117. }
  18118. inline bool load_system_certs(ctx_t ctx) {
  18119. if (!ctx) { return false; }
  18120. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18121. bool loaded = false;
  18122. #ifdef _WIN32
  18123. loaded = impl::enumerate_windows_system_certs(
  18124. [&](const unsigned char *data, size_t len) {
  18125. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  18126. });
  18127. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  18128. loaded = impl::enumerate_macos_keychain_certs(
  18129. [&](const unsigned char *data, size_t len) {
  18130. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  18131. });
  18132. #else
  18133. for (auto path = impl::system_ca_paths(); *path; ++path) {
  18134. if (mbedtls_x509_crt_parse_file(&mctx->ca_chain, *path) >= 0) {
  18135. loaded = true;
  18136. break;
  18137. }
  18138. }
  18139. if (!loaded) {
  18140. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  18141. if (mbedtls_x509_crt_parse_path(&mctx->ca_chain, *dir) >= 0) {
  18142. loaded = true;
  18143. break;
  18144. }
  18145. }
  18146. }
  18147. #endif
  18148. if (loaded) {
  18149. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18150. }
  18151. return loaded;
  18152. }
  18153. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  18154. const char *password) {
  18155. if (!ctx || !cert || !key) { return false; }
  18156. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18157. // Parse certificate
  18158. std::string cert_str(cert);
  18159. int ret = mbedtls_x509_crt_parse(
  18160. &mctx->own_cert,
  18161. reinterpret_cast<const unsigned char *>(cert_str.c_str()),
  18162. cert_str.size() + 1);
  18163. if (ret != 0) {
  18164. impl::mbedtls_last_error() = ret;
  18165. return false;
  18166. }
  18167. // Parse private key
  18168. std::string key_str(key);
  18169. const unsigned char *pwd =
  18170. password ? reinterpret_cast<const unsigned char *>(password) : nullptr;
  18171. size_t pwd_len = password ? strlen(password) : 0;
  18172. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18173. ret = mbedtls_pk_parse_key(
  18174. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  18175. key_str.size() + 1, pwd, pwd_len, mbedtls_ctr_drbg_random,
  18176. &mctx->ctr_drbg);
  18177. #else
  18178. ret = mbedtls_pk_parse_key(
  18179. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  18180. key_str.size() + 1, pwd, pwd_len);
  18181. #endif
  18182. if (ret != 0) {
  18183. impl::mbedtls_last_error() = ret;
  18184. return false;
  18185. }
  18186. // Verify that the certificate and private key match.
  18187. // Mbed TLS 4.x: mbedtls_pk_check_pair() reports a spurious mismatch for
  18188. // PSA-backed keys, so skip it and let the handshake surface a real mismatch.
  18189. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18190. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18191. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  18192. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18193. #else
  18194. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  18195. #endif
  18196. if (ret != 0) {
  18197. impl::mbedtls_last_error() = ret;
  18198. return false;
  18199. }
  18200. #endif
  18201. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  18202. if (ret != 0) {
  18203. impl::mbedtls_last_error() = ret;
  18204. return false;
  18205. }
  18206. return true;
  18207. }
  18208. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  18209. const char *key_path, const char *password) {
  18210. if (!ctx || !cert_path || !key_path) { return false; }
  18211. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18212. // Parse certificate file
  18213. int ret = mbedtls_x509_crt_parse_file(&mctx->own_cert, cert_path);
  18214. if (ret != 0) {
  18215. impl::mbedtls_last_error() = ret;
  18216. return false;
  18217. }
  18218. // Parse private key file
  18219. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18220. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password,
  18221. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18222. #else
  18223. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password);
  18224. #endif
  18225. if (ret != 0) {
  18226. impl::mbedtls_last_error() = ret;
  18227. return false;
  18228. }
  18229. // Verify that the certificate and private key match.
  18230. // Mbed TLS 4.x: see set_client_cert() — skip the spurious check_pair.
  18231. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18232. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18233. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  18234. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18235. #else
  18236. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  18237. #endif
  18238. if (ret != 0) {
  18239. impl::mbedtls_last_error() = ret;
  18240. return false;
  18241. }
  18242. #endif
  18243. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  18244. if (ret != 0) {
  18245. impl::mbedtls_last_error() = ret;
  18246. return false;
  18247. }
  18248. return true;
  18249. }
  18250. inline void set_verify_client(ctx_t ctx, bool require) {
  18251. if (!ctx) { return; }
  18252. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18253. mctx->verify_client = require;
  18254. impl::apply_verify_mode(*mctx);
  18255. }
  18256. inline session_t create_session(ctx_t ctx, socket_t sock) {
  18257. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  18258. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18259. auto session = new (std::nothrow) impl::MbedTlsSession();
  18260. if (!session) { return nullptr; }
  18261. session->sock = sock;
  18262. int ret = mbedtls_ssl_setup(&session->ssl, &mctx->conf);
  18263. if (ret != 0) {
  18264. impl::mbedtls_last_error() = ret;
  18265. delete session;
  18266. return nullptr;
  18267. }
  18268. // Explicitly opt out of in-handshake hostname verification by default;
  18269. // since Mbed TLS 3.6.4 a client handshake with certificate verification
  18270. // fails outright when no hostname was set. set_sni() installs the real
  18271. // hostname for DNS hosts; for IP hosts (where SNI must not be set) the
  18272. // caller verifies the certificate identity post-handshake via
  18273. // verify_hostname().
  18274. mbedtls_ssl_set_hostname(&session->ssl, nullptr);
  18275. // Set BIO callbacks
  18276. mbedtls_ssl_set_bio(&session->ssl, &session->sock, impl::mbedtls_net_send_cb,
  18277. impl::mbedtls_net_recv_cb, nullptr);
  18278. // Installed always, as it also masks the hostname mismatch that set_sni()
  18279. // may ask for. The session runs its own copy of the user's callback, which
  18280. // set_verify_callback() cannot replace under a handshake.
  18281. session->verify_callback = mctx->verify_callback;
  18282. session->is_server = mctx->is_server;
  18283. mbedtls_ssl_set_verify(&session->ssl, impl::mbedtls_verify_callback, session);
  18284. return static_cast<session_t>(session);
  18285. }
  18286. inline void free_session(session_t session) {
  18287. if (session) { delete static_cast<impl::MbedTlsSession *>(session); }
  18288. }
  18289. inline bool set_sni(session_t session, const char *hostname,
  18290. bool verify_hostname) {
  18291. if (!session || !hostname) { return false; }
  18292. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18293. // mbedtls_ssl_set_hostname() both sends the SNI extension and binds the
  18294. // handshake-time CN/SAN check to `hostname`; the two can't be requested
  18295. // independently, so a disabled hostname check is handled below by masking
  18296. // the resulting mismatch flag instead of skipping this call.
  18297. int ret = mbedtls_ssl_set_hostname(&msession->ssl, hostname);
  18298. if (ret != 0) {
  18299. impl::mbedtls_last_error() = ret;
  18300. return false;
  18301. }
  18302. msession->hostname = hostname;
  18303. if (!verify_hostname) { msession->suppress_hostname_mismatch = true; }
  18304. return true;
  18305. }
  18306. inline TlsError connect(session_t session) {
  18307. TlsError err;
  18308. if (!session) {
  18309. err.code = ErrorCode::Fatal;
  18310. return err;
  18311. }
  18312. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18313. int ret;
  18314. do {
  18315. ret = mbedtls_ssl_handshake(&msession->ssl);
  18316. } while (impl::mbedtls_is_session_ticket(ret));
  18317. if (ret == 0) {
  18318. err.code = ErrorCode::Success;
  18319. } else {
  18320. impl::fill_mbedtls_tls_error(err, msession->ssl, ret);
  18321. impl::mbedtls_last_error() = ret;
  18322. }
  18323. return err;
  18324. }
  18325. inline TlsError accept(session_t session) {
  18326. // Same as connect for Mbed TLS - handshake works for both client and server
  18327. auto result = connect(session);
  18328. // After successful handshake, capture SNI from thread-local storage
  18329. if (result.code == ErrorCode::Success && session) {
  18330. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18331. msession->sni_hostname = std::move(impl::mbedpending_sni());
  18332. impl::mbedpending_sni().clear();
  18333. }
  18334. return result;
  18335. }
  18336. inline bool connect_nonblocking(session_t session, socket_t sock,
  18337. time_t timeout_sec, time_t timeout_usec,
  18338. TlsError *err) {
  18339. if (!session) {
  18340. if (err) { err->code = ErrorCode::Fatal; }
  18341. return false;
  18342. }
  18343. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18344. // Set socket to non-blocking mode
  18345. detail::set_nonblocking(sock, true);
  18346. auto cleanup =
  18347. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18348. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  18349. int ret;
  18350. while ((ret = mbedtls_ssl_handshake(&msession->ssl)) != 0) {
  18351. // Non-fatal TLS 1.3 ticket; retry immediately.
  18352. if (impl::mbedtls_is_session_ticket(ret)) { continue; }
  18353. if (ret == MBEDTLS_ERR_SSL_WANT_READ) {
  18354. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  18355. } else if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) {
  18356. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  18357. }
  18358. // TlsError or timeout
  18359. if (err) { impl::fill_mbedtls_tls_error(*err, msession->ssl, ret); }
  18360. impl::mbedtls_last_error() = ret;
  18361. return false;
  18362. }
  18363. if (err) { err->code = ErrorCode::Success; }
  18364. return true;
  18365. }
  18366. inline bool accept_nonblocking(session_t session, socket_t sock,
  18367. time_t timeout_sec, time_t timeout_usec,
  18368. TlsError *err) {
  18369. // Same implementation as connect for Mbed TLS
  18370. bool result =
  18371. connect_nonblocking(session, sock, timeout_sec, timeout_usec, err);
  18372. // After successful handshake, capture SNI from thread-local storage
  18373. if (result && session) {
  18374. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18375. msession->sni_hostname = std::move(impl::mbedpending_sni());
  18376. impl::mbedpending_sni().clear();
  18377. }
  18378. return result;
  18379. }
  18380. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  18381. if (!session || !buf) {
  18382. err.code = ErrorCode::Fatal;
  18383. return -1;
  18384. }
  18385. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18386. // Serve a byte consumed by the is_peer_closed() probe before reading more.
  18387. if (msession->has_peeked_byte) {
  18388. if (len == 0) { return 0; }
  18389. auto p = static_cast<unsigned char *>(buf);
  18390. p[0] = msession->peeked_byte;
  18391. msession->has_peeked_byte = false;
  18392. size_t n = 1;
  18393. // Top up with any already-decrypted bytes without risking a block.
  18394. if (len > 1 && mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  18395. int extra = mbedtls_ssl_read(&msession->ssl, p + 1, len - 1);
  18396. if (extra > 0) { n += static_cast<size_t>(extra); }
  18397. }
  18398. err.code = ErrorCode::Success;
  18399. return static_cast<ssize_t>(n);
  18400. }
  18401. int ret;
  18402. do {
  18403. ret = mbedtls_ssl_read(&msession->ssl, static_cast<unsigned char *>(buf),
  18404. len);
  18405. } while (impl::mbedtls_is_session_ticket(ret));
  18406. if (ret > 0) {
  18407. err.code = ErrorCode::Success;
  18408. return static_cast<ssize_t>(ret);
  18409. }
  18410. if (ret == 0) {
  18411. err.code = ErrorCode::PeerClosed;
  18412. return 0;
  18413. }
  18414. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  18415. err.backend_code = static_cast<uint64_t>(-ret);
  18416. impl::mbedtls_last_error() = ret;
  18417. // mbedTLS signals a clean close_notify via a negative error code rather
  18418. // than 0; surface it as a clean EOF the way OpenSSL/wolfSSL do.
  18419. if (err.code == ErrorCode::PeerClosed) { return 0; }
  18420. return -1;
  18421. }
  18422. inline ssize_t write(session_t session, const void *buf, size_t len,
  18423. TlsError &err) {
  18424. if (!session || !buf) {
  18425. err.code = ErrorCode::Fatal;
  18426. return -1;
  18427. }
  18428. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18429. int ret;
  18430. do {
  18431. ret = mbedtls_ssl_write(&msession->ssl,
  18432. static_cast<const unsigned char *>(buf), len);
  18433. } while (impl::mbedtls_is_session_ticket(ret));
  18434. if (ret > 0) {
  18435. err.code = ErrorCode::Success;
  18436. return static_cast<ssize_t>(ret);
  18437. }
  18438. if (ret == 0) {
  18439. err.code = ErrorCode::PeerClosed;
  18440. return 0;
  18441. }
  18442. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  18443. err.backend_code = static_cast<uint64_t>(-ret);
  18444. impl::mbedtls_last_error() = ret;
  18445. return -1;
  18446. }
  18447. inline int pending(const_session_t session) {
  18448. if (!session) { return 0; }
  18449. auto msession =
  18450. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18451. return static_cast<int>(mbedtls_ssl_get_bytes_avail(&msession->ssl)) +
  18452. (msession->has_peeked_byte ? 1 : 0);
  18453. }
  18454. inline void shutdown(session_t session, bool graceful) {
  18455. if (!session) { return; }
  18456. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18457. if (graceful) {
  18458. // Try to send close_notify, but don't block forever
  18459. int ret;
  18460. int attempts = 0;
  18461. while ((ret = mbedtls_ssl_close_notify(&msession->ssl)) != 0 &&
  18462. attempts < 3) {
  18463. if (ret != MBEDTLS_ERR_SSL_WANT_READ &&
  18464. ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
  18465. break;
  18466. }
  18467. attempts++;
  18468. }
  18469. }
  18470. }
  18471. inline bool is_peer_closed(session_t session, socket_t sock) {
  18472. if (!session || sock == INVALID_SOCKET) { return true; }
  18473. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18474. // Check if there's already decrypted or pushed-back data available.
  18475. // If so, the connection is definitely alive.
  18476. if (msession->has_peeked_byte ||
  18477. mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  18478. return false;
  18479. }
  18480. // Set socket to non-blocking to avoid blocking on read
  18481. detail::set_nonblocking(sock, true);
  18482. auto cleanup =
  18483. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18484. // Probe with a 1-byte read (Mbed TLS has no peek API). If the probe lands
  18485. // on application data — e.g. a response that already arrived — push the
  18486. // byte back so the next read() delivers it instead of losing it.
  18487. unsigned char buf;
  18488. int ret;
  18489. do {
  18490. ret = mbedtls_ssl_read(&msession->ssl, &buf, 1);
  18491. } while (impl::mbedtls_is_session_ticket(ret));
  18492. // If we got data or WANT_READ (would block), connection is alive
  18493. if (ret > 0) {
  18494. msession->peeked_byte = buf;
  18495. msession->has_peeked_byte = true;
  18496. return false;
  18497. }
  18498. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return false; }
  18499. // If we get a peer close notify or a connection reset, the peer is closed
  18500. return ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY ||
  18501. ret == MBEDTLS_ERR_NET_CONN_RESET || ret == 0;
  18502. }
  18503. inline cert_t get_peer_cert(const_session_t session) {
  18504. if (!session) { return nullptr; }
  18505. auto msession =
  18506. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18507. // Mbed TLS returns a pointer to the internal peer cert chain.
  18508. // WARNING: This pointer is only valid while the session is active.
  18509. // Do not use the certificate after calling free_session().
  18510. const mbedtls_x509_crt *cert = mbedtls_ssl_get_peer_cert(&msession->ssl);
  18511. return const_cast<mbedtls_x509_crt *>(cert);
  18512. }
  18513. inline size_t get_peer_certs(const_session_t session,
  18514. std::vector<cert_t> &certs) {
  18515. certs.clear();
  18516. // Mbed TLS parses the whole received chain into a list headed by the peer
  18517. // certificate, owned by the session like get_peer_cert()'s result
  18518. for (auto crt = static_cast<mbedtls_x509_crt *>(get_peer_cert(session));
  18519. crt && crt->raw.len > 0; crt = crt->next) {
  18520. certs.push_back(static_cast<cert_t>(crt));
  18521. }
  18522. return certs.size();
  18523. }
  18524. inline void free_cert(cert_t cert) {
  18525. // Mbed TLS: every cert_t handed out points into a session's or a context's
  18526. // chain, so there is nothing to free. Callers still call this for the other
  18527. // backends.
  18528. (void)cert;
  18529. }
  18530. inline bool verify_hostname(cert_t cert, const char *hostname) {
  18531. if (!cert || !hostname) { return false; }
  18532. auto mcert = static_cast<const mbedtls_x509_crt *>(cert);
  18533. std::string host_str(hostname);
  18534. // Check if hostname is an IP address (IPv4 or IPv6)
  18535. unsigned char ip_bytes[16];
  18536. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  18537. auto is_ip = ip_len > 0;
  18538. // Check Subject Alternative Names (SAN). Mbed TLS keeps the GeneralName type
  18539. // in buf.tag and the raw value in buf.p / buf.len.
  18540. auto has_dns_san = false;
  18541. for (auto san = &mcert->subject_alt_names; san; san = san->next) {
  18542. if (!san->buf.p || san->buf.len == 0) { continue; }
  18543. const unsigned char *p = san->buf.p;
  18544. size_t len = san->buf.len;
  18545. auto san_type = san->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK;
  18546. if (is_ip) {
  18547. // For an IP host, only a matching iPAddress SAN of the same family
  18548. // (4 bytes for IPv4, 16 bytes for IPv6) may authenticate it.
  18549. if (san_type == MBEDTLS_X509_SAN_IP_ADDRESS && len == ip_len &&
  18550. memcmp(p, ip_bytes, ip_len) == 0) {
  18551. return true;
  18552. }
  18553. } else if (san_type == MBEDTLS_X509_SAN_DNS_NAME) {
  18554. has_dns_san = true;
  18555. std::string san_name(reinterpret_cast<const char *>(p), len);
  18556. if (detail::match_hostname(san_name, host_str)) { return true; }
  18557. }
  18558. }
  18559. // Fallback: the Common Names (CN) in the subject, as X509_check_host does it:
  18560. // never for an IP host, which only an iPAddress SAN names, and never next to
  18561. // a DNS SAN (RFC 6125 6.4.4).
  18562. if (is_ip || has_dns_san) { return false; }
  18563. for (auto name = &mcert->subject; name; name = name->next) {
  18564. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  18565. std::string cn(reinterpret_cast<const char *>(name->val.p),
  18566. name->val.len);
  18567. if (detail::match_hostname(cn, host_str)) { return true; }
  18568. }
  18569. }
  18570. return false;
  18571. }
  18572. inline uint64_t hostname_mismatch_code() {
  18573. return static_cast<uint64_t>(MBEDTLS_X509_BADCERT_CN_MISMATCH);
  18574. }
  18575. inline long get_verify_result(const_session_t session) {
  18576. if (!session) { return -1; }
  18577. auto msession =
  18578. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18579. uint32_t flags = mbedtls_ssl_get_verify_result(&msession->ssl);
  18580. // Return 0 (X509_V_OK equivalent) if verification passed
  18581. return flags == 0 ? 0 : static_cast<long>(flags);
  18582. }
  18583. inline std::string get_cert_subject_cn(cert_t cert) {
  18584. if (!cert) return "";
  18585. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18586. // Find the CN in the subject
  18587. const mbedtls_x509_name *name = &x509->subject;
  18588. while (name != nullptr) {
  18589. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  18590. return std::string(reinterpret_cast<const char *>(name->val.p),
  18591. name->val.len);
  18592. }
  18593. name = name->next;
  18594. }
  18595. return "";
  18596. }
  18597. inline std::string get_cert_issuer_name(cert_t cert) {
  18598. if (!cert) return "";
  18599. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18600. // Build a human-readable issuer name string
  18601. char buf[512];
  18602. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &x509->issuer);
  18603. if (ret < 0) return "";
  18604. return std::string(buf);
  18605. }
  18606. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  18607. sans.clear();
  18608. if (!cert) return false;
  18609. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18610. // Parse the Subject Alternative Name extension
  18611. const mbedtls_x509_sequence *cur = &x509->subject_alt_names;
  18612. while (cur != nullptr) {
  18613. if (cur->buf.len > 0) {
  18614. const unsigned char *p = cur->buf.p;
  18615. size_t value_len = cur->buf.len;
  18616. SanEntry entry;
  18617. switch (cur->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK) {
  18618. case MBEDTLS_X509_SAN_DNS_NAME:
  18619. entry.type = SanType::DNS;
  18620. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18621. break;
  18622. case MBEDTLS_X509_SAN_IP_ADDRESS:
  18623. entry.type = SanType::IP;
  18624. if (value_len == 4) {
  18625. // IPv4
  18626. char buf[16];
  18627. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", p[0], p[1], p[2], p[3]);
  18628. entry.value = buf;
  18629. } else if (value_len == 16) {
  18630. // IPv6
  18631. char buf[64];
  18632. snprintf(buf, sizeof(buf),
  18633. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  18634. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  18635. p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8], p[9],
  18636. p[10], p[11], p[12], p[13], p[14], p[15]);
  18637. entry.value = buf;
  18638. }
  18639. break;
  18640. case MBEDTLS_X509_SAN_RFC822_NAME:
  18641. entry.type = SanType::EMAIL;
  18642. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18643. break;
  18644. case MBEDTLS_X509_SAN_UNIFORM_RESOURCE_IDENTIFIER:
  18645. entry.type = SanType::URI;
  18646. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18647. break;
  18648. default: entry.type = SanType::OTHER; break;
  18649. }
  18650. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  18651. }
  18652. cur = cur->next;
  18653. }
  18654. return true;
  18655. }
  18656. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  18657. time_t &not_after) {
  18658. if (!cert) return false;
  18659. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18660. // Convert mbedtls_x509_time to time_t
  18661. auto to_time_t = [](const mbedtls_x509_time &t) -> time_t {
  18662. struct tm tm_time = {};
  18663. tm_time.tm_year = t.year - 1900;
  18664. tm_time.tm_mon = t.mon - 1;
  18665. tm_time.tm_mday = t.day;
  18666. tm_time.tm_hour = t.hour;
  18667. tm_time.tm_min = t.min;
  18668. tm_time.tm_sec = t.sec;
  18669. #ifdef _WIN32
  18670. return _mkgmtime(&tm_time);
  18671. #else
  18672. return timegm(&tm_time);
  18673. #endif
  18674. };
  18675. not_before = to_time_t(x509->valid_from);
  18676. not_after = to_time_t(x509->valid_to);
  18677. return true;
  18678. }
  18679. inline std::string get_cert_serial(cert_t cert) {
  18680. if (!cert) return "";
  18681. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18682. // Convert serial number to hex string
  18683. std::string result;
  18684. result.reserve(x509->serial.len * 2);
  18685. for (size_t i = 0; i < x509->serial.len; i++) {
  18686. char hex[3];
  18687. snprintf(hex, sizeof(hex), "%02X", x509->serial.p[i]);
  18688. result += hex;
  18689. }
  18690. return result;
  18691. }
  18692. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  18693. if (!cert) return false;
  18694. auto crt = static_cast<mbedtls_x509_crt *>(cert);
  18695. if (!crt->raw.p || crt->raw.len == 0) return false;
  18696. der.assign(crt->raw.p, crt->raw.p + crt->raw.len);
  18697. return true;
  18698. }
  18699. inline const char *get_sni(const_session_t session) {
  18700. if (!session) return nullptr;
  18701. auto msession = static_cast<const impl::MbedTlsSession *>(session);
  18702. // For server: return SNI received from client during handshake
  18703. if (!msession->sni_hostname.empty()) {
  18704. return msession->sni_hostname.c_str();
  18705. }
  18706. // For client: return the hostname set via set_sni
  18707. if (!msession->hostname.empty()) { return msession->hostname.c_str(); }
  18708. return nullptr;
  18709. }
  18710. inline uint64_t peek_error() {
  18711. // Mbed TLS doesn't have an error queue, return the last error
  18712. return static_cast<uint64_t>(-impl::mbedtls_last_error());
  18713. }
  18714. inline uint64_t get_error() {
  18715. // Mbed TLS doesn't have an error queue, return and clear the last error
  18716. uint64_t err = static_cast<uint64_t>(-impl::mbedtls_last_error());
  18717. impl::mbedtls_last_error() = 0;
  18718. return err;
  18719. }
  18720. inline std::string error_string(uint64_t code) {
  18721. char buf[256];
  18722. mbedtls_strerror(-static_cast<int>(code), buf, sizeof(buf));
  18723. return std::string(buf);
  18724. }
  18725. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  18726. auto *ca_chain = new (std::nothrow) mbedtls_x509_crt;
  18727. if (!ca_chain) { return nullptr; }
  18728. mbedtls_x509_crt_init(ca_chain);
  18729. // mbedtls_x509_crt_parse expects null-terminated PEM
  18730. int ret = mbedtls_x509_crt_parse(ca_chain,
  18731. reinterpret_cast<const unsigned char *>(pem),
  18732. len + 1); // +1 for null terminator
  18733. if (ret != 0) {
  18734. // Try without +1 in case PEM is already null-terminated
  18735. ret = mbedtls_x509_crt_parse(
  18736. ca_chain, reinterpret_cast<const unsigned char *>(pem), len);
  18737. if (ret != 0) {
  18738. mbedtls_x509_crt_free(ca_chain);
  18739. delete ca_chain;
  18740. return nullptr;
  18741. }
  18742. }
  18743. return static_cast<ca_store_t>(ca_chain);
  18744. }
  18745. inline void free_ca_store(ca_store_t store) {
  18746. if (store) {
  18747. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18748. mbedtls_x509_crt_free(ca_chain);
  18749. delete ca_chain;
  18750. }
  18751. }
  18752. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  18753. if (!ctx || !store) { return false; }
  18754. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18755. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18756. // Free existing CA chain
  18757. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  18758. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  18759. // Copy the CA chain (deep copy)
  18760. // Parse from the raw data of the source cert
  18761. mbedtls_x509_crt *src = ca_chain;
  18762. while (src != nullptr) {
  18763. int ret = mbedtls_x509_crt_parse_der(&mbed_ctx->ca_chain, src->raw.p,
  18764. src->raw.len);
  18765. if (ret != 0) {
  18766. free_ca_store(store);
  18767. return false;
  18768. }
  18769. src = src->next;
  18770. }
  18771. // This function takes ownership of the store; the chain was deep-copied
  18772. // above, so release the source
  18773. free_ca_store(store);
  18774. // Update the SSL config to use the new CA chain
  18775. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18776. return true;
  18777. }
  18778. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  18779. certs.clear();
  18780. if (!ctx) { return 0; }
  18781. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18782. // Owned by the context; see free_cert()
  18783. for (auto cert = &mbed_ctx->ca_chain; cert && cert->raw.len > 0;
  18784. cert = cert->next) {
  18785. certs.push_back(static_cast<cert_t>(cert));
  18786. }
  18787. return certs.size();
  18788. }
  18789. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  18790. std::vector<std::string> names;
  18791. if (!ctx) { return names; }
  18792. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18793. // Iterate through the CA chain
  18794. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  18795. while (cert != nullptr && cert->raw.len > 0) {
  18796. char buf[512];
  18797. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &cert->subject);
  18798. if (ret > 0) { names.push_back(buf); }
  18799. cert = cert->next;
  18800. }
  18801. return names;
  18802. }
  18803. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  18804. const char *key_pem, const char *password) {
  18805. if (!ctx || !cert_pem || !key_pem) { return false; }
  18806. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18807. // Parse into new objects first, so that a bad pair leaves the old one in
  18808. // place, and swap them in after; the old ones are freed on the way out.
  18809. mbedtls_x509_crt cert;
  18810. mbedtls_pk_context key;
  18811. mbedtls_x509_crt_init(&cert);
  18812. mbedtls_pk_init(&key);
  18813. auto se = detail::scope_exit([&] {
  18814. mbedtls_x509_crt_free(&cert);
  18815. mbedtls_pk_free(&key);
  18816. });
  18817. // Parse certificate PEM
  18818. int ret = mbedtls_x509_crt_parse(
  18819. &cert, reinterpret_cast<const unsigned char *>(cert_pem),
  18820. strlen(cert_pem) + 1);
  18821. if (ret != 0) {
  18822. impl::mbedtls_last_error() = ret;
  18823. return false;
  18824. }
  18825. // Parse private key PEM
  18826. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18827. ret = mbedtls_pk_parse_key(
  18828. &key, reinterpret_cast<const unsigned char *>(key_pem),
  18829. strlen(key_pem) + 1,
  18830. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18831. password ? strlen(password) : 0, mbedtls_ctr_drbg_random,
  18832. &mbed_ctx->ctr_drbg);
  18833. #else
  18834. ret = mbedtls_pk_parse_key(
  18835. &key, reinterpret_cast<const unsigned char *>(key_pem),
  18836. strlen(key_pem) + 1,
  18837. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18838. password ? strlen(password) : 0);
  18839. #endif
  18840. if (ret != 0) {
  18841. impl::mbedtls_last_error() = ret;
  18842. return false;
  18843. }
  18844. std::swap(mbed_ctx->own_cert, cert);
  18845. std::swap(mbed_ctx->own_key, key);
  18846. // Configure SSL to use the new certificate and key
  18847. ret = mbedtls_ssl_conf_own_cert(&mbed_ctx->conf, &mbed_ctx->own_cert,
  18848. &mbed_ctx->own_key);
  18849. if (ret != 0) {
  18850. impl::mbedtls_last_error() = ret;
  18851. return false;
  18852. }
  18853. return true;
  18854. }
  18855. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  18856. if (!ctx || !ca_pem) { return false; }
  18857. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18858. // Parse into a new chain first, so that a bad one leaves the old in place
  18859. mbedtls_x509_crt chain;
  18860. mbedtls_x509_crt_init(&chain);
  18861. auto se = detail::scope_exit([&] { mbedtls_x509_crt_free(&chain); });
  18862. // Parse CA PEM
  18863. int ret = mbedtls_x509_crt_parse(
  18864. &chain, reinterpret_cast<const unsigned char *>(ca_pem),
  18865. strlen(ca_pem) + 1);
  18866. if (ret != 0) {
  18867. impl::mbedtls_last_error() = ret;
  18868. return false;
  18869. }
  18870. std::swap(mbed_ctx->ca_chain, chain);
  18871. // Update SSL config to use new CA chain
  18872. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18873. return true;
  18874. }
  18875. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  18876. if (!ctx) { return false; }
  18877. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18878. // create_session() hands each session its own copy to run.
  18879. mbed_ctx->verify_callback = std::move(callback);
  18880. impl::apply_verify_mode(*mbed_ctx);
  18881. return true;
  18882. }
  18883. inline long get_verify_error(const_session_t session) {
  18884. if (!session) { return -1; }
  18885. auto *msession =
  18886. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18887. return static_cast<long>(mbedtls_ssl_get_verify_result(&msession->ssl));
  18888. }
  18889. inline std::string verify_error_string(long error_code) {
  18890. if (error_code == 0) { return ""; }
  18891. char buf[256];
  18892. mbedtls_x509_crt_verify_info(buf, sizeof(buf), "",
  18893. static_cast<uint32_t>(error_code));
  18894. // Remove trailing newline if present
  18895. std::string result(buf);
  18896. while (!result.empty() && (result.back() == '\n' || result.back() == ' ')) {
  18897. result.pop_back();
  18898. }
  18899. return result;
  18900. }
  18901. } // namespace tls
  18902. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  18903. /*
  18904. * Group 10: TLS abstraction layer - wolfSSL backend
  18905. */
  18906. /*
  18907. * wolfSSL Backend Implementation
  18908. */
  18909. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  18910. namespace tls {
  18911. namespace impl {
  18912. // wolfSSL session wrapper
  18913. struct WolfSSLSession {
  18914. WOLFSSL *ssl = nullptr;
  18915. socket_t sock = INVALID_SOCKET;
  18916. std::string hostname; // For client: set via set_sni
  18917. std::string sni_hostname; // For server: received from client via SNI callback
  18918. WolfSSLSession() = default;
  18919. ~WolfSSLSession() {
  18920. if (ssl) { wolfSSL_free(ssl); }
  18921. }
  18922. WolfSSLSession(const WolfSSLSession &) = delete;
  18923. WolfSSLSession &operator=(const WolfSSLSession &) = delete;
  18924. };
  18925. // Thread-local error code accessor for wolfSSL
  18926. inline uint64_t &wolfssl_last_error() {
  18927. static thread_local uint64_t err = 0;
  18928. return err;
  18929. }
  18930. // Helper to map wolfSSL error to ErrorCode.
  18931. // ssl_error is the value from wolfSSL_get_error().
  18932. // raw_ret is the raw return value from the wolfSSL call (for low-level error).
  18933. inline ErrorCode map_wolfssl_error(WOLFSSL *ssl, int ssl_error,
  18934. int &out_errno) {
  18935. switch (ssl_error) {
  18936. case SSL_ERROR_NONE: return ErrorCode::Success;
  18937. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  18938. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  18939. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  18940. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  18941. default:
  18942. if (ssl) {
  18943. // wolfSSL stores the low-level error code as a negative value.
  18944. // DOMAIN_NAME_MISMATCH (-322) indicates hostname verification failure.
  18945. int low_err = ssl_error; // wolfSSL_get_error returns the low-level code
  18946. if (low_err == DOMAIN_NAME_MISMATCH) {
  18947. return ErrorCode::HostnameMismatch;
  18948. }
  18949. // Check verify result to distinguish cert verification from generic SSL
  18950. // errors.
  18951. long vr = wolfSSL_get_verify_result(ssl);
  18952. if (vr != 0) { return ErrorCode::CertVerifyFailed; }
  18953. }
  18954. return ErrorCode::Fatal;
  18955. }
  18956. }
  18957. // WolfSSLContext constructor/destructor implementations
  18958. inline WolfSSLContext::WolfSSLContext() { wolfSSL_Init(); }
  18959. inline WolfSSLContext::~WolfSSLContext() {
  18960. if (ctx) { wolfSSL_CTX_free(ctx); }
  18961. }
  18962. // Thread-local storage for SNI captured during handshake
  18963. inline std::string &wolfssl_pending_sni() {
  18964. static thread_local std::string sni;
  18965. return sni;
  18966. }
  18967. // SNI callback for wolfSSL server to capture client's SNI hostname
  18968. inline int wolfssl_sni_callback(WOLFSSL *ssl, int *ret, void *exArg) {
  18969. (void)ret;
  18970. (void)exArg;
  18971. void *name_data = nullptr;
  18972. unsigned short name_len =
  18973. wolfSSL_SNI_GetRequest(ssl, WOLFSSL_SNI_HOST_NAME, &name_data);
  18974. if (name_data && name_len > 0) {
  18975. wolfssl_pending_sni().assign(static_cast<const char *>(name_data),
  18976. name_len);
  18977. } else {
  18978. wolfssl_pending_sni().clear();
  18979. }
  18980. return 0; // Continue regardless
  18981. }
  18982. // The WOLFSSL_CTX points back to its WolfSSLContext, so a handshake only ever
  18983. // runs the verify callback of its own context.
  18984. inline int context_ex_data_index() {
  18985. static const auto index =
  18986. wolfSSL_CTX_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  18987. return index;
  18988. }
  18989. // Each WOLFSSL points back to its WolfSSLSession, the session_t that every
  18990. // other tls:: function takes.
  18991. inline int session_ex_data_index() {
  18992. static const auto index =
  18993. wolfSSL_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  18994. return index;
  18995. }
  18996. // A resumed session skips the client's certificate, so a server that checks
  18997. // one would let in a certificate checked against another server's CA, as
  18998. // wolfSSL shares its session cache between contexts, or against a CA since
  18999. // replaced by update_server_client_ca().
  19000. inline void disable_server_resumption(WolfSSLContext *wctx) {
  19001. if (!wctx->is_server) { return; }
  19002. wolfSSL_CTX_set_session_cache_mode(wctx->ctx, WOLFSSL_SESS_CACHE_OFF);
  19003. #ifdef HAVE_SESSION_TICKET
  19004. wolfSSL_CTX_NoTicketTLSv12(wctx->ctx);
  19005. #endif
  19006. }
  19007. // wolfSSL verify callback wrapper
  19008. inline int wolfssl_verify_callback(int preverify_ok,
  19009. WOLFSSL_X509_STORE_CTX *x509_ctx) {
  19010. // Get the WOLFSSL object from the X509_STORE_CTX
  19011. WOLFSSL *ssl = static_cast<WOLFSSL *>(wolfSSL_X509_STORE_CTX_get_ex_data(
  19012. x509_ctx, wolfSSL_get_ex_data_X509_STORE_CTX_idx()));
  19013. if (!ssl) { return preverify_ok; }
  19014. auto wctx = static_cast<WolfSSLContext *>(wolfSSL_CTX_get_ex_data(
  19015. wolfSSL_get_SSL_CTX(ssl), context_ex_data_index()));
  19016. if (!wctx) { return preverify_ok; }
  19017. std::shared_ptr<VerifyCallback> callback;
  19018. {
  19019. std::lock_guard<std::mutex> guard(verify_callback_mutex());
  19020. callback = wctx->verify_callback;
  19021. }
  19022. if (!callback) { return preverify_ok; }
  19023. WOLFSSL_X509 *cert = wolfSSL_X509_STORE_CTX_get_current_cert(x509_ctx);
  19024. int depth = wolfSSL_X509_STORE_CTX_get_error_depth(x509_ctx);
  19025. int err = wolfSSL_X509_STORE_CTX_get_error(x509_ctx);
  19026. VerifyContext verify_ctx;
  19027. verify_ctx.session = wolfSSL_get_ex_data(ssl, session_ex_data_index());
  19028. verify_ctx.cert = static_cast<cert_t>(cert);
  19029. verify_ctx.depth = depth;
  19030. verify_ctx.preverify_ok = (preverify_ok != 0);
  19031. verify_ctx.error_code = static_cast<long>(err);
  19032. if (err != 0) {
  19033. verify_ctx.error_string = wolfSSL_X509_verify_cert_error_string(err);
  19034. } else {
  19035. verify_ctx.error_string = nullptr;
  19036. }
  19037. bool accepted = run_verify_callback(*callback, verify_ctx);
  19038. return accepted ? 1 : 0;
  19039. }
  19040. // Sets the verify mode from whether the peer's certificate is required and
  19041. // whether a verify callback is set.
  19042. inline void apply_verify_mode(WolfSSLContext &wctx) {
  19043. auto has_callback = static_cast<bool>(wctx.verify_callback);
  19044. if (wctx.verify_client || has_callback) { disable_server_resumption(&wctx); }
  19045. auto mode = wctx.verify_client
  19046. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  19047. : (has_callback ? SSL_VERIFY_PEER : SSL_VERIFY_NONE);
  19048. wolfSSL_CTX_set_verify(wctx.ctx, mode,
  19049. has_callback ? wolfssl_verify_callback : nullptr);
  19050. }
  19051. inline void set_wolfssl_password_cb(WOLFSSL_CTX *ctx, const char *password) {
  19052. wolfSSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char *>(password));
  19053. wolfSSL_CTX_set_default_passwd_cb(
  19054. ctx, [](char *buf, int size, int /*rwflag*/, void *userdata) -> int {
  19055. auto *pwd = static_cast<const char *>(userdata);
  19056. if (!pwd) return 0;
  19057. auto len = static_cast<int>(strlen(pwd));
  19058. if (len > size) len = size;
  19059. memcpy(buf, pwd, static_cast<size_t>(len));
  19060. return len;
  19061. });
  19062. }
  19063. } // namespace impl
  19064. inline ctx_t create_client_context() {
  19065. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  19066. if (!ctx) { return nullptr; }
  19067. ctx->is_server = false;
  19068. WOLFSSL_METHOD *method = wolfTLSv1_2_client_method();
  19069. if (!method) {
  19070. delete ctx;
  19071. return nullptr;
  19072. }
  19073. ctx->ctx = wolfSSL_CTX_new(method);
  19074. if (!ctx->ctx ||
  19075. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  19076. WOLFSSL_SUCCESS) {
  19077. delete ctx;
  19078. return nullptr;
  19079. }
  19080. // Default: verify peer certificate
  19081. ctx->verify_client = true;
  19082. impl::apply_verify_mode(*ctx);
  19083. return static_cast<ctx_t>(ctx);
  19084. }
  19085. inline ctx_t create_server_context() {
  19086. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  19087. if (!ctx) { return nullptr; }
  19088. ctx->is_server = true;
  19089. WOLFSSL_METHOD *method = wolfTLSv1_2_server_method();
  19090. if (!method) {
  19091. delete ctx;
  19092. return nullptr;
  19093. }
  19094. ctx->ctx = wolfSSL_CTX_new(method);
  19095. if (!ctx->ctx ||
  19096. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  19097. WOLFSSL_SUCCESS) {
  19098. delete ctx;
  19099. return nullptr;
  19100. }
  19101. // Default: don't verify client
  19102. impl::apply_verify_mode(*ctx);
  19103. // Enable SNI on server
  19104. wolfSSL_CTX_SNI_SetOptions(ctx->ctx, WOLFSSL_SNI_HOST_NAME,
  19105. WOLFSSL_SNI_CONTINUE_ON_MISMATCH);
  19106. wolfSSL_CTX_set_servername_callback(ctx->ctx, impl::wolfssl_sni_callback);
  19107. return static_cast<ctx_t>(ctx);
  19108. }
  19109. inline void free_context(ctx_t ctx) {
  19110. if (ctx) { delete static_cast<impl::WolfSSLContext *>(ctx); }
  19111. }
  19112. inline bool set_min_version(ctx_t ctx, Version version) {
  19113. if (!ctx) { return false; }
  19114. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19115. int min_ver = WOLFSSL_TLSV1_2;
  19116. if (version >= Version::TLS1_3) { min_ver = WOLFSSL_TLSV1_3; }
  19117. return wolfSSL_CTX_SetMinVersion(wctx->ctx, min_ver) == WOLFSSL_SUCCESS;
  19118. }
  19119. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  19120. if (!ctx || !pem) { return false; }
  19121. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19122. int ret = wolfSSL_CTX_load_verify_buffer(
  19123. wctx->ctx, reinterpret_cast<const unsigned char *>(pem),
  19124. static_cast<long>(len), SSL_FILETYPE_PEM);
  19125. if (ret != SSL_SUCCESS) {
  19126. impl::wolfssl_last_error() =
  19127. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19128. return false;
  19129. }
  19130. wctx->ca_pem_data_.append(pem, len);
  19131. return true;
  19132. }
  19133. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  19134. if (!ctx || !file_path) { return false; }
  19135. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19136. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, file_path, nullptr);
  19137. if (ret != SSL_SUCCESS) {
  19138. impl::wolfssl_last_error() =
  19139. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19140. return false;
  19141. }
  19142. return true;
  19143. }
  19144. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  19145. if (!ctx || !dir_path) { return false; }
  19146. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19147. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, dir_path);
  19148. // wolfSSL may fail if the directory doesn't contain properly hashed certs.
  19149. // Unlike OpenSSL which lazily loads certs from directories, wolfSSL scans
  19150. // immediately. Return true even on failure since the CA file may have
  19151. // already been loaded, matching OpenSSL's lenient behavior.
  19152. (void)ret;
  19153. return true;
  19154. }
  19155. inline bool load_system_certs(ctx_t ctx) {
  19156. if (!ctx) { return false; }
  19157. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19158. bool loaded = false;
  19159. #ifdef _WIN32
  19160. loaded = impl::enumerate_windows_system_certs(
  19161. [&](const unsigned char *data, size_t len) {
  19162. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  19163. static_cast<long>(len),
  19164. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  19165. });
  19166. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  19167. loaded = impl::enumerate_macos_keychain_certs(
  19168. [&](const unsigned char *data, size_t len) {
  19169. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  19170. static_cast<long>(len),
  19171. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  19172. });
  19173. #else
  19174. for (auto path = impl::system_ca_paths(); *path; ++path) {
  19175. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, *path, nullptr) ==
  19176. SSL_SUCCESS) {
  19177. loaded = true;
  19178. break;
  19179. }
  19180. }
  19181. if (!loaded) {
  19182. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  19183. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, *dir) ==
  19184. SSL_SUCCESS) {
  19185. loaded = true;
  19186. break;
  19187. }
  19188. }
  19189. }
  19190. #endif
  19191. return loaded;
  19192. }
  19193. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  19194. const char *password) {
  19195. if (!ctx || !cert || !key) { return false; }
  19196. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19197. // Load certificate
  19198. int ret = wolfSSL_CTX_use_certificate_buffer(
  19199. wctx->ctx, reinterpret_cast<const unsigned char *>(cert),
  19200. static_cast<long>(strlen(cert)), SSL_FILETYPE_PEM);
  19201. if (ret != SSL_SUCCESS) {
  19202. impl::wolfssl_last_error() =
  19203. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19204. return false;
  19205. }
  19206. // Set password callback if password is provided
  19207. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19208. // Load private key
  19209. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  19210. wctx->ctx, reinterpret_cast<const unsigned char *>(key),
  19211. static_cast<long>(strlen(key)), SSL_FILETYPE_PEM);
  19212. if (ret != SSL_SUCCESS) {
  19213. impl::wolfssl_last_error() =
  19214. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19215. return false;
  19216. }
  19217. // Verify that the certificate and private key match
  19218. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  19219. }
  19220. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  19221. const char *key_path, const char *password) {
  19222. if (!ctx || !cert_path || !key_path) { return false; }
  19223. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19224. // Load certificate file
  19225. int ret =
  19226. wolfSSL_CTX_use_certificate_file(wctx->ctx, cert_path, SSL_FILETYPE_PEM);
  19227. if (ret != SSL_SUCCESS) {
  19228. impl::wolfssl_last_error() =
  19229. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19230. return false;
  19231. }
  19232. // Set password callback if password is provided
  19233. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19234. // Load private key file
  19235. ret = wolfSSL_CTX_use_PrivateKey_file(wctx->ctx, key_path, SSL_FILETYPE_PEM);
  19236. if (ret != SSL_SUCCESS) {
  19237. impl::wolfssl_last_error() =
  19238. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19239. return false;
  19240. }
  19241. // Verify that the certificate and private key match
  19242. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  19243. }
  19244. inline void set_verify_client(ctx_t ctx, bool require) {
  19245. if (!ctx) { return; }
  19246. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19247. wctx->verify_client = require;
  19248. impl::apply_verify_mode(*wctx);
  19249. }
  19250. inline session_t create_session(ctx_t ctx, socket_t sock) {
  19251. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  19252. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19253. auto session = new (std::nothrow) impl::WolfSSLSession();
  19254. if (!session) { return nullptr; }
  19255. session->sock = sock;
  19256. session->ssl = wolfSSL_new(wctx->ctx);
  19257. if (!session->ssl) {
  19258. impl::wolfssl_last_error() =
  19259. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19260. delete session;
  19261. return nullptr;
  19262. }
  19263. if (wolfSSL_set_ex_data(session->ssl, impl::session_ex_data_index(),
  19264. session) != WOLFSSL_SUCCESS) {
  19265. delete session;
  19266. return nullptr;
  19267. }
  19268. wolfSSL_set_fd(session->ssl, static_cast<int>(sock));
  19269. return static_cast<session_t>(session);
  19270. }
  19271. inline void free_session(session_t session) {
  19272. if (session) { delete static_cast<impl::WolfSSLSession *>(session); }
  19273. }
  19274. inline bool set_sni(session_t session, const char *hostname,
  19275. bool verify_hostname) {
  19276. if (!session || !hostname) { return false; }
  19277. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19278. int ret = wolfSSL_UseSNI(wsession->ssl, WOLFSSL_SNI_HOST_NAME, hostname,
  19279. static_cast<word16>(strlen(hostname)));
  19280. if (ret != WOLFSSL_SUCCESS) {
  19281. impl::wolfssl_last_error() =
  19282. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19283. return false;
  19284. }
  19285. // wolfSSL_check_domain_name binds identity checking to the handshake,
  19286. // separately from the SNI extension sent above; skip it when hostname
  19287. // verification is disabled so only the chain is checked, matching OpenSSL.
  19288. if (verify_hostname) { wolfSSL_check_domain_name(wsession->ssl, hostname); }
  19289. wsession->hostname = hostname;
  19290. return true;
  19291. }
  19292. inline TlsError connect(session_t session) {
  19293. TlsError err;
  19294. if (!session) {
  19295. err.code = ErrorCode::Fatal;
  19296. return err;
  19297. }
  19298. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19299. int ret = wolfSSL_connect(wsession->ssl);
  19300. if (ret == SSL_SUCCESS) {
  19301. err.code = ErrorCode::Success;
  19302. } else {
  19303. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19304. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19305. err.backend_code = static_cast<uint64_t>(ssl_error);
  19306. impl::wolfssl_last_error() = err.backend_code;
  19307. }
  19308. return err;
  19309. }
  19310. inline TlsError accept(session_t session) {
  19311. TlsError err;
  19312. if (!session) {
  19313. err.code = ErrorCode::Fatal;
  19314. return err;
  19315. }
  19316. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19317. int ret = wolfSSL_accept(wsession->ssl);
  19318. if (ret == SSL_SUCCESS) {
  19319. err.code = ErrorCode::Success;
  19320. // Capture SNI from thread-local storage after successful handshake
  19321. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  19322. impl::wolfssl_pending_sni().clear();
  19323. } else {
  19324. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19325. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19326. err.backend_code = static_cast<uint64_t>(ssl_error);
  19327. impl::wolfssl_last_error() = err.backend_code;
  19328. }
  19329. return err;
  19330. }
  19331. inline bool connect_nonblocking(session_t session, socket_t sock,
  19332. time_t timeout_sec, time_t timeout_usec,
  19333. TlsError *err) {
  19334. if (!session) {
  19335. if (err) { err->code = ErrorCode::Fatal; }
  19336. return false;
  19337. }
  19338. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19339. // Set socket to non-blocking mode
  19340. detail::set_nonblocking(sock, true);
  19341. auto cleanup =
  19342. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19343. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  19344. int ret;
  19345. while ((ret = wolfSSL_connect(wsession->ssl)) != SSL_SUCCESS) {
  19346. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19347. if (ssl_error == SSL_ERROR_WANT_READ) {
  19348. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  19349. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  19350. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  19351. }
  19352. // Error or timeout
  19353. if (err) {
  19354. err->code =
  19355. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  19356. err->backend_code = static_cast<uint64_t>(ssl_error);
  19357. }
  19358. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  19359. return false;
  19360. }
  19361. if (err) { err->code = ErrorCode::Success; }
  19362. return true;
  19363. }
  19364. inline bool accept_nonblocking(session_t session, socket_t sock,
  19365. time_t timeout_sec, time_t timeout_usec,
  19366. TlsError *err) {
  19367. if (!session) {
  19368. if (err) { err->code = ErrorCode::Fatal; }
  19369. return false;
  19370. }
  19371. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19372. // Set socket to non-blocking mode
  19373. detail::set_nonblocking(sock, true);
  19374. auto cleanup =
  19375. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19376. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  19377. int ret;
  19378. while ((ret = wolfSSL_accept(wsession->ssl)) != SSL_SUCCESS) {
  19379. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19380. if (ssl_error == SSL_ERROR_WANT_READ) {
  19381. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  19382. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  19383. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  19384. }
  19385. // Error or timeout
  19386. if (err) {
  19387. err->code =
  19388. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  19389. err->backend_code = static_cast<uint64_t>(ssl_error);
  19390. }
  19391. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  19392. return false;
  19393. }
  19394. if (err) { err->code = ErrorCode::Success; }
  19395. // Capture SNI from thread-local storage after successful handshake
  19396. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  19397. impl::wolfssl_pending_sni().clear();
  19398. return true;
  19399. }
  19400. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  19401. if (!session || !buf) {
  19402. err.code = ErrorCode::Fatal;
  19403. return -1;
  19404. }
  19405. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19406. int ret = wolfSSL_read(wsession->ssl, buf, static_cast<int>(len));
  19407. if (ret > 0) {
  19408. err.code = ErrorCode::Success;
  19409. return static_cast<ssize_t>(ret);
  19410. }
  19411. if (ret == 0) {
  19412. err.code = ErrorCode::PeerClosed;
  19413. return 0;
  19414. }
  19415. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19416. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19417. err.backend_code = static_cast<uint64_t>(ssl_error);
  19418. impl::wolfssl_last_error() = err.backend_code;
  19419. return -1;
  19420. }
  19421. inline ssize_t write(session_t session, const void *buf, size_t len,
  19422. TlsError &err) {
  19423. if (!session || !buf) {
  19424. err.code = ErrorCode::Fatal;
  19425. return -1;
  19426. }
  19427. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19428. int ret = wolfSSL_write(wsession->ssl, buf, static_cast<int>(len));
  19429. if (ret > 0) {
  19430. err.code = ErrorCode::Success;
  19431. return static_cast<ssize_t>(ret);
  19432. }
  19433. // wolfSSL_write returns 0 when the peer has sent a close_notify.
  19434. // Treat this as an error (return -1) so callers don't spin in a
  19435. // write loop adding zero to the offset.
  19436. if (ret == 0) {
  19437. err.code = ErrorCode::PeerClosed;
  19438. return -1;
  19439. }
  19440. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19441. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19442. err.backend_code = static_cast<uint64_t>(ssl_error);
  19443. impl::wolfssl_last_error() = err.backend_code;
  19444. return -1;
  19445. }
  19446. inline int pending(const_session_t session) {
  19447. if (!session) { return 0; }
  19448. auto wsession =
  19449. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19450. return wolfSSL_pending(wsession->ssl);
  19451. }
  19452. inline void shutdown(session_t session, bool graceful) {
  19453. if (!session) { return; }
  19454. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19455. if (graceful) {
  19456. int ret;
  19457. int attempts = 0;
  19458. while ((ret = wolfSSL_shutdown(wsession->ssl)) != SSL_SUCCESS &&
  19459. attempts < 3) {
  19460. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19461. if (ssl_error != SSL_ERROR_WANT_READ &&
  19462. ssl_error != SSL_ERROR_WANT_WRITE) {
  19463. break;
  19464. }
  19465. attempts++;
  19466. }
  19467. } else {
  19468. wolfSSL_shutdown(wsession->ssl);
  19469. }
  19470. }
  19471. inline bool is_peer_closed(session_t session, socket_t sock) {
  19472. if (!session || sock == INVALID_SOCKET) { return true; }
  19473. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19474. // Check if there's already decrypted data available
  19475. if (wolfSSL_pending(wsession->ssl) > 0) { return false; }
  19476. // Set socket to non-blocking to avoid blocking on read
  19477. detail::set_nonblocking(sock, true);
  19478. auto cleanup =
  19479. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19480. // Peek 1 byte to check connection status without consuming data
  19481. unsigned char buf;
  19482. int ret = wolfSSL_peek(wsession->ssl, &buf, 1);
  19483. // If we got data or WANT_READ (would block), connection is alive
  19484. if (ret > 0) { return false; }
  19485. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19486. if (ssl_error == SSL_ERROR_WANT_READ) { return false; }
  19487. return ssl_error == SSL_ERROR_ZERO_RETURN || ssl_error == SSL_ERROR_SYSCALL ||
  19488. ret == 0;
  19489. }
  19490. inline cert_t get_peer_cert(const_session_t session) {
  19491. if (!session) { return nullptr; }
  19492. auto wsession =
  19493. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19494. WOLFSSL_X509 *cert = wolfSSL_get_peer_certificate(wsession->ssl);
  19495. return static_cast<cert_t>(cert);
  19496. }
  19497. inline size_t get_peer_certs(const_session_t session,
  19498. std::vector<cert_t> &certs) {
  19499. certs.clear();
  19500. if (!session) { return 0; }
  19501. // wolfSSL keeps the received chain only when built with SESSION_CERTS
  19502. #ifdef SESSION_CERTS
  19503. auto wsession =
  19504. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19505. auto chain = wolfSSL_get_peer_chain(wsession->ssl);
  19506. auto count = chain ? wolfSSL_get_chain_count(chain) : 0;
  19507. for (int i = 0; i < count; i++) {
  19508. auto x509 = wolfSSL_get_chain_X509(chain, i);
  19509. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19510. }
  19511. #endif
  19512. return certs.size();
  19513. }
  19514. inline void free_cert(cert_t cert) {
  19515. if (cert) { wolfSSL_X509_free(static_cast<WOLFSSL_X509 *>(cert)); }
  19516. }
  19517. inline bool verify_hostname(cert_t cert, const char *hostname) {
  19518. if (!cert || !hostname) { return false; }
  19519. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19520. std::string host_str(hostname);
  19521. // Check if hostname is an IP address (IPv4 or IPv6)
  19522. unsigned char ip_bytes[16];
  19523. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  19524. auto is_ip = ip_len > 0;
  19525. // Check Subject Alternative Names
  19526. auto has_dns_san = false;
  19527. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  19528. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  19529. if (san_names) {
  19530. int san_count = wolfSSL_sk_num(san_names);
  19531. for (int i = 0; i < san_count; i++) {
  19532. auto *names =
  19533. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  19534. if (!names) continue;
  19535. if (!is_ip && names->type == WOLFSSL_GEN_DNS) {
  19536. // DNS name
  19537. has_dns_san = true;
  19538. unsigned char *dns_name = nullptr;
  19539. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, names->d.dNSName);
  19540. if (dns_name && dns_len > 0) {
  19541. std::string san_name(reinterpret_cast<char *>(dns_name),
  19542. static_cast<size_t>(dns_len));
  19543. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  19544. if (detail::match_hostname(san_name, host_str)) {
  19545. wolfSSL_sk_free(san_names);
  19546. return true;
  19547. }
  19548. }
  19549. } else if (is_ip && names->type == WOLFSSL_GEN_IPADD) {
  19550. // IP address: only an iPAddress SAN of the same family (4 bytes for
  19551. // IPv4, 16 bytes for IPv6) may authenticate the host.
  19552. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(names->d.iPAddress);
  19553. auto san_ip_len = wolfSSL_ASN1_STRING_length(names->d.iPAddress);
  19554. if (ip_data && san_ip_len == static_cast<int>(ip_len) &&
  19555. memcmp(ip_data, ip_bytes, ip_len) == 0) {
  19556. wolfSSL_sk_free(san_names);
  19557. return true;
  19558. }
  19559. }
  19560. }
  19561. wolfSSL_sk_free(san_names);
  19562. }
  19563. // Fallback: the Common Name (CN) in the subject, as X509_check_host does it:
  19564. // never for an IP host, which only an iPAddress SAN names, and never next to
  19565. // a DNS SAN (RFC 6125 6.4.4).
  19566. if (is_ip || has_dns_san) { return false; }
  19567. auto cn = get_cert_subject_cn(cert);
  19568. return !cn.empty() && detail::match_hostname(cn, host_str);
  19569. }
  19570. inline uint64_t hostname_mismatch_code() {
  19571. return static_cast<uint64_t>(DOMAIN_NAME_MISMATCH);
  19572. }
  19573. inline long get_verify_result(const_session_t session) {
  19574. if (!session) { return -1; }
  19575. auto wsession =
  19576. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19577. long result = wolfSSL_get_verify_result(wsession->ssl);
  19578. return result;
  19579. }
  19580. inline std::string get_cert_subject_cn(cert_t cert) {
  19581. if (!cert) return "";
  19582. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19583. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19584. if (!subject) return "";
  19585. char cn[256] = {};
  19586. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  19587. sizeof(cn));
  19588. if (cn_len <= 0) return "";
  19589. return std::string(cn, static_cast<size_t>(cn_len));
  19590. }
  19591. inline std::string get_cert_issuer_name(cert_t cert) {
  19592. if (!cert) return "";
  19593. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19594. WOLFSSL_X509_NAME *issuer = wolfSSL_X509_get_issuer_name(x509);
  19595. if (!issuer) return "";
  19596. char *name_str = wolfSSL_X509_NAME_oneline(issuer, nullptr, 0);
  19597. if (!name_str) return "";
  19598. std::string result(name_str);
  19599. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19600. return result;
  19601. }
  19602. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  19603. sans.clear();
  19604. if (!cert) return false;
  19605. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19606. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  19607. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  19608. if (!san_names) return true; // No SANs is not an error
  19609. int count = wolfSSL_sk_num(san_names);
  19610. for (int i = 0; i < count; i++) {
  19611. auto *name =
  19612. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  19613. if (!name) continue;
  19614. SanEntry entry;
  19615. switch (name->type) {
  19616. case WOLFSSL_GEN_DNS: {
  19617. entry.type = SanType::DNS;
  19618. unsigned char *dns_name = nullptr;
  19619. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, name->d.dNSName);
  19620. if (dns_name && dns_len > 0) {
  19621. entry.value = std::string(reinterpret_cast<char *>(dns_name),
  19622. static_cast<size_t>(dns_len));
  19623. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  19624. }
  19625. break;
  19626. }
  19627. case WOLFSSL_GEN_IPADD: {
  19628. entry.type = SanType::IP;
  19629. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(name->d.iPAddress);
  19630. int ip_len = wolfSSL_ASN1_STRING_length(name->d.iPAddress);
  19631. if (ip_data && ip_len == 4) {
  19632. char buf[16];
  19633. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", ip_data[0], ip_data[1],
  19634. ip_data[2], ip_data[3]);
  19635. entry.value = buf;
  19636. } else if (ip_data && ip_len == 16) {
  19637. char buf[64];
  19638. snprintf(buf, sizeof(buf),
  19639. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  19640. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  19641. ip_data[0], ip_data[1], ip_data[2], ip_data[3], ip_data[4],
  19642. ip_data[5], ip_data[6], ip_data[7], ip_data[8], ip_data[9],
  19643. ip_data[10], ip_data[11], ip_data[12], ip_data[13],
  19644. ip_data[14], ip_data[15]);
  19645. entry.value = buf;
  19646. }
  19647. break;
  19648. }
  19649. case WOLFSSL_GEN_EMAIL:
  19650. entry.type = SanType::EMAIL;
  19651. {
  19652. unsigned char *email = nullptr;
  19653. int email_len = wolfSSL_ASN1_STRING_to_UTF8(&email, name->d.rfc822Name);
  19654. if (email && email_len > 0) {
  19655. entry.value = std::string(reinterpret_cast<char *>(email),
  19656. static_cast<size_t>(email_len));
  19657. XFREE(email, nullptr, DYNAMIC_TYPE_OPENSSL);
  19658. }
  19659. }
  19660. break;
  19661. case WOLFSSL_GEN_URI:
  19662. entry.type = SanType::URI;
  19663. {
  19664. unsigned char *uri = nullptr;
  19665. int uri_len = wolfSSL_ASN1_STRING_to_UTF8(
  19666. &uri, name->d.uniformResourceIdentifier);
  19667. if (uri && uri_len > 0) {
  19668. entry.value = std::string(reinterpret_cast<char *>(uri),
  19669. static_cast<size_t>(uri_len));
  19670. XFREE(uri, nullptr, DYNAMIC_TYPE_OPENSSL);
  19671. }
  19672. }
  19673. break;
  19674. default: entry.type = SanType::OTHER; break;
  19675. }
  19676. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  19677. }
  19678. wolfSSL_sk_free(san_names);
  19679. return true;
  19680. }
  19681. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  19682. time_t &not_after) {
  19683. if (!cert) return false;
  19684. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19685. const WOLFSSL_ASN1_TIME *nb = wolfSSL_X509_get_notBefore(x509);
  19686. const WOLFSSL_ASN1_TIME *na = wolfSSL_X509_get_notAfter(x509);
  19687. if (!nb || !na) return false;
  19688. // wolfSSL_ASN1_TIME_to_tm is available
  19689. struct tm tm_nb = {}, tm_na = {};
  19690. if (wolfSSL_ASN1_TIME_to_tm(nb, &tm_nb) != WOLFSSL_SUCCESS) return false;
  19691. if (wolfSSL_ASN1_TIME_to_tm(na, &tm_na) != WOLFSSL_SUCCESS) return false;
  19692. #ifdef _WIN32
  19693. not_before = _mkgmtime(&tm_nb);
  19694. not_after = _mkgmtime(&tm_na);
  19695. #else
  19696. not_before = timegm(&tm_nb);
  19697. not_after = timegm(&tm_na);
  19698. #endif
  19699. return true;
  19700. }
  19701. inline std::string get_cert_serial(cert_t cert) {
  19702. if (!cert) return "";
  19703. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19704. WOLFSSL_ASN1_INTEGER *serial_asn1 = wolfSSL_X509_get_serialNumber(x509);
  19705. if (!serial_asn1) return "";
  19706. // Get the serial number data
  19707. int len = serial_asn1->length;
  19708. unsigned char *data = serial_asn1->data;
  19709. if (!data || len <= 0) return "";
  19710. std::string result;
  19711. result.reserve(static_cast<size_t>(len) * 2);
  19712. for (int i = 0; i < len; i++) {
  19713. char hex[3];
  19714. snprintf(hex, sizeof(hex), "%02X", data[i]);
  19715. result += hex;
  19716. }
  19717. return result;
  19718. }
  19719. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  19720. if (!cert) return false;
  19721. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19722. int der_len = 0;
  19723. const unsigned char *der_data = wolfSSL_X509_get_der(x509, &der_len);
  19724. if (!der_data || der_len <= 0) return false;
  19725. der.assign(der_data, der_data + der_len);
  19726. return true;
  19727. }
  19728. inline const char *get_sni(const_session_t session) {
  19729. if (!session) return nullptr;
  19730. auto wsession = static_cast<const impl::WolfSSLSession *>(session);
  19731. // For server: return SNI received from client during handshake
  19732. if (!wsession->sni_hostname.empty()) {
  19733. return wsession->sni_hostname.c_str();
  19734. }
  19735. // For client: return the hostname set via set_sni
  19736. if (!wsession->hostname.empty()) { return wsession->hostname.c_str(); }
  19737. return nullptr;
  19738. }
  19739. inline uint64_t peek_error() {
  19740. return static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19741. }
  19742. inline uint64_t get_error() {
  19743. uint64_t err = impl::wolfssl_last_error();
  19744. impl::wolfssl_last_error() = 0;
  19745. return err;
  19746. }
  19747. inline std::string error_string(uint64_t code) {
  19748. char buf[256];
  19749. wolfSSL_ERR_error_string(static_cast<unsigned long>(code), buf);
  19750. return std::string(buf);
  19751. }
  19752. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  19753. if (!pem || len == 0) { return nullptr; }
  19754. // Validate by attempting to load into a temporary ctx
  19755. WOLFSSL_CTX *tmp_ctx = wolfSSL_CTX_new(wolfTLSv1_2_client_method());
  19756. if (!tmp_ctx) { return nullptr; }
  19757. int ret = wolfSSL_CTX_load_verify_buffer(
  19758. tmp_ctx, reinterpret_cast<const unsigned char *>(pem),
  19759. static_cast<long>(len), SSL_FILETYPE_PEM);
  19760. wolfSSL_CTX_free(tmp_ctx);
  19761. if (ret != SSL_SUCCESS) { return nullptr; }
  19762. return static_cast<ca_store_t>(
  19763. new impl::WolfSSLCAStore{std::string(pem, len)});
  19764. }
  19765. inline void free_ca_store(ca_store_t store) {
  19766. delete static_cast<impl::WolfSSLCAStore *>(store);
  19767. }
  19768. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  19769. if (!ctx || !store) { return false; }
  19770. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19771. auto *ca = static_cast<impl::WolfSSLCAStore *>(store);
  19772. int ret = wolfSSL_CTX_load_verify_buffer(
  19773. wctx->ctx, reinterpret_cast<const unsigned char *>(ca->pem_data.data()),
  19774. static_cast<long>(ca->pem_data.size()), SSL_FILETYPE_PEM);
  19775. if (ret == SSL_SUCCESS) { wctx->ca_pem_data_ += ca->pem_data; }
  19776. // This function takes ownership of the store; the PEM data was copied into
  19777. // the context, so release the source
  19778. free_ca_store(store);
  19779. return ret == SSL_SUCCESS;
  19780. }
  19781. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  19782. certs.clear();
  19783. if (!ctx) { return 0; }
  19784. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19785. if (wctx->ca_pem_data_.empty()) { return 0; }
  19786. const std::string &pem = wctx->ca_pem_data_;
  19787. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19788. const std::string end_marker = "-----END CERTIFICATE-----";
  19789. size_t pos = 0;
  19790. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19791. size_t end_pos = pem.find(end_marker, pos);
  19792. if (end_pos == std::string::npos) { break; }
  19793. end_pos += end_marker.size();
  19794. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19795. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19796. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19797. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19798. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19799. pos = end_pos;
  19800. }
  19801. return certs.size();
  19802. }
  19803. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  19804. std::vector<std::string> names;
  19805. if (!ctx) { return names; }
  19806. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19807. if (wctx->ca_pem_data_.empty()) { return names; }
  19808. const std::string &pem = wctx->ca_pem_data_;
  19809. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19810. const std::string end_marker = "-----END CERTIFICATE-----";
  19811. size_t pos = 0;
  19812. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19813. size_t end_pos = pem.find(end_marker, pos);
  19814. if (end_pos == std::string::npos) { break; }
  19815. end_pos += end_marker.size();
  19816. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19817. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19818. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19819. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19820. if (x509) {
  19821. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19822. if (subject) {
  19823. char *name_str = wolfSSL_X509_NAME_oneline(subject, nullptr, 0);
  19824. if (name_str) {
  19825. names.push_back(name_str);
  19826. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19827. }
  19828. }
  19829. wolfSSL_X509_free(x509);
  19830. }
  19831. pos = end_pos;
  19832. }
  19833. return names;
  19834. }
  19835. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  19836. const char *key_pem, const char *password) {
  19837. if (!ctx || !cert_pem || !key_pem) { return false; }
  19838. // Try the pair on a scratch context first, so that a bad one leaves the
  19839. // server's certificate and key as they were
  19840. auto tmp = create_server_context();
  19841. if (!tmp) { return false; }
  19842. auto se = detail::scope_exit([&] { free_context(tmp); });
  19843. if (!set_client_cert_pem(tmp, cert_pem, key_pem, password)) { return false; }
  19844. return set_client_cert_pem(ctx, cert_pem, key_pem, password);
  19845. }
  19846. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  19847. if (!ctx || !ca_pem) { return false; }
  19848. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19849. // Replace the CAs rather than add to them, as the other backends do, once
  19850. // the new ones are known to load
  19851. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  19852. if (!store) { return false; }
  19853. free_ca_store(store);
  19854. wolfSSL_CTX_UnloadCAs(wctx->ctx);
  19855. wctx->ca_pem_data_.clear();
  19856. return load_ca_pem(ctx, ca_pem, strlen(ca_pem));
  19857. }
  19858. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  19859. if (!ctx) { return false; }
  19860. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19861. auto stored = callback ? std::make_shared<VerifyCallback>(std::move(callback))
  19862. : nullptr;
  19863. {
  19864. std::lock_guard<std::mutex> guard(impl::verify_callback_mutex());
  19865. // A handshake running the previous callback keeps it until it returns.
  19866. wctx->verify_callback.swap(stored);
  19867. }
  19868. impl::apply_verify_mode(*wctx);
  19869. return true;
  19870. }
  19871. inline long get_verify_error(const_session_t session) {
  19872. if (!session) { return -1; }
  19873. auto *wsession =
  19874. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19875. return wolfSSL_get_verify_result(wsession->ssl);
  19876. }
  19877. inline std::string verify_error_string(long error_code) {
  19878. if (error_code == 0) { return ""; }
  19879. const char *str =
  19880. wolfSSL_X509_verify_cert_error_string(static_cast<int>(error_code));
  19881. return str ? std::string(str) : std::string();
  19882. }
  19883. } // namespace tls
  19884. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  19885. // WebSocket implementation
  19886. namespace ws {
  19887. inline bool WebSocket::send_frame(Opcode op, const char *data, size_t len,
  19888. bool fin) {
  19889. std::lock_guard<std::mutex> lock(write_mutex_);
  19890. if (closed_) { return false; }
  19891. return detail::write_websocket_frame(strm_, op, data, len, fin, !is_server_);
  19892. }
  19893. inline ReadResult WebSocket::read(std::string &msg) {
  19894. // Answers a control frame; any other opcode here is a protocol error.
  19895. // Returns false when the connection is done.
  19896. auto handle_control = [&](Opcode op, const std::string &payload) -> bool {
  19897. switch (op) {
  19898. case Opcode::Ping: {
  19899. std::lock_guard<std::mutex> lock(write_mutex_);
  19900. detail::write_websocket_frame(strm_, Opcode::Pong, payload.data(),
  19901. payload.size(), true, !is_server_);
  19902. return true;
  19903. }
  19904. case Opcode::Pong: {
  19905. std::lock_guard<std::mutex> lock(ping_mutex_);
  19906. unacked_pings_ = 0;
  19907. return true;
  19908. }
  19909. case Opcode::Close: {
  19910. // RFC 6455 §5.5.1: a Close is echoed back, unless its payload is
  19911. // malformed, which is answered with a protocol error instead.
  19912. if (closed_.exchange(true)) { return false; }
  19913. auto reply = payload;
  19914. if (!impl::is_valid_close_payload(payload)) {
  19915. auto code = static_cast<uint16_t>(CloseStatus::ProtocolError);
  19916. reply = {static_cast<char>(code >> 8), static_cast<char>(code & 0xff)};
  19917. }
  19918. std::lock_guard<std::mutex> lock(write_mutex_);
  19919. detail::write_websocket_frame(strm_, Opcode::Close, reply.data(),
  19920. reply.size(), true, !is_server_);
  19921. return false;
  19922. }
  19923. default: closed_ = true; return false;
  19924. }
  19925. };
  19926. std::unique_lock<std::mutex> read_lock(read_mutex_);
  19927. while (!closed_) {
  19928. Opcode opcode;
  19929. std::string payload;
  19930. bool fin;
  19931. impl::FrameRead r =
  19932. impl::read_websocket_frame(strm_, opcode, payload, fin, is_server_,
  19933. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH);
  19934. // A timeout landed on a frame boundary: the connection is untouched and
  19935. // still usable, so hand control back without closing it. That is only
  19936. // useful to a caller who asked for the timeout; the compile-time default
  19937. // is a backstop against a peer gone quiet, and elapsing it closes the
  19938. // connection so a plain `while (ws.read(msg))` loop ends.
  19939. if (r == impl::FrameRead::Timeout && read_timeout_set_) { return Timeout; }
  19940. if (r != impl::FrameRead::Ok) {
  19941. closed_ = true;
  19942. return Fail;
  19943. }
  19944. switch (opcode) {
  19945. case Opcode::Text:
  19946. case Opcode::Binary: {
  19947. auto result = opcode == Opcode::Text ? Text : Binary;
  19948. msg = std::move(payload);
  19949. // Handle fragmentation
  19950. if (!fin) {
  19951. while (true) {
  19952. Opcode cont_opcode;
  19953. std::string cont_payload;
  19954. bool cont_fin;
  19955. // Only what is left of the limit, but room for a control frame,
  19956. // which may come between the fragments.
  19957. auto max_len =
  19958. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH == 0
  19959. ? size_t(0)
  19960. : (std::max)(size_t(125),
  19961. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH -
  19962. msg.size());
  19963. // A timeout is not reportable here: half of a fragmented message is
  19964. // already in `msg` and read() has no way to resume it, so it is a
  19965. // failure like any other. Timeouts are only ever seen on a message
  19966. // boundary.
  19967. if (impl::read_websocket_frame(strm_, cont_opcode, cont_payload,
  19968. cont_fin, is_server_,
  19969. max_len) != impl::FrameRead::Ok) {
  19970. closed_ = true;
  19971. return Fail;
  19972. }
  19973. // RFC 6455 5.4: the fragments are continuation frames, with only
  19974. // control frames between them.
  19975. if (cont_opcode != Opcode::Continuation) {
  19976. if (handle_control(cont_opcode, cont_payload)) { continue; }
  19977. return Fail;
  19978. }
  19979. msg += cont_payload;
  19980. if (CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH > 0 &&
  19981. msg.size() > CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) {
  19982. closed_ = true;
  19983. return Fail;
  19984. }
  19985. if (cont_fin) { break; }
  19986. }
  19987. }
  19988. // RFC 6455 Section 5.6: text frames must contain valid UTF-8
  19989. if (result == Text && !impl::is_valid_utf8(msg)) {
  19990. // close() takes the read lock to wait for the peer's Close reply, so
  19991. // it must not run while this thread still holds it.
  19992. read_lock.unlock();
  19993. close(CloseStatus::InvalidPayload, "invalid UTF-8");
  19994. return Fail;
  19995. }
  19996. return result;
  19997. }
  19998. default:
  19999. if (handle_control(opcode, payload)) { continue; }
  20000. return Fail;
  20001. }
  20002. }
  20003. return Fail;
  20004. }
  20005. inline bool WebSocket::send(const std::string &data) {
  20006. return send_frame(Opcode::Text, data.data(), data.size());
  20007. }
  20008. inline bool WebSocket::send(const char *data, size_t len) {
  20009. return send_frame(Opcode::Binary, data, len);
  20010. }
  20011. inline void WebSocket::close(CloseStatus status, const std::string &reason) {
  20012. if (closed_.exchange(true)) { return; }
  20013. ping_cv_.notify_all();
  20014. std::string payload;
  20015. auto code = static_cast<uint16_t>(status);
  20016. payload.push_back(static_cast<char>((code >> 8) & 0xFF));
  20017. payload.push_back(static_cast<char>(code & 0xFF));
  20018. // RFC 6455 Section 5.5: control frame payload must not exceed 125 bytes
  20019. // Close frame has 2-byte status code, so reason is limited to 123 bytes,
  20020. // cut back to a whole UTF-8 character
  20021. auto short_reason = reason.substr(0, 123);
  20022. while (!short_reason.empty() && !impl::is_valid_utf8(short_reason)) {
  20023. short_reason.pop_back();
  20024. }
  20025. payload += short_reason;
  20026. // A code that may not be sent, such as NoStatus, goes without a payload
  20027. if (!impl::is_valid_close_payload(payload)) { payload.clear(); }
  20028. {
  20029. std::lock_guard<std::mutex> lock(write_mutex_);
  20030. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  20031. payload.size(), true, !is_server_);
  20032. }
  20033. // RFC 6455 Section 7.1.1: after sending a Close frame, wait for the peer's
  20034. // Close response before closing the TCP connection.
  20035. //
  20036. // Wait only when no other thread is parsing frames. When one is, it is the
  20037. // thread positioned to see the peer's reply, and reading here would take
  20038. // bytes out of the message it is assembling. Bailing out also leaves the
  20039. // stream, including its read timeout, entirely to that thread.
  20040. std::unique_lock<std::mutex> read_lock(read_mutex_, std::try_to_lock);
  20041. if (!read_lock.owns_lock()) { return; }
  20042. // Use a short timeout to avoid hanging if the peer doesn't respond.
  20043. strm_.set_read_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  20044. Opcode op;
  20045. std::string resp;
  20046. bool fin;
  20047. while (impl::read_websocket_frame(strm_, op, resp, fin, is_server_, 125) ==
  20048. impl::FrameRead::Ok) {
  20049. if (op == Opcode::Close) { break; }
  20050. }
  20051. }
  20052. inline WebSocket::~WebSocket() {
  20053. {
  20054. std::lock_guard<std::mutex> lock(ping_mutex_);
  20055. closed_ = true;
  20056. }
  20057. ping_cv_.notify_all();
  20058. if (ping_thread_.joinable()) { ping_thread_.join(); }
  20059. }
  20060. inline void WebSocket::start_heartbeat() {
  20061. if (ping_interval_sec_ <= 0) { return; }
  20062. ping_thread_ = std::thread([this]() {
  20063. std::unique_lock<std::mutex> lock(ping_mutex_);
  20064. // The predicate keeps a spurious wakeup from sending a ping early
  20065. while (!ping_cv_.wait_for(lock, std::chrono::seconds(ping_interval_sec_),
  20066. [this]() { return closed_.load(); })) {
  20067. // If the peer has failed to respond to the previous pings, give up.
  20068. // RFC 6455 does not define a pong-timeout mechanism; this is an
  20069. // opt-in liveness check controlled by max_missed_pongs_.
  20070. if (max_missed_pongs_ > 0 && unacked_pings_ >= max_missed_pongs_) {
  20071. lock.unlock();
  20072. close(CloseStatus::GoingAway, "pong timeout");
  20073. // Wake a read() blocked on the unresponsive peer. Only the read side
  20074. // is shut down: a TLS backend answers the EOF with an alert, and
  20075. // writing it to a socket closed for writing raises SIGPIPE.
  20076. #ifdef _WIN32
  20077. shutdown(strm_.socket(), SD_RECEIVE);
  20078. #else
  20079. shutdown(strm_.socket(), SHUT_RD);
  20080. #endif
  20081. return;
  20082. }
  20083. lock.unlock();
  20084. if (!send_frame(Opcode::Ping, nullptr, 0)) {
  20085. lock.lock();
  20086. closed_ = true;
  20087. break;
  20088. }
  20089. lock.lock();
  20090. unacked_pings_++;
  20091. }
  20092. });
  20093. }
  20094. inline const Request &WebSocket::request() const { return req_; }
  20095. inline bool WebSocket::is_open() const { return !closed_; }
  20096. inline void WebSocket::set_read_timeout(time_t sec, time_t usec) {
  20097. // 0 waits forever here, as it does for SO_RCVTIMEO. The stream waits with
  20098. // poll(), where 0 would instead mean "return immediately", so hand it the
  20099. // negative poll uses for an unbounded wait.
  20100. if (sec == 0 && usec == 0) { sec = -1; }
  20101. strm_.set_read_timeout(sec, usec);
  20102. read_timeout_set_ = true;
  20103. }
  20104. // WebSocketClient implementation
  20105. inline WebSocketClient::WebSocketClient(
  20106. const std::string &scheme_host_port_path, const Headers &headers)
  20107. : headers_(headers) {
  20108. detail::UrlComponents uc;
  20109. if (detail::parse_url(scheme_host_port_path, uc) && !uc.scheme.empty() &&
  20110. !uc.host.empty() && !uc.path.empty()) {
  20111. auto &scheme = uc.scheme;
  20112. #ifdef CPPHTTPLIB_SSL_ENABLED
  20113. if (scheme != "ws" && scheme != "wss") {
  20114. #else
  20115. if (scheme != "ws") {
  20116. #endif
  20117. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  20118. std::string msg = "'" + scheme + "' scheme is not supported.";
  20119. throw std::invalid_argument(msg);
  20120. #endif
  20121. return;
  20122. }
  20123. auto is_ssl = scheme == "wss";
  20124. host_ = std::move(uc.host);
  20125. port_ = is_ssl ? 443 : 80;
  20126. if (!uc.port.empty() && !detail::parse_port(uc.port, port_)) { return; }
  20127. path_ = std::move(uc.path);
  20128. if (!uc.query.empty()) { path_ += uc.query; }
  20129. #ifdef CPPHTTPLIB_SSL_ENABLED
  20130. is_ssl_ = is_ssl;
  20131. if (is_ssl_) {
  20132. // The context lives as long as the client so that CA configuration
  20133. // survives reconnects; sessions are created per connection.
  20134. tls_ctx_ = tls::create_client_context();
  20135. if (!tls_ctx_) { return; }
  20136. }
  20137. #else
  20138. if (is_ssl) { return; }
  20139. #endif
  20140. is_valid_ = true;
  20141. }
  20142. }
  20143. #ifdef CPPHTTPLIB_SSL_ENABLED
  20144. inline WebSocketClient::WebSocketClient(
  20145. const std::string &scheme_host_port_path, const PemMemory &pem,
  20146. const Headers &headers)
  20147. : WebSocketClient(scheme_host_port_path, headers) {
  20148. // For ws:// URLs the client certificate is silently ignored, consistent
  20149. // with the TLS-only setters such as set_ca_cert_path().
  20150. if (is_valid_ && is_ssl_ && pem.cert_pem && pem.key_pem) {
  20151. std::string cert_buf, key_buf;
  20152. if (!tls::set_client_cert_pem(
  20153. tls_ctx_,
  20154. detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  20155. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  20156. pem.private_key_password)) {
  20157. tls::free_context(tls_ctx_);
  20158. tls_ctx_ = nullptr;
  20159. is_valid_ = false;
  20160. }
  20161. }
  20162. }
  20163. #endif
  20164. inline WebSocketClient::~WebSocketClient() {
  20165. shutdown_and_close();
  20166. #ifdef CPPHTTPLIB_SSL_ENABLED
  20167. if (tls_ctx_) {
  20168. tls::free_context(tls_ctx_);
  20169. tls_ctx_ = nullptr;
  20170. }
  20171. #endif
  20172. }
  20173. inline bool WebSocketClient::is_valid() const { return is_valid_; }
  20174. inline void WebSocketClient::shutdown_and_close() {
  20175. // Send the close frame while the TLS session is still alive: ws_ holds an
  20176. // SSLSocketStream that keeps a raw pointer to tls_session_, so the session
  20177. // must outlive ws_->close() and ws_.reset() to avoid a use-after-free.
  20178. if (ws_ && ws_->is_open()) { ws_->close(); }
  20179. ws_.reset();
  20180. #ifdef CPPHTTPLIB_SSL_ENABLED
  20181. if (is_ssl_) {
  20182. if (tls_session_) {
  20183. tls::shutdown(tls_session_, true);
  20184. tls::free_session(tls_session_);
  20185. tls_session_ = nullptr;
  20186. }
  20187. }
  20188. #endif
  20189. if (sock_ != INVALID_SOCKET) {
  20190. detail::shutdown_socket(sock_);
  20191. detail::close_socket(sock_);
  20192. sock_ = INVALID_SOCKET;
  20193. }
  20194. }
  20195. // The handshakes belong to establishing the connection, so an unset read
  20196. // timeout leaves them bounded by the connection timeout instead of forever.
  20197. inline std::pair<time_t, time_t> WebSocketClient::handshake_timeout() const {
  20198. if (read_timeout_sec_ == 0 && read_timeout_usec_ == 0) {
  20199. return {connection_timeout_sec_, connection_timeout_usec_};
  20200. }
  20201. return {read_timeout_sec_, read_timeout_usec_};
  20202. }
  20203. inline bool WebSocketClient::create_stream(std::unique_ptr<Stream> &strm,
  20204. Error &error, int &ssl_error,
  20205. uint64_t &ssl_backend_error) {
  20206. // A read timeout of 0 means "wait forever", the way SO_RCVTIMEO reads it.
  20207. // The streams wait with poll(), where 0 instead means "return immediately",
  20208. // so they are given the negative poll uses for an unbounded wait.
  20209. auto unbounded = read_timeout_sec_ == 0 && read_timeout_usec_ == 0;
  20210. time_t strm_read_sec = unbounded ? -1 : read_timeout_sec_;
  20211. time_t strm_read_usec = unbounded ? 0 : read_timeout_usec_;
  20212. #ifdef CPPHTTPLIB_SSL_ENABLED
  20213. if (is_ssl_) {
  20214. // A plain flag rather than SSLClient::load_certs()'s call_once: connect()
  20215. // is not safe to call concurrently on one client to begin with, since
  20216. // nothing else here is guarded either.
  20217. if (server_certificate_verification_ && !certs_loaded_) {
  20218. uint64_t backend_error = 0;
  20219. detail::load_client_ca_config(tls_ctx_, ca_cert_file_path_,
  20220. ca_cert_dir_path_, custom_ca_loaded_,
  20221. system_ca_mode_, backend_error);
  20222. certs_loaded_ = true;
  20223. }
  20224. detail::ClientTlsSessionOptions options;
  20225. options.server_hostname_verification = server_hostname_verification_;
  20226. options.session_verifier = session_verifier_;
  20227. auto timeout = handshake_timeout();
  20228. detail::ClientTlsSessionError tls_error;
  20229. if (!detail::setup_client_tls_session(host_, tls_ctx_, tls_session_, sock_,
  20230. server_certificate_verification_,
  20231. timeout.first, timeout.second,
  20232. &tls_error, options)) {
  20233. error = tls_error.error;
  20234. ssl_error = tls_error.ssl_error;
  20235. ssl_backend_error = tls_error.backend_error;
  20236. return false;
  20237. }
  20238. strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  20239. sock_, tls_session_, strm_read_sec, strm_read_usec, write_timeout_sec_,
  20240. write_timeout_usec_));
  20241. return true;
  20242. }
  20243. #else
  20244. (void)error;
  20245. (void)ssl_error;
  20246. (void)ssl_backend_error;
  20247. #endif
  20248. strm = std::unique_ptr<Stream>(
  20249. new detail::SocketStream(sock_, strm_read_sec, strm_read_usec,
  20250. write_timeout_sec_, write_timeout_usec_));
  20251. return true;
  20252. }
  20253. inline void WebSocketClient::prepare_default_headers(Request &req) {
  20254. #ifdef CPPHTTPLIB_SSL_ENABLED
  20255. auto is_ssl = is_ssl_;
  20256. #else
  20257. auto is_ssl = false;
  20258. #endif
  20259. if (!req.has_header("Host")) {
  20260. req.headers.emplace("Host", detail::make_default_host_header_value(
  20261. host_, port_, is_ssl, address_family_));
  20262. }
  20263. detail::add_default_user_agent_header(req);
  20264. }
  20265. inline Result WebSocketClient::connect() {
  20266. if (!is_valid_) { return Result{Error::Connection, -1, Headers{}}; }
  20267. shutdown_and_close();
  20268. auto error = Error::Success;
  20269. if (!create_and_connect_socket(error)) {
  20270. return Result{error, -1, Headers{}};
  20271. }
  20272. if (is_proxy_enabled()) {
  20273. Response proxy_res;
  20274. if (!connect_with_proxy(proxy_res, error)) {
  20275. shutdown_and_close();
  20276. return Result{error, proxy_res.status, std::move(proxy_res.headers)};
  20277. }
  20278. }
  20279. std::unique_ptr<Stream> strm;
  20280. auto stream_error = Error::SSLConnection;
  20281. int ssl_error = 0;
  20282. uint64_t ssl_backend_error = 0;
  20283. if (!create_stream(strm, stream_error, ssl_error, ssl_backend_error)) {
  20284. shutdown_and_close();
  20285. #ifdef CPPHTTPLIB_SSL_ENABLED
  20286. return Result{stream_error, -1, Headers{}, ssl_error, ssl_backend_error};
  20287. #else
  20288. return Result{stream_error, -1, Headers{}};
  20289. #endif
  20290. }
  20291. Request req;
  20292. req.method = "GET";
  20293. req.path = path_;
  20294. req.headers = headers_;
  20295. prepare_default_headers(req);
  20296. detail::WebSocketUpgradeResponse upgrade;
  20297. if (!detail::perform_websocket_handshake(*strm, req, upgrade)) {
  20298. shutdown_and_close();
  20299. return Result{upgrade.error, upgrade.status, std::move(upgrade.headers)};
  20300. }
  20301. subprotocol_ = std::move(upgrade.selected_subprotocol);
  20302. ws_ = std::unique_ptr<WebSocket>(new WebSocket(std::move(strm), req, false,
  20303. websocket_ping_interval_sec_,
  20304. websocket_max_missed_pongs_));
  20305. // The stream was created with the timeout already; tell the WebSocket
  20306. // whether it came from the caller, so read() knows to report it as Timeout.
  20307. ws_->read_timeout_set_ = read_timeout_set_;
  20308. return Result{Error::Success, upgrade.status, std::move(upgrade.headers)};
  20309. }
  20310. inline ReadResult WebSocketClient::read(std::string &msg) {
  20311. if (!ws_) { return Fail; }
  20312. return ws_->read(msg);
  20313. }
  20314. inline bool WebSocketClient::send(const std::string &data) {
  20315. if (!ws_) { return false; }
  20316. return ws_->send(data);
  20317. }
  20318. inline bool WebSocketClient::send(const char *data, size_t len) {
  20319. if (!ws_) { return false; }
  20320. return ws_->send(data, len);
  20321. }
  20322. inline void WebSocketClient::close(CloseStatus status,
  20323. const std::string &reason) {
  20324. if (ws_) { ws_->close(status, reason); }
  20325. }
  20326. inline bool WebSocketClient::is_open() const { return ws_ && ws_->is_open(); }
  20327. inline const std::string &WebSocketClient::subprotocol() const {
  20328. return subprotocol_;
  20329. }
  20330. inline void WebSocketClient::set_read_timeout(time_t sec, time_t usec) {
  20331. read_timeout_sec_ = sec;
  20332. read_timeout_usec_ = usec;
  20333. read_timeout_set_ = true;
  20334. // The members above only seed the next connect(); read() consults the
  20335. // stream, so an already-open connection has to be told directly.
  20336. if (ws_) { ws_->set_read_timeout(sec, usec); }
  20337. }
  20338. inline void WebSocketClient::set_write_timeout(time_t sec, time_t usec) {
  20339. write_timeout_sec_ = sec;
  20340. write_timeout_usec_ = usec;
  20341. }
  20342. inline void WebSocketClient::set_websocket_ping_interval(time_t sec) {
  20343. websocket_ping_interval_sec_ = sec;
  20344. }
  20345. inline void WebSocketClient::set_websocket_max_missed_pongs(int count) {
  20346. websocket_max_missed_pongs_ = count;
  20347. }
  20348. inline void WebSocketClient::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  20349. inline void WebSocketClient::set_address_family(int family) {
  20350. address_family_ = family;
  20351. }
  20352. inline void WebSocketClient::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  20353. inline void WebSocketClient::set_socket_options(SocketOptions socket_options) {
  20354. socket_options_ = std::move(socket_options);
  20355. }
  20356. inline void WebSocketClient::set_connection_timeout(time_t sec, time_t usec) {
  20357. connection_timeout_sec_ = sec;
  20358. connection_timeout_usec_ = usec;
  20359. }
  20360. inline void WebSocketClient::set_interface(const std::string &intf) {
  20361. interface_ = intf;
  20362. }
  20363. inline void WebSocketClient::set_hostname_addr_map(
  20364. std::map<std::string, std::string> addr_map) {
  20365. addr_map_ = std::move(addr_map);
  20366. }
  20367. inline bool WebSocketClient::is_proxy_enabled() const {
  20368. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  20369. if (no_proxy_entries_.empty()) { return true; }
  20370. return !detail::host_matches_no_proxy(detail::normalize_target(host_),
  20371. no_proxy_entries_);
  20372. }
  20373. inline bool WebSocketClient::create_and_connect_socket(Error &error) {
  20374. std::string connect_host;
  20375. std::string ip;
  20376. auto port = port_;
  20377. if (is_proxy_enabled()) {
  20378. connect_host = proxy_host_;
  20379. port = proxy_port_;
  20380. } else {
  20381. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  20382. }
  20383. sock_ = detail::create_client_socket(
  20384. connect_host, ip, port, address_family_, tcp_nodelay_, ipv6_v6only_,
  20385. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  20386. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  20387. write_timeout_usec_, interface_, error);
  20388. if (sock_ != INVALID_SOCKET) { return true; }
  20389. if (error == Error::Success) { error = Error::Connection; }
  20390. return false;
  20391. }
  20392. inline bool WebSocketClient::send_proxy_connect(Request &req,
  20393. Response &proxy_res,
  20394. Error &error) {
  20395. auto timeout = handshake_timeout();
  20396. detail::SocketStream strm(sock_, timeout.first, timeout.second,
  20397. write_timeout_sec_, write_timeout_usec_);
  20398. if (!detail::write_request_head(strm, req, error)) { return false; }
  20399. if (!detail::read_response_head(strm, proxy_res.status, proxy_res.headers)) {
  20400. error = Error::Read;
  20401. return false;
  20402. }
  20403. return true;
  20404. }
  20405. // RFC 6455 4.1: ws:// is tunnelled with CONNECT as well, since a proxy need not
  20406. // forward an Upgrade request.
  20407. inline bool WebSocketClient::connect_with_proxy(Response &proxy_res,
  20408. Error &error) {
  20409. Request req;
  20410. req.method = "CONNECT";
  20411. req.path = detail::make_host_and_port_string_always_port(host_, port_);
  20412. req.headers.emplace("Host", req.path);
  20413. detail::add_default_user_agent_header(req);
  20414. detail::add_authorization_header(req, proxy_basic_auth_username_,
  20415. proxy_basic_auth_password_,
  20416. proxy_bearer_token_auth_token_, true);
  20417. if (!send_proxy_connect(req, proxy_res, error)) { return false; }
  20418. #ifdef CPPHTTPLIB_SSL_ENABLED
  20419. // A Digest challenge gets one retry on a fresh connection, like SSLClient.
  20420. std::map<std::string, std::string> auth;
  20421. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407 &&
  20422. !proxy_digest_auth_username_.empty() &&
  20423. !proxy_digest_auth_password_.empty() &&
  20424. detail::parse_www_authenticate(proxy_res, auth, true)) {
  20425. proxy_res = Response();
  20426. shutdown_and_close();
  20427. if (!create_and_connect_socket(error)) { return false; }
  20428. req.headers.erase("Proxy-Authorization");
  20429. req.headers.insert(detail::make_digest_authentication_header(
  20430. req, req.path, auth, 1, detail::random_string(10),
  20431. proxy_digest_auth_username_, proxy_digest_auth_password_, true));
  20432. if (!send_proxy_connect(req, proxy_res, error)) { return false; }
  20433. }
  20434. #endif
  20435. if (proxy_res.status != StatusCode::OK_200) {
  20436. error = Error::ProxyConnection;
  20437. return false;
  20438. }
  20439. return true;
  20440. }
  20441. inline void WebSocketClient::set_proxy(const std::string &host, int port) {
  20442. proxy_host_ = host;
  20443. proxy_port_ = port;
  20444. }
  20445. inline void WebSocketClient::set_proxy_basic_auth(const std::string &username,
  20446. const std::string &password) {
  20447. proxy_basic_auth_username_ = username;
  20448. proxy_basic_auth_password_ = password;
  20449. }
  20450. inline void
  20451. WebSocketClient::set_proxy_bearer_token_auth(const std::string &token) {
  20452. proxy_bearer_token_auth_token_ = token;
  20453. }
  20454. inline void
  20455. WebSocketClient::set_no_proxy(const std::vector<std::string> &patterns) {
  20456. no_proxy_entries_ = detail::parse_no_proxy_entries(patterns);
  20457. }
  20458. #ifdef CPPHTTPLIB_SSL_ENABLED
  20459. inline void
  20460. WebSocketClient::set_ca_cert_path(const std::string &ca_cert_file_path,
  20461. const std::string &ca_cert_dir_path) {
  20462. ca_cert_file_path_ = ca_cert_file_path;
  20463. ca_cert_dir_path_ = ca_cert_dir_path;
  20464. }
  20465. inline void
  20466. WebSocketClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  20467. if (tls_ctx_) { tls::set_verify_callback(tls_ctx_, std::move(verifier)); }
  20468. }
  20469. inline void WebSocketClient::set_session_verifier(
  20470. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  20471. session_verifier_ = std::move(verifier);
  20472. }
  20473. inline void WebSocketClient::set_ca_cert_store(tls::ca_store_t store) {
  20474. if (store && tls_ctx_) {
  20475. // set_ca_store takes ownership of store
  20476. tls::set_ca_store(tls_ctx_, store);
  20477. custom_ca_loaded_ = true;
  20478. } else if (store) {
  20479. tls::free_ca_store(store);
  20480. }
  20481. }
  20482. inline void WebSocketClient::load_ca_cert_store(const char *ca_cert,
  20483. std::size_t size) {
  20484. if (tls_ctx_ && ca_cert && size > 0) {
  20485. tls::load_ca_pem(tls_ctx_, ca_cert, size);
  20486. custom_ca_loaded_ = true;
  20487. }
  20488. }
  20489. inline void
  20490. WebSocketClient::enable_server_certificate_verification(bool enabled) {
  20491. server_certificate_verification_ = enabled;
  20492. }
  20493. inline void WebSocketClient::enable_server_hostname_verification(bool enabled) {
  20494. server_hostname_verification_ = enabled;
  20495. }
  20496. inline void WebSocketClient::enable_system_ca(bool enabled) {
  20497. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  20498. }
  20499. inline void
  20500. WebSocketClient::set_proxy_digest_auth(const std::string &username,
  20501. const std::string &password) {
  20502. proxy_digest_auth_username_ = username;
  20503. proxy_digest_auth_password_ = password;
  20504. }
  20505. #endif // CPPHTTPLIB_SSL_ENABLED
  20506. } // namespace ws
  20507. // ----------------------------------------------------------------------------
  20508. } // namespace httplib
  20509. #endif // CPPHTTPLIB_HTTPLIB_H