httplib.h 830 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845128461284712848128491285012851128521285312854128551285612857128581285912860128611286212863128641286512866128671286812869128701287112872128731287412875128761287712878128791288012881128821288312884128851288612887128881288912890128911289212893128941289512896128971289812899129001290112902129031290412905129061290712908129091291012911129121291312914129151291612917129181291912920129211292212923129241292512926129271292812929129301293112932129331293412935129361293712938129391294012941129421294312944129451294612947129481294912950129511295212953129541295512956129571295812959129601296112962129631296412965129661296712968129691297012971129721297312974129751297612977129781297912980129811298212983129841298512986129871298812989129901299112992129931299412995129961299712998129991300013001130021300313004130051300613007130081300913010130111301213013130141301513016130171301813019130201302113022130231302413025130261302713028130291303013031130321303313034130351303613037130381303913040130411304213043130441304513046130471304813049130501305113052130531305413055130561305713058130591306013061130621306313064130651306613067130681306913070130711307213073130741307513076130771307813079130801308113082130831308413085130861308713088130891309013091130921309313094130951309613097130981309913100131011310213103131041310513106131071310813109131101311113112131131311413115131161311713118131191312013121131221312313124131251312613127131281312913130131311313213133131341313513136131371313813139131401314113142131431314413145131461314713148131491315013151131521315313154131551315613157131581315913160131611316213163131641316513166131671316813169131701317113172131731317413175131761317713178131791318013181131821318313184131851318613187131881318913190131911319213193131941319513196131971319813199132001320113202132031320413205132061320713208132091321013211132121321313214132151321613217132181321913220132211322213223132241322513226132271322813229132301323113232132331323413235132361323713238132391324013241132421324313244132451324613247132481324913250132511325213253132541325513256132571325813259132601326113262132631326413265132661326713268132691327013271132721327313274132751327613277132781327913280132811328213283132841328513286132871328813289132901329113292132931329413295132961329713298132991330013301133021330313304133051330613307133081330913310133111331213313133141331513316133171331813319133201332113322133231332413325133261332713328133291333013331133321333313334133351333613337133381333913340133411334213343133441334513346133471334813349133501335113352133531335413355133561335713358133591336013361133621336313364133651336613367133681336913370133711337213373133741337513376133771337813379133801338113382133831338413385133861338713388133891339013391133921339313394133951339613397133981339913400134011340213403134041340513406134071340813409134101341113412134131341413415134161341713418134191342013421134221342313424134251342613427134281342913430134311343213433134341343513436134371343813439134401344113442134431344413445134461344713448134491345013451134521345313454134551345613457134581345913460134611346213463134641346513466134671346813469134701347113472134731347413475134761347713478134791348013481134821348313484134851348613487134881348913490134911349213493134941349513496134971349813499135001350113502135031350413505135061350713508135091351013511135121351313514135151351613517135181351913520135211352213523135241352513526135271352813529135301353113532135331353413535135361353713538135391354013541135421354313544135451354613547135481354913550135511355213553135541355513556135571355813559135601356113562135631356413565135661356713568135691357013571135721357313574135751357613577135781357913580135811358213583135841358513586135871358813589135901359113592135931359413595135961359713598135991360013601136021360313604136051360613607136081360913610136111361213613136141361513616136171361813619136201362113622136231362413625136261362713628136291363013631136321363313634136351363613637136381363913640136411364213643136441364513646136471364813649136501365113652136531365413655136561365713658136591366013661136621366313664136651366613667136681366913670136711367213673136741367513676136771367813679136801368113682136831368413685136861368713688136891369013691136921369313694136951369613697136981369913700137011370213703137041370513706137071370813709137101371113712137131371413715137161371713718137191372013721137221372313724137251372613727137281372913730137311373213733137341373513736137371373813739137401374113742137431374413745137461374713748137491375013751137521375313754137551375613757137581375913760137611376213763137641376513766137671376813769137701377113772137731377413775137761377713778137791378013781137821378313784137851378613787137881378913790137911379213793137941379513796137971379813799138001380113802138031380413805138061380713808138091381013811138121381313814138151381613817138181381913820138211382213823138241382513826138271382813829138301383113832138331383413835138361383713838138391384013841138421384313844138451384613847138481384913850138511385213853138541385513856138571385813859138601386113862138631386413865138661386713868138691387013871138721387313874138751387613877138781387913880138811388213883138841388513886138871388813889138901389113892138931389413895138961389713898138991390013901139021390313904139051390613907139081390913910139111391213913139141391513916139171391813919139201392113922139231392413925139261392713928139291393013931139321393313934139351393613937139381393913940139411394213943139441394513946139471394813949139501395113952139531395413955139561395713958139591396013961139621396313964139651396613967139681396913970139711397213973139741397513976139771397813979139801398113982139831398413985139861398713988139891399013991139921399313994139951399613997139981399914000140011400214003140041400514006140071400814009140101401114012140131401414015140161401714018140191402014021140221402314024140251402614027140281402914030140311403214033140341403514036140371403814039140401404114042140431404414045140461404714048140491405014051140521405314054140551405614057140581405914060140611406214063140641406514066140671406814069140701407114072140731407414075140761407714078140791408014081140821408314084140851408614087140881408914090140911409214093140941409514096140971409814099141001410114102141031410414105141061410714108141091411014111141121411314114141151411614117141181411914120141211412214123141241412514126141271412814129141301413114132141331413414135141361413714138141391414014141141421414314144141451414614147141481414914150141511415214153141541415514156141571415814159141601416114162141631416414165141661416714168141691417014171141721417314174141751417614177141781417914180141811418214183141841418514186141871418814189141901419114192141931419414195141961419714198141991420014201142021420314204142051420614207142081420914210142111421214213142141421514216142171421814219142201422114222142231422414225142261422714228142291423014231142321423314234142351423614237142381423914240142411424214243142441424514246142471424814249142501425114252142531425414255142561425714258142591426014261142621426314264142651426614267142681426914270142711427214273142741427514276142771427814279142801428114282142831428414285142861428714288142891429014291142921429314294142951429614297142981429914300143011430214303143041430514306143071430814309143101431114312143131431414315143161431714318143191432014321143221432314324143251432614327143281432914330143311433214333143341433514336143371433814339143401434114342143431434414345143461434714348143491435014351143521435314354143551435614357143581435914360143611436214363143641436514366143671436814369143701437114372143731437414375143761437714378143791438014381143821438314384143851438614387143881438914390143911439214393143941439514396143971439814399144001440114402144031440414405144061440714408144091441014411144121441314414144151441614417144181441914420144211442214423144241442514426144271442814429144301443114432144331443414435144361443714438144391444014441144421444314444144451444614447144481444914450144511445214453144541445514456144571445814459144601446114462144631446414465144661446714468144691447014471144721447314474144751447614477144781447914480144811448214483144841448514486144871448814489144901449114492144931449414495144961449714498144991450014501145021450314504145051450614507145081450914510145111451214513145141451514516145171451814519145201452114522145231452414525145261452714528145291453014531145321453314534145351453614537145381453914540145411454214543145441454514546145471454814549145501455114552145531455414555145561455714558145591456014561145621456314564145651456614567145681456914570145711457214573145741457514576145771457814579145801458114582145831458414585145861458714588145891459014591145921459314594145951459614597145981459914600146011460214603146041460514606146071460814609146101461114612146131461414615146161461714618146191462014621146221462314624146251462614627146281462914630146311463214633146341463514636146371463814639146401464114642146431464414645146461464714648146491465014651146521465314654146551465614657146581465914660146611466214663146641466514666146671466814669146701467114672146731467414675146761467714678146791468014681146821468314684146851468614687146881468914690146911469214693146941469514696146971469814699147001470114702147031470414705147061470714708147091471014711147121471314714147151471614717147181471914720147211472214723147241472514726147271472814729147301473114732147331473414735147361473714738147391474014741147421474314744147451474614747147481474914750147511475214753147541475514756147571475814759147601476114762147631476414765147661476714768147691477014771147721477314774147751477614777147781477914780147811478214783147841478514786147871478814789147901479114792147931479414795147961479714798147991480014801148021480314804148051480614807148081480914810148111481214813148141481514816148171481814819148201482114822148231482414825148261482714828148291483014831148321483314834148351483614837148381483914840148411484214843148441484514846148471484814849148501485114852148531485414855148561485714858148591486014861148621486314864148651486614867148681486914870148711487214873148741487514876148771487814879148801488114882148831488414885148861488714888148891489014891148921489314894148951489614897148981489914900149011490214903149041490514906149071490814909149101491114912149131491414915149161491714918149191492014921149221492314924149251492614927149281492914930149311493214933149341493514936149371493814939149401494114942149431494414945149461494714948149491495014951149521495314954149551495614957149581495914960149611496214963149641496514966149671496814969149701497114972149731497414975149761497714978149791498014981149821498314984149851498614987149881498914990149911499214993149941499514996149971499814999150001500115002150031500415005150061500715008150091501015011150121501315014150151501615017150181501915020150211502215023150241502515026150271502815029150301503115032150331503415035150361503715038150391504015041150421504315044150451504615047150481504915050150511505215053150541505515056150571505815059150601506115062150631506415065150661506715068150691507015071150721507315074150751507615077150781507915080150811508215083150841508515086150871508815089150901509115092150931509415095150961509715098150991510015101151021510315104151051510615107151081510915110151111511215113151141511515116151171511815119151201512115122151231512415125151261512715128151291513015131151321513315134151351513615137151381513915140151411514215143151441514515146151471514815149151501515115152151531515415155151561515715158151591516015161151621516315164151651516615167151681516915170151711517215173151741517515176151771517815179151801518115182151831518415185151861518715188151891519015191151921519315194151951519615197151981519915200152011520215203152041520515206152071520815209152101521115212152131521415215152161521715218152191522015221152221522315224152251522615227152281522915230152311523215233152341523515236152371523815239152401524115242152431524415245152461524715248152491525015251152521525315254152551525615257152581525915260152611526215263152641526515266152671526815269152701527115272152731527415275152761527715278152791528015281152821528315284152851528615287152881528915290152911529215293152941529515296152971529815299153001530115302153031530415305153061530715308153091531015311153121531315314153151531615317153181531915320153211532215323153241532515326153271532815329153301533115332153331533415335153361533715338153391534015341153421534315344153451534615347153481534915350153511535215353153541535515356153571535815359153601536115362153631536415365153661536715368153691537015371153721537315374153751537615377153781537915380153811538215383153841538515386153871538815389153901539115392153931539415395153961539715398153991540015401154021540315404154051540615407154081540915410154111541215413154141541515416154171541815419154201542115422154231542415425154261542715428154291543015431154321543315434154351543615437154381543915440154411544215443154441544515446154471544815449154501545115452154531545415455154561545715458154591546015461154621546315464154651546615467154681546915470154711547215473154741547515476154771547815479154801548115482154831548415485154861548715488154891549015491154921549315494154951549615497154981549915500155011550215503155041550515506155071550815509155101551115512155131551415515155161551715518155191552015521155221552315524155251552615527155281552915530155311553215533155341553515536155371553815539155401554115542155431554415545155461554715548155491555015551155521555315554155551555615557155581555915560155611556215563155641556515566155671556815569155701557115572155731557415575155761557715578155791558015581155821558315584155851558615587155881558915590155911559215593155941559515596155971559815599156001560115602156031560415605156061560715608156091561015611156121561315614156151561615617156181561915620156211562215623156241562515626156271562815629156301563115632156331563415635156361563715638156391564015641156421564315644156451564615647156481564915650156511565215653156541565515656156571565815659156601566115662156631566415665156661566715668156691567015671156721567315674156751567615677156781567915680156811568215683156841568515686156871568815689156901569115692156931569415695156961569715698156991570015701157021570315704157051570615707157081570915710157111571215713157141571515716157171571815719157201572115722157231572415725157261572715728157291573015731157321573315734157351573615737157381573915740157411574215743157441574515746157471574815749157501575115752157531575415755157561575715758157591576015761157621576315764157651576615767157681576915770157711577215773157741577515776157771577815779157801578115782157831578415785157861578715788157891579015791157921579315794157951579615797157981579915800158011580215803158041580515806158071580815809158101581115812158131581415815158161581715818158191582015821158221582315824158251582615827158281582915830158311583215833158341583515836158371583815839158401584115842158431584415845158461584715848158491585015851158521585315854158551585615857158581585915860158611586215863158641586515866158671586815869158701587115872158731587415875158761587715878158791588015881158821588315884158851588615887158881588915890158911589215893158941589515896158971589815899159001590115902159031590415905159061590715908159091591015911159121591315914159151591615917159181591915920159211592215923159241592515926159271592815929159301593115932159331593415935159361593715938159391594015941159421594315944159451594615947159481594915950159511595215953159541595515956159571595815959159601596115962159631596415965159661596715968159691597015971159721597315974159751597615977159781597915980159811598215983159841598515986159871598815989159901599115992159931599415995159961599715998159991600016001160021600316004160051600616007160081600916010160111601216013160141601516016160171601816019160201602116022160231602416025160261602716028160291603016031160321603316034160351603616037160381603916040160411604216043160441604516046160471604816049160501605116052160531605416055160561605716058160591606016061160621606316064160651606616067160681606916070160711607216073160741607516076160771607816079160801608116082160831608416085160861608716088160891609016091160921609316094160951609616097160981609916100161011610216103161041610516106161071610816109161101611116112161131611416115161161611716118161191612016121161221612316124161251612616127161281612916130161311613216133161341613516136161371613816139161401614116142161431614416145161461614716148161491615016151161521615316154161551615616157161581615916160161611616216163161641616516166161671616816169161701617116172161731617416175161761617716178161791618016181161821618316184161851618616187161881618916190161911619216193161941619516196161971619816199162001620116202162031620416205162061620716208162091621016211162121621316214162151621616217162181621916220162211622216223162241622516226162271622816229162301623116232162331623416235162361623716238162391624016241162421624316244162451624616247162481624916250162511625216253162541625516256162571625816259162601626116262162631626416265162661626716268162691627016271162721627316274162751627616277162781627916280162811628216283162841628516286162871628816289162901629116292162931629416295162961629716298162991630016301163021630316304163051630616307163081630916310163111631216313163141631516316163171631816319163201632116322163231632416325163261632716328163291633016331163321633316334163351633616337163381633916340163411634216343163441634516346163471634816349163501635116352163531635416355163561635716358163591636016361163621636316364163651636616367163681636916370163711637216373163741637516376163771637816379163801638116382163831638416385163861638716388163891639016391163921639316394163951639616397163981639916400164011640216403164041640516406164071640816409164101641116412164131641416415164161641716418164191642016421164221642316424164251642616427164281642916430164311643216433164341643516436164371643816439164401644116442164431644416445164461644716448164491645016451164521645316454164551645616457164581645916460164611646216463164641646516466164671646816469164701647116472164731647416475164761647716478164791648016481164821648316484164851648616487164881648916490164911649216493164941649516496164971649816499165001650116502165031650416505165061650716508165091651016511165121651316514165151651616517165181651916520165211652216523165241652516526165271652816529165301653116532165331653416535165361653716538165391654016541165421654316544165451654616547165481654916550165511655216553165541655516556165571655816559165601656116562165631656416565165661656716568165691657016571165721657316574165751657616577165781657916580165811658216583165841658516586165871658816589165901659116592165931659416595165961659716598165991660016601166021660316604166051660616607166081660916610166111661216613166141661516616166171661816619166201662116622166231662416625166261662716628166291663016631166321663316634166351663616637166381663916640166411664216643166441664516646166471664816649166501665116652166531665416655166561665716658166591666016661166621666316664166651666616667166681666916670166711667216673166741667516676166771667816679166801668116682166831668416685166861668716688166891669016691166921669316694166951669616697166981669916700167011670216703167041670516706167071670816709167101671116712167131671416715167161671716718167191672016721167221672316724167251672616727167281672916730167311673216733167341673516736167371673816739167401674116742167431674416745167461674716748167491675016751167521675316754167551675616757167581675916760167611676216763167641676516766167671676816769167701677116772167731677416775167761677716778167791678016781167821678316784167851678616787167881678916790167911679216793167941679516796167971679816799168001680116802168031680416805168061680716808168091681016811168121681316814168151681616817168181681916820168211682216823168241682516826168271682816829168301683116832168331683416835168361683716838168391684016841168421684316844168451684616847168481684916850168511685216853168541685516856168571685816859168601686116862168631686416865168661686716868168691687016871168721687316874168751687616877168781687916880168811688216883168841688516886168871688816889168901689116892168931689416895168961689716898168991690016901169021690316904169051690616907169081690916910169111691216913169141691516916169171691816919169201692116922169231692416925169261692716928169291693016931169321693316934169351693616937169381693916940169411694216943169441694516946169471694816949169501695116952169531695416955169561695716958169591696016961169621696316964169651696616967169681696916970169711697216973169741697516976169771697816979169801698116982169831698416985169861698716988169891699016991169921699316994169951699616997169981699917000170011700217003170041700517006170071700817009170101701117012170131701417015170161701717018170191702017021170221702317024170251702617027170281702917030170311703217033170341703517036170371703817039170401704117042170431704417045170461704717048170491705017051170521705317054170551705617057170581705917060170611706217063170641706517066170671706817069170701707117072170731707417075170761707717078170791708017081170821708317084170851708617087170881708917090170911709217093170941709517096170971709817099171001710117102171031710417105171061710717108171091711017111171121711317114171151711617117171181711917120171211712217123171241712517126171271712817129171301713117132171331713417135171361713717138171391714017141171421714317144171451714617147171481714917150171511715217153171541715517156171571715817159171601716117162171631716417165171661716717168171691717017171171721717317174171751717617177171781717917180171811718217183171841718517186171871718817189171901719117192171931719417195171961719717198171991720017201172021720317204172051720617207172081720917210172111721217213172141721517216172171721817219172201722117222172231722417225172261722717228172291723017231172321723317234172351723617237172381723917240172411724217243172441724517246172471724817249172501725117252172531725417255172561725717258172591726017261172621726317264172651726617267172681726917270172711727217273172741727517276172771727817279172801728117282172831728417285172861728717288172891729017291172921729317294172951729617297172981729917300173011730217303173041730517306173071730817309173101731117312173131731417315173161731717318173191732017321173221732317324173251732617327173281732917330173311733217333173341733517336173371733817339173401734117342173431734417345173461734717348173491735017351173521735317354173551735617357173581735917360173611736217363173641736517366173671736817369173701737117372173731737417375173761737717378173791738017381173821738317384173851738617387173881738917390173911739217393173941739517396173971739817399174001740117402174031740417405174061740717408174091741017411174121741317414174151741617417174181741917420174211742217423174241742517426174271742817429174301743117432174331743417435174361743717438174391744017441174421744317444174451744617447174481744917450174511745217453174541745517456174571745817459174601746117462174631746417465174661746717468174691747017471174721747317474174751747617477174781747917480174811748217483174841748517486174871748817489174901749117492174931749417495174961749717498174991750017501175021750317504175051750617507175081750917510175111751217513175141751517516175171751817519175201752117522175231752417525175261752717528175291753017531175321753317534175351753617537175381753917540175411754217543175441754517546175471754817549175501755117552175531755417555175561755717558175591756017561175621756317564175651756617567175681756917570175711757217573175741757517576175771757817579175801758117582175831758417585175861758717588175891759017591175921759317594175951759617597175981759917600176011760217603176041760517606176071760817609176101761117612176131761417615176161761717618176191762017621176221762317624176251762617627176281762917630176311763217633176341763517636176371763817639176401764117642176431764417645176461764717648176491765017651176521765317654176551765617657176581765917660176611766217663176641766517666176671766817669176701767117672176731767417675176761767717678176791768017681176821768317684176851768617687176881768917690176911769217693176941769517696176971769817699177001770117702177031770417705177061770717708177091771017711177121771317714177151771617717177181771917720177211772217723177241772517726177271772817729177301773117732177331773417735177361773717738177391774017741177421774317744177451774617747177481774917750177511775217753177541775517756177571775817759177601776117762177631776417765177661776717768177691777017771177721777317774177751777617777177781777917780177811778217783177841778517786177871778817789177901779117792177931779417795177961779717798177991780017801178021780317804178051780617807178081780917810178111781217813178141781517816178171781817819178201782117822178231782417825178261782717828178291783017831178321783317834178351783617837178381783917840178411784217843178441784517846178471784817849178501785117852178531785417855178561785717858178591786017861178621786317864178651786617867178681786917870178711787217873178741787517876178771787817879178801788117882178831788417885178861788717888178891789017891178921789317894178951789617897178981789917900179011790217903179041790517906179071790817909179101791117912179131791417915179161791717918179191792017921179221792317924179251792617927179281792917930179311793217933179341793517936179371793817939179401794117942179431794417945179461794717948179491795017951179521795317954179551795617957179581795917960179611796217963179641796517966179671796817969179701797117972179731797417975179761797717978179791798017981179821798317984179851798617987179881798917990179911799217993179941799517996179971799817999180001800118002180031800418005180061800718008180091801018011180121801318014180151801618017180181801918020180211802218023180241802518026180271802818029180301803118032180331803418035180361803718038180391804018041180421804318044180451804618047180481804918050180511805218053180541805518056180571805818059180601806118062180631806418065180661806718068180691807018071180721807318074180751807618077180781807918080180811808218083180841808518086180871808818089180901809118092180931809418095180961809718098180991810018101181021810318104181051810618107181081810918110181111811218113181141811518116181171811818119181201812118122181231812418125181261812718128181291813018131181321813318134181351813618137181381813918140181411814218143181441814518146181471814818149181501815118152181531815418155181561815718158181591816018161181621816318164181651816618167181681816918170181711817218173181741817518176181771817818179181801818118182181831818418185181861818718188181891819018191181921819318194181951819618197181981819918200182011820218203182041820518206182071820818209182101821118212182131821418215182161821718218182191822018221182221822318224182251822618227182281822918230182311823218233182341823518236182371823818239182401824118242182431824418245182461824718248182491825018251182521825318254182551825618257182581825918260182611826218263182641826518266182671826818269182701827118272182731827418275182761827718278182791828018281182821828318284182851828618287182881828918290182911829218293182941829518296182971829818299183001830118302183031830418305183061830718308183091831018311183121831318314183151831618317183181831918320183211832218323183241832518326183271832818329183301833118332183331833418335183361833718338183391834018341183421834318344183451834618347183481834918350183511835218353183541835518356183571835818359183601836118362183631836418365183661836718368183691837018371183721837318374183751837618377183781837918380183811838218383183841838518386183871838818389183901839118392183931839418395183961839718398183991840018401184021840318404184051840618407184081840918410184111841218413184141841518416184171841818419184201842118422184231842418425184261842718428184291843018431184321843318434184351843618437184381843918440184411844218443184441844518446184471844818449184501845118452184531845418455184561845718458184591846018461184621846318464184651846618467184681846918470184711847218473184741847518476184771847818479184801848118482184831848418485184861848718488184891849018491184921849318494184951849618497184981849918500185011850218503185041850518506185071850818509185101851118512185131851418515185161851718518185191852018521185221852318524185251852618527185281852918530185311853218533185341853518536185371853818539185401854118542185431854418545185461854718548185491855018551185521855318554185551855618557185581855918560185611856218563185641856518566185671856818569185701857118572185731857418575185761857718578185791858018581185821858318584185851858618587185881858918590185911859218593185941859518596185971859818599186001860118602186031860418605186061860718608186091861018611186121861318614186151861618617186181861918620186211862218623186241862518626186271862818629186301863118632186331863418635186361863718638186391864018641186421864318644186451864618647186481864918650186511865218653186541865518656186571865818659186601866118662186631866418665186661866718668186691867018671186721867318674186751867618677186781867918680186811868218683186841868518686186871868818689186901869118692186931869418695186961869718698186991870018701187021870318704187051870618707187081870918710187111871218713187141871518716187171871818719187201872118722187231872418725187261872718728187291873018731187321873318734187351873618737187381873918740187411874218743187441874518746187471874818749187501875118752187531875418755187561875718758187591876018761187621876318764187651876618767187681876918770187711877218773187741877518776187771877818779187801878118782187831878418785187861878718788187891879018791187921879318794187951879618797187981879918800188011880218803188041880518806188071880818809188101881118812188131881418815188161881718818188191882018821188221882318824188251882618827188281882918830188311883218833188341883518836188371883818839188401884118842188431884418845188461884718848188491885018851188521885318854188551885618857188581885918860188611886218863188641886518866188671886818869188701887118872188731887418875188761887718878188791888018881188821888318884188851888618887188881888918890188911889218893188941889518896188971889818899189001890118902189031890418905189061890718908189091891018911189121891318914189151891618917189181891918920189211892218923189241892518926189271892818929189301893118932189331893418935189361893718938189391894018941189421894318944189451894618947189481894918950189511895218953189541895518956189571895818959189601896118962189631896418965189661896718968189691897018971189721897318974189751897618977189781897918980189811898218983189841898518986189871898818989189901899118992189931899418995189961899718998189991900019001190021900319004190051900619007190081900919010190111901219013190141901519016190171901819019190201902119022190231902419025190261902719028190291903019031190321903319034190351903619037190381903919040190411904219043190441904519046190471904819049190501905119052190531905419055190561905719058190591906019061190621906319064190651906619067190681906919070190711907219073190741907519076190771907819079190801908119082190831908419085190861908719088190891909019091190921909319094190951909619097190981909919100191011910219103191041910519106191071910819109191101911119112191131911419115191161911719118191191912019121191221912319124191251912619127191281912919130191311913219133191341913519136191371913819139191401914119142191431914419145191461914719148191491915019151191521915319154191551915619157191581915919160191611916219163191641916519166191671916819169191701917119172191731917419175191761917719178191791918019181191821918319184191851918619187191881918919190191911919219193191941919519196191971919819199192001920119202192031920419205192061920719208192091921019211192121921319214192151921619217192181921919220192211922219223192241922519226192271922819229192301923119232192331923419235192361923719238192391924019241192421924319244192451924619247192481924919250192511925219253192541925519256192571925819259192601926119262192631926419265192661926719268192691927019271192721927319274192751927619277192781927919280192811928219283192841928519286192871928819289192901929119292192931929419295192961929719298192991930019301193021930319304193051930619307193081930919310193111931219313193141931519316193171931819319193201932119322193231932419325193261932719328193291933019331193321933319334193351933619337193381933919340193411934219343193441934519346193471934819349193501935119352193531935419355193561935719358193591936019361193621936319364193651936619367193681936919370193711937219373193741937519376193771937819379193801938119382193831938419385193861938719388193891939019391193921939319394193951939619397193981939919400194011940219403194041940519406194071940819409194101941119412194131941419415194161941719418194191942019421194221942319424194251942619427194281942919430194311943219433194341943519436194371943819439194401944119442194431944419445194461944719448194491945019451194521945319454194551945619457194581945919460194611946219463194641946519466194671946819469194701947119472194731947419475194761947719478194791948019481194821948319484194851948619487194881948919490194911949219493194941949519496194971949819499195001950119502195031950419505195061950719508195091951019511195121951319514195151951619517195181951919520195211952219523195241952519526195271952819529195301953119532195331953419535195361953719538195391954019541195421954319544195451954619547195481954919550195511955219553195541955519556195571955819559195601956119562195631956419565195661956719568195691957019571195721957319574195751957619577195781957919580195811958219583195841958519586195871958819589195901959119592195931959419595195961959719598195991960019601196021960319604196051960619607196081960919610196111961219613196141961519616196171961819619196201962119622196231962419625196261962719628196291963019631196321963319634196351963619637196381963919640196411964219643196441964519646196471964819649196501965119652196531965419655196561965719658196591966019661196621966319664196651966619667196681966919670196711967219673196741967519676196771967819679196801968119682196831968419685196861968719688196891969019691196921969319694196951969619697196981969919700197011970219703197041970519706197071970819709197101971119712197131971419715197161971719718197191972019721197221972319724197251972619727197281972919730197311973219733197341973519736197371973819739197401974119742197431974419745197461974719748197491975019751197521975319754197551975619757197581975919760197611976219763197641976519766197671976819769197701977119772197731977419775197761977719778197791978019781197821978319784197851978619787197881978919790197911979219793197941979519796197971979819799198001980119802198031980419805198061980719808198091981019811198121981319814198151981619817198181981919820198211982219823198241982519826198271982819829198301983119832198331983419835198361983719838198391984019841198421984319844198451984619847198481984919850198511985219853198541985519856198571985819859198601986119862198631986419865198661986719868198691987019871198721987319874198751987619877198781987919880198811988219883198841988519886198871988819889198901989119892198931989419895198961989719898198991990019901199021990319904199051990619907199081990919910199111991219913199141991519916199171991819919199201992119922199231992419925199261992719928199291993019931199321993319934199351993619937199381993919940199411994219943199441994519946199471994819949199501995119952199531995419955199561995719958199591996019961199621996319964199651996619967199681996919970199711997219973199741997519976199771997819979199801998119982199831998419985199861998719988199891999019991199921999319994199951999619997199981999920000200012000220003200042000520006200072000820009200102001120012200132001420015200162001720018200192002020021200222002320024200252002620027200282002920030200312003220033200342003520036200372003820039200402004120042200432004420045200462004720048200492005020051200522005320054200552005620057200582005920060200612006220063200642006520066200672006820069200702007120072200732007420075200762007720078200792008020081200822008320084200852008620087200882008920090200912009220093200942009520096200972009820099201002010120102201032010420105201062010720108201092011020111201122011320114201152011620117201182011920120201212012220123201242012520126201272012820129201302013120132201332013420135201362013720138201392014020141201422014320144201452014620147201482014920150201512015220153201542015520156201572015820159201602016120162201632016420165201662016720168201692017020171201722017320174201752017620177201782017920180201812018220183201842018520186201872018820189201902019120192201932019420195201962019720198201992020020201202022020320204202052020620207202082020920210202112021220213202142021520216202172021820219202202022120222202232022420225202262022720228202292023020231202322023320234202352023620237202382023920240202412024220243202442024520246202472024820249202502025120252202532025420255202562025720258202592026020261202622026320264202652026620267202682026920270202712027220273202742027520276202772027820279202802028120282202832028420285202862028720288202892029020291202922029320294202952029620297202982029920300203012030220303203042030520306203072030820309203102031120312203132031420315203162031720318203192032020321203222032320324203252032620327203282032920330203312033220333203342033520336203372033820339203402034120342203432034420345203462034720348203492035020351203522035320354203552035620357203582035920360203612036220363203642036520366203672036820369203702037120372203732037420375203762037720378203792038020381203822038320384203852038620387203882038920390203912039220393203942039520396203972039820399204002040120402204032040420405204062040720408204092041020411204122041320414204152041620417204182041920420204212042220423204242042520426204272042820429204302043120432204332043420435204362043720438204392044020441204422044320444204452044620447204482044920450204512045220453204542045520456204572045820459204602046120462204632046420465204662046720468204692047020471204722047320474204752047620477204782047920480204812048220483204842048520486204872048820489204902049120492204932049420495204962049720498204992050020501205022050320504205052050620507205082050920510205112051220513205142051520516205172051820519205202052120522205232052420525205262052720528205292053020531205322053320534205352053620537205382053920540205412054220543205442054520546205472054820549205502055120552205532055420555205562055720558205592056020561205622056320564205652056620567205682056920570205712057220573205742057520576205772057820579205802058120582205832058420585205862058720588205892059020591205922059320594205952059620597205982059920600206012060220603206042060520606206072060820609206102061120612206132061420615206162061720618206192062020621206222062320624206252062620627206282062920630206312063220633206342063520636206372063820639206402064120642206432064420645206462064720648206492065020651206522065320654206552065620657206582065920660206612066220663206642066520666206672066820669206702067120672206732067420675206762067720678206792068020681206822068320684206852068620687206882068920690206912069220693206942069520696206972069820699207002070120702207032070420705207062070720708207092071020711207122071320714207152071620717207182071920720207212072220723207242072520726207272072820729207302073120732207332073420735207362073720738207392074020741207422074320744207452074620747207482074920750207512075220753207542075520756207572075820759207602076120762207632076420765207662076720768207692077020771207722077320774207752077620777207782077920780207812078220783207842078520786207872078820789207902079120792207932079420795207962079720798207992080020801208022080320804208052080620807208082080920810208112081220813208142081520816208172081820819208202082120822208232082420825208262082720828208292083020831208322083320834208352083620837208382083920840208412084220843208442084520846208472084820849208502085120852208532085420855208562085720858208592086020861208622086320864208652086620867208682086920870208712087220873208742087520876208772087820879208802088120882208832088420885208862088720888208892089020891208922089320894208952089620897208982089920900209012090220903209042090520906209072090820909209102091120912209132091420915209162091720918209192092020921209222092320924209252092620927209282092920930209312093220933209342093520936209372093820939209402094120942209432094420945209462094720948209492095020951209522095320954209552095620957209582095920960209612096220963209642096520966209672096820969209702097120972209732097420975209762097720978209792098020981209822098320984209852098620987209882098920990209912099220993209942099520996209972099820999210002100121002210032100421005210062100721008210092101021011210122101321014210152101621017210182101921020210212102221023210242102521026210272102821029210302103121032210332103421035210362103721038210392104021041210422104321044210452104621047210482104921050210512105221053210542105521056210572105821059210602106121062210632106421065210662106721068210692107021071210722107321074210752107621077210782107921080210812108221083210842108521086210872108821089210902109121092210932109421095210962109721098210992110021101211022110321104211052110621107211082110921110211112111221113211142111521116211172111821119211202112121122211232112421125211262112721128211292113021131211322113321134211352113621137211382113921140211412114221143211442114521146211472114821149211502115121152211532115421155211562115721158211592116021161211622116321164211652116621167211682116921170211712117221173211742117521176211772117821179211802118121182211832118421185211862118721188211892119021191211922119321194211952119621197211982119921200212012120221203212042120521206212072120821209212102121121212212132121421215212162121721218212192122021221212222122321224212252122621227212282122921230212312123221233212342123521236212372123821239212402124121242212432124421245212462124721248212492125021251212522125321254212552125621257212582125921260212612126221263212642126521266212672126821269212702127121272212732127421275212762127721278212792128021281212822128321284212852128621287212882128921290212912129221293212942129521296212972129821299213002130121302213032130421305213062130721308213092131021311213122131321314213152131621317213182131921320213212132221323213242132521326213272132821329213302133121332213332133421335213362133721338213392134021341213422134321344213452134621347213482134921350213512135221353213542135521356213572135821359213602136121362213632136421365213662136721368213692137021371213722137321374213752137621377213782137921380213812138221383213842138521386213872138821389213902139121392213932139421395213962139721398213992140021401214022140321404214052140621407214082140921410214112141221413214142141521416214172141821419214202142121422214232142421425214262142721428214292143021431214322143321434214352143621437214382143921440214412144221443214442144521446214472144821449214502145121452214532145421455214562145721458214592146021461214622146321464214652146621467214682146921470214712147221473214742147521476214772147821479214802148121482214832148421485214862148721488214892149021491214922149321494214952149621497214982149921500215012150221503215042150521506215072150821509215102151121512215132151421515215162151721518215192152021521215222152321524215252152621527215282152921530215312153221533215342153521536215372153821539215402154121542215432154421545215462154721548215492155021551215522155321554215552155621557215582155921560215612156221563215642156521566215672156821569215702157121572215732157421575215762157721578215792158021581215822158321584215852158621587215882158921590215912159221593215942159521596215972159821599216002160121602216032160421605216062160721608216092161021611216122161321614216152161621617216182161921620216212162221623216242162521626216272162821629216302163121632216332163421635216362163721638216392164021641216422164321644216452164621647216482164921650216512165221653216542165521656216572165821659216602166121662216632166421665216662166721668216692167021671216722167321674216752167621677216782167921680216812168221683216842168521686216872168821689216902169121692216932169421695216962169721698216992170021701217022170321704217052170621707217082170921710217112171221713217142171521716217172171821719217202172121722217232172421725217262172721728217292173021731217322173321734217352173621737217382173921740217412174221743217442174521746217472174821749217502175121752217532175421755217562175721758217592176021761217622176321764217652176621767217682176921770217712177221773217742177521776217772177821779217802178121782217832178421785217862178721788217892179021791217922179321794217952179621797217982179921800218012180221803218042180521806218072180821809218102181121812218132181421815218162181721818218192182021821218222182321824218252182621827218282182921830218312183221833218342183521836218372183821839218402184121842218432184421845218462184721848218492185021851218522185321854218552185621857218582185921860218612186221863218642186521866218672186821869218702187121872218732187421875218762187721878218792188021881218822188321884218852188621887218882188921890218912189221893218942189521896218972189821899219002190121902219032190421905219062190721908219092191021911219122191321914219152191621917219182191921920219212192221923219242192521926219272192821929219302193121932219332193421935219362193721938219392194021941219422194321944219452194621947219482194921950219512195221953219542195521956219572195821959219602196121962219632196421965219662196721968219692197021971219722197321974219752197621977219782197921980219812198221983219842198521986219872198821989219902199121992219932199421995219962199721998219992200022001220022200322004220052200622007220082200922010220112201222013220142201522016220172201822019220202202122022220232202422025220262202722028220292203022031220322203322034220352203622037220382203922040220412204222043220442204522046220472204822049220502205122052220532205422055220562205722058220592206022061220622206322064220652206622067220682206922070220712207222073220742207522076220772207822079220802208122082220832208422085220862208722088220892209022091220922209322094220952209622097220982209922100221012210222103221042210522106221072210822109221102211122112221132211422115221162211722118221192212022121221222212322124221252212622127221282212922130221312213222133221342213522136221372213822139221402214122142221432214422145221462214722148221492215022151221522215322154221552215622157221582215922160221612216222163221642216522166221672216822169221702217122172221732217422175221762217722178221792218022181221822218322184221852218622187221882218922190221912219222193221942219522196221972219822199222002220122202222032220422205222062220722208222092221022211222122221322214222152221622217222182221922220222212222222223222242222522226222272222822229222302223122232222332223422235222362223722238222392224022241222422224322244222452224622247222482224922250222512225222253222542225522256222572225822259222602226122262222632226422265222662226722268222692227022271222722227322274222752227622277222782227922280222812228222283222842228522286222872228822289222902229122292222932229422295222962229722298222992230022301223022230322304223052230622307223082230922310223112231222313223142231522316223172231822319223202232122322223232232422325223262232722328223292233022331223322233322334223352233622337223382233922340223412234222343223442234522346223472234822349223502235122352223532235422355223562235722358223592236022361223622236322364223652236622367223682236922370223712237222373223742237522376223772237822379223802238122382223832238422385223862238722388223892239022391223922239322394223952239622397223982239922400224012240222403224042240522406224072240822409224102241122412224132241422415224162241722418224192242022421224222242322424224252242622427224282242922430224312243222433224342243522436224372243822439224402244122442224432244422445224462244722448224492245022451224522245322454224552245622457224582245922460224612246222463224642246522466224672246822469224702247122472224732247422475224762247722478224792248022481224822248322484224852248622487224882248922490224912249222493224942249522496224972249822499225002250122502225032250422505225062250722508225092251022511225122251322514225152251622517225182251922520225212252222523225242252522526225272252822529225302253122532225332253422535225362253722538225392254022541225422254322544225452254622547225482254922550225512255222553225542255522556225572255822559225602256122562225632256422565225662256722568225692257022571225722257322574225752257622577225782257922580225812258222583225842258522586225872258822589225902259122592225932259422595225962259722598225992260022601226022260322604226052260622607226082260922610226112261222613226142261522616226172261822619226202262122622226232262422625226262262722628226292263022631226322263322634226352263622637226382263922640226412264222643226442264522646226472264822649226502265122652226532265422655226562265722658226592266022661226622266322664226652266622667226682266922670226712267222673226742267522676226772267822679226802268122682226832268422685226862268722688226892269022691226922269322694226952269622697226982269922700227012270222703227042270522706227072270822709227102271122712227132271422715227162271722718227192272022721227222272322724227252272622727227282272922730227312273222733227342273522736227372273822739227402274122742227432274422745227462274722748227492275022751227522275322754227552275622757227582275922760227612276222763227642276522766227672276822769227702277122772227732277422775227762277722778227792278022781227822278322784227852278622787227882278922790227912279222793227942279522796227972279822799228002280122802228032280422805228062280722808228092281022811228122281322814228152281622817228182281922820228212282222823228242282522826228272282822829228302283122832228332283422835228362283722838228392284022841228422284322844228452284622847228482284922850228512285222853228542285522856228572285822859228602286122862228632286422865228662286722868228692287022871228722287322874228752287622877228782287922880228812288222883228842288522886228872288822889228902289122892228932289422895228962289722898228992290022901229022290322904229052290622907229082290922910229112291222913229142291522916229172291822919229202292122922229232292422925229262292722928229292293022931229322293322934229352293622937229382293922940229412294222943229442294522946229472294822949229502295122952229532295422955229562295722958229592296022961229622296322964229652296622967229682296922970229712297222973229742297522976229772297822979229802298122982229832298422985229862298722988229892299022991229922299322994229952299622997229982299923000230012300223003230042300523006230072300823009230102301123012230132301423015230162301723018230192302023021230222302323024230252302623027230282302923030230312303223033230342303523036230372303823039230402304123042230432304423045230462304723048230492305023051230522305323054230552305623057230582305923060230612306223063230642306523066230672306823069230702307123072230732307423075230762307723078230792308023081230822308323084230852308623087230882308923090230912309223093230942309523096230972309823099231002310123102231032310423105231062310723108231092311023111231122311323114231152311623117231182311923120231212312223123231242312523126231272312823129231302313123132231332313423135231362313723138231392314023141231422314323144231452314623147231482314923150231512315223153231542315523156231572315823159231602316123162231632316423165231662316723168231692317023171231722317323174231752317623177231782317923180231812318223183231842318523186231872318823189231902319123192231932319423195231962319723198231992320023201232022320323204232052320623207232082320923210232112321223213232142321523216232172321823219232202322123222232232322423225232262322723228232292323023231232322323323234232352323623237232382323923240232412324223243232442324523246232472324823249232502325123252232532325423255232562325723258232592326023261232622326323264232652326623267232682326923270232712327223273232742327523276232772327823279232802328123282232832328423285232862328723288232892329023291232922329323294232952329623297232982329923300233012330223303233042330523306233072330823309233102331123312233132331423315233162331723318233192332023321233222332323324233252332623327233282332923330233312333223333233342333523336233372333823339233402334123342233432334423345233462334723348233492335023351233522335323354233552335623357233582335923360233612336223363233642336523366233672336823369233702337123372233732337423375233762337723378233792338023381233822338323384233852338623387233882338923390233912339223393233942339523396233972339823399234002340123402234032340423405234062340723408234092341023411234122341323414234152341623417234182341923420234212342223423234242342523426234272342823429234302343123432234332343423435234362343723438234392344023441234422344323444234452344623447234482344923450234512345223453234542345523456234572345823459234602346123462234632346423465234662346723468234692347023471234722347323474234752347623477234782347923480234812348223483234842348523486234872348823489234902349123492234932349423495234962349723498234992350023501235022350323504235052350623507235082350923510235112351223513235142351523516235172351823519235202352123522235232352423525235262352723528235292353023531235322353323534235352353623537235382353923540235412354223543235442354523546235472354823549235502355123552235532355423555235562355723558235592356023561235622356323564235652356623567235682356923570235712357223573235742357523576235772357823579235802358123582235832358423585235862358723588235892359023591235922359323594235952359623597235982359923600236012360223603236042360523606236072360823609236102361123612236132361423615236162361723618236192362023621236222362323624236252362623627236282362923630236312363223633236342363523636236372363823639236402364123642236432364423645236462364723648236492365023651236522365323654236552365623657236582365923660236612366223663236642366523666236672366823669236702367123672236732367423675236762367723678236792368023681236822368323684236852368623687236882368923690236912369223693236942369523696236972369823699237002370123702237032370423705237062370723708237092371023711237122371323714237152371623717237182371923720237212372223723237242372523726237272372823729237302373123732237332373423735237362373723738237392374023741237422374323744237452374623747237482374923750237512375223753237542375523756237572375823759237602376123762237632376423765237662376723768237692377023771237722377323774237752377623777237782377923780237812378223783237842378523786237872378823789237902379123792237932379423795237962379723798237992380023801238022380323804238052380623807238082380923810238112381223813238142381523816238172381823819238202382123822238232382423825238262382723828238292383023831238322383323834238352383623837238382383923840238412384223843238442384523846238472384823849238502385123852238532385423855238562385723858238592386023861238622386323864238652386623867238682386923870238712387223873238742387523876238772387823879238802388123882238832388423885238862388723888238892389023891238922389323894238952389623897238982389923900239012390223903239042390523906239072390823909239102391123912239132391423915239162391723918239192392023921239222392323924239252392623927239282392923930239312393223933239342393523936239372393823939239402394123942239432394423945239462394723948239492395023951239522395323954239552395623957239582395923960239612396223963239642396523966239672396823969239702397123972239732397423975239762397723978239792398023981239822398323984239852398623987239882398923990239912399223993239942399523996239972399823999240002400124002240032400424005240062400724008240092401024011240122401324014240152401624017240182401924020240212402224023240242402524026240272402824029240302403124032240332403424035240362403724038240392404024041240422404324044240452404624047240482404924050240512405224053240542405524056240572405824059240602406124062240632406424065240662406724068240692407024071240722407324074240752407624077240782407924080240812408224083240842408524086240872408824089
  1. //
  2. // httplib.h
  3. //
  4. // Copyright (c) 2026 Yuji Hirose. All rights reserved.
  5. // MIT License
  6. //
  7. #ifndef CPPHTTPLIB_HTTPLIB_H
  8. #define CPPHTTPLIB_HTTPLIB_H
  9. #define CPPHTTPLIB_VERSION "0.63.0"
  10. #define CPPHTTPLIB_VERSION_NUM "0x003f00"
  11. #ifdef _WIN32
  12. #if defined(_WIN32_WINNT) && _WIN32_WINNT < 0x0A00
  13. #error \
  14. "cpp-httplib doesn't support Windows 8 or lower. Please use Windows 10 or later."
  15. #endif
  16. #endif
  17. #if defined(__SANITIZE_THREAD__)
  18. #define CPPHTTPLIB_THREAD_SANITIZER
  19. #elif defined(__has_feature)
  20. #if __has_feature(thread_sanitizer)
  21. #define CPPHTTPLIB_THREAD_SANITIZER
  22. #endif
  23. #endif
  24. /*
  25. * Configuration
  26. */
  27. #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND
  28. #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND 5
  29. #endif
  30. #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND
  31. #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND 10000
  32. #endif
  33. #ifndef CPPHTTPLIB_KEEPALIVE_MAX_COUNT
  34. #define CPPHTTPLIB_KEEPALIVE_MAX_COUNT 100
  35. #endif
  36. #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND
  37. #define CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND 300
  38. #endif
  39. #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND
  40. #define CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND 0
  41. #endif
  42. #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND
  43. #define CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND 5
  44. #endif
  45. #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND
  46. #define CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND 0
  47. #endif
  48. #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND
  49. #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND 5
  50. #endif
  51. #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND
  52. #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND 0
  53. #endif
  54. #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND
  55. #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND 300
  56. #endif
  57. #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND
  58. #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND 0
  59. #endif
  60. #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND
  61. #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND 5
  62. #endif
  63. #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND
  64. #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND 0
  65. #endif
  66. #ifndef CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND
  67. #define CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND 0
  68. #endif
  69. #ifndef CPPHTTPLIB_EXPECT_100_THRESHOLD
  70. #define CPPHTTPLIB_EXPECT_100_THRESHOLD 1024
  71. #endif
  72. #ifndef CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND
  73. #define CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND 1000
  74. #endif
  75. #ifndef CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD
  76. #define CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD (1024 * 1024)
  77. #endif
  78. #ifndef CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND
  79. #define CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND 50
  80. #endif
  81. #ifndef CPPHTTPLIB_IDLE_INTERVAL_SECOND
  82. #define CPPHTTPLIB_IDLE_INTERVAL_SECOND 0
  83. #endif
  84. #ifndef CPPHTTPLIB_IDLE_INTERVAL_USECOND
  85. #ifdef _WIN32
  86. #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 1000
  87. #else
  88. #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 0
  89. #endif
  90. #endif
  91. #ifndef CPPHTTPLIB_REQUEST_URI_MAX_LENGTH
  92. #define CPPHTTPLIB_REQUEST_URI_MAX_LENGTH 8192
  93. #endif
  94. #ifndef CPPHTTPLIB_HEADER_MAX_LENGTH
  95. #define CPPHTTPLIB_HEADER_MAX_LENGTH 8192
  96. #endif
  97. #ifndef CPPHTTPLIB_HEADER_MAX_COUNT
  98. #define CPPHTTPLIB_HEADER_MAX_COUNT 100
  99. #endif
  100. #ifndef CPPHTTPLIB_REDIRECT_MAX_COUNT
  101. #define CPPHTTPLIB_REDIRECT_MAX_COUNT 20
  102. #endif
  103. #ifndef CPPHTTPLIB_INTERIM_RESPONSE_MAX_COUNT
  104. #define CPPHTTPLIB_INTERIM_RESPONSE_MAX_COUNT 100
  105. #endif
  106. #ifndef CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT
  107. #define CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT 1024
  108. #endif
  109. #ifndef CPPHTTPLIB_PAYLOAD_MAX_LENGTH
  110. #define CPPHTTPLIB_PAYLOAD_MAX_LENGTH (100 * 1024 * 1024) // 100MB
  111. #endif
  112. #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. // Lets a wait for data end early once `interrupted` returns true, so that
  1702. // another thread can stop a blocked read on every platform.
  1703. virtual void set_read_interrupt(std::function<bool()> interrupted) {
  1704. (void)interrupted;
  1705. }
  1706. // Bytes already pulled off the socket and sitting in this stream's own
  1707. // buffer. Exposing them lets a line reader scan for a terminator in one
  1708. // pass instead of asking for a byte at a time. A stream that does no
  1709. // buffering of its own reports none, and readers fall back to read().
  1710. virtual const char *buffered_data(size_t &size) const {
  1711. size = 0;
  1712. return nullptr;
  1713. }
  1714. // Discards `size` bytes previously returned by buffered_data().
  1715. virtual void consume_buffered(size_t size) { (void)size; }
  1716. ssize_t write(const char *ptr);
  1717. ssize_t write(const std::string &s);
  1718. Error get_error() const { return error_; }
  1719. protected:
  1720. Error error_ = Error::Success;
  1721. };
  1722. class TaskQueue {
  1723. public:
  1724. TaskQueue() = default;
  1725. virtual ~TaskQueue() = default;
  1726. virtual bool enqueue(std::function<void()> fn) = 0;
  1727. virtual void shutdown() = 0;
  1728. virtual void on_idle() {}
  1729. };
  1730. class ThreadPool final : public TaskQueue {
  1731. public:
  1732. explicit ThreadPool(
  1733. size_t n, size_t max_n = 0, size_t mqr = 0,
  1734. time_t idle_timeout_sec = CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT);
  1735. ThreadPool(const ThreadPool &) = delete;
  1736. ~ThreadPool() override = default;
  1737. bool enqueue(std::function<void()> fn) override;
  1738. void shutdown() override;
  1739. private:
  1740. void worker(bool is_dynamic);
  1741. void move_to_finished(std::thread::id id);
  1742. void cleanup_finished_threads();
  1743. size_t base_thread_count_;
  1744. size_t max_thread_count_;
  1745. size_t max_queued_requests_;
  1746. time_t idle_timeout_sec_;
  1747. size_t idle_thread_count_;
  1748. bool shutdown_;
  1749. std::list<std::function<void()>> jobs_;
  1750. std::vector<std::thread> threads_; // base threads
  1751. std::list<std::thread> dynamic_threads_; // dynamic threads
  1752. std::vector<std::thread>
  1753. finished_threads_; // exited dynamic threads awaiting join
  1754. std::condition_variable cond_;
  1755. std::mutex mutex_;
  1756. };
  1757. using Logger = std::function<void(const Request &, const Response &)>;
  1758. // Forward declaration for Error type
  1759. enum class Error;
  1760. using ErrorLogger = std::function<void(const Error &, const Request *)>;
  1761. using SocketOptions = std::function<void(socket_t sock)>;
  1762. void default_socket_options(socket_t sock);
  1763. bool set_socket_opt(socket_t sock, int level, int optname, int optval);
  1764. const char *status_message(int status);
  1765. std::string to_string(Error error);
  1766. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1767. std::string get_bearer_token_auth(const Request &req);
  1768. namespace detail {
  1769. class MatcherBase {
  1770. public:
  1771. MatcherBase(std::string pattern) : pattern_(std::move(pattern)) {}
  1772. virtual ~MatcherBase() = default;
  1773. const std::string &pattern() const { return pattern_; }
  1774. // Match request path and populate its matches and
  1775. virtual bool match(Request &request) const = 0;
  1776. private:
  1777. std::string pattern_;
  1778. };
  1779. /**
  1780. * Captures parameters in request path and stores them in Request::path_params
  1781. *
  1782. * Capture name is a substring of a pattern from : to /.
  1783. * The rest of the pattern is matched against the request path directly
  1784. * Parameters are captured starting from the next character after
  1785. * the end of the last matched static pattern fragment until the next /.
  1786. *
  1787. * Example pattern:
  1788. * "/path/fragments/:capture/more/fragments/:second_capture"
  1789. * Static fragments:
  1790. * "/path/fragments/", "more/fragments/"
  1791. *
  1792. * Given the following request path:
  1793. * "/path/fragments/:1/more/fragments/:2"
  1794. * the resulting capture will be
  1795. * {{"capture", "1"}, {"second_capture", "2"}}
  1796. */
  1797. class PathParamsMatcher final : public MatcherBase {
  1798. public:
  1799. PathParamsMatcher(const std::string &pattern);
  1800. bool match(Request &request) const override;
  1801. private:
  1802. // Treat segment separators as the end of path parameter capture
  1803. // Does not need to handle query parameters as they are parsed before path
  1804. // matching
  1805. static constexpr char separator = '/';
  1806. // Contains static path fragments to match against, excluding the '/' after
  1807. // path params
  1808. // Fragments are separated by path params
  1809. std::vector<std::string> static_fragments_;
  1810. // Stores the names of the path parameters to be used as keys in the
  1811. // Request::path_params map
  1812. std::vector<std::string> param_names_;
  1813. };
  1814. /**
  1815. * Performs std::regex_match on request path
  1816. * and stores the result in Request::matches
  1817. *
  1818. * Note that regex match is performed directly on the whole request.
  1819. * This means that wildcard patterns may match multiple path segments with /:
  1820. * "/begin/(.*)/end" will match both "/begin/middle/end" and "/begin/1/2/end".
  1821. */
  1822. class RegexMatcher final : public MatcherBase {
  1823. public:
  1824. RegexMatcher(const std::string &pattern)
  1825. : MatcherBase(pattern), regex_(pattern) {}
  1826. bool match(Request &request) const override;
  1827. private:
  1828. std::regex regex_;
  1829. };
  1830. int close_socket(socket_t sock) noexcept;
  1831. bool is_accept_resource_error();
  1832. bool is_accept_transient_error();
  1833. ssize_t write_headers(Stream &strm, const Headers &headers);
  1834. bool set_socket_opt_time(socket_t sock, int level, int optname, time_t sec,
  1835. time_t usec);
  1836. size_t get_multipart_content_length(const UploadFormDataItems &items,
  1837. const std::string &boundary);
  1838. ContentProvider
  1839. make_multipart_content_provider(const UploadFormDataItems &items,
  1840. const std::string &boundary);
  1841. } // namespace detail
  1842. bool is_valid_multipart_boundary(const std::string &boundary);
  1843. // Serializer for multipart/form-data request bodies. The boundary is owned
  1844. // by the writer so that per-part framing and the final terminator always
  1845. // agree. Field names and filenames are escaped following the WHATWG HTML
  1846. // standard ('"' -> %22, CR -> %0D, LF -> %0A); CR and LF are also escaped
  1847. // in content types.
  1848. class MultipartFormDataWriter {
  1849. public:
  1850. MultipartFormDataWriter();
  1851. // precondition: is_valid_multipart_boundary(boundary)
  1852. explicit MultipartFormDataWriter(std::string boundary);
  1853. const std::string &boundary() const;
  1854. std::string content_type() const;
  1855. // In-memory items -> whole body (known length)
  1856. std::string serialize(const UploadFormDataItems &items) const;
  1857. size_t content_length(const UploadFormDataItems &items) const;
  1858. // Per-part framing for streaming via a content provider
  1859. std::string item_begin(const UploadFormData &item) const;
  1860. static std::string item_end();
  1861. std::string finish() const;
  1862. private:
  1863. std::string boundary_;
  1864. };
  1865. class Server {
  1866. public:
  1867. using Handler = std::function<void(const Request &, Response &)>;
  1868. using ExceptionHandler =
  1869. std::function<void(const Request &, Response &, std::exception_ptr ep)>;
  1870. enum class HandlerResponse {
  1871. Handled,
  1872. Unhandled,
  1873. };
  1874. using HandlerWithResponse =
  1875. std::function<HandlerResponse(const Request &, Response &)>;
  1876. using HandlerWithContentReader = std::function<void(
  1877. const Request &, Response &, const ContentReader &content_reader)>;
  1878. using Expect100ContinueHandler =
  1879. std::function<int(const Request &, Response &)>;
  1880. using StartHandler = std::function<void()>;
  1881. using WebSocketHandler =
  1882. std::function<void(const Request &, ws::WebSocket &)>;
  1883. using SubProtocolSelector =
  1884. std::function<std::string(const std::vector<std::string> &protocols)>;
  1885. Server();
  1886. virtual ~Server();
  1887. virtual bool is_valid() const;
  1888. Server &Get(const std::string &pattern, Handler handler);
  1889. Server &Post(const std::string &pattern, Handler handler);
  1890. Server &Post(const std::string &pattern, HandlerWithContentReader handler);
  1891. Server &Put(const std::string &pattern, Handler handler);
  1892. Server &Put(const std::string &pattern, HandlerWithContentReader handler);
  1893. Server &Patch(const std::string &pattern, Handler handler);
  1894. Server &Patch(const std::string &pattern, HandlerWithContentReader handler);
  1895. Server &Delete(const std::string &pattern, Handler handler);
  1896. Server &Delete(const std::string &pattern, HandlerWithContentReader handler);
  1897. Server &Options(const std::string &pattern, Handler handler);
  1898. // Register a handler for an HTTP method outside the built-in set (e.g. the
  1899. // WebDAV methods from RFC 4918). Registering a method here is what makes the
  1900. // server accept it; an unregistered method is still rejected with 400.
  1901. // `method` must be a valid HTTP method token and must not be one of the
  1902. // built-in methods, which have their own registration functions above. A
  1903. // rejected registration makes is_valid() return false, so listen() fails.
  1904. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1905. Handler handler);
  1906. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1907. HandlerWithContentReader handler);
  1908. Server &WebSocket(const std::string &pattern, WebSocketHandler handler);
  1909. Server &WebSocket(const std::string &pattern, WebSocketHandler handler,
  1910. SubProtocolSelector sub_protocol_selector);
  1911. bool set_base_dir(const std::string &dir,
  1912. const std::string &mount_point = std::string());
  1913. bool set_mount_point(const std::string &mount_point, const std::string &dir,
  1914. Headers headers = Headers());
  1915. bool remove_mount_point(const std::string &mount_point);
  1916. Server &set_file_extension_and_mimetype_mapping(const std::string &ext,
  1917. const std::string &mime);
  1918. Server &set_default_file_mimetype(const std::string &mime);
  1919. Server &set_file_request_handler(Handler handler);
  1920. template <class ErrorHandlerFunc>
  1921. Server &set_error_handler(ErrorHandlerFunc &&handler) {
  1922. return set_error_handler_core(
  1923. std::forward<ErrorHandlerFunc>(handler),
  1924. std::is_convertible<ErrorHandlerFunc, HandlerWithResponse>{});
  1925. }
  1926. Server &set_exception_handler(ExceptionHandler handler);
  1927. Server &set_pre_routing_handler(HandlerWithResponse handler);
  1928. Server &set_post_routing_handler(Handler handler);
  1929. Server &set_pre_request_handler(HandlerWithResponse handler);
  1930. Server &set_expect_100_continue_handler(Expect100ContinueHandler handler);
  1931. Server &set_start_handler(StartHandler handler);
  1932. Server &set_logger(Logger logger);
  1933. Server &set_pre_compression_logger(Logger logger);
  1934. Server &set_error_logger(ErrorLogger error_logger);
  1935. Server &set_address_family(int family);
  1936. Server &set_tcp_nodelay(bool on);
  1937. Server &set_ipv6_v6only(bool on);
  1938. Server &set_socket_options(SocketOptions socket_options);
  1939. Server &set_default_headers(Headers headers);
  1940. Server &
  1941. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  1942. Server &set_trusted_proxies(const std::vector<std::string> &proxies);
  1943. Server &set_keep_alive_max_count(size_t count);
  1944. Server &set_keep_alive_timeout(time_t sec);
  1945. template <class Rep, class Period>
  1946. Server &
  1947. set_keep_alive_timeout(const std::chrono::duration<Rep, Period> &duration);
  1948. Server &set_read_timeout(time_t sec, time_t usec = 0);
  1949. template <class Rep, class Period>
  1950. Server &set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  1951. Server &set_write_timeout(time_t sec, time_t usec = 0);
  1952. template <class Rep, class Period>
  1953. Server &set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  1954. Server &set_idle_interval(time_t sec, time_t usec = 0);
  1955. template <class Rep, class Period>
  1956. Server &set_idle_interval(const std::chrono::duration<Rep, Period> &duration);
  1957. Server &set_payload_max_length(size_t length);
  1958. Server &set_compress(bool on);
  1959. Server &set_static_file_compression(bool on);
  1960. Server &set_static_file_compression_min_length(size_t length);
  1961. Server &set_static_file_compression_max_length(size_t length);
  1962. Server &set_websocket_ping_interval(time_t sec);
  1963. template <class Rep, class Period>
  1964. Server &set_websocket_ping_interval(
  1965. const std::chrono::duration<Rep, Period> &duration);
  1966. Server &set_websocket_max_missed_pongs(int count);
  1967. bool bind_to_port(const std::string &host, int port, int socket_flags = 0);
  1968. int bind_to_any_port(const std::string &host, int socket_flags = 0);
  1969. bool listen_after_bind();
  1970. bool listen(const std::string &host, int port, int socket_flags = 0);
  1971. bool is_running() const;
  1972. void wait_until_ready() const;
  1973. void stop() noexcept;
  1974. void decommission();
  1975. std::function<TaskQueue *(void)> new_task_queue;
  1976. protected:
  1977. bool process_request(Stream &strm, const std::string &remote_addr,
  1978. int remote_port, const std::string &local_addr,
  1979. int local_port, bool close_connection,
  1980. bool &connection_closed,
  1981. const std::function<void(Request &)> &setup_request,
  1982. bool *websocket_upgraded = nullptr);
  1983. // Runs the per-connection serving loop and stops an exception thrown by a
  1984. // user callback from escaping the worker thread.
  1985. //
  1986. // process_request() wraps only routing() in a try/catch. Content providers,
  1987. // the post-routing, error, logging and expect-100 handlers and WebSocket
  1988. // handlers all run outside it, and the task queue calls the job without a
  1989. // catch, so an exception from any of those would terminate the process.
  1990. //
  1991. // No 500 is possible here: by the time a content provider runs, the status
  1992. // line and headers are already on the wire. Report it through the error
  1993. // logger and drop the connection, which is what the peer observes either
  1994. // way. Other connections are unaffected.
  1995. template <typename Serve> bool serve_guarded(Serve &&serve) const {
  1996. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  1997. return serve();
  1998. #else
  1999. try {
  2000. return serve();
  2001. } catch (...) {
  2002. // The error logger is a user callback too, so it must not be able to
  2003. // throw the guard back open.
  2004. try {
  2005. output_error_log(Error::UserCallbackException, nullptr);
  2006. } catch (...) {}
  2007. return false;
  2008. }
  2009. #endif
  2010. }
  2011. std::atomic<socket_t> svr_sock_{INVALID_SOCKET};
  2012. std::vector<std::string> trusted_proxies_;
  2013. size_t keep_alive_max_count_ = CPPHTTPLIB_KEEPALIVE_MAX_COUNT;
  2014. time_t keep_alive_timeout_sec_ = CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND;
  2015. time_t read_timeout_sec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND;
  2016. time_t read_timeout_usec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND;
  2017. time_t write_timeout_sec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND;
  2018. time_t write_timeout_usec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND;
  2019. time_t idle_interval_sec_ = CPPHTTPLIB_IDLE_INTERVAL_SECOND;
  2020. time_t idle_interval_usec_ = CPPHTTPLIB_IDLE_INTERVAL_USECOND;
  2021. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2022. bool compress_ = true;
  2023. bool static_file_compression_ = false;
  2024. size_t static_file_compression_min_length_ =
  2025. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH;
  2026. size_t static_file_compression_max_length_ =
  2027. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH;
  2028. time_t websocket_ping_interval_sec_ =
  2029. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  2030. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  2031. private:
  2032. using Handlers =
  2033. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, Handler>>;
  2034. using HandlersForContentReader =
  2035. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>,
  2036. HandlerWithContentReader>>;
  2037. // Both handler tables for one custom method live in a single entry, so that
  2038. // routing() needs only one map lookup per request to reach either of them.
  2039. struct CustomHandlerEntry {
  2040. Handlers handlers;
  2041. HandlersForContentReader handlers_for_content_reader;
  2042. };
  2043. using CustomHandlers = std::map<std::string, CustomHandlerEntry>;
  2044. static std::unique_ptr<detail::MatcherBase>
  2045. make_matcher(const std::string &pattern);
  2046. static const std::set<std::string> &builtin_methods();
  2047. CustomHandlerEntry *custom_entry_for_registration(const std::string &method);
  2048. const CustomHandlerEntry *find_custom_entry(const std::string &method) const;
  2049. template <typename H>
  2050. Server &add_handler(
  2051. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, H>> &handlers,
  2052. const std::string &pattern, H handler) {
  2053. handlers.emplace_back(make_matcher(pattern), std::move(handler));
  2054. return *this;
  2055. }
  2056. Server &set_error_handler_core(HandlerWithResponse handler, std::true_type);
  2057. Server &set_error_handler_core(Handler handler, std::false_type);
  2058. socket_t create_server_socket(const std::string &host, int port,
  2059. int socket_flags,
  2060. SocketOptions socket_options) const;
  2061. int bind_internal(const std::string &host, int port, int socket_flags);
  2062. bool listen_internal();
  2063. bool routing(Request &req, Response &res, Stream &strm,
  2064. bool skip_pre_routing);
  2065. bool handle_file_request(Request &req, Response &res);
  2066. bool check_if_not_modified(const Request &req, Response &res,
  2067. const std::string &etag, time_t mtime) const;
  2068. bool check_if_range(Request &req, const std::string &etag,
  2069. time_t mtime) const;
  2070. bool dispatch_request(Request &req, Response &res, const Handlers &handlers,
  2071. Stream &strm);
  2072. bool dispatch_request_for_content_reader(
  2073. Request &req, Response &res, ContentReader content_reader,
  2074. const HandlersForContentReader &handlers) const;
  2075. bool parse_request_line(const char *s, Request &req) const;
  2076. detail::EncodingType static_file_encoding(const Request &req,
  2077. const Response &res,
  2078. const std::string &content_type,
  2079. size_t length) const;
  2080. bool apply_static_file_compression(const Request &req, Response &res) const;
  2081. void apply_ranges(const Request &req, Response &res,
  2082. std::string &content_type, std::string &boundary) const;
  2083. bool write_response(Stream &strm, bool close_connection, Request &req,
  2084. Response &res);
  2085. bool write_response_with_content(Stream &strm, bool close_connection,
  2086. const Request &req, Response &res);
  2087. bool write_response_core(Stream &strm, bool close_connection,
  2088. const Request &req, Response &res,
  2089. bool need_apply_ranges);
  2090. bool write_content_with_provider(Stream &strm, const Request &req,
  2091. Response &res, const std::string &boundary,
  2092. const std::string &content_type);
  2093. bool read_content(Stream &strm, Request &req, Response &res);
  2094. bool read_content_with_content_receiver(Stream &strm, Request &req,
  2095. Response &res,
  2096. ContentReceiver receiver,
  2097. FormDataHeader multipart_header,
  2098. ContentReceiver multipart_receiver);
  2099. bool read_content_core(Stream &strm, Request &req, Response &res,
  2100. ContentReceiver receiver,
  2101. FormDataHeader multipart_header,
  2102. ContentReceiver multipart_receiver) const;
  2103. virtual bool process_and_close_socket(socket_t sock);
  2104. void output_log(const Request &req, const Response &res) const;
  2105. void output_pre_compression_log(const Request &req,
  2106. const Response &res) const;
  2107. void output_error_log(const Error &err, const Request *req) const;
  2108. std::atomic<bool> is_running_{false};
  2109. std::atomic<bool> is_decommissioned{false};
  2110. // Set when CustomRoute() refuses a registration. Written before listen(),
  2111. // read by is_valid() on the same thread, so it needs no synchronization.
  2112. bool has_invalid_registration_ = false;
  2113. struct MountPointEntry {
  2114. std::string mount_point;
  2115. std::string base_dir;
  2116. std::string resolved_base_dir;
  2117. Headers headers;
  2118. };
  2119. std::vector<MountPointEntry> base_dirs_;
  2120. std::map<std::string, std::string> file_extension_and_mimetype_map_;
  2121. std::string default_file_mimetype_ = "application/octet-stream";
  2122. Handler file_request_handler_;
  2123. Handlers get_handlers_;
  2124. Handlers post_handlers_;
  2125. HandlersForContentReader post_handlers_for_content_reader_;
  2126. Handlers put_handlers_;
  2127. HandlersForContentReader put_handlers_for_content_reader_;
  2128. Handlers patch_handlers_;
  2129. HandlersForContentReader patch_handlers_for_content_reader_;
  2130. Handlers delete_handlers_;
  2131. HandlersForContentReader delete_handlers_for_content_reader_;
  2132. Handlers options_handlers_;
  2133. CustomHandlers custom_handlers_;
  2134. struct WebSocketHandlerEntry {
  2135. std::unique_ptr<detail::MatcherBase> matcher;
  2136. WebSocketHandler handler;
  2137. SubProtocolSelector sub_protocol_selector;
  2138. };
  2139. using WebSocketHandlers = std::vector<WebSocketHandlerEntry>;
  2140. WebSocketHandlers websocket_handlers_;
  2141. HandlerWithResponse error_handler_;
  2142. ExceptionHandler exception_handler_;
  2143. HandlerWithResponse pre_routing_handler_;
  2144. Handler post_routing_handler_;
  2145. HandlerWithResponse pre_request_handler_;
  2146. Expect100ContinueHandler expect_100_continue_handler_;
  2147. StartHandler start_handler_;
  2148. mutable std::mutex logger_mutex_;
  2149. Logger logger_;
  2150. Logger pre_compression_logger_;
  2151. ErrorLogger error_logger_;
  2152. int address_family_ = AF_UNSPEC;
  2153. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2154. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2155. SocketOptions socket_options_ = default_socket_options;
  2156. Headers default_headers_;
  2157. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2158. detail::write_headers;
  2159. };
  2160. class Result {
  2161. public:
  2162. Result() = default;
  2163. Result(std::unique_ptr<Response> &&res, Error err,
  2164. Headers &&request_headers = Headers{})
  2165. : res_(std::move(res)), err_(err),
  2166. request_headers_(std::move(request_headers)) {}
  2167. // Response
  2168. operator bool() const { return res_ != nullptr; }
  2169. bool operator==(std::nullptr_t) const { return res_ == nullptr; }
  2170. bool operator!=(std::nullptr_t) const { return res_ != nullptr; }
  2171. const Response &value() const { return *res_; }
  2172. Response &value() { return *res_; }
  2173. const Response &operator*() const { return *res_; }
  2174. Response &operator*() { return *res_; }
  2175. const Response *operator->() const { return res_.get(); }
  2176. Response *operator->() { return res_.get(); }
  2177. // Error
  2178. Error error() const { return err_; }
  2179. // Request Headers
  2180. bool has_request_header(const std::string &key) const;
  2181. std::string get_request_header_value(const std::string &key,
  2182. const char *def = "",
  2183. size_t id = 0) const;
  2184. size_t get_request_header_value_u64(const std::string &key, size_t def = 0,
  2185. size_t id = 0) const;
  2186. size_t get_request_header_value_count(const std::string &key) const;
  2187. private:
  2188. std::unique_ptr<Response> res_;
  2189. Error err_ = Error::Unknown;
  2190. Headers request_headers_;
  2191. #ifdef CPPHTTPLIB_SSL_ENABLED
  2192. public:
  2193. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2194. int ssl_error)
  2195. : res_(std::move(res)), err_(err),
  2196. request_headers_(std::move(request_headers)), ssl_error_(ssl_error) {}
  2197. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2198. int ssl_error, uint64_t ssl_backend_error)
  2199. : res_(std::move(res)), err_(err),
  2200. request_headers_(std::move(request_headers)), ssl_error_(ssl_error),
  2201. ssl_backend_error_(ssl_backend_error) {}
  2202. int ssl_error() const { return ssl_error_; }
  2203. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  2204. private:
  2205. int ssl_error_ = 0;
  2206. uint64_t ssl_backend_error_ = 0;
  2207. #endif
  2208. };
  2209. struct ClientConnection {
  2210. socket_t sock = INVALID_SOCKET;
  2211. bool is_open() const { return sock != INVALID_SOCKET; }
  2212. ClientConnection() = default;
  2213. ~ClientConnection();
  2214. ClientConnection(const ClientConnection &) = delete;
  2215. ClientConnection &operator=(const ClientConnection &) = delete;
  2216. ClientConnection(ClientConnection &&other) noexcept
  2217. : sock(other.sock)
  2218. #ifdef CPPHTTPLIB_SSL_ENABLED
  2219. ,
  2220. session(other.session)
  2221. #endif
  2222. {
  2223. other.sock = INVALID_SOCKET;
  2224. #ifdef CPPHTTPLIB_SSL_ENABLED
  2225. other.session = nullptr;
  2226. #endif
  2227. }
  2228. ClientConnection &operator=(ClientConnection &&other) noexcept {
  2229. if (this != &other) {
  2230. sock = other.sock;
  2231. other.sock = INVALID_SOCKET;
  2232. #ifdef CPPHTTPLIB_SSL_ENABLED
  2233. session = other.session;
  2234. other.session = nullptr;
  2235. #endif
  2236. }
  2237. return *this;
  2238. }
  2239. #ifdef CPPHTTPLIB_SSL_ENABLED
  2240. tls::session_t session = nullptr;
  2241. #endif
  2242. };
  2243. namespace detail {
  2244. struct ChunkedDecoder;
  2245. struct BodyReader {
  2246. Stream *stream = nullptr;
  2247. bool has_content_length = false;
  2248. size_t content_length = 0;
  2249. size_t payload_max_length = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2250. size_t bytes_read = 0;
  2251. bool chunked = false;
  2252. bool eof = false;
  2253. std::unique_ptr<ChunkedDecoder> chunked_decoder;
  2254. Error last_error = Error::Success;
  2255. ssize_t read(char *buf, size_t len);
  2256. bool has_error() const { return last_error != Error::Success; }
  2257. };
  2258. inline ssize_t read_body_content(Stream *stream, BodyReader &br, char *buf,
  2259. size_t len) {
  2260. (void)stream;
  2261. return br.read(buf, len);
  2262. }
  2263. class decompressor;
  2264. enum class NoProxyKind {
  2265. Wildcard, // "*"
  2266. HostnameSuffix, // "example.com" or ".example.com"
  2267. IPv4Cidr, // "10.0.0.0/8" (or single IP, treated as /32)
  2268. IPv6Cidr, // "fe80::/10" (or single IP, treated as /128)
  2269. };
  2270. // Unified 16-byte buffer holding either a v4 (first 4 bytes) or v6 address.
  2271. // Lets one CIDR matcher cover both families.
  2272. using IPBytes = std::array<uint8_t, 16>;
  2273. struct NoProxyEntry {
  2274. NoProxyKind kind = NoProxyKind::Wildcard;
  2275. std::string hostname_pattern; // lowercased, leading/trailing dot stripped
  2276. IPBytes net{};
  2277. int prefix_bits = 0;
  2278. };
  2279. struct NormalizedTarget {
  2280. std::string hostname; // lowercase; brackets and trailing dot removed
  2281. bool is_ipv4 = false;
  2282. bool is_ipv6 = false;
  2283. IPBytes ip{};
  2284. };
  2285. } // namespace detail
  2286. class ClientImpl {
  2287. public:
  2288. explicit ClientImpl(const std::string &host);
  2289. explicit ClientImpl(const std::string &host, int port);
  2290. explicit ClientImpl(const std::string &host, int port,
  2291. const std::string &client_cert_path,
  2292. const std::string &client_key_path);
  2293. virtual ~ClientImpl();
  2294. virtual bool is_valid() const;
  2295. struct StreamHandle {
  2296. std::unique_ptr<Response> response;
  2297. Error error = Error::Success;
  2298. StreamHandle() = default;
  2299. StreamHandle(const StreamHandle &) = delete;
  2300. StreamHandle &operator=(const StreamHandle &) = delete;
  2301. StreamHandle(StreamHandle &&) = default;
  2302. StreamHandle &operator=(StreamHandle &&) = default;
  2303. ~StreamHandle() = default;
  2304. bool is_valid() const {
  2305. return response != nullptr && error == Error::Success;
  2306. }
  2307. ssize_t read(char *buf, size_t len);
  2308. void parse_trailers_if_needed();
  2309. Error get_read_error() const { return body_reader_.last_error; }
  2310. bool has_read_error() const { return body_reader_.has_error(); }
  2311. bool trailers_parsed_ = false;
  2312. private:
  2313. friend class ClientImpl;
  2314. friend class sse::SSEClient;
  2315. ssize_t read_with_decompression(char *buf, size_t len);
  2316. std::unique_ptr<ClientConnection> connection_;
  2317. std::unique_ptr<Stream> socket_stream_;
  2318. Stream *stream_ = nullptr;
  2319. detail::BodyReader body_reader_;
  2320. std::unique_ptr<detail::decompressor> decompressor_;
  2321. std::string decompress_buffer_;
  2322. size_t decompress_offset_ = 0;
  2323. size_t decompressed_bytes_read_ = 0;
  2324. };
  2325. // clang-format off
  2326. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2327. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2328. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2329. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2330. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2331. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2332. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2333. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2334. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2335. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2336. Result Head(const std::string &path);
  2337. Result Head(const std::string &path, const Headers &headers);
  2338. Result Post(const std::string &path);
  2339. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2340. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2341. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2342. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2343. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2344. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2345. Result Post(const std::string &path, const Params &params);
  2346. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2347. Result Post(const std::string &path, const Headers &headers);
  2348. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2349. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2350. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2351. 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);
  2352. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2353. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2354. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2355. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2356. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2357. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2358. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2359. Result Put(const std::string &path);
  2360. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2361. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2362. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2363. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2364. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2365. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2366. Result Put(const std::string &path, const Params &params);
  2367. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2368. Result Put(const std::string &path, const Headers &headers);
  2369. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2370. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2371. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2372. 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);
  2373. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2374. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2375. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2376. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2377. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2378. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2379. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2380. Result Patch(const std::string &path);
  2381. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2382. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2383. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2384. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2385. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2386. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2387. Result Patch(const std::string &path, const Params &params);
  2388. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2389. Result Patch(const std::string &path, const Headers &headers, UploadProgress progress = nullptr);
  2390. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2391. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2392. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2393. 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);
  2394. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2395. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2396. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2397. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2398. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2399. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2400. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2401. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2402. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2403. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2404. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2405. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2406. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2407. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2408. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2409. Result Options(const std::string &path);
  2410. Result Options(const std::string &path, const Headers &headers);
  2411. // clang-format on
  2412. // Streaming API: Open a stream for reading response body incrementally
  2413. // Socket ownership is transferred to StreamHandle for true streaming
  2414. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2415. StreamHandle open_stream(const std::string &method, const std::string &path,
  2416. const Params &params = {},
  2417. const Headers &headers = {},
  2418. const std::string &body = {},
  2419. const std::string &content_type = {});
  2420. bool send(Request &req, Response &res, Error &error);
  2421. Result send(const Request &req);
  2422. void stop();
  2423. std::string host() const;
  2424. int port() const;
  2425. size_t is_socket_open() const;
  2426. socket_t socket() const;
  2427. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2428. void set_default_headers(Headers headers);
  2429. void
  2430. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2431. void set_address_family(int family);
  2432. void set_tcp_nodelay(bool on);
  2433. void set_ipv6_v6only(bool on);
  2434. void set_socket_options(SocketOptions socket_options);
  2435. void set_connection_timeout(time_t sec, time_t usec = 0);
  2436. template <class Rep, class Period>
  2437. void
  2438. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2439. void set_read_timeout(time_t sec, time_t usec = 0);
  2440. template <class Rep, class Period>
  2441. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2442. void set_write_timeout(time_t sec, time_t usec = 0);
  2443. template <class Rep, class Period>
  2444. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2445. void set_max_timeout(time_t msec);
  2446. template <class Rep, class Period>
  2447. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2448. void set_basic_auth(const std::string &username, const std::string &password);
  2449. void set_bearer_token_auth(const std::string &token);
  2450. void set_keep_alive(bool on);
  2451. void set_follow_location(bool on);
  2452. void set_path_encode(bool on);
  2453. void set_compress(bool on);
  2454. void set_decompress(bool on);
  2455. void set_payload_max_length(size_t length);
  2456. void set_interface(const std::string &intf);
  2457. void set_proxy(const std::string &host, int port);
  2458. void set_proxy_basic_auth(const std::string &username,
  2459. const std::string &password);
  2460. void set_proxy_bearer_token_auth(const std::string &token);
  2461. void set_no_proxy(const std::vector<std::string> &patterns);
  2462. void set_logger(Logger logger);
  2463. void set_error_logger(ErrorLogger error_logger);
  2464. protected:
  2465. struct Socket {
  2466. socket_t sock = INVALID_SOCKET;
  2467. // For Mbed TLS compatibility: start_time for request timeout tracking
  2468. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  2469. bool is_open() const { return sock != INVALID_SOCKET; }
  2470. #ifdef CPPHTTPLIB_SSL_ENABLED
  2471. tls::session_t ssl = nullptr;
  2472. #endif
  2473. };
  2474. virtual bool create_and_connect_socket(Socket &socket, Error &error);
  2475. virtual bool ensure_socket_connection(Socket &socket, Error &error);
  2476. virtual bool setup_proxy_connection(
  2477. Socket &socket,
  2478. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2479. Response &res, bool &success, Error &error);
  2480. bool is_proxy_enabled_for_host(const std::string &host) const;
  2481. // All of:
  2482. // shutdown_ssl
  2483. // shutdown_socket
  2484. // close_socket
  2485. // disconnect
  2486. // should ONLY be called when socket_mutex_ is locked, and only when
  2487. // no other thread is using the socket.
  2488. virtual void shutdown_ssl(Socket &socket, bool shutdown_gracefully);
  2489. void shutdown_socket(Socket &socket) const;
  2490. void close_socket(Socket &socket);
  2491. void disconnect(bool gracefully);
  2492. std::string make_request_target(const Request &req) const;
  2493. bool process_request(Stream &strm, Request &req, Response &res,
  2494. bool close_connection, Error &error);
  2495. bool write_content_with_provider(Stream &strm, const Request &req,
  2496. Error &error) const;
  2497. void output_log(const Request &req, const Response &res) const;
  2498. void output_error_log(const Error &err, const Request *req) const;
  2499. // Socket endpoint information
  2500. const std::string host_;
  2501. const int port_;
  2502. // Current open socket
  2503. Socket socket_;
  2504. mutable std::mutex socket_mutex_;
  2505. std::recursive_mutex request_mutex_;
  2506. // How many send() calls are running on this client, guarded by
  2507. // request_mutex_
  2508. size_t send_depth_ = 0;
  2509. // These are all protected under socket_mutex
  2510. size_t socket_requests_in_flight_ = 0;
  2511. std::thread::id socket_requests_are_from_thread_ = std::thread::id();
  2512. bool socket_should_be_closed_when_request_is_done_ = false;
  2513. // Hostname to connection target map. The value is an IP literal or another
  2514. // hostname; only the connection target changes, never the identity.
  2515. std::map<std::string, std::string> addr_map_;
  2516. // Default headers
  2517. Headers default_headers_;
  2518. // Header writer
  2519. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2520. detail::write_headers;
  2521. // Settings
  2522. std::string client_cert_path_;
  2523. std::string client_key_path_;
  2524. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  2525. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  2526. time_t read_timeout_sec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND;
  2527. time_t read_timeout_usec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND;
  2528. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  2529. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  2530. time_t max_timeout_msec_ = CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND;
  2531. std::string basic_auth_username_;
  2532. std::string basic_auth_password_;
  2533. std::string bearer_token_auth_token_;
  2534. bool keep_alive_ = false;
  2535. bool follow_location_ = false;
  2536. bool path_encode_ = true;
  2537. int address_family_ = AF_UNSPEC;
  2538. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2539. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2540. SocketOptions socket_options_ = nullptr;
  2541. bool compress_ = false;
  2542. bool decompress_ = true;
  2543. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2544. bool has_payload_max_length_ = false;
  2545. std::string interface_;
  2546. std::string proxy_host_;
  2547. int proxy_port_ = -1;
  2548. std::string proxy_basic_auth_username_;
  2549. std::string proxy_basic_auth_password_;
  2550. std::string proxy_bearer_token_auth_token_;
  2551. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  2552. mutable detail::NormalizedTarget host_normalized_;
  2553. mutable bool host_normalized_valid_ = false;
  2554. mutable std::mutex logger_mutex_;
  2555. Logger logger_;
  2556. ErrorLogger error_logger_;
  2557. private:
  2558. bool send_(Request &req, Response &res, Error &error);
  2559. Result send_(Request &&req);
  2560. socket_t create_client_socket(Error &error) const;
  2561. bool read_response_line(Stream &strm, const Request &req, Response &res,
  2562. bool skip_100_continue = true) const;
  2563. bool write_request(Stream &strm, Request &req, bool close_connection,
  2564. Error &error, bool skip_body, bool &rejected_locally);
  2565. bool write_request_body(Stream &strm, Request &req, Error &error);
  2566. void prepare_default_headers(Request &r, bool for_stream,
  2567. const std::string &ct);
  2568. bool redirect(Request &req, Response &res, Error &error);
  2569. bool create_redirect_client(const std::string &scheme,
  2570. const std::string &host, int port, Request &req,
  2571. Response &res, const std::string &path,
  2572. const std::string &location, Error &error);
  2573. template <typename ClientType> void setup_redirect_client(ClientType &client);
  2574. bool handle_request(Stream &strm, Request &req, Response &res,
  2575. bool close_connection, Error &error);
  2576. std::unique_ptr<Response> send_with_content_provider_and_receiver(
  2577. Request &req, const char *body, size_t content_length,
  2578. ContentProvider content_provider,
  2579. ContentProviderWithoutLength content_provider_without_length,
  2580. const std::string &content_type, ContentReceiver content_receiver,
  2581. Error &error);
  2582. Result send_with_content_provider_and_receiver(
  2583. const std::string &method, const std::string &path,
  2584. const Headers &headers, const char *body, size_t content_length,
  2585. ContentProvider content_provider,
  2586. ContentProviderWithoutLength content_provider_without_length,
  2587. const std::string &content_type, ContentReceiver content_receiver,
  2588. UploadProgress progress);
  2589. ContentProviderWithoutLength get_multipart_content_provider(
  2590. const std::string &boundary, const UploadFormDataItems &items,
  2591. const FormDataProviderItems &provider_items) const;
  2592. virtual bool
  2593. process_socket(const Socket &socket,
  2594. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2595. std::function<bool(Stream &strm)> callback);
  2596. virtual bool is_ssl() const;
  2597. void transfer_socket_ownership_to_handle(StreamHandle &handle);
  2598. StreamHandle open_stream_(Request &req);
  2599. void add_credential_headers(Request &req);
  2600. std::string proxy_target_prefix() const;
  2601. #ifdef CPPHTTPLIB_SSL_ENABLED
  2602. public:
  2603. void set_digest_auth(const std::string &username,
  2604. const std::string &password);
  2605. void set_proxy_digest_auth(const std::string &username,
  2606. const std::string &password);
  2607. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2608. const std::string &ca_cert_dir_path = std::string());
  2609. void enable_server_certificate_verification(bool enabled);
  2610. void enable_server_hostname_verification(bool enabled);
  2611. void enable_system_ca(bool enabled);
  2612. protected:
  2613. std::string digest_auth_username_;
  2614. std::string digest_auth_password_;
  2615. std::string proxy_digest_auth_username_;
  2616. std::string proxy_digest_auth_password_;
  2617. std::string ca_cert_file_path_;
  2618. std::string ca_cert_dir_path_;
  2619. bool server_certificate_verification_ = true;
  2620. bool server_hostname_verification_ = true;
  2621. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  2622. std::string ca_cert_pem_; // Store CA cert PEM for redirect transfer
  2623. int last_ssl_error_ = 0;
  2624. uint64_t last_backend_error_ = 0;
  2625. #endif
  2626. };
  2627. namespace detail {
  2628. // Stands in for a client that Client could not make from its arguments, so a
  2629. // request fails rather than going through a null pointer.
  2630. class InvalidClientImpl final : public ClientImpl {
  2631. public:
  2632. InvalidClientImpl() : ClientImpl(std::string(), 0) {}
  2633. bool is_valid() const override { return false; }
  2634. private:
  2635. bool create_and_connect_socket(Socket &, Error &error) override {
  2636. error = Error::Connection;
  2637. return false;
  2638. }
  2639. };
  2640. } // namespace detail
  2641. class Client {
  2642. public:
  2643. // Universal interface
  2644. explicit Client(const std::string &scheme_host_port);
  2645. explicit Client(const std::string &scheme_host_port,
  2646. const std::string &client_cert_path,
  2647. const std::string &client_key_path);
  2648. // HTTP only interface
  2649. explicit Client(const std::string &host, int port);
  2650. explicit Client(const std::string &host, int port,
  2651. const std::string &client_cert_path,
  2652. const std::string &client_key_path);
  2653. Client(Client &&) = default;
  2654. Client &operator=(Client &&) = default;
  2655. ~Client();
  2656. bool is_valid() const;
  2657. // clang-format off
  2658. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2659. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2660. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2661. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2662. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2663. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2664. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2665. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2666. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2667. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2668. Result Head(const std::string &path);
  2669. Result Head(const std::string &path, const Headers &headers);
  2670. Result Post(const std::string &path);
  2671. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2672. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2673. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2674. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2675. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2676. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2677. Result Post(const std::string &path, const Params &params);
  2678. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2679. Result Post(const std::string &path, const Headers &headers);
  2680. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2681. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2682. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2683. 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);
  2684. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2685. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2686. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2687. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2688. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2689. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2690. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2691. Result Put(const std::string &path);
  2692. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2693. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2694. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2695. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2696. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2697. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2698. Result Put(const std::string &path, const Params &params);
  2699. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2700. Result Put(const std::string &path, const Headers &headers);
  2701. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2702. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2703. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2704. 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);
  2705. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2706. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2707. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2708. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2709. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2710. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2711. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2712. Result Patch(const std::string &path);
  2713. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2714. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2715. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2716. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2717. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2718. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2719. Result Patch(const std::string &path, const Params &params);
  2720. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2721. Result Patch(const std::string &path, const Headers &headers);
  2722. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2723. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2724. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2725. 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);
  2726. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2727. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2728. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2729. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2730. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2731. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2732. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2733. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2734. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2735. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2736. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2737. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2738. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2739. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2740. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2741. Result Options(const std::string &path);
  2742. Result Options(const std::string &path, const Headers &headers);
  2743. // clang-format on
  2744. // Streaming API: Open a stream for reading response body incrementally
  2745. // Socket ownership is transferred to StreamHandle for true streaming
  2746. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2747. ClientImpl::StreamHandle open_stream(const std::string &method,
  2748. const std::string &path,
  2749. const Params &params = {},
  2750. const Headers &headers = {},
  2751. const std::string &body = {},
  2752. const std::string &content_type = {});
  2753. bool send(Request &req, Response &res, Error &error);
  2754. Result send(const Request &req);
  2755. void stop();
  2756. std::string host() const;
  2757. int port() const;
  2758. size_t is_socket_open() const;
  2759. socket_t socket() const;
  2760. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2761. void set_default_headers(Headers headers);
  2762. void
  2763. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2764. void set_address_family(int family);
  2765. void set_tcp_nodelay(bool on);
  2766. void set_socket_options(SocketOptions socket_options);
  2767. void set_connection_timeout(time_t sec, time_t usec = 0);
  2768. template <class Rep, class Period>
  2769. void
  2770. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2771. void set_read_timeout(time_t sec, time_t usec = 0);
  2772. template <class Rep, class Period>
  2773. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2774. void set_write_timeout(time_t sec, time_t usec = 0);
  2775. template <class Rep, class Period>
  2776. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2777. void set_max_timeout(time_t msec);
  2778. template <class Rep, class Period>
  2779. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2780. void set_basic_auth(const std::string &username, const std::string &password);
  2781. void set_bearer_token_auth(const std::string &token);
  2782. void set_keep_alive(bool on);
  2783. void set_follow_location(bool on);
  2784. void set_path_encode(bool on);
  2785. void set_compress(bool on);
  2786. void set_decompress(bool on);
  2787. void set_payload_max_length(size_t length);
  2788. void set_interface(const std::string &intf);
  2789. void set_proxy(const std::string &host, int port);
  2790. void set_proxy_basic_auth(const std::string &username,
  2791. const std::string &password);
  2792. void set_proxy_bearer_token_auth(const std::string &token);
  2793. void set_no_proxy(const std::vector<std::string> &patterns);
  2794. void set_logger(Logger logger);
  2795. void set_error_logger(ErrorLogger error_logger);
  2796. private:
  2797. std::unique_ptr<ClientImpl> cli_;
  2798. #ifdef CPPHTTPLIB_SSL_ENABLED
  2799. public:
  2800. void set_digest_auth(const std::string &username,
  2801. const std::string &password);
  2802. void set_proxy_digest_auth(const std::string &username,
  2803. const std::string &password);
  2804. void enable_server_certificate_verification(bool enabled);
  2805. void enable_server_hostname_verification(bool enabled);
  2806. void enable_system_ca(bool enabled);
  2807. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2808. const std::string &ca_cert_dir_path = std::string());
  2809. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2810. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2811. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2812. void set_session_verifier(
  2813. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2814. tls::ctx_t tls_context() const;
  2815. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2816. void enable_windows_certificate_verification(bool enabled);
  2817. #endif
  2818. private:
  2819. bool is_ssl_ = false;
  2820. #endif
  2821. };
  2822. #ifdef CPPHTTPLIB_SSL_ENABLED
  2823. class SSLServer : public Server {
  2824. public:
  2825. SSLServer(const char *cert_path, const char *private_key_path,
  2826. const char *client_ca_cert_file_path = nullptr,
  2827. const char *client_ca_cert_dir_path = nullptr,
  2828. const char *private_key_password = nullptr);
  2829. struct PemMemory {
  2830. const char *cert_pem;
  2831. size_t cert_pem_len;
  2832. const char *key_pem;
  2833. size_t key_pem_len;
  2834. const char *client_ca_pem;
  2835. size_t client_ca_pem_len;
  2836. const char *private_key_password;
  2837. };
  2838. explicit SSLServer(const PemMemory &pem);
  2839. // The callback receives the ctx_t handle which can be cast to the
  2840. // appropriate backend type (SSL_CTX* for OpenSSL,
  2841. // tls::impl::MbedTlsContext* for Mbed TLS)
  2842. explicit SSLServer(const tls::ContextSetupCallback &setup_callback);
  2843. ~SSLServer() override;
  2844. bool is_valid() const override;
  2845. bool update_certs_pem(const char *cert_pem, const char *key_pem,
  2846. const char *client_ca_pem = nullptr,
  2847. const char *password = nullptr);
  2848. tls::ctx_t tls_context() const { return ctx_; }
  2849. int ssl_last_error() const { return last_ssl_error_; }
  2850. private:
  2851. bool process_and_close_socket(socket_t sock) override;
  2852. tls::ctx_t ctx_ = nullptr;
  2853. // update_certs_pem() replaces the certificates and CAs that handshakes read
  2854. // from ctx_, so it waits for the handshakes in progress, which their timeout
  2855. // bounds, and new ones wait while it is pending so that they cannot keep it
  2856. // waiting.
  2857. std::mutex ctx_mutex_;
  2858. std::condition_variable ctx_cv_;
  2859. size_t handshakes_in_progress_ = 0;
  2860. size_t updates_pending_ = 0;
  2861. int last_ssl_error_ = 0;
  2862. };
  2863. class SSLClient final : public ClientImpl {
  2864. public:
  2865. explicit SSLClient(const std::string &host);
  2866. explicit SSLClient(const std::string &host, int port);
  2867. explicit SSLClient(const std::string &host, int port,
  2868. const std::string &client_cert_path,
  2869. const std::string &client_key_path,
  2870. const std::string &private_key_password = std::string());
  2871. struct PemMemory {
  2872. const char *cert_pem;
  2873. size_t cert_pem_len;
  2874. const char *key_pem;
  2875. size_t key_pem_len;
  2876. const char *private_key_password;
  2877. };
  2878. explicit SSLClient(const std::string &host, int port, const PemMemory &pem);
  2879. ~SSLClient() override;
  2880. bool is_valid() const override;
  2881. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2882. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2883. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2884. // Post-handshake session verifier (backend-independent)
  2885. void set_session_verifier(
  2886. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2887. tls::ctx_t tls_context() const { return ctx_; }
  2888. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2889. void enable_windows_certificate_verification(bool enabled);
  2890. #endif
  2891. private:
  2892. bool create_and_connect_socket(Socket &socket, Error &error) override;
  2893. bool ensure_socket_connection(Socket &socket, Error &error) override;
  2894. void shutdown_ssl(Socket &socket, bool shutdown_gracefully) override;
  2895. void shutdown_ssl_impl(Socket &socket, bool shutdown_gracefully);
  2896. bool
  2897. process_socket(const Socket &socket,
  2898. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2899. std::function<bool(Stream &strm)> callback) override;
  2900. bool is_ssl() const override;
  2901. bool setup_proxy_connection(
  2902. Socket &socket,
  2903. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2904. Response &res, bool &success, Error &error) override;
  2905. bool connect_with_proxy(
  2906. Socket &sock,
  2907. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2908. Response &res, bool &success, Error &error);
  2909. bool initialize_ssl(Socket &socket, Error &error);
  2910. void init_ctx();
  2911. void reset_ctx_on_error();
  2912. bool load_certs();
  2913. tls::ctx_t ctx_ = nullptr;
  2914. std::mutex ctx_mutex_;
  2915. std::once_flag initialize_cert_;
  2916. // Tracks whether a custom CA store was applied via set_ca_cert_store(),
  2917. // since the store handle itself is owned by ctx_ and leaves no other trace.
  2918. bool ca_cert_store_set_ = false;
  2919. // Set by set_ca_cert_store() and load_ca_cert_store() even when they bring
  2920. // no certificate, so that a CA that failed to come through fails
  2921. // verification instead of letting the system CAs in.
  2922. bool custom_ca_loaded_ = false;
  2923. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  2924. // Like ca_cert_store_set_, keeps what ctx_ cannot report back: the verifier
  2925. // set_server_certificate_verifier() installed there.
  2926. tls::VerifyCallback server_certificate_verifier_;
  2927. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2928. bool enable_windows_cert_verification_ = true;
  2929. #endif
  2930. friend class ClientImpl;
  2931. };
  2932. #endif // CPPHTTPLIB_SSL_ENABLED
  2933. namespace detail {
  2934. template <typename T, typename U>
  2935. inline void duration_to_sec_and_usec(const T &duration, U callback) {
  2936. auto sec = std::chrono::duration_cast<std::chrono::seconds>(duration).count();
  2937. auto usec = std::chrono::duration_cast<std::chrono::microseconds>(
  2938. duration - std::chrono::seconds(sec))
  2939. .count();
  2940. callback(static_cast<time_t>(sec), static_cast<time_t>(usec));
  2941. }
  2942. template <size_t N> inline constexpr size_t str_len(const char (&)[N]) {
  2943. return N - 1;
  2944. }
  2945. inline bool is_numeric(const std::string &str) {
  2946. return !str.empty() && std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  2947. }
  2948. // std::ranges::next(first, n, last) for C++11
  2949. template <typename It> inline It bounded_next(It first, size_t n, It last) {
  2950. for (; n > 0 && first != last; --n) {
  2951. ++first;
  2952. }
  2953. return first;
  2954. }
  2955. inline size_t get_header_value_u64(const Headers &headers,
  2956. const std::string &key, size_t def,
  2957. size_t id, bool &is_invalid_value) {
  2958. is_invalid_value = false;
  2959. auto rng = headers.equal_range(key);
  2960. auto it = bounded_next(rng.first, id, rng.second);
  2961. if (it != rng.second) {
  2962. if (is_numeric(it->second)) {
  2963. // Parse at size_t width so an out-of-range Content-Length is reported
  2964. // rather than silently saturated/truncated (a value above 2^32 would
  2965. // otherwise wrap to a small framing length on 32-bit builds). Flag it
  2966. // and return SIZE_MAX so the existing oversized-value guards reject it.
  2967. size_t val = 0;
  2968. const auto &s = it->second;
  2969. auto r = from_chars(s.data(), s.data() + s.size(), val);
  2970. if (r.ec == std::errc::result_out_of_range) {
  2971. is_invalid_value = true;
  2972. return (std::numeric_limits<size_t>::max)();
  2973. }
  2974. return val;
  2975. } else {
  2976. is_invalid_value = true;
  2977. }
  2978. }
  2979. return def;
  2980. }
  2981. inline size_t get_header_value_u64(const Headers &headers,
  2982. const std::string &key, size_t def,
  2983. size_t id) {
  2984. auto dummy = false;
  2985. return get_header_value_u64(headers, key, def, id, dummy);
  2986. }
  2987. } // namespace detail
  2988. template <class Rep, class Period>
  2989. inline Server &
  2990. Server::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2991. detail::duration_to_sec_and_usec(
  2992. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  2993. return *this;
  2994. }
  2995. template <class Rep, class Period>
  2996. inline Server &
  2997. Server::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2998. detail::duration_to_sec_and_usec(
  2999. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3000. return *this;
  3001. }
  3002. template <class Rep, class Period>
  3003. inline Server &
  3004. Server::set_idle_interval(const std::chrono::duration<Rep, Period> &duration) {
  3005. detail::duration_to_sec_and_usec(
  3006. duration, [&](time_t sec, time_t usec) { set_idle_interval(sec, usec); });
  3007. return *this;
  3008. }
  3009. template <class Rep, class Period>
  3010. inline void ClientImpl::set_connection_timeout(
  3011. const std::chrono::duration<Rep, Period> &duration) {
  3012. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  3013. set_connection_timeout(sec, usec);
  3014. });
  3015. }
  3016. template <class Rep, class Period>
  3017. inline void ClientImpl::set_read_timeout(
  3018. const std::chrono::duration<Rep, Period> &duration) {
  3019. detail::duration_to_sec_and_usec(
  3020. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3021. }
  3022. template <class Rep, class Period>
  3023. inline void ClientImpl::set_write_timeout(
  3024. const std::chrono::duration<Rep, Period> &duration) {
  3025. detail::duration_to_sec_and_usec(
  3026. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3027. }
  3028. template <class Rep, class Period>
  3029. inline void ClientImpl::set_max_timeout(
  3030. const std::chrono::duration<Rep, Period> &duration) {
  3031. auto msec =
  3032. std::chrono::duration_cast<std::chrono::milliseconds>(duration).count();
  3033. set_max_timeout(static_cast<time_t>(msec));
  3034. }
  3035. template <class Rep, class Period>
  3036. inline void Client::set_connection_timeout(
  3037. const std::chrono::duration<Rep, Period> &duration) {
  3038. cli_->set_connection_timeout(duration);
  3039. }
  3040. template <class Rep, class Period>
  3041. inline void
  3042. Client::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3043. cli_->set_read_timeout(duration);
  3044. }
  3045. template <class Rep, class Period>
  3046. inline void
  3047. Client::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3048. cli_->set_write_timeout(duration);
  3049. }
  3050. inline void Client::set_max_timeout(time_t msec) {
  3051. cli_->set_max_timeout(msec);
  3052. }
  3053. template <class Rep, class Period>
  3054. inline void
  3055. Client::set_max_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3056. cli_->set_max_timeout(duration);
  3057. }
  3058. /*
  3059. * Forward declarations and types that will be part of the .h file if split into
  3060. * .h + .cc.
  3061. */
  3062. std::string hosted_at(const std::string &hostname);
  3063. void hosted_at(const std::string &hostname, std::vector<std::string> &addrs);
  3064. // JavaScript-style URL encoding/decoding functions
  3065. std::string encode_uri_component(const std::string &value);
  3066. std::string encode_uri(const std::string &value);
  3067. std::string decode_uri_component(const std::string &value);
  3068. std::string decode_uri(const std::string &value);
  3069. // RFC 3986 compliant URL component encoding/decoding functions
  3070. std::string encode_path_component(const std::string &component);
  3071. std::string decode_path_component(const std::string &component);
  3072. std::string encode_query_component(const std::string &component,
  3073. bool space_as_plus = true);
  3074. std::string decode_query_component(const std::string &component,
  3075. bool plus_as_space = true);
  3076. std::string sanitize_filename(const std::string &filename);
  3077. std::string append_query_params(const std::string &path, const Params &params);
  3078. std::pair<std::string, std::string> make_range_header(const Ranges &ranges);
  3079. std::pair<std::string, std::string>
  3080. make_basic_authentication_header(const std::string &username,
  3081. const std::string &password,
  3082. bool is_proxy = false);
  3083. namespace detail {
  3084. #if defined(_WIN32)
  3085. inline std::wstring u8string_to_wstring(const char *s) {
  3086. if (!s) { return std::wstring(); }
  3087. auto len = static_cast<int>(strlen(s));
  3088. if (!len) { return std::wstring(); }
  3089. auto wlen = ::MultiByteToWideChar(CP_UTF8, 0, s, len, nullptr, 0);
  3090. if (!wlen) { return std::wstring(); }
  3091. std::wstring ws;
  3092. ws.resize(wlen);
  3093. wlen = ::MultiByteToWideChar(
  3094. CP_UTF8, 0, s, len,
  3095. const_cast<LPWSTR>(reinterpret_cast<LPCWSTR>(ws.data())), wlen);
  3096. if (wlen != static_cast<int>(ws.size())) { ws.clear(); }
  3097. return ws;
  3098. }
  3099. #endif
  3100. struct FileStat {
  3101. FileStat(const std::string &path);
  3102. bool is_file() const;
  3103. bool is_dir() const;
  3104. time_t mtime() const;
  3105. size_t size() const;
  3106. private:
  3107. #if defined(_WIN32)
  3108. struct _stat st_;
  3109. #else
  3110. struct stat st_;
  3111. #endif
  3112. int ret_ = -1;
  3113. };
  3114. std::string make_host_and_port_string(const std::string &host, int port,
  3115. bool is_ssl);
  3116. template <typename T>
  3117. bool check_and_write_headers(Stream &strm, Headers &headers, T header_writer,
  3118. Error &error);
  3119. std::string trim_copy(const std::string &s);
  3120. void divide(
  3121. const char *data, std::size_t size, char d,
  3122. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3123. fn);
  3124. void divide(
  3125. const std::string &str, char d,
  3126. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3127. fn);
  3128. void split(const char *b, const char *e, char d,
  3129. std::function<void(const char *, const char *)> fn);
  3130. void split(const char *b, const char *e, char d, size_t m,
  3131. std::function<void(const char *, const char *)> fn);
  3132. bool split_find(const char *b, const char *e, char d,
  3133. std::function<bool(const char *, const char *)> fn);
  3134. bool has_header_token(const Headers &headers, const std::string &key,
  3135. const std::string &token);
  3136. std::string websocket_accept_key(const std::string &client_key);
  3137. bool is_websocket_upgrade(const Request &req);
  3138. bool process_client_socket(
  3139. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  3140. time_t write_timeout_sec, time_t write_timeout_usec,
  3141. time_t max_timeout_msec,
  3142. std::chrono::time_point<std::chrono::steady_clock> start_time,
  3143. std::function<bool(Stream &)> callback);
  3144. socket_t create_client_socket(const std::string &host, const std::string &ip,
  3145. int port, int address_family, bool tcp_nodelay,
  3146. bool ipv6_v6only, SocketOptions socket_options,
  3147. time_t connection_timeout_sec,
  3148. time_t connection_timeout_usec,
  3149. time_t read_timeout_sec, time_t read_timeout_usec,
  3150. time_t write_timeout_sec,
  3151. time_t write_timeout_usec,
  3152. const std::string &intf, Error &error);
  3153. const char *get_header_value(const Headers &headers, const std::string &key,
  3154. const char *def, size_t id);
  3155. std::string get_combined_header_value(const Headers &headers,
  3156. const std::string &key);
  3157. std::string params_to_query_str(const Params &params);
  3158. void parse_query_text(const char *data, std::size_t size, Params &params);
  3159. void parse_query_text(const std::string &s, Params &params);
  3160. bool parse_multipart_boundary(const std::string &content_type,
  3161. std::string &boundary);
  3162. bool parse_range_header(const std::string &s, Ranges &ranges);
  3163. bool parse_accept_header(const std::string &s,
  3164. std::vector<std::string> &content_types);
  3165. void parse_disposition_params(const std::string &s, Params &params);
  3166. ssize_t send_socket(socket_t sock, const void *ptr, size_t size, int flags);
  3167. ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags);
  3168. EncodingType encoding_type(const Request &req, const std::string &content_type);
  3169. EncodingType encoding_type(const Request &req, const Response &res,
  3170. const std::string &content_type);
  3171. EncodingType encoding_type(const Request &req, const Response &res);
  3172. class BufferStream final : public Stream {
  3173. public:
  3174. BufferStream() = default;
  3175. ~BufferStream() override = default;
  3176. bool is_readable() const override;
  3177. bool wait_readable() const override;
  3178. bool wait_writable() const override;
  3179. ssize_t read(char *ptr, size_t size) override;
  3180. ssize_t write(const char *ptr, size_t size) override;
  3181. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  3182. void get_local_ip_and_port(std::string &ip, int &port) const override;
  3183. socket_t socket() const override;
  3184. time_t duration() const override;
  3185. const std::string &get_buffer() const;
  3186. private:
  3187. std::string buffer;
  3188. size_t position = 0;
  3189. };
  3190. class compressor {
  3191. public:
  3192. virtual ~compressor() = default;
  3193. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3194. virtual bool compress(const char *data, size_t data_length, bool last,
  3195. Callback callback) = 0;
  3196. };
  3197. class decompressor {
  3198. public:
  3199. virtual ~decompressor() = default;
  3200. virtual bool is_valid() const = 0;
  3201. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3202. virtual bool decompress(const char *data, size_t data_length,
  3203. Callback callback) = 0;
  3204. };
  3205. class nocompressor final : public compressor {
  3206. public:
  3207. ~nocompressor() override = default;
  3208. bool compress(const char *data, size_t data_length, bool /*last*/,
  3209. Callback callback) override;
  3210. };
  3211. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  3212. class gzip_compressor final : public compressor {
  3213. public:
  3214. gzip_compressor();
  3215. ~gzip_compressor() override;
  3216. bool compress(const char *data, size_t data_length, bool last,
  3217. Callback callback) override;
  3218. private:
  3219. bool is_valid_ = false;
  3220. z_stream strm_;
  3221. };
  3222. class gzip_decompressor final : public decompressor {
  3223. public:
  3224. gzip_decompressor();
  3225. ~gzip_decompressor() override;
  3226. bool is_valid() const override;
  3227. bool decompress(const char *data, size_t data_length,
  3228. Callback callback) override;
  3229. private:
  3230. bool is_valid_ = false;
  3231. z_stream strm_;
  3232. };
  3233. #endif
  3234. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  3235. class brotli_compressor final : public compressor {
  3236. public:
  3237. brotli_compressor();
  3238. ~brotli_compressor();
  3239. bool compress(const char *data, size_t data_length, bool last,
  3240. Callback callback) override;
  3241. private:
  3242. BrotliEncoderState *state_ = nullptr;
  3243. };
  3244. class brotli_decompressor final : public decompressor {
  3245. public:
  3246. brotli_decompressor();
  3247. ~brotli_decompressor();
  3248. bool is_valid() const override;
  3249. bool decompress(const char *data, size_t data_length,
  3250. Callback callback) override;
  3251. private:
  3252. BrotliDecoderResult decoder_r;
  3253. BrotliDecoderState *decoder_s = nullptr;
  3254. };
  3255. #endif
  3256. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  3257. class zstd_compressor : public compressor {
  3258. public:
  3259. zstd_compressor();
  3260. ~zstd_compressor();
  3261. bool compress(const char *data, size_t data_length, bool last,
  3262. Callback callback) override;
  3263. private:
  3264. ZSTD_CCtx *ctx_ = nullptr;
  3265. };
  3266. class zstd_decompressor : public decompressor {
  3267. public:
  3268. zstd_decompressor();
  3269. ~zstd_decompressor();
  3270. bool is_valid() const override;
  3271. bool decompress(const char *data, size_t data_length,
  3272. Callback callback) override;
  3273. private:
  3274. ZSTD_DCtx *ctx_ = nullptr;
  3275. };
  3276. #endif
  3277. // NOTE: until the read size reaches `fixed_buffer_size`, use `fixed_buffer`
  3278. // to store data. The call can set memory on stack for performance.
  3279. class stream_line_reader {
  3280. public:
  3281. stream_line_reader(Stream &strm, char *fixed_buffer,
  3282. size_t fixed_buffer_size);
  3283. const char *ptr() const;
  3284. size_t size() const;
  3285. bool end_with_crlf() const;
  3286. bool getline();
  3287. private:
  3288. void append(char c);
  3289. void append(const char *data, size_t size);
  3290. Stream &strm_;
  3291. char *fixed_buffer_;
  3292. const size_t fixed_buffer_size_;
  3293. size_t fixed_buffer_used_size_ = 0;
  3294. std::string growable_buffer_;
  3295. };
  3296. bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  3297. const Headers &src_headers);
  3298. struct ChunkedDecoder {
  3299. Stream &strm;
  3300. size_t chunk_remaining = 0;
  3301. bool finished = false;
  3302. char line_buf[64];
  3303. size_t last_chunk_total = 0;
  3304. size_t last_chunk_offset = 0;
  3305. size_t overhead = 0;
  3306. explicit ChunkedDecoder(Stream &s);
  3307. ssize_t read_payload(char *buf, size_t len, size_t &out_chunk_offset,
  3308. size_t &out_chunk_total);
  3309. bool parse_trailers_into(Headers &dest, const Headers &src_headers);
  3310. };
  3311. // A regular file opened to be served: mapped on Windows, read with pread()
  3312. // elsewhere.
  3313. class mmap {
  3314. public:
  3315. mmap(const char *path);
  3316. ~mmap();
  3317. bool open(const char *path);
  3318. void close();
  3319. bool is_open() const;
  3320. size_t size() const;
  3321. // Copies up to len bytes from offset into buf and returns how many: fewer,
  3322. // down to 0, if the file has shrunk since it was opened.
  3323. size_t read(size_t offset, char *buf, size_t len) const;
  3324. private:
  3325. #if defined(_WIN32)
  3326. HANDLE hFile_ = NULL;
  3327. HANDLE hMapping_ = NULL;
  3328. void *addr_ = nullptr;
  3329. bool is_open_empty_file = false;
  3330. #else
  3331. int fd_ = -1;
  3332. #endif
  3333. size_t size_ = 0;
  3334. };
  3335. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  3336. namespace fields {
  3337. bool is_token_char(char c);
  3338. bool is_token(const std::string &s);
  3339. bool is_field_name(const std::string &s);
  3340. bool is_vchar(char c);
  3341. bool is_obs_text(char c);
  3342. bool is_field_vchar(char c);
  3343. bool is_field_content(const std::string &s);
  3344. bool is_field_value(const std::string &s);
  3345. bool is_field_valid(const std::string &name, const std::string &value);
  3346. bool is_request_target(const std::string &s);
  3347. bool is_host(const std::string &s);
  3348. } // namespace fields
  3349. } // namespace detail
  3350. /*
  3351. * TLS Abstraction Layer Declarations
  3352. */
  3353. #ifdef CPPHTTPLIB_SSL_ENABLED
  3354. // TLS abstraction layer - backend-specific type declarations
  3355. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  3356. namespace tls {
  3357. namespace impl {
  3358. // Mbed TLS context wrapper (holds config, entropy, DRBG, CA chain, own
  3359. // cert/key). This struct is accessible via tls::impl for use in SSL context
  3360. // setup callbacks (cast ctx_t to tls::impl::MbedTlsContext*).
  3361. struct MbedTlsContext {
  3362. mbedtls_ssl_config conf;
  3363. #ifndef CPPHTTPLIB_MBEDTLS_V4
  3364. // Mbed TLS 4.x uses PSA Crypto's internal RNG; no explicit entropy/DRBG.
  3365. mbedtls_entropy_context entropy;
  3366. mbedtls_ctr_drbg_context ctr_drbg;
  3367. #endif
  3368. mbedtls_x509_crt ca_chain;
  3369. mbedtls_x509_crt own_cert;
  3370. mbedtls_pk_context own_key;
  3371. bool is_server = false;
  3372. // Peer certificate required (set_verify_client()); a client defaults to true
  3373. bool verify_client = false;
  3374. // Set by tls::set_verify_callback().
  3375. VerifyCallback verify_callback;
  3376. MbedTlsContext();
  3377. ~MbedTlsContext();
  3378. MbedTlsContext(const MbedTlsContext &) = delete;
  3379. MbedTlsContext &operator=(const MbedTlsContext &) = delete;
  3380. };
  3381. } // namespace impl
  3382. } // namespace tls
  3383. #endif
  3384. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  3385. namespace tls {
  3386. namespace impl {
  3387. // wolfSSL context wrapper (holds WOLFSSL_CTX and related state).
  3388. // This struct is accessible via tls::impl for use in SSL context
  3389. // setup callbacks (cast ctx_t to tls::impl::WolfSSLContext*).
  3390. struct WolfSSLContext {
  3391. WOLFSSL_CTX *ctx = nullptr;
  3392. bool is_server = false;
  3393. // Peer certificate required (set_verify_client()); a client defaults to true
  3394. bool verify_client = false;
  3395. // Replaced under verify_callback_mutex()
  3396. std::shared_ptr<VerifyCallback> verify_callback;
  3397. std::string ca_pem_data_; // accumulated PEM for get_ca_names/get_ca_certs
  3398. WolfSSLContext();
  3399. ~WolfSSLContext();
  3400. WolfSSLContext(const WolfSSLContext &) = delete;
  3401. WolfSSLContext &operator=(const WolfSSLContext &) = delete;
  3402. };
  3403. // CA store for wolfSSL: holds raw PEM bytes to allow reloading into any ctx
  3404. struct WolfSSLCAStore {
  3405. std::string pem_data;
  3406. };
  3407. } // namespace impl
  3408. } // namespace tls
  3409. #endif
  3410. #endif // CPPHTTPLIB_SSL_ENABLED
  3411. namespace stream {
  3412. class Result {
  3413. public:
  3414. Result();
  3415. explicit Result(ClientImpl::StreamHandle &&handle, size_t chunk_size = 8192);
  3416. Result(Result &&other) noexcept;
  3417. Result &operator=(Result &&other) noexcept;
  3418. Result(const Result &) = delete;
  3419. Result &operator=(const Result &) = delete;
  3420. // Response info
  3421. bool is_valid() const;
  3422. explicit operator bool() const;
  3423. int status() const;
  3424. const Headers &headers() const;
  3425. std::string get_header_value(const std::string &key,
  3426. const char *def = "") const;
  3427. bool has_header(const std::string &key) const;
  3428. Error error() const;
  3429. Error read_error() const;
  3430. bool has_read_error() const;
  3431. // Stream reading
  3432. bool next();
  3433. const char *data() const;
  3434. size_t size() const;
  3435. std::string read_all();
  3436. private:
  3437. ClientImpl::StreamHandle handle_;
  3438. std::string buffer_;
  3439. size_t current_size_ = 0;
  3440. size_t chunk_size_;
  3441. bool finished_ = false;
  3442. };
  3443. // GET
  3444. template <typename ClientType>
  3445. inline Result Get(ClientType &cli, const std::string &path,
  3446. size_t chunk_size = 8192) {
  3447. return Result{cli.open_stream("GET", path), chunk_size};
  3448. }
  3449. template <typename ClientType>
  3450. inline Result Get(ClientType &cli, const std::string &path,
  3451. const Headers &headers, size_t chunk_size = 8192) {
  3452. return Result{cli.open_stream("GET", path, {}, headers), chunk_size};
  3453. }
  3454. template <typename ClientType>
  3455. inline Result Get(ClientType &cli, const std::string &path,
  3456. const Params &params, size_t chunk_size = 8192) {
  3457. return Result{cli.open_stream("GET", path, params), chunk_size};
  3458. }
  3459. template <typename ClientType>
  3460. inline Result Get(ClientType &cli, const std::string &path,
  3461. const Params &params, const Headers &headers,
  3462. size_t chunk_size = 8192) {
  3463. return Result{cli.open_stream("GET", path, params, headers), chunk_size};
  3464. }
  3465. // POST
  3466. template <typename ClientType>
  3467. inline Result Post(ClientType &cli, const std::string &path,
  3468. const std::string &body, const std::string &content_type,
  3469. size_t chunk_size = 8192) {
  3470. return Result{cli.open_stream("POST", path, {}, {}, body, content_type),
  3471. chunk_size};
  3472. }
  3473. template <typename ClientType>
  3474. inline Result Post(ClientType &cli, const std::string &path,
  3475. const Headers &headers, const std::string &body,
  3476. const std::string &content_type, size_t chunk_size = 8192) {
  3477. return Result{cli.open_stream("POST", path, {}, headers, body, content_type),
  3478. chunk_size};
  3479. }
  3480. template <typename ClientType>
  3481. inline Result Post(ClientType &cli, const std::string &path,
  3482. const Params &params, const std::string &body,
  3483. const std::string &content_type, size_t chunk_size = 8192) {
  3484. return Result{cli.open_stream("POST", path, params, {}, body, content_type),
  3485. chunk_size};
  3486. }
  3487. template <typename ClientType>
  3488. inline Result Post(ClientType &cli, const std::string &path,
  3489. const Params &params, const Headers &headers,
  3490. const std::string &body, const std::string &content_type,
  3491. size_t chunk_size = 8192) {
  3492. return Result{
  3493. cli.open_stream("POST", path, params, headers, body, content_type),
  3494. chunk_size};
  3495. }
  3496. // PUT
  3497. template <typename ClientType>
  3498. inline Result Put(ClientType &cli, const std::string &path,
  3499. const std::string &body, const std::string &content_type,
  3500. size_t chunk_size = 8192) {
  3501. return Result{cli.open_stream("PUT", path, {}, {}, body, content_type),
  3502. chunk_size};
  3503. }
  3504. template <typename ClientType>
  3505. inline Result Put(ClientType &cli, const std::string &path,
  3506. const Headers &headers, const std::string &body,
  3507. const std::string &content_type, size_t chunk_size = 8192) {
  3508. return Result{cli.open_stream("PUT", path, {}, headers, body, content_type),
  3509. chunk_size};
  3510. }
  3511. template <typename ClientType>
  3512. inline Result Put(ClientType &cli, const std::string &path,
  3513. const Params &params, const std::string &body,
  3514. const std::string &content_type, size_t chunk_size = 8192) {
  3515. return Result{cli.open_stream("PUT", path, params, {}, body, content_type),
  3516. chunk_size};
  3517. }
  3518. template <typename ClientType>
  3519. inline Result Put(ClientType &cli, const std::string &path,
  3520. const Params &params, const Headers &headers,
  3521. const std::string &body, const std::string &content_type,
  3522. size_t chunk_size = 8192) {
  3523. return Result{
  3524. cli.open_stream("PUT", path, params, headers, body, content_type),
  3525. chunk_size};
  3526. }
  3527. // PATCH
  3528. template <typename ClientType>
  3529. inline Result Patch(ClientType &cli, const std::string &path,
  3530. const std::string &body, const std::string &content_type,
  3531. size_t chunk_size = 8192) {
  3532. return Result{cli.open_stream("PATCH", path, {}, {}, body, content_type),
  3533. chunk_size};
  3534. }
  3535. template <typename ClientType>
  3536. inline Result Patch(ClientType &cli, const std::string &path,
  3537. const Headers &headers, const std::string &body,
  3538. const std::string &content_type, size_t chunk_size = 8192) {
  3539. return Result{cli.open_stream("PATCH", path, {}, headers, body, content_type),
  3540. chunk_size};
  3541. }
  3542. template <typename ClientType>
  3543. inline Result Patch(ClientType &cli, const std::string &path,
  3544. const Params &params, const std::string &body,
  3545. const std::string &content_type, size_t chunk_size = 8192) {
  3546. return Result{cli.open_stream("PATCH", path, params, {}, body, content_type),
  3547. chunk_size};
  3548. }
  3549. template <typename ClientType>
  3550. inline Result Patch(ClientType &cli, const std::string &path,
  3551. const Params &params, const Headers &headers,
  3552. const std::string &body, const std::string &content_type,
  3553. size_t chunk_size = 8192) {
  3554. return Result{
  3555. cli.open_stream("PATCH", path, params, headers, body, content_type),
  3556. chunk_size};
  3557. }
  3558. // DELETE
  3559. template <typename ClientType>
  3560. inline Result Delete(ClientType &cli, const std::string &path,
  3561. size_t chunk_size = 8192) {
  3562. return Result{cli.open_stream("DELETE", path), chunk_size};
  3563. }
  3564. template <typename ClientType>
  3565. inline Result Delete(ClientType &cli, const std::string &path,
  3566. const Headers &headers, size_t chunk_size = 8192) {
  3567. return Result{cli.open_stream("DELETE", path, {}, headers), chunk_size};
  3568. }
  3569. template <typename ClientType>
  3570. inline Result Delete(ClientType &cli, const std::string &path,
  3571. const std::string &body, const std::string &content_type,
  3572. size_t chunk_size = 8192) {
  3573. return Result{cli.open_stream("DELETE", path, {}, {}, body, content_type),
  3574. chunk_size};
  3575. }
  3576. template <typename ClientType>
  3577. inline Result Delete(ClientType &cli, const std::string &path,
  3578. const Headers &headers, const std::string &body,
  3579. const std::string &content_type,
  3580. size_t chunk_size = 8192) {
  3581. return Result{
  3582. cli.open_stream("DELETE", path, {}, headers, body, content_type),
  3583. chunk_size};
  3584. }
  3585. template <typename ClientType>
  3586. inline Result Delete(ClientType &cli, const std::string &path,
  3587. const Params &params, size_t chunk_size = 8192) {
  3588. return Result{cli.open_stream("DELETE", path, params), chunk_size};
  3589. }
  3590. template <typename ClientType>
  3591. inline Result Delete(ClientType &cli, const std::string &path,
  3592. const Params &params, const Headers &headers,
  3593. size_t chunk_size = 8192) {
  3594. return Result{cli.open_stream("DELETE", path, params, headers), chunk_size};
  3595. }
  3596. template <typename ClientType>
  3597. inline Result Delete(ClientType &cli, const std::string &path,
  3598. const Params &params, const std::string &body,
  3599. const std::string &content_type,
  3600. size_t chunk_size = 8192) {
  3601. return Result{cli.open_stream("DELETE", path, params, {}, body, content_type),
  3602. chunk_size};
  3603. }
  3604. template <typename ClientType>
  3605. inline Result Delete(ClientType &cli, const std::string &path,
  3606. const Params &params, const Headers &headers,
  3607. const std::string &body, const std::string &content_type,
  3608. size_t chunk_size = 8192) {
  3609. return Result{
  3610. cli.open_stream("DELETE", path, params, headers, body, content_type),
  3611. chunk_size};
  3612. }
  3613. // HEAD
  3614. template <typename ClientType>
  3615. inline Result Head(ClientType &cli, const std::string &path,
  3616. size_t chunk_size = 8192) {
  3617. return Result{cli.open_stream("HEAD", path), chunk_size};
  3618. }
  3619. template <typename ClientType>
  3620. inline Result Head(ClientType &cli, const std::string &path,
  3621. const Headers &headers, size_t chunk_size = 8192) {
  3622. return Result{cli.open_stream("HEAD", path, {}, headers), chunk_size};
  3623. }
  3624. template <typename ClientType>
  3625. inline Result Head(ClientType &cli, const std::string &path,
  3626. const Params &params, size_t chunk_size = 8192) {
  3627. return Result{cli.open_stream("HEAD", path, params), chunk_size};
  3628. }
  3629. template <typename ClientType>
  3630. inline Result Head(ClientType &cli, const std::string &path,
  3631. const Params &params, const Headers &headers,
  3632. size_t chunk_size = 8192) {
  3633. return Result{cli.open_stream("HEAD", path, params, headers), chunk_size};
  3634. }
  3635. // OPTIONS
  3636. template <typename ClientType>
  3637. inline Result Options(ClientType &cli, const std::string &path,
  3638. size_t chunk_size = 8192) {
  3639. return Result{cli.open_stream("OPTIONS", path), chunk_size};
  3640. }
  3641. template <typename ClientType>
  3642. inline Result Options(ClientType &cli, const std::string &path,
  3643. const Headers &headers, size_t chunk_size = 8192) {
  3644. return Result{cli.open_stream("OPTIONS", path, {}, headers), chunk_size};
  3645. }
  3646. template <typename ClientType>
  3647. inline Result Options(ClientType &cli, const std::string &path,
  3648. const Params &params, size_t chunk_size = 8192) {
  3649. return Result{cli.open_stream("OPTIONS", path, params), chunk_size};
  3650. }
  3651. template <typename ClientType>
  3652. inline Result Options(ClientType &cli, const std::string &path,
  3653. const Params &params, const Headers &headers,
  3654. size_t chunk_size = 8192) {
  3655. return Result{cli.open_stream("OPTIONS", path, params, headers), chunk_size};
  3656. }
  3657. } // namespace stream
  3658. namespace sse {
  3659. struct SSEMessage {
  3660. std::string event; // Event type (default: "message")
  3661. std::string data; // Event payload
  3662. std::string id; // Event ID for Last-Event-ID header
  3663. SSEMessage();
  3664. void clear();
  3665. };
  3666. class SSEClient {
  3667. public:
  3668. using MessageHandler = std::function<void(const SSEMessage &)>;
  3669. using ErrorHandler = std::function<void(Error)>;
  3670. using OpenHandler = std::function<void()>;
  3671. SSEClient(Client &client, const std::string &path);
  3672. SSEClient(Client &client, const std::string &path, const Headers &headers);
  3673. ~SSEClient();
  3674. SSEClient(const SSEClient &) = delete;
  3675. SSEClient &operator=(const SSEClient &) = delete;
  3676. // Event handlers
  3677. SSEClient &on_message(MessageHandler handler);
  3678. SSEClient &on_event(const std::string &type, MessageHandler handler);
  3679. SSEClient &on_open(OpenHandler handler);
  3680. SSEClient &on_error(ErrorHandler handler);
  3681. SSEClient &set_reconnect_interval(int ms);
  3682. SSEClient &set_max_reconnect_attempts(int n);
  3683. // Update headers (thread-safe)
  3684. SSEClient &set_headers(const Headers &headers);
  3685. // State accessors
  3686. bool is_connected() const;
  3687. const std::string &last_event_id() const;
  3688. // Blocking start - runs event loop with auto-reconnect
  3689. void start();
  3690. // Non-blocking start - runs in background thread
  3691. void start_async();
  3692. // Stop the client (thread-safe)
  3693. void stop();
  3694. private:
  3695. bool parse_sse_line(const std::string &line, SSEMessage &msg, int &retry_ms,
  3696. bool &has_data, bool &has_id);
  3697. void run_event_loop();
  3698. void dispatch_event(const SSEMessage &msg);
  3699. bool should_reconnect(int count) const;
  3700. void wait_for_reconnect();
  3701. // Client and path
  3702. Client &client_;
  3703. std::string path_;
  3704. Headers headers_;
  3705. mutable std::mutex headers_mutex_;
  3706. // Callbacks
  3707. MessageHandler on_message_;
  3708. std::map<std::string, MessageHandler> event_handlers_;
  3709. OpenHandler on_open_;
  3710. ErrorHandler on_error_;
  3711. // Configuration
  3712. int reconnect_interval_ms_ = 3000;
  3713. int max_reconnect_attempts_ = 0; // 0 = unlimited
  3714. // State
  3715. std::atomic<bool> running_{false};
  3716. std::atomic<bool> connected_{false};
  3717. std::string last_event_id_;
  3718. // Async support
  3719. std::thread async_thread_;
  3720. };
  3721. } // namespace sse
  3722. namespace ws {
  3723. class WebSocketClient;
  3724. enum class Opcode : uint8_t {
  3725. Continuation = 0x0,
  3726. Text = 0x1,
  3727. Binary = 0x2,
  3728. Close = 0x8,
  3729. Ping = 0x9,
  3730. Pong = 0xA,
  3731. };
  3732. enum class CloseStatus : uint16_t {
  3733. Normal = 1000,
  3734. GoingAway = 1001,
  3735. ProtocolError = 1002,
  3736. UnsupportedData = 1003,
  3737. NoStatus = 1005,
  3738. Abnormal = 1006,
  3739. InvalidPayload = 1007,
  3740. PolicyViolation = 1008,
  3741. MessageTooBig = 1009,
  3742. MandatoryExtension = 1010,
  3743. InternalError = 1011,
  3744. };
  3745. // Timeout is returned only when a read timeout was set and it elapsed before
  3746. // any byte of a frame arrived: nothing was consumed and the connection is
  3747. // still open, so the caller can send on it and read again. `msg` is left
  3748. // untouched, so a `while (ws.read(msg))` loop must not treat it as a message.
  3749. enum ReadResult : int { Fail = 0, Text = 1, Binary = 2, Timeout = 3 };
  3750. // Result of WebSocketClient::connect(). Truthy only when the WebSocket
  3751. // upgrade handshake fully succeeded. On failure error() identifies the
  3752. // failing layer; status()/headers() expose the server's upgrade response
  3753. // when one was received (status() is -1 otherwise), or the proxy's reply to
  3754. // CONNECT when error() is ProxyConnection.
  3755. class Result {
  3756. public:
  3757. Result() = default;
  3758. Result(Error err, int status, Headers &&headers)
  3759. : err_(err), status_(status), headers_(std::move(headers)) {}
  3760. explicit operator bool() const { return err_ == Error::Success; }
  3761. Error error() const { return err_; }
  3762. // Upgrade response info
  3763. int status() const { return status_; }
  3764. const Headers &headers() const { return headers_; }
  3765. std::string get_header_value(const std::string &key,
  3766. const char *def = "") const {
  3767. return detail::get_header_value(headers_, key, def, 0);
  3768. }
  3769. bool has_header(const std::string &key) const {
  3770. return headers_.find(key) != headers_.end();
  3771. }
  3772. #ifdef CPPHTTPLIB_SSL_ENABLED
  3773. Result(Error err, int status, Headers &&headers, int ssl_error,
  3774. uint64_t ssl_backend_error)
  3775. : err_(err), status_(status), headers_(std::move(headers)),
  3776. ssl_error_(ssl_error), ssl_backend_error_(ssl_backend_error) {}
  3777. int ssl_error() const { return ssl_error_; }
  3778. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  3779. #endif
  3780. private:
  3781. Error err_ = Error::Unknown; // a default-constructed Result is falsy
  3782. int status_ = -1;
  3783. Headers headers_;
  3784. #ifdef CPPHTTPLIB_SSL_ENABLED
  3785. int ssl_error_ = 0;
  3786. uint64_t ssl_backend_error_ = 0;
  3787. #endif
  3788. };
  3789. class WebSocket {
  3790. public:
  3791. WebSocket(const WebSocket &) = delete;
  3792. WebSocket &operator=(const WebSocket &) = delete;
  3793. ~WebSocket();
  3794. ReadResult read(std::string &msg);
  3795. bool send(const std::string &data);
  3796. bool send(const char *data, size_t len);
  3797. void close(CloseStatus status = CloseStatus::Normal,
  3798. const std::string &reason = "");
  3799. const Request &request() const;
  3800. bool is_open() const;
  3801. // Bound how long read() waits before returning Timeout. 0 waits forever.
  3802. // A server handler owns its connection's timeout this way; a client sets it
  3803. // through WebSocketClient. Safe to call while another thread is in read().
  3804. //
  3805. // Only a timeout set here is reported as Timeout. The compile-time default
  3806. // (CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND) is a backstop rather
  3807. // than a request for control, so when it elapses read() returns Fail and
  3808. // closes the connection, and `while (ws.read(msg))` ends as it always has.
  3809. void set_read_timeout(time_t sec, time_t usec = 0);
  3810. template <class Rep, class Period>
  3811. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3812. private:
  3813. friend class httplib::Server;
  3814. friend class httplib::ws::WebSocketClient;
  3815. WebSocket(
  3816. Stream &strm, const Request &req, bool is_server,
  3817. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3818. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3819. : strm_(strm), req_(req), is_server_(is_server),
  3820. ping_interval_sec_(ping_interval_sec),
  3821. max_missed_pongs_(max_missed_pongs) {
  3822. start_heartbeat();
  3823. }
  3824. WebSocket(
  3825. std::unique_ptr<Stream> &&owned_strm, const Request &req, bool is_server,
  3826. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3827. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3828. : strm_(*owned_strm), owned_strm_(std::move(owned_strm)), req_(req),
  3829. is_server_(is_server), ping_interval_sec_(ping_interval_sec),
  3830. max_missed_pongs_(max_missed_pongs) {
  3831. start_heartbeat();
  3832. }
  3833. void start_heartbeat();
  3834. bool send_frame(Opcode op, const char *data, size_t len, bool fin = true);
  3835. Stream &strm_;
  3836. std::unique_ptr<Stream> owned_strm_;
  3837. Request req_;
  3838. bool is_server_;
  3839. time_t ping_interval_sec_;
  3840. int max_missed_pongs_;
  3841. int unacked_pings_ = 0;
  3842. std::atomic<bool> closed_{false};
  3843. // Set when the peer stopped answering pings, to end a read() waiting on it
  3844. std::atomic<bool> pong_timed_out_{false};
  3845. // Set once the caller has bounded read() through set_read_timeout(). Until
  3846. // then the timeout in effect is the compile-time default, and elapsing it
  3847. // is a failure that closes the connection, not a Timeout.
  3848. std::atomic<bool> read_timeout_set_{false};
  3849. std::mutex write_mutex_;
  3850. // Owned by whichever thread is parsing frames off strm_. Only one thread
  3851. // may do so: read_websocket_frame() reads a payload until it has the whole
  3852. // declared length, so a second parser stealing bytes silently corrupts the
  3853. // message the first one is assembling.
  3854. std::mutex read_mutex_;
  3855. std::thread ping_thread_;
  3856. std::mutex ping_mutex_;
  3857. std::condition_variable ping_cv_;
  3858. };
  3859. class WebSocketClient {
  3860. public:
  3861. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3862. const Headers &headers = {});
  3863. ~WebSocketClient();
  3864. WebSocketClient(const WebSocketClient &) = delete;
  3865. WebSocketClient &operator=(const WebSocketClient &) = delete;
  3866. bool is_valid() const;
  3867. Result connect();
  3868. ReadResult read(std::string &msg);
  3869. bool send(const std::string &data);
  3870. bool send(const char *data, size_t len);
  3871. void close(CloseStatus status = CloseStatus::Normal,
  3872. const std::string &reason = "");
  3873. bool is_open() const;
  3874. const std::string &subprotocol() const;
  3875. void set_read_timeout(time_t sec, time_t usec = 0);
  3876. template <class Rep, class Period>
  3877. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3878. void set_write_timeout(time_t sec, time_t usec = 0);
  3879. template <class Rep, class Period>
  3880. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  3881. void set_websocket_ping_interval(time_t sec);
  3882. void set_websocket_max_missed_pongs(int count);
  3883. void set_tcp_nodelay(bool on);
  3884. void set_address_family(int family);
  3885. void set_ipv6_v6only(bool on);
  3886. void set_socket_options(SocketOptions socket_options);
  3887. void set_connection_timeout(time_t sec, time_t usec = 0);
  3888. template <class Rep, class Period>
  3889. void
  3890. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  3891. void set_interface(const std::string &intf);
  3892. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  3893. void set_proxy(const std::string &host, int port);
  3894. void set_proxy_basic_auth(const std::string &username,
  3895. const std::string &password);
  3896. void set_proxy_bearer_token_auth(const std::string &token);
  3897. void set_no_proxy(const std::vector<std::string> &patterns);
  3898. #ifdef CPPHTTPLIB_SSL_ENABLED
  3899. struct PemMemory {
  3900. const char *cert_pem;
  3901. size_t cert_pem_len;
  3902. const char *key_pem;
  3903. size_t key_pem_len;
  3904. const char *private_key_password;
  3905. };
  3906. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3907. const PemMemory &pem, const Headers &headers = {});
  3908. void set_ca_cert_path(const std::string &ca_cert_file_path,
  3909. const std::string &ca_cert_dir_path = std::string());
  3910. void set_ca_cert_store(tls::ca_store_t store);
  3911. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  3912. void enable_server_certificate_verification(bool enabled);
  3913. void enable_server_hostname_verification(bool enabled);
  3914. void enable_system_ca(bool enabled);
  3915. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  3916. void set_session_verifier(
  3917. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  3918. void set_proxy_digest_auth(const std::string &username,
  3919. const std::string &password);
  3920. #endif
  3921. private:
  3922. void shutdown_and_close();
  3923. std::pair<time_t, time_t> handshake_timeout() const;
  3924. bool create_stream(std::unique_ptr<Stream> &strm, Error &error,
  3925. int &ssl_error, uint64_t &ssl_backend_error);
  3926. void prepare_default_headers(Request &req);
  3927. bool is_proxy_enabled() const;
  3928. bool create_and_connect_socket(Error &error);
  3929. bool send_proxy_connect(Request &req, Response &proxy_res, Error &error);
  3930. bool connect_with_proxy(Response &proxy_res, Error &error);
  3931. std::string host_;
  3932. int port_;
  3933. std::string path_;
  3934. Headers headers_;
  3935. std::string subprotocol_;
  3936. bool is_valid_ = false;
  3937. socket_t sock_ = INVALID_SOCKET;
  3938. std::unique_ptr<WebSocket> ws_;
  3939. time_t read_timeout_sec_ = CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND;
  3940. time_t read_timeout_usec_ = 0;
  3941. bool read_timeout_set_ = false; // see WebSocket::read_timeout_set_
  3942. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  3943. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  3944. time_t websocket_ping_interval_sec_ =
  3945. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  3946. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  3947. int address_family_ = AF_UNSPEC;
  3948. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  3949. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  3950. SocketOptions socket_options_ = nullptr;
  3951. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  3952. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  3953. std::string interface_;
  3954. // Hostname to connection target map. The value is an IP literal or another
  3955. // hostname; only the connection target changes, never the identity.
  3956. std::map<std::string, std::string> addr_map_;
  3957. std::string proxy_host_;
  3958. int proxy_port_ = -1;
  3959. std::string proxy_basic_auth_username_;
  3960. std::string proxy_basic_auth_password_;
  3961. std::string proxy_bearer_token_auth_token_;
  3962. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  3963. #ifdef CPPHTTPLIB_SSL_ENABLED
  3964. bool is_ssl_ = false;
  3965. tls::ctx_t tls_ctx_ = nullptr;
  3966. tls::session_t tls_session_ = nullptr;
  3967. std::string ca_cert_file_path_;
  3968. std::string ca_cert_dir_path_;
  3969. // Set by set_ca_cert_store() and load_ca_cert_store() even when they bring
  3970. // no certificate, so that a CA that failed to come through fails
  3971. // verification instead of letting the system CAs in.
  3972. bool custom_ca_loaded_ = false;
  3973. bool certs_loaded_ = false;
  3974. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  3975. bool server_certificate_verification_ = true;
  3976. bool server_hostname_verification_ = true;
  3977. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  3978. std::string proxy_digest_auth_username_;
  3979. std::string proxy_digest_auth_password_;
  3980. #endif
  3981. };
  3982. template <class Rep, class Period>
  3983. inline void WebSocket::set_read_timeout(
  3984. const std::chrono::duration<Rep, Period> &duration) {
  3985. detail::duration_to_sec_and_usec(
  3986. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3987. }
  3988. template <class Rep, class Period>
  3989. inline void WebSocketClient::set_read_timeout(
  3990. const std::chrono::duration<Rep, Period> &duration) {
  3991. detail::duration_to_sec_and_usec(
  3992. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3993. }
  3994. template <class Rep, class Period>
  3995. inline void WebSocketClient::set_write_timeout(
  3996. const std::chrono::duration<Rep, Period> &duration) {
  3997. detail::duration_to_sec_and_usec(
  3998. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3999. }
  4000. template <class Rep, class Period>
  4001. inline void WebSocketClient::set_connection_timeout(
  4002. const std::chrono::duration<Rep, Period> &duration) {
  4003. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  4004. set_connection_timeout(sec, usec);
  4005. });
  4006. }
  4007. namespace impl {
  4008. bool is_valid_utf8(const std::string &s);
  4009. // Three states, because a failure that consumed bytes and one that consumed
  4010. // none are not the same thing: the first has left the stream in the middle of
  4011. // a frame and the connection cannot be reused, the second can just be retried.
  4012. enum class FrameRead { Ok, Fail, Timeout };
  4013. FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  4014. std::string &payload, bool &fin,
  4015. bool expect_masked, size_t max_len);
  4016. } // namespace impl
  4017. } // namespace ws
  4018. // ----------------------------------------------------------------------------
  4019. /*
  4020. * Implementation that will be part of the .cc file if split into .h + .cc.
  4021. */
  4022. namespace stream {
  4023. // stream::Result implementations
  4024. inline Result::Result() : chunk_size_(8192) {}
  4025. inline Result::Result(ClientImpl::StreamHandle &&handle, size_t chunk_size)
  4026. : handle_(std::move(handle)), chunk_size_(chunk_size) {}
  4027. inline Result::Result(Result &&other) noexcept
  4028. : handle_(std::move(other.handle_)), buffer_(std::move(other.buffer_)),
  4029. current_size_(other.current_size_), chunk_size_(other.chunk_size_),
  4030. finished_(other.finished_) {
  4031. other.current_size_ = 0;
  4032. other.finished_ = true;
  4033. }
  4034. inline Result &Result::operator=(Result &&other) noexcept {
  4035. if (this != &other) {
  4036. handle_ = std::move(other.handle_);
  4037. buffer_ = std::move(other.buffer_);
  4038. current_size_ = other.current_size_;
  4039. chunk_size_ = other.chunk_size_;
  4040. finished_ = other.finished_;
  4041. other.current_size_ = 0;
  4042. other.finished_ = true;
  4043. }
  4044. return *this;
  4045. }
  4046. inline bool Result::is_valid() const { return handle_.is_valid(); }
  4047. inline Result::operator bool() const { return is_valid(); }
  4048. inline int Result::status() const {
  4049. return handle_.response ? handle_.response->status : -1;
  4050. }
  4051. inline const Headers &Result::headers() const {
  4052. static const Headers empty_headers;
  4053. return handle_.response ? handle_.response->headers : empty_headers;
  4054. }
  4055. inline std::string Result::get_header_value(const std::string &key,
  4056. const char *def) const {
  4057. return handle_.response ? handle_.response->get_header_value(key, def) : def;
  4058. }
  4059. inline bool Result::has_header(const std::string &key) const {
  4060. return handle_.response ? handle_.response->has_header(key) : false;
  4061. }
  4062. inline Error Result::error() const { return handle_.error; }
  4063. inline Error Result::read_error() const { return handle_.get_read_error(); }
  4064. inline bool Result::has_read_error() const { return handle_.has_read_error(); }
  4065. inline bool Result::next() {
  4066. if (!handle_.is_valid() || finished_) { return false; }
  4067. if (buffer_.size() < chunk_size_) { buffer_.resize(chunk_size_); }
  4068. ssize_t n = handle_.read(&buffer_[0], chunk_size_);
  4069. if (n > 0) {
  4070. current_size_ = static_cast<size_t>(n);
  4071. return true;
  4072. }
  4073. current_size_ = 0;
  4074. finished_ = true;
  4075. return false;
  4076. }
  4077. inline const char *Result::data() const { return buffer_.data(); }
  4078. inline size_t Result::size() const { return current_size_; }
  4079. inline std::string Result::read_all() {
  4080. std::string result;
  4081. while (next()) {
  4082. result.append(data(), size());
  4083. }
  4084. return result;
  4085. }
  4086. } // namespace stream
  4087. namespace sse {
  4088. // SSEMessage implementations
  4089. inline SSEMessage::SSEMessage() : event("message") {}
  4090. inline void SSEMessage::clear() {
  4091. event = "message";
  4092. data.clear();
  4093. id.clear();
  4094. }
  4095. // SSEClient implementations
  4096. inline SSEClient::SSEClient(Client &client, const std::string &path)
  4097. : client_(client), path_(path) {}
  4098. inline SSEClient::SSEClient(Client &client, const std::string &path,
  4099. const Headers &headers)
  4100. : client_(client), path_(path), headers_(headers) {}
  4101. inline SSEClient::~SSEClient() { stop(); }
  4102. inline SSEClient &SSEClient::on_message(MessageHandler handler) {
  4103. on_message_ = std::move(handler);
  4104. return *this;
  4105. }
  4106. inline SSEClient &SSEClient::on_event(const std::string &type,
  4107. MessageHandler handler) {
  4108. event_handlers_[type] = std::move(handler);
  4109. return *this;
  4110. }
  4111. inline SSEClient &SSEClient::on_open(OpenHandler handler) {
  4112. on_open_ = std::move(handler);
  4113. return *this;
  4114. }
  4115. inline SSEClient &SSEClient::on_error(ErrorHandler handler) {
  4116. on_error_ = std::move(handler);
  4117. return *this;
  4118. }
  4119. inline SSEClient &SSEClient::set_reconnect_interval(int ms) {
  4120. reconnect_interval_ms_ = ms;
  4121. return *this;
  4122. }
  4123. inline SSEClient &SSEClient::set_max_reconnect_attempts(int n) {
  4124. max_reconnect_attempts_ = n;
  4125. return *this;
  4126. }
  4127. inline SSEClient &SSEClient::set_headers(const Headers &headers) {
  4128. std::lock_guard<std::mutex> lock(headers_mutex_);
  4129. headers_ = headers;
  4130. return *this;
  4131. }
  4132. inline bool SSEClient::is_connected() const { return connected_.load(); }
  4133. inline const std::string &SSEClient::last_event_id() const {
  4134. return last_event_id_;
  4135. }
  4136. inline void SSEClient::start() {
  4137. running_.store(true);
  4138. run_event_loop();
  4139. }
  4140. inline void SSEClient::start_async() {
  4141. running_.store(true);
  4142. async_thread_ = std::thread([this]() { run_event_loop(); });
  4143. }
  4144. inline void SSEClient::stop() {
  4145. running_.store(false);
  4146. client_.stop(); // Cancel any pending operations
  4147. if (async_thread_.joinable()) { async_thread_.join(); }
  4148. }
  4149. inline bool SSEClient::parse_sse_line(const std::string &line, SSEMessage &msg,
  4150. int &retry_ms, bool &has_data,
  4151. bool &has_id) {
  4152. // Blank line signals end of event
  4153. if (line.empty()) { return true; }
  4154. // Lines starting with ':' are comments (ignored)
  4155. if (line[0] == ':') { return false; }
  4156. // Find the colon separator
  4157. auto colon_pos = line.find(':');
  4158. auto field = line.substr(0, colon_pos);
  4159. std::string value;
  4160. // Value starts after colon, skip optional single space
  4161. if (colon_pos != std::string::npos && colon_pos + 1 < line.size()) {
  4162. auto value_start = colon_pos + 1;
  4163. if (line[value_start] == ' ') { value_start++; }
  4164. value = line.substr(value_start);
  4165. }
  4166. // Handle known fields
  4167. if (field == "event") {
  4168. // An empty event type is dispatched as "message" per the SSE spec
  4169. msg.event = value.empty() ? std::string("message") : std::move(value);
  4170. } else if (field == "data") {
  4171. // Multiple data lines are concatenated with newlines
  4172. if (has_data) { msg.data += "\n"; }
  4173. msg.data += value;
  4174. has_data = true;
  4175. } else if (field == "id") {
  4176. // An id that cannot be sent back as Last-Event-ID is ignored. Empty id is
  4177. // valid (clears the last event ID)
  4178. if (detail::fields::is_field_value(value)) {
  4179. msg.id = value;
  4180. has_id = true;
  4181. }
  4182. } else if (field == "retry") {
  4183. // Parse retry interval in milliseconds
  4184. // Per the SSE spec, a value that is not all ASCII digits is ignored.
  4185. if (detail::is_numeric(value)) {
  4186. int v = 0;
  4187. auto res =
  4188. detail::from_chars(value.data(), value.data() + value.size(), v);
  4189. if (res.ec == std::errc{}) { retry_ms = v; }
  4190. }
  4191. }
  4192. // Unknown fields are ignored per SSE spec
  4193. return false;
  4194. }
  4195. inline void SSEClient::run_event_loop() {
  4196. auto reconnect_count = 0;
  4197. while (running_.load()) {
  4198. // Build headers, including Last-Event-ID if we have one
  4199. Headers request_headers;
  4200. {
  4201. std::lock_guard<std::mutex> lock(headers_mutex_);
  4202. request_headers = headers_;
  4203. }
  4204. if (!last_event_id_.empty()) {
  4205. request_headers.emplace("Last-Event-ID", last_event_id_);
  4206. }
  4207. // Open streaming connection. An event stream has no end, so each event is
  4208. // bounded instead of the whole body.
  4209. auto handle = client_.open_stream("GET", path_, {}, request_headers);
  4210. handle.body_reader_.payload_max_length = 0;
  4211. // stop() ends a read that is waiting for the next event
  4212. if (handle.stream_) {
  4213. handle.stream_->set_read_interrupt([this] { return !running_.load(); });
  4214. }
  4215. stream::Result result{std::move(handle)};
  4216. // Connection error handling
  4217. if (!result) {
  4218. connected_.store(false);
  4219. if (on_error_) { on_error_(result.error()); }
  4220. if (!should_reconnect(reconnect_count)) { break; }
  4221. wait_for_reconnect();
  4222. reconnect_count++;
  4223. continue;
  4224. }
  4225. if (result.status() != StatusCode::OK_200) {
  4226. connected_.store(false);
  4227. if (on_error_) { on_error_(Error::Connection); }
  4228. // For certain errors, don't reconnect.
  4229. // Note: 401 is intentionally absent so that handlers can refresh
  4230. // credentials via set_headers() and let the client reconnect.
  4231. if (result.status() == StatusCode::NoContent_204 ||
  4232. result.status() == StatusCode::NotFound_404 ||
  4233. result.status() == StatusCode::Forbidden_403) {
  4234. break;
  4235. }
  4236. if (!should_reconnect(reconnect_count)) { break; }
  4237. wait_for_reconnect();
  4238. reconnect_count++;
  4239. continue;
  4240. }
  4241. // Connection successful
  4242. connected_.store(true);
  4243. reconnect_count = 0;
  4244. if (on_open_) { on_open_(); }
  4245. // Event receiving loop
  4246. std::string buffer;
  4247. SSEMessage current_msg;
  4248. auto has_data = false;
  4249. auto has_id = false;
  4250. auto first_line = true;
  4251. auto after_cr = false;
  4252. auto event_too_long = false;
  4253. while (running_.load() && result.next()) {
  4254. // What is left in the buffer has no line ending
  4255. auto search_pos = buffer.size();
  4256. buffer.append(result.data(), result.size());
  4257. // Process complete lines in the buffer. A line ends with \r\n, \n or \r
  4258. // per the SSE spec
  4259. size_t line_start = 0;
  4260. size_t eol_pos;
  4261. while ((eol_pos = buffer.find_first_of("\r\n", search_pos)) !=
  4262. std::string::npos) {
  4263. auto line = buffer.substr(line_start, eol_pos - line_start);
  4264. line_start = eol_pos + 1;
  4265. search_pos = line_start;
  4266. // The \n of a \r\n may arrive in a later chunk than its \r
  4267. auto is_lf_of_crlf =
  4268. after_cr && line.empty() && buffer[eol_pos] == '\n';
  4269. after_cr = buffer[eol_pos] == '\r';
  4270. if (is_lf_of_crlf) { continue; }
  4271. // A UTF-8 BOM at the start of the stream is ignored per the SSE spec
  4272. if (first_line) {
  4273. first_line = false;
  4274. if (line.compare(0, 3, "\xEF\xBB\xBF") == 0) { line.erase(0, 3); }
  4275. }
  4276. // Parse the line and check if event is complete
  4277. auto event_complete = parse_sse_line(
  4278. line, current_msg, reconnect_interval_ms_, has_data, has_id);
  4279. if (event_complete) {
  4280. // Update last_event_id for reconnection, even for an event that
  4281. // has no data. An empty id clears it.
  4282. if (has_id) { last_event_id_ = current_msg.id; }
  4283. // An event without a data field is not dispatched
  4284. if (has_data) { dispatch_event(current_msg); }
  4285. // Reset the message for the next event either way
  4286. current_msg.clear();
  4287. has_data = false;
  4288. has_id = false;
  4289. }
  4290. }
  4291. // Keep unprocessed data in buffer
  4292. buffer.erase(0, line_start);
  4293. // Neither an event nor a line still waiting for its end may grow
  4294. // without bound. 0 means no limit.
  4295. if (CPPHTTPLIB_SSE_MAX_EVENT_LENGTH > 0 &&
  4296. buffer.size() + current_msg.data.size() >
  4297. CPPHTTPLIB_SSE_MAX_EVENT_LENGTH) {
  4298. if (on_error_) { on_error_(Error::ExceedMaxPayloadSize); }
  4299. event_too_long = true;
  4300. break;
  4301. }
  4302. }
  4303. // Connection ended
  4304. connected_.store(false);
  4305. // Reconnecting would only get the same event again
  4306. if (!running_.load() || event_too_long) { break; }
  4307. // Check for read errors
  4308. if (result.has_read_error()) {
  4309. if (on_error_) { on_error_(result.read_error()); }
  4310. }
  4311. if (!should_reconnect(reconnect_count)) { break; }
  4312. wait_for_reconnect();
  4313. reconnect_count++;
  4314. }
  4315. connected_.store(false);
  4316. }
  4317. inline void SSEClient::dispatch_event(const SSEMessage &msg) {
  4318. // Check for specific event type handler first
  4319. auto it = event_handlers_.find(msg.event);
  4320. if (it != event_handlers_.end()) {
  4321. it->second(msg);
  4322. return;
  4323. }
  4324. // Fall back to generic message handler
  4325. if (on_message_) { on_message_(msg); }
  4326. }
  4327. inline bool SSEClient::should_reconnect(int count) const {
  4328. if (!running_.load()) { return false; }
  4329. if (max_reconnect_attempts_ == 0) { return true; } // unlimited
  4330. return count < max_reconnect_attempts_;
  4331. }
  4332. inline void SSEClient::wait_for_reconnect() {
  4333. // Use small increments to check running_ flag frequently.
  4334. // Always wait at least one increment, so that a zero interval (e.g.
  4335. // "retry: 0" from the server) cannot cause a busy reconnect loop.
  4336. const auto step_ms = 100;
  4337. auto interval_ms = (std::max)(reconnect_interval_ms_, step_ms);
  4338. auto waited = 0;
  4339. while (running_.load() && waited < interval_ms) {
  4340. std::this_thread::sleep_for(std::chrono::milliseconds(step_ms));
  4341. waited += step_ms;
  4342. }
  4343. }
  4344. } // namespace sse
  4345. #ifdef CPPHTTPLIB_SSL_ENABLED
  4346. /*
  4347. * TLS abstraction layer - internal function declarations
  4348. * These are implementation details and not part of the public API.
  4349. */
  4350. namespace tls {
  4351. // Client context
  4352. ctx_t create_client_context();
  4353. void free_context(ctx_t ctx);
  4354. bool set_min_version(ctx_t ctx, Version version);
  4355. bool load_ca_pem(ctx_t ctx, const char *pem, size_t len);
  4356. bool load_ca_file(ctx_t ctx, const char *file_path);
  4357. bool load_ca_dir(ctx_t ctx, const char *dir_path);
  4358. bool load_system_certs(ctx_t ctx);
  4359. bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4360. const char *password);
  4361. bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  4362. const char *key_path, const char *password);
  4363. // Server context
  4364. ctx_t create_server_context();
  4365. bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4366. const char *password);
  4367. bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  4368. const char *key_path, const char *password);
  4369. bool set_client_ca_file(ctx_t ctx, const char *ca_file, const char *ca_dir);
  4370. void set_verify_client(ctx_t ctx, bool require);
  4371. // Session management
  4372. session_t create_session(ctx_t ctx, socket_t sock);
  4373. void free_session(session_t session);
  4374. bool set_sni(session_t session, const char *hostname, bool verify_hostname);
  4375. // Handshake (non-blocking capable)
  4376. TlsError connect(session_t session);
  4377. TlsError accept(session_t session);
  4378. // Handshake with timeout (blocking until timeout)
  4379. bool connect_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4380. time_t timeout_usec, TlsError *err);
  4381. bool accept_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4382. time_t timeout_usec, TlsError *err);
  4383. // I/O (non-blocking capable)
  4384. ssize_t read(session_t session, void *buf, size_t len, TlsError &err);
  4385. ssize_t write(session_t session, const void *buf, size_t len, TlsError &err);
  4386. int pending(const_session_t session);
  4387. void shutdown(session_t session, bool graceful);
  4388. // Connection state
  4389. bool is_peer_closed(session_t session, socket_t sock);
  4390. // Certificate verification
  4391. cert_t get_peer_cert(const_session_t session);
  4392. // The certificates the peer sent, leaf first. Free each with free_cert(), and
  4393. // do not use them after free_session(), as with get_peer_cert().
  4394. size_t get_peer_certs(const_session_t session, std::vector<cert_t> &certs);
  4395. void free_cert(cert_t cert);
  4396. bool verify_hostname(cert_t cert, const char *hostname);
  4397. uint64_t hostname_mismatch_code();
  4398. long get_verify_result(const_session_t session);
  4399. // Certificate introspection
  4400. std::string get_cert_subject_cn(cert_t cert);
  4401. std::string get_cert_issuer_name(cert_t cert);
  4402. bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans);
  4403. bool get_cert_validity(cert_t cert, time_t &not_before, time_t &not_after);
  4404. std::string get_cert_serial(cert_t cert);
  4405. bool get_cert_der(cert_t cert, std::vector<unsigned char> &der);
  4406. const char *get_sni(const_session_t session);
  4407. // CA store management
  4408. ca_store_t create_ca_store(const char *pem, size_t len);
  4409. void free_ca_store(ca_store_t store);
  4410. bool set_ca_store(ctx_t ctx, ca_store_t store);
  4411. // Free each with free_cert(), and do not use them once the context's CA
  4412. // certificates change.
  4413. size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs);
  4414. std::vector<std::string> get_ca_names(ctx_t ctx);
  4415. // Dynamic certificate update (for servers)
  4416. bool update_server_cert(ctx_t ctx, const char *cert_pem, const char *key_pem,
  4417. const char *password);
  4418. bool update_server_client_ca(ctx_t ctx, const char *ca_pem);
  4419. // Certificate verification callback
  4420. bool set_verify_callback(ctx_t ctx, VerifyCallback callback);
  4421. long get_verify_error(const_session_t session);
  4422. std::string verify_error_string(long error_code);
  4423. // TlsError information
  4424. uint64_t peek_error();
  4425. uint64_t get_error();
  4426. std::string error_string(uint64_t code);
  4427. } // namespace tls
  4428. #endif // CPPHTTPLIB_SSL_ENABLED
  4429. /*
  4430. * Group 1: detail namespace - Non-SSL utilities
  4431. */
  4432. namespace detail {
  4433. inline bool set_socket_opt_impl(socket_t sock, int level, int optname,
  4434. const void *optval, socklen_t optlen) {
  4435. return setsockopt(sock, level, optname,
  4436. #ifdef _WIN32
  4437. reinterpret_cast<const char *>(optval),
  4438. #else
  4439. optval,
  4440. #endif
  4441. optlen) == 0;
  4442. }
  4443. inline bool set_socket_opt_time(socket_t sock, int level, int optname,
  4444. time_t sec, time_t usec) {
  4445. #ifdef _WIN32
  4446. auto timeout = static_cast<uint32_t>(sec * 1000 + usec / 1000);
  4447. #else
  4448. timeval timeout;
  4449. timeout.tv_sec = static_cast<long>(sec);
  4450. timeout.tv_usec = static_cast<decltype(timeout.tv_usec)>(usec);
  4451. #endif
  4452. return set_socket_opt_impl(sock, level, optname, &timeout, sizeof(timeout));
  4453. }
  4454. inline bool is_hex(char c, int &v) {
  4455. if (is_ascii_digit(c)) {
  4456. v = c - '0';
  4457. return true;
  4458. } else if ('A' <= c && c <= 'F') {
  4459. v = c - 'A' + 10;
  4460. return true;
  4461. } else if ('a' <= c && c <= 'f') {
  4462. v = c - 'a' + 10;
  4463. return true;
  4464. }
  4465. return false;
  4466. }
  4467. inline bool from_hex_to_i(const std::string &s, size_t i, size_t cnt,
  4468. int &val) {
  4469. if (i >= s.size()) { return false; }
  4470. val = 0;
  4471. for (; cnt; i++, cnt--) {
  4472. if (!s[i]) { return false; }
  4473. auto v = 0;
  4474. if (is_hex(s[i], v)) {
  4475. val = val * 16 + v;
  4476. } else {
  4477. return false;
  4478. }
  4479. }
  4480. return true;
  4481. }
  4482. inline std::string from_i_to_hex(size_t n) {
  4483. static const auto charset = "0123456789abcdef";
  4484. std::string ret;
  4485. do {
  4486. ret = charset[n & 15] + ret;
  4487. n >>= 4;
  4488. } while (n > 0);
  4489. return ret;
  4490. }
  4491. // A round trip rather than `n <= SIZE_MAX`, which is always true on 64-bit
  4492. // builds and trips -Wtautological-type-limit-compare.
  4493. inline bool fits_in_size_t(uint64_t n) {
  4494. return static_cast<uint64_t>(static_cast<size_t>(n)) == n;
  4495. }
  4496. inline std::string compute_etag(const FileStat &fs,
  4497. const std::string &suffix = std::string()) {
  4498. if (!fs.is_file()) { return std::string(); }
  4499. // If mtime cannot be determined (negative value indicates an error
  4500. // or sentinel), do not generate an ETag. Returning a neutral / fixed
  4501. // value like 0 could collide with a real file that legitimately has
  4502. // mtime == 0 (epoch) and lead to misleading validators.
  4503. auto mtime_raw = fs.mtime();
  4504. if (mtime_raw < 0) { return std::string(); }
  4505. auto mtime = static_cast<size_t>(mtime_raw);
  4506. auto size = fs.size();
  4507. return std::string("W/\"") + from_i_to_hex(mtime) + "-" +
  4508. from_i_to_hex(size) + suffix + "\"";
  4509. }
  4510. // Format time_t as HTTP-date (RFC 9110 Section 5.6.7): "Sun, 06 Nov 1994
  4511. // 08:49:37 GMT" This implementation is defensive: it validates `mtime`, checks
  4512. // return values from `gmtime_r`/`gmtime_s`, and ensures `strftime` succeeds.
  4513. inline std::string file_mtime_to_http_date(time_t mtime) {
  4514. if (mtime < 0) { return std::string(); }
  4515. struct tm tm_buf;
  4516. #ifdef _WIN32
  4517. if (gmtime_s(&tm_buf, &mtime) != 0) { return std::string(); }
  4518. #else
  4519. if (gmtime_r(&mtime, &tm_buf) == nullptr) { return std::string(); }
  4520. #endif
  4521. char buf[64];
  4522. if (strftime(buf, sizeof(buf), "%a, %d %b %Y %H:%M:%S GMT", &tm_buf) == 0) {
  4523. return std::string();
  4524. }
  4525. return std::string(buf);
  4526. }
  4527. // Parse HTTP-date (RFC 9110 Section 5.6.7) to time_t. Returns -1 on failure.
  4528. inline time_t parse_http_date(const std::string &date_str) {
  4529. struct tm tm_buf;
  4530. // Create a classic locale object once for all parsing attempts
  4531. const std::locale classic_locale = std::locale::classic();
  4532. // Try to parse using std::get_time (C++11, cross-platform)
  4533. auto try_parse = [&](const char *fmt) -> bool {
  4534. std::istringstream ss(date_str);
  4535. ss.imbue(classic_locale);
  4536. memset(&tm_buf, 0, sizeof(tm_buf));
  4537. ss >> std::get_time(&tm_buf, fmt);
  4538. return !ss.fail();
  4539. };
  4540. // RFC 9110 preferred format (HTTP-date): "Sun, 06 Nov 1994 08:49:37 GMT"
  4541. if (!try_parse("%a, %d %b %Y %H:%M:%S")) {
  4542. // RFC 850 format: "Sunday, 06-Nov-94 08:49:37 GMT"
  4543. if (!try_parse("%A, %d-%b-%y %H:%M:%S")) {
  4544. // asctime format: "Sun Nov 6 08:49:37 1994"
  4545. if (!try_parse("%a %b %d %H:%M:%S %Y")) {
  4546. return static_cast<time_t>(-1);
  4547. }
  4548. }
  4549. }
  4550. #ifdef _WIN32
  4551. return _mkgmtime(&tm_buf);
  4552. #elif defined _AIX
  4553. return mktime(&tm_buf);
  4554. #else
  4555. return timegm(&tm_buf);
  4556. #endif
  4557. }
  4558. inline bool is_weak_etag(const std::string &s) {
  4559. // Check if the string is a weak ETag (starts with 'W/"')
  4560. return s.size() > 3 && s[0] == 'W' && s[1] == '/' && s[2] == '"';
  4561. }
  4562. inline bool is_strong_etag(const std::string &s) {
  4563. // Check if the string is a strong ETag (starts and ends with '"', at least 2
  4564. // chars)
  4565. return s.size() >= 2 && s[0] == '"' && s.back() == '"';
  4566. }
  4567. inline size_t to_utf8(int code, char *buff) {
  4568. if (code < 0x0080) {
  4569. buff[0] = static_cast<char>(code & 0x7F);
  4570. return 1;
  4571. } else if (code < 0x0800) {
  4572. buff[0] = static_cast<char>(0xC0 | ((code >> 6) & 0x1F));
  4573. buff[1] = static_cast<char>(0x80 | (code & 0x3F));
  4574. return 2;
  4575. } else if (code < 0xD800) {
  4576. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4577. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4578. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4579. return 3;
  4580. } else if (code < 0xE000) { // D800 - DFFF is invalid...
  4581. return 0;
  4582. } else if (code < 0x10000) {
  4583. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4584. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4585. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4586. return 3;
  4587. } else if (code < 0x110000) {
  4588. buff[0] = static_cast<char>(0xF0 | ((code >> 18) & 0x7));
  4589. buff[1] = static_cast<char>(0x80 | ((code >> 12) & 0x3F));
  4590. buff[2] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4591. buff[3] = static_cast<char>(0x80 | (code & 0x3F));
  4592. return 4;
  4593. }
  4594. // NOTREACHED
  4595. return 0;
  4596. }
  4597. } // namespace detail
  4598. namespace ws {
  4599. namespace impl {
  4600. inline bool is_valid_utf8(const std::string &s) {
  4601. size_t i = 0;
  4602. auto n = s.size();
  4603. while (i < n) {
  4604. auto c = static_cast<unsigned char>(s[i]);
  4605. size_t len;
  4606. uint32_t cp;
  4607. if (c < 0x80) {
  4608. i++;
  4609. continue;
  4610. } else if ((c & 0xE0) == 0xC0) {
  4611. len = 2;
  4612. cp = c & 0x1F;
  4613. } else if ((c & 0xF0) == 0xE0) {
  4614. len = 3;
  4615. cp = c & 0x0F;
  4616. } else if ((c & 0xF8) == 0xF0) {
  4617. len = 4;
  4618. cp = c & 0x07;
  4619. } else {
  4620. return false;
  4621. }
  4622. if (i + len > n) { return false; }
  4623. for (size_t j = 1; j < len; j++) {
  4624. auto b = static_cast<unsigned char>(s[i + j]);
  4625. if ((b & 0xC0) != 0x80) { return false; }
  4626. cp = (cp << 6) | (b & 0x3F);
  4627. }
  4628. // Overlong encoding check
  4629. if (len == 2 && cp < 0x80) { return false; }
  4630. if (len == 3 && cp < 0x800) { return false; }
  4631. if (len == 4 && cp < 0x10000) { return false; }
  4632. // Surrogate halves (U+D800..U+DFFF) and beyond U+10FFFF are invalid
  4633. if (cp >= 0xD800 && cp <= 0xDFFF) { return false; }
  4634. if (cp > 0x10FFFF) { return false; }
  4635. i += len;
  4636. }
  4637. return true;
  4638. }
  4639. } // namespace impl
  4640. } // namespace ws
  4641. namespace detail {
  4642. // NOTE: This code came up with the following stackoverflow post:
  4643. // https://stackoverflow.com/questions/180947/base64-decode-snippet-in-c
  4644. inline std::string base64_encode(const std::string &in) {
  4645. static const auto lookup =
  4646. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4647. std::string out;
  4648. out.reserve(in.size());
  4649. // Unsigned: the accumulator is never masked, so with a signed int the
  4650. // `val << 8` below overflows once enough bytes are folded in (undefined
  4651. // behaviour before C++20). Only the low bits are ever emitted, so the
  4652. // wrap-around of an unsigned accumulator does not affect the output.
  4653. uint32_t val = 0;
  4654. auto valb = -6;
  4655. for (auto c : in) {
  4656. val = (val << 8) + static_cast<uint8_t>(c);
  4657. valb += 8;
  4658. while (valb >= 0) {
  4659. out.push_back(lookup[(val >> valb) & 0x3F]);
  4660. valb -= 6;
  4661. }
  4662. }
  4663. if (valb > -6) { out.push_back(lookup[((val << 8) >> (valb + 8)) & 0x3F]); }
  4664. while (out.size() % 4) {
  4665. out.push_back('=');
  4666. }
  4667. return out;
  4668. }
  4669. inline std::string sha1(const std::string &input) {
  4670. // RFC 3174 SHA-1 implementation
  4671. auto left_rotate = [](uint32_t x, uint32_t n) -> uint32_t {
  4672. return (x << n) | (x >> (32 - n));
  4673. };
  4674. uint32_t h0 = 0x67452301;
  4675. uint32_t h1 = 0xEFCDAB89;
  4676. uint32_t h2 = 0x98BADCFE;
  4677. uint32_t h3 = 0x10325476;
  4678. uint32_t h4 = 0xC3D2E1F0;
  4679. // Pre-processing: adding padding bits
  4680. std::string msg = input;
  4681. uint64_t original_bit_len = static_cast<uint64_t>(msg.size()) * 8;
  4682. msg.push_back(static_cast<char>(0x80u));
  4683. while (msg.size() % 64 != 56) {
  4684. msg.push_back(0);
  4685. }
  4686. // Append original length in bits as 64-bit big-endian
  4687. for (int i = 56; i >= 0; i -= 8) {
  4688. msg.push_back(static_cast<char>((original_bit_len >> i) & 0xFF));
  4689. }
  4690. // Process each 512-bit chunk
  4691. for (size_t offset = 0; offset < msg.size(); offset += 64) {
  4692. uint32_t w[80];
  4693. for (size_t i = 0; i < 16; i++) {
  4694. w[i] =
  4695. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4]))
  4696. << 24) |
  4697. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 1]))
  4698. << 16) |
  4699. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 2]))
  4700. << 8) |
  4701. (static_cast<uint32_t>(
  4702. static_cast<uint8_t>(msg[offset + i * 4 + 3])));
  4703. }
  4704. for (int i = 16; i < 80; i++) {
  4705. w[i] = left_rotate(w[i - 3] ^ w[i - 8] ^ w[i - 14] ^ w[i - 16], 1);
  4706. }
  4707. uint32_t a = h0, b = h1, c = h2, d = h3, e = h4;
  4708. for (int i = 0; i < 80; i++) {
  4709. uint32_t f, k;
  4710. if (i < 20) {
  4711. f = (b & c) | ((~b) & d);
  4712. k = 0x5A827999;
  4713. } else if (i < 40) {
  4714. f = b ^ c ^ d;
  4715. k = 0x6ED9EBA1;
  4716. } else if (i < 60) {
  4717. f = (b & c) | (b & d) | (c & d);
  4718. k = 0x8F1BBCDC;
  4719. } else {
  4720. f = b ^ c ^ d;
  4721. k = 0xCA62C1D6;
  4722. }
  4723. uint32_t temp = left_rotate(a, 5) + f + e + k + w[i];
  4724. e = d;
  4725. d = c;
  4726. c = left_rotate(b, 30);
  4727. b = a;
  4728. a = temp;
  4729. }
  4730. h0 += a;
  4731. h1 += b;
  4732. h2 += c;
  4733. h3 += d;
  4734. h4 += e;
  4735. }
  4736. // Produce the final hash as a 20-byte binary string
  4737. std::string hash(20, '\0');
  4738. for (size_t i = 0; i < 4; i++) {
  4739. hash[i] = static_cast<char>((h0 >> (24 - i * 8)) & 0xFF);
  4740. hash[4 + i] = static_cast<char>((h1 >> (24 - i * 8)) & 0xFF);
  4741. hash[8 + i] = static_cast<char>((h2 >> (24 - i * 8)) & 0xFF);
  4742. hash[12 + i] = static_cast<char>((h3 >> (24 - i * 8)) & 0xFF);
  4743. hash[16 + i] = static_cast<char>((h4 >> (24 - i * 8)) & 0xFF);
  4744. }
  4745. return hash;
  4746. }
  4747. inline std::string websocket_accept_key(const std::string &client_key) {
  4748. const std::string magic = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
  4749. return base64_encode(sha1(client_key + magic));
  4750. }
  4751. inline bool is_websocket_upgrade(const Request &req) {
  4752. if (req.method != "GET") { return false; }
  4753. // Check Upgrade: websocket. RFC 9110 7.8 defines Upgrade as a comma-separated
  4754. // list of protocols and asks recipients to match each name
  4755. // case-insensitively, so look for the token rather than compare the whole
  4756. // field value.
  4757. if (!has_header_token(req.headers, "Upgrade", "websocket")) { return false; }
  4758. // Check Connection: Upgrade
  4759. if (!has_header_token(req.headers, "Connection", "upgrade")) { return false; }
  4760. // Check Sec-WebSocket-Key is a valid base64-encoded 16-byte value (24 chars)
  4761. // RFC 6455 Section 4.2.1
  4762. auto ws_key = req.get_header_value("Sec-WebSocket-Key");
  4763. if (ws_key.size() != 24 || ws_key[22] != '=' || ws_key[23] != '=') {
  4764. return false;
  4765. }
  4766. static const std::string b64chars =
  4767. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4768. for (size_t i = 0; i < 22; i++) {
  4769. if (b64chars.find(ws_key[i]) == std::string::npos) { return false; }
  4770. }
  4771. // Check Sec-WebSocket-Version: 13
  4772. auto version = req.get_header_value("Sec-WebSocket-Version");
  4773. if (version != "13") { return false; }
  4774. return true;
  4775. }
  4776. // Unpredictable bytes for masking keys (RFC 6455 Section 5.3) and nonces
  4777. inline void fill_random_bytes(unsigned char *out, size_t n) {
  4778. thread_local std::random_device rd;
  4779. size_t filled = 0;
  4780. while (filled < n) {
  4781. auto v = rd();
  4782. for (size_t b = 0; b < sizeof(v) && filled < n; ++b, ++filled) {
  4783. out[filled] = static_cast<unsigned char>((v >> (b * 8)) & 0xFFu);
  4784. }
  4785. }
  4786. }
  4787. inline bool write_websocket_frame(Stream &strm, ws::Opcode opcode,
  4788. const char *data, size_t len, bool fin,
  4789. bool mask) {
  4790. // First byte: FIN + opcode
  4791. uint8_t header[2];
  4792. header[0] = static_cast<uint8_t>((fin ? 0x80 : 0x00) |
  4793. (static_cast<uint8_t>(opcode) & 0x0F));
  4794. // Second byte: MASK + payload length
  4795. if (len < 126) {
  4796. header[1] = static_cast<uint8_t>(len);
  4797. if (mask) { header[1] |= 0x80; }
  4798. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4799. } else if (len <= 0xFFFF) {
  4800. header[1] = 126;
  4801. if (mask) { header[1] |= 0x80; }
  4802. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4803. uint8_t ext[2];
  4804. ext[0] = static_cast<uint8_t>((len >> 8) & 0xFF);
  4805. ext[1] = static_cast<uint8_t>(len & 0xFF);
  4806. if (strm.write(reinterpret_cast<char *>(ext), 2) < 0) { return false; }
  4807. } else {
  4808. header[1] = 127;
  4809. if (mask) { header[1] |= 0x80; }
  4810. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4811. uint8_t ext[8];
  4812. for (int i = 7; i >= 0; i--) {
  4813. ext[7 - i] =
  4814. static_cast<uint8_t>((static_cast<uint64_t>(len) >> (i * 8)) & 0xFF);
  4815. }
  4816. if (strm.write(reinterpret_cast<char *>(ext), 8) < 0) { return false; }
  4817. }
  4818. if (mask) {
  4819. // Generate random mask key
  4820. uint8_t mask_key[4];
  4821. fill_random_bytes(mask_key, sizeof(mask_key));
  4822. if (strm.write(reinterpret_cast<char *>(mask_key), 4) < 0) { return false; }
  4823. // Write masked payload in chunks
  4824. const size_t chunk_size = 4096;
  4825. std::vector<char> buf((std::min)(len, chunk_size));
  4826. for (size_t offset = 0; offset < len; offset += chunk_size) {
  4827. size_t n = (std::min)(chunk_size, len - offset);
  4828. for (size_t i = 0; i < n; i++) {
  4829. buf[i] =
  4830. data[offset + i] ^ static_cast<char>(mask_key[(offset + i) % 4]);
  4831. }
  4832. if (strm.write(buf.data(), n) < 0) { return false; }
  4833. }
  4834. } else {
  4835. if (len > 0) {
  4836. if (strm.write(data, len) < 0) { return false; }
  4837. }
  4838. }
  4839. return true;
  4840. }
  4841. } // namespace detail
  4842. namespace ws {
  4843. namespace impl {
  4844. // Read exactly `size` bytes. Stream::read may return less than asked for -- it
  4845. // hands back whatever its buffer already holds -- so every multi-byte field has
  4846. // to loop. Reading a 2-byte header with a single read() fails whenever the
  4847. // header straddles the read buffer's boundary.
  4848. //
  4849. // Timeout is reported only when nothing at all was consumed. Once a byte has
  4850. // been taken the stream sits mid-field and cannot be resumed, so a timeout
  4851. // there is a failure like any other. (When read() fails it always records why,
  4852. // so the error belongs to this call and not to an earlier one.)
  4853. inline FrameRead read_exact(Stream &strm, void *buf, size_t size) {
  4854. auto p = static_cast<char *>(buf);
  4855. size_t total = 0;
  4856. while (total < size) {
  4857. auto n = strm.read(p + total, size - total);
  4858. if (n <= 0) {
  4859. auto timed_out = total == 0 && strm.get_error() == Error::Timeout;
  4860. return timed_out ? FrameRead::Timeout : FrameRead::Fail;
  4861. }
  4862. total += static_cast<size_t>(n);
  4863. }
  4864. return FrameRead::Ok;
  4865. }
  4866. inline FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  4867. std::string &payload, bool &fin,
  4868. bool expect_masked, size_t max_len) {
  4869. // Read first 2 bytes. This is the only read that may report a timeout: it
  4870. // sits on a frame boundary, where nothing has been consumed yet.
  4871. uint8_t header[2];
  4872. FrameRead first = read_exact(strm, header, 2);
  4873. if (first != FrameRead::Ok) { return first; }
  4874. fin = (header[0] & 0x80) != 0;
  4875. // RSV1, RSV2, RSV3 must be 0 when no extension is negotiated
  4876. if (header[0] & 0x70) { return FrameRead::Fail; }
  4877. opcode = static_cast<Opcode>(header[0] & 0x0F);
  4878. bool masked = (header[1] & 0x80) != 0;
  4879. uint64_t payload_len = header[1] & 0x7F;
  4880. // RFC 6455 Section 5.5: control frames MUST NOT be fragmented and
  4881. // MUST have a payload length of 125 bytes or less
  4882. bool is_control = (static_cast<uint8_t>(opcode) & 0x08) != 0;
  4883. if (is_control) {
  4884. if (!fin) { return FrameRead::Fail; }
  4885. if (payload_len > 125) { return FrameRead::Fail; }
  4886. }
  4887. if (masked != expect_masked) { return FrameRead::Fail; }
  4888. // Extended payload length
  4889. if (payload_len == 126) {
  4890. uint8_t ext[2];
  4891. if (read_exact(strm, ext, 2) != FrameRead::Ok) { return FrameRead::Fail; }
  4892. payload_len = (static_cast<uint64_t>(ext[0]) << 8) | ext[1];
  4893. } else if (payload_len == 127) {
  4894. uint8_t ext[8];
  4895. if (read_exact(strm, ext, 8) != FrameRead::Ok) { return FrameRead::Fail; }
  4896. // RFC 6455 Section 5.2: the most significant bit MUST be 0
  4897. if (ext[0] & 0x80) { return FrameRead::Fail; }
  4898. payload_len = 0;
  4899. for (int i = 0; i < 8; i++) {
  4900. payload_len = (payload_len << 8) | ext[i];
  4901. }
  4902. }
  4903. // A max_len of 0 means no limit, as payload_max_length does, and a length
  4904. // size_t cannot hold (32-bit builds) is refused either way.
  4905. if ((max_len > 0 && payload_len > max_len) ||
  4906. !detail::fits_in_size_t(payload_len)) {
  4907. return FrameRead::Fail;
  4908. }
  4909. // Read mask key if present
  4910. uint8_t mask_key[4] = {0};
  4911. if (masked) {
  4912. if (read_exact(strm, mask_key, 4) != FrameRead::Ok) {
  4913. return FrameRead::Fail;
  4914. }
  4915. }
  4916. // Grow the payload only as it arrives, since a header alone can announce
  4917. // max_len bytes that never come.
  4918. payload.clear();
  4919. auto len = static_cast<size_t>(payload_len);
  4920. while (payload.size() < len) {
  4921. auto offset = payload.size();
  4922. auto n = (std::min)(len - offset, CPPHTTPLIB_RECV_BUFSIZ);
  4923. payload.resize(offset + n);
  4924. if (read_exact(strm, &payload[offset], n) != FrameRead::Ok) {
  4925. return FrameRead::Fail;
  4926. }
  4927. }
  4928. // Unmask if needed
  4929. if (masked) {
  4930. for (size_t i = 0; i < payload.size(); i++) {
  4931. payload[i] ^= static_cast<char>(mask_key[i % 4]);
  4932. }
  4933. }
  4934. return FrameRead::Ok;
  4935. }
  4936. // RFC 6455 §5.5.1, §7.4: a Close payload is empty, or a status code that may
  4937. // be sent followed by a UTF-8 reason.
  4938. inline bool is_valid_close_payload(const std::string &payload) {
  4939. if (payload.empty()) { return true; }
  4940. if (payload.size() < 2) { return false; }
  4941. auto code = (static_cast<uint8_t>(payload[0]) << 8) |
  4942. static_cast<uint8_t>(payload[1]);
  4943. auto may_be_sent = (1000 <= code && code <= 1003) ||
  4944. (1007 <= code && code <= 1014) ||
  4945. (3000 <= code && code <= 4999);
  4946. return may_be_sent && is_valid_utf8(payload.substr(2));
  4947. }
  4948. } // namespace impl
  4949. } // namespace ws
  4950. namespace detail {
  4951. // A path a mount point serves: absolute, with no ".", ".." or empty segment
  4952. // except a trailing '/', so the file served is the one that req.path names to
  4953. // the handlers that ran before it.
  4954. inline bool is_valid_path(const std::string &path) {
  4955. if (path.empty() || path[0] != '/') { return false; }
  4956. auto beg = size_t{1};
  4957. for (auto i = beg; i <= path.size(); i++) {
  4958. if (i < path.size() && path[i] != '/') {
  4959. if (path[i] == '\0' || path[i] == '\\') { return false; }
  4960. continue;
  4961. }
  4962. auto len = i - beg;
  4963. if ((len == 0 && i < path.size()) || (len == 1 && path[beg] == '.') ||
  4964. (len == 2 && path[beg] == '.' && path[beg + 1] == '.')) {
  4965. return false;
  4966. }
  4967. beg = i + 1;
  4968. }
  4969. return true;
  4970. }
  4971. inline bool canonicalize_path(const char *path, std::string &resolved) {
  4972. #if defined(_WIN32)
  4973. char buf[_MAX_PATH];
  4974. if (_fullpath(buf, path, _MAX_PATH) == nullptr) { return false; }
  4975. resolved = buf;
  4976. #elif defined(PATH_MAX)
  4977. char buf[PATH_MAX];
  4978. if (realpath(path, buf) == nullptr) { return false; }
  4979. resolved = buf;
  4980. #else
  4981. auto buf = realpath(path, nullptr);
  4982. auto guard = scope_exit([&]() { std::free(buf); });
  4983. if (buf == nullptr) { return false; }
  4984. resolved = buf;
  4985. #endif
  4986. return true;
  4987. }
  4988. inline bool is_path_within_base(const std::string &resolved_path,
  4989. const std::string &resolved_base) {
  4990. #if defined(_WIN32)
  4991. return _strnicmp(resolved_path.c_str(), resolved_base.c_str(),
  4992. resolved_base.size()) == 0;
  4993. #else
  4994. return strncmp(resolved_path.c_str(), resolved_base.c_str(),
  4995. resolved_base.size()) == 0;
  4996. #endif
  4997. }
  4998. inline FileStat::FileStat(const std::string &path) {
  4999. #if defined(_WIN32)
  5000. auto wpath = u8string_to_wstring(path.c_str());
  5001. ret_ = _wstat(wpath.c_str(), &st_);
  5002. #else
  5003. ret_ = stat(path.c_str(), &st_);
  5004. #endif
  5005. }
  5006. inline bool FileStat::is_file() const {
  5007. return ret_ >= 0 && S_ISREG(st_.st_mode);
  5008. }
  5009. inline bool FileStat::is_dir() const {
  5010. return ret_ >= 0 && S_ISDIR(st_.st_mode);
  5011. }
  5012. inline time_t FileStat::mtime() const {
  5013. return ret_ >= 0 ? static_cast<time_t>(st_.st_mtime)
  5014. : static_cast<time_t>(-1);
  5015. }
  5016. inline size_t FileStat::size() const {
  5017. return ret_ >= 0 ? static_cast<size_t>(st_.st_size) : 0;
  5018. }
  5019. inline std::string encode_path(const std::string &s) {
  5020. std::string result;
  5021. result.reserve(s.size());
  5022. for (size_t i = 0; s[i]; i++) {
  5023. switch (s[i]) {
  5024. case ' ': result += "%20"; break;
  5025. case '+': result += "%2B"; break;
  5026. case '\'': result += "%27"; break;
  5027. case ',': result += "%2C"; break;
  5028. // case ':': result += "%3A"; break; // ok? probably...
  5029. case ';': result += "%3B"; break;
  5030. default:
  5031. auto c = static_cast<uint8_t>(s[i]);
  5032. // Control characters (incl. CR/LF) and non-ASCII bytes are not allowed
  5033. // in a request-target as-is.
  5034. if (c < 0x20 || c == 0x7f || c >= 0x80) {
  5035. result += '%';
  5036. char hex[4];
  5037. auto len = snprintf(hex, sizeof(hex) - 1, "%02X", c);
  5038. assert(len == 2);
  5039. result.append(hex, static_cast<size_t>(len));
  5040. } else {
  5041. result += s[i];
  5042. }
  5043. break;
  5044. }
  5045. }
  5046. return result;
  5047. }
  5048. inline std::string file_extension(const std::string &path) {
  5049. auto i = path.size();
  5050. while (i > 0 && is_ascii_alnum(path[i - 1])) {
  5051. i--;
  5052. }
  5053. if (i == path.size() || i == 0 || path[i - 1] != '.') {
  5054. return std::string();
  5055. }
  5056. return path.substr(i);
  5057. }
  5058. inline bool is_space_or_tab(char c) { return c == ' ' || c == '\t'; }
  5059. template <typename T>
  5060. inline bool parse_header(const char *beg, const char *end, T fn);
  5061. template <typename T>
  5062. inline bool parse_header(const char *beg, const char *end, T fn) {
  5063. // Skip trailing spaces and tabs.
  5064. while (beg < end && is_space_or_tab(end[-1])) {
  5065. end--;
  5066. }
  5067. auto p = beg;
  5068. while (p < end && *p != ':') {
  5069. p++;
  5070. }
  5071. auto name = std::string(beg, p);
  5072. if (!detail::fields::is_field_name(name)) { return false; }
  5073. if (p == end) { return false; }
  5074. auto key_end = p;
  5075. if (*p++ != ':') { return false; }
  5076. while (p < end && is_space_or_tab(*p)) {
  5077. p++;
  5078. }
  5079. if (p <= end) {
  5080. auto key_len = key_end - beg;
  5081. if (!key_len) { return false; }
  5082. auto key = std::string(beg, key_end);
  5083. auto val = std::string(p, end);
  5084. if (!detail::fields::is_field_value(val)) { return false; }
  5085. // RFC 9110 §5.5: header field values are opaque octets and MUST NOT be
  5086. // percent-decoded by the recipient. Applications that need to interpret a
  5087. // value as a URI component should call httplib::decode_uri_component()
  5088. // (or decode_path_component()) explicitly.
  5089. fn(key, val);
  5090. return true;
  5091. }
  5092. return false;
  5093. }
  5094. inline bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  5095. const Headers &src_headers) {
  5096. // NOTE: In RFC 9112, '7.1 Chunked Transfer Coding' mentions "The chunked
  5097. // transfer coding is complete when a chunk with a chunk-size of zero is
  5098. // received, possibly followed by a trailer section, and finally terminated by
  5099. // an empty line". https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1
  5100. //
  5101. // In '7.1.3. Decoding Chunked', however, the pseudo-code in the section
  5102. // doesn't care for the existence of the final CRLF. In other words, it seems
  5103. // to be ok whether the final CRLF exists or not in the chunked data.
  5104. // https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1.3
  5105. //
  5106. // According to the reference code in RFC 9112, cpp-httplib now allows
  5107. // chunked transfer coding data without the final CRLF.
  5108. // RFC 7230 Section 4.1.2 - Headers prohibited in trailers
  5109. thread_local case_ignore::unordered_set<std::string> prohibited_trailers = {
  5110. "transfer-encoding",
  5111. "content-length",
  5112. "host",
  5113. "authorization",
  5114. "www-authenticate",
  5115. "proxy-authenticate",
  5116. "proxy-authorization",
  5117. "cookie",
  5118. "set-cookie",
  5119. "cache-control",
  5120. "expect",
  5121. "max-forwards",
  5122. "pragma",
  5123. "range",
  5124. "te",
  5125. "age",
  5126. "expires",
  5127. "date",
  5128. "location",
  5129. "retry-after",
  5130. "vary",
  5131. "warning",
  5132. "content-encoding",
  5133. "content-type",
  5134. "content-range",
  5135. "trailer"};
  5136. case_ignore::unordered_set<std::string> declared_trailers;
  5137. auto trailer_header = get_combined_header_value(src_headers, "Trailer");
  5138. if (!trailer_header.empty()) {
  5139. // split() trims each token and skips empty ones, so the name arrives ready
  5140. // to look up.
  5141. split(trailer_header.data(), trailer_header.data() + trailer_header.size(),
  5142. ',', [&](const char *b, const char *e) {
  5143. // A legitimate message declares only a handful of trailers. Cap the
  5144. // set so a peer cannot grow it without bound: an oversized set only
  5145. // arises from an attempt to force many colliding names into
  5146. // quadratic lookups (case_ignore::hash is unkeyed).
  5147. if (declared_trailers.size() >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  5148. return;
  5149. }
  5150. std::string key(b, e);
  5151. if (prohibited_trailers.find(key) == prohibited_trailers.end()) {
  5152. declared_trailers.insert(key);
  5153. }
  5154. });
  5155. }
  5156. size_t trailer_header_count = 0;
  5157. while (strcmp(line_reader.ptr(), "\r\n") != 0) {
  5158. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  5159. // Count every received trailer field, not only the declared ones stored in
  5160. // dest, so undeclared fields cannot keep this loop running past the limit.
  5161. if (trailer_header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  5162. constexpr auto line_terminator_len = 2;
  5163. auto line_beg = line_reader.ptr();
  5164. auto line_end =
  5165. line_reader.ptr() + line_reader.size() - line_terminator_len;
  5166. if (!parse_header(line_beg, line_end,
  5167. [&](const std::string &key, const std::string &val) {
  5168. if (declared_trailers.find(key) !=
  5169. declared_trailers.end()) {
  5170. dest.emplace(key, val);
  5171. }
  5172. })) {
  5173. return false;
  5174. }
  5175. trailer_header_count++;
  5176. if (!line_reader.getline()) { return false; }
  5177. }
  5178. return true;
  5179. }
  5180. inline std::pair<size_t, size_t> trim(const char *b, const char *e, size_t left,
  5181. size_t right) {
  5182. while (b + left < e && is_space_or_tab(b[left])) {
  5183. left++;
  5184. }
  5185. while (right > 0 && is_space_or_tab(b[right - 1])) {
  5186. right--;
  5187. }
  5188. return std::make_pair(left, right);
  5189. }
  5190. inline std::string trim_copy(const std::string &s) {
  5191. auto r = trim(s.data(), s.data() + s.size(), 0, s.size());
  5192. return s.substr(r.first, r.second - r.first);
  5193. }
  5194. inline std::string trim_double_quotes_copy(const std::string &s) {
  5195. if (s.length() >= 2 && s.front() == '"' && s.back() == '"') {
  5196. return s.substr(1, s.size() - 2);
  5197. }
  5198. return s;
  5199. }
  5200. // Takes the quotes off a parameter value. Only \" and \\ are quoted-pairs
  5201. // here, as browsers send any other backslash, such as one in a Windows path,
  5202. // as it is.
  5203. inline std::string unquote_param(const std::string &s) {
  5204. if (s.size() < 2 || s.front() != '"' || s.back() != '"') { return s; }
  5205. std::string out;
  5206. for (size_t i = 1; i + 1 < s.size(); i++) {
  5207. if (s[i] == '\\' && i + 2 < s.size() &&
  5208. (s[i + 1] == '"' || s[i + 1] == '\\')) {
  5209. i++;
  5210. }
  5211. out += s[i];
  5212. }
  5213. return out;
  5214. }
  5215. inline void
  5216. divide(const char *data, std::size_t size, char d,
  5217. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5218. fn) {
  5219. const auto it = std::find(data, data + size, d);
  5220. const auto found = static_cast<std::size_t>(it != data + size);
  5221. const auto lhs_data = data;
  5222. const auto lhs_size = static_cast<std::size_t>(it - data);
  5223. const auto rhs_data = it + found;
  5224. const auto rhs_size = size - lhs_size - found;
  5225. fn(lhs_data, lhs_size, rhs_data, rhs_size);
  5226. }
  5227. inline void
  5228. divide(const std::string &str, char d,
  5229. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5230. fn) {
  5231. divide(str.data(), str.size(), d, std::move(fn));
  5232. }
  5233. inline void split(const char *b, const char *e, char d,
  5234. std::function<void(const char *, const char *)> fn) {
  5235. return split(b, e, d, (std::numeric_limits<size_t>::max)(), std::move(fn));
  5236. }
  5237. inline void split(const char *b, const char *e, char d, size_t m,
  5238. std::function<void(const char *, const char *)> fn) {
  5239. size_t i = 0;
  5240. size_t beg = 0;
  5241. size_t count = 1;
  5242. while (e ? (b + i < e) : (b[i] != '\0')) {
  5243. if (b[i] == d && count < m) {
  5244. auto r = trim(b, e, beg, i);
  5245. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5246. beg = i + 1;
  5247. count++;
  5248. }
  5249. i++;
  5250. }
  5251. if (i) {
  5252. auto r = trim(b, e, beg, i);
  5253. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5254. }
  5255. }
  5256. // Same contract as split(), except that a delimiter inside a quoted-string is
  5257. // not a delimiter. RFC 9110 Section 5.6.6 lets a parameter value be a
  5258. // quoted-string, and ';' and '=' are legal characters inside one.
  5259. inline void split_unquoted(const char *b, const char *e, char d, size_t m,
  5260. std::function<void(const char *, const char *)> fn) {
  5261. size_t i = 0;
  5262. size_t beg = 0;
  5263. size_t count = 1;
  5264. auto in_quotes = false;
  5265. auto has = [&](size_t j) { return e ? (b + j < e) : (b[j] != '\0'); };
  5266. while (has(i)) {
  5267. if (in_quotes && b[i] == '\\' && has(i + 1)) {
  5268. // A quoted-pair, whose second character does not end the string.
  5269. i++;
  5270. } else if (b[i] == '"') {
  5271. in_quotes = !in_quotes;
  5272. } else if (b[i] == d && !in_quotes && count < m) {
  5273. auto r = trim(b, e, beg, i);
  5274. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5275. beg = i + 1;
  5276. count++;
  5277. }
  5278. i++;
  5279. }
  5280. if (i) {
  5281. auto r = trim(b, e, beg, i);
  5282. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5283. }
  5284. }
  5285. inline void split_unquoted(const char *b, const char *e, char d,
  5286. std::function<void(const char *, const char *)> fn) {
  5287. return split_unquoted(b, e, d, (std::numeric_limits<size_t>::max)(),
  5288. std::move(fn));
  5289. }
  5290. // Divide a header parameter at its first '='. RFC 9110 Section 5.6.6 makes the
  5291. // key a token, so the first '=' is the separator even when the value is a
  5292. // quoted-string carrying more of them.
  5293. inline void divide_param_pair(const char *b, const char *e, std::string &key,
  5294. std::string &val) {
  5295. divide(
  5296. b, static_cast<std::size_t>(e - b), '=',
  5297. [&](const char *kb, std::size_t klen, const char *vb, std::size_t vlen) {
  5298. const auto kr = trim(kb, kb + klen, 0, klen);
  5299. key.assign(kb + kr.first, kb + kr.second);
  5300. const auto vr = trim(vb, vb + vlen, 0, vlen);
  5301. val.assign(vb + vr.first, vb + vr.second);
  5302. });
  5303. }
  5304. inline bool split_find(const char *b, const char *e, char d, size_t m,
  5305. std::function<bool(const char *, const char *)> fn) {
  5306. size_t i = 0;
  5307. size_t beg = 0;
  5308. size_t count = 1;
  5309. while (e ? (b + i < e) : (b[i] != '\0')) {
  5310. if (b[i] == d && count < m) {
  5311. auto r = trim(b, e, beg, i);
  5312. if (r.first < r.second) {
  5313. auto found = fn(&b[r.first], &b[r.second]);
  5314. if (found) { return true; }
  5315. }
  5316. beg = i + 1;
  5317. count++;
  5318. }
  5319. i++;
  5320. }
  5321. if (i) {
  5322. auto r = trim(b, e, beg, i);
  5323. if (r.first < r.second) {
  5324. auto found = fn(&b[r.first], &b[r.second]);
  5325. if (found) { return true; }
  5326. }
  5327. }
  5328. return false;
  5329. }
  5330. inline bool split_find(const char *b, const char *e, char d,
  5331. std::function<bool(const char *, const char *)> fn) {
  5332. return split_find(b, e, d, (std::numeric_limits<size_t>::max)(),
  5333. std::move(fn));
  5334. }
  5335. inline stream_line_reader::stream_line_reader(Stream &strm, char *fixed_buffer,
  5336. size_t fixed_buffer_size)
  5337. : strm_(strm), fixed_buffer_(fixed_buffer),
  5338. fixed_buffer_size_(fixed_buffer_size) {}
  5339. inline const char *stream_line_reader::ptr() const {
  5340. if (growable_buffer_.empty()) {
  5341. return fixed_buffer_;
  5342. } else {
  5343. return growable_buffer_.data();
  5344. }
  5345. }
  5346. inline size_t stream_line_reader::size() const {
  5347. if (growable_buffer_.empty()) {
  5348. return fixed_buffer_used_size_;
  5349. } else {
  5350. return growable_buffer_.size();
  5351. }
  5352. }
  5353. inline bool stream_line_reader::end_with_crlf() const {
  5354. auto end = ptr() + size();
  5355. return size() >= 2 && end[-2] == '\r' && end[-1] == '\n';
  5356. }
  5357. inline bool stream_line_reader::getline() {
  5358. fixed_buffer_used_size_ = 0;
  5359. growable_buffer_.clear();
  5360. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5361. char prev_byte = 0;
  5362. #endif
  5363. for (size_t i = 0;; i++) {
  5364. // Fast path: whatever the stream has already buffered can be scanned for
  5365. // the terminator in one pass. Asking for a byte at a time costs a virtual
  5366. // call, a bounds check and a one-byte copy per character of the request.
  5367. size_t buffered_size = 0;
  5368. if (auto buffered = strm_.buffered_data(buffered_size)) {
  5369. auto take = buffered_size;
  5370. auto terminated = false;
  5371. for (size_t at = 0; at < buffered_size;) {
  5372. auto nl = static_cast<const char *>(
  5373. memchr(buffered + at, '\n', buffered_size - at));
  5374. if (!nl) { break; }
  5375. auto pos = static_cast<size_t>(nl - buffered);
  5376. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5377. take = pos + 1;
  5378. terminated = true;
  5379. break;
  5380. #else
  5381. // A bare LF does not end the line; keep looking for CRLF. The CR may
  5382. // be the last byte of an earlier chunk, hence prev_byte.
  5383. if ((pos > 0 ? buffered[pos - 1] : prev_byte) == '\r') {
  5384. take = pos + 1;
  5385. terminated = true;
  5386. break;
  5387. }
  5388. at = pos + 1;
  5389. #endif
  5390. }
  5391. if (size() + take > CPPHTTPLIB_MAX_LINE_LENGTH) { return false; }
  5392. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5393. prev_byte = buffered[take - 1];
  5394. #endif
  5395. append(buffered, take);
  5396. strm_.consume_buffered(take);
  5397. i += take;
  5398. if (terminated) { return true; }
  5399. continue;
  5400. }
  5401. if (size() >= CPPHTTPLIB_MAX_LINE_LENGTH) {
  5402. // Treat exceptionally long lines as an error to
  5403. // prevent infinite loops/memory exhaustion
  5404. return false;
  5405. }
  5406. char byte;
  5407. auto n = strm_.read(&byte, 1);
  5408. if (n < 0) {
  5409. return false;
  5410. } else if (n == 0) {
  5411. if (i == 0) {
  5412. return false;
  5413. } else {
  5414. break;
  5415. }
  5416. }
  5417. append(byte);
  5418. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5419. if (byte == '\n') { break; }
  5420. #else
  5421. if (prev_byte == '\r' && byte == '\n') { break; }
  5422. prev_byte = byte;
  5423. #endif
  5424. }
  5425. return true;
  5426. }
  5427. inline void stream_line_reader::append(char c) { append(&c, 1); }
  5428. inline void stream_line_reader::append(const char *data, size_t size) {
  5429. // Once the line has outgrown the fixed buffer everything must keep going to
  5430. // the growable one, even if a later chunk would have fit. Without the
  5431. // emptiness check a short append after a long one would land in the fixed
  5432. // buffer, which ptr() and size() no longer look at, and be lost.
  5433. if (growable_buffer_.empty() &&
  5434. fixed_buffer_used_size_ + size < fixed_buffer_size_) {
  5435. memcpy(fixed_buffer_ + fixed_buffer_used_size_, data, size);
  5436. fixed_buffer_used_size_ += size;
  5437. fixed_buffer_[fixed_buffer_used_size_] = '\0';
  5438. } else {
  5439. // Unlike the per-character overload, this can be the very first append of
  5440. // the line, so the fixed buffer may hold nothing and carry no terminator
  5441. // yet. assign() takes an explicit length and does not need one.
  5442. if (growable_buffer_.empty()) {
  5443. growable_buffer_.assign(fixed_buffer_, fixed_buffer_used_size_);
  5444. }
  5445. growable_buffer_.append(data, size);
  5446. }
  5447. }
  5448. inline mmap::mmap(const char *path) { open(path); }
  5449. inline mmap::~mmap() { close(); }
  5450. inline bool mmap::open(const char *path) {
  5451. close();
  5452. #if defined(_WIN32)
  5453. auto wpath = u8string_to_wstring(path);
  5454. if (wpath.empty()) { return false; }
  5455. hFile_ =
  5456. ::CreateFile2(wpath.c_str(), GENERIC_READ,
  5457. FILE_SHARE_READ | FILE_SHARE_WRITE, OPEN_EXISTING, NULL);
  5458. if (hFile_ == INVALID_HANDLE_VALUE) { return false; }
  5459. LARGE_INTEGER size{};
  5460. if (!::GetFileSizeEx(hFile_, &size)) { return false; }
  5461. // If the following line doesn't compile due to QuadPart, update Windows SDK.
  5462. // See:
  5463. // https://github.com/yhirose/cpp-httplib/issues/1903#issuecomment-2316520721
  5464. if (!fits_in_size_t(static_cast<uint64_t>(size.QuadPart))) { return false; }
  5465. size_ = static_cast<size_t>(size.QuadPart);
  5466. hMapping_ =
  5467. ::CreateFileMappingFromApp(hFile_, NULL, PAGE_READONLY, size_, NULL);
  5468. // Special treatment for an empty file...
  5469. if (hMapping_ == NULL && size_ == 0) {
  5470. close();
  5471. is_open_empty_file = true;
  5472. return true;
  5473. }
  5474. if (hMapping_ == NULL) {
  5475. close();
  5476. return false;
  5477. }
  5478. addr_ = ::MapViewOfFileFromApp(hMapping_, FILE_MAP_READ, 0, 0);
  5479. if (addr_ == nullptr) {
  5480. close();
  5481. return false;
  5482. }
  5483. #else
  5484. // O_NONBLOCK so that opening a FIFO does not wait for a writer.
  5485. fd_ = ::open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC);
  5486. if (fd_ == -1) { return false; }
  5487. // Only a regular file has a size to serve, unlike a directory or a device.
  5488. struct stat sb;
  5489. if (fstat(fd_, &sb) == -1 || !S_ISREG(sb.st_mode) ||
  5490. !fits_in_size_t(static_cast<uint64_t>(sb.st_size))) {
  5491. close();
  5492. return false;
  5493. }
  5494. size_ = static_cast<size_t>(sb.st_size);
  5495. #endif
  5496. return true;
  5497. }
  5498. inline bool mmap::is_open() const {
  5499. #if defined(_WIN32)
  5500. return is_open_empty_file ? true : addr_ != nullptr;
  5501. #else
  5502. return fd_ != -1;
  5503. #endif
  5504. }
  5505. inline size_t mmap::size() const { return size_; }
  5506. inline void mmap::close() {
  5507. #if defined(_WIN32)
  5508. if (addr_) {
  5509. ::UnmapViewOfFile(addr_);
  5510. addr_ = nullptr;
  5511. }
  5512. if (hMapping_) {
  5513. ::CloseHandle(hMapping_);
  5514. hMapping_ = NULL;
  5515. }
  5516. if (hFile_ != INVALID_HANDLE_VALUE) {
  5517. ::CloseHandle(hFile_);
  5518. hFile_ = INVALID_HANDLE_VALUE;
  5519. }
  5520. is_open_empty_file = false;
  5521. #else
  5522. if (fd_ != -1) {
  5523. ::close(fd_);
  5524. fd_ = -1;
  5525. }
  5526. #endif
  5527. size_ = 0;
  5528. }
  5529. inline int close_socket(socket_t sock) noexcept {
  5530. #ifdef _WIN32
  5531. return closesocket(sock);
  5532. #else
  5533. return close(sock);
  5534. #endif
  5535. }
  5536. template <typename T> inline ssize_t handle_EINTR(T fn) {
  5537. ssize_t res = 0;
  5538. while (true) {
  5539. res = fn();
  5540. if (res < 0 && errno == EINTR) {
  5541. std::this_thread::sleep_for(std::chrono::microseconds{1});
  5542. continue;
  5543. }
  5544. break;
  5545. }
  5546. return res;
  5547. }
  5548. inline size_t mmap::read(size_t offset, char *buf, size_t len) const {
  5549. if (offset >= size_) { return 0; }
  5550. len = (std::min)(len, size_ - offset);
  5551. #if defined(_WIN32)
  5552. // Windows does not let a mapped file be truncated.
  5553. std::memcpy(buf, static_cast<const char *>(addr_) + offset, len);
  5554. return len;
  5555. #else
  5556. auto n = handle_EINTR(
  5557. [&]() { return ::pread(fd_, buf, len, static_cast<off_t>(offset)); });
  5558. return n > 0 ? static_cast<size_t>(n) : 0;
  5559. #endif
  5560. }
  5561. inline ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags) {
  5562. return handle_EINTR([&]() {
  5563. return recv(sock,
  5564. #ifdef _WIN32
  5565. static_cast<char *>(ptr), static_cast<int>(size),
  5566. #else
  5567. ptr, size,
  5568. #endif
  5569. flags);
  5570. });
  5571. }
  5572. inline ssize_t send_socket(socket_t sock, const void *ptr, size_t size,
  5573. int flags) {
  5574. return handle_EINTR([&]() {
  5575. return send(sock,
  5576. #ifdef _WIN32
  5577. static_cast<const char *>(ptr), static_cast<int>(size),
  5578. #else
  5579. ptr, size,
  5580. #endif
  5581. flags);
  5582. });
  5583. }
  5584. inline int poll_wrapper(struct pollfd *fds, nfds_t nfds, int timeout) {
  5585. #ifdef _WIN32
  5586. return ::WSAPoll(fds, nfds, timeout);
  5587. #else
  5588. return ::poll(fds, nfds, timeout);
  5589. #endif
  5590. }
  5591. inline ssize_t select_impl(socket_t sock, short events, time_t sec,
  5592. time_t usec) {
  5593. struct pollfd pfd;
  5594. pfd.fd = sock;
  5595. pfd.events = events;
  5596. pfd.revents = 0;
  5597. // A negative timeout waits forever, poll's own convention. 0 keeps meaning
  5598. // "return immediately", which callers here rely on to probe a socket.
  5599. auto timeout = sec < 0 ? -1 : static_cast<int>(sec * 1000 + usec / 1000);
  5600. return handle_EINTR([&]() { return poll_wrapper(&pfd, 1, timeout); });
  5601. }
  5602. inline ssize_t select_read(socket_t sock, time_t sec, time_t usec) {
  5603. return select_impl(sock, POLLIN, sec, usec);
  5604. }
  5605. inline ssize_t select_write(socket_t sock, time_t sec, time_t usec) {
  5606. return select_impl(sock, POLLOUT, sec, usec);
  5607. }
  5608. // The point sec and usec from now, for select_until(). A negative sec never
  5609. // comes, as a negative timeout waits forever in select_impl().
  5610. inline std::chrono::steady_clock::time_point deadline_after(time_t sec,
  5611. time_t usec) {
  5612. if (sec < 0) { return (std::chrono::steady_clock::time_point::max)(); }
  5613. return std::chrono::steady_clock::now() + std::chrono::seconds(sec) +
  5614. std::chrono::microseconds(usec);
  5615. }
  5616. // Waits only for the time left until deadline, so that all the waits of one
  5617. // TLS handshake come out of a single timeout.
  5618. inline ssize_t select_until(socket_t sock, short events,
  5619. std::chrono::steady_clock::time_point deadline) {
  5620. if (deadline == (std::chrono::steady_clock::time_point::max)()) {
  5621. return select_impl(sock, events, -1, 0);
  5622. }
  5623. auto left = std::chrono::duration_cast<std::chrono::microseconds>(
  5624. deadline - std::chrono::steady_clock::now())
  5625. .count();
  5626. if (left <= 0) { return 0; }
  5627. return select_impl(sock, events, static_cast<time_t>(left / 1000000),
  5628. static_cast<time_t>(left % 1000000));
  5629. }
  5630. // select_read(), but waits in slices and gives up once interrupted() returns
  5631. // true. A local shutdown() would not wake the wait on Windows.
  5632. inline ssize_t
  5633. select_read_interruptible(socket_t sock, time_t sec, time_t usec,
  5634. const std::function<bool()> &interrupted) {
  5635. if (!interrupted) { return select_read(sock, sec, usec); }
  5636. const auto slice = std::chrono::microseconds(100000);
  5637. auto deadline = deadline_after(sec, usec);
  5638. while (!interrupted()) {
  5639. auto left = std::chrono::duration_cast<std::chrono::microseconds>(
  5640. deadline - std::chrono::steady_clock::now());
  5641. auto wait =
  5642. (std::max)((std::min)(left, slice), std::chrono::microseconds(0));
  5643. auto ret = select_impl(sock, POLLIN, 0, static_cast<time_t>(wait.count()));
  5644. if (ret != 0 || wait < slice) { return ret; }
  5645. }
  5646. return 0;
  5647. }
  5648. inline Error wait_until_socket_is_ready(socket_t sock, time_t sec,
  5649. time_t usec) {
  5650. struct pollfd pfd_read;
  5651. pfd_read.fd = sock;
  5652. pfd_read.events = POLLIN | POLLOUT;
  5653. pfd_read.revents = 0;
  5654. auto timeout = static_cast<int>(sec * 1000 + usec / 1000);
  5655. auto poll_res =
  5656. handle_EINTR([&]() { return poll_wrapper(&pfd_read, 1, timeout); });
  5657. if (poll_res == 0) { return Error::ConnectionTimeout; }
  5658. if (poll_res > 0 && pfd_read.revents & (POLLIN | POLLOUT)) {
  5659. auto error = 0;
  5660. socklen_t len = sizeof(error);
  5661. auto res = getsockopt(sock, SOL_SOCKET, SO_ERROR,
  5662. reinterpret_cast<char *>(&error), &len);
  5663. auto successful = res >= 0 && !error;
  5664. return successful ? Error::Success : Error::Connection;
  5665. }
  5666. return Error::Connection;
  5667. }
  5668. inline bool is_socket_alive(socket_t sock) {
  5669. const auto val = detail::select_read(sock, 0, 0);
  5670. if (val == 0) {
  5671. return true;
  5672. } else if (val < 0 && errno == EBADF) {
  5673. return false;
  5674. }
  5675. char buf[1];
  5676. return detail::read_socket(sock, &buf[0], sizeof(buf), MSG_PEEK) > 0;
  5677. }
  5678. class SocketStream final : public Stream {
  5679. public:
  5680. SocketStream(socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5681. time_t write_timeout_sec, time_t write_timeout_usec,
  5682. time_t max_timeout_msec = 0,
  5683. std::chrono::time_point<std::chrono::steady_clock> start_time =
  5684. (std::chrono::steady_clock::time_point::min)());
  5685. ~SocketStream() override;
  5686. bool is_readable() const override;
  5687. bool wait_readable() const override;
  5688. bool wait_writable() const override;
  5689. bool is_peer_alive() const override;
  5690. ssize_t read(char *ptr, size_t size) override;
  5691. ssize_t write(const char *ptr, size_t size) override;
  5692. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  5693. void get_local_ip_and_port(std::string &ip, int &port) const override;
  5694. socket_t socket() const override;
  5695. time_t duration() const override;
  5696. void set_read_timeout(time_t sec, time_t usec = 0) override;
  5697. void set_max_timeout(time_t msec) override;
  5698. void set_read_interrupt(std::function<bool()> interrupted) override;
  5699. const char *buffered_data(size_t &size) const override;
  5700. void consume_buffered(size_t size) override;
  5701. // The caller has just seen this socket become readable. Lets the next read
  5702. // skip its own readiness wait, which would otherwise ask the kernel a
  5703. // question that was answered a moment ago. Consumed by that read.
  5704. void set_readable_hint() { readable_hint_ = true; }
  5705. private:
  5706. bool ensure_readable();
  5707. socket_t sock_;
  5708. // Atomic because ws::WebSocket::set_read_timeout() reaches this from another
  5709. // thread while a read is in flight -- that is the point of it, for a caller
  5710. // holding one connection and wanting control back to send on it.
  5711. std::atomic<time_t> read_timeout_sec_;
  5712. std::atomic<time_t> read_timeout_usec_;
  5713. time_t write_timeout_sec_;
  5714. time_t write_timeout_usec_;
  5715. time_t max_timeout_msec_;
  5716. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  5717. std::function<bool()> read_interrupted_;
  5718. std::vector<char> read_buff_;
  5719. size_t read_buff_off_ = 0;
  5720. size_t read_buff_content_size_ = 0;
  5721. bool readable_hint_ = false;
  5722. static const size_t read_buff_size_ = 1024l * 4;
  5723. };
  5724. inline bool keep_alive(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5725. time_t keep_alive_timeout_sec) {
  5726. using namespace std::chrono;
  5727. const auto interval_usec =
  5728. CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND;
  5729. // Avoid expensive `steady_clock::now()` call for the first time
  5730. if (select_read(sock, 0, interval_usec) > 0) { return true; }
  5731. const auto start = steady_clock::now() - microseconds{interval_usec};
  5732. const auto timeout = seconds{keep_alive_timeout_sec};
  5733. while (true) {
  5734. if (svr_sock == INVALID_SOCKET) {
  5735. break; // Server socket is closed
  5736. }
  5737. auto val = select_read(sock, 0, interval_usec);
  5738. if (val < 0) {
  5739. break; // Ssocket error
  5740. } else if (val == 0) {
  5741. if (steady_clock::now() - start > timeout) {
  5742. break; // Timeout
  5743. }
  5744. } else {
  5745. return true; // Ready for read
  5746. }
  5747. }
  5748. return false;
  5749. }
  5750. // `has_buffered_request` reports whether the connection's stream already holds
  5751. // bytes of the next request. A client may pipeline its requests (RFC 9112
  5752. // 9.3.2), so reading one request can pull the start of the next one into the
  5753. // stream's buffer; that request must be served without waiting for the socket
  5754. // to become readable again, since its bytes are no longer on the socket.
  5755. // `callback` is told whether keep_alive() has just seen the socket go readable.
  5756. template <typename P, typename T>
  5757. inline bool process_server_socket_core(const std::atomic<socket_t> &svr_sock,
  5758. socket_t sock,
  5759. size_t keep_alive_max_count,
  5760. time_t keep_alive_timeout_sec,
  5761. P has_buffered_request, T callback) {
  5762. auto ret = false;
  5763. // A keep_alive_max_count of 0 sets no limit.
  5764. for (size_t served = 0;
  5765. keep_alive_max_count == 0 || served < keep_alive_max_count; served++) {
  5766. auto socket_readable = false;
  5767. if (!has_buffered_request()) {
  5768. if (!keep_alive(svr_sock, sock, keep_alive_timeout_sec)) { break; }
  5769. socket_readable = true;
  5770. }
  5771. auto close_connection = served + 1 == keep_alive_max_count;
  5772. auto connection_closed = false;
  5773. ret = callback(socket_readable, close_connection, connection_closed);
  5774. if (!ret || connection_closed) { break; }
  5775. }
  5776. return ret;
  5777. }
  5778. template <typename T>
  5779. inline bool
  5780. process_server_socket(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5781. size_t keep_alive_max_count,
  5782. time_t keep_alive_timeout_sec, time_t read_timeout_sec,
  5783. time_t read_timeout_usec, time_t write_timeout_sec,
  5784. time_t write_timeout_usec, T callback) {
  5785. // One stream per connection: its read buffer can already hold the start of
  5786. // the next, pipelined request.
  5787. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5788. write_timeout_sec, write_timeout_usec);
  5789. return process_server_socket_core(
  5790. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  5791. [&]() { return strm.is_readable(); },
  5792. [&](bool socket_readable, bool close_connection,
  5793. bool &connection_closed) {
  5794. if (socket_readable) { strm.set_readable_hint(); }
  5795. return callback(strm, close_connection, connection_closed);
  5796. });
  5797. }
  5798. inline bool process_client_socket(
  5799. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5800. time_t write_timeout_sec, time_t write_timeout_usec,
  5801. time_t max_timeout_msec,
  5802. std::chrono::time_point<std::chrono::steady_clock> start_time,
  5803. std::function<bool(Stream &)> callback) {
  5804. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5805. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  5806. start_time);
  5807. return callback(strm);
  5808. }
  5809. inline int shutdown_socket(socket_t sock) noexcept {
  5810. #ifdef _WIN32
  5811. return shutdown(sock, SD_BOTH);
  5812. #else
  5813. return shutdown(sock, SHUT_RDWR);
  5814. #endif
  5815. }
  5816. // Half-closes the write side and drains any in-flight/queued bytes before
  5817. // the final shutdown+close. Closing with unread data in the receive queue
  5818. // (or bytes arriving after the receive side is closed) makes the stack send
  5819. // an abortive RST instead of a graceful FIN, which can make the peer see the
  5820. // response as a failed read even though it was fully written.
  5821. inline void drain_and_close_socket(socket_t sock) noexcept {
  5822. #ifdef _WIN32
  5823. shutdown(sock, SD_SEND);
  5824. #else
  5825. shutdown(sock, SHUT_WR);
  5826. #endif
  5827. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  5828. size_t total = 0;
  5829. const auto deadline = std::chrono::steady_clock::now() +
  5830. std::chrono::milliseconds(100); // bound #1
  5831. while (total < size_t(1024u * 1024u)) { // bound #2
  5832. const auto remaining =
  5833. std::chrono::duration_cast<std::chrono::microseconds>(
  5834. deadline - std::chrono::steady_clock::now())
  5835. .count();
  5836. if (remaining <= 0) { break; }
  5837. if (select_read(sock, 0, static_cast<time_t>(remaining)) <= 0) { break; }
  5838. const auto n = read_socket(sock, buf, sizeof(buf), CPPHTTPLIB_RECV_FLAGS);
  5839. if (n <= 0) { break; }
  5840. total += static_cast<size_t>(n);
  5841. }
  5842. shutdown_socket(sock);
  5843. close_socket(sock);
  5844. }
  5845. inline std::string escape_abstract_namespace_unix_domain(const std::string &s) {
  5846. if (s.size() > 1 && s[0] == '\0') {
  5847. auto ret = s;
  5848. ret[0] = '@';
  5849. return ret;
  5850. }
  5851. return s;
  5852. }
  5853. inline std::string
  5854. unescape_abstract_namespace_unix_domain(const std::string &s) {
  5855. if (s.size() > 1 && s[0] == '@') {
  5856. auto ret = s;
  5857. ret[0] = '\0';
  5858. return ret;
  5859. }
  5860. return s;
  5861. }
  5862. inline int getaddrinfo_with_timeout(const char *node, const char *service,
  5863. const struct addrinfo *hints,
  5864. struct addrinfo **res, time_t timeout_sec) {
  5865. #ifdef CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO
  5866. if (timeout_sec <= 0) {
  5867. // No timeout specified, use standard getaddrinfo
  5868. return getaddrinfo(node, service, hints, res);
  5869. }
  5870. #ifdef _WIN32
  5871. // Windows-specific implementation using GetAddrInfoEx with overlapped I/O
  5872. OVERLAPPED overlapped = {};
  5873. HANDLE event = CreateEventW(nullptr, TRUE, FALSE, nullptr);
  5874. if (!event) { return EAI_FAIL; }
  5875. overlapped.hEvent = event;
  5876. PADDRINFOEXW result_addrinfo = nullptr;
  5877. HANDLE cancel_handle = nullptr;
  5878. ADDRINFOEXW hints_ex = {};
  5879. if (hints) {
  5880. hints_ex.ai_flags = hints->ai_flags;
  5881. hints_ex.ai_family = hints->ai_family;
  5882. hints_ex.ai_socktype = hints->ai_socktype;
  5883. hints_ex.ai_protocol = hints->ai_protocol;
  5884. }
  5885. auto wnode = u8string_to_wstring(node);
  5886. auto wservice = u8string_to_wstring(service);
  5887. auto ret = ::GetAddrInfoExW(wnode.data(), wservice.data(), NS_DNS, nullptr,
  5888. hints ? &hints_ex : nullptr, &result_addrinfo,
  5889. nullptr, &overlapped, nullptr, &cancel_handle);
  5890. if (ret == WSA_IO_PENDING) {
  5891. auto wait_result =
  5892. ::WaitForSingleObject(event, static_cast<DWORD>(timeout_sec * 1000));
  5893. if (wait_result == WAIT_TIMEOUT) {
  5894. if (cancel_handle) { ::GetAddrInfoExCancel(&cancel_handle); }
  5895. ::CloseHandle(event);
  5896. return EAI_AGAIN;
  5897. }
  5898. DWORD bytes_returned;
  5899. if (!::GetOverlappedResult((HANDLE)INVALID_SOCKET, &overlapped,
  5900. &bytes_returned, FALSE)) {
  5901. ::CloseHandle(event);
  5902. return ::WSAGetLastError();
  5903. }
  5904. }
  5905. ::CloseHandle(event);
  5906. if (ret == NO_ERROR || ret == WSA_IO_PENDING) {
  5907. *res = reinterpret_cast<struct addrinfo *>(result_addrinfo);
  5908. return 0;
  5909. }
  5910. return ret;
  5911. #elif TARGET_OS_MAC && defined(__clang__)
  5912. if (!node) { return EAI_NONAME; }
  5913. // macOS implementation using CFHost API for asynchronous DNS resolution
  5914. CFStringRef hostname_ref = CFStringCreateWithCString(
  5915. kCFAllocatorDefault, node, kCFStringEncodingUTF8);
  5916. if (!hostname_ref) { return EAI_MEMORY; }
  5917. CFHostRef host_ref = CFHostCreateWithName(kCFAllocatorDefault, hostname_ref);
  5918. CFRelease(hostname_ref);
  5919. if (!host_ref) { return EAI_MEMORY; }
  5920. // Set up context for callback
  5921. struct CFHostContext {
  5922. bool completed = false;
  5923. bool success = false;
  5924. CFArrayRef addresses = nullptr;
  5925. std::mutex mutex;
  5926. std::condition_variable cv;
  5927. } context;
  5928. CFHostClientContext client_context;
  5929. memset(&client_context, 0, sizeof(client_context));
  5930. client_context.info = &context;
  5931. // Set callback
  5932. auto callback = [](CFHostRef theHost, CFHostInfoType /*typeInfo*/,
  5933. const CFStreamError *error, void *info) {
  5934. auto ctx = static_cast<CFHostContext *>(info);
  5935. std::lock_guard<std::mutex> lock(ctx->mutex);
  5936. if (error && error->error != 0) {
  5937. ctx->success = false;
  5938. } else {
  5939. Boolean hasBeenResolved;
  5940. ctx->addresses = CFHostGetAddressing(theHost, &hasBeenResolved);
  5941. if (ctx->addresses && hasBeenResolved) {
  5942. CFRetain(ctx->addresses);
  5943. ctx->success = true;
  5944. } else {
  5945. ctx->success = false;
  5946. }
  5947. }
  5948. ctx->completed = true;
  5949. ctx->cv.notify_one();
  5950. };
  5951. if (!CFHostSetClient(host_ref, callback, &client_context)) {
  5952. CFRelease(host_ref);
  5953. return EAI_SYSTEM;
  5954. }
  5955. // Schedule on run loop
  5956. CFRunLoopRef run_loop = CFRunLoopGetCurrent();
  5957. CFHostScheduleWithRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5958. // Start resolution
  5959. CFStreamError stream_error;
  5960. if (!CFHostStartInfoResolution(host_ref, kCFHostAddresses, &stream_error)) {
  5961. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5962. CFRelease(host_ref);
  5963. return EAI_FAIL;
  5964. }
  5965. // Wait for completion with timeout
  5966. auto timeout_time =
  5967. std::chrono::steady_clock::now() + std::chrono::seconds(timeout_sec);
  5968. bool timed_out = false;
  5969. {
  5970. std::unique_lock<std::mutex> lock(context.mutex);
  5971. while (!context.completed) {
  5972. auto now = std::chrono::steady_clock::now();
  5973. if (now >= timeout_time) {
  5974. timed_out = true;
  5975. break;
  5976. }
  5977. // Run the runloop for a short time
  5978. lock.unlock();
  5979. CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.1, true);
  5980. lock.lock();
  5981. }
  5982. }
  5983. // Clean up
  5984. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5985. CFHostSetClient(host_ref, nullptr, nullptr);
  5986. if (timed_out || !context.completed) {
  5987. CFHostCancelInfoResolution(host_ref, kCFHostAddresses);
  5988. CFRelease(host_ref);
  5989. return EAI_AGAIN;
  5990. }
  5991. if (!context.success || !context.addresses) {
  5992. CFRelease(host_ref);
  5993. return EAI_NODATA;
  5994. }
  5995. // Convert CFArray to addrinfo
  5996. CFIndex count = CFArrayGetCount(context.addresses);
  5997. if (count == 0) {
  5998. CFRelease(context.addresses);
  5999. CFRelease(host_ref);
  6000. return EAI_NODATA;
  6001. }
  6002. struct addrinfo *result_addrinfo = nullptr;
  6003. struct addrinfo **current = &result_addrinfo;
  6004. for (CFIndex i = 0; i < count; i++) {
  6005. CFDataRef addr_data =
  6006. static_cast<CFDataRef>(CFArrayGetValueAtIndex(context.addresses, i));
  6007. if (!addr_data) continue;
  6008. const struct sockaddr *sockaddr_ptr =
  6009. reinterpret_cast<const struct sockaddr *>(CFDataGetBytePtr(addr_data));
  6010. socklen_t sockaddr_len = static_cast<socklen_t>(CFDataGetLength(addr_data));
  6011. // Allocate addrinfo structure
  6012. *current = static_cast<struct addrinfo *>(malloc(sizeof(struct addrinfo)));
  6013. if (!*current) {
  6014. freeaddrinfo(result_addrinfo);
  6015. CFRelease(context.addresses);
  6016. CFRelease(host_ref);
  6017. return EAI_MEMORY;
  6018. }
  6019. memset(*current, 0, sizeof(struct addrinfo));
  6020. // Set up addrinfo fields
  6021. (*current)->ai_family = sockaddr_ptr->sa_family;
  6022. (*current)->ai_socktype = hints ? hints->ai_socktype : SOCK_STREAM;
  6023. (*current)->ai_protocol = hints ? hints->ai_protocol : IPPROTO_TCP;
  6024. (*current)->ai_addrlen = sockaddr_len;
  6025. // Copy sockaddr
  6026. (*current)->ai_addr = static_cast<struct sockaddr *>(malloc(sockaddr_len));
  6027. if (!(*current)->ai_addr) {
  6028. freeaddrinfo(result_addrinfo);
  6029. CFRelease(context.addresses);
  6030. CFRelease(host_ref);
  6031. return EAI_MEMORY;
  6032. }
  6033. memcpy((*current)->ai_addr, sockaddr_ptr, sockaddr_len);
  6034. // Set port if service is specified
  6035. if (service && *service) {
  6036. int port = 0;
  6037. if (parse_port(service, strlen(service), port)) {
  6038. if (sockaddr_ptr->sa_family == AF_INET) {
  6039. reinterpret_cast<struct sockaddr_in *>((*current)->ai_addr)
  6040. ->sin_port = htons(static_cast<uint16_t>(port));
  6041. } else if (sockaddr_ptr->sa_family == AF_INET6) {
  6042. reinterpret_cast<struct sockaddr_in6 *>((*current)->ai_addr)
  6043. ->sin6_port = htons(static_cast<uint16_t>(port));
  6044. }
  6045. }
  6046. }
  6047. current = &((*current)->ai_next);
  6048. }
  6049. CFRelease(context.addresses);
  6050. CFRelease(host_ref);
  6051. *res = result_addrinfo;
  6052. return 0;
  6053. #elif defined(_GNU_SOURCE) && defined(__GLIBC__) && \
  6054. (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 2)) && \
  6055. !defined(CPPHTTPLIB_THREAD_SANITIZER)
  6056. // Skipped under TSan: glibc's internal resolver thread is invisible to it.
  6057. // #2431: gai_cancel() is non-blocking and may return EAI_NOTCANCELED while
  6058. // the resolver worker still references the stack-local gaicb. The cancel
  6059. // path therefore waits (gai_suspend with no timeout) for the worker to
  6060. // actually finish before letting the stack frame go. The trade-off is that
  6061. // a wedged DNS server can hold this thread for the system resolver timeout
  6062. // (~30s by default) past the caller's connection timeout.
  6063. struct gaicb request{};
  6064. struct gaicb *requests[1] = {&request};
  6065. struct sigevent sevp{};
  6066. struct timespec timeout{timeout_sec, 0};
  6067. request.ar_name = node;
  6068. request.ar_service = service;
  6069. request.ar_request = hints;
  6070. sevp.sigev_notify = SIGEV_NONE;
  6071. int rc = getaddrinfo_a(GAI_NOWAIT, requests, 1, &sevp);
  6072. if (rc != 0) { return rc; }
  6073. auto cleanup = scope_exit([&] {
  6074. if (request.ar_result) { freeaddrinfo(request.ar_result); }
  6075. });
  6076. int wait_result = gai_suspend(requests, 1, &timeout);
  6077. if (wait_result == 0 || wait_result == EAI_ALLDONE) {
  6078. int gai_result = gai_error(&request);
  6079. if (gai_result == 0) {
  6080. *res = request.ar_result;
  6081. request.ar_result = nullptr;
  6082. return 0;
  6083. }
  6084. return gai_result;
  6085. }
  6086. gai_cancel(&request);
  6087. while (gai_error(&request) == EAI_INPROGRESS) {
  6088. gai_suspend(requests, 1, nullptr);
  6089. }
  6090. return wait_result;
  6091. #else
  6092. // Fallback implementation using thread-based timeout for other Unix systems.
  6093. struct GetAddrInfoState {
  6094. ~GetAddrInfoState() {
  6095. if (info) { freeaddrinfo(info); }
  6096. }
  6097. std::mutex mutex;
  6098. std::condition_variable result_cv;
  6099. bool completed = false;
  6100. int result = EAI_SYSTEM;
  6101. std::string node;
  6102. std::string service;
  6103. struct addrinfo hints;
  6104. struct addrinfo *info = nullptr;
  6105. };
  6106. // Allocate on the heap, so the resolver thread can keep using the data.
  6107. auto state = std::make_shared<GetAddrInfoState>();
  6108. if (node) { state->node = node; }
  6109. state->service = service;
  6110. state->hints = *hints;
  6111. std::thread resolve_thread([state]() {
  6112. auto thread_result =
  6113. getaddrinfo(state->node.c_str(), state->service.c_str(), &state->hints,
  6114. &state->info);
  6115. std::lock_guard<std::mutex> lock(state->mutex);
  6116. state->result = thread_result;
  6117. state->completed = true;
  6118. state->result_cv.notify_one();
  6119. });
  6120. // Wait for completion or timeout
  6121. std::unique_lock<std::mutex> lock(state->mutex);
  6122. auto finished =
  6123. state->result_cv.wait_for(lock, std::chrono::seconds(timeout_sec),
  6124. [&] { return state->completed; });
  6125. if (finished) {
  6126. // Operation completed within timeout
  6127. resolve_thread.join();
  6128. *res = state->info;
  6129. state->info = nullptr; // Pass ownership to caller
  6130. return state->result;
  6131. } else {
  6132. // Timeout occurred
  6133. resolve_thread.detach(); // Let the thread finish in background
  6134. return EAI_AGAIN; // Return timeout error
  6135. }
  6136. #endif
  6137. #else
  6138. (void)(timeout_sec); // Unused parameter for non-blocking getaddrinfo
  6139. return getaddrinfo(node, service, hints, res);
  6140. #endif
  6141. }
  6142. template <typename BindOrConnect>
  6143. socket_t create_socket(const std::string &host, const std::string &ip, int port,
  6144. int address_family, int socket_flags, bool tcp_nodelay,
  6145. bool ipv6_v6only, SocketOptions socket_options,
  6146. BindOrConnect bind_or_connect, time_t timeout_sec = 0) {
  6147. // Get address info
  6148. const char *node = nullptr;
  6149. struct addrinfo hints;
  6150. struct addrinfo *result;
  6151. memset(&hints, 0, sizeof(struct addrinfo));
  6152. hints.ai_socktype = SOCK_STREAM;
  6153. hints.ai_protocol = IPPROTO_IP;
  6154. if (!ip.empty()) {
  6155. node = ip.c_str();
  6156. // Ask getaddrinfo to convert IP in c-string to address
  6157. hints.ai_family = AF_UNSPEC;
  6158. hints.ai_flags = AI_NUMERICHOST;
  6159. } else {
  6160. if (!host.empty()) { node = host.c_str(); }
  6161. hints.ai_family = address_family;
  6162. hints.ai_flags = socket_flags;
  6163. }
  6164. #if !defined(_WIN32) || defined(CPPHTTPLIB_HAVE_AFUNIX_H)
  6165. if (hints.ai_family == AF_UNIX) {
  6166. const auto addrlen = host.length();
  6167. if (addrlen > sizeof(sockaddr_un::sun_path)) { return INVALID_SOCKET; }
  6168. #ifdef SOCK_CLOEXEC
  6169. auto sock = socket(hints.ai_family, hints.ai_socktype | SOCK_CLOEXEC,
  6170. hints.ai_protocol);
  6171. #else
  6172. auto sock = socket(hints.ai_family, hints.ai_socktype, hints.ai_protocol);
  6173. #endif
  6174. if (sock != INVALID_SOCKET) {
  6175. sockaddr_un addr{};
  6176. addr.sun_family = AF_UNIX;
  6177. auto unescaped_host = unescape_abstract_namespace_unix_domain(host);
  6178. std::copy(unescaped_host.begin(), unescaped_host.end(), addr.sun_path);
  6179. hints.ai_addr = reinterpret_cast<sockaddr *>(&addr);
  6180. hints.ai_addrlen = static_cast<socklen_t>(
  6181. sizeof(addr) - sizeof(addr.sun_path) + addrlen);
  6182. #ifndef SOCK_CLOEXEC
  6183. #ifndef _WIN32
  6184. fcntl(sock, F_SETFD, FD_CLOEXEC);
  6185. #endif
  6186. #endif
  6187. if (socket_options) { socket_options(sock); }
  6188. #ifdef _WIN32
  6189. // Setting SO_REUSEADDR seems not to work well with AF_UNIX on windows, so
  6190. // remove the option.
  6191. set_socket_opt(sock, SOL_SOCKET, SO_REUSEADDR, 0);
  6192. #endif
  6193. bool dummy;
  6194. if (!bind_or_connect(sock, hints, dummy)) {
  6195. close_socket(sock);
  6196. sock = INVALID_SOCKET;
  6197. }
  6198. }
  6199. return sock;
  6200. }
  6201. #endif
  6202. auto service = std::to_string(port);
  6203. if (getaddrinfo_with_timeout(node, service.c_str(), &hints, &result,
  6204. timeout_sec)) {
  6205. #if defined __linux__ && !defined __ANDROID__
  6206. res_init();
  6207. #endif
  6208. return INVALID_SOCKET;
  6209. }
  6210. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6211. for (auto rp = result; rp; rp = rp->ai_next) {
  6212. // Create a socket
  6213. #ifdef _WIN32
  6214. auto sock =
  6215. WSASocketW(rp->ai_family, rp->ai_socktype, rp->ai_protocol, nullptr, 0,
  6216. WSA_FLAG_NO_HANDLE_INHERIT | WSA_FLAG_OVERLAPPED);
  6217. /**
  6218. * Since the WSA_FLAG_NO_HANDLE_INHERIT is only supported on Windows 7 SP1
  6219. * and above the socket creation fails on older Windows Systems.
  6220. *
  6221. * Let's try to create a socket the old way in this case.
  6222. *
  6223. * Reference:
  6224. * https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketa
  6225. *
  6226. * WSA_FLAG_NO_HANDLE_INHERIT:
  6227. * This flag is supported on Windows 7 with SP1, Windows Server 2008 R2 with
  6228. * SP1, and later
  6229. *
  6230. */
  6231. if (sock == INVALID_SOCKET) {
  6232. sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6233. }
  6234. #else
  6235. #ifdef SOCK_CLOEXEC
  6236. auto sock =
  6237. socket(rp->ai_family, rp->ai_socktype | SOCK_CLOEXEC, rp->ai_protocol);
  6238. #else
  6239. auto sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6240. #endif
  6241. #endif
  6242. if (sock == INVALID_SOCKET) { continue; }
  6243. #if !defined _WIN32 && !defined SOCK_CLOEXEC
  6244. if (fcntl(sock, F_SETFD, FD_CLOEXEC) == -1) {
  6245. close_socket(sock);
  6246. continue;
  6247. }
  6248. #endif
  6249. if (tcp_nodelay) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  6250. if (rp->ai_family == AF_INET6) {
  6251. set_socket_opt(sock, IPPROTO_IPV6, IPV6_V6ONLY, ipv6_v6only ? 1 : 0);
  6252. }
  6253. if (socket_options) { socket_options(sock); }
  6254. // bind or connect
  6255. auto quit = false;
  6256. if (bind_or_connect(sock, *rp, quit)) { return sock; }
  6257. close_socket(sock);
  6258. if (quit) { break; }
  6259. }
  6260. return INVALID_SOCKET;
  6261. }
  6262. inline void set_nonblocking(socket_t sock, bool nonblocking) {
  6263. #ifdef _WIN32
  6264. auto flags = nonblocking ? 1UL : 0UL;
  6265. ioctlsocket(sock, FIONBIO, &flags);
  6266. #else
  6267. auto flags = fcntl(sock, F_GETFL, 0);
  6268. fcntl(sock, F_SETFL,
  6269. nonblocking ? (flags | O_NONBLOCK) : (flags & (~O_NONBLOCK)));
  6270. #endif
  6271. }
  6272. inline bool is_connection_error() {
  6273. #ifdef _WIN32
  6274. return WSAGetLastError() != WSAEWOULDBLOCK;
  6275. #else
  6276. return errno != EINPROGRESS;
  6277. #endif
  6278. }
  6279. // accept() failed because the process or the network stack is temporarily out
  6280. // of resources. The listening socket is still usable, so back off briefly and
  6281. // try again.
  6282. inline bool is_accept_resource_error() {
  6283. #ifdef _WIN32
  6284. auto err = WSAGetLastError();
  6285. return err == WSAEMFILE || err == WSAENOBUFS;
  6286. #else
  6287. auto err = errno;
  6288. return err == EMFILE || err == ENFILE || err == ENOBUFS || err == ENOMEM;
  6289. #endif
  6290. }
  6291. // accept() failed for a reason that says nothing about the listening socket:
  6292. // the pending connection went away before it could be accepted, or the call
  6293. // was interrupted. Retry immediately. WSAAccept()'s own documentation omits
  6294. // WSAECONNRESET, but the accept() it wraps reports an aborted pending
  6295. // connection that way.
  6296. inline bool is_accept_transient_error() {
  6297. #ifdef _WIN32
  6298. auto err = WSAGetLastError();
  6299. return err == WSAEINTR || err == WSAEWOULDBLOCK || err == WSAECONNRESET ||
  6300. err == WSAECONNABORTED;
  6301. #else
  6302. auto err = errno;
  6303. return err == EINTR || err == EAGAIN || err == EWOULDBLOCK ||
  6304. err == ECONNABORTED;
  6305. #endif
  6306. }
  6307. inline bool bind_ip_address(socket_t sock, const std::string &host) {
  6308. struct addrinfo hints;
  6309. struct addrinfo *result;
  6310. memset(&hints, 0, sizeof(struct addrinfo));
  6311. hints.ai_family = AF_UNSPEC;
  6312. hints.ai_socktype = SOCK_STREAM;
  6313. hints.ai_protocol = 0;
  6314. if (getaddrinfo_with_timeout(host.c_str(), "0", &hints, &result, 0)) {
  6315. return false;
  6316. }
  6317. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6318. auto ret = false;
  6319. for (auto rp = result; rp; rp = rp->ai_next) {
  6320. const auto &ai = *rp;
  6321. if (!::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  6322. ret = true;
  6323. break;
  6324. }
  6325. }
  6326. return ret;
  6327. }
  6328. #if !defined _WIN32 && !defined ANDROID && !defined _AIX && !defined __MVS__
  6329. #define USE_IF2IP
  6330. #endif
  6331. #ifdef USE_IF2IP
  6332. inline std::string if2ip(int address_family, const std::string &ifn) {
  6333. struct ifaddrs *ifap;
  6334. getifaddrs(&ifap);
  6335. auto se = detail::scope_exit([&] { freeifaddrs(ifap); });
  6336. std::string addr_candidate;
  6337. for (auto ifa = ifap; ifa; ifa = ifa->ifa_next) {
  6338. if (ifa->ifa_addr && ifn == ifa->ifa_name &&
  6339. (AF_UNSPEC == address_family ||
  6340. ifa->ifa_addr->sa_family == address_family)) {
  6341. if (ifa->ifa_addr->sa_family == AF_INET) {
  6342. auto sa = reinterpret_cast<struct sockaddr_in *>(ifa->ifa_addr);
  6343. char buf[INET_ADDRSTRLEN];
  6344. if (inet_ntop(AF_INET, &sa->sin_addr, buf, INET_ADDRSTRLEN)) {
  6345. return std::string(buf, INET_ADDRSTRLEN);
  6346. }
  6347. } else if (ifa->ifa_addr->sa_family == AF_INET6) {
  6348. auto sa = reinterpret_cast<struct sockaddr_in6 *>(ifa->ifa_addr);
  6349. if (!IN6_IS_ADDR_LINKLOCAL(&sa->sin6_addr)) {
  6350. char buf[INET6_ADDRSTRLEN] = {};
  6351. if (inet_ntop(AF_INET6, &sa->sin6_addr, buf, INET6_ADDRSTRLEN)) {
  6352. // equivalent to mac's IN6_IS_ADDR_UNIQUE_LOCAL
  6353. auto s6_addr_head = sa->sin6_addr.s6_addr[0];
  6354. if (s6_addr_head == 0xfc || s6_addr_head == 0xfd) {
  6355. addr_candidate = std::string(buf, INET6_ADDRSTRLEN);
  6356. } else {
  6357. return std::string(buf, INET6_ADDRSTRLEN);
  6358. }
  6359. }
  6360. }
  6361. }
  6362. }
  6363. }
  6364. return addr_candidate;
  6365. }
  6366. #endif
  6367. inline socket_t create_client_socket(
  6368. const std::string &host, const std::string &ip, int port,
  6369. int address_family, bool tcp_nodelay, bool ipv6_v6only,
  6370. SocketOptions socket_options, time_t connection_timeout_sec,
  6371. time_t connection_timeout_usec, time_t read_timeout_sec,
  6372. time_t read_timeout_usec, time_t write_timeout_sec,
  6373. time_t write_timeout_usec, const std::string &intf, Error &error) {
  6374. auto sock = create_socket(
  6375. host, ip, port, address_family, 0, tcp_nodelay, ipv6_v6only,
  6376. std::move(socket_options),
  6377. [&](socket_t sock2, struct addrinfo &ai, bool &quit) -> bool {
  6378. if (!intf.empty()) {
  6379. #ifdef USE_IF2IP
  6380. auto ip_from_if = if2ip(address_family, intf);
  6381. if (ip_from_if.empty()) { ip_from_if = intf; }
  6382. if (!bind_ip_address(sock2, ip_from_if)) {
  6383. error = Error::BindIPAddress;
  6384. return false;
  6385. }
  6386. #endif
  6387. }
  6388. set_nonblocking(sock2, true);
  6389. auto ret =
  6390. ::connect(sock2, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen));
  6391. if (ret < 0) {
  6392. if (is_connection_error()) {
  6393. error = Error::Connection;
  6394. return false;
  6395. }
  6396. error = wait_until_socket_is_ready(sock2, connection_timeout_sec,
  6397. connection_timeout_usec);
  6398. if (error != Error::Success) {
  6399. if (error == Error::ConnectionTimeout) { quit = true; }
  6400. return false;
  6401. }
  6402. }
  6403. set_nonblocking(sock2, false);
  6404. set_socket_opt_time(sock2, SOL_SOCKET, SO_RCVTIMEO, read_timeout_sec,
  6405. read_timeout_usec);
  6406. set_socket_opt_time(sock2, SOL_SOCKET, SO_SNDTIMEO, write_timeout_sec,
  6407. write_timeout_usec);
  6408. error = Error::Success;
  6409. return true;
  6410. },
  6411. connection_timeout_sec); // Pass DNS timeout
  6412. if (sock != INVALID_SOCKET) {
  6413. error = Error::Success;
  6414. } else {
  6415. if (error == Error::Success) { error = Error::Connection; }
  6416. }
  6417. return sock;
  6418. }
  6419. inline bool get_ip_and_port(const struct sockaddr_storage &addr,
  6420. socklen_t addr_len, std::string &ip, int &port) {
  6421. if (addr.ss_family == AF_INET) {
  6422. port = ntohs(reinterpret_cast<const struct sockaddr_in *>(&addr)->sin_port);
  6423. } else if (addr.ss_family == AF_INET6) {
  6424. port =
  6425. ntohs(reinterpret_cast<const struct sockaddr_in6 *>(&addr)->sin6_port);
  6426. } else {
  6427. return false;
  6428. }
  6429. std::array<char, NI_MAXHOST> ipstr{};
  6430. if (getnameinfo(reinterpret_cast<const struct sockaddr *>(&addr), addr_len,
  6431. ipstr.data(), static_cast<socklen_t>(ipstr.size()), nullptr,
  6432. 0, NI_NUMERICHOST)) {
  6433. return false;
  6434. }
  6435. ip = ipstr.data();
  6436. return true;
  6437. }
  6438. inline void get_local_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6439. struct sockaddr_storage addr;
  6440. socklen_t addr_len = sizeof(addr);
  6441. if (!getsockname(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6442. &addr_len)) {
  6443. get_ip_and_port(addr, addr_len, ip, port);
  6444. }
  6445. }
  6446. inline void get_remote_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6447. struct sockaddr_storage addr;
  6448. socklen_t addr_len = sizeof(addr);
  6449. if (!getpeername(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6450. &addr_len)) {
  6451. #ifndef _WIN32
  6452. if (addr.ss_family == AF_UNIX) {
  6453. #if defined(__linux__)
  6454. struct ucred ucred;
  6455. socklen_t len = sizeof(ucred);
  6456. if (getsockopt(sock, SOL_SOCKET, SO_PEERCRED, &ucred, &len) == 0) {
  6457. port = ucred.pid;
  6458. }
  6459. #elif defined(SOL_LOCAL) && defined(SO_PEERPID)
  6460. pid_t pid;
  6461. socklen_t len = sizeof(pid);
  6462. if (getsockopt(sock, SOL_LOCAL, SO_PEERPID, &pid, &len) == 0) {
  6463. port = pid;
  6464. }
  6465. #endif
  6466. return;
  6467. }
  6468. #endif
  6469. get_ip_and_port(addr, addr_len, ip, port);
  6470. }
  6471. }
  6472. inline std::string
  6473. find_content_type(const std::string &path,
  6474. const std::map<std::string, std::string> &user_data,
  6475. const std::string &default_content_type) {
  6476. auto ext = file_extension(path);
  6477. // Extensions are matched regardless of case, as web servers do, with an
  6478. // exact match to a user mapping first
  6479. auto lower_ext = case_ignore::to_lower(ext);
  6480. auto it = user_data.find(ext);
  6481. if (it == user_data.end()) { it = user_data.find(lower_ext); }
  6482. if (it != user_data.end()) { return it->second; }
  6483. static const struct {
  6484. const char *ext;
  6485. const char *type;
  6486. } types[] = {
  6487. {"css", "text/css"},
  6488. {"csv", "text/csv"},
  6489. {"htm", "text/html"},
  6490. {"html", "text/html"},
  6491. {"js", "text/javascript"},
  6492. {"mjs", "text/javascript"},
  6493. {"txt", "text/plain"},
  6494. {"vtt", "text/vtt"},
  6495. {"apng", "image/apng"},
  6496. {"avif", "image/avif"},
  6497. {"bmp", "image/bmp"},
  6498. {"gif", "image/gif"},
  6499. {"png", "image/png"},
  6500. {"svg", "image/svg+xml"},
  6501. {"webp", "image/webp"},
  6502. {"ico", "image/x-icon"},
  6503. {"tif", "image/tiff"},
  6504. {"tiff", "image/tiff"},
  6505. {"jpg", "image/jpeg"},
  6506. {"jpeg", "image/jpeg"},
  6507. {"mp4", "video/mp4"},
  6508. {"mpeg", "video/mpeg"},
  6509. {"webm", "video/webm"},
  6510. {"mp3", "audio/mp3"},
  6511. {"mpga", "audio/mpeg"},
  6512. {"weba", "audio/webm"},
  6513. {"wav", "audio/wave"},
  6514. {"otf", "font/otf"},
  6515. {"ttf", "font/ttf"},
  6516. {"woff", "font/woff"},
  6517. {"woff2", "font/woff2"},
  6518. {"7z", "application/x-7z-compressed"},
  6519. {"atom", "application/atom+xml"},
  6520. {"pdf", "application/pdf"},
  6521. {"json", "application/json"},
  6522. {"rss", "application/rss+xml"},
  6523. {"tar", "application/x-tar"},
  6524. {"xht", "application/xhtml+xml"},
  6525. {"xhtml", "application/xhtml+xml"},
  6526. {"xslt", "application/xslt+xml"},
  6527. {"xml", "application/xml"},
  6528. {"gz", "application/gzip"},
  6529. {"zip", "application/zip"},
  6530. {"wasm", "application/wasm"},
  6531. };
  6532. for (const auto &t : types) {
  6533. if (lower_ext == t.ext) { return t.type; }
  6534. }
  6535. return default_content_type;
  6536. }
  6537. inline std::string
  6538. extract_media_type(const std::string &content_type,
  6539. std::map<std::string, std::string> *params = nullptr) {
  6540. // Extract type/subtype from Content-Type value (RFC 2045)
  6541. // e.g. "application/json; charset=utf-8" -> "application/json"
  6542. auto media_type = content_type;
  6543. auto semicolon_pos = media_type.find(';');
  6544. if (semicolon_pos != std::string::npos) {
  6545. auto param_str = media_type.substr(semicolon_pos + 1);
  6546. media_type = media_type.substr(0, semicolon_pos);
  6547. if (params) {
  6548. // Parse parameters: key=value pairs separated by ';'
  6549. split_unquoted(param_str.data(), param_str.data() + param_str.size(), ';',
  6550. [&](const char *b, const char *e) {
  6551. std::string key;
  6552. std::string val;
  6553. divide_param_pair(b, e, key, val);
  6554. // Parameter names are case-insensitive (RFC 9110
  6555. // §5.6.6)
  6556. if (!key.empty()) {
  6557. params->emplace(case_ignore::to_lower(trim_copy(key)),
  6558. unquote_param(val));
  6559. }
  6560. });
  6561. }
  6562. }
  6563. // Trim whitespace from media type
  6564. return trim_copy(media_type);
  6565. }
  6566. inline bool can_compress_content_type(const std::string &content_type) {
  6567. // Media types are case-insensitive (RFC 9110 §8.3.1)
  6568. auto mime_type = case_ignore::to_lower(extract_media_type(content_type));
  6569. static const char *const compressible[] = {
  6570. "image/svg+xml",
  6571. "application/javascript",
  6572. "application/x-javascript",
  6573. "application/json",
  6574. "application/ld+json",
  6575. "application/xml",
  6576. "application/xhtml+xml",
  6577. "application/rss+xml",
  6578. "application/atom+xml",
  6579. "application/xslt+xml",
  6580. "application/protobuf",
  6581. };
  6582. for (auto type : compressible) {
  6583. if (mime_type == type) { return true; }
  6584. }
  6585. return mime_type != "text/event-stream" && !mime_type.rfind("text/", 0);
  6586. }
  6587. inline bool parse_quality(const char *b, const char *e, std::string &token,
  6588. double &quality) {
  6589. quality = 1.0;
  6590. token.clear();
  6591. // Split on first ';': left = token name, right = parameters
  6592. const char *params_b = nullptr;
  6593. std::size_t params_len = 0;
  6594. divide(
  6595. b, static_cast<std::size_t>(e - b), ';',
  6596. [&](const char *lb, std::size_t llen, const char *rb, std::size_t rlen) {
  6597. auto r = trim(lb, lb + llen, 0, llen);
  6598. if (r.first < r.second) { token.assign(lb + r.first, lb + r.second); }
  6599. params_b = rb;
  6600. params_len = rlen;
  6601. });
  6602. if (token.empty()) { return false; }
  6603. if (params_len == 0) { return true; }
  6604. // Scan parameters for q= (stops on first match)
  6605. bool invalid = false;
  6606. split_find(params_b, params_b + params_len, ';',
  6607. (std::numeric_limits<size_t>::max)(),
  6608. [&](const char *pb, const char *pe) -> bool {
  6609. // Match exactly "q=" or "Q=" (not "query=" etc.)
  6610. auto len = static_cast<size_t>(pe - pb);
  6611. if (len < 2) { return false; }
  6612. if ((pb[0] != 'q' && pb[0] != 'Q') || pb[1] != '=') {
  6613. return false;
  6614. }
  6615. // Trim the value portion
  6616. auto r = trim(pb, pe, 2, len);
  6617. if (r.first >= r.second) {
  6618. invalid = true;
  6619. return true;
  6620. }
  6621. double v = 0.0;
  6622. auto res = from_chars(pb + r.first, pb + r.second, v);
  6623. if (res.ec != std::errc{} || res.ptr != pb + r.second ||
  6624. v < 0.0 || v > 1.0) {
  6625. invalid = true;
  6626. return true;
  6627. }
  6628. quality = v;
  6629. return true;
  6630. });
  6631. return !invalid;
  6632. }
  6633. inline EncodingType encoding_type(const Request &req,
  6634. const std::string &content_type) {
  6635. if (!can_compress_content_type(content_type)) { return EncodingType::None; }
  6636. auto s = get_combined_header_value(req.headers, "Accept-Encoding");
  6637. if (s.empty()) { return EncodingType::None; }
  6638. // Single-pass: iterate tokens and track the best supported encoding.
  6639. // Server preference breaks ties (br > gzip > zstd).
  6640. EncodingType best = EncodingType::None;
  6641. double best_q = 0.0; // q=0 means "not acceptable"
  6642. // Server preference: Brotli > Gzip > Zstd (lower = more preferred)
  6643. auto priority = [](EncodingType t) -> int {
  6644. switch (t) {
  6645. case EncodingType::Brotli: return 0;
  6646. case EncodingType::Gzip: return 1;
  6647. case EncodingType::Zstd: return 2;
  6648. default: return 3;
  6649. }
  6650. };
  6651. std::string name;
  6652. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  6653. double quality = 1.0;
  6654. if (!parse_quality(b, e, name, quality)) { return; }
  6655. if (quality <= 0.0) { return; }
  6656. EncodingType type = EncodingType::None;
  6657. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6658. if (case_ignore::equal(name, "br")) { type = EncodingType::Brotli; }
  6659. #endif
  6660. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6661. if (type == EncodingType::None && case_ignore::equal(name, "gzip")) {
  6662. type = EncodingType::Gzip;
  6663. }
  6664. #endif
  6665. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6666. if (type == EncodingType::None && case_ignore::equal(name, "zstd")) {
  6667. type = EncodingType::Zstd;
  6668. }
  6669. #endif
  6670. if (type == EncodingType::None) { return; }
  6671. // Higher q-value wins; for equal q, server preference breaks ties
  6672. if (quality > best_q ||
  6673. (quality == best_q && priority(type) < priority(best))) {
  6674. best_q = quality;
  6675. best = type;
  6676. }
  6677. });
  6678. return best;
  6679. }
  6680. // `content_type` is taken separately because a file-backed response has not
  6681. // been given one yet when its coding has to be decided.
  6682. inline EncodingType encoding_type(const Request &req, const Response &res,
  6683. const std::string &content_type) {
  6684. // The response already names a content coding of its own: a handler serving
  6685. // a body it encoded itself (pre-compressed static assets, say), or a mount
  6686. // point whose headers name the coding its files are stored in. Applying one
  6687. // on top of that would double-encode the body and append a second
  6688. // `Content-Encoding` field line.
  6689. if (res.has_header("Content-Encoding")) { return EncodingType::None; }
  6690. return encoding_type(req, content_type);
  6691. }
  6692. inline EncodingType encoding_type(const Request &req, const Response &res) {
  6693. return encoding_type(req, res, res.get_header_value("Content-Type"));
  6694. }
  6695. inline std::unique_ptr<compressor> make_compressor(EncodingType type) {
  6696. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6697. if (type == EncodingType::Gzip) {
  6698. return detail::make_unique<gzip_compressor>();
  6699. }
  6700. #endif
  6701. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6702. if (type == EncodingType::Brotli) {
  6703. return detail::make_unique<brotli_compressor>();
  6704. }
  6705. #endif
  6706. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6707. if (type == EncodingType::Zstd) {
  6708. return detail::make_unique<zstd_compressor>();
  6709. }
  6710. #endif
  6711. (void)type;
  6712. return nullptr;
  6713. }
  6714. inline const char *encoding_name(EncodingType type) {
  6715. switch (type) {
  6716. case EncodingType::Gzip: return "gzip";
  6717. case EncodingType::Brotli: return "br";
  6718. case EncodingType::Zstd: return "zstd";
  6719. default: return "";
  6720. }
  6721. }
  6722. inline bool nocompressor::compress(const char *data, size_t data_length,
  6723. bool /*last*/, Callback callback) {
  6724. if (!data_length) { return true; }
  6725. return callback(data, data_length);
  6726. }
  6727. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6728. inline gzip_compressor::gzip_compressor() {
  6729. std::memset(&strm_, 0, sizeof(strm_));
  6730. strm_.zalloc = Z_NULL;
  6731. strm_.zfree = Z_NULL;
  6732. strm_.opaque = Z_NULL;
  6733. is_valid_ = deflateInit2(&strm_, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 31, 8,
  6734. Z_DEFAULT_STRATEGY) == Z_OK;
  6735. }
  6736. inline gzip_compressor::~gzip_compressor() { deflateEnd(&strm_); }
  6737. inline bool gzip_compressor::compress(const char *data, size_t data_length,
  6738. bool last, Callback callback) {
  6739. assert(is_valid_);
  6740. do {
  6741. constexpr size_t max_avail_in =
  6742. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6743. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6744. (std::min)(data_length, max_avail_in));
  6745. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6746. data_length -= strm_.avail_in;
  6747. data += strm_.avail_in;
  6748. auto flush = (last && data_length == 0) ? Z_FINISH : Z_NO_FLUSH;
  6749. auto ret = Z_OK;
  6750. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6751. do {
  6752. strm_.avail_out = static_cast<uInt>(buff.size());
  6753. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6754. ret = deflate(&strm_, flush);
  6755. if (ret == Z_STREAM_ERROR) { return false; }
  6756. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6757. return false;
  6758. }
  6759. } while (strm_.avail_out == 0);
  6760. assert((flush == Z_FINISH && ret == Z_STREAM_END) ||
  6761. (flush == Z_NO_FLUSH && ret == Z_OK));
  6762. assert(strm_.avail_in == 0);
  6763. } while (data_length > 0);
  6764. return true;
  6765. }
  6766. inline gzip_decompressor::gzip_decompressor() {
  6767. std::memset(&strm_, 0, sizeof(strm_));
  6768. strm_.zalloc = Z_NULL;
  6769. strm_.zfree = Z_NULL;
  6770. strm_.opaque = Z_NULL;
  6771. // 15 is the value of wbits, which should be at the maximum possible value
  6772. // to ensure that any gzip stream can be decoded. The offset of 32 specifies
  6773. // that the stream type should be automatically detected either gzip or
  6774. // deflate.
  6775. is_valid_ = inflateInit2(&strm_, 32 + 15) == Z_OK;
  6776. }
  6777. inline gzip_decompressor::~gzip_decompressor() { inflateEnd(&strm_); }
  6778. inline bool gzip_decompressor::is_valid() const { return is_valid_; }
  6779. inline bool gzip_decompressor::decompress(const char *data, size_t data_length,
  6780. Callback callback) {
  6781. assert(is_valid_);
  6782. auto ret = Z_OK;
  6783. do {
  6784. constexpr size_t max_avail_in =
  6785. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6786. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6787. (std::min)(data_length, max_avail_in));
  6788. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6789. data_length -= strm_.avail_in;
  6790. data += strm_.avail_in;
  6791. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6792. while (strm_.avail_in > 0 && ret == Z_OK) {
  6793. strm_.avail_out = static_cast<uInt>(buff.size());
  6794. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6795. ret = inflate(&strm_, Z_NO_FLUSH);
  6796. assert(ret != Z_STREAM_ERROR);
  6797. switch (ret) {
  6798. case Z_NEED_DICT:
  6799. case Z_DATA_ERROR:
  6800. case Z_MEM_ERROR: inflateEnd(&strm_); return false;
  6801. }
  6802. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6803. return false;
  6804. }
  6805. }
  6806. if (ret != Z_OK && ret != Z_STREAM_END) { return false; }
  6807. } while (data_length > 0);
  6808. return true;
  6809. }
  6810. #endif
  6811. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6812. inline brotli_compressor::brotli_compressor() {
  6813. state_ = BrotliEncoderCreateInstance(nullptr, nullptr, nullptr);
  6814. }
  6815. inline brotli_compressor::~brotli_compressor() {
  6816. BrotliEncoderDestroyInstance(state_);
  6817. }
  6818. inline bool brotli_compressor::compress(const char *data, size_t data_length,
  6819. bool last, Callback callback) {
  6820. std::array<uint8_t, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6821. auto operation = last ? BROTLI_OPERATION_FINISH : BROTLI_OPERATION_PROCESS;
  6822. auto available_in = data_length;
  6823. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6824. for (;;) {
  6825. if (last) {
  6826. if (BrotliEncoderIsFinished(state_)) { break; }
  6827. } else {
  6828. if (!available_in) { break; }
  6829. }
  6830. auto available_out = buff.size();
  6831. auto next_out = buff.data();
  6832. if (!BrotliEncoderCompressStream(state_, operation, &available_in, &next_in,
  6833. &available_out, &next_out, nullptr)) {
  6834. return false;
  6835. }
  6836. auto output_bytes = buff.size() - available_out;
  6837. if (output_bytes) {
  6838. callback(reinterpret_cast<const char *>(buff.data()), output_bytes);
  6839. }
  6840. }
  6841. return true;
  6842. }
  6843. inline brotli_decompressor::brotli_decompressor() {
  6844. decoder_s = BrotliDecoderCreateInstance(0, 0, 0);
  6845. decoder_r = decoder_s ? BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT
  6846. : BROTLI_DECODER_RESULT_ERROR;
  6847. }
  6848. inline brotli_decompressor::~brotli_decompressor() {
  6849. if (decoder_s) { BrotliDecoderDestroyInstance(decoder_s); }
  6850. }
  6851. inline bool brotli_decompressor::is_valid() const { return decoder_s; }
  6852. inline bool brotli_decompressor::decompress(const char *data,
  6853. size_t data_length,
  6854. Callback callback) {
  6855. if (decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6856. decoder_r == BROTLI_DECODER_RESULT_ERROR) {
  6857. return 0;
  6858. }
  6859. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6860. size_t avail_in = data_length;
  6861. size_t total_out;
  6862. decoder_r = BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT;
  6863. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6864. while (decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT) {
  6865. char *next_out = buff.data();
  6866. size_t avail_out = buff.size();
  6867. decoder_r = BrotliDecoderDecompressStream(
  6868. decoder_s, &avail_in, &next_in, &avail_out,
  6869. reinterpret_cast<uint8_t **>(&next_out), &total_out);
  6870. if (decoder_r == BROTLI_DECODER_RESULT_ERROR) { return false; }
  6871. if (!callback(buff.data(), buff.size() - avail_out)) { return false; }
  6872. }
  6873. return decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6874. decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT;
  6875. }
  6876. #endif
  6877. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6878. inline zstd_compressor::zstd_compressor() {
  6879. ctx_ = ZSTD_createCCtx();
  6880. ZSTD_CCtx_setParameter(ctx_, ZSTD_c_compressionLevel, ZSTD_fast);
  6881. }
  6882. inline zstd_compressor::~zstd_compressor() { ZSTD_freeCCtx(ctx_); }
  6883. inline bool zstd_compressor::compress(const char *data, size_t data_length,
  6884. bool last, Callback callback) {
  6885. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6886. ZSTD_EndDirective mode = last ? ZSTD_e_end : ZSTD_e_continue;
  6887. ZSTD_inBuffer input = {data, data_length, 0};
  6888. bool finished;
  6889. do {
  6890. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6891. size_t const remaining = ZSTD_compressStream2(ctx_, &output, &input, mode);
  6892. if (ZSTD_isError(remaining)) { return false; }
  6893. if (!callback(buff.data(), output.pos)) { return false; }
  6894. finished = last ? (remaining == 0) : (input.pos == input.size);
  6895. } while (!finished);
  6896. return true;
  6897. }
  6898. inline zstd_decompressor::zstd_decompressor() { ctx_ = ZSTD_createDCtx(); }
  6899. inline zstd_decompressor::~zstd_decompressor() { ZSTD_freeDCtx(ctx_); }
  6900. inline bool zstd_decompressor::is_valid() const { return ctx_ != nullptr; }
  6901. inline bool zstd_decompressor::decompress(const char *data, size_t data_length,
  6902. Callback callback) {
  6903. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6904. ZSTD_inBuffer input = {data, data_length, 0};
  6905. while (input.pos < input.size) {
  6906. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6907. size_t const remaining = ZSTD_decompressStream(ctx_, &output, &input);
  6908. if (ZSTD_isError(remaining)) { return false; }
  6909. if (!callback(buff.data(), output.pos)) { return false; }
  6910. }
  6911. return true;
  6912. }
  6913. #endif
  6914. // Content codings are case-insensitive (RFC 9110 8.4.1). Matching them
  6915. // case-sensitively would make a response labeled e.g. "GZIP" look like an
  6916. // unknown coding, and its payload would be handed back still compressed.
  6917. inline bool is_zlib_encoding(const std::string &encoding) {
  6918. return case_ignore::equal(encoding, "gzip") ||
  6919. case_ignore::equal(encoding, "deflate");
  6920. }
  6921. inline bool is_brotli_encoding(const std::string &encoding) {
  6922. return case_ignore::equal(encoding, "br");
  6923. }
  6924. inline bool is_zstd_encoding(const std::string &encoding) {
  6925. return case_ignore::equal(encoding, "zstd");
  6926. }
  6927. // Returns true if the content coding is one cpp-httplib is able to decompress
  6928. // when the corresponding support is compiled in.
  6929. inline bool is_known_content_encoding(const std::string &encoding) {
  6930. return is_zlib_encoding(encoding) || is_brotli_encoding(encoding) ||
  6931. is_zstd_encoding(encoding);
  6932. }
  6933. inline std::unique_ptr<decompressor>
  6934. create_decompressor(const std::string &encoding) {
  6935. std::unique_ptr<decompressor> decompressor;
  6936. if (is_zlib_encoding(encoding)) {
  6937. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6938. decompressor = detail::make_unique<gzip_decompressor>();
  6939. #endif
  6940. } else if (is_brotli_encoding(encoding)) {
  6941. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6942. decompressor = detail::make_unique<brotli_decompressor>();
  6943. #endif
  6944. } else if (is_zstd_encoding(encoding)) {
  6945. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6946. decompressor = detail::make_unique<zstd_decompressor>();
  6947. #endif
  6948. }
  6949. return decompressor;
  6950. }
  6951. // Returns the best available compressor and its Content-Encoding name.
  6952. // Priority: Brotli > Gzip > Zstd (matches server-side preference).
  6953. inline std::pair<std::unique_ptr<compressor>, const char *>
  6954. create_compressor() {
  6955. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6956. return {detail::make_unique<brotli_compressor>(), "br"};
  6957. #elif defined(CPPHTTPLIB_ZLIB_SUPPORT)
  6958. return {detail::make_unique<gzip_compressor>(), "gzip"};
  6959. #elif defined(CPPHTTPLIB_ZSTD_SUPPORT)
  6960. return {detail::make_unique<zstd_compressor>(), "zstd"};
  6961. #else
  6962. return {nullptr, nullptr};
  6963. #endif
  6964. }
  6965. inline bool is_prohibited_header_name(const std::string &name) {
  6966. // Field names are case-insensitive (RFC 9110 §5.1)
  6967. return case_ignore::equal(name, "REMOTE_ADDR") ||
  6968. case_ignore::equal(name, "REMOTE_PORT") ||
  6969. case_ignore::equal(name, "LOCAL_ADDR") ||
  6970. case_ignore::equal(name, "LOCAL_PORT");
  6971. }
  6972. inline bool has_header(const Headers &headers, const std::string &key) {
  6973. if (is_prohibited_header_name(key)) { return false; }
  6974. return headers.find(key) != headers.end();
  6975. }
  6976. inline const char *get_header_value(const Headers &headers,
  6977. const std::string &key, const char *def,
  6978. size_t id) {
  6979. if (is_prohibited_header_name(key)) {
  6980. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  6981. std::string msg = "Prohibited header name '" + key + "' is specified.";
  6982. throw std::invalid_argument(msg);
  6983. #else
  6984. return "";
  6985. #endif
  6986. }
  6987. auto rng = headers.equal_range(key);
  6988. auto it = bounded_next(rng.first, id, rng.second);
  6989. if (it != rng.second) { return it->second.c_str(); }
  6990. return def;
  6991. }
  6992. inline size_t get_header_value_count(const Headers &headers,
  6993. const std::string &key) {
  6994. return headers.count(key);
  6995. }
  6996. // RFC 9110 Section 5.2 and 5.3: a field that is defined as a comma-separated
  6997. // list may be sent as several field lines, and the combined field value is
  6998. // those values joined by commas in the order they were received. Callers that
  6999. // parse such a list must work on the combined value; reading only the first
  7000. // occurrence silently drops whatever the later field lines carry.
  7001. inline std::string get_combined_header_value(const Headers &headers,
  7002. const std::string &key) {
  7003. std::string combined;
  7004. auto rng = headers.equal_range(key);
  7005. for (auto it = rng.first; it != rng.second; ++it) {
  7006. // RFC 9110 Section 5.6.1.2: a recipient has to parse and ignore empty list
  7007. // elements, so an empty field line must not contribute a bare comma to the
  7008. // combined value.
  7009. if (it->second.empty()) { continue; }
  7010. if (!combined.empty()) { combined += ", "; }
  7011. combined += it->second;
  7012. }
  7013. return combined;
  7014. }
  7015. inline bool has_header_token(const Headers &headers, const std::string &key,
  7016. const std::string &token) {
  7017. // RFC 9110 7.6.1: a comma-separated token list field such as Connection may
  7018. // carry several tokens, and RFC 9110 5.3 lets that list be split across
  7019. // several lines. Match complete tokens rather than searching the raw value,
  7020. // so that a value such as "notupgrade" is not read as the token "upgrade".
  7021. auto rng = headers.equal_range(key);
  7022. for (auto it = rng.first; it != rng.second; ++it) {
  7023. const auto &value = it->second;
  7024. if (split_find(value.data(), value.data() + value.size(), ',',
  7025. [&](const char *b, const char *e) {
  7026. return case_ignore::equal(std::string(b, e), token);
  7027. })) {
  7028. return true;
  7029. }
  7030. }
  7031. return false;
  7032. }
  7033. template <typename Map>
  7034. inline typename Map::mapped_type
  7035. get_multimap_value(const Map &m, const std::string &key, size_t id) {
  7036. auto rng = m.equal_range(key);
  7037. auto it = bounded_next(rng.first, id, rng.second);
  7038. if (it != rng.second) { return it->second; }
  7039. return typename Map::mapped_type();
  7040. }
  7041. inline void set_header(Headers &headers, const std::string &key,
  7042. const std::string &val) {
  7043. if (fields::is_field_valid(key, val)) { headers.emplace(key, val); }
  7044. }
  7045. // Drops the fields set_header() would refuse, from headers an application can
  7046. // fill directly: CR/LF in one would split the message.
  7047. inline void erase_invalid_fields(Headers &headers) {
  7048. for (auto it = headers.begin(); it != headers.end();) {
  7049. if (fields::is_field_valid(it->first, it->second)) {
  7050. ++it;
  7051. } else {
  7052. it = headers.erase(it);
  7053. }
  7054. }
  7055. }
  7056. inline bool read_headers(Stream &strm, Headers &headers) {
  7057. const auto bufsiz = 2048;
  7058. char buf[bufsiz];
  7059. stream_line_reader line_reader(strm, buf, bufsiz);
  7060. size_t header_count = 0;
  7061. for (;;) {
  7062. if (!line_reader.getline()) { return false; }
  7063. // Check if the line ends with CRLF.
  7064. auto line_terminator_len = 2;
  7065. if (line_reader.end_with_crlf()) {
  7066. // Blank line indicates end of headers.
  7067. if (line_reader.size() == 2) { break; }
  7068. } else {
  7069. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  7070. // Blank line indicates end of headers.
  7071. if (line_reader.size() == 1) { break; }
  7072. line_terminator_len = 1;
  7073. #else
  7074. continue; // Skip invalid line.
  7075. #endif
  7076. }
  7077. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  7078. // Check header count limit
  7079. if (header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  7080. // Exclude line terminator
  7081. auto end = line_reader.ptr() + line_reader.size() - line_terminator_len;
  7082. if (!parse_header(line_reader.ptr(), end,
  7083. [&](const std::string &key, const std::string &val) {
  7084. headers.emplace(key, val);
  7085. })) {
  7086. return false;
  7087. }
  7088. header_count++;
  7089. }
  7090. // RFC 9110 Section 8.6: Reject requests with multiple Content-Length
  7091. // headers that have different values to prevent request smuggling.
  7092. auto cl_range = headers.equal_range("Content-Length");
  7093. if (cl_range.first != cl_range.second) {
  7094. const auto &first_val = cl_range.first->second;
  7095. for (auto it = std::next(cl_range.first); it != cl_range.second; ++it) {
  7096. if (it->second != first_val) { return false; }
  7097. }
  7098. }
  7099. return true;
  7100. }
  7101. // Parsed by hand: std::regex_match recurses once per character of the reason
  7102. // phrase, which a server can make as long as a whole line.
  7103. inline bool parse_status_line(const char *line, std::string &version,
  7104. int &status, std::string &reason) {
  7105. if (std::strncmp(line, "HTTP/1.", 7) != 0 ||
  7106. (line[7] != '0' && line[7] != '1') || line[8] != ' ' ||
  7107. !is_ascii_digit(line[9]) || !is_ascii_digit(line[10]) ||
  7108. !is_ascii_digit(line[11])) {
  7109. return false;
  7110. }
  7111. auto p = line + 12;
  7112. auto reason_begin = p;
  7113. if (*p == ' ') {
  7114. reason_begin = ++p;
  7115. p += std::strcspn(p, "\r\n");
  7116. }
  7117. auto reason_end = p;
  7118. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  7119. if (*p == '\r') { p++; }
  7120. #else
  7121. if (*p++ != '\r') { return false; }
  7122. #endif
  7123. if (*p++ != '\n' || *p != '\0') { return false; }
  7124. version.assign(line, 8);
  7125. status = (line[9] - '0') * 100 + (line[10] - '0') * 10 + (line[11] - '0');
  7126. reason.assign(reason_begin, reason_end);
  7127. return true;
  7128. }
  7129. // Everything WebSocketClient::connect() reports about the upgrade exchange.
  7130. // status stays -1 until a status line is parsed, mirroring stream::Result.
  7131. struct WebSocketUpgradeResponse {
  7132. Error error = Error::Success;
  7133. int status = -1;
  7134. Headers headers;
  7135. std::string selected_subprotocol;
  7136. };
  7137. // Reads a response's status line and headers, leaving any body unread. An
  7138. // unparsable status line is no stream error; it just leaves `status` as is.
  7139. inline bool read_response_head(Stream &strm, int &status, Headers &headers) {
  7140. const auto bufsiz = 2048;
  7141. char buf[bufsiz];
  7142. stream_line_reader line_reader(strm, buf, bufsiz);
  7143. if (!line_reader.getline()) { return false; }
  7144. std::string version;
  7145. std::string reason;
  7146. if (!parse_status_line(line_reader.ptr(), version, status, reason)) {
  7147. return true;
  7148. }
  7149. return read_headers(strm, headers);
  7150. }
  7151. inline bool
  7152. read_websocket_upgrade_response(Stream &strm,
  7153. const std::string &expected_accept,
  7154. const std::string &offered_subprotocols,
  7155. WebSocketUpgradeResponse &upgrade) {
  7156. // The headers of a rejection are kept so the caller can see why the server
  7157. // refused the upgrade.
  7158. if (!read_response_head(strm, upgrade.status, upgrade.headers)) {
  7159. upgrade.error = Error::Read;
  7160. return false;
  7161. }
  7162. const auto &headers = upgrade.headers;
  7163. if (upgrade.status != StatusCode::SwitchingProtocol_101) {
  7164. upgrade.error = Error::WebSocketHandshake;
  7165. return false;
  7166. }
  7167. // Verify Upgrade: websocket (a comma-separated list, matched per token)
  7168. if (!has_header_token(headers, "Upgrade", "websocket")) {
  7169. upgrade.error = Error::WebSocketHandshake;
  7170. return false;
  7171. }
  7172. // Verify Connection: Upgrade
  7173. if (!has_header_token(headers, "Connection", "upgrade")) {
  7174. upgrade.error = Error::WebSocketHandshake;
  7175. return false;
  7176. }
  7177. // Verify Sec-WebSocket-Accept header value
  7178. auto it = headers.find("Sec-WebSocket-Accept");
  7179. if (it == headers.end() || it->second != expected_accept) {
  7180. upgrade.error = Error::WebSocketHandshake;
  7181. return false;
  7182. }
  7183. // Extract negotiated subprotocol
  7184. auto proto_it = headers.find("Sec-WebSocket-Protocol");
  7185. if (proto_it != headers.end()) {
  7186. upgrade.selected_subprotocol = proto_it->second;
  7187. }
  7188. // Verify the subprotocol is one the client offered (RFC 6455 4.1)
  7189. if (!upgrade.selected_subprotocol.empty()) {
  7190. auto was_offered = false;
  7191. split(offered_subprotocols.data(),
  7192. offered_subprotocols.data() + offered_subprotocols.size(), ',',
  7193. [&](const char *b, const char *e) {
  7194. if (std::string(b, e) == upgrade.selected_subprotocol) {
  7195. was_offered = true;
  7196. }
  7197. });
  7198. if (!was_offered) {
  7199. upgrade.error = Error::WebSocketHandshake;
  7200. return false;
  7201. }
  7202. }
  7203. return true;
  7204. }
  7205. enum class ReadContentResult {
  7206. Success, // Successfully read the content
  7207. PayloadTooLarge, // The content exceeds the specified payload limit
  7208. Error // An error occurred while reading the content
  7209. };
  7210. inline ReadContentResult read_content_with_length(
  7211. Stream &strm, size_t len, DownloadProgress progress,
  7212. ContentReceiverWithProgress out,
  7213. size_t payload_max_length = (std::numeric_limits<size_t>::max)()) {
  7214. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7215. detail::BodyReader br;
  7216. br.stream = &strm;
  7217. br.has_content_length = true;
  7218. br.content_length = len;
  7219. br.payload_max_length = payload_max_length;
  7220. br.chunked = false;
  7221. br.bytes_read = 0;
  7222. br.last_error = Error::Success;
  7223. size_t r = 0;
  7224. while (r < len) {
  7225. auto read_len = static_cast<size_t>(len - r);
  7226. auto to_read = (std::min)(read_len, CPPHTTPLIB_RECV_BUFSIZ);
  7227. auto n = detail::read_body_content(&strm, br, buf, to_read);
  7228. if (n <= 0) {
  7229. // Check if it was a payload size error
  7230. if (br.last_error == Error::ExceedMaxPayloadSize) {
  7231. return ReadContentResult::PayloadTooLarge;
  7232. }
  7233. return ReadContentResult::Error;
  7234. }
  7235. if (!out(buf, static_cast<size_t>(n), r, len)) {
  7236. return ReadContentResult::Error;
  7237. }
  7238. r += static_cast<size_t>(n);
  7239. if (progress) {
  7240. if (!progress(r, len)) { return ReadContentResult::Error; }
  7241. }
  7242. }
  7243. return ReadContentResult::Success;
  7244. }
  7245. inline ReadContentResult
  7246. read_content_without_length(Stream &strm, size_t payload_max_length,
  7247. ContentReceiverWithProgress out) {
  7248. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7249. size_t r = 0;
  7250. for (;;) {
  7251. auto n = strm.read(buf, CPPHTTPLIB_RECV_BUFSIZ);
  7252. if (n == 0) { return ReadContentResult::Success; }
  7253. if (n < 0) { return ReadContentResult::Error; }
  7254. // Check if adding this data would exceed the payload limit
  7255. if (payload_max_length > 0 &&
  7256. (r > payload_max_length ||
  7257. payload_max_length - r < static_cast<size_t>(n))) {
  7258. return ReadContentResult::PayloadTooLarge;
  7259. }
  7260. if (!out(buf, static_cast<size_t>(n), r, 0)) {
  7261. return ReadContentResult::Error;
  7262. }
  7263. r += static_cast<size_t>(n);
  7264. }
  7265. return ReadContentResult::Success;
  7266. }
  7267. template <typename T>
  7268. inline ReadContentResult read_content_chunked(Stream &strm, T &x,
  7269. size_t payload_max_length,
  7270. ContentReceiverWithProgress out) {
  7271. detail::ChunkedDecoder dec(strm);
  7272. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7273. size_t total_len = 0;
  7274. for (;;) {
  7275. size_t chunk_offset = 0;
  7276. size_t chunk_total = 0;
  7277. auto n = dec.read_payload(buf, sizeof(buf), chunk_offset, chunk_total);
  7278. if (n < 0) { return ReadContentResult::Error; }
  7279. if (n == 0) {
  7280. if (!dec.parse_trailers_into(x.trailers, x.headers)) {
  7281. return ReadContentResult::Error;
  7282. }
  7283. return ReadContentResult::Success;
  7284. }
  7285. if (payload_max_length > 0 &&
  7286. (total_len > payload_max_length ||
  7287. payload_max_length - total_len < static_cast<size_t>(n))) {
  7288. return ReadContentResult::PayloadTooLarge;
  7289. }
  7290. if (!out(buf, static_cast<size_t>(n), chunk_offset, chunk_total)) {
  7291. return ReadContentResult::Error;
  7292. }
  7293. total_len += static_cast<size_t>(n);
  7294. }
  7295. }
  7296. inline bool is_chunked_transfer_encoding(const Headers &headers) {
  7297. // RFC 9112 6.1: a message is framed with the chunked coding when "chunked"
  7298. // is the final transfer coding. A single field value may list several
  7299. // codings ("gzip, chunked"), and RFC 9110 5.3 lets that list be split across
  7300. // several Transfer-Encoding lines, which combine into one comma-separated
  7301. // list in the order the lines were received. Headers preserves that order,
  7302. // so the final coding is the last token of the last line. Match it
  7303. // case-insensitively rather than comparing the whole value against
  7304. // "chunked".
  7305. //
  7306. // Security: reading a chunked message as unframed leaves its body in the
  7307. // socket, where a keep-alive connection parses it as a smuggled request.
  7308. // Server::process_request() answers 400 and closes when the final coding is
  7309. // not chunked, so a request whose framing cannot be determined never
  7310. // reaches the "no body" path.
  7311. auto rng = headers.equal_range("Transfer-Encoding");
  7312. if (rng.first == rng.second) { return false; }
  7313. // Cleared per line, so a trailing line carrying no coding at all leaves the
  7314. // combined list ending in nothing rather than inheriting the line before it.
  7315. std::string last_coding;
  7316. for (auto it = rng.first; it != rng.second; ++it) {
  7317. const auto &value = it->second;
  7318. last_coding.clear();
  7319. split(value.data(), value.data() + value.size(), ',',
  7320. [&](const char *b, const char *e) { last_coding.assign(b, e); });
  7321. }
  7322. return case_ignore::equal(last_coding, "chunked");
  7323. }
  7324. // RFC 9112 6.1: a message framed by Transfer-Encoding next to a Content-Length,
  7325. // or in HTTP/1.0, leaves the connection unfit to carry another one.
  7326. template <typename T> inline bool has_faulty_transfer_encoding(const T &msg) {
  7327. return msg.has_header("Transfer-Encoding") &&
  7328. (msg.has_header("Content-Length") || msg.version == "HTTP/1.0");
  7329. }
  7330. inline bool has_conflicting_content_length(const Headers &headers) {
  7331. // RFC 9112 §6.3: a message carrying both Transfer-Encoding and a non-zero
  7332. // Content-Length is framed ambiguously. The body readers here delimit it by
  7333. // the transfer coding and drop Content-Length, while an intermediary may do
  7334. // the reverse, so the two disagree on where the body ends and a reused
  7335. // connection is desynchronised (request/response smuggling). Content-Length:
  7336. // 0 is tolerated for compatibility with existing peers.
  7337. return has_header(headers, "Transfer-Encoding") &&
  7338. get_header_value_u64(headers, "Content-Length", 0, 0) > 0;
  7339. }
  7340. template <typename T, typename U>
  7341. bool prepare_content_receiver(T &x, int &status,
  7342. ContentReceiverWithProgress receiver,
  7343. bool decompress, size_t payload_max_length,
  7344. bool &exceed_payload_max_length, U callback) {
  7345. if (decompress) {
  7346. auto encoding = get_combined_header_value(x.headers, "Content-Encoding");
  7347. std::unique_ptr<decompressor> decompressor;
  7348. if (!encoding.empty()) {
  7349. // A coding we know about but were not built with is an error. An
  7350. // unrecognized coding (including "identity") is left alone and the
  7351. // payload is passed through as-is, since some servers misuse the header,
  7352. // e.g. by sending a character set such as "Content-Encoding: UTF-8".
  7353. decompressor = detail::create_decompressor(encoding);
  7354. if (!decompressor && detail::is_known_content_encoding(encoding)) {
  7355. status = StatusCode::UnsupportedMediaType_415;
  7356. return false;
  7357. }
  7358. }
  7359. if (decompressor) {
  7360. if (decompressor->is_valid()) {
  7361. size_t decompressed_size = 0;
  7362. ContentReceiverWithProgress out = [&](const char *buf, size_t n,
  7363. size_t off, size_t len) {
  7364. return decompressor->decompress(
  7365. buf, n, [&](const char *buf2, size_t n2) {
  7366. // Guard against zip-bomb: check
  7367. // decompressed size against limit.
  7368. if (payload_max_length > 0 &&
  7369. (decompressed_size >= payload_max_length ||
  7370. n2 > payload_max_length - decompressed_size)) {
  7371. exceed_payload_max_length = true;
  7372. return false;
  7373. }
  7374. decompressed_size += n2;
  7375. return receiver(buf2, n2, off, len);
  7376. });
  7377. };
  7378. return callback(std::move(out));
  7379. } else {
  7380. status = StatusCode::InternalServerError_500;
  7381. return false;
  7382. }
  7383. }
  7384. }
  7385. ContentReceiverWithProgress out = [&](const char *buf, size_t n, size_t off,
  7386. size_t len) {
  7387. return receiver(buf, n, off, len);
  7388. };
  7389. return callback(std::move(out));
  7390. }
  7391. template <typename T>
  7392. bool read_content(Stream &strm, T &x, size_t payload_max_length, int &status,
  7393. DownloadProgress progress,
  7394. ContentReceiverWithProgress receiver, bool decompress) {
  7395. bool exceed_payload_max_length = false;
  7396. return prepare_content_receiver(
  7397. x, status, std::move(receiver), decompress, payload_max_length,
  7398. exceed_payload_max_length, [&](const ContentReceiverWithProgress &out) {
  7399. auto ret = true;
  7400. // Note: exceed_payload_max_length may also be set by the decompressor
  7401. // wrapper in prepare_content_receiver when the decompressed payload
  7402. // size exceeds the limit.
  7403. if (is_chunked_transfer_encoding(x.headers)) {
  7404. auto result = read_content_chunked(strm, x, payload_max_length, out);
  7405. if (result == ReadContentResult::Success) {
  7406. ret = true;
  7407. } else if (result == ReadContentResult::PayloadTooLarge) {
  7408. exceed_payload_max_length = true;
  7409. ret = false;
  7410. } else {
  7411. ret = false;
  7412. }
  7413. } else if (!has_header(x.headers, "Content-Length")) {
  7414. auto result =
  7415. read_content_without_length(strm, payload_max_length, out);
  7416. if (result == ReadContentResult::Success) {
  7417. ret = true;
  7418. } else if (result == ReadContentResult::PayloadTooLarge) {
  7419. exceed_payload_max_length = true;
  7420. ret = false;
  7421. } else {
  7422. ret = false;
  7423. }
  7424. } else {
  7425. auto is_invalid_value = false;
  7426. auto len = get_header_value_u64(x.headers, "Content-Length",
  7427. (std::numeric_limits<size_t>::max)(),
  7428. 0, is_invalid_value);
  7429. if (is_invalid_value) {
  7430. ret = false;
  7431. } else if (len > 0) {
  7432. auto result = read_content_with_length(
  7433. strm, len, std::move(progress), out, payload_max_length);
  7434. ret = (result == ReadContentResult::Success);
  7435. if (result == ReadContentResult::PayloadTooLarge) {
  7436. exceed_payload_max_length = true;
  7437. }
  7438. }
  7439. }
  7440. if (!ret) {
  7441. status = exceed_payload_max_length ? StatusCode::PayloadTooLarge_413
  7442. : StatusCode::BadRequest_400;
  7443. }
  7444. return ret;
  7445. });
  7446. }
  7447. inline ssize_t write_request_line(Stream &strm, const std::string &method,
  7448. const std::string &path) {
  7449. // Neither the method nor the request target may carry CR/LF, SP or other
  7450. // control octets; otherwise a value smuggled into either splits the request
  7451. // line and injects headers or a whole request.
  7452. if (!fields::is_token(method)) { return -1; }
  7453. if (!fields::is_request_target(path)) { return -1; }
  7454. std::string s = method;
  7455. s += ' ';
  7456. s += path;
  7457. s += " HTTP/1.1\r\n";
  7458. return strm.write(s.data(), s.size());
  7459. }
  7460. inline ssize_t write_response_line(Stream &strm, int status) {
  7461. std::string s = "HTTP/1.1 ";
  7462. s += std::to_string(status);
  7463. s += ' ';
  7464. s += httplib::status_message(status);
  7465. s += "\r\n";
  7466. return strm.write(s.data(), s.size());
  7467. }
  7468. inline ssize_t write_headers(Stream &strm, const Headers &headers) {
  7469. ssize_t write_len = 0;
  7470. for (const auto &x : headers) {
  7471. std::string s;
  7472. s = x.first;
  7473. s += ": ";
  7474. s += x.second;
  7475. s += "\r\n";
  7476. auto len = strm.write(s.data(), s.size());
  7477. if (len < 0) { return len; }
  7478. write_len += len;
  7479. }
  7480. auto len = strm.write("\r\n");
  7481. if (len < 0) { return len; }
  7482. write_len += len;
  7483. return write_len;
  7484. }
  7485. inline bool write_data(Stream &strm, const char *d, size_t l) {
  7486. size_t offset = 0;
  7487. while (offset < l) {
  7488. auto length = strm.write(d + offset, l - offset);
  7489. if (length < 0) { return false; }
  7490. offset += static_cast<size_t>(length);
  7491. }
  7492. return true;
  7493. }
  7494. template <typename T>
  7495. inline bool write_content_with_progress(Stream &strm,
  7496. const ContentProvider &content_provider,
  7497. size_t offset, size_t length,
  7498. T is_shutting_down,
  7499. const UploadProgress &upload_progress,
  7500. Error &error) {
  7501. size_t end_offset = offset + length;
  7502. size_t start_offset = offset;
  7503. auto ok = true;
  7504. auto finished = false;
  7505. DataSink data_sink;
  7506. data_sink.write = [&](const char *d, size_t l) -> bool {
  7507. if (ok) {
  7508. // Bytes past `length` would follow the framed body, where the peer reads
  7509. // them as the next message. Write only what fits and fail the rest.
  7510. if (l > end_offset - offset) {
  7511. l = end_offset - offset;
  7512. ok = false;
  7513. }
  7514. if (write_data(strm, d, l)) {
  7515. offset += l;
  7516. if (upload_progress && length > 0) {
  7517. size_t current_written = offset - start_offset;
  7518. if (!upload_progress(current_written, length)) {
  7519. ok = false;
  7520. return false;
  7521. }
  7522. }
  7523. } else {
  7524. ok = false;
  7525. }
  7526. }
  7527. return ok;
  7528. };
  7529. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7530. // The body is framed by `length`, so a provider that reports itself done
  7531. // early has truncated it. Record that and let the short-body check below
  7532. // fail the write, rather than calling the provider again forever.
  7533. data_sink.done = [&]() { finished = true; };
  7534. while (offset < end_offset && !finished && !is_shutting_down()) {
  7535. auto last_offset = offset;
  7536. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7537. error = Error::Write;
  7538. return false;
  7539. } else if (!content_provider(offset, end_offset - offset, data_sink)) {
  7540. error = Error::Canceled;
  7541. return false;
  7542. } else if (!ok) {
  7543. error = Error::Write;
  7544. return false;
  7545. }
  7546. // A provider that reports success without writing anything and without
  7547. // reporting itself done gets handed the same offset and length again on
  7548. // the next pass, so it would spin here for as long as the peer stays
  7549. // connected. Treat making no progress as a short body, like done() early.
  7550. if (!finished && offset == last_offset) {
  7551. error = Error::Write;
  7552. return false;
  7553. }
  7554. }
  7555. if (offset < end_offset) { // done() called early, or is_shutting_down()
  7556. error = Error::Write;
  7557. return false;
  7558. }
  7559. error = Error::Success;
  7560. return true;
  7561. }
  7562. template <typename T>
  7563. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7564. size_t offset, size_t length, T is_shutting_down,
  7565. Error &error) {
  7566. return write_content_with_progress<T>(strm, content_provider, offset, length,
  7567. is_shutting_down, nullptr, error);
  7568. }
  7569. template <typename T>
  7570. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7571. size_t offset, size_t length,
  7572. const T &is_shutting_down) {
  7573. auto error = Error::Success;
  7574. return write_content(strm, content_provider, offset, length, is_shutting_down,
  7575. error);
  7576. }
  7577. template <typename T>
  7578. inline bool
  7579. write_content_without_length(Stream &strm,
  7580. const ContentProvider &content_provider,
  7581. const T &is_shutting_down) {
  7582. size_t offset = 0;
  7583. auto data_available = true;
  7584. auto ok = true;
  7585. DataSink data_sink;
  7586. data_sink.write = [&](const char *d, size_t l) -> bool {
  7587. if (ok) {
  7588. offset += l;
  7589. if (!write_data(strm, d, l)) { ok = false; }
  7590. }
  7591. return ok;
  7592. };
  7593. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7594. data_sink.done = [&](void) { data_available = false; };
  7595. while (data_available && !is_shutting_down()) {
  7596. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7597. return false;
  7598. } else if (!content_provider(offset, 0, data_sink)) {
  7599. return false;
  7600. } else if (!ok) {
  7601. return false;
  7602. }
  7603. }
  7604. return !data_available; // true only if done() was called, false if shutting
  7605. // down
  7606. }
  7607. // Runs a known-length content provider to completion and compresses what it
  7608. // writes into `out`, chunk by chunk, without holding the identity form.
  7609. inline bool compress_content_provider(const ContentProvider &content_provider,
  7610. size_t length, compressor &cmp,
  7611. std::string &out) {
  7612. size_t offset = 0;
  7613. auto ok = true;
  7614. auto finished = false;
  7615. DataSink data_sink;
  7616. auto append = [&](const char *data, size_t data_len) {
  7617. out.append(data, data_len);
  7618. return true;
  7619. };
  7620. data_sink.write = [&](const char *d, size_t l) -> bool {
  7621. if (!ok) { return false; }
  7622. offset += l;
  7623. if (l > 0 && !cmp.compress(d, l, false, append)) { ok = false; }
  7624. return ok;
  7625. };
  7626. // The body is framed by `length`, so a provider that reports itself done
  7627. // early has truncated it; the short-body check below turns that into a
  7628. // failure rather than calling the provider again forever.
  7629. data_sink.done = [&]() { finished = true; };
  7630. while (offset < length && !finished) {
  7631. auto prev_offset = offset;
  7632. if (!content_provider(offset, length - offset, data_sink) || !ok) {
  7633. return false;
  7634. }
  7635. // No Stream to block on here, so a provider that keeps returning true
  7636. // without writing would spin. Treat a pass that made no progress as a
  7637. // failure.
  7638. if (offset == prev_offset) { return false; }
  7639. }
  7640. if (offset != length) { return false; }
  7641. return cmp.compress(nullptr, 0, true, append);
  7642. }
  7643. // Serves `m` as the response body. `set_content_provider()` clears the coding
  7644. // and the file flag, so recording them has to come after; keeping all of it
  7645. // here means a third file-serving path cannot get that order wrong.
  7646. inline void set_file_content_provider(Response &res,
  7647. const std::shared_ptr<mmap> &m,
  7648. const std::string &content_type,
  7649. EncodingType encoding) {
  7650. // One read and one write move up to this much of the file at a time.
  7651. auto buf = std::make_shared<std::vector<char>>(
  7652. (std::min)(m->size(), size_t(256 * 1024)));
  7653. res.set_content_provider(
  7654. m->size(), content_type,
  7655. [m, buf](size_t offset, size_t length, DataSink &sink) -> bool {
  7656. // Never read past the file, which ends the response early if it has
  7657. // shrunk since it was opened.
  7658. auto n = m->read(offset, buf->data(), (std::min)(length, buf->size()));
  7659. if (n == 0) { return false; }
  7660. sink.write(buf->data(), n);
  7661. return true;
  7662. });
  7663. res.is_file_content_provider_ = true;
  7664. res.content_coding_ = encoding;
  7665. }
  7666. template <typename T, typename U>
  7667. inline bool
  7668. write_content_chunked(Stream &strm, const ContentProvider &content_provider,
  7669. const T &is_shutting_down, U &compressor, Error &error) {
  7670. size_t offset = 0;
  7671. auto data_available = true;
  7672. auto ok = true;
  7673. DataSink data_sink;
  7674. data_sink.write = [&](const char *d, size_t l) -> bool {
  7675. // Only done()/done_with_trailer() end a chunked body. A pass with nothing
  7676. // to hand over is ordinary (an empty buffer popped off a queue), and a
  7677. // zero-length chunk is the terminator, so it must not be emitted here.
  7678. if (ok && l > 0) {
  7679. offset += l;
  7680. std::string payload;
  7681. if (compressor.compress(d, l, false,
  7682. [&](const char *data, size_t data_len) {
  7683. payload.append(data, data_len);
  7684. return true;
  7685. })) {
  7686. if (!payload.empty()) {
  7687. // Emit chunked response header and footer for each chunk
  7688. auto chunk =
  7689. from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7690. if (!write_data(strm, chunk.data(), chunk.size())) { ok = false; }
  7691. }
  7692. } else {
  7693. ok = false;
  7694. }
  7695. }
  7696. return ok;
  7697. };
  7698. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7699. auto done_with_trailer = [&](const Headers *trailer) {
  7700. if (!ok) { return; }
  7701. data_available = false;
  7702. std::string payload;
  7703. if (!compressor.compress(nullptr, 0, true,
  7704. [&](const char *data, size_t data_len) {
  7705. payload.append(data, data_len);
  7706. return true;
  7707. })) {
  7708. ok = false;
  7709. return;
  7710. }
  7711. if (!payload.empty()) {
  7712. // Emit chunked response header and footer for each chunk
  7713. auto chunk = from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7714. if (!write_data(strm, chunk.data(), chunk.size())) {
  7715. ok = false;
  7716. return;
  7717. }
  7718. }
  7719. constexpr const char done_marker[] = "0\r\n";
  7720. if (!write_data(strm, done_marker, str_len(done_marker))) { ok = false; }
  7721. // Trailer
  7722. if (trailer) {
  7723. for (const auto &kv : *trailer) {
  7724. // Skip fields with invalid names or values to prevent response
  7725. // splitting via CR/LF injection, matching set_header().
  7726. if (!fields::is_field_valid(kv.first, kv.second)) { continue; }
  7727. std::string field_line = kv.first + ": " + kv.second + "\r\n";
  7728. if (!write_data(strm, field_line.data(), field_line.size())) {
  7729. ok = false;
  7730. }
  7731. }
  7732. }
  7733. constexpr const char crlf[] = "\r\n";
  7734. if (!write_data(strm, crlf, str_len(crlf))) { ok = false; }
  7735. };
  7736. data_sink.done = [&](void) { done_with_trailer(nullptr); };
  7737. data_sink.done_with_trailer = [&](const Headers &trailer) {
  7738. done_with_trailer(&trailer);
  7739. };
  7740. while (data_available && !is_shutting_down()) {
  7741. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7742. error = Error::Write;
  7743. return false;
  7744. } else if (!content_provider(offset, 0, data_sink)) {
  7745. error = Error::Canceled;
  7746. return false;
  7747. } else if (!ok) {
  7748. error = Error::Write;
  7749. return false;
  7750. }
  7751. }
  7752. if (data_available) { // exited due to is_shutting_down(), not done()
  7753. error = Error::Write;
  7754. return false;
  7755. }
  7756. error = Error::Success;
  7757. return true;
  7758. }
  7759. template <typename T, typename U>
  7760. inline bool write_content_chunked(Stream &strm,
  7761. const ContentProvider &content_provider,
  7762. const T &is_shutting_down, U &compressor) {
  7763. auto error = Error::Success;
  7764. return write_content_chunked(strm, content_provider, is_shutting_down,
  7765. compressor, error);
  7766. }
  7767. template <typename T>
  7768. inline bool redirect(T &cli, Request &req, Response &res,
  7769. const std::string &path, const std::string &location,
  7770. Error &error) {
  7771. Request new_req = req;
  7772. new_req.path = path;
  7773. new_req.redirect_count_ -= 1;
  7774. if (res.status == StatusCode::SeeOther_303 &&
  7775. (req.method != "GET" && req.method != "HEAD")) {
  7776. new_req.method = "GET";
  7777. new_req.body.clear();
  7778. new_req.headers.clear();
  7779. new_req.content_length_ = 0;
  7780. new_req.content_provider_ = nullptr;
  7781. new_req.is_chunked_content_provider_ = false;
  7782. }
  7783. Response new_res;
  7784. auto ret = cli.send(new_req, new_res, error);
  7785. if (ret) {
  7786. req = std::move(new_req);
  7787. res = std::move(new_res);
  7788. if (res.location.empty()) { res.location = location; }
  7789. }
  7790. return ret;
  7791. }
  7792. inline std::string params_to_query_str(const Params &params) {
  7793. std::string query;
  7794. for (auto it = params.begin(); it != params.end(); ++it) {
  7795. if (it != params.begin()) { query += '&'; }
  7796. query += encode_query_component(it->first);
  7797. query += '=';
  7798. query += encode_query_component(it->second);
  7799. }
  7800. return query;
  7801. }
  7802. // Splits one "key=value" span of a query string at its first '='. A span with
  7803. // no '=' at all lands entirely in key, leaving val empty, which is how a bare
  7804. // "?flag" keeps its name.
  7805. inline void divide_query_pair(const char *b, const char *e, std::string &key,
  7806. std::string &val) {
  7807. divide(b, static_cast<std::size_t>(e - b), '=',
  7808. [&](const char *lhs_data, std::size_t lhs_size, const char *rhs_data,
  7809. std::size_t rhs_size) {
  7810. key.assign(lhs_data, lhs_size);
  7811. val.assign(rhs_data, rhs_size);
  7812. });
  7813. }
  7814. inline void parse_query_text(const char *data, std::size_t size,
  7815. Params &params) {
  7816. std::set<std::string> cache;
  7817. split(data, data + size, '&', [&](const char *b, const char *e) {
  7818. std::string kv(b, e);
  7819. if (cache.find(kv) != cache.end()) { return; }
  7820. cache.insert(std::move(kv));
  7821. std::string key;
  7822. std::string val;
  7823. divide_query_pair(b, e, key, val);
  7824. if (!key.empty()) {
  7825. params.emplace(decode_query_component(key), decode_query_component(val));
  7826. }
  7827. });
  7828. }
  7829. inline void parse_query_text(const std::string &s, Params &params) {
  7830. parse_query_text(s.data(), s.size(), params);
  7831. }
  7832. // Normalize a query string by decoding and re-encoding each key/value pair
  7833. // while preserving the original parameter order. This avoids double-encoding
  7834. // and ensures consistent encoding. It works on the raw string rather than
  7835. // parsing into Params and re-serializing, because that round trip cannot
  7836. // reproduce the input: params_to_query_str() always emits '=', so a bare
  7837. // "flag" would come back as "flag=", and parse_query_text() drops exactly
  7838. // duplicated pairs.
  7839. inline std::string normalize_query_string(const std::string &query) {
  7840. std::string result;
  7841. split(query.data(), query.data() + query.size(), '&',
  7842. [&](const char *b, const char *e) {
  7843. std::string key;
  7844. std::string val;
  7845. divide_query_pair(b, e, key, val);
  7846. if (!key.empty()) {
  7847. auto dec_key = decode_query_component(key);
  7848. auto dec_val = decode_query_component(val);
  7849. if (!result.empty()) { result += '&'; }
  7850. result += encode_query_component(dec_key);
  7851. if (!val.empty() || std::find(b, e, '=') != e) {
  7852. result += '=';
  7853. result += encode_query_component(dec_val);
  7854. }
  7855. }
  7856. });
  7857. return result;
  7858. }
  7859. // The query of a client's path: what follows '?', up to the fragment.
  7860. inline std::string query_of(const std::string &path) {
  7861. auto fragment_pos = path.find('#');
  7862. auto query_pos = path.find('?');
  7863. return query_pos < fragment_pos
  7864. ? path.substr(query_pos + 1, fragment_pos - query_pos - 1)
  7865. : std::string();
  7866. }
  7867. // Build the request target that goes on the wire from a caller-supplied path.
  7868. // Shared by the buffered send path and the streaming API so that both put the
  7869. // same bytes in the request line for the same input.
  7870. inline std::string encode_request_target(const std::string &uri,
  7871. bool path_encode) {
  7872. // The fragment stays with the client (RFC 9110 §7.1).
  7873. auto target = uri.substr(0, uri.find('#'));
  7874. // `substr(0, npos)` yields the whole string, which is what the no-query
  7875. // case needs.
  7876. auto query_pos = target.find('?');
  7877. auto path_part = target.substr(0, query_pos);
  7878. std::string query_part;
  7879. if (query_pos != std::string::npos) {
  7880. query_part = target.substr(query_pos + 1);
  7881. }
  7882. auto result = path_encode ? encode_path(path_part) : std::move(path_part);
  7883. if (!query_part.empty()) {
  7884. // When path encoding is disabled the caller has supplied an already-encoded
  7885. // target and expects the exact bytes to be sent on the wire, so skip
  7886. // normalization for the query too. Normalizing would decode-then-re-encode
  7887. // it and corrupt pre-encoded binary payloads (e.g. turning `%20` into `+`,
  7888. // which a strict RFC 3986 server decodes back as `+`, not a space).
  7889. if (path_encode) {
  7890. auto normalized = normalize_query_string(query_part);
  7891. if (!normalized.empty()) {
  7892. result += '?';
  7893. result += normalized;
  7894. }
  7895. } else {
  7896. result += '?';
  7897. result += query_part;
  7898. }
  7899. }
  7900. return result;
  7901. }
  7902. inline bool parse_multipart_boundary(const std::string &content_type,
  7903. std::string &boundary) {
  7904. std::map<std::string, std::string> params;
  7905. extract_media_type(content_type, &params);
  7906. auto it = params.find("boundary");
  7907. if (it == params.end()) { return false; }
  7908. boundary = it->second;
  7909. // RFC 2046 5.1.1 caps a boundary at 70 characters. The parser scans the body
  7910. // for "--" + boundary, so a body crafted to repeat that delimiter's leading
  7911. // bytes costs a nearly full comparison at nearly every position: the
  7912. // boundary's length multiplies the worst-case cost of scanning a body.
  7913. return !boundary.empty() && boundary.size() <= 70;
  7914. }
  7915. inline void parse_disposition_params(const std::string &s, Params &params) {
  7916. std::set<std::string> cache;
  7917. split_unquoted(
  7918. s.data(), s.data() + s.size(), ';', [&](const char *b, const char *e) {
  7919. std::string kv(b, e);
  7920. if (cache.find(kv) != cache.end()) { return; }
  7921. cache.insert(kv);
  7922. std::string key;
  7923. std::string val;
  7924. divide_param_pair(b, e, key, val);
  7925. if (!key.empty()) {
  7926. params.emplace(trim_double_quotes_copy(key), unquote_param(val));
  7927. }
  7928. });
  7929. }
  7930. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7931. inline bool parse_range_header(const std::string &s, Ranges &ranges) {
  7932. #else
  7933. inline bool parse_range_header(const std::string &s, Ranges &ranges) try {
  7934. #endif
  7935. auto is_valid = [](const std::string &str) {
  7936. return std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  7937. };
  7938. if (s.size() > 7 && case_ignore::equal(s.substr(0, 6), "bytes=")) {
  7939. const auto pos = static_cast<size_t>(6);
  7940. const auto len = static_cast<size_t>(s.size() - 6);
  7941. auto all_valid_ranges = true;
  7942. split(&s[pos], &s[pos + len], ',', [&](const char *b, const char *e) {
  7943. if (!all_valid_ranges) { return; }
  7944. const auto it = std::find(b, e, '-');
  7945. if (it == e) {
  7946. all_valid_ranges = false;
  7947. return;
  7948. }
  7949. const auto lhs = std::string(b, it);
  7950. const auto rhs = std::string(it + 1, e);
  7951. if (!is_valid(lhs) || !is_valid(rhs)) {
  7952. all_valid_ranges = false;
  7953. return;
  7954. }
  7955. ssize_t first = -1;
  7956. if (!lhs.empty()) {
  7957. // Reject an overflowing first-byte-pos; treating it as absent (-1)
  7958. // would turn the range into a suffix range.
  7959. auto res =
  7960. detail::from_chars(lhs.data(), lhs.data() + lhs.size(), first);
  7961. if (res.ec != std::errc{}) {
  7962. all_valid_ranges = false;
  7963. return;
  7964. }
  7965. }
  7966. ssize_t last = -1;
  7967. if (!rhs.empty()) {
  7968. // An overflowing last-byte-pos is past any content length, so keeping
  7969. // -1 ("remainder", RFC 9110 14.1.2) is correct here.
  7970. ssize_t v;
  7971. auto res = detail::from_chars(rhs.data(), rhs.data() + rhs.size(), v);
  7972. if (res.ec == std::errc{}) { last = v; }
  7973. }
  7974. if ((first == -1 && last == -1) ||
  7975. (first != -1 && last != -1 && first > last)) {
  7976. all_valid_ranges = false;
  7977. return;
  7978. }
  7979. ranges.emplace_back(first, last);
  7980. });
  7981. return all_valid_ranges && !ranges.empty();
  7982. }
  7983. return false;
  7984. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7985. }
  7986. #else
  7987. } catch (...) { return false; }
  7988. #endif
  7989. // Removes each quoted-string, honoring a quoted-pair (RFC 9110 Section 5.6.4)
  7990. inline std::string remove_quoted_strings(const std::string &s) {
  7991. std::string out;
  7992. auto in_quotes = false;
  7993. for (size_t i = 0; i < s.size(); i++) {
  7994. if (s[i] == '"') {
  7995. in_quotes = !in_quotes;
  7996. } else if (!in_quotes) {
  7997. out += s[i];
  7998. } else if (s[i] == '\\') {
  7999. i++;
  8000. }
  8001. }
  8002. return out;
  8003. }
  8004. inline bool parse_accept_header(const std::string &s,
  8005. std::vector<std::string> &content_types) {
  8006. // Parameter values are not used here, so a quoted-string is dropped rather
  8007. // than parsed: a ',' or ';' inside one must not be read as a delimiter.
  8008. if (s.find('"') != std::string::npos) {
  8009. return parse_accept_header(remove_quoted_strings(s), content_types);
  8010. }
  8011. content_types.clear();
  8012. // Empty string is considered valid (no preference)
  8013. if (s.empty()) { return true; }
  8014. struct AcceptEntry {
  8015. std::string media_type;
  8016. double quality;
  8017. int order;
  8018. };
  8019. std::vector<AcceptEntry> entries;
  8020. int order = 0;
  8021. bool has_invalid_entry = false;
  8022. // Split by comma and parse each entry. RFC 9110 Section 5.6.1.2: a recipient
  8023. // has to parse and ignore empty list elements, so a leading, trailing or
  8024. // doubled comma must not turn a legal Accept value into 400 Bad Request.
  8025. // split() skips them, and the header length limit bounds how many a sender
  8026. // can send, so ignoring all of them cannot be used as a denial-of-service
  8027. // vector.
  8028. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  8029. std::string entry(b, e);
  8030. entry = trim_copy(entry);
  8031. AcceptEntry accept_entry;
  8032. accept_entry.order = order++;
  8033. if (!parse_quality(entry.data(), entry.data() + entry.size(),
  8034. accept_entry.media_type, accept_entry.quality)) {
  8035. has_invalid_entry = true;
  8036. return;
  8037. }
  8038. // Remove additional parameters from media type
  8039. accept_entry.media_type = extract_media_type(accept_entry.media_type);
  8040. // Basic validation of media type format
  8041. if (accept_entry.media_type.empty()) {
  8042. has_invalid_entry = true;
  8043. return;
  8044. }
  8045. // Check for basic media type format (should contain '/' or be '*')
  8046. if (accept_entry.media_type != "*" &&
  8047. accept_entry.media_type.find('/') == std::string::npos) {
  8048. has_invalid_entry = true;
  8049. return;
  8050. }
  8051. entries.push_back(std::move(accept_entry));
  8052. });
  8053. // Return false if any invalid entry was found
  8054. if (has_invalid_entry) { return false; }
  8055. // Sort by quality (descending), then by original order (ascending)
  8056. std::sort(entries.begin(), entries.end(),
  8057. [](const AcceptEntry &a, const AcceptEntry &b) {
  8058. if (a.quality != b.quality) {
  8059. return a.quality > b.quality; // Higher quality first
  8060. }
  8061. return a.order < b.order; // Earlier order first for same quality
  8062. });
  8063. // Extract sorted media types
  8064. content_types.reserve(entries.size());
  8065. for (auto &entry : entries) {
  8066. content_types.push_back(std::move(entry.media_type));
  8067. }
  8068. return true;
  8069. }
  8070. class FormDataParser {
  8071. public:
  8072. FormDataParser() = default;
  8073. void set_boundary(std::string &&boundary) {
  8074. boundary_ = std::move(boundary);
  8075. dash_boundary_crlf_ = dash_ + boundary_ + crlf_;
  8076. crlf_dash_boundary_ = crlf_ + dash_ + boundary_;
  8077. }
  8078. bool is_valid() const { return is_valid_; }
  8079. bool parse(const char *buf, size_t n, const FormDataHeader &header_callback,
  8080. const ContentReceiver &content_callback) {
  8081. // Once the close delimiter has been seen the rest of the body is epilogue
  8082. // to be discarded (RFC 2046). Drop it without buffering so a large epilogue
  8083. // spread across reads is not copied in only to be erased right away.
  8084. if (state_ == 5) { return true; }
  8085. buf_append(buf, n);
  8086. while (buf_size() > 0) {
  8087. switch (state_) {
  8088. case 0: { // Initial boundary
  8089. auto pos = buf_find(dash_boundary_crlf_);
  8090. if (pos == buf_size()) {
  8091. // Not found yet: keep only a possible partial boundary at the tail so
  8092. // that a body which never contains the boundary cannot grow the
  8093. // buffer (and get rescanned from the start) without bound.
  8094. auto keep = dash_boundary_crlf_.size() - 1;
  8095. if (buf_size() > keep) { buf_erase(buf_size() - keep); }
  8096. return true;
  8097. }
  8098. buf_erase(pos + dash_boundary_crlf_.size());
  8099. state_ = 1;
  8100. break;
  8101. }
  8102. case 1: { // New entry
  8103. clear_file_info();
  8104. header_searched_ = 0;
  8105. state_ = 2;
  8106. break;
  8107. }
  8108. case 2: { // Headers
  8109. // Resume where the last call stopped looking, so that a line arriving
  8110. // a few bytes at a time is not searched from its start each time.
  8111. auto pos = buf_find(crlf_, header_searched_);
  8112. if (pos > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  8113. while (pos < buf_size()) {
  8114. // Empty line
  8115. if (pos == 0) {
  8116. if (!header_callback(file_)) {
  8117. is_valid_ = false;
  8118. return false;
  8119. }
  8120. buf_erase(crlf_.size());
  8121. state_ = 3;
  8122. break;
  8123. }
  8124. // Check header count limit
  8125. if (header_count_ >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  8126. is_valid_ = false;
  8127. return false;
  8128. }
  8129. header_count_++;
  8130. const auto header = buf_head(pos);
  8131. if (!parse_header(header.data(), header.data() + header.size(),
  8132. [&](const std::string &, const std::string &) {})) {
  8133. is_valid_ = false;
  8134. return false;
  8135. }
  8136. // Parse and emplace space trimmed headers into a map
  8137. if (!parse_header(
  8138. header.data(), header.data() + header.size(),
  8139. [&](const std::string &key, const std::string &val) {
  8140. file_.headers.emplace(key, val);
  8141. })) {
  8142. is_valid_ = false;
  8143. return false;
  8144. }
  8145. constexpr const char header_content_type[] = "Content-Type:";
  8146. if (start_with_case_ignore(header, header_content_type)) {
  8147. file_.content_type =
  8148. trim_copy(header.substr(str_len(header_content_type)));
  8149. } else {
  8150. std::string disposition_params;
  8151. if (parse_content_disposition(header, disposition_params)) {
  8152. Params params;
  8153. parse_disposition_params(disposition_params, params);
  8154. auto it = params.find("name");
  8155. if (it != params.end()) {
  8156. file_.name = it->second;
  8157. } else {
  8158. is_valid_ = false;
  8159. return false;
  8160. }
  8161. it = params.find("filename");
  8162. if (it != params.end()) { file_.filename = it->second; }
  8163. it = params.find("filename*");
  8164. if (it != params.end()) {
  8165. // RFC 5987: only UTF-8 encoding is allowed
  8166. const auto &val = it->second;
  8167. constexpr const char utf8_prefix[] = "UTF-8''";
  8168. constexpr size_t prefix_len = str_len(utf8_prefix);
  8169. if (val.size() > prefix_len &&
  8170. start_with_case_ignore(val, utf8_prefix)) {
  8171. file_.filename = decode_path_component(
  8172. val.substr(prefix_len)); // override...
  8173. } else {
  8174. is_valid_ = false;
  8175. return false;
  8176. }
  8177. }
  8178. }
  8179. }
  8180. buf_erase(pos + crlf_.size());
  8181. pos = buf_find(crlf_);
  8182. }
  8183. if (state_ != 3) {
  8184. // The CR of the CRLF may be the last byte so far.
  8185. header_searched_ = buf_size() > 0 ? buf_size() - 1 : 0;
  8186. return true;
  8187. }
  8188. break;
  8189. }
  8190. case 3: { // Body
  8191. if (crlf_dash_boundary_.size() > buf_size()) { return true; }
  8192. auto pos = buf_find(crlf_dash_boundary_);
  8193. if (pos < buf_size()) {
  8194. if (!content_callback(buf_data(), pos)) {
  8195. is_valid_ = false;
  8196. return false;
  8197. }
  8198. buf_erase(pos + crlf_dash_boundary_.size());
  8199. state_ = 4;
  8200. } else {
  8201. auto len = buf_size() - crlf_dash_boundary_.size();
  8202. if (len > 0) {
  8203. if (!content_callback(buf_data(), len)) {
  8204. is_valid_ = false;
  8205. return false;
  8206. }
  8207. buf_erase(len);
  8208. }
  8209. return true;
  8210. }
  8211. break;
  8212. }
  8213. case 4: { // Boundary
  8214. if (crlf_.size() > buf_size()) { return true; }
  8215. if (buf_start_with(crlf_)) {
  8216. buf_erase(crlf_.size());
  8217. state_ = 1;
  8218. } else if (buf_start_with(dash_)) {
  8219. buf_erase(dash_.size());
  8220. is_valid_ = true;
  8221. state_ = 5;
  8222. } else {
  8223. // Only CRLF (another part follows) and "--" (close-delimiter) are
  8224. // accepted after a boundary; RFC 2046 allows transport-padding in
  8225. // between, but this parser has never supported it. Either way the
  8226. // body is already destined to be rejected, so fail now instead of
  8227. // buffering the rest of it. Both are two bytes, so the check above
  8228. // already guarantees enough buffered data to decide.
  8229. is_valid_ = false;
  8230. return false;
  8231. }
  8232. break;
  8233. }
  8234. case 5: { // Epilogue
  8235. buf_erase(buf_size());
  8236. break;
  8237. }
  8238. }
  8239. }
  8240. return true;
  8241. }
  8242. private:
  8243. void clear_file_info() {
  8244. file_.name.clear();
  8245. file_.filename.clear();
  8246. file_.content_type.clear();
  8247. file_.headers.clear();
  8248. header_count_ = 0;
  8249. }
  8250. bool start_with_case_ignore(const std::string &a, const char *b,
  8251. size_t offset = 0) const {
  8252. const auto b_len = strlen(b);
  8253. if (a.size() < offset + b_len) { return false; }
  8254. for (size_t i = 0; i < b_len; i++) {
  8255. if (case_ignore::to_lower(a[offset + i]) != case_ignore::to_lower(b[i])) {
  8256. return false;
  8257. }
  8258. }
  8259. return true;
  8260. }
  8261. // Parses "Content-Disposition: form-data; <params>" without std::regex.
  8262. // Returns true if header matches, with the params portion in `params_out`.
  8263. bool parse_content_disposition(const std::string &header,
  8264. std::string &params_out) const {
  8265. constexpr const char prefix[] = "Content-Disposition:";
  8266. constexpr size_t prefix_len = str_len(prefix);
  8267. if (!start_with_case_ignore(header, prefix)) { return false; }
  8268. // Skip whitespace after "Content-Disposition:"
  8269. auto pos = prefix_len;
  8270. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8271. pos++;
  8272. }
  8273. // Match "form-data;" (case-insensitive)
  8274. constexpr const char form_data[] = "form-data;";
  8275. constexpr size_t form_data_len = str_len(form_data);
  8276. if (!start_with_case_ignore(header, form_data, pos)) { return false; }
  8277. pos += form_data_len;
  8278. // Skip whitespace after "form-data;"
  8279. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8280. pos++;
  8281. }
  8282. params_out = header.substr(pos);
  8283. return true;
  8284. }
  8285. const std::string dash_ = "--";
  8286. const std::string crlf_ = "\r\n";
  8287. std::string boundary_;
  8288. std::string dash_boundary_crlf_;
  8289. std::string crlf_dash_boundary_;
  8290. size_t state_ = 0;
  8291. bool is_valid_ = false;
  8292. FormData file_;
  8293. size_t header_count_ = 0;
  8294. size_t header_searched_ = 0;
  8295. // Buffer
  8296. bool start_with(const std::string &a, size_t spos, size_t epos,
  8297. const std::string &b) const {
  8298. if (epos - spos < b.size()) { return false; }
  8299. for (size_t i = 0; i < b.size(); i++) {
  8300. if (a[i + spos] != b[i]) { return false; }
  8301. }
  8302. return true;
  8303. }
  8304. size_t buf_size() const { return buf_epos_ - buf_spos_; }
  8305. const char *buf_data() const { return &buf_[buf_spos_]; }
  8306. std::string buf_head(size_t l) const { return buf_.substr(buf_spos_, l); }
  8307. bool buf_start_with(const std::string &s) const {
  8308. return start_with(buf_, buf_spos_, buf_epos_, s);
  8309. }
  8310. size_t buf_find(const std::string &s, size_t from = 0) const {
  8311. auto c = s.front();
  8312. size_t off = buf_spos_ + from;
  8313. while (off < buf_epos_) {
  8314. auto pos = off;
  8315. while (true) {
  8316. if (pos == buf_epos_) { return buf_size(); }
  8317. if (buf_[pos] == c) { break; }
  8318. pos++;
  8319. }
  8320. auto remaining_size = buf_epos_ - pos;
  8321. if (s.size() > remaining_size) { return buf_size(); }
  8322. if (start_with(buf_, pos, buf_epos_, s)) { return pos - buf_spos_; }
  8323. off = pos + 1;
  8324. }
  8325. return buf_size();
  8326. }
  8327. void buf_append(const char *data, size_t n) {
  8328. auto remaining_size = buf_size();
  8329. if (remaining_size > 0 && buf_spos_ > 0) {
  8330. for (size_t i = 0; i < remaining_size; i++) {
  8331. buf_[i] = buf_[buf_spos_ + i];
  8332. }
  8333. }
  8334. buf_spos_ = 0;
  8335. buf_epos_ = remaining_size;
  8336. if (remaining_size + n > buf_.size()) { buf_.resize(remaining_size + n); }
  8337. for (size_t i = 0; i < n; i++) {
  8338. buf_[buf_epos_ + i] = data[i];
  8339. }
  8340. buf_epos_ += n;
  8341. }
  8342. void buf_erase(size_t size) { buf_spos_ += size; }
  8343. std::string buf_;
  8344. size_t buf_spos_ = 0;
  8345. size_t buf_epos_ = 0;
  8346. };
  8347. inline std::string random_string(size_t length) {
  8348. constexpr const char data[] =
  8349. "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
  8350. std::string result(length, '\0');
  8351. fill_random_bytes(reinterpret_cast<unsigned char *>(&result[0]), length);
  8352. for (auto &c : result) {
  8353. c = data[static_cast<unsigned char>(c) % (sizeof(data) - 1)];
  8354. }
  8355. return result;
  8356. }
  8357. inline std::string make_multipart_data_boundary() {
  8358. return "--cpp-httplib-multipart-data-" + detail::random_string(16);
  8359. }
  8360. inline bool is_multipart_boundary_chars_valid(const std::string &boundary) {
  8361. auto valid = true;
  8362. for (size_t i = 0; i < boundary.size(); i++) {
  8363. auto c = boundary[i];
  8364. if (!is_ascii_alnum(c) && c != '-' && c != '_') {
  8365. valid = false;
  8366. break;
  8367. }
  8368. }
  8369. return valid;
  8370. }
  8371. // Escape a multipart field name/filename following the WHATWG HTML standard
  8372. // ("escape a multipart form-data name"): '"' -> %22, CR -> %0D, LF -> %0A.
  8373. // As the value is a quoted-string, '\' -> '\\' too, which browsers leave out.
  8374. // With quoted = false, only CR and LF are escaped; this is for header values
  8375. // outside a quoted-string (e.g. Content-Type), where '"' and '\' are legal.
  8376. inline std::string escape_multipart_field(const std::string &s,
  8377. bool quoted = true) {
  8378. std::string result;
  8379. result.reserve(s.size());
  8380. for (auto c : s) {
  8381. switch (c) {
  8382. case '"':
  8383. if (quoted) {
  8384. result += "%22";
  8385. } else {
  8386. result += c;
  8387. }
  8388. break;
  8389. case '\\':
  8390. // A lone backslash would escape the character after it (RFC 9110
  8391. // 5.6.4).
  8392. if (quoted) { result += '\\'; }
  8393. result += c;
  8394. break;
  8395. case '\r': result += "%0D"; break;
  8396. case '\n': result += "%0A"; break;
  8397. default: result += c; break;
  8398. }
  8399. }
  8400. return result;
  8401. }
  8402. template <typename T>
  8403. inline std::string
  8404. serialize_multipart_formdata_item_begin(const T &item,
  8405. const std::string &boundary) {
  8406. std::string body = "--" + boundary + "\r\n";
  8407. body += "Content-Disposition: form-data; name=\"" +
  8408. escape_multipart_field(item.name) + "\"";
  8409. if (!item.filename.empty()) {
  8410. body += "; filename=\"" + escape_multipart_field(item.filename) + "\"";
  8411. }
  8412. body += "\r\n";
  8413. if (!item.content_type.empty()) {
  8414. body +=
  8415. "Content-Type: " + escape_multipart_field(item.content_type, false) +
  8416. "\r\n";
  8417. }
  8418. body += "\r\n";
  8419. return body;
  8420. }
  8421. inline std::string serialize_multipart_formdata_item_end() { return "\r\n"; }
  8422. inline std::string
  8423. serialize_multipart_formdata_finish(const std::string &boundary) {
  8424. return "--" + boundary + "--\r\n";
  8425. }
  8426. inline std::string
  8427. serialize_multipart_formdata_get_content_type(const std::string &boundary) {
  8428. return "multipart/form-data; boundary=" + boundary;
  8429. }
  8430. inline std::string
  8431. serialize_multipart_formdata(const UploadFormDataItems &items,
  8432. const std::string &boundary, bool finish = true) {
  8433. std::string body;
  8434. for (const auto &item : items) {
  8435. body += serialize_multipart_formdata_item_begin(item, boundary);
  8436. body += item.content + serialize_multipart_formdata_item_end();
  8437. }
  8438. if (finish) { body += serialize_multipart_formdata_finish(boundary); }
  8439. return body;
  8440. }
  8441. inline size_t get_multipart_content_length(const UploadFormDataItems &items,
  8442. const std::string &boundary) {
  8443. size_t total = 0;
  8444. for (const auto &item : items) {
  8445. total += serialize_multipart_formdata_item_begin(item, boundary).size();
  8446. total += item.content.size();
  8447. total += serialize_multipart_formdata_item_end().size();
  8448. }
  8449. total += serialize_multipart_formdata_finish(boundary).size();
  8450. return total;
  8451. }
  8452. struct MultipartSegment {
  8453. const char *data;
  8454. size_t size;
  8455. };
  8456. // NOTE: items must outlive the returned ContentProvider
  8457. // (safe for synchronous use inside Post/Put/Patch)
  8458. inline ContentProvider
  8459. make_multipart_content_provider(const UploadFormDataItems &items,
  8460. const std::string &boundary) {
  8461. // Own the per-item header strings and the finish string
  8462. std::vector<std::string> owned;
  8463. owned.reserve(items.size() + 1);
  8464. for (const auto &item : items)
  8465. owned.push_back(serialize_multipart_formdata_item_begin(item, boundary));
  8466. owned.push_back(serialize_multipart_formdata_finish(boundary));
  8467. // Flat segment list: [header, content, "\r\n"] * N + [finish]
  8468. std::vector<MultipartSegment> segs;
  8469. segs.reserve(items.size() * 3 + 1);
  8470. static const char crlf[] = "\r\n";
  8471. for (size_t i = 0; i < items.size(); i++) {
  8472. segs.push_back({owned[i].data(), owned[i].size()});
  8473. segs.push_back({items[i].content.data(), items[i].content.size()});
  8474. segs.push_back({crlf, 2});
  8475. }
  8476. segs.push_back({owned.back().data(), owned.back().size()});
  8477. struct MultipartState {
  8478. std::vector<std::string> owned;
  8479. std::vector<MultipartSegment> segs;
  8480. std::vector<char> buf = std::vector<char>(CPPHTTPLIB_SEND_BUFSIZ);
  8481. };
  8482. auto state = std::make_shared<MultipartState>();
  8483. state->owned = std::move(owned);
  8484. // `segs` holds raw pointers into owned strings; std::string move preserves
  8485. // the data pointer, so these pointers remain valid after the move above.
  8486. state->segs = std::move(segs);
  8487. return [state](size_t offset, size_t length, DataSink &sink) -> bool {
  8488. // Buffer multiple small segments into fewer, larger writes to avoid
  8489. // excessive TCP packets when there are many form data items (#2410)
  8490. auto &buf = state->buf;
  8491. auto buf_size = buf.size();
  8492. size_t buf_len = 0;
  8493. size_t remaining = length;
  8494. // Find the first segment containing 'offset'
  8495. size_t pos = 0;
  8496. size_t seg_idx = 0;
  8497. for (; seg_idx < state->segs.size(); seg_idx++) {
  8498. const auto &seg = state->segs[seg_idx];
  8499. if (seg.size > 0 && offset - pos < seg.size) { break; }
  8500. pos += seg.size;
  8501. }
  8502. size_t seg_offset = (seg_idx < state->segs.size()) ? offset - pos : 0;
  8503. for (; seg_idx < state->segs.size() && remaining > 0; seg_idx++) {
  8504. const auto &seg = state->segs[seg_idx];
  8505. size_t available = seg.size - seg_offset;
  8506. size_t to_copy = (std::min)(available, remaining);
  8507. const char *src = seg.data + seg_offset;
  8508. seg_offset = 0; // only the first segment has a non-zero offset
  8509. while (to_copy > 0) {
  8510. size_t space = buf_size - buf_len;
  8511. size_t chunk = (std::min)(to_copy, space);
  8512. std::memcpy(buf.data() + buf_len, src, chunk);
  8513. buf_len += chunk;
  8514. src += chunk;
  8515. to_copy -= chunk;
  8516. remaining -= chunk;
  8517. if (buf_len == buf_size) {
  8518. if (!sink.write(buf.data(), buf_len)) { return false; }
  8519. buf_len = 0;
  8520. }
  8521. }
  8522. }
  8523. if (buf_len > 0) { return sink.write(buf.data(), buf_len); }
  8524. return true;
  8525. };
  8526. }
  8527. inline void coalesce_ranges(Ranges &ranges, size_t content_length) {
  8528. if (ranges.size() <= 1) return;
  8529. // Sort ranges by start position
  8530. std::sort(ranges.begin(), ranges.end(),
  8531. [](const Range &a, const Range &b) { return a.first < b.first; });
  8532. Ranges coalesced;
  8533. coalesced.reserve(ranges.size());
  8534. for (auto &r : ranges) {
  8535. auto first_pos = r.first;
  8536. auto last_pos = r.second;
  8537. // Handle special cases like in range_error
  8538. if (first_pos == -1 && last_pos == -1) {
  8539. first_pos = 0;
  8540. last_pos = static_cast<ssize_t>(content_length);
  8541. }
  8542. if (first_pos == -1) {
  8543. first_pos = static_cast<ssize_t>(content_length) - last_pos;
  8544. last_pos = static_cast<ssize_t>(content_length) - 1;
  8545. }
  8546. if (last_pos == -1 || last_pos >= static_cast<ssize_t>(content_length)) {
  8547. last_pos = static_cast<ssize_t>(content_length) - 1;
  8548. }
  8549. // Skip invalid ranges
  8550. if (!(0 <= first_pos && first_pos <= last_pos &&
  8551. last_pos < static_cast<ssize_t>(content_length))) {
  8552. continue;
  8553. }
  8554. // Coalesce with previous range if overlapping or adjacent (but not
  8555. // identical)
  8556. if (!coalesced.empty()) {
  8557. auto &prev = coalesced.back();
  8558. // Check if current range overlaps or is adjacent to previous range
  8559. // but don't coalesce identical ranges (allow duplicates)
  8560. if (first_pos <= prev.second + 1 &&
  8561. !(first_pos == prev.first && last_pos == prev.second)) {
  8562. // Extend the previous range
  8563. prev.second = (std::max)(prev.second, last_pos);
  8564. continue;
  8565. }
  8566. }
  8567. // Add new range
  8568. coalesced.emplace_back(first_pos, last_pos);
  8569. }
  8570. ranges = std::move(coalesced);
  8571. }
  8572. inline bool range_error(Request &req, Response &res) {
  8573. if (!req.ranges.empty() && 200 <= res.status && res.status < 300) {
  8574. if (res.body.empty() && res.content_provider_ && res.content_length_ == 0) {
  8575. req.ranges.clear();
  8576. if (res.status == StatusCode::PartialContent_206) {
  8577. res.status = StatusCode::OK_200;
  8578. }
  8579. return false;
  8580. }
  8581. ssize_t content_len = static_cast<ssize_t>(
  8582. res.content_length_ ? res.content_length_ : res.body.size());
  8583. std::vector<std::pair<ssize_t, ssize_t>> processed_ranges;
  8584. size_t overwrapping_count = 0;
  8585. // NOTE: The following Range check is based on '14.2. Range' in RFC 9110
  8586. // 'HTTP Semantics' to avoid potential denial-of-service attacks.
  8587. // https://www.rfc-editor.org/rfc/rfc9110#section-14.2
  8588. // Too many ranges
  8589. if (CPPHTTPLIB_RANGE_MAX_COUNT > 0 &&
  8590. req.ranges.size() > CPPHTTPLIB_RANGE_MAX_COUNT) {
  8591. return true;
  8592. }
  8593. for (auto &r : req.ranges) {
  8594. auto &first_pos = r.first;
  8595. auto &last_pos = r.second;
  8596. if (first_pos == -1 && last_pos == -1) {
  8597. first_pos = 0;
  8598. last_pos = content_len;
  8599. }
  8600. // RFC 9110 14.1.2: a suffix-length longer than the representation
  8601. // selects the entire representation.
  8602. if (first_pos == -1) {
  8603. first_pos = (std::max)(static_cast<ssize_t>(0), content_len - last_pos);
  8604. last_pos = content_len - 1;
  8605. }
  8606. // NOTE: RFC-9110 '14.1.2. Byte Ranges':
  8607. // A client can limit the number of bytes requested without knowing the
  8608. // size of the selected representation. If the last-pos value is absent,
  8609. // or if the value is greater than or equal to the current length of the
  8610. // representation data, the byte range is interpreted as the remainder of
  8611. // the representation (i.e., the server replaces the value of last-pos
  8612. // with a value that is one less than the current length of the selected
  8613. // representation).
  8614. // https://www.rfc-editor.org/rfc/rfc9110.html#section-14.1.2-6
  8615. if (last_pos == -1 || last_pos >= content_len) {
  8616. last_pos = content_len - 1;
  8617. }
  8618. // Range must be within content length
  8619. if (!(0 <= first_pos && first_pos <= last_pos &&
  8620. last_pos <= content_len - 1)) {
  8621. return true;
  8622. }
  8623. // Request must not have more than two overlapping ranges
  8624. for (const auto &processed_range : processed_ranges) {
  8625. if (!(last_pos < processed_range.first ||
  8626. first_pos > processed_range.second)) {
  8627. overwrapping_count++;
  8628. if (overwrapping_count > 2) { return true; }
  8629. break; // Only count once per range
  8630. }
  8631. }
  8632. processed_ranges.emplace_back(first_pos, last_pos);
  8633. }
  8634. // After validation, coalesce overlapping ranges as per RFC 9110
  8635. coalesce_ranges(req.ranges, static_cast<size_t>(content_len));
  8636. }
  8637. return false;
  8638. }
  8639. inline std::pair<size_t, size_t>
  8640. get_range_offset_and_length(Range r, size_t content_length) {
  8641. assert(r.first != -1 && r.second != -1);
  8642. assert(0 <= r.first && r.first < static_cast<ssize_t>(content_length));
  8643. assert(r.first <= r.second &&
  8644. r.second < static_cast<ssize_t>(content_length));
  8645. (void)(content_length);
  8646. return std::make_pair(static_cast<size_t>(r.first),
  8647. static_cast<size_t>(r.second - r.first) + 1);
  8648. }
  8649. inline std::string make_content_range_header_field(
  8650. const std::pair<size_t, size_t> &offset_and_length, size_t content_length) {
  8651. auto st = offset_and_length.first;
  8652. auto ed = st + offset_and_length.second - 1;
  8653. std::string field = "bytes ";
  8654. field += std::to_string(st);
  8655. field += '-';
  8656. field += std::to_string(ed);
  8657. field += '/';
  8658. field += std::to_string(content_length);
  8659. return field;
  8660. }
  8661. template <typename SToken, typename CToken, typename Content>
  8662. bool process_multipart_ranges_data(const Request &req,
  8663. const std::string &boundary,
  8664. const std::string &content_type,
  8665. size_t content_length, SToken stoken,
  8666. CToken ctoken, Content content) {
  8667. for (size_t i = 0; i < req.ranges.size(); i++) {
  8668. ctoken("--");
  8669. stoken(boundary);
  8670. ctoken("\r\n");
  8671. if (!content_type.empty()) {
  8672. ctoken("Content-Type: ");
  8673. stoken(content_type);
  8674. ctoken("\r\n");
  8675. }
  8676. auto offset_and_length =
  8677. get_range_offset_and_length(req.ranges[i], content_length);
  8678. ctoken("Content-Range: ");
  8679. stoken(make_content_range_header_field(offset_and_length, content_length));
  8680. ctoken("\r\n");
  8681. ctoken("\r\n");
  8682. if (!content(offset_and_length.first, offset_and_length.second)) {
  8683. return false;
  8684. }
  8685. ctoken("\r\n");
  8686. }
  8687. ctoken("--");
  8688. stoken(boundary);
  8689. ctoken("--");
  8690. return true;
  8691. }
  8692. inline void make_multipart_ranges_data(const Request &req, Response &res,
  8693. const std::string &boundary,
  8694. const std::string &content_type,
  8695. size_t content_length,
  8696. std::string &data) {
  8697. process_multipart_ranges_data(
  8698. req, boundary, content_type, content_length,
  8699. [&](const std::string &token) { data += token; },
  8700. [&](const std::string &token) { data += token; },
  8701. [&](size_t offset, size_t length) {
  8702. assert(offset + length <= content_length);
  8703. data += res.body.substr(offset, length);
  8704. return true;
  8705. });
  8706. }
  8707. inline size_t get_multipart_ranges_data_length(const Request &req,
  8708. const std::string &boundary,
  8709. const std::string &content_type,
  8710. size_t content_length) {
  8711. size_t data_length = 0;
  8712. process_multipart_ranges_data(
  8713. req, boundary, content_type, content_length,
  8714. [&](const std::string &token) { data_length += token.size(); },
  8715. [&](const std::string &token) { data_length += token.size(); },
  8716. [&](size_t /*offset*/, size_t length) {
  8717. data_length += length;
  8718. return true;
  8719. });
  8720. return data_length;
  8721. }
  8722. template <typename T>
  8723. inline bool
  8724. write_multipart_ranges_data(Stream &strm, const Request &req, Response &res,
  8725. const std::string &boundary,
  8726. const std::string &content_type,
  8727. size_t content_length, const T &is_shutting_down) {
  8728. return process_multipart_ranges_data(
  8729. req, boundary, content_type, content_length,
  8730. [&](const std::string &token) { strm.write(token); },
  8731. [&](const std::string &token) { strm.write(token); },
  8732. [&](size_t offset, size_t length) {
  8733. return write_content(strm, res.content_provider_, offset, length,
  8734. is_shutting_down);
  8735. });
  8736. }
  8737. inline bool has_framed_body(const Request &req) {
  8738. return is_chunked_transfer_encoding(req.headers) ||
  8739. req.get_header_value_u64("Content-Length") > 0;
  8740. }
  8741. inline bool is_connection_persistent(const Request &req) {
  8742. if (has_header_token(req.headers, "Connection", "close")) { return false; }
  8743. if (req.version == "HTTP/1.0" &&
  8744. !has_header_token(req.headers, "Connection", "keep-alive")) {
  8745. return false;
  8746. }
  8747. return true;
  8748. }
  8749. inline bool expect_content(const Request &req) {
  8750. if (req.method == "POST" || req.method == "PUT" || req.method == "PATCH" ||
  8751. req.method == "DELETE") {
  8752. return true;
  8753. }
  8754. return has_framed_body(req);
  8755. }
  8756. #ifdef _WIN32
  8757. class WSInit {
  8758. public:
  8759. WSInit() {
  8760. WSADATA wsaData;
  8761. if (WSAStartup(0x0002, &wsaData) == 0) is_valid_ = true;
  8762. }
  8763. ~WSInit() {
  8764. if (is_valid_) WSACleanup();
  8765. }
  8766. bool is_valid_ = false;
  8767. };
  8768. static WSInit wsinit_;
  8769. #endif
  8770. inline std::string unescape_quoted_pairs(const std::string &s) {
  8771. std::string out;
  8772. out.reserve(s.size());
  8773. for (size_t i = 0; i < s.size(); i++) {
  8774. if (s[i] == '\\' && i + 1 < s.size()) {
  8775. out += s[++i];
  8776. } else {
  8777. out += s[i];
  8778. }
  8779. }
  8780. return out;
  8781. }
  8782. // Inverse of unescape_quoted_pairs: prepares a value to sit inside a
  8783. // quoted-string. RFC 9110 §5.6.4 requires a literal '\' or '"' to be sent as a
  8784. // quoted-pair, so the recipient recovers the original value.
  8785. inline std::string escape_quoted_pairs(const std::string &s) {
  8786. std::string out;
  8787. out.reserve(s.size());
  8788. for (auto c : s) {
  8789. if (c == '\\' || c == '"') { out += '\\'; }
  8790. out += c;
  8791. }
  8792. return out;
  8793. }
  8794. // RFC 9110 Section 11.6.1 defines a challenge list as
  8795. // WWW-Authenticate = #challenge
  8796. // challenge = auth-scheme [ 1*SP ( token68 / [ #auth-param ] ) ]
  8797. // auth-param = token BWS "=" BWS ( token / quoted-string )
  8798. // so a server may offer several schemes, each with its own comma-separated
  8799. // auth-param list, in either order and either as separate field lines or
  8800. // packed into one. Splitting on every comma would break apart a challenge's
  8801. // own param list; splitting only on the first space would miss a Digest
  8802. // challenge that isn't first. Split on commas that aren't inside a
  8803. // quoted-string instead (split_unquoted), then track which scheme each
  8804. // resulting segment belongs to: a segment whose text before "=" contains
  8805. // whitespace (or that has no "=" at all) starts a new challenge named by its
  8806. // leading token.
  8807. inline bool parse_www_authenticate(const Response &res,
  8808. std::map<std::string, std::string> &auth,
  8809. bool is_proxy) {
  8810. auto auth_key = is_proxy ? "Proxy-Authenticate" : "WWW-Authenticate";
  8811. auto combined = get_combined_header_value(res.headers, auth_key);
  8812. if (combined.empty()) { return false; }
  8813. auto found_digest = false;
  8814. auto in_digest_challenge = false;
  8815. split_unquoted(
  8816. combined.data(), combined.data() + combined.size(), ',',
  8817. [&](const char *b, const char *e) {
  8818. std::string segment(b, e);
  8819. auto eq_pos = segment.find('=');
  8820. // BWS is allowed on both sides of "=", so the text naming the key (or,
  8821. // for the first segment of a challenge, "<scheme> <key>") must be
  8822. // trimmed before its boundaries are inspected.
  8823. auto key_part = trim_copy(
  8824. eq_pos == std::string::npos ? segment : segment.substr(0, eq_pos));
  8825. auto space_pos = key_part.find_last_of(" \t");
  8826. if (space_pos != std::string::npos || eq_pos == std::string::npos) {
  8827. // "<scheme>[ <key>]" starts a new challenge.
  8828. auto scheme_end =
  8829. space_pos == std::string::npos ? key_part.size() : space_pos;
  8830. // RFC 7616 Section 3.7: a server may offer more than one Digest
  8831. // challenge (e.g. SHA-256 and MD5); keep only the first so a nonce
  8832. // from one challenge is never paired with another's algorithm.
  8833. in_digest_challenge =
  8834. !found_digest &&
  8835. case_ignore::equal(key_part.substr(0, scheme_end), "Digest");
  8836. if (in_digest_challenge) { found_digest = true; }
  8837. if (space_pos == std::string::npos) {
  8838. // Bare scheme (or a token68), no auth-param on this segment.
  8839. return;
  8840. }
  8841. key_part = key_part.substr(space_pos + 1);
  8842. }
  8843. if (!in_digest_challenge) { return; }
  8844. auto val = trim_copy(segment.substr(eq_pos + 1));
  8845. auto unquoted = trim_double_quotes_copy(val);
  8846. if (unquoted.size() != val.size()) {
  8847. unquoted = unescape_quoted_pairs(unquoted);
  8848. }
  8849. auth[std::move(key_part)] = std::move(unquoted);
  8850. });
  8851. // RFC 7616 Section 3.3 requires realm and nonce on every Digest challenge;
  8852. // make_digest_authentication_header() dereferences both unconditionally, so
  8853. // a challenge missing either can't produce a usable Authorization header.
  8854. // Treat it the same as no Digest challenge at all.
  8855. return found_digest && auth.find("realm") != auth.end() &&
  8856. auth.find("nonce") != auth.end();
  8857. }
  8858. class ContentProviderAdapter {
  8859. public:
  8860. explicit ContentProviderAdapter(
  8861. ContentProviderWithoutLength &&content_provider)
  8862. : content_provider_(std::move(content_provider)) {}
  8863. bool operator()(size_t offset, size_t, DataSink &sink) {
  8864. return content_provider_(offset, sink);
  8865. }
  8866. private:
  8867. ContentProviderWithoutLength content_provider_;
  8868. };
  8869. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  8870. namespace fields {
  8871. inline bool is_token_char(char c) {
  8872. return is_ascii_alnum(c) || c == '!' || c == '#' || c == '$' || c == '%' ||
  8873. c == '&' || c == '\'' || c == '*' || c == '+' || c == '-' ||
  8874. c == '.' || c == '^' || c == '_' || c == '`' || c == '|' || c == '~';
  8875. }
  8876. inline bool is_token(const std::string &s) {
  8877. if (s.empty()) { return false; }
  8878. for (auto c : s) {
  8879. if (!is_token_char(c)) { return false; }
  8880. }
  8881. return true;
  8882. }
  8883. inline bool is_field_name(const std::string &s) { return is_token(s); }
  8884. inline bool is_vchar(char c) { return c >= 33 && c <= 126; }
  8885. inline bool is_obs_text(char c) { return 128 <= static_cast<unsigned char>(c); }
  8886. inline bool is_field_vchar(char c) { return is_vchar(c) || is_obs_text(c); }
  8887. inline bool is_field_content(const std::string &s) {
  8888. if (s.empty()) { return true; }
  8889. if (s.size() == 1) {
  8890. return is_field_vchar(s[0]);
  8891. } else if (s.size() == 2) {
  8892. return is_field_vchar(s[0]) && is_field_vchar(s[1]);
  8893. } else {
  8894. size_t i = 0;
  8895. if (!is_field_vchar(s[i])) { return false; }
  8896. i++;
  8897. while (i < s.size() - 1) {
  8898. auto c = s[i++];
  8899. if (c == ' ' || c == '\t' || is_field_vchar(c)) {
  8900. } else {
  8901. return false;
  8902. }
  8903. }
  8904. return is_field_vchar(s[i]);
  8905. }
  8906. }
  8907. inline bool is_field_value(const std::string &s) { return is_field_content(s); }
  8908. inline bool is_field_valid(const std::string &name, const std::string &value) {
  8909. return is_field_name(name) && is_field_value(value);
  8910. }
  8911. // RFC 9112 §2.2/§3.2: the request-target has no SP, HTAB or other control
  8912. // characters (incl. bare CR). obs-text (raw UTF-8) is allowed.
  8913. inline bool is_request_target(const std::string &s) {
  8914. return std::all_of(s.begin(), s.end(), is_field_vchar);
  8915. }
  8916. // RFC 9110 §7.2: the bytes of uri-host [ ":" port ], i.e. unreserved,
  8917. // sub-delims, "%", ":" and the IP-literal brackets. An empty value is valid.
  8918. inline bool is_host(const std::string &s) {
  8919. return std::all_of(s.begin(), s.end(), [](char c) {
  8920. return is_ascii_alnum(c) || c == '-' || c == '.' || c == '_' || c == '~' ||
  8921. c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  8922. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  8923. c == '=' || c == '%' || c == ':' || c == '[' || c == ']';
  8924. });
  8925. }
  8926. } // namespace fields
  8927. // Built in memory first, like ClientImpl::write_request, so a rejected header
  8928. // never leaves a partial request on the wire.
  8929. inline bool write_request_head(Stream &strm, Request &req, Error &error) {
  8930. BufferStream bstrm;
  8931. if (write_request_line(bstrm, req.method, req.path) < 0) {
  8932. error = Error::Write;
  8933. return false;
  8934. }
  8935. if (!check_and_write_headers(bstrm, req.headers, write_headers, error)) {
  8936. return false;
  8937. }
  8938. const auto &data = bstrm.get_buffer();
  8939. if (!write_data(strm, data.data(), data.size())) {
  8940. error = Error::Write;
  8941. return false;
  8942. }
  8943. return true;
  8944. }
  8945. inline bool perform_websocket_handshake(Stream &strm, Request &req,
  8946. WebSocketUpgradeResponse &upgrade) {
  8947. // Generate a random 16-byte Sec-WebSocket-Key (RFC 6455 Section 4.1)
  8948. std::string key_bytes(16, '\0');
  8949. fill_random_bytes(reinterpret_cast<unsigned char *>(&key_bytes[0]),
  8950. key_bytes.size());
  8951. auto client_key = base64_encode(key_bytes);
  8952. req.headers.erase("Upgrade");
  8953. req.headers.erase("Connection");
  8954. req.headers.erase("Sec-WebSocket-Key");
  8955. req.headers.erase("Sec-WebSocket-Version");
  8956. req.headers.emplace("Upgrade", "websocket");
  8957. req.headers.emplace("Connection", "Upgrade");
  8958. req.headers.emplace("Sec-WebSocket-Key", client_key);
  8959. req.headers.emplace("Sec-WebSocket-Version", "13");
  8960. if (!write_request_head(strm, req, upgrade.error)) { return false; }
  8961. // Verify 101 response and Sec-WebSocket-Accept header
  8962. auto expected_accept = websocket_accept_key(client_key);
  8963. auto offered_subprotocols =
  8964. get_combined_header_value(req.headers, "Sec-WebSocket-Protocol");
  8965. return read_websocket_upgrade_response(strm, expected_accept,
  8966. offered_subprotocols, upgrade);
  8967. }
  8968. inline bool is_ip_address(const std::string &host) {
  8969. struct in_addr addr4;
  8970. struct in6_addr addr6;
  8971. return inet_pton(AF_INET, host.c_str(), &addr4) == 1 ||
  8972. inet_pton(AF_INET6, host.c_str(), &addr6) == 1;
  8973. }
  8974. // Resolve where a client should connect for `host`, honoring a user-supplied
  8975. // hostname-to-address map. `host` itself is never rewritten, so it keeps
  8976. // supplying the Host header and SNI; only the connection target changes.
  8977. //
  8978. // A mapped IP literal goes to `ip`, which keeps create_socket's AI_NUMERICHOST
  8979. // path. Anything else goes to `connect_host`, which create_socket resolves as
  8980. // a name, or uses as the socket path when the address family is AF_UNIX. An
  8981. // absent or empty mapping leaves `host` as the connection target; without the
  8982. // empty check the value would reach getaddrinfo as a null node and silently
  8983. // resolve to loopback.
  8984. inline void apply_addr_map(const std::map<std::string, std::string> &addr_map,
  8985. const std::string &host, std::string &connect_host,
  8986. std::string &ip) {
  8987. connect_host = host;
  8988. ip.clear();
  8989. auto it = addr_map.find(host);
  8990. if (it == addr_map.end() || it->second.empty()) { return; }
  8991. if (is_ip_address(it->second)) {
  8992. ip = it->second;
  8993. } else {
  8994. connect_host = it->second;
  8995. }
  8996. }
  8997. } // namespace detail
  8998. /*
  8999. * Group 2: detail namespace - SSL common utilities
  9000. */
  9001. #ifdef CPPHTTPLIB_SSL_ENABLED
  9002. namespace detail {
  9003. class SSLSocketStream final : public Stream {
  9004. public:
  9005. SSLSocketStream(
  9006. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  9007. time_t read_timeout_usec, time_t write_timeout_sec,
  9008. time_t write_timeout_usec, time_t max_timeout_msec = 0,
  9009. std::chrono::time_point<std::chrono::steady_clock> start_time =
  9010. (std::chrono::steady_clock::time_point::min)());
  9011. ~SSLSocketStream() override;
  9012. bool is_readable() const override;
  9013. bool wait_readable() const override;
  9014. bool wait_writable() const override;
  9015. bool is_peer_alive() const override;
  9016. ssize_t read(char *ptr, size_t size) override;
  9017. ssize_t write(const char *ptr, size_t size) override;
  9018. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  9019. void get_local_ip_and_port(std::string &ip, int &port) const override;
  9020. socket_t socket() const override;
  9021. time_t duration() const override;
  9022. void set_read_timeout(time_t sec, time_t usec = 0) override;
  9023. void set_max_timeout(time_t msec) override;
  9024. void set_read_interrupt(std::function<bool()> interrupted) override;
  9025. // See SocketStream::set_readable_hint().
  9026. void set_readable_hint() { readable_hint_ = true; }
  9027. // The error from the last read() or write() that failed in the TLS layer,
  9028. // with code Success if none did
  9029. const tls::TlsError &tls_error() const { return tls_error_; }
  9030. private:
  9031. bool ensure_readable();
  9032. socket_t sock_;
  9033. tls::session_t session_;
  9034. time_t read_timeout_sec_;
  9035. time_t read_timeout_usec_;
  9036. time_t write_timeout_sec_;
  9037. time_t write_timeout_usec_;
  9038. time_t max_timeout_msec_;
  9039. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  9040. std::function<bool()> read_interrupted_;
  9041. bool readable_hint_ = false;
  9042. tls::TlsError tls_error_;
  9043. };
  9044. // A TLS stream for WebSocket connections, where the receive path and the
  9045. // send path (application send() plus the heartbeat ping thread) run on
  9046. // different threads. A single TLS session must never be entered
  9047. // concurrently, so every call into the session is serialized by one mutex.
  9048. //
  9049. // Unlike SSLSocketStream, the socket is kept non-blocking for the stream's
  9050. // whole lifetime and each read()/write() performs a single non-blocking TLS
  9051. // call under the lock, then waits for readiness with select() outside the
  9052. // lock. The lock is therefore held only for CPU-bound work, so a reader
  9053. // blocked waiting for data never stalls a concurrent sender.
  9054. //
  9055. // This stream is used only for wss:// connections. Plain ws:// and ordinary
  9056. // HTTP/HTTPS keep using SocketStream/SSLSocketStream unchanged.
  9057. class WebSocketSSLStream final : public Stream {
  9058. public:
  9059. WebSocketSSLStream(socket_t sock, tls::session_t session,
  9060. time_t read_timeout_sec, time_t read_timeout_usec,
  9061. time_t write_timeout_sec, time_t write_timeout_usec);
  9062. ~WebSocketSSLStream() override;
  9063. bool is_readable() const override;
  9064. bool wait_readable() const override;
  9065. bool wait_writable() const override;
  9066. ssize_t read(char *ptr, size_t size) override;
  9067. ssize_t write(const char *ptr, size_t size) override;
  9068. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  9069. void get_local_ip_and_port(std::string &ip, int &port) const override;
  9070. socket_t socket() const override;
  9071. time_t duration() const override;
  9072. void set_read_timeout(time_t sec, time_t usec = 0) override;
  9073. void set_read_interrupt(std::function<bool()> interrupted) override;
  9074. private:
  9075. mutable std::mutex session_mutex_;
  9076. socket_t sock_;
  9077. tls::session_t session_;
  9078. // WebSocket::close() shortens the read timeout from the closing thread
  9079. // while the receive thread is inside wait_readable(), so these two are read
  9080. // and written concurrently. The write timeouts are never mutated.
  9081. std::atomic<time_t> read_timeout_sec_;
  9082. std::atomic<time_t> read_timeout_usec_;
  9083. time_t write_timeout_sec_;
  9084. time_t write_timeout_usec_;
  9085. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  9086. std::function<bool()> read_interrupted_;
  9087. };
  9088. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  9089. inline std::string message_digest(const std::string &s, const EVP_MD *algo) {
  9090. auto context = std::unique_ptr<EVP_MD_CTX, decltype(&EVP_MD_CTX_free)>(
  9091. EVP_MD_CTX_new(), EVP_MD_CTX_free);
  9092. unsigned int hash_length = 0;
  9093. unsigned char hash[EVP_MAX_MD_SIZE];
  9094. EVP_DigestInit_ex(context.get(), algo, nullptr);
  9095. EVP_DigestUpdate(context.get(), s.c_str(), s.size());
  9096. EVP_DigestFinal_ex(context.get(), hash, &hash_length);
  9097. std::stringstream ss;
  9098. for (auto i = 0u; i < hash_length; ++i) {
  9099. ss << std::hex << std::setw(2) << std::setfill('0')
  9100. << static_cast<unsigned int>(hash[i]);
  9101. }
  9102. return ss.str();
  9103. }
  9104. inline std::string MD5(const std::string &s) {
  9105. return message_digest(s, EVP_md5());
  9106. }
  9107. inline std::string SHA_256(const std::string &s) {
  9108. return message_digest(s, EVP_sha256());
  9109. }
  9110. inline std::string SHA_512(const std::string &s) {
  9111. return message_digest(s, EVP_sha512());
  9112. }
  9113. #elif defined(CPPHTTPLIB_MBEDTLS_SUPPORT)
  9114. namespace {
  9115. template <size_t N>
  9116. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  9117. std::stringstream ss;
  9118. for (size_t i = 0; i < N; ++i) {
  9119. ss << std::hex << std::setw(2) << std::setfill('0')
  9120. << static_cast<unsigned int>(hash[i]);
  9121. }
  9122. return ss.str();
  9123. }
  9124. } // namespace
  9125. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9126. // Mbed TLS 4.x provides hashing (and TLS RNG) via PSA Crypto, which must be
  9127. // initialized once. PSA state is process-global; do not free it.
  9128. inline bool ensure_mbedtls_psa_crypto() {
  9129. static std::once_flag once;
  9130. static bool ok = false;
  9131. std::call_once(once, []() { ok = (psa_crypto_init() == PSA_SUCCESS); });
  9132. return ok;
  9133. }
  9134. inline bool psa_hash(psa_algorithm_t alg, const std::string &s,
  9135. unsigned char *out, size_t out_size) {
  9136. if (!ensure_mbedtls_psa_crypto()) { return false; }
  9137. size_t olen = 0;
  9138. return psa_hash_compute(alg, reinterpret_cast<const uint8_t *>(s.data()),
  9139. s.size(), out, out_size, &olen) == PSA_SUCCESS &&
  9140. olen == out_size;
  9141. }
  9142. #endif
  9143. inline std::string MD5(const std::string &s) {
  9144. unsigned char hash[16];
  9145. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9146. if (!psa_hash(PSA_ALG_MD5, s, hash, sizeof(hash))) { return {}; }
  9147. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9148. mbedtls_md5(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9149. hash);
  9150. #else
  9151. mbedtls_md5_ret(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9152. hash);
  9153. #endif
  9154. return hash_to_hex(hash);
  9155. }
  9156. inline std::string SHA_256(const std::string &s) {
  9157. unsigned char hash[32];
  9158. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9159. if (!psa_hash(PSA_ALG_SHA_256, s, hash, sizeof(hash))) { return {}; }
  9160. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9161. mbedtls_sha256(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9162. hash, 0);
  9163. #else
  9164. mbedtls_sha256_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9165. s.size(), hash, 0);
  9166. #endif
  9167. return hash_to_hex(hash);
  9168. }
  9169. inline std::string SHA_512(const std::string &s) {
  9170. unsigned char hash[64];
  9171. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9172. if (!psa_hash(PSA_ALG_SHA_512, s, hash, sizeof(hash))) { return {}; }
  9173. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9174. mbedtls_sha512(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9175. hash, 0);
  9176. #else
  9177. mbedtls_sha512_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9178. s.size(), hash, 0);
  9179. #endif
  9180. return hash_to_hex(hash);
  9181. }
  9182. #elif defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9183. namespace {
  9184. template <size_t N>
  9185. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  9186. std::stringstream ss;
  9187. for (size_t i = 0; i < N; ++i) {
  9188. ss << std::hex << std::setw(2) << std::setfill('0')
  9189. << static_cast<unsigned int>(hash[i]);
  9190. }
  9191. return ss.str();
  9192. }
  9193. } // namespace
  9194. inline std::string MD5(const std::string &s) {
  9195. unsigned char hash[WC_MD5_DIGEST_SIZE];
  9196. wc_Md5Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9197. static_cast<word32>(s.size()), hash);
  9198. return hash_to_hex(hash);
  9199. }
  9200. inline std::string SHA_256(const std::string &s) {
  9201. unsigned char hash[WC_SHA256_DIGEST_SIZE];
  9202. wc_Sha256Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9203. static_cast<word32>(s.size()), hash);
  9204. return hash_to_hex(hash);
  9205. }
  9206. inline std::string SHA_512(const std::string &s) {
  9207. unsigned char hash[WC_SHA512_DIGEST_SIZE];
  9208. wc_Sha512Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9209. static_cast<word32>(s.size()), hash);
  9210. return hash_to_hex(hash);
  9211. }
  9212. #endif
  9213. template <typename T>
  9214. inline bool process_server_socket_ssl(
  9215. const std::atomic<socket_t> &svr_sock, tls::session_t session,
  9216. socket_t sock, size_t keep_alive_max_count, time_t keep_alive_timeout_sec,
  9217. time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec,
  9218. time_t write_timeout_usec, T callback) {
  9219. // See process_server_socket(). The TLS library keeps already decrypted bytes
  9220. // of a pipelined request, which keep_alive() cannot see on the socket.
  9221. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9222. write_timeout_sec, write_timeout_usec);
  9223. return process_server_socket_core(
  9224. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  9225. [&]() { return strm.is_readable(); },
  9226. [&](bool socket_readable, bool close_connection,
  9227. bool &connection_closed) {
  9228. if (socket_readable) { strm.set_readable_hint(); }
  9229. return callback(strm, close_connection, connection_closed);
  9230. });
  9231. }
  9232. template <typename T>
  9233. inline bool process_client_socket_ssl(
  9234. tls::session_t session, socket_t sock, time_t read_timeout_sec,
  9235. time_t read_timeout_usec, time_t write_timeout_sec,
  9236. time_t write_timeout_usec, time_t max_timeout_msec,
  9237. std::chrono::time_point<std::chrono::steady_clock> start_time, T callback) {
  9238. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9239. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  9240. start_time);
  9241. return callback(strm);
  9242. }
  9243. // `uri` is req's request-target in origin form, as curl sends it, also when
  9244. // the request line carries the absolute form for a proxy.
  9245. inline std::pair<std::string, std::string> make_digest_authentication_header(
  9246. const Request &req, const std::string &uri,
  9247. const std::map<std::string, std::string> &auth, size_t cnonce_count,
  9248. const std::string &cnonce, const std::string &username,
  9249. const std::string &password, bool is_proxy = false) {
  9250. std::string nc;
  9251. {
  9252. std::stringstream ss;
  9253. ss << std::setfill('0') << std::setw(8) << std::hex << cnonce_count;
  9254. nc = ss.str();
  9255. }
  9256. std::string qop;
  9257. if (auth.find("qop") != auth.end()) {
  9258. qop = auth.at("qop");
  9259. if (qop.find("auth-int") != std::string::npos) {
  9260. qop = "auth-int";
  9261. } else if (qop.find("auth") != std::string::npos) {
  9262. qop = "auth";
  9263. } else {
  9264. qop.clear();
  9265. }
  9266. }
  9267. std::string algo = "MD5";
  9268. if (auth.find("algorithm") != auth.end()) {
  9269. // algorithm is an unquoted token (RFC 7616 §3.4). A server value that is
  9270. // not a token would otherwise be emitted verbatim and could carry commas
  9271. // or quotes that inject further auth-params into the header below.
  9272. const auto &a = auth.at("algorithm");
  9273. if (fields::is_token(a)) { algo = a; }
  9274. }
  9275. std::string response;
  9276. {
  9277. auto H = algo == "SHA-256" ? detail::SHA_256
  9278. : algo == "SHA-512" ? detail::SHA_512
  9279. : detail::MD5;
  9280. auto A1 = username + ":" + auth.at("realm") + ":" + password;
  9281. auto A2 = req.method + ":" + uri;
  9282. if (qop == "auth-int") { A2 += ":" + H(req.body); }
  9283. if (qop.empty()) {
  9284. response = H(H(A1) + ":" + auth.at("nonce") + ":" + H(A2));
  9285. } else {
  9286. response = H(H(A1) + ":" + auth.at("nonce") + ":" + nc + ":" + cnonce +
  9287. ":" + qop + ":" + H(A2));
  9288. }
  9289. }
  9290. auto opaque = (auth.find("opaque") != auth.end()) ? auth.at("opaque") : "";
  9291. // Every value placed inside a quoted-string is escaped so a '"' in it cannot
  9292. // close the string early. realm, nonce and opaque come straight from the
  9293. // server's challenge (parse_www_authenticate() already de-escaped them), so
  9294. // without this a crafted challenge injects extra auth-params into the header.
  9295. auto field =
  9296. "Digest username=\"" + detail::escape_quoted_pairs(username) +
  9297. "\", realm=\"" + detail::escape_quoted_pairs(auth.at("realm")) +
  9298. "\", nonce=\"" + detail::escape_quoted_pairs(auth.at("nonce")) +
  9299. "\", uri=\"" + detail::escape_quoted_pairs(uri) +
  9300. "\", algorithm=" + algo +
  9301. (qop.empty() ? ", response=\""
  9302. : ", qop=" + qop + ", nc=" + nc + ", cnonce=\"" + cnonce +
  9303. "\", response=\"") +
  9304. response + "\"" +
  9305. (opaque.empty()
  9306. ? ""
  9307. : ", opaque=\"" + detail::escape_quoted_pairs(opaque) + "\"");
  9308. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9309. return std::make_pair(key, field);
  9310. }
  9311. // Follows X509_check_host, which the OpenSSL backend uses, so that every
  9312. // backend accepts the same names.
  9313. inline bool match_hostname(const std::string &pattern,
  9314. const std::string &hostname) {
  9315. // A trailing dot on the host is ignored
  9316. auto host = hostname;
  9317. if (host.size() > 1 && host.back() == '.') { host.pop_back(); }
  9318. // Exact match (case-insensitive)
  9319. if (detail::case_ignore::equal(host, pattern)) { return true; }
  9320. // Split both pattern and hostname into components by '.', keeping any empty
  9321. // one, which no name may have
  9322. auto labels = [](const std::string &s) {
  9323. std::vector<std::string> v;
  9324. size_t b = 0;
  9325. while (true) {
  9326. auto e = s.find('.', b);
  9327. v.push_back(s.substr(b, e - b));
  9328. if (e == std::string::npos) { return v; }
  9329. b = e + 1;
  9330. }
  9331. };
  9332. auto pattern_components = labels(pattern);
  9333. auto host_components = labels(host);
  9334. auto has_empty_label = [](const std::vector<std::string> &v) {
  9335. return std::any_of(v.begin(), v.end(),
  9336. [](const std::string &l) { return l.empty(); });
  9337. };
  9338. if (has_empty_label(pattern_components) || has_empty_label(host_components)) {
  9339. return false;
  9340. }
  9341. // Component count must match
  9342. if (host_components.size() != pattern_components.size()) { return false; }
  9343. // A wildcard needs two labels after it, so that "*.com" matches nothing,
  9344. // and an IDNA label may not have one
  9345. const auto &leftmost = pattern_components.front();
  9346. if (leftmost.find('*') != std::string::npos &&
  9347. (pattern_components.size() < 3 ||
  9348. case_ignore::equal(leftmost.substr(0, 4), "xn--"))) {
  9349. return false;
  9350. }
  9351. // Compare each component with wildcard support
  9352. // Supports: "*" (full wildcard), "prefix*" (partial wildcard)
  9353. // https://bugs.launchpad.net/ubuntu/+source/firefox-3.0/+bug/376484
  9354. // Only the leftmost label may carry a wildcard (RFC 6125 6.4.3)
  9355. auto itr = pattern_components.begin();
  9356. for (const auto &h : host_components) {
  9357. auto &p = *itr;
  9358. auto is_leftmost = itr == pattern_components.begin();
  9359. if (!detail::case_ignore::equal(p, h) && !(is_leftmost && p == "*")) {
  9360. bool partial_match = false;
  9361. if (is_leftmost && !p.empty() && p[p.size() - 1] == '*') {
  9362. const auto prefix_length = p.size() - 1;
  9363. if (prefix_length == 0) {
  9364. partial_match = true;
  9365. } else if (h.size() >= prefix_length) {
  9366. partial_match =
  9367. std::equal(p.begin(),
  9368. p.begin() + static_cast<std::string::difference_type>(
  9369. prefix_length),
  9370. h.begin(), [](const char ca, const char cb) {
  9371. return detail::case_ignore::to_lower(ca) ==
  9372. detail::case_ignore::to_lower(cb);
  9373. });
  9374. }
  9375. }
  9376. if (!partial_match) { return false; }
  9377. }
  9378. ++itr;
  9379. }
  9380. return true;
  9381. }
  9382. #ifdef _WIN32
  9383. // Verify certificate using Windows CertGetCertificateChain API.
  9384. // This provides real-time certificate validation with Windows Update
  9385. // integration, independent of the TLS backend.
  9386. inline bool verify_cert_with_windows_schannel(
  9387. const std::vector<unsigned char> &der_cert, const std::string &hostname,
  9388. bool verify_hostname, uint64_t &out_error, tls::const_session_t session) {
  9389. if (der_cert.empty()) { return false; }
  9390. out_error = 0;
  9391. // Create Windows certificate context from DER data
  9392. auto cert_context = CertCreateCertificateContext(
  9393. X509_ASN_ENCODING | PKCS_7_ASN_ENCODING, der_cert.data(),
  9394. static_cast<DWORD>(der_cert.size()));
  9395. if (!cert_context) {
  9396. out_error = GetLastError();
  9397. return false;
  9398. }
  9399. auto cert_guard =
  9400. scope_exit([&] { CertFreeCertificateContext(cert_context); });
  9401. // Give CryptoAPI the certificates the server sent. Without them it follows
  9402. // the leaf's AIA URL, which may lead to an issuer under an untrusted root.
  9403. std::vector<tls::cert_t> peer_certs;
  9404. tls::get_peer_certs(session, peer_certs);
  9405. auto store = CertOpenStore(CERT_STORE_PROV_MEMORY, 0, 0, 0, nullptr);
  9406. auto store_guard = scope_exit([&] {
  9407. for (auto cert : peer_certs) {
  9408. tls::free_cert(cert);
  9409. }
  9410. if (store) { CertCloseStore(store, 0); }
  9411. });
  9412. for (auto cert : peer_certs) {
  9413. std::vector<unsigned char> der;
  9414. if (store && tls::get_cert_der(cert, der)) {
  9415. CertAddEncodedCertificateToStore(store, X509_ASN_ENCODING, der.data(),
  9416. static_cast<DWORD>(der.size()),
  9417. CERT_STORE_ADD_USE_EXISTING, nullptr);
  9418. }
  9419. }
  9420. // Setup chain parameters
  9421. CERT_CHAIN_PARA chain_para = {};
  9422. chain_para.cbSize = sizeof(chain_para);
  9423. // Require the server authentication usage along the chain, which also
  9424. // rejects roots that Windows trusts only for other purposes.
  9425. LPSTR server_auth = const_cast<LPSTR>(szOID_PKIX_KP_SERVER_AUTH);
  9426. chain_para.RequestedUsage.dwType = USAGE_MATCH_TYPE_AND;
  9427. chain_para.RequestedUsage.Usage.cUsageIdentifier = 1;
  9428. chain_para.RequestedUsage.Usage.rgpszUsageIdentifier = &server_auth;
  9429. // Build certificate chain with revocation checking
  9430. PCCERT_CHAIN_CONTEXT chain_context = nullptr;
  9431. auto chain_result = CertGetCertificateChain(
  9432. nullptr, cert_context, nullptr, store, &chain_para,
  9433. CERT_CHAIN_CACHE_END_CERT | CERT_CHAIN_REVOCATION_CHECK_END_CERT |
  9434. CERT_CHAIN_REVOCATION_ACCUMULATIVE_TIMEOUT,
  9435. nullptr, &chain_context);
  9436. if (!chain_result || !chain_context) {
  9437. out_error = GetLastError();
  9438. return false;
  9439. }
  9440. auto chain_guard =
  9441. scope_exit([&] { CertFreeCertificateChain(chain_context); });
  9442. // Verify SSL policy
  9443. SSL_EXTRA_CERT_CHAIN_POLICY_PARA extra_policy_para = {};
  9444. extra_policy_para.cbSize = sizeof(extra_policy_para);
  9445. #ifdef AUTHTYPE_SERVER
  9446. extra_policy_para.dwAuthType = AUTHTYPE_SERVER;
  9447. #endif
  9448. std::wstring whost;
  9449. if (verify_hostname) {
  9450. whost = u8string_to_wstring(hostname.c_str());
  9451. extra_policy_para.pwszServerName = const_cast<wchar_t *>(whost.c_str());
  9452. }
  9453. CERT_CHAIN_POLICY_PARA policy_para = {};
  9454. policy_para.cbSize = sizeof(policy_para);
  9455. #ifdef CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS
  9456. policy_para.dwFlags = CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS;
  9457. #else
  9458. policy_para.dwFlags = 0;
  9459. #endif
  9460. policy_para.pvExtraPolicyPara = &extra_policy_para;
  9461. CERT_CHAIN_POLICY_STATUS policy_status = {};
  9462. policy_status.cbSize = sizeof(policy_status);
  9463. if (!CertVerifyCertificateChainPolicy(CERT_CHAIN_POLICY_SSL, chain_context,
  9464. &policy_para, &policy_status)) {
  9465. out_error = GetLastError();
  9466. return false;
  9467. }
  9468. if (policy_status.dwError != 0) {
  9469. out_error = policy_status.dwError;
  9470. return false;
  9471. }
  9472. return true;
  9473. }
  9474. #endif // _WIN32
  9475. // Loads CA file/dir configuration and applies the system CA policy to a
  9476. // client TLS context. PEM data and native stores are applied to the context
  9477. // directly at set time; has_custom_store reflects them for the Auto policy
  9478. // decision.
  9479. inline bool load_client_ca_config(tls::ctx_t ctx,
  9480. const std::string &ca_cert_file_path,
  9481. const std::string &ca_cert_dir_path,
  9482. bool has_custom_store, SystemCAMode mode,
  9483. uint64_t &backend_error) {
  9484. auto ret = true;
  9485. if (!ca_cert_file_path.empty()) {
  9486. if (!tls::load_ca_file(ctx, ca_cert_file_path.c_str())) {
  9487. backend_error = tls::get_error();
  9488. ret = false;
  9489. }
  9490. } else if (!ca_cert_dir_path.empty()) {
  9491. if (!tls::load_ca_dir(ctx, ca_cert_dir_path.c_str())) {
  9492. backend_error = tls::get_error();
  9493. ret = false;
  9494. }
  9495. }
  9496. auto has_custom_ca = !ca_cert_file_path.empty() ||
  9497. !ca_cert_dir_path.empty() || has_custom_store;
  9498. if (mode == SystemCAMode::Enabled ||
  9499. (mode == SystemCAMode::Auto && !has_custom_ca)) {
  9500. if (!tls::load_system_certs(ctx)) { backend_error = tls::get_error(); }
  9501. }
  9502. return ret;
  9503. }
  9504. // Serializes the CA certificates installed in ctx as PEM, so they can be
  9505. // loaded into another context.
  9506. inline std::string ca_certs_to_pem(tls::ctx_t ctx) {
  9507. std::string pem;
  9508. std::vector<tls::cert_t> certs;
  9509. tls::get_ca_certs(ctx, certs);
  9510. for (auto cert : certs) {
  9511. std::vector<unsigned char> der;
  9512. if (tls::get_cert_der(cert, der)) {
  9513. auto b64 = base64_encode(std::string(der.begin(), der.end()));
  9514. pem += "-----BEGIN CERTIFICATE-----\n";
  9515. for (size_t i = 0; i < b64.size(); i += 64) {
  9516. pem += b64.substr(i, 64);
  9517. pem += '\n';
  9518. }
  9519. pem += "-----END CERTIFICATE-----\n";
  9520. }
  9521. tls::free_cert(cert);
  9522. }
  9523. return pem;
  9524. }
  9525. // Returns a PemMemory field as a NUL-terminated string: its first len bytes,
  9526. // copied to buf, or pem itself when len is 0.
  9527. inline const char *pem_c_str(const char *pem, size_t len, std::string &buf) {
  9528. if (!pem || len == 0) { return pem; }
  9529. buf.assign(pem, len);
  9530. return buf.c_str();
  9531. }
  9532. // The parts of session setup that only SSLClient needs, plus the handful
  9533. // WebSocketClient also exposes; everything else takes the defaults, which is
  9534. // what keeps the two clients on one implementation.
  9535. struct ClientTlsSessionOptions {
  9536. // Both SSLClient and WebSocketClient expose this independently of
  9537. // certificate verification.
  9538. bool server_hostname_verification = true;
  9539. std::function<SSLVerifierResponse(tls::session_t)> session_verifier;
  9540. // When non-null, guards session creation against concurrent use of the
  9541. // context. A WebSocketClient is not safe to use from several threads to
  9542. // begin with, so it passes nothing.
  9543. std::mutex *ctx_mutex = nullptr;
  9544. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9545. // The caller decides whether Schannel has anything to say about this
  9546. // connection; see SSLClient::initialize_ssl().
  9547. bool windows_cert_verification = false;
  9548. // A server certificate verifier works on the backend's chain verification,
  9549. // so the backend keeps deciding and Schannel only adds its own check.
  9550. bool server_certificate_verifier_set = false;
  9551. #endif
  9552. };
  9553. // Filled in on failure for callers that report error details.
  9554. struct ClientTlsSessionError {
  9555. Error error = Error::Success;
  9556. int ssl_error = 0;
  9557. uint64_t backend_error = 0;
  9558. };
  9559. // Establishes a client TLS session on an already connected socket. On failure
  9560. // the session is left for the caller to free: SSLClient frees it right away,
  9561. // WebSocketClient keeps it in a member that shutdown_and_close() cleans up.
  9562. inline bool setup_client_tls_session(
  9563. const std::string &host, tls::ctx_t ctx, tls::session_t &session,
  9564. socket_t sock, bool server_certificate_verification, time_t timeout_sec,
  9565. time_t timeout_usec, ClientTlsSessionError *out_error = nullptr,
  9566. const ClientTlsSessionOptions &options = ClientTlsSessionOptions()) {
  9567. using namespace tls;
  9568. auto fail = [&](Error error, int ssl_error, uint64_t backend_error) {
  9569. if (out_error) {
  9570. out_error->error = error;
  9571. out_error->ssl_error = ssl_error;
  9572. out_error->backend_error = backend_error;
  9573. }
  9574. return false;
  9575. };
  9576. // A TLS failure, whose verification codes name the Error too
  9577. auto fail_tls = [&](ErrorCode code, uint64_t backend_error) {
  9578. auto error = Error::SSLConnection;
  9579. if (code == ErrorCode::CertVerifyFailed) {
  9580. error = Error::SSLServerVerification;
  9581. } else if (code == ErrorCode::HostnameMismatch) {
  9582. error = Error::SSLServerHostnameVerification;
  9583. }
  9584. return fail(error, static_cast<int>(code), backend_error);
  9585. };
  9586. if (!ctx) {
  9587. session = nullptr;
  9588. return fail(Error::SSLConnection, 0, 0);
  9589. }
  9590. // With Windows verification on and no server certificate verifier set,
  9591. // Schannel is the only chain verifier. The backend's trust store is a
  9592. // snapshot of the Windows stores that lacks the roots Windows fetches on
  9593. // demand, so the backend's verdict is not used.
  9594. auto windows_verifies_chain = false;
  9595. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9596. windows_verifies_chain = options.windows_cert_verification &&
  9597. !options.server_certificate_verifier_set;
  9598. #endif
  9599. // The chain, and a host name, are verified during the handshake, so that a
  9600. // server failing them never gets to see a client certificate. Unless
  9601. // Schannel verifies the chain instead, this holds for IP hosts too, whose
  9602. // identity is checked after the handshake by verify_hostname().
  9603. auto verify_in_handshake =
  9604. server_certificate_verification && !windows_verifies_chain;
  9605. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  9606. // A session verifier may accept a certificate the built-in check rejects,
  9607. // and runs only after the handshake
  9608. verify_in_handshake = verify_in_handshake && !options.session_verifier;
  9609. #endif
  9610. {
  9611. std::unique_lock<std::mutex> guard;
  9612. if (options.ctx_mutex) {
  9613. guard = std::unique_lock<std::mutex>(*options.ctx_mutex);
  9614. }
  9615. // The mode is set on the context, so under the same lock
  9616. set_verify_client(ctx, verify_in_handshake);
  9617. session = create_session(ctx, sock);
  9618. }
  9619. if (!session) { return fail(Error::SSLConnection, 0, get_error()); }
  9620. // RFC 6066: SNI must not be set for IP addresses; skip it for IP hosts, so
  9621. // their identity is checked post-handshake below instead.
  9622. if (!is_ip_address(host)) {
  9623. if (!set_sni(session, host.c_str(),
  9624. verify_in_handshake && options.server_hostname_verification)) {
  9625. return fail(Error::SSLConnection, 0, get_error());
  9626. }
  9627. }
  9628. TlsError tls_err;
  9629. if (!connect_nonblocking(session, sock, timeout_sec, timeout_usec,
  9630. &tls_err)) {
  9631. return fail_tls(tls_err.code, tls_err.backend_code);
  9632. }
  9633. auto verification_status = SSLVerifierResponse::NoDecisionMade;
  9634. if (options.session_verifier) {
  9635. verification_status = options.session_verifier(session);
  9636. }
  9637. if (verification_status == SSLVerifierResponse::CertificateRejected) {
  9638. return fail(Error::SSLServerVerification, 0, get_error());
  9639. }
  9640. if (verification_status == SSLVerifierResponse::NoDecisionMade &&
  9641. server_certificate_verification) {
  9642. if (!windows_verifies_chain) {
  9643. auto verify_result = get_verify_result(session);
  9644. if (verify_result != 0) {
  9645. return fail_tls(ErrorCode::CertVerifyFailed,
  9646. static_cast<uint64_t>(verify_result));
  9647. }
  9648. }
  9649. auto server_cert = get_peer_cert(session);
  9650. if (!server_cert) {
  9651. return fail_tls(ErrorCode::CertVerifyFailed, get_error());
  9652. }
  9653. auto cert_guard = detail::scope_exit([&] { free_cert(server_cert); });
  9654. // Identity check against the peer certificate, post-handshake for all
  9655. // backends. For IP hosts this is the only identity verification, since no
  9656. // hostname is bound during the handshake.
  9657. if (options.server_hostname_verification) {
  9658. if (!verify_hostname(server_cert, host.c_str())) {
  9659. return fail_tls(ErrorCode::HostnameMismatch, hostname_mismatch_code());
  9660. }
  9661. }
  9662. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9663. // Windows Schannel verification, which lets Windows fetch missing roots
  9664. // and intermediates on demand. It must not be skipped: unless a server
  9665. // certificate verifier is set, it is the only chain check.
  9666. if (options.windows_cert_verification) {
  9667. std::vector<unsigned char> der;
  9668. uint64_t wincrypt_error = 0;
  9669. if (!get_cert_der(server_cert, der) ||
  9670. !verify_cert_with_windows_schannel(
  9671. der, host, options.server_hostname_verification, wincrypt_error,
  9672. session)) {
  9673. return fail_tls(ErrorCode::CertVerifyFailed, wincrypt_error);
  9674. }
  9675. }
  9676. #endif
  9677. }
  9678. return true;
  9679. }
  9680. } // namespace detail
  9681. #endif // CPPHTTPLIB_SSL_ENABLED
  9682. /*
  9683. * Group 3: httplib namespace - Non-SSL public API implementations
  9684. */
  9685. inline void default_socket_options(socket_t sock) {
  9686. set_socket_opt(sock, SOL_SOCKET,
  9687. #ifdef SO_REUSEPORT
  9688. SO_REUSEPORT,
  9689. #else
  9690. SO_REUSEADDR,
  9691. #endif
  9692. 1);
  9693. }
  9694. inline bool set_socket_opt(socket_t sock, int level, int optname, int optval) {
  9695. return detail::set_socket_opt_impl(sock, level, optname, &optval,
  9696. sizeof(optval));
  9697. }
  9698. inline std::string get_bearer_token_auth(const Request &req) {
  9699. // The auth scheme is case-insensitive (RFC 9110 11.1), and a value shorter
  9700. // than the prefix carries no token.
  9701. constexpr const char bearer_prefix[] = "Bearer ";
  9702. constexpr auto bearer_prefix_len = detail::str_len(bearer_prefix);
  9703. auto value = req.get_header_value("Authorization");
  9704. if (value.size() >= bearer_prefix_len &&
  9705. detail::case_ignore::equal(value.substr(0, bearer_prefix_len),
  9706. bearer_prefix)) {
  9707. return value.substr(bearer_prefix_len);
  9708. }
  9709. return "";
  9710. }
  9711. inline const char *status_message(int status) {
  9712. switch (status) {
  9713. case StatusCode::Continue_100: return "Continue";
  9714. case StatusCode::SwitchingProtocol_101: return "Switching Protocol";
  9715. case StatusCode::Processing_102: return "Processing";
  9716. case StatusCode::EarlyHints_103: return "Early Hints";
  9717. case StatusCode::OK_200: return "OK";
  9718. case StatusCode::Created_201: return "Created";
  9719. case StatusCode::Accepted_202: return "Accepted";
  9720. case StatusCode::NonAuthoritativeInformation_203:
  9721. return "Non-Authoritative Information";
  9722. case StatusCode::NoContent_204: return "No Content";
  9723. case StatusCode::ResetContent_205: return "Reset Content";
  9724. case StatusCode::PartialContent_206: return "Partial Content";
  9725. case StatusCode::MultiStatus_207: return "Multi-Status";
  9726. case StatusCode::AlreadyReported_208: return "Already Reported";
  9727. case StatusCode::IMUsed_226: return "IM Used";
  9728. case StatusCode::MultipleChoices_300: return "Multiple Choices";
  9729. case StatusCode::MovedPermanently_301: return "Moved Permanently";
  9730. case StatusCode::Found_302: return "Found";
  9731. case StatusCode::SeeOther_303: return "See Other";
  9732. case StatusCode::NotModified_304: return "Not Modified";
  9733. case StatusCode::UseProxy_305: return "Use Proxy";
  9734. case StatusCode::unused_306: return "unused";
  9735. case StatusCode::TemporaryRedirect_307: return "Temporary Redirect";
  9736. case StatusCode::PermanentRedirect_308: return "Permanent Redirect";
  9737. case StatusCode::BadRequest_400: return "Bad Request";
  9738. case StatusCode::Unauthorized_401: return "Unauthorized";
  9739. case StatusCode::PaymentRequired_402: return "Payment Required";
  9740. case StatusCode::Forbidden_403: return "Forbidden";
  9741. case StatusCode::NotFound_404: return "Not Found";
  9742. case StatusCode::MethodNotAllowed_405: return "Method Not Allowed";
  9743. case StatusCode::NotAcceptable_406: return "Not Acceptable";
  9744. case StatusCode::ProxyAuthenticationRequired_407:
  9745. return "Proxy Authentication Required";
  9746. case StatusCode::RequestTimeout_408: return "Request Timeout";
  9747. case StatusCode::Conflict_409: return "Conflict";
  9748. case StatusCode::Gone_410: return "Gone";
  9749. case StatusCode::LengthRequired_411: return "Length Required";
  9750. case StatusCode::PreconditionFailed_412: return "Precondition Failed";
  9751. case StatusCode::PayloadTooLarge_413: return "Payload Too Large";
  9752. case StatusCode::UriTooLong_414: return "URI Too Long";
  9753. case StatusCode::UnsupportedMediaType_415: return "Unsupported Media Type";
  9754. case StatusCode::RangeNotSatisfiable_416: return "Range Not Satisfiable";
  9755. case StatusCode::ExpectationFailed_417: return "Expectation Failed";
  9756. case StatusCode::ImATeapot_418: return "I'm a teapot";
  9757. case StatusCode::MisdirectedRequest_421: return "Misdirected Request";
  9758. case StatusCode::UnprocessableContent_422: return "Unprocessable Content";
  9759. case StatusCode::Locked_423: return "Locked";
  9760. case StatusCode::FailedDependency_424: return "Failed Dependency";
  9761. case StatusCode::TooEarly_425: return "Too Early";
  9762. case StatusCode::UpgradeRequired_426: return "Upgrade Required";
  9763. case StatusCode::PreconditionRequired_428: return "Precondition Required";
  9764. case StatusCode::TooManyRequests_429: return "Too Many Requests";
  9765. case StatusCode::RequestHeaderFieldsTooLarge_431:
  9766. return "Request Header Fields Too Large";
  9767. case StatusCode::UnavailableForLegalReasons_451:
  9768. return "Unavailable For Legal Reasons";
  9769. case StatusCode::NotImplemented_501: return "Not Implemented";
  9770. case StatusCode::BadGateway_502: return "Bad Gateway";
  9771. case StatusCode::ServiceUnavailable_503: return "Service Unavailable";
  9772. case StatusCode::GatewayTimeout_504: return "Gateway Timeout";
  9773. case StatusCode::HttpVersionNotSupported_505:
  9774. return "HTTP Version Not Supported";
  9775. case StatusCode::VariantAlsoNegotiates_506: return "Variant Also Negotiates";
  9776. case StatusCode::InsufficientStorage_507: return "Insufficient Storage";
  9777. case StatusCode::LoopDetected_508: return "Loop Detected";
  9778. case StatusCode::NotExtended_510: return "Not Extended";
  9779. case StatusCode::NetworkAuthenticationRequired_511:
  9780. return "Network Authentication Required";
  9781. default:
  9782. case StatusCode::InternalServerError_500: return "Internal Server Error";
  9783. }
  9784. }
  9785. inline std::string to_string(const Error error) {
  9786. switch (error) {
  9787. case Error::Success: return "Success (no error)";
  9788. case Error::Unknown: return "Unknown";
  9789. case Error::Connection: return "Could not establish connection";
  9790. case Error::BindIPAddress: return "Failed to bind IP address";
  9791. case Error::Read: return "Failed to read connection";
  9792. case Error::Write: return "Failed to write connection";
  9793. case Error::ExceedRedirectCount: return "Maximum redirect count exceeded";
  9794. case Error::Canceled: return "Connection handling canceled";
  9795. case Error::SSLConnection: return "SSL connection failed";
  9796. case Error::SSLLoadingCerts: return "SSL certificate loading failed";
  9797. case Error::SSLServerVerification: return "SSL server verification failed";
  9798. case Error::SSLServerHostnameVerification:
  9799. return "SSL server hostname verification failed";
  9800. case Error::UnsupportedMultipartBoundaryChars:
  9801. return "Unsupported HTTP multipart boundary characters";
  9802. case Error::Compression: return "Compression failed";
  9803. case Error::ConnectionTimeout: return "Connection timed out";
  9804. case Error::ProxyConnection: return "Proxy connection failed";
  9805. case Error::ConnectionClosed: return "Connection closed by server";
  9806. case Error::Timeout: return "Read timeout";
  9807. case Error::ResourceExhaustion: return "Resource exhaustion";
  9808. case Error::TooManyFormDataFiles: return "Too many form data files";
  9809. case Error::ExceedMaxPayloadSize: return "Exceeded maximum payload size";
  9810. case Error::ExceedUriMaxLength: return "Exceeded maximum URI length";
  9811. case Error::ExceedMaxSocketDescriptorCount:
  9812. return "Exceeded maximum socket descriptor count";
  9813. case Error::InvalidRequestLine: return "Invalid request line";
  9814. case Error::InvalidHTTPMethod: return "Invalid HTTP method";
  9815. case Error::InvalidHTTPVersion: return "Invalid HTTP version";
  9816. case Error::InvalidHeaders: return "Invalid headers";
  9817. case Error::MultipartParsing: return "Multipart parsing failed";
  9818. case Error::OpenFile: return "Failed to open file";
  9819. case Error::Listen: return "Failed to listen on socket";
  9820. case Error::GetSockName: return "Failed to get socket name";
  9821. case Error::UnsupportedAddressFamily: return "Unsupported address family";
  9822. case Error::HTTPParsing: return "HTTP parsing failed";
  9823. case Error::InvalidRangeHeader: return "Invalid Range header";
  9824. case Error::UnsupportedContentEncoding: return "Unsupported Content-Encoding";
  9825. case Error::WebSocketHandshake: return "WebSocket handshake failed";
  9826. case Error::UserCallbackException: return "User callback threw an exception";
  9827. default: break;
  9828. }
  9829. return "Invalid";
  9830. }
  9831. inline std::ostream &operator<<(std::ostream &os, const Error &obj) {
  9832. os << to_string(obj);
  9833. os << " (" << static_cast<std::underlying_type<Error>::type>(obj) << ')';
  9834. return os;
  9835. }
  9836. inline std::string hosted_at(const std::string &hostname) {
  9837. std::vector<std::string> addrs;
  9838. hosted_at(hostname, addrs);
  9839. if (addrs.empty()) { return std::string(); }
  9840. return addrs[0];
  9841. }
  9842. inline void hosted_at(const std::string &hostname,
  9843. std::vector<std::string> &addrs) {
  9844. struct addrinfo hints;
  9845. struct addrinfo *result;
  9846. memset(&hints, 0, sizeof(struct addrinfo));
  9847. hints.ai_family = AF_UNSPEC;
  9848. hints.ai_socktype = SOCK_STREAM;
  9849. hints.ai_protocol = 0;
  9850. if (detail::getaddrinfo_with_timeout(hostname.c_str(), nullptr, &hints,
  9851. &result, 0)) {
  9852. #if defined __linux__ && !defined __ANDROID__
  9853. res_init();
  9854. #endif
  9855. return;
  9856. }
  9857. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  9858. for (auto rp = result; rp; rp = rp->ai_next) {
  9859. const auto &addr =
  9860. *reinterpret_cast<struct sockaddr_storage *>(rp->ai_addr);
  9861. std::string ip;
  9862. auto dummy = -1;
  9863. if (detail::get_ip_and_port(addr, sizeof(struct sockaddr_storage), ip,
  9864. dummy)) {
  9865. addrs.emplace_back(std::move(ip));
  9866. }
  9867. }
  9868. }
  9869. inline std::string encode_uri_component(const std::string &value) {
  9870. std::ostringstream escaped;
  9871. escaped.fill('0');
  9872. escaped << std::hex;
  9873. for (auto c : value) {
  9874. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9875. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')') {
  9876. escaped << c;
  9877. } else {
  9878. escaped << std::uppercase;
  9879. escaped << '%' << std::setw(2)
  9880. << static_cast<int>(static_cast<unsigned char>(c));
  9881. escaped << std::nouppercase;
  9882. }
  9883. }
  9884. return escaped.str();
  9885. }
  9886. inline std::string encode_uri(const std::string &value) {
  9887. std::ostringstream escaped;
  9888. escaped.fill('0');
  9889. escaped << std::hex;
  9890. for (auto c : value) {
  9891. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9892. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')' ||
  9893. c == ';' || c == '/' || c == '?' || c == ':' || c == '@' || c == '&' ||
  9894. c == '=' || c == '+' || c == '$' || c == ',' || c == '#') {
  9895. escaped << c;
  9896. } else {
  9897. escaped << std::uppercase;
  9898. escaped << '%' << std::setw(2)
  9899. << static_cast<int>(static_cast<unsigned char>(c));
  9900. escaped << std::nouppercase;
  9901. }
  9902. }
  9903. return escaped.str();
  9904. }
  9905. inline std::string decode_uri_component(const std::string &value) {
  9906. std::string result;
  9907. for (size_t i = 0; i < value.size(); i++) {
  9908. if (value[i] == '%' && i + 2 < value.size()) {
  9909. auto val = 0;
  9910. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9911. result += static_cast<char>(val);
  9912. i += 2;
  9913. } else {
  9914. result += value[i];
  9915. }
  9916. } else {
  9917. result += value[i];
  9918. }
  9919. }
  9920. return result;
  9921. }
  9922. inline std::string decode_uri(const std::string &value) {
  9923. std::string result;
  9924. for (size_t i = 0; i < value.size(); i++) {
  9925. if (value[i] == '%' && i + 2 < value.size()) {
  9926. auto val = 0;
  9927. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9928. auto c = static_cast<char>(val);
  9929. // Keep escapes of the reserved characters that encode_uri leaves
  9930. // literal, so decode_uri is the inverse of encode_uri and an escaped
  9931. // delimiter is not promoted into a real one (as with JS decodeURI).
  9932. if (c == ';' || c == '/' || c == '?' || c == ':' || c == '@' ||
  9933. c == '&' || c == '=' || c == '+' || c == '$' || c == ',' ||
  9934. c == '#') {
  9935. result += value[i];
  9936. result += value[i + 1];
  9937. result += value[i + 2];
  9938. } else {
  9939. result += c;
  9940. }
  9941. i += 2;
  9942. } else {
  9943. result += value[i];
  9944. }
  9945. } else {
  9946. result += value[i];
  9947. }
  9948. }
  9949. return result;
  9950. }
  9951. inline std::string encode_path_component(const std::string &component) {
  9952. std::string result;
  9953. result.reserve(component.size() * 3);
  9954. for (size_t i = 0; i < component.size(); i++) {
  9955. auto c = static_cast<unsigned char>(component[i]);
  9956. // Unreserved characters per RFC 3986: ALPHA / DIGIT / "-" / "." / "_" / "~"
  9957. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9958. c == '_' || c == '~') {
  9959. result += static_cast<char>(c);
  9960. }
  9961. // Path-safe sub-delimiters: "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" /
  9962. // "," / ";" / "="
  9963. else if (c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  9964. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  9965. c == '=') {
  9966. result += static_cast<char>(c);
  9967. }
  9968. // Colon is allowed in path segments except first segment
  9969. else if (c == ':') {
  9970. result += static_cast<char>(c);
  9971. }
  9972. // @ is allowed in path
  9973. else if (c == '@') {
  9974. result += static_cast<char>(c);
  9975. } else {
  9976. result += '%';
  9977. char hex[3];
  9978. snprintf(hex, sizeof(hex), "%02X", c);
  9979. result.append(hex, 2);
  9980. }
  9981. }
  9982. return result;
  9983. }
  9984. inline std::string decode_path_component(const std::string &component) {
  9985. std::string result;
  9986. result.reserve(component.size());
  9987. for (size_t i = 0; i < component.size(); i++) {
  9988. if (component[i] == '%' && i + 1 < component.size()) {
  9989. if (component[i + 1] == 'u') {
  9990. // Unicode %uXXXX encoding
  9991. auto val = 0;
  9992. // 4 digits Unicode codes: val is 0x0000-0xFFFF (from 4 hex digits),
  9993. // so to_utf8 writes at most 3 bytes. buff[4] is safe.
  9994. char buff[4];
  9995. size_t len = 0;
  9996. if (detail::from_hex_to_i(component, i + 2, 4, val) &&
  9997. (len = detail::to_utf8(val, buff)) > 0) {
  9998. result.append(buff, len);
  9999. i += 5; // 'u0000'
  10000. } else {
  10001. // Not 4 hex digits, or a surrogate, which is no character: the
  10002. // escape is kept as it is rather than joining its neighbours
  10003. result += component[i];
  10004. }
  10005. } else {
  10006. // Standard %XX encoding
  10007. auto val = 0;
  10008. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  10009. // 2 digits hex codes
  10010. result += static_cast<char>(val);
  10011. i += 2; // 'XX'
  10012. } else {
  10013. result += component[i];
  10014. }
  10015. }
  10016. } else {
  10017. result += component[i];
  10018. }
  10019. }
  10020. return result;
  10021. }
  10022. inline std::string encode_query_component(const std::string &component,
  10023. bool space_as_plus) {
  10024. std::string result;
  10025. result.reserve(component.size() * 3);
  10026. for (size_t i = 0; i < component.size(); i++) {
  10027. auto c = static_cast<unsigned char>(component[i]);
  10028. // Unreserved characters per RFC 3986
  10029. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  10030. c == '_' || c == '~') {
  10031. result += static_cast<char>(c);
  10032. }
  10033. // Space handling
  10034. else if (c == ' ') {
  10035. if (space_as_plus) {
  10036. result += '+';
  10037. } else {
  10038. result += "%20";
  10039. }
  10040. }
  10041. // Plus sign handling
  10042. else if (c == '+') {
  10043. if (space_as_plus) {
  10044. result += "%2B";
  10045. } else {
  10046. result += static_cast<char>(c);
  10047. }
  10048. }
  10049. // Query-safe sub-delimiters (excluding & and = which are query delimiters)
  10050. else if (c == '!' || c == '$' || c == '\'' || c == '(' || c == ')' ||
  10051. c == '*' || c == ',' || c == ';') {
  10052. result += static_cast<char>(c);
  10053. }
  10054. // Colon and @ are allowed in query
  10055. else if (c == ':' || c == '@') {
  10056. result += static_cast<char>(c);
  10057. }
  10058. // Forward slash is allowed in query values
  10059. else if (c == '/') {
  10060. result += static_cast<char>(c);
  10061. }
  10062. // Question mark is allowed in query values (after first ?)
  10063. else if (c == '?') {
  10064. result += static_cast<char>(c);
  10065. } else {
  10066. result += '%';
  10067. char hex[3];
  10068. snprintf(hex, sizeof(hex), "%02X", c);
  10069. result.append(hex, 2);
  10070. }
  10071. }
  10072. return result;
  10073. }
  10074. inline std::string decode_query_component(const std::string &component,
  10075. bool plus_as_space) {
  10076. std::string result;
  10077. result.reserve(component.size());
  10078. for (size_t i = 0; i < component.size(); i++) {
  10079. if (component[i] == '%' && i + 2 < component.size()) {
  10080. auto val = 0;
  10081. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  10082. result += static_cast<char>(val);
  10083. i += 2;
  10084. } else {
  10085. result += component[i];
  10086. }
  10087. } else if (component[i] == '+' && plus_as_space) {
  10088. result += ' '; // + becomes space in form-urlencoded
  10089. } else {
  10090. result += component[i];
  10091. }
  10092. }
  10093. return result;
  10094. }
  10095. inline std::string sanitize_filename(const std::string &filename) {
  10096. // Extract basename: find the last path separator (/ or \)
  10097. auto pos = filename.find_last_of("/\\");
  10098. auto result =
  10099. (pos != std::string::npos) ? filename.substr(pos + 1) : filename;
  10100. // Strip null bytes
  10101. result.erase(std::remove(result.begin(), result.end(), '\0'), result.end());
  10102. // Trim whitespace
  10103. {
  10104. auto start = result.find_first_not_of(" \t");
  10105. auto end = result.find_last_not_of(" \t");
  10106. result = (start == std::string::npos)
  10107. ? ""
  10108. : result.substr(start, end - start + 1);
  10109. }
  10110. // Reject . and ..
  10111. if (result == "." || result == "..") { return ""; }
  10112. return result;
  10113. }
  10114. inline std::string append_query_params(const std::string &path,
  10115. const Params &params) {
  10116. // The query ends at the fragment (RFC 3986 3.5), so the params go before it.
  10117. auto fragment_pos = path.find('#');
  10118. auto path_with_query = path.substr(0, fragment_pos);
  10119. path_with_query += path_with_query.find('?') == std::string::npos ? '?' : '&';
  10120. path_with_query += detail::params_to_query_str(params);
  10121. if (fragment_pos != std::string::npos) {
  10122. path_with_query.append(path, fragment_pos, std::string::npos);
  10123. }
  10124. return path_with_query;
  10125. }
  10126. // Header utilities
  10127. inline std::pair<std::string, std::string>
  10128. make_range_header(const Ranges &ranges) {
  10129. std::string field = "bytes=";
  10130. auto i = 0;
  10131. for (const auto &r : ranges) {
  10132. if (i != 0) { field += ", "; }
  10133. if (r.first != -1) { field += std::to_string(r.first); }
  10134. field += '-';
  10135. if (r.second != -1) { field += std::to_string(r.second); }
  10136. i++;
  10137. }
  10138. return std::make_pair("Range", std::move(field));
  10139. }
  10140. inline std::pair<std::string, std::string>
  10141. make_basic_authentication_header(const std::string &username,
  10142. const std::string &password, bool is_proxy) {
  10143. auto field = "Basic " + detail::base64_encode(username + ":" + password);
  10144. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  10145. return std::make_pair(key, std::move(field));
  10146. }
  10147. inline std::pair<std::string, std::string>
  10148. make_bearer_token_authentication_header(const std::string &token,
  10149. bool is_proxy = false) {
  10150. auto field = "Bearer " + token;
  10151. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  10152. return std::make_pair(key, std::move(field));
  10153. }
  10154. namespace detail {
  10155. // Basic auth when a username or password is set, otherwise a bearer token,
  10156. // unless the request already carries the header.
  10157. inline void add_authorization_header(Request &req, const std::string &username,
  10158. const std::string &password,
  10159. const std::string &token, bool is_proxy) {
  10160. if (req.has_header(is_proxy ? "Proxy-Authorization" : "Authorization")) {
  10161. return;
  10162. }
  10163. if (!username.empty() || !password.empty()) {
  10164. req.headers.insert(
  10165. make_basic_authentication_header(username, password, is_proxy));
  10166. } else if (!token.empty()) {
  10167. req.headers.insert(
  10168. make_bearer_token_authentication_header(token, is_proxy));
  10169. }
  10170. }
  10171. } // namespace detail
  10172. // Request implementation
  10173. inline size_t Request::get_header_value_u64(const std::string &key, size_t def,
  10174. size_t id) const {
  10175. return detail::get_header_value_u64(headers, key, def, id);
  10176. }
  10177. inline bool Request::has_header(const std::string &key) const {
  10178. return detail::has_header(headers, key);
  10179. }
  10180. inline std::string Request::get_header_value(const std::string &key,
  10181. const char *def, size_t id) const {
  10182. return detail::get_header_value(headers, key, def, id);
  10183. }
  10184. inline size_t Request::get_header_value_count(const std::string &key) const {
  10185. return detail::get_header_value_count(headers, key);
  10186. }
  10187. inline void Request::set_header(const std::string &key,
  10188. const std::string &val) {
  10189. detail::set_header(headers, key, val);
  10190. }
  10191. inline bool Request::has_trailer(const std::string &key) const {
  10192. return trailers.find(key) != trailers.end();
  10193. }
  10194. inline std::string Request::get_trailer_value(const std::string &key,
  10195. size_t id) const {
  10196. return detail::get_multimap_value(trailers, key, id);
  10197. }
  10198. inline size_t Request::get_trailer_value_count(const std::string &key) const {
  10199. return trailers.count(key);
  10200. }
  10201. inline bool Request::has_param(const std::string &key) const {
  10202. return params.find(key) != params.end();
  10203. }
  10204. inline std::string Request::get_param_value(const std::string &key,
  10205. size_t id) const {
  10206. return detail::get_multimap_value(params, key, id);
  10207. }
  10208. inline std::vector<std::string>
  10209. Request::get_param_values(const std::string &key) const {
  10210. auto rng = params.equal_range(key);
  10211. std::vector<std::string> values;
  10212. values.reserve(static_cast<size_t>(std::distance(rng.first, rng.second)));
  10213. for (auto it = rng.first; it != rng.second; ++it) {
  10214. values.push_back(it->second);
  10215. }
  10216. return values;
  10217. }
  10218. inline size_t Request::get_param_value_count(const std::string &key) const {
  10219. return params.count(key);
  10220. }
  10221. inline bool Request::is_multipart_form_data() const {
  10222. const auto &content_type = get_header_value("Content-Type");
  10223. return detail::case_ignore::equal(detail::extract_media_type(content_type),
  10224. "multipart/form-data");
  10225. }
  10226. // Multipart FormData implementation
  10227. inline std::string MultipartFormData::get_field(const std::string &key,
  10228. size_t id) const {
  10229. auto rng = fields.equal_range(key);
  10230. auto it = detail::bounded_next(rng.first, id, rng.second);
  10231. if (it != rng.second) { return it->second.content; }
  10232. return std::string();
  10233. }
  10234. inline std::vector<std::string>
  10235. MultipartFormData::get_fields(const std::string &key) const {
  10236. std::vector<std::string> values;
  10237. auto rng = fields.equal_range(key);
  10238. for (auto it = rng.first; it != rng.second; it++) {
  10239. values.push_back(it->second.content);
  10240. }
  10241. return values;
  10242. }
  10243. inline bool MultipartFormData::has_field(const std::string &key) const {
  10244. return fields.find(key) != fields.end();
  10245. }
  10246. inline size_t MultipartFormData::get_field_count(const std::string &key) const {
  10247. return fields.count(key);
  10248. }
  10249. inline FormData MultipartFormData::get_file(const std::string &key,
  10250. size_t id) const {
  10251. return detail::get_multimap_value(files, key, id);
  10252. }
  10253. inline std::vector<FormData>
  10254. MultipartFormData::get_files(const std::string &key) const {
  10255. std::vector<FormData> values;
  10256. auto rng = files.equal_range(key);
  10257. for (auto it = rng.first; it != rng.second; it++) {
  10258. values.push_back(it->second);
  10259. }
  10260. return values;
  10261. }
  10262. inline bool MultipartFormData::has_file(const std::string &key) const {
  10263. return files.find(key) != files.end();
  10264. }
  10265. inline size_t MultipartFormData::get_file_count(const std::string &key) const {
  10266. return files.count(key);
  10267. }
  10268. // Multipart FormData writer implementation
  10269. inline bool is_valid_multipart_boundary(const std::string &boundary) {
  10270. return detail::is_multipart_boundary_chars_valid(boundary);
  10271. }
  10272. inline MultipartFormDataWriter::MultipartFormDataWriter()
  10273. : boundary_(detail::make_multipart_data_boundary()) {}
  10274. inline MultipartFormDataWriter::MultipartFormDataWriter(std::string boundary)
  10275. : boundary_(std::move(boundary)) {}
  10276. inline const std::string &MultipartFormDataWriter::boundary() const {
  10277. return boundary_;
  10278. }
  10279. inline std::string MultipartFormDataWriter::content_type() const {
  10280. return detail::serialize_multipart_formdata_get_content_type(boundary_);
  10281. }
  10282. inline std::string
  10283. MultipartFormDataWriter::serialize(const UploadFormDataItems &items) const {
  10284. return detail::serialize_multipart_formdata(items, boundary_);
  10285. }
  10286. inline size_t MultipartFormDataWriter::content_length(
  10287. const UploadFormDataItems &items) const {
  10288. return detail::get_multipart_content_length(items, boundary_);
  10289. }
  10290. inline std::string
  10291. MultipartFormDataWriter::item_begin(const UploadFormData &item) const {
  10292. return detail::serialize_multipart_formdata_item_begin(item, boundary_);
  10293. }
  10294. inline std::string MultipartFormDataWriter::item_end() {
  10295. return detail::serialize_multipart_formdata_item_end();
  10296. }
  10297. inline std::string MultipartFormDataWriter::finish() const {
  10298. return detail::serialize_multipart_formdata_finish(boundary_);
  10299. }
  10300. // Response implementation
  10301. namespace detail {
  10302. // A response has one content source: `body`, a content provider, or a file.
  10303. // Each content setter calls this so that the one called last wins.
  10304. inline void clear_content_provider(Response &res) {
  10305. auto releaser = std::move(res.content_provider_resource_releaser_);
  10306. auto success = res.content_provider_success_;
  10307. res.content_length_ = 0;
  10308. res.content_provider_ = nullptr;
  10309. res.content_provider_resource_releaser_ = nullptr;
  10310. res.is_chunked_content_provider_ = false;
  10311. res.is_file_content_provider_ = false;
  10312. res.content_provider_success_ = false;
  10313. res.content_coding_ = EncodingType::None;
  10314. res.file_content_path_.clear();
  10315. res.file_content_content_type_.clear();
  10316. if (releaser) { releaser(success); }
  10317. }
  10318. inline void clear_content(Response &res) {
  10319. res.body.clear();
  10320. clear_content_provider(res);
  10321. }
  10322. // The Content-Type of the old content goes with it.
  10323. inline void set_content_type(Response &res, const std::string &content_type) {
  10324. res.headers.erase("Content-Type");
  10325. res.set_header("Content-Type", content_type);
  10326. }
  10327. // `body` is public, so it can be assigned directly after a provider or a file
  10328. // was set. It came last, so it wins.
  10329. inline void prefer_assigned_body(Response &res) {
  10330. if (!res.body.empty() &&
  10331. (res.content_provider_ || !res.file_content_path_.empty())) {
  10332. clear_content_provider(res);
  10333. }
  10334. }
  10335. // RFC 9112 6.3: a 1xx, 204 or 304 response ends with its header section.
  10336. inline bool body_allowed_for_status(int status) {
  10337. return status >= 200 && status != StatusCode::NoContent_204 &&
  10338. status != StatusCode::NotModified_304;
  10339. }
  10340. // Only a 206 response is served as a partial representation. range_error()
  10341. // validates `req.ranges` only for a 2xx status, so slicing under any other
  10342. // status would start from an unchecked offset.
  10343. inline bool is_partial_content(const Request &req, const Response &res) {
  10344. return !req.ranges.empty() && res.status == StatusCode::PartialContent_206;
  10345. }
  10346. // Sets the Content-Length or Transfer-Encoding framing the body that
  10347. // Server::write_response_core() writes, or closes the connection after a body
  10348. // that has neither. Only the library sets them: one from a handler would go
  10349. // out next to it, or describe some other body.
  10350. inline void set_framing_headers(const Request &req, Response &res,
  10351. const std::string &boundary,
  10352. const std::string &content_type) {
  10353. // A HEAD response may give the length a GET would have had (RFC 9110 9.3.2).
  10354. auto head_length = req.method == "HEAD"
  10355. ? res.get_header_value("Content-Length")
  10356. : std::string();
  10357. res.headers.erase("Content-Length");
  10358. res.headers.erase("Transfer-Encoding");
  10359. if (!body_allowed_for_status(res.status)) { return; }
  10360. if (res.content_provider_) {
  10361. if (res.content_length_ == 0) {
  10362. if (res.is_chunked_content_provider_) {
  10363. res.set_header("Transfer-Encoding", "chunked");
  10364. } else if (req.method != "HEAD") {
  10365. // RFC 9112 6.3: a body with neither ends where the connection does.
  10366. res.headers.erase("Keep-Alive");
  10367. if (!has_header_token(res.headers, "Connection", "close")) {
  10368. res.set_header("Connection", "close");
  10369. }
  10370. }
  10371. return;
  10372. }
  10373. // The part Server::write_content_with_provider() writes.
  10374. auto length = res.content_length_;
  10375. if (is_partial_content(req, res)) {
  10376. length = req.ranges.size() == 1
  10377. ? get_range_offset_and_length(req.ranges[0], length).second
  10378. : get_multipart_ranges_data_length(req, boundary,
  10379. content_type, length);
  10380. }
  10381. res.set_header("Content-Length", std::to_string(length));
  10382. } else if (!res.body.empty()) {
  10383. res.set_header("Content-Length", std::to_string(res.body.size()));
  10384. } else {
  10385. res.set_header("Content-Length", head_length.empty() ? "0" : head_length);
  10386. }
  10387. }
  10388. } // namespace detail
  10389. inline size_t Response::get_header_value_u64(const std::string &key, size_t def,
  10390. size_t id) const {
  10391. return detail::get_header_value_u64(headers, key, def, id);
  10392. }
  10393. inline bool Response::has_header(const std::string &key) const {
  10394. return headers.find(key) != headers.end();
  10395. }
  10396. inline std::string Response::get_header_value(const std::string &key,
  10397. const char *def,
  10398. size_t id) const {
  10399. return detail::get_header_value(headers, key, def, id);
  10400. }
  10401. inline size_t Response::get_header_value_count(const std::string &key) const {
  10402. return detail::get_header_value_count(headers, key);
  10403. }
  10404. inline void Response::set_header(const std::string &key,
  10405. const std::string &val) {
  10406. detail::set_header(headers, key, val);
  10407. }
  10408. inline bool Response::has_trailer(const std::string &key) const {
  10409. return trailers.find(key) != trailers.end();
  10410. }
  10411. inline std::string Response::get_trailer_value(const std::string &key,
  10412. size_t id) const {
  10413. return detail::get_multimap_value(trailers, key, id);
  10414. }
  10415. inline size_t Response::get_trailer_value_count(const std::string &key) const {
  10416. return trailers.count(key);
  10417. }
  10418. inline void Response::set_redirect(const std::string &url, int stat) {
  10419. if (detail::fields::is_field_value(url)) {
  10420. set_header("Location", url);
  10421. if (300 <= stat && stat < 400) {
  10422. this->status = stat;
  10423. } else {
  10424. this->status = StatusCode::Found_302;
  10425. }
  10426. }
  10427. }
  10428. inline void Response::set_content(const char *s, size_t n,
  10429. const std::string &content_type) {
  10430. body.assign(s, n); // Before the releaser runs; it may own `s`.
  10431. detail::clear_content_provider(*this);
  10432. detail::set_content_type(*this, content_type);
  10433. }
  10434. inline void Response::set_content(const std::string &s,
  10435. const std::string &content_type) {
  10436. set_content(s.data(), s.size(), content_type);
  10437. }
  10438. inline void Response::set_content(std::string &&s,
  10439. const std::string &content_type) {
  10440. body = std::move(s);
  10441. detail::clear_content_provider(*this);
  10442. detail::set_content_type(*this, content_type);
  10443. }
  10444. inline void Response::set_content_provider(
  10445. size_t in_length, const std::string &content_type, ContentProvider provider,
  10446. ContentProviderResourceReleaser resource_releaser) {
  10447. detail::clear_content(*this);
  10448. detail::set_content_type(*this, content_type);
  10449. content_length_ = in_length;
  10450. if (in_length > 0) { content_provider_ = std::move(provider); }
  10451. content_provider_resource_releaser_ = std::move(resource_releaser);
  10452. }
  10453. inline void Response::set_content_provider(
  10454. const std::string &content_type, ContentProviderWithoutLength provider,
  10455. ContentProviderResourceReleaser resource_releaser) {
  10456. detail::clear_content(*this);
  10457. detail::set_content_type(*this, content_type);
  10458. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  10459. content_provider_resource_releaser_ = std::move(resource_releaser);
  10460. }
  10461. inline void Response::set_chunked_content_provider(
  10462. const std::string &content_type, ContentProviderWithoutLength provider,
  10463. ContentProviderResourceReleaser resource_releaser) {
  10464. set_content_provider(content_type, std::move(provider),
  10465. std::move(resource_releaser));
  10466. is_chunked_content_provider_ = true;
  10467. }
  10468. inline void Response::set_file_content(const std::string &path,
  10469. const std::string &content_type) {
  10470. detail::clear_content(*this);
  10471. headers.erase("Content-Type");
  10472. file_content_path_ = path;
  10473. file_content_content_type_ = content_type;
  10474. }
  10475. inline void Response::set_file_content(const std::string &path) {
  10476. set_file_content(path, std::string());
  10477. }
  10478. // Result implementation
  10479. inline size_t Result::get_request_header_value_u64(const std::string &key,
  10480. size_t def,
  10481. size_t id) const {
  10482. return detail::get_header_value_u64(request_headers_, key, def, id);
  10483. }
  10484. inline bool Result::has_request_header(const std::string &key) const {
  10485. return request_headers_.find(key) != request_headers_.end();
  10486. }
  10487. inline std::string Result::get_request_header_value(const std::string &key,
  10488. const char *def,
  10489. size_t id) const {
  10490. return detail::get_header_value(request_headers_, key, def, id);
  10491. }
  10492. inline size_t
  10493. Result::get_request_header_value_count(const std::string &key) const {
  10494. return request_headers_.count(key);
  10495. }
  10496. // Stream implementation
  10497. inline ssize_t Stream::write(const char *ptr) {
  10498. return write(ptr, strlen(ptr));
  10499. }
  10500. inline ssize_t Stream::write(const std::string &s) {
  10501. return write(s.data(), s.size());
  10502. }
  10503. // BodyReader implementation
  10504. inline ssize_t detail::BodyReader::read(char *buf, size_t len) {
  10505. if (!stream) {
  10506. last_error = Error::Connection;
  10507. return -1;
  10508. }
  10509. if (eof) { return 0; }
  10510. if (!chunked) {
  10511. // Content-Length based reading
  10512. if (has_content_length && bytes_read >= content_length) {
  10513. eof = true;
  10514. return 0;
  10515. }
  10516. auto to_read = len;
  10517. if (has_content_length) {
  10518. auto remaining = content_length - bytes_read;
  10519. to_read = (std::min)(len, remaining);
  10520. }
  10521. auto n = stream->read(buf, to_read);
  10522. // Without Content-Length the body ends when the connection closes
  10523. // (RFC 9112 §6.3); with one, an EOF here came too early
  10524. if (n < 0 || (n == 0 && has_content_length)) {
  10525. last_error = stream->get_error();
  10526. if (last_error == Error::Success) { last_error = Error::Read; }
  10527. }
  10528. if (n <= 0) {
  10529. eof = true;
  10530. return n;
  10531. }
  10532. bytes_read += static_cast<size_t>(n);
  10533. if (has_content_length && bytes_read >= content_length) { eof = true; }
  10534. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10535. last_error = Error::ExceedMaxPayloadSize;
  10536. eof = true;
  10537. return -1;
  10538. }
  10539. return n;
  10540. }
  10541. // Chunked transfer encoding: delegate to shared decoder instance.
  10542. if (!chunked_decoder) { chunked_decoder.reset(new ChunkedDecoder(*stream)); }
  10543. size_t chunk_offset = 0;
  10544. size_t chunk_total = 0;
  10545. auto n = chunked_decoder->read_payload(buf, len, chunk_offset, chunk_total);
  10546. if (n < 0) {
  10547. last_error = stream->get_error();
  10548. if (last_error == Error::Success) { last_error = Error::Read; }
  10549. eof = true;
  10550. return n;
  10551. }
  10552. if (n == 0) {
  10553. // Final chunk observed. Leave trailer parsing to the caller (StreamHandle).
  10554. eof = true;
  10555. return 0;
  10556. }
  10557. bytes_read += static_cast<size_t>(n);
  10558. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10559. last_error = Error::ExceedMaxPayloadSize;
  10560. eof = true;
  10561. return -1;
  10562. }
  10563. return n;
  10564. }
  10565. // ThreadPool implementation
  10566. inline ThreadPool::ThreadPool(size_t n, size_t max_n, size_t mqr,
  10567. time_t idle_timeout_sec)
  10568. : base_thread_count_(n), max_queued_requests_(mqr),
  10569. idle_timeout_sec_(idle_timeout_sec), idle_thread_count_(0),
  10570. shutdown_(false) {
  10571. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10572. if (max_n != 0 && max_n < n) {
  10573. std::string msg = "max_threads must be >= base_threads";
  10574. throw std::invalid_argument(msg);
  10575. }
  10576. #endif
  10577. max_thread_count_ = max_n == 0 ? n : max_n;
  10578. threads_.reserve(base_thread_count_);
  10579. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10580. try {
  10581. #endif
  10582. for (size_t i = 0; i < base_thread_count_; i++) {
  10583. threads_.emplace_back(std::thread([this]() { worker(false); }));
  10584. }
  10585. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10586. } catch (...) {
  10587. // If thread creation fails partway (e.g., pthread_create returns EAGAIN),
  10588. // signal the workers we already spawned to exit and join them so the
  10589. // vector destructor does not see joinable threads (which would call
  10590. // std::terminate). Then rethrow so the caller learns of the failure.
  10591. {
  10592. std::unique_lock<std::mutex> lock(mutex_);
  10593. shutdown_ = true;
  10594. }
  10595. cond_.notify_all();
  10596. for (auto &t : threads_) {
  10597. if (t.joinable()) { t.join(); }
  10598. }
  10599. throw;
  10600. }
  10601. #endif
  10602. }
  10603. inline bool ThreadPool::enqueue(std::function<void()> fn) {
  10604. {
  10605. std::unique_lock<std::mutex> lock(mutex_);
  10606. if (shutdown_) { return false; }
  10607. if (max_queued_requests_ > 0 && jobs_.size() >= max_queued_requests_) {
  10608. return false;
  10609. }
  10610. jobs_.push_back(std::move(fn));
  10611. // Spawn a dynamic thread if jobs outnumber idle threads and under max
  10612. if (jobs_.size() > idle_thread_count_ &&
  10613. threads_.size() + dynamic_threads_.size() < max_thread_count_) {
  10614. cleanup_finished_threads();
  10615. dynamic_threads_.emplace_back(std::thread([this]() { worker(true); }));
  10616. }
  10617. }
  10618. cond_.notify_one();
  10619. return true;
  10620. }
  10621. inline void ThreadPool::shutdown() {
  10622. {
  10623. std::unique_lock<std::mutex> lock(mutex_);
  10624. shutdown_ = true;
  10625. }
  10626. cond_.notify_all();
  10627. for (auto &t : threads_) {
  10628. if (t.joinable()) { t.join(); }
  10629. }
  10630. // Move dynamic_threads_ to a local list under the lock to avoid racing
  10631. // with worker threads that call move_to_finished() concurrently.
  10632. std::list<std::thread> remaining_dynamic;
  10633. {
  10634. std::unique_lock<std::mutex> lock(mutex_);
  10635. remaining_dynamic = std::move(dynamic_threads_);
  10636. }
  10637. for (auto &t : remaining_dynamic) {
  10638. if (t.joinable()) { t.join(); }
  10639. }
  10640. std::unique_lock<std::mutex> lock(mutex_);
  10641. cleanup_finished_threads();
  10642. }
  10643. inline void ThreadPool::move_to_finished(std::thread::id id) {
  10644. // Must be called with mutex_ held
  10645. for (auto it = dynamic_threads_.begin(); it != dynamic_threads_.end(); ++it) {
  10646. if (it->get_id() == id) {
  10647. finished_threads_.push_back(std::move(*it));
  10648. dynamic_threads_.erase(it);
  10649. return;
  10650. }
  10651. }
  10652. }
  10653. inline void ThreadPool::cleanup_finished_threads() {
  10654. // Must be called with mutex_ held
  10655. for (auto &t : finished_threads_) {
  10656. if (t.joinable()) { t.join(); }
  10657. }
  10658. finished_threads_.clear();
  10659. }
  10660. inline void ThreadPool::worker(bool is_dynamic) {
  10661. for (;;) {
  10662. std::function<void()> fn;
  10663. {
  10664. std::unique_lock<std::mutex> lock(mutex_);
  10665. idle_thread_count_++;
  10666. if (is_dynamic) {
  10667. auto has_work =
  10668. cond_.wait_for(lock, std::chrono::seconds(idle_timeout_sec_),
  10669. [&] { return !jobs_.empty() || shutdown_; });
  10670. if (!has_work) {
  10671. // Timed out with no work - exit this dynamic thread
  10672. idle_thread_count_--;
  10673. move_to_finished(std::this_thread::get_id());
  10674. break;
  10675. }
  10676. } else {
  10677. cond_.wait(lock, [&] { return !jobs_.empty() || shutdown_; });
  10678. }
  10679. idle_thread_count_--;
  10680. if (shutdown_ && jobs_.empty()) { break; }
  10681. fn = std::move(jobs_.front());
  10682. jobs_.pop_front();
  10683. }
  10684. assert(true == static_cast<bool>(fn));
  10685. fn();
  10686. }
  10687. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(OPENSSL_IS_BORINGSSL) && \
  10688. !defined(LIBRESSL_VERSION_NUMBER)
  10689. OPENSSL_thread_stop();
  10690. #endif
  10691. }
  10692. /*
  10693. * Group 1 (continued): detail namespace - Stream implementations
  10694. */
  10695. namespace detail {
  10696. inline void calc_actual_timeout(time_t max_timeout_msec, time_t duration_msec,
  10697. time_t timeout_sec, time_t timeout_usec,
  10698. time_t &actual_timeout_sec,
  10699. time_t &actual_timeout_usec) {
  10700. auto timeout_msec = (timeout_sec * 1000) + (timeout_usec / 1000);
  10701. auto actual_timeout_msec =
  10702. (std::min)(max_timeout_msec - duration_msec, timeout_msec);
  10703. if (actual_timeout_msec < 0) { actual_timeout_msec = 0; }
  10704. actual_timeout_sec = actual_timeout_msec / 1000;
  10705. actual_timeout_usec = (actual_timeout_msec % 1000) * 1000;
  10706. }
  10707. // Socket stream implementation
  10708. inline SocketStream::SocketStream(
  10709. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  10710. time_t write_timeout_sec, time_t write_timeout_usec,
  10711. time_t max_timeout_msec,
  10712. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10713. : sock_(sock), read_timeout_sec_(read_timeout_sec),
  10714. read_timeout_usec_(read_timeout_usec),
  10715. write_timeout_sec_(write_timeout_sec),
  10716. write_timeout_usec_(write_timeout_usec),
  10717. max_timeout_msec_(max_timeout_msec), start_time_(start_time),
  10718. read_buff_(read_buff_size_, 0) {}
  10719. inline SocketStream::~SocketStream() = default;
  10720. inline bool SocketStream::is_readable() const {
  10721. return read_buff_off_ < read_buff_content_size_;
  10722. }
  10723. inline bool SocketStream::wait_readable() const {
  10724. if (max_timeout_msec_ <= 0) {
  10725. return select_read_interruptible(sock_, read_timeout_sec_,
  10726. read_timeout_usec_, read_interrupted_) > 0;
  10727. }
  10728. time_t read_timeout_sec;
  10729. time_t read_timeout_usec;
  10730. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10731. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10732. return select_read_interruptible(sock_, read_timeout_sec, read_timeout_usec,
  10733. read_interrupted_) > 0;
  10734. }
  10735. inline bool SocketStream::wait_writable() const {
  10736. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10737. }
  10738. inline bool SocketStream::ensure_readable() {
  10739. if (readable_hint_) {
  10740. readable_hint_ = false;
  10741. return true;
  10742. }
  10743. return wait_readable();
  10744. }
  10745. inline const char *SocketStream::buffered_data(size_t &size) const {
  10746. size = read_buff_content_size_ - read_buff_off_;
  10747. return size ? read_buff_.data() + read_buff_off_ : nullptr;
  10748. }
  10749. inline void SocketStream::consume_buffered(size_t size) {
  10750. assert(size <= read_buff_content_size_ - read_buff_off_);
  10751. read_buff_off_ += size;
  10752. }
  10753. inline bool SocketStream::is_peer_alive() const {
  10754. return detail::is_socket_alive(sock_);
  10755. }
  10756. inline ssize_t SocketStream::read(char *ptr, size_t size) {
  10757. #ifdef _WIN32
  10758. size =
  10759. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10760. #else
  10761. size = (std::min)(size,
  10762. static_cast<size_t>((std::numeric_limits<ssize_t>::max)()));
  10763. #endif
  10764. if (read_buff_off_ < read_buff_content_size_) {
  10765. auto remaining_size = read_buff_content_size_ - read_buff_off_;
  10766. if (size <= remaining_size) {
  10767. memcpy(ptr, read_buff_.data() + read_buff_off_, size);
  10768. read_buff_off_ += size;
  10769. return static_cast<ssize_t>(size);
  10770. } else {
  10771. memcpy(ptr, read_buff_.data() + read_buff_off_, remaining_size);
  10772. read_buff_off_ += remaining_size;
  10773. return static_cast<ssize_t>(remaining_size);
  10774. }
  10775. }
  10776. if (!ensure_readable()) {
  10777. error_ = Error::Timeout;
  10778. return -1;
  10779. }
  10780. read_buff_off_ = 0;
  10781. read_buff_content_size_ = 0;
  10782. if (size < read_buff_size_) {
  10783. auto n = read_socket(sock_, read_buff_.data(), read_buff_size_,
  10784. CPPHTTPLIB_RECV_FLAGS);
  10785. if (n <= 0) {
  10786. if (n == 0) {
  10787. error_ = Error::ConnectionClosed;
  10788. } else {
  10789. error_ = Error::Read;
  10790. }
  10791. return n;
  10792. } else if (n <= static_cast<ssize_t>(size)) {
  10793. memcpy(ptr, read_buff_.data(), static_cast<size_t>(n));
  10794. return n;
  10795. } else {
  10796. memcpy(ptr, read_buff_.data(), size);
  10797. read_buff_off_ = size;
  10798. read_buff_content_size_ = static_cast<size_t>(n);
  10799. return static_cast<ssize_t>(size);
  10800. }
  10801. } else {
  10802. auto n = read_socket(sock_, ptr, size, CPPHTTPLIB_RECV_FLAGS);
  10803. if (n <= 0) {
  10804. if (n == 0) {
  10805. error_ = Error::ConnectionClosed;
  10806. } else {
  10807. error_ = Error::Read;
  10808. }
  10809. }
  10810. return n;
  10811. }
  10812. }
  10813. inline ssize_t SocketStream::write(const char *ptr, size_t size) {
  10814. if (!wait_writable()) { return -1; }
  10815. #if defined(_WIN32) && !defined(_WIN64)
  10816. size =
  10817. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10818. #endif
  10819. return send_socket(sock_, ptr, size, CPPHTTPLIB_SEND_FLAGS);
  10820. }
  10821. inline void SocketStream::get_remote_ip_and_port(std::string &ip,
  10822. int &port) const {
  10823. return detail::get_remote_ip_and_port(sock_, ip, port);
  10824. }
  10825. inline void SocketStream::get_local_ip_and_port(std::string &ip,
  10826. int &port) const {
  10827. return detail::get_local_ip_and_port(sock_, ip, port);
  10828. }
  10829. inline socket_t SocketStream::socket() const { return sock_; }
  10830. inline time_t SocketStream::duration() const {
  10831. return static_cast<time_t>(
  10832. std::chrono::duration_cast<std::chrono::milliseconds>(
  10833. std::chrono::steady_clock::now() - start_time_)
  10834. .count());
  10835. }
  10836. inline void SocketStream::set_read_timeout(time_t sec, time_t usec) {
  10837. read_timeout_sec_ = sec;
  10838. read_timeout_usec_ = usec;
  10839. }
  10840. inline void SocketStream::set_max_timeout(time_t msec) {
  10841. max_timeout_msec_ = msec;
  10842. start_time_ = std::chrono::steady_clock::now();
  10843. }
  10844. inline void
  10845. SocketStream::set_read_interrupt(std::function<bool()> interrupted) {
  10846. read_interrupted_ = std::move(interrupted);
  10847. }
  10848. // Buffer stream implementation
  10849. inline bool BufferStream::is_readable() const { return true; }
  10850. inline bool BufferStream::wait_readable() const { return true; }
  10851. inline bool BufferStream::wait_writable() const { return true; }
  10852. inline ssize_t BufferStream::read(char *ptr, size_t size) {
  10853. #if defined(_MSC_VER) && _MSC_VER < 1910
  10854. auto len_read = buffer._Copy_s(ptr, size, size, position);
  10855. #else
  10856. auto len_read = buffer.copy(ptr, size, position);
  10857. #endif
  10858. position += static_cast<size_t>(len_read);
  10859. return static_cast<ssize_t>(len_read);
  10860. }
  10861. inline ssize_t BufferStream::write(const char *ptr, size_t size) {
  10862. buffer.append(ptr, size);
  10863. return static_cast<ssize_t>(size);
  10864. }
  10865. inline void BufferStream::get_remote_ip_and_port(std::string & /*ip*/,
  10866. int & /*port*/) const {}
  10867. inline void BufferStream::get_local_ip_and_port(std::string & /*ip*/,
  10868. int & /*port*/) const {}
  10869. inline socket_t BufferStream::socket() const { return 0; }
  10870. inline time_t BufferStream::duration() const { return 0; }
  10871. inline const std::string &BufferStream::get_buffer() const { return buffer; }
  10872. inline PathParamsMatcher::PathParamsMatcher(const std::string &pattern)
  10873. : MatcherBase(pattern) {
  10874. constexpr const char marker[] = "/:";
  10875. // One past the last ending position of a path param substring
  10876. std::size_t last_param_end = 0;
  10877. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10878. // Needed to ensure that parameter names are unique during matcher
  10879. // construction
  10880. // If exceptions are disabled, only last duplicate path
  10881. // parameter will be set
  10882. std::unordered_set<std::string> param_name_set;
  10883. #endif
  10884. while (true) {
  10885. const auto marker_pos = pattern.find(
  10886. marker, last_param_end == 0 ? last_param_end : last_param_end - 1);
  10887. if (marker_pos == std::string::npos) { break; }
  10888. static_fragments_.push_back(
  10889. pattern.substr(last_param_end, marker_pos - last_param_end + 1));
  10890. const auto param_name_start = marker_pos + str_len(marker);
  10891. auto sep_pos = pattern.find(separator, param_name_start);
  10892. if (sep_pos == std::string::npos) { sep_pos = pattern.length(); }
  10893. auto param_name =
  10894. pattern.substr(param_name_start, sep_pos - param_name_start);
  10895. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10896. if (param_name_set.find(param_name) != param_name_set.cend()) {
  10897. std::string msg = "Encountered path parameter '" + param_name +
  10898. "' multiple times in route pattern '" + pattern + "'.";
  10899. throw std::invalid_argument(msg);
  10900. }
  10901. #endif
  10902. param_names_.push_back(std::move(param_name));
  10903. last_param_end = sep_pos + 1;
  10904. }
  10905. if (last_param_end < pattern.length()) {
  10906. static_fragments_.push_back(pattern.substr(last_param_end));
  10907. }
  10908. }
  10909. inline bool PathParamsMatcher::match(Request &request) const {
  10910. request.matches = std::smatch();
  10911. request.path_params.clear();
  10912. // A pattern without parameters is just a literal path to compare against
  10913. if (param_names_.empty()) { return request.path == pattern(); }
  10914. request.path_params.reserve(param_names_.size());
  10915. // One past the position at which the path matched the pattern last time
  10916. std::size_t starting_pos = 0;
  10917. for (size_t i = 0; i < static_fragments_.size(); ++i) {
  10918. const auto &fragment = static_fragments_[i];
  10919. if (starting_pos + fragment.length() > request.path.length()) {
  10920. return false;
  10921. }
  10922. // Avoid unnecessary allocation by using strncmp instead of substr +
  10923. // comparison
  10924. if (std::strncmp(request.path.c_str() + starting_pos, fragment.c_str(),
  10925. fragment.length()) != 0) {
  10926. return false;
  10927. }
  10928. starting_pos += fragment.length();
  10929. // Should only happen when we have a static fragment after a param
  10930. // Example: '/users/:id/subscriptions'
  10931. // The 'subscriptions' fragment here does not have a corresponding param
  10932. if (i >= param_names_.size()) { continue; }
  10933. auto sep_pos = request.path.find(separator, starting_pos);
  10934. if (sep_pos == std::string::npos) { sep_pos = request.path.length(); }
  10935. const auto &param_name = param_names_[i];
  10936. request.path_params.emplace(
  10937. param_name, request.path.substr(starting_pos, sep_pos - starting_pos));
  10938. // Mark everything up to '/' as matched
  10939. starting_pos = sep_pos + 1;
  10940. }
  10941. // Returns false if the path is longer than the pattern
  10942. return starting_pos >= request.path.length();
  10943. }
  10944. inline bool RegexMatcher::match(Request &request) const {
  10945. request.path_params.clear();
  10946. // See CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH: an overlong path is treated as
  10947. // a non-match rather than risking a stack overflow in std::regex_match.
  10948. if (request.path.length() > CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH) {
  10949. return false;
  10950. }
  10951. return std::regex_match(request.path, request.matches, regex_);
  10952. }
  10953. // Enclose IPv6 address in brackets if needed
  10954. inline std::string prepare_host_string(const std::string &host) {
  10955. // Enclose IPv6 address in brackets (but not if already enclosed)
  10956. if (host.find(':') == std::string::npos ||
  10957. (!host.empty() && host[0] == '[')) {
  10958. // IPv4, hostname, or already bracketed IPv6
  10959. return host;
  10960. } else {
  10961. // IPv6 address without brackets
  10962. return "[" + host + "]";
  10963. }
  10964. }
  10965. inline std::string make_host_and_port_string(const std::string &host, int port,
  10966. bool is_ssl) {
  10967. auto result = prepare_host_string(host);
  10968. // Append port if not default
  10969. if ((!is_ssl && port == 80) || (is_ssl && port == 443)) {
  10970. ; // do nothing
  10971. } else {
  10972. result += ":" + std::to_string(port);
  10973. }
  10974. return result;
  10975. }
  10976. // Create "host:port" string always including port number (for CONNECT method)
  10977. inline std::string
  10978. make_host_and_port_string_always_port(const std::string &host, int port) {
  10979. return prepare_host_string(host) + ":" + std::to_string(port);
  10980. }
  10981. // Value for the Host header a client sends when the caller supplied none.
  10982. // Only the value: callers decide where in their header list it goes.
  10983. inline std::string make_default_host_header_value(const std::string &host,
  10984. int port, bool is_ssl,
  10985. int address_family) {
  10986. if (address_family == AF_UNIX) { return "localhost"; }
  10987. return make_host_and_port_string(host, port, is_ssl);
  10988. }
  10989. inline void add_default_user_agent_header(Request &req) {
  10990. #ifndef CPPHTTPLIB_NO_DEFAULT_USER_AGENT
  10991. if (!req.has_header("User-Agent")) {
  10992. req.set_header("User-Agent",
  10993. std::string("cpp-httplib/") + CPPHTTPLIB_VERSION);
  10994. }
  10995. #else
  10996. (void)req;
  10997. #endif
  10998. }
  10999. bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out);
  11000. NormalizedTarget normalize_target(const std::string &host);
  11001. bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits);
  11002. bool host_matches_no_proxy(const NormalizedTarget &target,
  11003. const std::vector<NoProxyEntry> &entries);
  11004. inline bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits) {
  11005. if (prefix_bits < 0 || prefix_bits > 128) { return false; }
  11006. if (prefix_bits == 0) { return true; }
  11007. int full_bytes = prefix_bits / 8;
  11008. int rem_bits = prefix_bits % 8;
  11009. if (full_bytes > 0 && std::memcmp(ip.data(), net.data(),
  11010. static_cast<size_t>(full_bytes)) != 0) {
  11011. return false;
  11012. }
  11013. if (rem_bits == 0) { return true; }
  11014. auto i = static_cast<size_t>(full_bytes);
  11015. auto mask = static_cast<uint8_t>(0xFFu << (8 - rem_bits));
  11016. return (ip[i] & mask) == (net[i] & mask);
  11017. }
  11018. inline bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out) {
  11019. if (token.empty()) { return false; }
  11020. if (token == "*") {
  11021. out.kind = NoProxyKind::Wildcard;
  11022. return true;
  11023. }
  11024. auto slash = token.find('/');
  11025. std::string addr_part =
  11026. (slash == std::string::npos) ? token : token.substr(0, slash);
  11027. std::string prefix_part =
  11028. (slash == std::string::npos) ? std::string() : token.substr(slash + 1);
  11029. // A bare slash or trailing-slash CIDR like "10.0.0.0/" is malformed;
  11030. // don't silently treat it as a /32 (or /128).
  11031. if (slash != std::string::npos && prefix_part.empty()) { return false; }
  11032. // Accept the bracketed IPv6 form ("[::1]", "[fe80::]/10") as well as the
  11033. // bare form. Brackets have no meaning for IPv4, so skip the IPv4 attempt
  11034. // when brackets are present.
  11035. bool bracketed = addr_part.size() >= 2 && addr_part.front() == '[' &&
  11036. addr_part.back() == ']';
  11037. if (bracketed) { addr_part = addr_part.substr(1, addr_part.size() - 2); }
  11038. if (!bracketed) {
  11039. struct in_addr v4;
  11040. if (inet_pton(AF_INET, addr_part.c_str(), &v4) == 1) {
  11041. int prefix = 32;
  11042. if (!prefix_part.empty() &&
  11043. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 32,
  11044. prefix)) {
  11045. return false;
  11046. }
  11047. out.kind = NoProxyKind::IPv4Cidr;
  11048. std::memcpy(out.net.data(), &v4, sizeof(v4));
  11049. out.prefix_bits = prefix;
  11050. return true;
  11051. }
  11052. }
  11053. struct in6_addr v6;
  11054. if (inet_pton(AF_INET6, addr_part.c_str(), &v6) == 1) {
  11055. int prefix = 128;
  11056. if (!prefix_part.empty() &&
  11057. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 128,
  11058. prefix)) {
  11059. return false;
  11060. }
  11061. out.kind = NoProxyKind::IPv6Cidr;
  11062. std::memcpy(out.net.data(), &v6, sizeof(v6));
  11063. out.prefix_bits = prefix;
  11064. return true;
  11065. }
  11066. // Bracketed entries can only be IPv6. If the IPv6 parse above failed,
  11067. // the entry is malformed — don't fall through to the hostname branch.
  11068. if (bracketed) { return false; }
  11069. // A '/' on a non-IP token means a CIDR prefix without an address. Reject.
  11070. if (slash != std::string::npos) { return false; }
  11071. // Port-specific entries (host:port) are not supported.
  11072. if (token.find(':') != std::string::npos) { return false; }
  11073. std::string hostname = case_ignore::to_lower(token);
  11074. while (!hostname.empty() && hostname.front() == '.') {
  11075. hostname.erase(hostname.begin());
  11076. }
  11077. while (!hostname.empty() && hostname.back() == '.') {
  11078. hostname.pop_back();
  11079. }
  11080. if (hostname.empty()) { return false; }
  11081. out.kind = NoProxyKind::HostnameSuffix;
  11082. out.hostname_pattern = std::move(hostname);
  11083. return true;
  11084. }
  11085. inline std::vector<NoProxyEntry>
  11086. parse_no_proxy_entries(const std::vector<std::string> &patterns) {
  11087. std::vector<NoProxyEntry> entries;
  11088. entries.reserve(patterns.size());
  11089. for (const auto &p : patterns) {
  11090. auto trimmed = trim_copy(p);
  11091. if (trimmed.empty()) { continue; }
  11092. NoProxyEntry entry;
  11093. if (parse_no_proxy_entry(trimmed, entry)) {
  11094. entries.push_back(std::move(entry));
  11095. }
  11096. }
  11097. return entries;
  11098. }
  11099. inline NormalizedTarget normalize_target(const std::string &host) {
  11100. NormalizedTarget t;
  11101. std::string h = host;
  11102. if (h.size() >= 2 && h.front() == '[' && h.back() == ']') {
  11103. h = h.substr(1, h.size() - 2);
  11104. }
  11105. // Strip a single trailing dot so "example.com." canonicalizes to
  11106. // "example.com".
  11107. if (!h.empty() && h.back() == '.') { h.pop_back(); }
  11108. t.hostname = case_ignore::to_lower(h);
  11109. if (!t.hostname.empty()) {
  11110. struct in_addr v4;
  11111. struct in6_addr v6;
  11112. if (inet_pton(AF_INET, t.hostname.c_str(), &v4) == 1) {
  11113. t.is_ipv4 = true;
  11114. std::memcpy(t.ip.data(), &v4, sizeof(v4));
  11115. } else if (inet_pton(AF_INET6, t.hostname.c_str(), &v6) == 1) {
  11116. t.is_ipv6 = true;
  11117. std::memcpy(t.ip.data(), &v6, sizeof(v6));
  11118. }
  11119. }
  11120. return t;
  11121. }
  11122. inline bool host_matches_no_proxy(const NormalizedTarget &target,
  11123. const std::vector<NoProxyEntry> &entries) {
  11124. if (target.hostname.empty()) { return false; }
  11125. for (const auto &e : entries) {
  11126. switch (e.kind) {
  11127. case NoProxyKind::Wildcard: return true;
  11128. case NoProxyKind::IPv4Cidr:
  11129. if (target.is_ipv4 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  11130. return true;
  11131. }
  11132. break;
  11133. case NoProxyKind::IPv6Cidr:
  11134. if (target.is_ipv6 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  11135. return true;
  11136. }
  11137. break;
  11138. case NoProxyKind::HostnameSuffix:
  11139. if (target.is_ipv4 || target.is_ipv6) { break; }
  11140. if (target.hostname == e.hostname_pattern) { return true; }
  11141. // Dot-boundary suffix match: prevents "evilexample.com" from matching
  11142. // an entry of "example.com".
  11143. if (target.hostname.size() > e.hostname_pattern.size() + 1) {
  11144. auto offset = target.hostname.size() - e.hostname_pattern.size();
  11145. if (target.hostname[offset - 1] == '.' &&
  11146. target.hostname.compare(offset, e.hostname_pattern.size(),
  11147. e.hostname_pattern) == 0) {
  11148. return true;
  11149. }
  11150. }
  11151. break;
  11152. }
  11153. }
  11154. return false;
  11155. }
  11156. template <typename T>
  11157. inline bool check_and_write_headers(Stream &strm, Headers &headers,
  11158. T header_writer, Error &error) {
  11159. for (const auto &h : headers) {
  11160. if (!detail::fields::is_field_valid(h.first, h.second)) {
  11161. error = Error::InvalidHeaders;
  11162. return false;
  11163. }
  11164. }
  11165. if (header_writer(strm, headers) <= 0) {
  11166. error = Error::Write;
  11167. return false;
  11168. }
  11169. return true;
  11170. }
  11171. } // namespace detail
  11172. /*
  11173. * Group 2 (continued): detail namespace - SSLSocketStream implementation
  11174. */
  11175. #ifdef CPPHTTPLIB_SSL_ENABLED
  11176. namespace detail {
  11177. // SSL socket stream implementation
  11178. inline SSLSocketStream::SSLSocketStream(
  11179. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  11180. time_t read_timeout_usec, time_t write_timeout_sec,
  11181. time_t write_timeout_usec, time_t max_timeout_msec,
  11182. std::chrono::time_point<std::chrono::steady_clock> start_time)
  11183. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  11184. read_timeout_usec_(read_timeout_usec),
  11185. write_timeout_sec_(write_timeout_sec),
  11186. write_timeout_usec_(write_timeout_usec),
  11187. max_timeout_msec_(max_timeout_msec), start_time_(start_time) {
  11188. tls_error_.code = tls::ErrorCode::Success;
  11189. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  11190. // Clear AUTO_RETRY for proper non-blocking I/O timeout handling
  11191. // Note: create_session() also clears this, but SSLClient currently
  11192. // uses ssl_new() which does not. Until full TLS API migration is complete,
  11193. // we need to ensure AUTO_RETRY is cleared here regardless of how the
  11194. // SSL session was created.
  11195. SSL_clear_mode(static_cast<SSL *>(session), SSL_MODE_AUTO_RETRY);
  11196. #endif
  11197. }
  11198. inline SSLSocketStream::~SSLSocketStream() = default;
  11199. inline bool SSLSocketStream::is_readable() const {
  11200. return tls::pending(session_) > 0;
  11201. }
  11202. inline bool SSLSocketStream::wait_readable() const {
  11203. if (max_timeout_msec_ <= 0) {
  11204. return select_read_interruptible(sock_, read_timeout_sec_,
  11205. read_timeout_usec_, read_interrupted_) > 0;
  11206. }
  11207. time_t read_timeout_sec;
  11208. time_t read_timeout_usec;
  11209. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  11210. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  11211. return select_read_interruptible(sock_, read_timeout_sec, read_timeout_usec,
  11212. read_interrupted_) > 0;
  11213. }
  11214. inline bool SSLSocketStream::wait_writable() const {
  11215. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0 &&
  11216. !tls::is_peer_closed(session_, sock_);
  11217. }
  11218. inline bool SSLSocketStream::ensure_readable() {
  11219. if (readable_hint_) {
  11220. readable_hint_ = false;
  11221. return true;
  11222. }
  11223. return wait_readable();
  11224. }
  11225. inline bool SSLSocketStream::is_peer_alive() const {
  11226. return !tls::is_peer_closed(session_, sock_);
  11227. }
  11228. inline ssize_t SSLSocketStream::read(char *ptr, size_t size) {
  11229. if (tls::pending(session_) > 0) {
  11230. tls::TlsError err;
  11231. auto ret = tls::read(session_, ptr, size, err);
  11232. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11233. error_ = Error::ConnectionClosed;
  11234. } else if (ret < 0) {
  11235. tls_error_ = err;
  11236. }
  11237. return ret;
  11238. } else if (ensure_readable()) {
  11239. tls::TlsError err;
  11240. auto ret = tls::read(session_, ptr, size, err);
  11241. if (ret < 0) {
  11242. auto n = 1000;
  11243. #ifdef _WIN32
  11244. while (--n >= 0 && (err.code == tls::ErrorCode::WantRead ||
  11245. (err.code == tls::ErrorCode::SyscallError &&
  11246. WSAGetLastError() == WSAETIMEDOUT))) {
  11247. #else
  11248. while (--n >= 0 && err.code == tls::ErrorCode::WantRead) {
  11249. #endif
  11250. if (tls::pending(session_) > 0) {
  11251. ret = tls::read(session_, ptr, size, err);
  11252. if (ret >= 0) { return ret; }
  11253. break;
  11254. } else if (wait_readable()) {
  11255. std::this_thread::sleep_for(std::chrono::microseconds{10});
  11256. ret = tls::read(session_, ptr, size, err);
  11257. if (ret >= 0) { return ret; }
  11258. } else {
  11259. break;
  11260. }
  11261. }
  11262. assert(ret < 0);
  11263. tls_error_ = err;
  11264. } else if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11265. error_ = Error::ConnectionClosed;
  11266. }
  11267. return ret;
  11268. } else {
  11269. error_ = Error::Timeout;
  11270. return -1;
  11271. }
  11272. }
  11273. inline ssize_t SSLSocketStream::write(const char *ptr, size_t size) {
  11274. if (wait_writable()) {
  11275. auto handle_size =
  11276. std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11277. tls::TlsError err;
  11278. auto ret = tls::write(session_, ptr, handle_size, err);
  11279. if (ret < 0) {
  11280. auto n = 1000;
  11281. #ifdef _WIN32
  11282. while (--n >= 0 && (err.code == tls::ErrorCode::WantWrite ||
  11283. (err.code == tls::ErrorCode::SyscallError &&
  11284. WSAGetLastError() == WSAETIMEDOUT))) {
  11285. #else
  11286. while (--n >= 0 && err.code == tls::ErrorCode::WantWrite) {
  11287. #endif
  11288. if (wait_writable()) {
  11289. std::this_thread::sleep_for(std::chrono::microseconds{10});
  11290. ret = tls::write(session_, ptr, handle_size, err);
  11291. if (ret >= 0) { return ret; }
  11292. } else {
  11293. break;
  11294. }
  11295. }
  11296. assert(ret < 0);
  11297. tls_error_ = err;
  11298. }
  11299. return ret;
  11300. }
  11301. return -1;
  11302. }
  11303. inline void SSLSocketStream::get_remote_ip_and_port(std::string &ip,
  11304. int &port) const {
  11305. detail::get_remote_ip_and_port(sock_, ip, port);
  11306. }
  11307. inline void SSLSocketStream::get_local_ip_and_port(std::string &ip,
  11308. int &port) const {
  11309. detail::get_local_ip_and_port(sock_, ip, port);
  11310. }
  11311. inline socket_t SSLSocketStream::socket() const { return sock_; }
  11312. inline time_t SSLSocketStream::duration() const {
  11313. return static_cast<time_t>(
  11314. std::chrono::duration_cast<std::chrono::milliseconds>(
  11315. std::chrono::steady_clock::now() - start_time_)
  11316. .count());
  11317. }
  11318. inline void SSLSocketStream::set_read_timeout(time_t sec, time_t usec) {
  11319. read_timeout_sec_ = sec;
  11320. read_timeout_usec_ = usec;
  11321. }
  11322. inline void SSLSocketStream::set_max_timeout(time_t msec) {
  11323. max_timeout_msec_ = msec;
  11324. start_time_ = std::chrono::steady_clock::now();
  11325. }
  11326. inline void
  11327. SSLSocketStream::set_read_interrupt(std::function<bool()> interrupted) {
  11328. read_interrupted_ = std::move(interrupted);
  11329. }
  11330. inline WebSocketSSLStream::WebSocketSSLStream(socket_t sock,
  11331. tls::session_t session,
  11332. time_t read_timeout_sec,
  11333. time_t read_timeout_usec,
  11334. time_t write_timeout_sec,
  11335. time_t write_timeout_usec)
  11336. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  11337. read_timeout_usec_(read_timeout_usec),
  11338. write_timeout_sec_(write_timeout_sec),
  11339. write_timeout_usec_(write_timeout_usec),
  11340. start_time_(std::chrono::steady_clock::now()) {
  11341. // The receive and send paths run on different threads, so each TLS call is
  11342. // driven in non-blocking mode and readiness is awaited with select()
  11343. // outside the session lock. Set the socket non-blocking once here; it is
  11344. // never flipped back, so no thread races on the flag.
  11345. detail::set_nonblocking(sock_, true);
  11346. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  11347. SSL_clear_mode(static_cast<SSL *>(session_), SSL_MODE_AUTO_RETRY);
  11348. #endif
  11349. }
  11350. inline WebSocketSSLStream::~WebSocketSSLStream() = default;
  11351. inline bool WebSocketSSLStream::is_readable() const {
  11352. std::lock_guard<std::mutex> guard(session_mutex_);
  11353. return tls::pending(session_) > 0;
  11354. }
  11355. inline bool WebSocketSSLStream::wait_readable() const {
  11356. return select_read_interruptible(sock_, read_timeout_sec_, read_timeout_usec_,
  11357. read_interrupted_) > 0;
  11358. }
  11359. inline bool WebSocketSSLStream::wait_writable() const {
  11360. // Unlike SSLSocketStream, this deliberately does not call is_peer_closed():
  11361. // that probe toggles the socket's blocking flag, which would race with the
  11362. // concurrent reader on a permanently non-blocking socket.
  11363. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  11364. }
  11365. inline ssize_t WebSocketSSLStream::read(char *ptr, size_t size) {
  11366. tls::TlsError err;
  11367. auto n = 1000;
  11368. while (--n >= 0) {
  11369. {
  11370. std::lock_guard<std::mutex> guard(session_mutex_);
  11371. auto ret = tls::read(session_, ptr, size, err);
  11372. if (ret > 0) { return ret; }
  11373. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11374. error_ = Error::ConnectionClosed;
  11375. return ret;
  11376. }
  11377. }
  11378. // ret < 0. On a non-blocking socket a TLS read can stop needing either
  11379. // direction: the send path shares this session, so output it left pending
  11380. // has to be flushed before more input can be decrypted. Anything else is
  11381. // a hard error.
  11382. auto needs_readable = err.code == tls::ErrorCode::WantRead;
  11383. #ifdef _WIN32
  11384. // On Windows a socket timeout surfaces as a syscall error, not WantRead.
  11385. needs_readable =
  11386. needs_readable || (err.code == tls::ErrorCode::SyscallError &&
  11387. WSAGetLastError() == WSAETIMEDOUT);
  11388. #endif
  11389. if (!needs_readable && err.code != tls::ErrorCode::WantWrite) {
  11390. error_ = Error::Read;
  11391. return -1;
  11392. }
  11393. if (!(needs_readable ? wait_readable() : wait_writable())) {
  11394. error_ = Error::Timeout;
  11395. return -1;
  11396. }
  11397. }
  11398. // Out of retries. Recording a reason matters: a caller that reads get_error()
  11399. // to tell a timeout from a close would otherwise see whatever the previous
  11400. // failure left behind (error_ is never cleared on success).
  11401. error_ = Error::Read;
  11402. return -1;
  11403. }
  11404. inline ssize_t WebSocketSSLStream::write(const char *ptr, size_t size) {
  11405. auto handle_size = std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11406. tls::TlsError err;
  11407. auto n = 1000;
  11408. while (--n >= 0) {
  11409. {
  11410. std::lock_guard<std::mutex> guard(session_mutex_);
  11411. auto ret = tls::write(session_, ptr, handle_size, err);
  11412. if (ret >= 0) { return ret; }
  11413. }
  11414. // ret < 0. As in read(), either direction can be needed: a renegotiation
  11415. // or a post-handshake message must be consumed before the record goes
  11416. // out. Anything else is a hard error.
  11417. auto needs_writable = err.code == tls::ErrorCode::WantWrite;
  11418. #ifdef _WIN32
  11419. // On Windows a socket timeout surfaces as a syscall error, not WantWrite.
  11420. needs_writable =
  11421. needs_writable || (err.code == tls::ErrorCode::SyscallError &&
  11422. WSAGetLastError() == WSAETIMEDOUT);
  11423. #endif
  11424. if (!needs_writable && err.code != tls::ErrorCode::WantRead) { return -1; }
  11425. if (!(needs_writable ? wait_writable() : wait_readable())) { return -1; }
  11426. }
  11427. return -1;
  11428. }
  11429. inline void WebSocketSSLStream::get_remote_ip_and_port(std::string &ip,
  11430. int &port) const {
  11431. detail::get_remote_ip_and_port(sock_, ip, port);
  11432. }
  11433. inline void WebSocketSSLStream::get_local_ip_and_port(std::string &ip,
  11434. int &port) const {
  11435. detail::get_local_ip_and_port(sock_, ip, port);
  11436. }
  11437. inline socket_t WebSocketSSLStream::socket() const { return sock_; }
  11438. inline time_t WebSocketSSLStream::duration() const {
  11439. return static_cast<time_t>(
  11440. std::chrono::duration_cast<std::chrono::milliseconds>(
  11441. std::chrono::steady_clock::now() - start_time_)
  11442. .count());
  11443. }
  11444. inline void WebSocketSSLStream::set_read_timeout(time_t sec, time_t usec) {
  11445. read_timeout_sec_ = sec;
  11446. read_timeout_usec_ = usec;
  11447. }
  11448. inline void
  11449. WebSocketSSLStream::set_read_interrupt(std::function<bool()> interrupted) {
  11450. read_interrupted_ = std::move(interrupted);
  11451. }
  11452. } // namespace detail
  11453. #endif // CPPHTTPLIB_SSL_ENABLED
  11454. /*
  11455. * Group 4: Server implementation
  11456. */
  11457. // HTTP server implementation
  11458. inline Server::Server()
  11459. : new_task_queue([] {
  11460. return new ThreadPool(CPPHTTPLIB_THREAD_POOL_COUNT,
  11461. CPPHTTPLIB_THREAD_POOL_MAX_COUNT);
  11462. }) {
  11463. #ifndef _WIN32
  11464. signal(SIGPIPE, SIG_IGN);
  11465. #endif
  11466. }
  11467. inline Server::~Server() = default;
  11468. inline std::unique_ptr<detail::MatcherBase>
  11469. Server::make_matcher(const std::string &pattern) {
  11470. // Path params take precedence, so "/users/:id/(.*)" keeps being matched as
  11471. // a path params pattern
  11472. if (pattern.find("/:") != std::string::npos) {
  11473. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11474. }
  11475. // A pattern with no regex metacharacter only has to be compared literally,
  11476. // which is what PathParamsMatcher already does when it captures no
  11477. // parameter, so std::regex is only worth building for the patterns that
  11478. // actually need it
  11479. if (pattern.find_first_of(".^$|()[]{}*+?\\") == std::string::npos) {
  11480. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11481. }
  11482. return detail::make_unique<detail::RegexMatcher>(pattern);
  11483. }
  11484. inline Server &Server::Get(const std::string &pattern, Handler handler) {
  11485. return add_handler(get_handlers_, pattern, std::move(handler));
  11486. }
  11487. inline Server &Server::Post(const std::string &pattern, Handler handler) {
  11488. return add_handler(post_handlers_, pattern, std::move(handler));
  11489. }
  11490. inline Server &Server::Post(const std::string &pattern,
  11491. HandlerWithContentReader handler) {
  11492. return add_handler(post_handlers_for_content_reader_, pattern,
  11493. std::move(handler));
  11494. }
  11495. inline Server &Server::Put(const std::string &pattern, Handler handler) {
  11496. return add_handler(put_handlers_, pattern, std::move(handler));
  11497. }
  11498. inline Server &Server::Put(const std::string &pattern,
  11499. HandlerWithContentReader handler) {
  11500. return add_handler(put_handlers_for_content_reader_, pattern,
  11501. std::move(handler));
  11502. }
  11503. inline Server &Server::Patch(const std::string &pattern, Handler handler) {
  11504. return add_handler(patch_handlers_, pattern, std::move(handler));
  11505. }
  11506. inline Server &Server::Patch(const std::string &pattern,
  11507. HandlerWithContentReader handler) {
  11508. return add_handler(patch_handlers_for_content_reader_, pattern,
  11509. std::move(handler));
  11510. }
  11511. inline Server &Server::Delete(const std::string &pattern, Handler handler) {
  11512. return add_handler(delete_handlers_, pattern, std::move(handler));
  11513. }
  11514. inline Server &Server::Delete(const std::string &pattern,
  11515. HandlerWithContentReader handler) {
  11516. return add_handler(delete_handlers_for_content_reader_, pattern,
  11517. std::move(handler));
  11518. }
  11519. inline Server &Server::Options(const std::string &pattern, Handler handler) {
  11520. return add_handler(options_handlers_, pattern, std::move(handler));
  11521. }
  11522. inline const std::set<std::string> &Server::builtin_methods() {
  11523. thread_local const std::set<std::string> methods{
  11524. "GET", "HEAD", "POST", "PUT", "DELETE",
  11525. "CONNECT", "OPTIONS", "TRACE", "PATCH", "PRI"};
  11526. return methods;
  11527. }
  11528. inline Server::CustomHandlerEntry *
  11529. Server::custom_entry_for_registration(const std::string &method) {
  11530. // Built-in methods are refused for two different reasons. GET, HEAD, POST,
  11531. // PUT, DELETE, OPTIONS and PATCH are dispatched by the if/else chain in
  11532. // routing() before the custom tables are consulted, so a route registered
  11533. // for one of them could never fire. CONNECT, TRACE and PRI have no branch
  11534. // there and would be reachable, but they carry protocol-level meaning
  11535. // (tunnel setup, request echo, the HTTP/2 connection preface) that this
  11536. // library does not route.
  11537. if (!detail::fields::is_token(method) || builtin_methods().count(method)) {
  11538. output_error_log(Error::InvalidHTTPMethod, nullptr);
  11539. has_invalid_registration_ = true;
  11540. return nullptr;
  11541. }
  11542. return &custom_handlers_[method];
  11543. }
  11544. inline Server &Server::CustomRoute(const std::string &method,
  11545. const std::string &pattern,
  11546. Handler handler) {
  11547. auto *entry = custom_entry_for_registration(method);
  11548. if (!entry) { return *this; }
  11549. return add_handler(entry->handlers, pattern, std::move(handler));
  11550. }
  11551. inline Server &Server::CustomRoute(const std::string &method,
  11552. const std::string &pattern,
  11553. HandlerWithContentReader handler) {
  11554. auto *entry = custom_entry_for_registration(method);
  11555. if (!entry) { return *this; }
  11556. return add_handler(entry->handlers_for_content_reader, pattern,
  11557. std::move(handler));
  11558. }
  11559. inline const Server::CustomHandlerEntry *
  11560. Server::find_custom_entry(const std::string &method) const {
  11561. // find() alone would be correct here. The empty() check is what keeps the
  11562. // per-request cost off servers that never call CustomRoute(), which is the
  11563. // overwhelmingly common case; keep it rather than walking into the tree.
  11564. if (custom_handlers_.empty()) { return nullptr; }
  11565. auto it = custom_handlers_.find(method);
  11566. return it == custom_handlers_.end() ? nullptr : &it->second;
  11567. }
  11568. inline Server &Server::WebSocket(const std::string &pattern,
  11569. WebSocketHandler handler) {
  11570. websocket_handlers_.push_back(
  11571. {make_matcher(pattern), std::move(handler), nullptr});
  11572. return *this;
  11573. }
  11574. inline Server &Server::WebSocket(const std::string &pattern,
  11575. WebSocketHandler handler,
  11576. SubProtocolSelector sub_protocol_selector) {
  11577. websocket_handlers_.push_back({make_matcher(pattern), std::move(handler),
  11578. std::move(sub_protocol_selector)});
  11579. return *this;
  11580. }
  11581. inline bool Server::set_base_dir(const std::string &dir,
  11582. const std::string &mount_point) {
  11583. return set_mount_point(mount_point, dir);
  11584. }
  11585. inline bool Server::set_mount_point(const std::string &mount_point,
  11586. const std::string &dir, Headers headers) {
  11587. detail::FileStat stat(dir);
  11588. if (stat.is_dir()) {
  11589. std::string mnt = !mount_point.empty() ? mount_point : "/";
  11590. if (!mnt.empty() && mnt[0] == '/') {
  11591. // Without the resolved directory, a file could not be checked to be
  11592. // inside it.
  11593. std::string resolved_base;
  11594. if (!detail::canonicalize_path(dir.c_str(), resolved_base)) {
  11595. return false;
  11596. }
  11597. #if defined(_WIN32)
  11598. if (resolved_base.back() != '\\' && resolved_base.back() != '/') {
  11599. resolved_base += '\\';
  11600. }
  11601. #else
  11602. if (resolved_base.back() != '/') { resolved_base += '/'; }
  11603. #endif
  11604. base_dirs_.push_back(
  11605. {std::move(mnt), dir, std::move(resolved_base), std::move(headers)});
  11606. return true;
  11607. }
  11608. }
  11609. return false;
  11610. }
  11611. inline bool Server::remove_mount_point(const std::string &mount_point) {
  11612. for (auto it = base_dirs_.begin(); it != base_dirs_.end(); ++it) {
  11613. if (it->mount_point == mount_point) {
  11614. base_dirs_.erase(it);
  11615. return true;
  11616. }
  11617. }
  11618. return false;
  11619. }
  11620. inline Server &
  11621. Server::set_file_extension_and_mimetype_mapping(const std::string &ext,
  11622. const std::string &mime) {
  11623. file_extension_and_mimetype_map_[ext] = mime;
  11624. return *this;
  11625. }
  11626. inline Server &Server::set_default_file_mimetype(const std::string &mime) {
  11627. default_file_mimetype_ = mime;
  11628. return *this;
  11629. }
  11630. inline Server &Server::set_file_request_handler(Handler handler) {
  11631. file_request_handler_ = std::move(handler);
  11632. return *this;
  11633. }
  11634. inline Server &Server::set_error_handler_core(HandlerWithResponse handler,
  11635. std::true_type) {
  11636. error_handler_ = std::move(handler);
  11637. return *this;
  11638. }
  11639. inline Server &Server::set_error_handler_core(Handler handler,
  11640. std::false_type) {
  11641. error_handler_ = [handler](const Request &req, Response &res) {
  11642. handler(req, res);
  11643. return HandlerResponse::Handled;
  11644. };
  11645. return *this;
  11646. }
  11647. inline Server &Server::set_exception_handler(ExceptionHandler handler) {
  11648. exception_handler_ = std::move(handler);
  11649. return *this;
  11650. }
  11651. inline Server &Server::set_pre_routing_handler(HandlerWithResponse handler) {
  11652. pre_routing_handler_ = std::move(handler);
  11653. return *this;
  11654. }
  11655. inline Server &Server::set_post_routing_handler(Handler handler) {
  11656. post_routing_handler_ = std::move(handler);
  11657. return *this;
  11658. }
  11659. inline Server &Server::set_pre_request_handler(HandlerWithResponse handler) {
  11660. pre_request_handler_ = std::move(handler);
  11661. return *this;
  11662. }
  11663. inline Server &Server::set_logger(Logger logger) {
  11664. logger_ = std::move(logger);
  11665. return *this;
  11666. }
  11667. inline Server &Server::set_error_logger(ErrorLogger error_logger) {
  11668. error_logger_ = std::move(error_logger);
  11669. return *this;
  11670. }
  11671. inline Server &Server::set_pre_compression_logger(Logger logger) {
  11672. pre_compression_logger_ = std::move(logger);
  11673. return *this;
  11674. }
  11675. inline Server &
  11676. Server::set_expect_100_continue_handler(Expect100ContinueHandler handler) {
  11677. expect_100_continue_handler_ = std::move(handler);
  11678. return *this;
  11679. }
  11680. inline Server &Server::set_start_handler(StartHandler handler) {
  11681. start_handler_ = std::move(handler);
  11682. return *this;
  11683. }
  11684. inline Server &Server::set_address_family(int family) {
  11685. address_family_ = family;
  11686. return *this;
  11687. }
  11688. inline Server &Server::set_tcp_nodelay(bool on) {
  11689. tcp_nodelay_ = on;
  11690. return *this;
  11691. }
  11692. inline Server &Server::set_ipv6_v6only(bool on) {
  11693. ipv6_v6only_ = on;
  11694. return *this;
  11695. }
  11696. inline Server &Server::set_socket_options(SocketOptions socket_options) {
  11697. socket_options_ = std::move(socket_options);
  11698. return *this;
  11699. }
  11700. inline Server &Server::set_default_headers(Headers headers) {
  11701. default_headers_ = std::move(headers);
  11702. return *this;
  11703. }
  11704. inline Server &Server::set_header_writer(
  11705. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  11706. header_writer_ = writer;
  11707. return *this;
  11708. }
  11709. inline Server &
  11710. Server::set_trusted_proxies(const std::vector<std::string> &proxies) {
  11711. trusted_proxies_ = proxies;
  11712. return *this;
  11713. }
  11714. inline Server &Server::set_keep_alive_max_count(size_t count) {
  11715. keep_alive_max_count_ = count;
  11716. return *this;
  11717. }
  11718. inline Server &Server::set_keep_alive_timeout(time_t sec) {
  11719. keep_alive_timeout_sec_ = sec;
  11720. return *this;
  11721. }
  11722. template <class Rep, class Period>
  11723. inline Server &Server::set_keep_alive_timeout(
  11724. const std::chrono::duration<Rep, Period> &duration) {
  11725. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11726. set_keep_alive_timeout(sec);
  11727. });
  11728. return *this;
  11729. }
  11730. inline Server &Server::set_read_timeout(time_t sec, time_t usec) {
  11731. read_timeout_sec_ = sec;
  11732. read_timeout_usec_ = usec;
  11733. return *this;
  11734. }
  11735. inline Server &Server::set_write_timeout(time_t sec, time_t usec) {
  11736. write_timeout_sec_ = sec;
  11737. write_timeout_usec_ = usec;
  11738. return *this;
  11739. }
  11740. inline Server &Server::set_idle_interval(time_t sec, time_t usec) {
  11741. idle_interval_sec_ = sec;
  11742. idle_interval_usec_ = usec;
  11743. return *this;
  11744. }
  11745. inline Server &Server::set_payload_max_length(size_t length) {
  11746. payload_max_length_ = length;
  11747. return *this;
  11748. }
  11749. inline Server &Server::set_compress(bool on) {
  11750. compress_ = on;
  11751. return *this;
  11752. }
  11753. inline Server &Server::set_static_file_compression(bool on) {
  11754. static_file_compression_ = on;
  11755. return *this;
  11756. }
  11757. inline Server &Server::set_static_file_compression_min_length(size_t length) {
  11758. static_file_compression_min_length_ = length;
  11759. return *this;
  11760. }
  11761. inline Server &Server::set_static_file_compression_max_length(size_t length) {
  11762. static_file_compression_max_length_ = length;
  11763. return *this;
  11764. }
  11765. inline Server &Server::set_websocket_max_missed_pongs(int count) {
  11766. websocket_max_missed_pongs_ = count;
  11767. return *this;
  11768. }
  11769. inline Server &Server::set_websocket_ping_interval(time_t sec) {
  11770. websocket_ping_interval_sec_ = sec;
  11771. return *this;
  11772. }
  11773. template <class Rep, class Period>
  11774. inline Server &Server::set_websocket_ping_interval(
  11775. const std::chrono::duration<Rep, Period> &duration) {
  11776. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11777. set_websocket_ping_interval(sec);
  11778. });
  11779. return *this;
  11780. }
  11781. inline bool Server::bind_to_port(const std::string &host, int port,
  11782. int socket_flags) {
  11783. auto ret = bind_internal(host, port, socket_flags);
  11784. if (ret == -1) { is_decommissioned = true; }
  11785. return ret >= 0;
  11786. }
  11787. inline int Server::bind_to_any_port(const std::string &host, int socket_flags) {
  11788. auto ret = bind_internal(host, 0, socket_flags);
  11789. if (ret == -1) { is_decommissioned = true; }
  11790. return ret;
  11791. }
  11792. inline bool Server::listen_after_bind() { return listen_internal(); }
  11793. inline bool Server::listen(const std::string &host, int port,
  11794. int socket_flags) {
  11795. return bind_to_port(host, port, socket_flags) && listen_internal();
  11796. }
  11797. inline bool Server::is_running() const { return is_running_; }
  11798. inline void Server::wait_until_ready() const {
  11799. while (!is_running_ && !is_decommissioned) {
  11800. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  11801. }
  11802. }
  11803. inline void Server::stop() noexcept {
  11804. // Release the listening socket whether or not the accept loop is running:
  11805. // bind_to_port() without listen_after_bind() still owns the descriptor. The
  11806. // exchange is what makes this safe to call concurrently with the accept loop.
  11807. socket_t sock = svr_sock_.exchange(INVALID_SOCKET);
  11808. if (sock != INVALID_SOCKET) {
  11809. detail::shutdown_socket(sock);
  11810. detail::close_socket(sock);
  11811. }
  11812. is_decommissioned = false;
  11813. }
  11814. inline void Server::decommission() { is_decommissioned = true; }
  11815. inline bool Server::parse_request_line(const char *s, Request &req) const {
  11816. auto len = strlen(s);
  11817. if (len < 2 || s[len - 2] != '\r' || s[len - 1] != '\n') { return false; }
  11818. len -= 2;
  11819. {
  11820. // RFC 9112 §3: exactly one SP between the method, the target and the
  11821. // version. Taking other whitespace as a separator too lets recipients
  11822. // that parse more strictly see a different request.
  11823. auto end = s + len;
  11824. if (std::count(s, end, ' ') != 2) { return false; }
  11825. auto sp1 = std::find(s, end, ' ');
  11826. auto sp2 = std::find(sp1 + 1, end, ' ');
  11827. if (sp1 == s || sp2 == sp1 + 1 || sp2 + 1 == end) { return false; }
  11828. req.method.assign(s, sp1);
  11829. req.target.assign(sp1 + 1, sp2);
  11830. req.version.assign(sp2 + 1, end);
  11831. }
  11832. // A method outside the built-in set is accepted only when a handler has been
  11833. // registered for it with CustomRoute().
  11834. const auto &methods = builtin_methods();
  11835. if (methods.find(req.method) == methods.end() &&
  11836. !find_custom_entry(req.method)) {
  11837. output_error_log(Error::InvalidHTTPMethod, &req);
  11838. return false;
  11839. }
  11840. if (req.version != "HTTP/1.1" && req.version != "HTTP/1.0") {
  11841. output_error_log(Error::InvalidHTTPVersion, &req);
  11842. return false;
  11843. }
  11844. // A request-target has no fragment (RFC 9112 §3.2), and one stripped here
  11845. // would leave this server routing a different path than a cache or a
  11846. // filter in front of it sees.
  11847. if (!detail::fields::is_request_target(req.target) ||
  11848. req.target.find('#') != std::string::npos) {
  11849. return false;
  11850. }
  11851. {
  11852. detail::divide(req.target, '?',
  11853. [&](const char *lhs_data, std::size_t lhs_size,
  11854. const char *rhs_data, std::size_t rhs_size) {
  11855. req.path =
  11856. decode_path_component(std::string(lhs_data, lhs_size));
  11857. detail::parse_query_text(rhs_data, rhs_size, req.params);
  11858. });
  11859. }
  11860. return true;
  11861. }
  11862. inline bool Server::write_response(Stream &strm, bool close_connection,
  11863. Request &req, Response &res) {
  11864. // NOTE: `req.ranges` should be empty, otherwise it will be applied
  11865. // incorrectly to the error content.
  11866. req.ranges.clear();
  11867. return write_response_core(strm, close_connection, req, res, false);
  11868. }
  11869. inline bool Server::write_response_with_content(Stream &strm,
  11870. bool close_connection,
  11871. const Request &req,
  11872. Response &res) {
  11873. return write_response_core(strm, close_connection, req, res, true);
  11874. }
  11875. inline bool Server::write_response_core(Stream &strm, bool close_connection,
  11876. const Request &req, Response &res,
  11877. bool need_apply_ranges) {
  11878. assert(res.status != -1);
  11879. if (400 <= res.status && error_handler_ &&
  11880. error_handler_(req, res) == HandlerResponse::Handled) {
  11881. need_apply_ranges = true;
  11882. }
  11883. // Before anything below reads res.headers, which the handlers may have
  11884. // filled directly
  11885. detail::erase_invalid_fields(res.headers);
  11886. if (!detail::body_allowed_for_status(res.status)) {
  11887. detail::clear_content(res);
  11888. }
  11889. detail::prefer_assigned_body(res);
  11890. std::string content_type;
  11891. std::string boundary;
  11892. if (need_apply_ranges) { apply_ranges(req, res, content_type, boundary); }
  11893. // Prepare additional headers
  11894. if (close_connection ||
  11895. detail::has_header_token(req.headers, "Connection", "close") ||
  11896. 400 <= res.status || // Don't leave connections open after errors
  11897. // The client withholds the body until `100 Continue`, which was never
  11898. // sent, so whether and when the body follows is unknown.
  11899. (req.expect_100_continue_pending_ && detail::has_framed_body(req)) ||
  11900. // The body was left partway, e.g. by a content receiver that returned
  11901. // false, so the rest of it cannot be told from the next request.
  11902. (req.body_read_started_ && !req.body_consumed_)) {
  11903. res.set_header("Connection", "close");
  11904. } else {
  11905. std::string s = "timeout=";
  11906. s += std::to_string(keep_alive_timeout_sec_);
  11907. if (keep_alive_max_count_ > 0) {
  11908. s += ", max=";
  11909. s += std::to_string(keep_alive_max_count_);
  11910. }
  11911. res.set_header("Keep-Alive", s);
  11912. }
  11913. if ((!res.body.empty() || res.content_length_ > 0 || res.content_provider_) &&
  11914. !res.has_header("Content-Type")) {
  11915. res.set_header("Content-Type", "text/plain");
  11916. }
  11917. detail::set_framing_headers(req, res, boundary, content_type);
  11918. if (req.method == "HEAD" && !res.has_header("Accept-Ranges")) {
  11919. res.set_header("Accept-Ranges", "bytes");
  11920. }
  11921. if (post_routing_handler_) {
  11922. post_routing_handler_(req, res);
  11923. detail::erase_invalid_fields(res.headers);
  11924. // Again, for a body or framing headers the handler changed.
  11925. detail::set_framing_headers(req, res, boundary, content_type);
  11926. }
  11927. // Response line and headers
  11928. detail::BufferStream bstrm;
  11929. if (!detail::write_response_line(bstrm, res.status)) { return false; }
  11930. if (header_writer_(bstrm, res.headers) <= 0) { return false; }
  11931. // Combine a small body with the headers so the whole response leaves in a
  11932. // single write. A large body is written on its own instead: a copy of it
  11933. // costs more than the extra write saves.
  11934. auto send_body =
  11935. req.method != "HEAD" && detail::body_allowed_for_status(res.status);
  11936. auto body_is_separate = false;
  11937. auto provider_done = false;
  11938. if (send_body && !res.body.empty() && !res.content_provider_) {
  11939. if (res.body.size() < CPPHTTPLIB_SEND_BUFSIZ) {
  11940. bstrm.write(res.body.data(), res.body.size());
  11941. } else {
  11942. body_is_separate = true;
  11943. }
  11944. } else if (send_body && res.content_provider_ &&
  11945. res.is_file_content_provider_ &&
  11946. res.content_length_ < CPPHTTPLIB_SEND_BUFSIZ) {
  11947. // A small file is read into the same buffer. Other providers may produce
  11948. // their data over time, so they are never held back.
  11949. if (!write_content_with_provider(bstrm, req, res, boundary, content_type)) {
  11950. return false;
  11951. }
  11952. provider_done = true;
  11953. }
  11954. // Log before writing to avoid race condition with client-side code that
  11955. // accesses logger-captured data immediately after receiving the response.
  11956. output_log(req, res);
  11957. // Flush buffer
  11958. auto &data = bstrm.get_buffer();
  11959. if (!detail::write_data(strm, data.data(), data.size())) { return false; }
  11960. if (body_is_separate) {
  11961. return detail::write_data(strm, res.body.data(), res.body.size());
  11962. }
  11963. // Streaming body
  11964. if (send_body && res.content_provider_) {
  11965. if (!provider_done &&
  11966. !write_content_with_provider(strm, req, res, boundary, content_type)) {
  11967. return false;
  11968. }
  11969. res.content_provider_success_ = true;
  11970. }
  11971. return true;
  11972. }
  11973. inline bool
  11974. Server::write_content_with_provider(Stream &strm, const Request &req,
  11975. Response &res, const std::string &boundary,
  11976. const std::string &content_type) {
  11977. auto is_shutting_down = [this]() {
  11978. return this->svr_sock_ == INVALID_SOCKET;
  11979. };
  11980. if (res.content_length_ > 0) {
  11981. if (!detail::is_partial_content(req, res)) {
  11982. return detail::write_content(strm, res.content_provider_, 0,
  11983. res.content_length_, is_shutting_down);
  11984. } else if (req.ranges.size() == 1) {
  11985. auto offset_and_length = detail::get_range_offset_and_length(
  11986. req.ranges[0], res.content_length_);
  11987. return detail::write_content(strm, res.content_provider_,
  11988. offset_and_length.first,
  11989. offset_and_length.second, is_shutting_down);
  11990. } else {
  11991. return detail::write_multipart_ranges_data(
  11992. strm, req, res, boundary, content_type, res.content_length_,
  11993. is_shutting_down);
  11994. }
  11995. } else {
  11996. if (res.is_chunked_content_provider_) {
  11997. // Use the coding `apply_ranges()` chose when it wrote the headers;
  11998. // re-negotiating here would disagree with them, e.g. once a handler's
  11999. // own Content-Encoding header suppresses the negotiation.
  12000. auto compressor = detail::make_compressor(res.content_coding_);
  12001. if (!compressor) {
  12002. compressor = detail::make_unique<detail::nocompressor>();
  12003. }
  12004. return detail::write_content_chunked(strm, res.content_provider_,
  12005. is_shutting_down, *compressor);
  12006. } else {
  12007. return detail::write_content_without_length(strm, res.content_provider_,
  12008. is_shutting_down);
  12009. }
  12010. }
  12011. }
  12012. inline bool Server::read_content(Stream &strm, Request &req, Response &res) {
  12013. FormFields::iterator cur_field;
  12014. FormFiles::iterator cur_file;
  12015. auto is_text_field = false;
  12016. size_t count = 0;
  12017. if (read_content_core(
  12018. strm, req, res,
  12019. // Regular
  12020. [&](const char *buf, size_t n) {
  12021. // Prevent arithmetic overflow when checking sizes.
  12022. // Avoid computing (req.body.size() + n) directly because
  12023. // adding two unsigned `size_t` values can wrap around and
  12024. // produce a small result instead of indicating overflow.
  12025. // Instead, check using subtraction: ensure `n` does not
  12026. // exceed the remaining capacity `max_size() - size()`.
  12027. if (req.body.size() >= req.body.max_size() ||
  12028. n > req.body.max_size() - req.body.size()) {
  12029. return false;
  12030. }
  12031. // Limit decompressed body size to payload_max_length_ to protect
  12032. // against "zip bomb" attacks where a small compressed payload
  12033. // decompresses to a massive size.
  12034. if (payload_max_length_ > 0 &&
  12035. (req.body.size() >= payload_max_length_ ||
  12036. n > payload_max_length_ - req.body.size())) {
  12037. return false;
  12038. }
  12039. req.body.append(buf, n);
  12040. return true;
  12041. },
  12042. // Multipart FormData
  12043. [&](const FormData &file) {
  12044. if (CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT > 0 &&
  12045. count++ == CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT) {
  12046. output_error_log(Error::TooManyFormDataFiles, &req);
  12047. return false;
  12048. }
  12049. if (file.filename.empty()) {
  12050. cur_field = req.form.fields.emplace(
  12051. file.name, FormField{file.name, file.content, file.headers});
  12052. is_text_field = true;
  12053. } else {
  12054. cur_file = req.form.files.emplace(file.name, file);
  12055. is_text_field = false;
  12056. }
  12057. return true;
  12058. },
  12059. [&](const char *buf, size_t n) {
  12060. if (is_text_field) {
  12061. auto &content = cur_field->second.content;
  12062. if (content.size() + n > content.max_size()) { return false; }
  12063. content.append(buf, n);
  12064. } else {
  12065. auto &content = cur_file->second.content;
  12066. if (content.size() + n > content.max_size()) { return false; }
  12067. content.append(buf, n);
  12068. }
  12069. return true;
  12070. })) {
  12071. const auto &content_type = req.get_header_value("Content-Type");
  12072. if (detail::case_ignore::equal(detail::extract_media_type(content_type),
  12073. "application/x-www-form-urlencoded")) {
  12074. if (CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH > 0 &&
  12075. req.body.size() > CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH) {
  12076. res.status = StatusCode::PayloadTooLarge_413; // NOTE: should be 414?
  12077. output_error_log(Error::ExceedMaxPayloadSize, &req);
  12078. return false;
  12079. }
  12080. detail::parse_query_text(req.body, req.params);
  12081. }
  12082. return true;
  12083. }
  12084. return false;
  12085. }
  12086. inline bool Server::read_content_with_content_receiver(
  12087. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  12088. FormDataHeader multipart_header, ContentReceiver multipart_receiver) {
  12089. return read_content_core(strm, req, res, std::move(receiver),
  12090. std::move(multipart_header),
  12091. std::move(multipart_receiver));
  12092. }
  12093. inline bool Server::read_content_core(
  12094. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  12095. FormDataHeader multipart_header, ContentReceiver multipart_receiver) const {
  12096. detail::FormDataParser multipart_form_data_parser;
  12097. ContentReceiverWithProgress out;
  12098. if (req.is_multipart_form_data()) {
  12099. const auto &content_type = req.get_header_value("Content-Type");
  12100. std::string boundary;
  12101. if (!detail::parse_multipart_boundary(content_type, boundary)) {
  12102. res.status = StatusCode::BadRequest_400;
  12103. output_error_log(Error::MultipartParsing, &req);
  12104. return false;
  12105. }
  12106. multipart_form_data_parser.set_boundary(std::move(boundary));
  12107. out = [&](const char *buf, size_t n, size_t /*off*/, size_t /*len*/) {
  12108. return multipart_form_data_parser.parse(buf, n, multipart_header,
  12109. multipart_receiver);
  12110. };
  12111. } else {
  12112. out = [receiver](const char *buf, size_t n, size_t /*off*/,
  12113. size_t /*len*/) { return receiver(buf, n); };
  12114. }
  12115. // RFC 9112 §6: no Transfer-Encoding and no Content-Length means no body.
  12116. // For non-SSL builds we still scan non-persistent connections for stray
  12117. // body bytes so the payload limit is enforced (413). On keep-alive,
  12118. // pending bytes may be the next request (issue #2450), so skip.
  12119. #if !defined(CPPHTTPLIB_SSL_ENABLED)
  12120. if (!req.has_header("Content-Length") &&
  12121. !detail::is_chunked_transfer_encoding(req.headers)) {
  12122. if (!detail::is_connection_persistent(req) && payload_max_length_ > 0 &&
  12123. payload_max_length_ < (std::numeric_limits<size_t>::max)()) {
  12124. auto has_data = strm.is_readable();
  12125. if (!has_data) {
  12126. auto s = strm.socket();
  12127. if (s != INVALID_SOCKET) {
  12128. has_data = detail::select_read(s, 0, 0) > 0;
  12129. }
  12130. }
  12131. if (has_data) {
  12132. // Route through the same decompressing reader used by the
  12133. // length-framed and chunked paths below, so payload_max_length_ is
  12134. // enforced on the decompressed size here too instead of only on the
  12135. // compressed wire bytes.
  12136. return detail::read_content(strm, req, payload_max_length_, res.status,
  12137. nullptr, out, true);
  12138. }
  12139. }
  12140. return true;
  12141. }
  12142. #else
  12143. if (!req.has_header("Content-Length") &&
  12144. !detail::is_chunked_transfer_encoding(req.headers)) {
  12145. return true;
  12146. }
  12147. #endif
  12148. // A second read would start where the first one stopped, or in the next
  12149. // request.
  12150. if (req.body_read_started_) { return false; }
  12151. // The client is waiting for this before it sends the body.
  12152. if (req.expect_100_continue_pending_) {
  12153. req.expect_100_continue_pending_ = false;
  12154. detail::write_response_line(strm, StatusCode::Continue_100);
  12155. strm.write("\r\n");
  12156. }
  12157. // Set before reading, since a receiver may also stop by throwing.
  12158. req.body_read_started_ = true;
  12159. if (!detail::read_content(strm, req, payload_max_length_, res.status, nullptr,
  12160. out, true)) {
  12161. return false;
  12162. }
  12163. req.body_consumed_ = true;
  12164. if (req.is_multipart_form_data()) {
  12165. if (!multipart_form_data_parser.is_valid()) {
  12166. res.status = StatusCode::BadRequest_400;
  12167. output_error_log(Error::MultipartParsing, &req);
  12168. return false;
  12169. }
  12170. }
  12171. return true;
  12172. }
  12173. inline bool Server::handle_file_request(Request &req, Response &res) {
  12174. if (!detail::is_valid_path(req.path)) { return false; }
  12175. for (const auto &entry : base_dirs_) {
  12176. // Prefix match, on a path segment boundary. A mount point of "/mount"
  12177. // covers "/mount" and "/mount/...", but must not swallow "/mountdir/...".
  12178. // One that already ends in '/' (the root mount among them) carries its own
  12179. // boundary; set_mount_point() guarantees the mount point is not empty.
  12180. if (!req.path.compare(0, entry.mount_point.size(), entry.mount_point) &&
  12181. (entry.mount_point.back() == '/' ||
  12182. req.path.size() == entry.mount_point.size() ||
  12183. req.path[entry.mount_point.size()] == '/')) {
  12184. std::string sub_path = "/" + req.path.substr(entry.mount_point.size());
  12185. auto path = entry.base_dir + sub_path;
  12186. if (path.back() == '/') { path += "index.html"; }
  12187. // Defense-in-depth: is_valid_path blocks ".." traversal in the URL,
  12188. // but symlinks/junctions can still escape the base directory. A path
  12189. // that cannot be resolved, which includes one that does not exist, is
  12190. // not served from here.
  12191. std::string resolved_path;
  12192. if (!detail::canonicalize_path(path.c_str(), resolved_path)) { continue; }
  12193. if (!detail::is_path_within_base(resolved_path,
  12194. entry.resolved_base_dir)) {
  12195. res.status = StatusCode::Forbidden_403;
  12196. return true;
  12197. }
  12198. detail::FileStat stat(path);
  12199. if (stat.is_dir()) {
  12200. // Relative, so "//dir" cannot name another host; "./" keeps a ':'
  12201. // in the name from reading as a scheme.
  12202. auto name = req.path.substr(req.path.rfind('/') + 1);
  12203. res.set_redirect("./" + encode_path_component(name) + "/",
  12204. StatusCode::MovedPermanently_301);
  12205. return true;
  12206. }
  12207. if (stat.is_file()) {
  12208. for (const auto &kv : entry.headers) {
  12209. res.set_header(kv.first, kv.second);
  12210. }
  12211. auto content_type = detail::find_content_type(
  12212. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  12213. auto encoding = detail::EncodingType::None;
  12214. if (static_file_compression_) {
  12215. encoding = static_file_encoding(req, res, content_type, stat.size());
  12216. }
  12217. // The ETag names the representation actually sent, so a client that
  12218. // cached the compressed form revalidates against the compressed ETag
  12219. // and still gets a 304, while one that took identity keeps the plain
  12220. // ETag.
  12221. auto etag = detail::compute_etag(
  12222. stat, encoding == detail::EncodingType::None
  12223. ? std::string()
  12224. : std::string("-") + detail::encoding_name(encoding));
  12225. if (!etag.empty()) { res.set_header("ETag", etag); }
  12226. auto mtime = stat.mtime();
  12227. auto last_modified = detail::file_mtime_to_http_date(mtime);
  12228. if (!last_modified.empty()) {
  12229. res.set_header("Last-Modified", last_modified);
  12230. }
  12231. if (check_if_not_modified(req, res, etag, mtime)) { return true; }
  12232. check_if_range(req, etag, mtime);
  12233. auto mm = std::make_shared<detail::mmap>(path.c_str());
  12234. if (!mm->is_open()) {
  12235. output_error_log(Error::OpenFile, &req);
  12236. return false;
  12237. }
  12238. detail::set_file_content_provider(res, mm, content_type, encoding);
  12239. if (req.method != "HEAD" && file_request_handler_) {
  12240. file_request_handler_(req, res);
  12241. }
  12242. return true;
  12243. } else {
  12244. output_error_log(Error::OpenFile, &req);
  12245. }
  12246. }
  12247. }
  12248. return false;
  12249. }
  12250. inline bool Server::check_if_not_modified(const Request &req, Response &res,
  12251. const std::string &etag,
  12252. time_t mtime) const {
  12253. // Handle conditional GET:
  12254. // 1. If-None-Match takes precedence (RFC 9110 Section 13.1.2)
  12255. // 2. If-Modified-Since is checked only when If-None-Match is absent
  12256. if (req.has_header("If-None-Match")) {
  12257. if (!etag.empty()) {
  12258. auto val =
  12259. detail::get_combined_header_value(req.headers, "If-None-Match");
  12260. // NOTE: We use exact string matching here. This works correctly
  12261. // because our server always generates weak ETags (W/"..."), and
  12262. // clients typically send back the same ETag they received.
  12263. // RFC 9110 Section 8.8.3.2 allows weak comparison for
  12264. // If-None-Match, where W/"x" and "x" would match, but this
  12265. // simplified implementation requires exact matches.
  12266. auto ret = detail::split_find(val.data(), val.data() + val.size(), ',',
  12267. [&](const char *b, const char *e) {
  12268. auto seg_len = static_cast<size_t>(e - b);
  12269. return (seg_len == 1 && *b == '*') ||
  12270. (seg_len == etag.size() &&
  12271. std::equal(b, e, etag.begin()));
  12272. });
  12273. if (ret) {
  12274. res.status = StatusCode::NotModified_304;
  12275. return true;
  12276. }
  12277. }
  12278. } else if (req.has_header("If-Modified-Since")) {
  12279. auto val = req.get_header_value("If-Modified-Since");
  12280. auto t = detail::parse_http_date(val);
  12281. if (t != static_cast<time_t>(-1) && mtime <= t) {
  12282. res.status = StatusCode::NotModified_304;
  12283. return true;
  12284. }
  12285. }
  12286. return false;
  12287. }
  12288. inline bool Server::check_if_range(Request &req, const std::string &etag,
  12289. time_t mtime) const {
  12290. // Handle If-Range for partial content requests (RFC 9110
  12291. // Section 13.1.5). If-Range is only evaluated when Range header is
  12292. // present. If the validator matches, serve partial content; otherwise
  12293. // serve full content.
  12294. if (!req.ranges.empty() && req.has_header("If-Range")) {
  12295. auto val = req.get_header_value("If-Range");
  12296. auto is_valid_range = [&]() {
  12297. if (detail::is_strong_etag(val)) {
  12298. // RFC 9110 Section 13.1.5: If-Range requires strong ETag
  12299. // comparison.
  12300. return (!etag.empty() && val == etag);
  12301. } else if (detail::is_weak_etag(val)) {
  12302. // Weak ETags are not valid for If-Range (RFC 9110 Section 13.1.5)
  12303. return false;
  12304. } else {
  12305. // HTTP-date comparison
  12306. auto t = detail::parse_http_date(val);
  12307. return (t != static_cast<time_t>(-1) && mtime <= t);
  12308. }
  12309. };
  12310. if (!is_valid_range()) {
  12311. // Validator doesn't match: ignore Range and serve full content
  12312. req.ranges.clear();
  12313. return false;
  12314. }
  12315. }
  12316. return true;
  12317. }
  12318. inline socket_t
  12319. Server::create_server_socket(const std::string &host, int port,
  12320. int socket_flags,
  12321. SocketOptions socket_options) const {
  12322. return detail::create_socket(
  12323. host, std::string(), port, address_family_, socket_flags, tcp_nodelay_,
  12324. ipv6_v6only_, std::move(socket_options),
  12325. [&](socket_t sock, struct addrinfo &ai, bool & /*quit*/) -> bool {
  12326. if (::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  12327. output_error_log(Error::BindIPAddress, nullptr);
  12328. return false;
  12329. }
  12330. if (::listen(sock, CPPHTTPLIB_LISTEN_BACKLOG)) {
  12331. output_error_log(Error::Listen, nullptr);
  12332. return false;
  12333. }
  12334. return true;
  12335. });
  12336. }
  12337. inline int Server::bind_internal(const std::string &host, int port,
  12338. int socket_flags) {
  12339. if (is_decommissioned) { return -1; }
  12340. if (!is_valid()) { return -1; }
  12341. svr_sock_ = create_server_socket(host, port, socket_flags, socket_options_);
  12342. if (svr_sock_ == INVALID_SOCKET) { return -1; }
  12343. if (port == 0) {
  12344. struct sockaddr_storage addr;
  12345. socklen_t addr_len = sizeof(addr);
  12346. if (getsockname(svr_sock_, reinterpret_cast<struct sockaddr *>(&addr),
  12347. &addr_len) == -1) {
  12348. output_error_log(Error::GetSockName, nullptr);
  12349. return -1;
  12350. }
  12351. if (addr.ss_family == AF_INET) {
  12352. return ntohs(reinterpret_cast<struct sockaddr_in *>(&addr)->sin_port);
  12353. } else if (addr.ss_family == AF_INET6) {
  12354. return ntohs(reinterpret_cast<struct sockaddr_in6 *>(&addr)->sin6_port);
  12355. } else {
  12356. output_error_log(Error::UnsupportedAddressFamily, nullptr);
  12357. return -1;
  12358. }
  12359. } else {
  12360. return port;
  12361. }
  12362. }
  12363. inline bool Server::listen_internal() {
  12364. // A stop() between bind and listen leaves nothing to accept on. Report
  12365. // failure instead of returning success without ever serving, and mark the
  12366. // server decommissioned the way any failed listen does so that a concurrent
  12367. // wait_until_ready() wakes up instead of spinning forever.
  12368. if (is_decommissioned || svr_sock_ == INVALID_SOCKET) {
  12369. is_decommissioned = true;
  12370. return false;
  12371. }
  12372. auto ret = true;
  12373. is_running_ = true;
  12374. auto se = detail::scope_exit([&]() { is_running_ = false; });
  12375. if (start_handler_) { start_handler_(); }
  12376. {
  12377. std::unique_ptr<TaskQueue> task_queue(new_task_queue());
  12378. while (svr_sock_ != INVALID_SOCKET) {
  12379. #ifndef _WIN32
  12380. if (idle_interval_sec_ > 0 || idle_interval_usec_ > 0) {
  12381. #endif
  12382. auto val = detail::select_read(svr_sock_, idle_interval_sec_,
  12383. idle_interval_usec_);
  12384. if (val == 0) { // Timeout
  12385. task_queue->on_idle();
  12386. continue;
  12387. }
  12388. #ifndef _WIN32
  12389. }
  12390. #endif
  12391. #if defined _WIN32
  12392. // sockets connected via WASAccept inherit flags NO_HANDLE_INHERIT,
  12393. // OVERLAPPED
  12394. socket_t sock = WSAAccept(svr_sock_, nullptr, nullptr, nullptr, 0);
  12395. #elif defined SOCK_CLOEXEC
  12396. socket_t sock = accept4(svr_sock_, nullptr, nullptr, SOCK_CLOEXEC);
  12397. #else
  12398. socket_t sock = accept(svr_sock_, nullptr, nullptr);
  12399. #endif
  12400. if (sock == INVALID_SOCKET) {
  12401. // NOTE: Winsock reports failures through WSAGetLastError() and never
  12402. // touches the CRT errno, so the two have to be asked platform by
  12403. // platform rather than by testing errno here.
  12404. if (detail::is_accept_resource_error()) {
  12405. // The per-process descriptor limit or the network stack's buffer
  12406. // space has been reached. Try to accept new connections after a
  12407. // short sleep.
  12408. std::this_thread::sleep_for(std::chrono::microseconds{1});
  12409. continue;
  12410. } else if (detail::is_accept_transient_error()) {
  12411. continue;
  12412. }
  12413. // Take the descriptor out of svr_sock_ before closing it: a later
  12414. // stop() would otherwise shutdown()/close() a value the OS may have
  12415. // reused, and keep_alive() watches svr_sock_ to notice the server is
  12416. // gone. The exchange also settles the race with a concurrent stop(),
  12417. // since whichever side takes the descriptor closes it exactly once.
  12418. auto listen_sock = svr_sock_.exchange(INVALID_SOCKET);
  12419. if (listen_sock != INVALID_SOCKET) {
  12420. detail::close_socket(listen_sock);
  12421. ret = false;
  12422. output_error_log(Error::Connection, nullptr);
  12423. } else {
  12424. ; // The server socket was closed by user.
  12425. }
  12426. break;
  12427. }
  12428. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO,
  12429. read_timeout_sec_, read_timeout_usec_);
  12430. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_SNDTIMEO,
  12431. write_timeout_sec_, write_timeout_usec_);
  12432. if (tcp_nodelay_) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  12433. if (!task_queue->enqueue(
  12434. [this, sock]() { process_and_close_socket(sock); })) {
  12435. output_error_log(Error::ResourceExhaustion, nullptr);
  12436. detail::shutdown_socket(sock);
  12437. detail::close_socket(sock);
  12438. }
  12439. }
  12440. task_queue->shutdown();
  12441. }
  12442. is_decommissioned = !ret;
  12443. return ret;
  12444. }
  12445. inline bool Server::routing(Request &req, Response &res, Stream &strm,
  12446. bool skip_pre_routing) {
  12447. if (!skip_pre_routing && pre_routing_handler_ &&
  12448. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12449. return true;
  12450. }
  12451. // File handler
  12452. if ((req.method == "GET" || req.method == "HEAD") &&
  12453. handle_file_request(req, res)) {
  12454. return true;
  12455. }
  12456. const auto *custom = find_custom_entry(req.method);
  12457. // The second clause mirrors what expect_content() does unconditionally for
  12458. // POST/PUT/PATCH/DELETE: a content reader route fires even when the request
  12459. // carries no body. Without it a body-less PROPFIND (RFC 4918 treats one as
  12460. // `allprop`) would skip its handler and fall through to 404.
  12461. if (detail::expect_content(req) ||
  12462. (custom && !custom->handlers_for_content_reader.empty())) {
  12463. // Content reader handler
  12464. {
  12465. // Track whether the ContentReader was aborted due to the decompressed
  12466. // payload exceeding `payload_max_length_`.
  12467. // The user handler runs after the lambda returns, so we must restore the
  12468. // 413 status if the handler overwrites it.
  12469. bool content_reader_payload_too_large = false;
  12470. ContentReader reader(
  12471. [&](ContentReceiver receiver) {
  12472. auto result = read_content_with_content_receiver(
  12473. strm, req, res, std::move(receiver), nullptr, nullptr);
  12474. if (!result) {
  12475. output_error_log(Error::Read, &req);
  12476. if (res.status == StatusCode::PayloadTooLarge_413) {
  12477. content_reader_payload_too_large = true;
  12478. }
  12479. }
  12480. return result;
  12481. },
  12482. [&](FormDataHeader header, ContentReceiver receiver) {
  12483. auto result = read_content_with_content_receiver(
  12484. strm, req, res, nullptr, std::move(header),
  12485. std::move(receiver));
  12486. if (!result) {
  12487. output_error_log(Error::Read, &req);
  12488. if (res.status == StatusCode::PayloadTooLarge_413) {
  12489. content_reader_payload_too_large = true;
  12490. }
  12491. }
  12492. return result;
  12493. });
  12494. bool dispatched = false;
  12495. if (req.method == "POST") {
  12496. dispatched = dispatch_request_for_content_reader(
  12497. req, res, std::move(reader), post_handlers_for_content_reader_);
  12498. } else if (req.method == "PUT") {
  12499. dispatched = dispatch_request_for_content_reader(
  12500. req, res, std::move(reader), put_handlers_for_content_reader_);
  12501. } else if (req.method == "PATCH") {
  12502. dispatched = dispatch_request_for_content_reader(
  12503. req, res, std::move(reader), patch_handlers_for_content_reader_);
  12504. } else if (req.method == "DELETE") {
  12505. dispatched = dispatch_request_for_content_reader(
  12506. req, res, std::move(reader), delete_handlers_for_content_reader_);
  12507. } else if (custom) {
  12508. dispatched = dispatch_request_for_content_reader(
  12509. req, res, std::move(reader), custom->handlers_for_content_reader);
  12510. }
  12511. if (dispatched) {
  12512. if (content_reader_payload_too_large) {
  12513. // Enforce the limit: override any status the handler may have set
  12514. // and return false so the error path sends a plain 413 response.
  12515. res.status = StatusCode::PayloadTooLarge_413;
  12516. detail::clear_content(res);
  12517. return false;
  12518. }
  12519. return true;
  12520. }
  12521. }
  12522. // NOTE: `req.body` is not read here. For a regular handler the body is
  12523. // read inside dispatch_request(), after the route has matched and the
  12524. // pre-request handler has approved the request, so that a rejected
  12525. // request (e.g. failed authentication) never forces us to buffer a
  12526. // potentially large body.
  12527. }
  12528. // Regular handler
  12529. if (req.method == "GET" || req.method == "HEAD") {
  12530. return dispatch_request(req, res, get_handlers_, strm);
  12531. } else if (req.method == "POST") {
  12532. return dispatch_request(req, res, post_handlers_, strm);
  12533. } else if (req.method == "PUT") {
  12534. return dispatch_request(req, res, put_handlers_, strm);
  12535. } else if (req.method == "DELETE") {
  12536. return dispatch_request(req, res, delete_handlers_, strm);
  12537. } else if (req.method == "OPTIONS") {
  12538. return dispatch_request(req, res, options_handlers_, strm);
  12539. } else if (req.method == "PATCH") {
  12540. return dispatch_request(req, res, patch_handlers_, strm);
  12541. } else if (custom) {
  12542. return dispatch_request(req, res, custom->handlers, strm);
  12543. }
  12544. res.status = StatusCode::BadRequest_400;
  12545. return false;
  12546. }
  12547. inline bool Server::dispatch_request(Request &req, Response &res,
  12548. const Handlers &handlers, Stream &strm) {
  12549. for (const auto &x : handlers) {
  12550. const auto &matcher = x.first;
  12551. const auto &handler = x.second;
  12552. if (matcher->match(req)) {
  12553. req.matched_route = matcher->pattern();
  12554. // Run the pre-request handler before reading the body so a rejected
  12555. // request (e.g. failed authentication) never forces us to buffer a
  12556. // potentially large body. `req.matched_route` is available here.
  12557. if (pre_request_handler_ &&
  12558. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12559. return true;
  12560. }
  12561. // The route matched and the request was approved; read the body now.
  12562. if (detail::expect_content(req) && !read_content(strm, req, res)) {
  12563. output_error_log(Error::Read, &req);
  12564. return false;
  12565. }
  12566. handler(req, res);
  12567. return true;
  12568. }
  12569. }
  12570. return false;
  12571. }
  12572. // Decides the content coding for a response served straight from a file. Both
  12573. // the ETag, which has to name the representation actually sent, and
  12574. // `apply_static_file_compression()` go through this, so the two cannot drift
  12575. // apart.
  12576. inline detail::EncodingType
  12577. Server::static_file_encoding(const Request &req, const Response &res,
  12578. const std::string &content_type,
  12579. size_t length) const {
  12580. if (!static_file_compression_) { return detail::EncodingType::None; }
  12581. // Nothing to compress, and an empty file already answers with
  12582. // `Content-Length: 0`. Checked on its own so that a zero floor still cannot
  12583. // turn an empty body into a 20-byte gzip stream.
  12584. if (length == 0) { return detail::EncodingType::None; }
  12585. // A file that already fits in a single packet gains nothing from being made
  12586. // smaller, since it still travels in that one segment, and a file of a few
  12587. // bytes comes out larger than it went in.
  12588. if (length < static_file_compression_min_length_) {
  12589. return detail::EncodingType::None;
  12590. }
  12591. // RFC 9110 applies Range to the representation after content coding, so a
  12592. // compressed 206 would mean compressing the whole file and then slicing it.
  12593. // Serve ranges from the identity representation instead.
  12594. if (!req.ranges.empty()) { return detail::EncodingType::None; }
  12595. if (static_file_compression_max_length_ > 0 &&
  12596. length > static_file_compression_max_length_) {
  12597. return detail::EncodingType::None;
  12598. }
  12599. return detail::encoding_type(req, res, content_type);
  12600. }
  12601. // Compresses a file-backed content provider into `res.body`. Returns false when
  12602. // the response is left untouched.
  12603. inline bool Server::apply_static_file_compression(const Request &req,
  12604. Response &res) const {
  12605. auto type = res.content_coding_;
  12606. if (type == detail::EncodingType::None || !res.content_provider_) {
  12607. return false;
  12608. }
  12609. auto compressor = detail::make_compressor(type);
  12610. if (!compressor) { return false; }
  12611. output_pre_compression_log(req, res);
  12612. std::string compressed;
  12613. if (!detail::compress_content_provider(res.content_provider_,
  12614. res.content_length_, *compressor,
  12615. compressed)) {
  12616. return false;
  12617. }
  12618. res.body.swap(compressed);
  12619. // The provider was consumed in full, so its releaser hears about a success.
  12620. res.content_provider_success_ = true;
  12621. detail::clear_content_provider(res);
  12622. res.set_header("Content-Encoding", detail::encoding_name(type));
  12623. res.set_header("Vary", "Accept-Encoding");
  12624. return true;
  12625. }
  12626. inline void Server::apply_ranges(const Request &req, Response &res,
  12627. std::string &content_type,
  12628. std::string &boundary) const {
  12629. // A known-length content provider leaves `res.body` empty, so the compressor
  12630. // at the end of this function never runs for one (issue #2545). A file-backed
  12631. // provider is fully readable right here, so compress it and answer with an
  12632. // ordinary body: `Content-Length` and HEAD keep working, and the response
  12633. // takes the same path as `set_content()` from here on. Range requests never
  12634. // get a content coding, so `Content-Range` still names identity bytes and
  12635. // none of the range handling below applies.
  12636. if (apply_static_file_compression(req, res)) { return; }
  12637. if (req.ranges.size() > 1 && res.status == StatusCode::PartialContent_206) {
  12638. auto it = res.headers.find("Content-Type");
  12639. if (it != res.headers.end()) {
  12640. content_type = it->second;
  12641. res.headers.erase(it);
  12642. }
  12643. boundary = detail::make_multipart_data_boundary();
  12644. res.set_header("Content-Type",
  12645. "multipart/byteranges; boundary=" + boundary);
  12646. }
  12647. auto type =
  12648. compress_ ? detail::encoding_type(req, res) : detail::EncodingType::None;
  12649. if (res.body.empty()) {
  12650. if (res.content_length_ > 0 && req.ranges.size() == 1 &&
  12651. res.status == StatusCode::PartialContent_206) {
  12652. auto offset_and_length = detail::get_range_offset_and_length(
  12653. req.ranges[0], res.content_length_);
  12654. auto content_range = detail::make_content_range_header_field(
  12655. offset_and_length, res.content_length_);
  12656. res.set_header("Content-Range", content_range);
  12657. } else if (res.is_chunked_content_provider_) {
  12658. res.content_coding_ = type;
  12659. if (type != detail::EncodingType::None) {
  12660. res.set_header("Content-Encoding", detail::encoding_name(type));
  12661. res.set_header("Vary", "Accept-Encoding");
  12662. }
  12663. }
  12664. } else {
  12665. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12666. ;
  12667. } else if (req.ranges.size() == 1) {
  12668. auto offset_and_length =
  12669. detail::get_range_offset_and_length(req.ranges[0], res.body.size());
  12670. auto offset = offset_and_length.first;
  12671. auto length = offset_and_length.second;
  12672. auto content_range = detail::make_content_range_header_field(
  12673. offset_and_length, res.body.size());
  12674. res.set_header("Content-Range", content_range);
  12675. assert(offset + length <= res.body.size());
  12676. res.body = res.body.substr(offset, length);
  12677. } else {
  12678. std::string data;
  12679. detail::make_multipart_ranges_data(req, res, boundary, content_type,
  12680. res.body.size(), data);
  12681. res.body.swap(data);
  12682. }
  12683. if (type != detail::EncodingType::None) {
  12684. output_pre_compression_log(req, res);
  12685. if (auto compressor = detail::make_compressor(type)) {
  12686. std::string compressed;
  12687. if (compressor->compress(res.body.data(), res.body.size(), true,
  12688. [&](const char *data, size_t data_len) {
  12689. compressed.append(data, data_len);
  12690. return true;
  12691. })) {
  12692. res.body.swap(compressed);
  12693. res.set_header("Content-Encoding", detail::encoding_name(type));
  12694. res.set_header("Vary", "Accept-Encoding");
  12695. }
  12696. }
  12697. }
  12698. res.content_length_ = res.body.size();
  12699. }
  12700. }
  12701. inline bool Server::dispatch_request_for_content_reader(
  12702. Request &req, Response &res, ContentReader content_reader,
  12703. const HandlersForContentReader &handlers) const {
  12704. for (const auto &x : handlers) {
  12705. const auto &matcher = x.first;
  12706. const auto &handler = x.second;
  12707. if (matcher->match(req)) {
  12708. req.matched_route = matcher->pattern();
  12709. if (!pre_request_handler_ ||
  12710. pre_request_handler_(req, res) != HandlerResponse::Handled) {
  12711. handler(req, res, content_reader);
  12712. }
  12713. return true;
  12714. }
  12715. }
  12716. return false;
  12717. }
  12718. inline std::string
  12719. get_client_ip(const std::string &x_forwarded_for,
  12720. const std::vector<std::string> &trusted_proxies) {
  12721. // X-Forwarded-For is a comma-separated list per RFC 7239
  12722. std::vector<std::string> ip_list;
  12723. detail::split(x_forwarded_for.data(),
  12724. x_forwarded_for.data() + x_forwarded_for.size(), ',',
  12725. [&](const char *b, const char *e) {
  12726. auto r = detail::trim(b, e, 0, static_cast<size_t>(e - b));
  12727. ip_list.emplace_back(std::string(b + r.first, b + r.second));
  12728. });
  12729. // A malformed X-Forwarded-For (empty, comma-only, whitespace-only) yields
  12730. // no segments. Signal "no client IP derived" with an empty string so the
  12731. // caller can fall back to the connection-level remote address.
  12732. if (ip_list.empty()) { return std::string(); }
  12733. // Each hop appends the address it received the request from, so the rightmost
  12734. // entries are the ones written by our own infrastructure while the leftmost
  12735. // are whatever the original client chose to send. Walk from the right and
  12736. // skip trusted proxies; the first address that is not a trusted proxy is the
  12737. // furthest point still attributable to a real hop, i.e. the client. Scanning
  12738. // from the left instead lets a client forge an arbitrary address by following
  12739. // it with a trusted proxy's address, which the left-to-right scan then
  12740. // returned as the client.
  12741. for (size_t i = ip_list.size(); i-- > 0;) {
  12742. const auto &ip = ip_list[i];
  12743. auto is_trusted_proxy =
  12744. std::any_of(trusted_proxies.begin(), trusted_proxies.end(),
  12745. [&](const std::string &proxy) { return ip == proxy; });
  12746. if (!is_trusted_proxy) { return ip; }
  12747. }
  12748. // Every hop was a trusted proxy; fall back to the first entry.
  12749. return ip_list.front();
  12750. }
  12751. inline bool
  12752. Server::process_request(Stream &strm, const std::string &remote_addr,
  12753. int remote_port, const std::string &local_addr,
  12754. int local_port, bool close_connection,
  12755. bool &connection_closed,
  12756. const std::function<void(Request &)> &setup_request,
  12757. bool *websocket_upgraded) {
  12758. std::array<char, 2048> buf{};
  12759. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12760. // The read timeout bounds the request line and headers as a whole, so a
  12761. // client sending them a byte at a time cannot hold the worker any longer.
  12762. strm.set_max_timeout(read_timeout_sec_ * 1000 + read_timeout_usec_ / 1000);
  12763. // Connection has been closed on client
  12764. if (!line_reader.getline()) { return false; }
  12765. // RFC 9112 2.2: ignore an empty line received before the request-line. Some
  12766. // clients send an extra CRLF after a request body, which would otherwise be
  12767. // parsed as the next request on a persistent connection.
  12768. if (strcmp(line_reader.ptr(), "\r\n") == 0 && !line_reader.getline()) {
  12769. return false;
  12770. }
  12771. Request req;
  12772. req.start_time_ = std::chrono::steady_clock::now();
  12773. req.remote_addr = remote_addr;
  12774. req.remote_port = remote_port;
  12775. req.local_addr = local_addr;
  12776. req.local_port = local_port;
  12777. Response res;
  12778. res.version = "HTTP/1.1";
  12779. res.headers = default_headers_;
  12780. // RFC 9112 §9.6: a server that sends the "close" connection option must
  12781. // close the connection after that response, whichever path wrote it (an
  12782. // error status, a handler, or a rejected request). Reading on would also
  12783. // parse whatever the client sent next on a connection it considers done.
  12784. auto honor_connection_close = detail::scope_exit([&] {
  12785. if (detail::has_header_token(res.headers, "Connection", "close")) {
  12786. connection_closed = true;
  12787. }
  12788. });
  12789. // Request line and headers. A rejected message leaves the rest of it (and
  12790. // any body) unread, so the connection cannot be reused: the leftover bytes
  12791. // would be parsed as the next request.
  12792. if (!parse_request_line(line_reader.ptr(), req)) {
  12793. connection_closed = true;
  12794. res.status = StatusCode::BadRequest_400;
  12795. output_error_log(Error::InvalidRequestLine, &req);
  12796. return write_response(strm, close_connection, req, res);
  12797. }
  12798. // Request headers
  12799. if (!detail::read_headers(strm, req.headers)) {
  12800. connection_closed = true;
  12801. res.status = StatusCode::BadRequest_400;
  12802. output_error_log(Error::InvalidHeaders, &req);
  12803. return write_response(strm, close_connection, req, res);
  12804. }
  12805. strm.set_max_timeout(0);
  12806. // RFC 9112 §6.3: Reject requests whose framing is invalid or ambiguous,
  12807. // which would otherwise let an intermediary and this parser disagree on
  12808. // where the body ends and enable request smuggling. Three cases: a
  12809. // Content-Length that is not a valid decimal length (e.g. "42, 42", "+42"
  12810. // or empty), which would otherwise be read as "no body"; a non-zero
  12811. // Content-Length alongside any Transfer-Encoding (Content-Length: 0 is
  12812. // tolerated for compatibility with existing clients); and a
  12813. // Transfer-Encoding whose final coding is not chunked, which leaves the body
  12814. // length undeterminable. None of them may fall through to the "no body"
  12815. // path, or the body bytes are parsed as the next request on a persistent
  12816. // connection.
  12817. auto is_invalid_content_length = false;
  12818. detail::get_header_value_u64(req.headers, "Content-Length", 0, 0,
  12819. is_invalid_content_length);
  12820. if (is_invalid_content_length ||
  12821. detail::has_conflicting_content_length(req.headers) ||
  12822. (req.has_header("Transfer-Encoding") &&
  12823. !detail::is_chunked_transfer_encoding(req.headers))) {
  12824. connection_closed = true;
  12825. res.status = StatusCode::BadRequest_400;
  12826. return write_response(strm, close_connection, req, res);
  12827. }
  12828. // RFC 9112 §6.1: a Transfer-Encoding alongside a Content-Length, or in an
  12829. // HTTP/1.0 request, is honoured, but the connection closes after the
  12830. // response.
  12831. if (detail::has_faulty_transfer_encoding(req)) { connection_closed = true; }
  12832. // RFC 9112 §3.2: Reject more than one Host field line, an invalid Host
  12833. // value, or none in HTTP/1.1, so that every recipient of the request sees
  12834. // the same authority.
  12835. auto host_count = req.get_header_value_count("Host");
  12836. if (host_count > 1 || (host_count == 0 && req.version == "HTTP/1.1") ||
  12837. !detail::fields::is_host(req.get_header_value("Host"))) {
  12838. connection_closed = true;
  12839. res.status = StatusCode::BadRequest_400;
  12840. output_error_log(Error::InvalidHeaders, &req);
  12841. return write_response(strm, close_connection, req, res);
  12842. }
  12843. // Check if the request URI doesn't exceed the limit
  12844. if (req.target.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  12845. connection_closed = true;
  12846. res.status = StatusCode::UriTooLong_414;
  12847. output_error_log(Error::ExceedUriMaxLength, &req);
  12848. return write_response(strm, close_connection, req, res);
  12849. }
  12850. if (detail::has_header_token(req.headers, "Connection", "close")) {
  12851. connection_closed = true;
  12852. }
  12853. if (req.version == "HTTP/1.0" &&
  12854. !detail::has_header_token(req.headers, "Connection", "keep-alive")) {
  12855. connection_closed = true;
  12856. }
  12857. // Only honor X-Forwarded-For if the peer on the actual TCP connection is
  12858. // itself a trusted proxy. Otherwise any direct client could spoof
  12859. // remote_addr simply by sending an arbitrary X-Forwarded-For header.
  12860. auto is_trusted_peer = std::any_of(
  12861. trusted_proxies_.begin(), trusted_proxies_.end(),
  12862. [&](const std::string &proxy) { return proxy == remote_addr; });
  12863. if (is_trusted_peer && req.has_header("X-Forwarded-For")) {
  12864. // Some proxies append the address they observed as a separate
  12865. // X-Forwarded-For field line instead of extending the one the client sent
  12866. // (e.g. HAProxy's "option forwardfor"), so the whole combined value has to
  12867. // be scanned. Reading only the first occurrence would hand back the
  12868. // client-supplied, and therefore forgeable, value.
  12869. auto x_forwarded_for =
  12870. detail::get_combined_header_value(req.headers, "X-Forwarded-For");
  12871. auto derived = get_client_ip(x_forwarded_for, trusted_proxies_);
  12872. req.remote_addr = derived.empty() ? remote_addr : derived;
  12873. } else {
  12874. req.remote_addr = remote_addr;
  12875. }
  12876. req.remote_port = remote_port;
  12877. req.local_addr = local_addr;
  12878. req.local_port = local_port;
  12879. if (req.has_header("Accept")) {
  12880. auto accept_header =
  12881. detail::get_combined_header_value(req.headers, "Accept");
  12882. if (!detail::parse_accept_header(accept_header, req.accept_content_types)) {
  12883. connection_closed = true;
  12884. res.status = StatusCode::BadRequest_400;
  12885. output_error_log(Error::HTTPParsing, &req);
  12886. return write_response(strm, close_connection, req, res);
  12887. }
  12888. }
  12889. if (req.has_header("Range")) {
  12890. const auto &range_header_value = req.get_header_value("Range");
  12891. if (!detail::parse_range_header(range_header_value, req.ranges)) {
  12892. connection_closed = true;
  12893. res.status = StatusCode::RangeNotSatisfiable_416;
  12894. output_error_log(Error::InvalidRangeHeader, &req);
  12895. return write_response(strm, close_connection, req, res);
  12896. }
  12897. }
  12898. if (setup_request) { setup_request(req); }
  12899. // RFC 9110 10.1.1: Expect is a comma-separated list whose value is
  12900. // case-insensitive, and a 100-continue expectation in an HTTP/1.0 request
  12901. // must be ignored. An expectation we do not recognize is left alone; the
  12902. // 417 the section allows for one is a MAY, not a requirement.
  12903. //
  12904. // `100 Continue` itself is deferred until the body is actually read (see
  12905. // read_content_core), so a request rejected by a later handler never
  12906. // invites the client to send a body nobody will read.
  12907. if (req.version != "HTTP/1.0" &&
  12908. detail::has_header_token(req.headers, "Expect", "100-continue")) {
  12909. int status = StatusCode::Continue_100;
  12910. if (expect_100_continue_handler_) {
  12911. status = expect_100_continue_handler_(req, res);
  12912. }
  12913. if (status == StatusCode::Continue_100) {
  12914. req.expect_100_continue_pending_ = true;
  12915. } else {
  12916. if (res.status == -1) { res.status = status; }
  12917. connection_closed = true;
  12918. return write_response(strm, true, req, res);
  12919. }
  12920. }
  12921. // Setup `is_connection_closed` method
  12922. auto sock = strm.socket();
  12923. req.is_connection_closed = [sock]() {
  12924. return !detail::is_socket_alive(sock);
  12925. };
  12926. // WebSocket upgrade
  12927. // Run pre_routing_handler_ and pre_request_handler_ before upgrading so
  12928. // that authentication and other middleware can reject the request with an
  12929. // HTTP response (e.g., 401) before the protocol switches.
  12930. // The response says so when this connection closes after it.
  12931. auto close_after_response = close_connection || connection_closed;
  12932. // An upgrade request has been through pre-routing before it reaches routing()
  12933. auto is_upgrade = detail::is_websocket_upgrade(req);
  12934. if (is_upgrade) {
  12935. // A response given here leaves the body unread, and it would be parsed as
  12936. // the next request.
  12937. auto close_if_answered =
  12938. close_after_response || detail::has_framed_body(req);
  12939. if (pre_routing_handler_ &&
  12940. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12941. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12942. return write_response_with_content(strm, close_if_answered, req, res);
  12943. }
  12944. // Find matching WebSocket handler
  12945. for (const auto &entry : websocket_handlers_) {
  12946. if (entry.matcher->match(req)) {
  12947. req.matched_route = entry.matcher->pattern();
  12948. if (pre_request_handler_ &&
  12949. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12950. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12951. return write_response_with_content(strm, close_if_answered, req, res);
  12952. }
  12953. // Compute accept key
  12954. auto client_key = req.get_header_value("Sec-WebSocket-Key");
  12955. auto accept_key = detail::websocket_accept_key(client_key);
  12956. // Negotiate subprotocol
  12957. std::string selected_subprotocol;
  12958. if (entry.sub_protocol_selector) {
  12959. auto protocol_header = detail::get_combined_header_value(
  12960. req.headers, "Sec-WebSocket-Protocol");
  12961. if (!protocol_header.empty()) {
  12962. std::vector<std::string> protocols;
  12963. detail::split(protocol_header.data(),
  12964. protocol_header.data() + protocol_header.size(), ',',
  12965. [&](const char *b, const char *e) {
  12966. protocols.emplace_back(b, e);
  12967. });
  12968. selected_subprotocol = entry.sub_protocol_selector(protocols);
  12969. // Ignore a selection the client did not offer (RFC 6455 4.2.2)
  12970. if (std::find(protocols.begin(), protocols.end(),
  12971. selected_subprotocol) == protocols.end()) {
  12972. selected_subprotocol.clear();
  12973. }
  12974. }
  12975. }
  12976. // Send 101 Switching Protocols
  12977. std::string handshake_response = "HTTP/1.1 101 Switching Protocols\r\n"
  12978. "Upgrade: websocket\r\n"
  12979. "Connection: Upgrade\r\n"
  12980. "Sec-WebSocket-Accept: " +
  12981. accept_key + "\r\n";
  12982. if (!selected_subprotocol.empty()) {
  12983. if (!detail::fields::is_field_value(selected_subprotocol)) {
  12984. return false;
  12985. }
  12986. handshake_response +=
  12987. "Sec-WebSocket-Protocol: " + selected_subprotocol + "\r\n";
  12988. }
  12989. handshake_response += "\r\n";
  12990. if (strm.write(handshake_response.data(), handshake_response.size()) <
  12991. 0) {
  12992. return false;
  12993. }
  12994. connection_closed = true;
  12995. if (websocket_upgraded) { *websocket_upgraded = true; }
  12996. {
  12997. #ifdef CPPHTTPLIB_SSL_ENABLED
  12998. if (req.ssl) {
  12999. // wss: the heartbeat ping thread and the read path enter the same
  13000. // TLS session from different threads. Hand the WebSocket a stream
  13001. // that serializes every TLS call, so the shared SSLSocketStream on
  13002. // the plain HTTP/HTTPS paths stays untouched.
  13003. auto ws_strm =
  13004. std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  13005. strm.socket(), const_cast<tls::session_t>(req.ssl),
  13006. CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0,
  13007. write_timeout_sec_, write_timeout_usec_));
  13008. ws::WebSocket ws(std::move(ws_strm), req, true,
  13009. websocket_ping_interval_sec_,
  13010. websocket_max_missed_pongs_);
  13011. entry.handler(req, ws);
  13012. return true;
  13013. }
  13014. #endif
  13015. // Use WebSocket-specific read timeout instead of HTTP timeout
  13016. strm.set_read_timeout(CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND,
  13017. 0);
  13018. ws::WebSocket ws(strm, req, true, websocket_ping_interval_sec_,
  13019. websocket_max_missed_pongs_);
  13020. entry.handler(req, ws);
  13021. }
  13022. return true;
  13023. }
  13024. }
  13025. // No WebSocket route: route it as a plain HTTP request
  13026. }
  13027. // Routing
  13028. auto routed = false;
  13029. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  13030. routed = routing(req, res, strm, is_upgrade);
  13031. #else
  13032. try {
  13033. routed = routing(req, res, strm, is_upgrade);
  13034. } catch (std::exception &) {
  13035. if (exception_handler_) {
  13036. auto ep = std::current_exception();
  13037. exception_handler_(req, res, ep);
  13038. routed = true;
  13039. } else {
  13040. res.status = StatusCode::InternalServerError_500;
  13041. }
  13042. } catch (...) {
  13043. if (exception_handler_) {
  13044. auto ep = std::current_exception();
  13045. exception_handler_(req, res, ep);
  13046. routed = true;
  13047. } else {
  13048. res.status = StatusCode::InternalServerError_500;
  13049. }
  13050. }
  13051. #endif
  13052. auto ret = false;
  13053. if (routed) {
  13054. if (res.status == -1) {
  13055. res.status = req.ranges.empty() ? StatusCode::OK_200
  13056. : StatusCode::PartialContent_206;
  13057. }
  13058. // Before the Range checks below, so they see the body's own length.
  13059. detail::prefer_assigned_body(res);
  13060. // Serve file content by using a content provider
  13061. auto file_open_error = false;
  13062. if (!res.file_content_path_.empty()) {
  13063. const auto &path = res.file_content_path_;
  13064. auto mm = std::make_shared<detail::mmap>(path.c_str());
  13065. if (!mm->is_open()) {
  13066. res.status = StatusCode::NotFound_404;
  13067. output_error_log(Error::OpenFile, &req);
  13068. file_open_error = true;
  13069. } else {
  13070. auto content_type = res.file_content_content_type_;
  13071. if (content_type.empty()) {
  13072. // One the handler set after set_file_content()
  13073. content_type = res.get_header_value("Content-Type");
  13074. }
  13075. if (content_type.empty()) {
  13076. content_type = detail::find_content_type(
  13077. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  13078. }
  13079. detail::set_file_content_provider(
  13080. res, mm, content_type,
  13081. static_file_encoding(req, res, content_type, mm->size()));
  13082. }
  13083. }
  13084. if (file_open_error) {
  13085. ret = write_response(strm, close_after_response, req, res);
  13086. } else if (detail::range_error(req, res)) {
  13087. detail::clear_content(res);
  13088. res.status = StatusCode::RangeNotSatisfiable_416;
  13089. ret = write_response(strm, close_after_response, req, res);
  13090. } else {
  13091. ret = write_response_with_content(strm, close_after_response, req, res);
  13092. }
  13093. } else {
  13094. if (res.status == -1) { res.status = StatusCode::NotFound_404; }
  13095. ret = write_response(strm, close_after_response, req, res);
  13096. }
  13097. // Drain any unconsumed framed body to prevent request smuggling on
  13098. // keep-alive. Without framing there is no body to drain — reading would
  13099. // consume the next request (issue #2450). If the response has committed the
  13100. // connection to close, there is no next request to protect. A body read in
  13101. // part cannot be drained from where it stopped, so the connection closes.
  13102. if (!req.body_consumed_ && detail::has_framed_body(req) &&
  13103. !detail::has_header_token(res.headers, "Connection", "close")) {
  13104. int dummy_status;
  13105. if (req.body_read_started_ ||
  13106. !detail::read_content(
  13107. strm, req, payload_max_length_, dummy_status, nullptr,
  13108. [](const char *, size_t, size_t, size_t) { return true; }, false)) {
  13109. connection_closed = true;
  13110. }
  13111. }
  13112. return ret;
  13113. }
  13114. inline bool Server::is_valid() const { return !has_invalid_registration_; }
  13115. inline bool Server::process_and_close_socket(socket_t sock) {
  13116. std::string remote_addr;
  13117. int remote_port = 0;
  13118. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  13119. std::string local_addr;
  13120. int local_port = 0;
  13121. detail::get_local_ip_and_port(sock, local_addr, local_port);
  13122. bool websocket_upgraded = false;
  13123. auto ret = serve_guarded([&]() {
  13124. return detail::process_server_socket(
  13125. svr_sock_, sock, keep_alive_max_count_, keep_alive_timeout_sec_,
  13126. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13127. write_timeout_usec_,
  13128. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  13129. return process_request(strm, remote_addr, remote_port, local_addr,
  13130. local_port, close_connection,
  13131. connection_closed, nullptr,
  13132. &websocket_upgraded);
  13133. });
  13134. });
  13135. detail::drain_and_close_socket(sock);
  13136. return ret;
  13137. }
  13138. inline void Server::output_log(const Request &req, const Response &res) const {
  13139. if (logger_) {
  13140. std::lock_guard<std::mutex> guard(logger_mutex_);
  13141. logger_(req, res);
  13142. }
  13143. }
  13144. inline void Server::output_pre_compression_log(const Request &req,
  13145. const Response &res) const {
  13146. if (pre_compression_logger_) {
  13147. std::lock_guard<std::mutex> guard(logger_mutex_);
  13148. pre_compression_logger_(req, res);
  13149. }
  13150. }
  13151. inline void Server::output_error_log(const Error &err,
  13152. const Request *req) const {
  13153. if (error_logger_) {
  13154. std::lock_guard<std::mutex> guard(logger_mutex_);
  13155. error_logger_(err, req);
  13156. }
  13157. }
  13158. /*
  13159. * Group 5: ClientImpl and Client (Universal) implementation
  13160. */
  13161. // HTTP client implementation
  13162. inline ClientImpl::ClientImpl(const std::string &host)
  13163. : ClientImpl(host, 80, std::string(), std::string()) {}
  13164. inline ClientImpl::ClientImpl(const std::string &host, int port)
  13165. : ClientImpl(host, port, std::string(), std::string()) {}
  13166. inline ClientImpl::ClientImpl(const std::string &host, int port,
  13167. const std::string &client_cert_path,
  13168. const std::string &client_key_path)
  13169. : host_(detail::escape_abstract_namespace_unix_domain(host)), port_(port),
  13170. client_cert_path_(client_cert_path), client_key_path_(client_key_path) {}
  13171. inline ClientImpl::~ClientImpl() {
  13172. // Wait until all the requests in flight are handled.
  13173. size_t retry_count = 10;
  13174. while (retry_count-- > 0) {
  13175. {
  13176. std::lock_guard<std::mutex> guard(socket_mutex_);
  13177. if (socket_requests_in_flight_ == 0) { break; }
  13178. }
  13179. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  13180. }
  13181. std::lock_guard<std::mutex> guard(socket_mutex_);
  13182. shutdown_socket(socket_);
  13183. close_socket(socket_);
  13184. }
  13185. inline bool ClientImpl::is_valid() const { return true; }
  13186. inline bool
  13187. ClientImpl::is_proxy_enabled_for_host(const std::string &host) const {
  13188. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  13189. if (no_proxy_entries_.empty()) { return true; }
  13190. // host_ is const so its normalized form is invariant; cache it. The
  13191. // cross-host path (setup_redirect_client passing next_host) re-normalizes.
  13192. if (host == host_) {
  13193. if (!host_normalized_valid_) {
  13194. host_normalized_ = detail::normalize_target(host_);
  13195. host_normalized_valid_ = true;
  13196. }
  13197. return !detail::host_matches_no_proxy(host_normalized_, no_proxy_entries_);
  13198. }
  13199. auto target = detail::normalize_target(host);
  13200. return !detail::host_matches_no_proxy(target, no_proxy_entries_);
  13201. }
  13202. inline socket_t ClientImpl::create_client_socket(Error &error) const {
  13203. if (is_proxy_enabled_for_host(host_)) {
  13204. return detail::create_client_socket(
  13205. proxy_host_, std::string(), proxy_port_, address_family_, tcp_nodelay_,
  13206. ipv6_v6only_, socket_options_, connection_timeout_sec_,
  13207. connection_timeout_usec_, read_timeout_sec_, read_timeout_usec_,
  13208. write_timeout_sec_, write_timeout_usec_, interface_, error);
  13209. }
  13210. // Check is custom IP or hostname specified for host_
  13211. std::string connect_host;
  13212. std::string ip;
  13213. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  13214. return detail::create_client_socket(
  13215. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  13216. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  13217. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13218. write_timeout_usec_, interface_, error);
  13219. }
  13220. inline bool ClientImpl::create_and_connect_socket(Socket &socket,
  13221. Error &error) {
  13222. auto sock = create_client_socket(error);
  13223. if (sock == INVALID_SOCKET) { return false; }
  13224. socket.sock = sock;
  13225. return true;
  13226. }
  13227. inline bool ClientImpl::ensure_socket_connection(Socket &socket, Error &error) {
  13228. return create_and_connect_socket(socket, error);
  13229. }
  13230. inline bool ClientImpl::setup_proxy_connection(
  13231. Socket & /*socket*/,
  13232. std::chrono::time_point<std::chrono::steady_clock> /*start_time*/,
  13233. Response & /*res*/, bool & /*success*/, Error & /*error*/) {
  13234. return true;
  13235. }
  13236. inline void ClientImpl::shutdown_ssl(Socket & /*socket*/,
  13237. bool /*shutdown_gracefully*/) {
  13238. // If there are any requests in flight from threads other than us, then it's
  13239. // a thread-unsafe race because individual ssl* objects are not thread-safe.
  13240. assert(socket_requests_in_flight_ == 0 ||
  13241. socket_requests_are_from_thread_ == std::this_thread::get_id());
  13242. }
  13243. inline void ClientImpl::shutdown_socket(Socket &socket) const {
  13244. if (socket.sock == INVALID_SOCKET) { return; }
  13245. detail::shutdown_socket(socket.sock);
  13246. }
  13247. inline void ClientImpl::close_socket(Socket &socket) {
  13248. // If there are requests in flight in another thread, usually closing
  13249. // the socket will be fine and they will simply receive an error when
  13250. // using the closed socket, but it is still a bug since rarely the OS
  13251. // may reassign the socket id to be used for a new socket, and then
  13252. // suddenly they will be operating on a live socket that is different
  13253. // than the one they intended!
  13254. assert(socket_requests_in_flight_ == 0 ||
  13255. socket_requests_are_from_thread_ == std::this_thread::get_id());
  13256. // It is also a bug if this happens while SSL is still active
  13257. #ifdef CPPHTTPLIB_SSL_ENABLED
  13258. assert(socket.ssl == nullptr);
  13259. #endif
  13260. if (socket.sock == INVALID_SOCKET) { return; }
  13261. detail::close_socket(socket.sock);
  13262. socket.sock = INVALID_SOCKET;
  13263. }
  13264. inline void ClientImpl::disconnect(bool gracefully) {
  13265. shutdown_ssl(socket_, gracefully);
  13266. shutdown_socket(socket_);
  13267. close_socket(socket_);
  13268. }
  13269. inline bool ClientImpl::read_response_line(Stream &strm, const Request &req,
  13270. Response &res,
  13271. bool skip_100_continue) const {
  13272. std::array<char, 2048> buf{};
  13273. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  13274. if (!line_reader.getline()) { return false; }
  13275. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  13276. res.reason)) {
  13277. return req.method == "CONNECT";
  13278. }
  13279. // Skip interim (1xx) responses along with their header fields, except a 100
  13280. // Continue the caller handles itself for Expect: 100-continue. 101 ends
  13281. // HTTP on the connection, so it is final. A server sending them without end
  13282. // would hold the client, so there may be only so many.
  13283. size_t interim_count = 0;
  13284. while (100 <= res.status && res.status < 200 &&
  13285. res.status != StatusCode::SwitchingProtocol_101 &&
  13286. (skip_100_continue || res.status != StatusCode::Continue_100)) {
  13287. if (++interim_count > CPPHTTPLIB_INTERIM_RESPONSE_MAX_COUNT) {
  13288. return false;
  13289. }
  13290. Headers interim_headers;
  13291. if (!detail::read_headers(strm, interim_headers)) { return false; }
  13292. if (!line_reader.getline()) { return false; } // next response line
  13293. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  13294. res.reason)) {
  13295. return false;
  13296. }
  13297. }
  13298. return true;
  13299. }
  13300. inline bool ClientImpl::send(Request &req, Response &res, Error &error) {
  13301. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  13302. // A same-origin redirect and a digest retry send through here again. Only
  13303. // the call the caller made reports a failure, once, with its request.
  13304. auto outermost = send_depth_++ == 0;
  13305. auto se = detail::scope_exit([&] { send_depth_--; });
  13306. if (outermost) { error = Error::Success; }
  13307. auto ret = send_(req, res, error);
  13308. if (error == Error::SSLPeerCouldBeClosed_) {
  13309. assert(!ret);
  13310. ret = send_(req, res, error);
  13311. // If still failing with SSLPeerCouldBeClosed_, convert to Read error
  13312. if (error == Error::SSLPeerCouldBeClosed_) { error = Error::Read; }
  13313. }
  13314. // Also an answer that carries an error, such as a proxy's 407
  13315. if (outermost && error != Error::Success) { output_error_log(error, &req); }
  13316. return ret;
  13317. }
  13318. inline bool ClientImpl::send_(Request &req, Response &res, Error &error) {
  13319. #ifdef CPPHTTPLIB_SSL_ENABLED
  13320. // Don't let an earlier attempt's TLS error show up in this one's Result. A
  13321. // client that failed to set up its TLS context keeps reporting why.
  13322. if (is_valid()) {
  13323. last_ssl_error_ = 0;
  13324. last_backend_error_ = 0;
  13325. }
  13326. #endif
  13327. {
  13328. std::lock_guard<std::mutex> guard(socket_mutex_);
  13329. // Set this to false immediately - if it ever gets set to true by the end
  13330. // of the request, we know another thread instructed us to close the
  13331. // socket.
  13332. socket_should_be_closed_when_request_is_done_ = false;
  13333. auto is_alive = false;
  13334. if (socket_.is_open()) {
  13335. is_alive = detail::is_socket_alive(socket_.sock);
  13336. #ifdef CPPHTTPLIB_SSL_ENABLED
  13337. if (is_alive && is_ssl()) {
  13338. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13339. is_alive = false;
  13340. }
  13341. }
  13342. #endif
  13343. if (!is_alive) {
  13344. // Peer seems gone — non-graceful shutdown to avoid SIGPIPE.
  13345. disconnect(/*gracefully=*/false);
  13346. }
  13347. }
  13348. if (!is_alive) {
  13349. if (!ensure_socket_connection(socket_, error)) { return false; }
  13350. {
  13351. auto success = true;
  13352. if (!setup_proxy_connection(socket_, req.start_time_, res, success,
  13353. error)) {
  13354. return success;
  13355. }
  13356. }
  13357. }
  13358. // Mark the current socket as being in use so that it cannot be closed by
  13359. // anyone else while this request is ongoing, even though we will be
  13360. // releasing the mutex.
  13361. if (socket_requests_in_flight_ > 1) {
  13362. assert(socket_requests_are_from_thread_ == std::this_thread::get_id());
  13363. }
  13364. socket_requests_in_flight_ += 1;
  13365. socket_requests_are_from_thread_ = std::this_thread::get_id();
  13366. }
  13367. for (const auto &header : default_headers_) {
  13368. if (req.headers.find(header.first) == req.headers.end()) {
  13369. req.headers.insert(header);
  13370. }
  13371. }
  13372. auto ret = false;
  13373. auto close_connection = !keep_alive_;
  13374. auto se = detail::scope_exit([&]() {
  13375. // Briefly lock mutex in order to mark that a request is no longer ongoing
  13376. std::lock_guard<std::mutex> guard(socket_mutex_);
  13377. socket_requests_in_flight_ -= 1;
  13378. if (socket_requests_in_flight_ <= 0) {
  13379. assert(socket_requests_in_flight_ == 0);
  13380. socket_requests_are_from_thread_ = std::thread::id();
  13381. }
  13382. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  13383. !ret) {
  13384. disconnect(/*gracefully=*/true);
  13385. }
  13386. });
  13387. ret = process_socket(socket_, req.start_time_, [&](Stream &strm) {
  13388. return handle_request(strm, req, res, close_connection, error);
  13389. });
  13390. if (!ret) {
  13391. if (error == Error::Success) { error = Error::Unknown; }
  13392. }
  13393. return ret;
  13394. }
  13395. inline Result ClientImpl::send(const Request &req) {
  13396. auto req2 = req;
  13397. return send_(std::move(req2));
  13398. }
  13399. inline Result ClientImpl::send_(Request &&req) {
  13400. auto res = detail::make_unique<Response>();
  13401. auto error = Error::Success;
  13402. #ifdef CPPHTTPLIB_SSL_ENABLED
  13403. // Hold the request lock until the Result has read this request's TLS error
  13404. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  13405. #endif
  13406. auto ret = send(req, *res, error);
  13407. #ifdef CPPHTTPLIB_SSL_ENABLED
  13408. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers),
  13409. last_ssl_error_, last_backend_error_};
  13410. #else
  13411. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers)};
  13412. #endif
  13413. }
  13414. inline void ClientImpl::prepare_default_headers(Request &r, bool for_stream,
  13415. const std::string &ct) {
  13416. (void)for_stream;
  13417. // Default headers are meant for the origin and may carry its credentials, so
  13418. // keep them off the CONNECT request the proxy reads.
  13419. if (r.method != "CONNECT") {
  13420. for (const auto &header : default_headers_) {
  13421. if (!r.has_header(header.first)) { r.headers.insert(header); }
  13422. }
  13423. }
  13424. // RFC 9110 5.3 recommends sending control data such as Host first, so
  13425. // prepend it rather than appending it after the caller's own fields.
  13426. if (!r.has_header("Host")) {
  13427. r.headers.emplace_front(
  13428. "Host", detail::make_default_host_header_value(host_, port_, is_ssl(),
  13429. address_family_));
  13430. }
  13431. if (!r.has_header("Accept")) { r.headers.emplace("Accept", "*/*"); }
  13432. if (!r.content_receiver) {
  13433. if (!r.has_header("Accept-Encoding")) {
  13434. std::string accept_encoding;
  13435. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  13436. accept_encoding = "br";
  13437. #endif
  13438. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  13439. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13440. accept_encoding += "gzip, deflate";
  13441. #endif
  13442. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  13443. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13444. accept_encoding += "zstd";
  13445. #endif
  13446. r.set_header("Accept-Encoding", accept_encoding);
  13447. }
  13448. detail::add_default_user_agent_header(r);
  13449. }
  13450. if (!r.body.empty()) {
  13451. if (!ct.empty() && !r.has_header("Content-Type")) {
  13452. r.headers.emplace("Content-Type", ct);
  13453. }
  13454. if (!r.has_header("Content-Length")) {
  13455. r.headers.emplace("Content-Length", std::to_string(r.body.size()));
  13456. }
  13457. }
  13458. }
  13459. inline ClientImpl::StreamHandle
  13460. ClientImpl::open_stream(const std::string &method, const std::string &path,
  13461. const Params &params, const Headers &headers,
  13462. const std::string &body,
  13463. const std::string &content_type) {
  13464. // Encode the target exactly like the buffered send path does, so that the
  13465. // same `path` produces the same request line through either API.
  13466. auto raw_query_path =
  13467. params.empty() ? path : append_query_params(path, params);
  13468. Request req;
  13469. req.method = method;
  13470. req.path = detail::encode_request_target(raw_query_path, path_encode_);
  13471. req.headers = headers;
  13472. req.body = body;
  13473. prepare_default_headers(req, true, content_type);
  13474. auto handle = open_stream_(req);
  13475. // Like a buffered request, a stream that fails to open is reported once
  13476. if (handle.error != Error::Success) { output_error_log(handle.error, &req); }
  13477. return handle;
  13478. }
  13479. inline ClientImpl::StreamHandle ClientImpl::open_stream_(Request &req) {
  13480. StreamHandle handle;
  13481. handle.response = detail::make_unique<Response>();
  13482. handle.error = Error::Success;
  13483. handle.connection_ = detail::make_unique<ClientConnection>();
  13484. {
  13485. std::lock_guard<std::mutex> guard(socket_mutex_);
  13486. auto is_alive = false;
  13487. if (socket_.is_open()) {
  13488. is_alive = detail::is_socket_alive(socket_.sock);
  13489. #ifdef CPPHTTPLIB_SSL_ENABLED
  13490. if (is_alive && is_ssl()) {
  13491. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13492. is_alive = false;
  13493. }
  13494. }
  13495. #endif
  13496. if (!is_alive) { disconnect(/*gracefully=*/false); }
  13497. }
  13498. if (!is_alive) {
  13499. if (!ensure_socket_connection(socket_, handle.error)) {
  13500. handle.response.reset();
  13501. return handle;
  13502. }
  13503. {
  13504. auto success = true;
  13505. auto start_time = std::chrono::steady_clock::now();
  13506. if (!setup_proxy_connection(socket_, start_time, *handle.response,
  13507. success, handle.error)) {
  13508. if (!success) { handle.response.reset(); }
  13509. return handle;
  13510. }
  13511. }
  13512. }
  13513. transfer_socket_ownership_to_handle(handle);
  13514. }
  13515. #ifdef CPPHTTPLIB_SSL_ENABLED
  13516. if (is_ssl() && handle.connection_->session) {
  13517. handle.socket_stream_ = detail::make_unique<detail::SSLSocketStream>(
  13518. handle.connection_->sock, handle.connection_->session,
  13519. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13520. write_timeout_usec_);
  13521. } else {
  13522. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13523. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13524. write_timeout_sec_, write_timeout_usec_);
  13525. }
  13526. #else
  13527. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13528. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13529. write_timeout_sec_, write_timeout_usec_);
  13530. #endif
  13531. handle.stream_ = handle.socket_stream_.get();
  13532. auto &strm = *handle.stream_;
  13533. // After connecting, as for a buffered request
  13534. add_credential_headers(req);
  13535. // Build the request line and headers in memory first, like write_request()
  13536. // does, so that a rejected header leaves nothing on the wire.
  13537. {
  13538. detail::BufferStream bstrm;
  13539. if (detail::write_request_line(bstrm, req.method,
  13540. proxy_target_prefix() + req.path) < 0) {
  13541. handle.error = Error::Write;
  13542. handle.response.reset();
  13543. return handle;
  13544. }
  13545. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13546. handle.error)) {
  13547. handle.response.reset();
  13548. return handle;
  13549. }
  13550. const auto &data = bstrm.get_buffer();
  13551. if (!detail::write_data(strm, data.data(), data.size())) {
  13552. handle.error = Error::Write;
  13553. handle.response.reset();
  13554. return handle;
  13555. }
  13556. }
  13557. if (!req.body.empty()) {
  13558. if (strm.write(req.body.data(), req.body.size()) < 0) {
  13559. handle.error = Error::Write;
  13560. handle.response.reset();
  13561. return handle;
  13562. }
  13563. }
  13564. if (!read_response_line(strm, req, *handle.response) ||
  13565. !detail::read_headers(strm, handle.response->headers)) {
  13566. handle.error = Error::Read;
  13567. handle.response.reset();
  13568. return handle;
  13569. }
  13570. handle.body_reader_.stream = handle.stream_;
  13571. handle.body_reader_.payload_max_length = payload_max_length_;
  13572. // RFC 9112 6.3: a response to HEAD, and a 204 or 304 response, ends with its
  13573. // header section, so none of its framing or coding headers apply.
  13574. if (req.method == "HEAD" ||
  13575. handle.response->status == StatusCode::NoContent_204 ||
  13576. handle.response->status == StatusCode::NotModified_304) {
  13577. handle.body_reader_.eof = true;
  13578. return handle;
  13579. }
  13580. // Same framing check as ClientImpl::process_request()
  13581. if (detail::has_conflicting_content_length(handle.response->headers)) {
  13582. handle.error = Error::Read;
  13583. handle.response.reset();
  13584. return handle;
  13585. }
  13586. if (handle.response->has_header("Content-Length")) {
  13587. bool is_invalid = false;
  13588. auto content_length = detail::get_header_value_u64(
  13589. handle.response->headers, "Content-Length", 0, 0, is_invalid);
  13590. if (is_invalid) {
  13591. handle.error = Error::Read;
  13592. handle.response.reset();
  13593. return handle;
  13594. }
  13595. handle.body_reader_.has_content_length = true;
  13596. handle.body_reader_.content_length = content_length;
  13597. }
  13598. handle.body_reader_.chunked =
  13599. detail::is_chunked_transfer_encoding(handle.response->headers);
  13600. auto content_encoding = detail::get_combined_header_value(
  13601. handle.response->headers, "Content-Encoding");
  13602. if (!content_encoding.empty()) {
  13603. // Same policy as prepare_content_receiver(): reject a coding we know about
  13604. // but were not built with, pass an unrecognized one through as-is.
  13605. handle.decompressor_ = detail::create_decompressor(content_encoding);
  13606. if (!handle.decompressor_) {
  13607. if (detail::is_known_content_encoding(content_encoding)) {
  13608. handle.error = Error::UnsupportedContentEncoding;
  13609. handle.response.reset();
  13610. return handle;
  13611. }
  13612. } else if (!handle.decompressor_->is_valid()) {
  13613. handle.error = Error::Compression;
  13614. handle.response.reset();
  13615. return handle;
  13616. }
  13617. }
  13618. return handle;
  13619. }
  13620. inline ssize_t ClientImpl::StreamHandle::read(char *buf, size_t len) {
  13621. if (!is_valid() || !response) { return -1; }
  13622. auto n = decompressor_
  13623. ? read_with_decompression(buf, len)
  13624. : detail::read_body_content(stream_, body_reader_, buf, len);
  13625. if (n == 0) { parse_trailers_if_needed(); }
  13626. return n;
  13627. }
  13628. inline ssize_t ClientImpl::StreamHandle::read_with_decompression(char *buf,
  13629. size_t len) {
  13630. if (decompress_offset_ < decompress_buffer_.size()) {
  13631. auto available = decompress_buffer_.size() - decompress_offset_;
  13632. auto to_copy = (std::min)(len, available);
  13633. std::memcpy(buf, decompress_buffer_.data() + decompress_offset_, to_copy);
  13634. decompress_offset_ += to_copy;
  13635. decompressed_bytes_read_ += to_copy;
  13636. return static_cast<ssize_t>(to_copy);
  13637. }
  13638. decompress_buffer_.clear();
  13639. decompress_offset_ = 0;
  13640. constexpr size_t kDecompressionBufferSize = 8192;
  13641. char compressed_buf[kDecompressionBufferSize];
  13642. while (true) {
  13643. auto n = detail::read_body_content(stream_, body_reader_, compressed_buf,
  13644. sizeof(compressed_buf));
  13645. if (n <= 0) { return n; }
  13646. auto exceeded = false;
  13647. bool decompress_ok = decompressor_->decompress(
  13648. compressed_buf, static_cast<size_t>(n),
  13649. [&](const char *data, size_t data_len) {
  13650. decompress_buffer_.append(data, data_len);
  13651. auto limit = body_reader_.payload_max_length;
  13652. exceeded =
  13653. limit > 0 &&
  13654. decompressed_bytes_read_ + decompress_buffer_.size() > limit;
  13655. return !exceeded;
  13656. });
  13657. if (!decompress_ok) {
  13658. body_reader_.last_error =
  13659. exceeded ? Error::ExceedMaxPayloadSize : Error::Read;
  13660. return -1;
  13661. }
  13662. if (!decompress_buffer_.empty()) { break; }
  13663. }
  13664. auto to_copy = (std::min)(len, decompress_buffer_.size());
  13665. std::memcpy(buf, decompress_buffer_.data(), to_copy);
  13666. decompress_offset_ = to_copy;
  13667. decompressed_bytes_read_ += to_copy;
  13668. return static_cast<ssize_t>(to_copy);
  13669. }
  13670. inline void ClientImpl::StreamHandle::parse_trailers_if_needed() {
  13671. // The trailers follow the last chunk, so there are none before it
  13672. auto &decoder = body_reader_.chunked_decoder;
  13673. if (!response || trailers_parsed_ || !decoder || !decoder->finished) {
  13674. return;
  13675. }
  13676. trailers_parsed_ = true;
  13677. decoder->parse_trailers_into(response->trailers, response->headers);
  13678. }
  13679. namespace detail {
  13680. inline ChunkedDecoder::ChunkedDecoder(Stream &s) : strm(s) {}
  13681. inline ssize_t ChunkedDecoder::read_payload(char *buf, size_t len,
  13682. size_t &out_chunk_offset,
  13683. size_t &out_chunk_total) {
  13684. if (finished) { return 0; }
  13685. if (chunk_remaining == 0) {
  13686. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13687. if (!lr.getline()) { return -1; }
  13688. // Everything below is bounded by eol rather than by the buffer's NUL, so
  13689. // the line terminator is never mistaken for line content.
  13690. const char *eol = lr.ptr() + lr.size();
  13691. if (lr.end_with_crlf()) {
  13692. eol -= 2;
  13693. } else if (eol != lr.ptr() && eol[-1] == '\n') {
  13694. // Only reachable under CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR, where
  13695. // getline() ends the line on a bare LF. That LF is the terminator, so it
  13696. // has to come off here or the check below would reject the line.
  13697. eol -= 1;
  13698. }
  13699. // RFC 9112 §7.1: chunk-size = 1*HEXDIG
  13700. const char *p = lr.ptr();
  13701. int v = 0;
  13702. if (p == eol || !is_hex(*p, v)) { return -1; }
  13703. size_t chunk_len = 0;
  13704. constexpr size_t chunk_len_max = (std::numeric_limits<size_t>::max)();
  13705. for (; p < eol && is_hex(*p, v); ++p) {
  13706. if (chunk_len > (chunk_len_max >> 4)) { return -1; }
  13707. chunk_len = (chunk_len << 4) | static_cast<size_t>(v);
  13708. }
  13709. while (p < eol && is_space_or_tab(*p)) {
  13710. ++p;
  13711. }
  13712. // RFC 9112 §7.1.1: only a chunk-ext may sit between the size and the line
  13713. // terminator, and it is built from tokens and quoted-strings, so it never
  13714. // holds a CR, LF or any other control character. getline() reads up to the
  13715. // CRLF, so a bare LF left in here would be swallowed as extension text
  13716. // while an intermediary that ends the line on it delimits the chunks
  13717. // differently, and the two disagree on where the body ends (request
  13718. // smuggling).
  13719. if (p < eol && *p != ';') { return -1; }
  13720. for (; p < eol; ++p) {
  13721. if (!is_space_or_tab(*p) && !fields::is_field_vchar(*p)) { return -1; }
  13722. }
  13723. // The bytes around the data are no payload, so they are counted on their
  13724. // own, as Go does: each chunk may spend 16 bytes and twice its data on
  13725. // them, which lets a stream send a byte at a time, and what goes past that
  13726. // in padding, leading zeros and extensions builds up to one header field.
  13727. overhead += lr.size() + 2;
  13728. overhead = overhead > 16 ? overhead - 16 : 0;
  13729. overhead = chunk_len > overhead / 2 ? 0 : overhead - 2 * chunk_len;
  13730. if (overhead > CPPHTTPLIB_HEADER_MAX_LENGTH) { return -1; }
  13731. if (chunk_len == 0) {
  13732. chunk_remaining = 0;
  13733. finished = true;
  13734. out_chunk_offset = 0;
  13735. out_chunk_total = 0;
  13736. return 0;
  13737. }
  13738. chunk_remaining = chunk_len;
  13739. last_chunk_total = chunk_remaining;
  13740. last_chunk_offset = 0;
  13741. }
  13742. auto to_read = (std::min)(chunk_remaining, len);
  13743. auto n = strm.read(buf, to_read);
  13744. if (n <= 0) { return -1; }
  13745. auto offset_before = last_chunk_offset;
  13746. last_chunk_offset += static_cast<size_t>(n);
  13747. chunk_remaining -= static_cast<size_t>(n);
  13748. out_chunk_offset = offset_before;
  13749. out_chunk_total = last_chunk_total;
  13750. if (chunk_remaining == 0) {
  13751. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13752. if (!lr.getline()) { return -1; }
  13753. if (std::strcmp(lr.ptr(), "\r\n") != 0) { return -1; }
  13754. }
  13755. return n;
  13756. }
  13757. inline bool ChunkedDecoder::parse_trailers_into(Headers &dest,
  13758. const Headers &src_headers) {
  13759. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13760. if (!lr.getline()) { return false; }
  13761. return parse_trailers(lr, dest, src_headers);
  13762. }
  13763. // A 3xx without a Location, such as a 304, is a final response
  13764. inline bool is_redirect(const Response &res) {
  13765. return 300 < res.status && res.status < 400 &&
  13766. !res.get_header_value("Location").empty();
  13767. }
  13768. } // namespace detail
  13769. inline void
  13770. ClientImpl::transfer_socket_ownership_to_handle(StreamHandle &handle) {
  13771. handle.connection_->sock = socket_.sock;
  13772. #ifdef CPPHTTPLIB_SSL_ENABLED
  13773. handle.connection_->session = socket_.ssl;
  13774. socket_.ssl = nullptr;
  13775. #endif
  13776. socket_.sock = INVALID_SOCKET;
  13777. }
  13778. // A plain HTTP proxy reads the target in absolute-form (RFC 9112 3.2.2)
  13779. inline std::string ClientImpl::proxy_target_prefix() const {
  13780. if (is_ssl() || !is_proxy_enabled_for_host(host_)) { return std::string(); }
  13781. return "http://" + detail::make_host_and_port_string(host_, port_, false);
  13782. }
  13783. inline bool ClientImpl::handle_request(Stream &strm, Request &req,
  13784. Response &res, bool close_connection,
  13785. Error &error) {
  13786. if (req.path.empty()) {
  13787. error = Error::Connection;
  13788. return false;
  13789. }
  13790. auto req_save = req;
  13791. bool ret;
  13792. auto prefix = proxy_target_prefix();
  13793. if (!prefix.empty()) {
  13794. auto req2 = req;
  13795. req2.path = prefix + req.path;
  13796. ret = process_request(strm, req2, res, close_connection, error);
  13797. req = std::move(req2);
  13798. req.path = req_save.path;
  13799. } else {
  13800. ret = process_request(strm, req, res, close_connection, error);
  13801. }
  13802. if (!ret) { return false; }
  13803. {
  13804. // NOTE: this requires a not-entirely-obvious chain of calls to be correct
  13805. // for this to be safe.
  13806. // This is safe to call because handle_request is only called by send_
  13807. // which locks the request mutex during the process. It would be a bug
  13808. // to call it from a different thread since it's a thread-safety issue
  13809. // to do these things to the socket if another thread is using the socket.
  13810. std::lock_guard<std::mutex> guard(socket_mutex_);
  13811. // Also when the request asked for it (e.g. a body that was never sent),
  13812. // so that a redirect or an auth retry below does not reuse the socket.
  13813. if (socket_should_be_closed_when_request_is_done_ ||
  13814. detail::has_header_token(res.headers, "Connection", "close") ||
  13815. (res.version == "HTTP/1.0" && res.reason != "Connection established")) {
  13816. disconnect(/*gracefully=*/true);
  13817. }
  13818. }
  13819. if (follow_location_ && detail::is_redirect(res)) {
  13820. req = std::move(req_save);
  13821. // The client that followed the redirect has answered any challenge it
  13822. // could. Retrying below would sign another host's challenge and send it
  13823. // here.
  13824. return redirect(req, res, error);
  13825. }
  13826. #ifdef CPPHTTPLIB_SSL_ENABLED
  13827. if ((res.status == StatusCode::Unauthorized_401 ||
  13828. res.status == StatusCode::ProxyAuthenticationRequired_407) &&
  13829. req.authorization_count_ < 5) {
  13830. auto is_proxy = res.status == StatusCode::ProxyAuthenticationRequired_407;
  13831. // Only retry when the 407 actually came from a proxy hop: plain HTTP
  13832. // through an enabled proxy. HTTPS via CONNECT tunnels the 407 from the
  13833. // origin (#2457); direct/bypassed origins have no proxy hop at all.
  13834. if (is_proxy && !(!is_ssl() && is_proxy_enabled_for_host(host_))) {
  13835. return ret;
  13836. }
  13837. const auto &username =
  13838. is_proxy ? proxy_digest_auth_username_ : digest_auth_username_;
  13839. const auto &password =
  13840. is_proxy ? proxy_digest_auth_password_ : digest_auth_password_;
  13841. if (!username.empty() && !password.empty()) {
  13842. std::map<std::string, std::string> auth;
  13843. if (detail::parse_www_authenticate(res, auth, is_proxy)) {
  13844. Request new_req = req;
  13845. new_req.authorization_count_ += 1;
  13846. new_req.headers.erase(is_proxy ? "Proxy-Authorization"
  13847. : "Authorization");
  13848. new_req.headers.insert(detail::make_digest_authentication_header(
  13849. req, make_request_target(req), auth, new_req.authorization_count_,
  13850. detail::random_string(10), username, password, is_proxy));
  13851. Response new_res;
  13852. ret = send(new_req, new_res, error);
  13853. if (ret) { res = std::move(new_res); }
  13854. }
  13855. }
  13856. }
  13857. #endif
  13858. return ret;
  13859. }
  13860. inline bool ClientImpl::redirect(Request &req, Response &res, Error &error) {
  13861. if (req.redirect_count_ == 0) {
  13862. error = Error::ExceedRedirectCount;
  13863. return false;
  13864. }
  13865. auto location = res.get_header_value("location");
  13866. if (location.empty()) { return false; }
  13867. detail::UrlComponents uc;
  13868. if (!detail::parse_url(detail::resolve_relative_location(location, req.path),
  13869. uc)) {
  13870. return false;
  13871. }
  13872. // Only follow http/https redirects
  13873. if (!uc.scheme.empty() && uc.scheme != "http" && uc.scheme != "https") {
  13874. return false;
  13875. }
  13876. auto scheme = is_ssl() ? "https" : "http";
  13877. auto next_scheme = std::move(uc.scheme);
  13878. auto next_host = std::move(uc.host);
  13879. auto port_str = std::move(uc.port);
  13880. auto next_path = std::move(uc.path);
  13881. auto next_query = std::move(uc.query);
  13882. auto next_port = port_;
  13883. if (!port_str.empty()) {
  13884. if (!detail::parse_port(port_str, next_port)) { return false; }
  13885. } else if (!next_scheme.empty()) {
  13886. next_port = next_scheme == "https" ? 443 : 80;
  13887. }
  13888. if (next_scheme.empty()) { next_scheme = scheme; }
  13889. if (next_host.empty()) { next_host = host_; }
  13890. if (next_path.empty()) { next_path = "/"; }
  13891. auto path = std::move(next_path) + next_query;
  13892. // Same host redirect - use current client
  13893. if (next_scheme == scheme && next_host == host_ && next_port == port_) {
  13894. return detail::redirect(*this, req, res, path, location, error);
  13895. }
  13896. // Cross-host/scheme redirect - create new client with robust setup
  13897. return create_redirect_client(next_scheme, next_host, next_port, req, res,
  13898. path, location, error);
  13899. }
  13900. // New method for robust redirect client creation
  13901. inline bool ClientImpl::create_redirect_client(
  13902. const std::string &scheme, const std::string &host, int port, Request &req,
  13903. Response &res, const std::string &path, const std::string &location,
  13904. Error &error) {
  13905. // Determine if we need SSL
  13906. auto need_ssl = (scheme == "https");
  13907. // Clean up request headers that are host/client specific
  13908. // Remove headers that should not be carried over to new host
  13909. auto headers_to_remove = std::vector<std::string>{
  13910. "Host", "Proxy-Authorization", "Authorization", "Cookie", "Cookie2"};
  13911. for (const auto &header_name : headers_to_remove) {
  13912. auto it = req.headers.find(header_name);
  13913. while (it != req.headers.end()) {
  13914. it = req.headers.erase(it);
  13915. it = req.headers.find(header_name);
  13916. }
  13917. }
  13918. // Create appropriate client type and handle redirect
  13919. if (need_ssl) {
  13920. #ifdef CPPHTTPLIB_SSL_ENABLED
  13921. // Create SSL client for HTTPS redirect
  13922. SSLClient redirect_client(host, port);
  13923. // Setup basic client configuration first
  13924. setup_redirect_client(redirect_client);
  13925. redirect_client.enable_server_certificate_verification(
  13926. server_certificate_verification_);
  13927. redirect_client.enable_server_hostname_verification(
  13928. server_hostname_verification_);
  13929. redirect_client.system_ca_mode_ = system_ca_mode_;
  13930. // Transfer CA certificate to redirect client
  13931. redirect_client.set_ca_cert_path(ca_cert_file_path_, ca_cert_dir_path_);
  13932. if (is_ssl()) {
  13933. auto &self = static_cast<SSLClient &>(*this);
  13934. // A store given to set_ca_cert_store() lives only in this client's
  13935. // context, which then holds all that is trusted.
  13936. if (self.ca_cert_store_set_) {
  13937. std::string pem;
  13938. {
  13939. std::lock_guard<std::mutex> guard(self.ctx_mutex_);
  13940. pem = detail::ca_certs_to_pem(self.ctx_);
  13941. }
  13942. redirect_client.load_ca_cert_store(pem.data(), pem.size());
  13943. redirect_client.ca_cert_store_set_ = true;
  13944. } else if (self.custom_ca_loaded_) {
  13945. redirect_client.load_ca_cert_store(ca_cert_pem_.c_str(),
  13946. ca_cert_pem_.size());
  13947. }
  13948. redirect_client.set_session_verifier(self.session_verifier_);
  13949. if (self.server_certificate_verifier_) {
  13950. redirect_client.set_server_certificate_verifier(
  13951. self.server_certificate_verifier_);
  13952. }
  13953. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  13954. redirect_client.enable_windows_cert_verification_ =
  13955. self.enable_windows_cert_verification_;
  13956. #endif
  13957. }
  13958. // Client certificates are set through constructor for SSLClient
  13959. // NOTE: SSLClient constructor already takes client_cert_path and
  13960. // client_key_path so we need to create it properly if client certs are
  13961. // needed
  13962. // Execute the redirect
  13963. return detail::redirect(redirect_client, req, res, path, location, error);
  13964. #else
  13965. // SSL not supported - set appropriate error
  13966. error = Error::SSLConnection;
  13967. return false;
  13968. #endif
  13969. } else {
  13970. // HTTP redirect
  13971. ClientImpl redirect_client(host, port);
  13972. // Setup client with robust configuration
  13973. setup_redirect_client(redirect_client);
  13974. // Execute the redirect
  13975. return detail::redirect(redirect_client, req, res, path, location, error);
  13976. }
  13977. }
  13978. // New method for robust client setup (based on basic_manual_redirect.cpp
  13979. // logic)
  13980. template <typename ClientType>
  13981. inline void ClientImpl::setup_redirect_client(ClientType &client) {
  13982. // Copy basic settings first
  13983. client.set_connection_timeout(connection_timeout_sec_,
  13984. connection_timeout_usec_);
  13985. client.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  13986. client.set_write_timeout(write_timeout_sec_, write_timeout_usec_);
  13987. client.set_max_timeout(max_timeout_msec_);
  13988. if (has_payload_max_length_) {
  13989. client.set_payload_max_length(payload_max_length_);
  13990. }
  13991. client.set_keep_alive(keep_alive_);
  13992. client.set_follow_location(
  13993. true); // Enable redirects to handle multi-step redirects
  13994. client.set_path_encode(path_encode_);
  13995. client.set_compress(compress_);
  13996. client.set_decompress(decompress_);
  13997. // NOTE: Authentication credentials (basic auth, bearer token, digest auth)
  13998. // are intentionally NOT copied to the redirect client. Per RFC 9110 Section
  13999. // 15.4, credentials must not be forwarded when redirecting to a different
  14000. // host. This function is only called for cross-host redirects; same-host
  14001. // redirects are handled directly in ClientImpl::redirect().
  14002. // Copy the proxy configuration unconditionally; the per-target bypass is
  14003. // re-evaluated at send time, so a later hop to a non-bypassed host can
  14004. // still use the proxy.
  14005. client.no_proxy_entries_ = no_proxy_entries_;
  14006. if (!proxy_host_.empty() && proxy_port_ != -1) {
  14007. client.set_proxy(proxy_host_, proxy_port_);
  14008. if (!proxy_basic_auth_username_.empty() ||
  14009. !proxy_basic_auth_password_.empty()) {
  14010. client.set_proxy_basic_auth(proxy_basic_auth_username_,
  14011. proxy_basic_auth_password_);
  14012. }
  14013. if (!proxy_bearer_token_auth_token_.empty()) {
  14014. client.set_proxy_bearer_token_auth(proxy_bearer_token_auth_token_);
  14015. }
  14016. #ifdef CPPHTTPLIB_SSL_ENABLED
  14017. if (!proxy_digest_auth_username_.empty()) {
  14018. client.set_proxy_digest_auth(proxy_digest_auth_username_,
  14019. proxy_digest_auth_password_);
  14020. }
  14021. #endif
  14022. }
  14023. // Copy network and socket settings
  14024. client.addr_map_ = addr_map_;
  14025. client.set_address_family(address_family_);
  14026. client.set_tcp_nodelay(tcp_nodelay_);
  14027. client.set_ipv6_v6only(ipv6_v6only_);
  14028. if (socket_options_) { client.set_socket_options(socket_options_); }
  14029. if (!interface_.empty()) { client.set_interface(interface_); }
  14030. // Copy logging and headers. Not the error logger: a failure comes back to
  14031. // this client's send(), which reports it with the caller's request.
  14032. if (logger_) { client.set_logger(logger_); }
  14033. // NOTE: DO NOT copy default_headers_ as they may contain stale Host headers
  14034. // Each new client should generate its own headers based on its target host
  14035. }
  14036. inline bool ClientImpl::write_content_with_provider(Stream &strm,
  14037. const Request &req,
  14038. Error &error) const {
  14039. auto is_shutting_down = []() { return false; };
  14040. if (req.is_chunked_content_provider_) {
  14041. auto compressor = compress_ ? detail::create_compressor().first
  14042. : std::unique_ptr<detail::compressor>();
  14043. if (!compressor) {
  14044. compressor = detail::make_unique<detail::nocompressor>();
  14045. }
  14046. return detail::write_content_chunked(strm, req.content_provider_,
  14047. is_shutting_down, *compressor, error);
  14048. } else {
  14049. return detail::write_content_with_progress(
  14050. strm, req.content_provider_, 0, req.content_length_, is_shutting_down,
  14051. req.upload_progress, error);
  14052. }
  14053. }
  14054. // What goes on the request line for req: its path, encoded and without the
  14055. // fragment, with `req.params` as the query when the path has none.
  14056. inline std::string ClientImpl::make_request_target(const Request &req) const {
  14057. auto target = detail::encode_request_target(req.path, path_encode_);
  14058. if (detail::query_of(req.path).empty() && !req.params.empty()) {
  14059. target = append_query_params(target, req.params);
  14060. }
  14061. return target;
  14062. }
  14063. inline void ClientImpl::add_credential_headers(Request &req) {
  14064. // A CONNECT request is read by the proxy; everything sent through the tunnel
  14065. // it opens is read by the origin. Each credential goes only to its own hop.
  14066. auto is_connect = req.method == "CONNECT";
  14067. if (!is_connect) {
  14068. detail::add_authorization_header(req, basic_auth_username_,
  14069. basic_auth_password_,
  14070. bearer_token_auth_token_, false);
  14071. }
  14072. // Proxy-Authorization is only sent when the proxy reads this message —
  14073. // otherwise NO_PROXY-matched requests, and requests inside a TLS tunnel,
  14074. // would leak proxy credentials to the destination server.
  14075. if (is_proxy_enabled_for_host(host_) && (!is_ssl() || is_connect)) {
  14076. detail::add_authorization_header(req, proxy_basic_auth_username_,
  14077. proxy_basic_auth_password_,
  14078. proxy_bearer_token_auth_token_, true);
  14079. }
  14080. }
  14081. inline bool ClientImpl::write_request(Stream &strm, Request &req,
  14082. bool close_connection, Error &error,
  14083. bool skip_body, bool &rejected_locally) {
  14084. rejected_locally = false;
  14085. // Prepare additional headers
  14086. if (close_connection) {
  14087. if (!req.has_header("Connection")) {
  14088. req.set_header("Connection", "close");
  14089. }
  14090. }
  14091. std::string ct_for_defaults;
  14092. if (!req.has_header("Content-Type") && !req.body.empty()) {
  14093. ct_for_defaults = "text/plain";
  14094. }
  14095. prepare_default_headers(req, false, ct_for_defaults);
  14096. if (req.body.empty()) {
  14097. if (req.content_provider_) {
  14098. if (!req.is_chunked_content_provider_) {
  14099. if (!req.has_header("Content-Length")) {
  14100. auto length = std::to_string(req.content_length_);
  14101. req.set_header("Content-Length", length);
  14102. }
  14103. }
  14104. } else {
  14105. if (req.method == "POST" || req.method == "PUT" ||
  14106. req.method == "PATCH") {
  14107. req.set_header("Content-Length", "0");
  14108. }
  14109. }
  14110. }
  14111. add_credential_headers(req);
  14112. // Request line and headers
  14113. {
  14114. detail::BufferStream bstrm;
  14115. auto path_with_query = make_request_target(req);
  14116. // The query already came in through `req.path`; still populate
  14117. // `req.params` for handlers/users who read them.
  14118. auto query_part = detail::query_of(req.path);
  14119. if (!query_part.empty()) {
  14120. detail::parse_query_text(query_part, req.params);
  14121. }
  14122. // Write request line and headers
  14123. if (detail::write_request_line(bstrm, req.method, path_with_query) < 0) {
  14124. // A rejected method (not a token, e.g. carrying CR/LF) or target (e.g.
  14125. // CR/LF in a caller-supplied path under set_path_encode(false)) must
  14126. // fail the request cleanly instead of emitting a request-line-less,
  14127. // header-injecting request.
  14128. error = Error::Write;
  14129. rejected_locally = true;
  14130. return false;
  14131. }
  14132. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  14133. error)) {
  14134. rejected_locally = true;
  14135. return false;
  14136. }
  14137. // Flush buffer
  14138. auto &data = bstrm.get_buffer();
  14139. if (!detail::write_data(strm, data.data(), data.size())) {
  14140. error = Error::Write;
  14141. return false;
  14142. }
  14143. }
  14144. // After sending request line and headers, wait briefly for an early server
  14145. // response (e.g. 4xx) and avoid sending a potentially large request body
  14146. // unnecessarily. This workaround is only enabled on Windows because Unix
  14147. // platforms surface write errors (EPIPE) earlier; on Windows kernel send
  14148. // buffering can accept large writes even when the peer already responded.
  14149. // Check the stream first (which covers SSL via `is_readable()`), then
  14150. // fall back to select on the socket. Only perform the wait for very large
  14151. // request bodies to avoid interfering with normal small requests and
  14152. // reduce side-effects. Poll briefly (up to 50ms as default) for an early
  14153. // response. Skip this check when using Expect: 100-continue, as the protocol
  14154. // handles early responses properly.
  14155. #if defined(_WIN32)
  14156. if (!skip_body &&
  14157. req.body.size() > CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD &&
  14158. req.path.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  14159. auto start = std::chrono::high_resolution_clock::now();
  14160. for (;;) {
  14161. // Prefer socket-level readiness to avoid SSL_pending() false-positives
  14162. // from SSL internals. If the underlying socket is readable, assume an
  14163. // early response may be present.
  14164. auto sock = strm.socket();
  14165. if (sock != INVALID_SOCKET && detail::select_read(sock, 0, 0) > 0) {
  14166. return false;
  14167. }
  14168. // Fallback to stream-level check for non-socket streams or when the
  14169. // socket isn't reporting readable. Avoid using `is_readable()` for
  14170. // SSL, since `SSL_pending()` may report buffered records that do not
  14171. // indicate a complete application-level response yet.
  14172. if (!is_ssl() && strm.is_readable()) { return false; }
  14173. auto now = std::chrono::high_resolution_clock::now();
  14174. auto elapsed =
  14175. std::chrono::duration_cast<std::chrono::milliseconds>(now - start)
  14176. .count();
  14177. if (elapsed >= CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND) {
  14178. break;
  14179. }
  14180. std::this_thread::sleep_for(std::chrono::milliseconds(1));
  14181. }
  14182. }
  14183. #endif
  14184. // Body
  14185. if (skip_body) { return true; }
  14186. return write_request_body(strm, req, error);
  14187. }
  14188. inline bool ClientImpl::write_request_body(Stream &strm, Request &req,
  14189. Error &error) {
  14190. if (req.body.empty()) {
  14191. return write_content_with_provider(strm, req, error);
  14192. }
  14193. if (req.upload_progress) {
  14194. auto body_size = req.body.size();
  14195. size_t written = 0;
  14196. auto data = req.body.data();
  14197. while (written < body_size) {
  14198. size_t to_write = (std::min)(CPPHTTPLIB_SEND_BUFSIZ, body_size - written);
  14199. if (!detail::write_data(strm, data + written, to_write)) {
  14200. error = Error::Write;
  14201. return false;
  14202. }
  14203. written += to_write;
  14204. if (!req.upload_progress(written, body_size)) {
  14205. error = Error::Canceled;
  14206. return false;
  14207. }
  14208. }
  14209. } else {
  14210. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  14211. error = Error::Write;
  14212. return false;
  14213. }
  14214. }
  14215. return true;
  14216. }
  14217. inline std::unique_ptr<Response>
  14218. ClientImpl::send_with_content_provider_and_receiver(
  14219. Request &req, const char *body, size_t content_length,
  14220. ContentProvider content_provider,
  14221. ContentProviderWithoutLength content_provider_without_length,
  14222. const std::string &content_type, ContentReceiver content_receiver,
  14223. Error &error) {
  14224. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14225. auto enc = compress_
  14226. ? detail::create_compressor()
  14227. : std::pair<std::unique_ptr<detail::compressor>, const char *>(
  14228. nullptr, nullptr);
  14229. if (enc.second) { req.set_header("Content-Encoding", enc.second); }
  14230. if (enc.first && !content_provider_without_length) {
  14231. auto &compressor = enc.first;
  14232. if (content_provider) {
  14233. auto ok = true;
  14234. auto finished = false;
  14235. size_t offset = 0;
  14236. DataSink data_sink;
  14237. data_sink.write = [&](const char *data, size_t data_len) -> bool {
  14238. if (ok) {
  14239. auto last = offset + data_len == content_length;
  14240. auto ret = compressor->compress(
  14241. data, data_len, last,
  14242. [&](const char *compressed_data, size_t compressed_data_len) {
  14243. req.body.append(compressed_data, compressed_data_len);
  14244. return true;
  14245. });
  14246. if (ret) {
  14247. offset += data_len;
  14248. } else {
  14249. ok = false;
  14250. }
  14251. }
  14252. return ok;
  14253. };
  14254. // As in detail::write_content_with_progress(): the body is framed by
  14255. // content_length, so a provider that finishes early has truncated it.
  14256. // Stop and report that instead of calling the provider forever.
  14257. data_sink.done = [&]() { finished = true; };
  14258. while (ok && !finished && offset < content_length) {
  14259. if (!content_provider(offset, content_length - offset, data_sink)) {
  14260. error = Error::Canceled;
  14261. output_error_log(error, &req);
  14262. return nullptr;
  14263. }
  14264. }
  14265. // A short body here means either the provider stopped early or the
  14266. // compressor gave up. The branch below reports a failing compressor as
  14267. // Error::Compression, so keep the two distinguishable.
  14268. if (offset < content_length) {
  14269. error = ok ? Error::Write : Error::Compression;
  14270. output_error_log(error, &req);
  14271. return nullptr;
  14272. }
  14273. } else {
  14274. if (!compressor->compress(body, content_length, true,
  14275. [&](const char *data, size_t data_len) {
  14276. req.body.append(data, data_len);
  14277. return true;
  14278. })) {
  14279. error = Error::Compression;
  14280. output_error_log(error, &req);
  14281. return nullptr;
  14282. }
  14283. }
  14284. } else {
  14285. if (content_provider) {
  14286. req.content_length_ = content_length;
  14287. req.content_provider_ = std::move(content_provider);
  14288. req.is_chunked_content_provider_ = false;
  14289. } else if (content_provider_without_length) {
  14290. req.content_length_ = 0;
  14291. req.content_provider_ = detail::ContentProviderAdapter(
  14292. std::move(content_provider_without_length));
  14293. req.is_chunked_content_provider_ = true;
  14294. req.set_header("Transfer-Encoding", "chunked");
  14295. } else {
  14296. req.body.assign(body, content_length);
  14297. }
  14298. }
  14299. if (content_receiver) {
  14300. req.content_receiver =
  14301. [content_receiver](const char *data, size_t data_length,
  14302. size_t /*offset*/, size_t /*total_length*/) {
  14303. return content_receiver(data, data_length);
  14304. };
  14305. }
  14306. auto res = detail::make_unique<Response>();
  14307. return send(req, *res, error) ? std::move(res) : nullptr;
  14308. }
  14309. inline Result ClientImpl::send_with_content_provider_and_receiver(
  14310. const std::string &method, const std::string &path, const Headers &headers,
  14311. const char *body, size_t content_length, ContentProvider content_provider,
  14312. ContentProviderWithoutLength content_provider_without_length,
  14313. const std::string &content_type, ContentReceiver content_receiver,
  14314. UploadProgress progress) {
  14315. Request req;
  14316. req.method = method;
  14317. req.headers = headers;
  14318. req.path = path;
  14319. req.upload_progress = std::move(progress);
  14320. if (max_timeout_msec_ > 0) {
  14321. req.start_time_ = std::chrono::steady_clock::now();
  14322. }
  14323. auto error = Error::Success;
  14324. #ifdef CPPHTTPLIB_SSL_ENABLED
  14325. // Hold the request lock until the Result has read this request's TLS error
  14326. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  14327. #endif
  14328. auto res = send_with_content_provider_and_receiver(
  14329. req, body, content_length, std::move(content_provider),
  14330. std::move(content_provider_without_length), content_type,
  14331. std::move(content_receiver), error);
  14332. #ifdef CPPHTTPLIB_SSL_ENABLED
  14333. return Result{std::move(res), error, std::move(req.headers), last_ssl_error_,
  14334. last_backend_error_};
  14335. #else
  14336. return Result{std::move(res), error, std::move(req.headers)};
  14337. #endif
  14338. }
  14339. inline void ClientImpl::output_log(const Request &req,
  14340. const Response &res) const {
  14341. if (logger_) {
  14342. std::lock_guard<std::mutex> guard(logger_mutex_);
  14343. logger_(req, res);
  14344. }
  14345. }
  14346. inline void ClientImpl::output_error_log(const Error &err,
  14347. const Request *req) const {
  14348. if (error_logger_) {
  14349. std::lock_guard<std::mutex> guard(logger_mutex_);
  14350. error_logger_(err, req);
  14351. }
  14352. }
  14353. inline bool ClientImpl::process_request(Stream &strm, Request &req,
  14354. Response &res, bool close_connection,
  14355. Error &error) {
  14356. // Auto-add Expect: 100-continue for large bodies
  14357. if (CPPHTTPLIB_EXPECT_100_THRESHOLD > 0 && !req.has_header("Expect")) {
  14358. auto body_size = req.body.empty() ? req.content_length_ : req.body.size();
  14359. if (body_size >= CPPHTTPLIB_EXPECT_100_THRESHOLD) {
  14360. req.set_header("Expect", "100-continue");
  14361. }
  14362. }
  14363. // Check for Expect: 100-continue
  14364. auto expect_100_continue =
  14365. detail::has_header_token(req.headers, "Expect", "100-continue");
  14366. // Send request (skip body if using Expect: 100-continue)
  14367. auto rejected_locally = false;
  14368. auto write_request_success =
  14369. write_request(strm, req, close_connection, error, expect_100_continue,
  14370. rejected_locally);
  14371. // A failed write normally still reads the response below, since the server
  14372. // may have answered early (e.g. 413/414) and closed while the body was being
  14373. // sent. A request rejected before any byte reached the socket gets no such
  14374. // response, and waiting for one would block until the read timeout.
  14375. if (rejected_locally) { return false; }
  14376. #ifdef CPPHTTPLIB_SSL_ENABLED
  14377. if (is_ssl() && !expect_100_continue) {
  14378. auto is_proxy_enabled = is_proxy_enabled_for_host(host_);
  14379. if (!is_proxy_enabled) {
  14380. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  14381. error = Error::SSLPeerCouldBeClosed_;
  14382. return false;
  14383. }
  14384. }
  14385. }
  14386. #endif
  14387. // Handle Expect: 100-continue.
  14388. //
  14389. // Wait for an interim/early response by attempting to read the status line
  14390. // under a short timeout, instead of trusting raw socket readability. Over
  14391. // TLS, post-handshake records (e.g. session tickets) make the socket
  14392. // readable without any HTTP response being available; relying on
  14393. // `select_read` there caused the body to be withheld forever and the
  14394. // request to fail with `Read` (#2458). If no status line arrives within the
  14395. // timeout, send the body anyway (matching curl's behavior).
  14396. auto status_line_read = false;
  14397. if (expect_100_continue && write_request_success) {
  14398. if (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND > 0) {
  14399. time_t sec = CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND / 1000;
  14400. time_t usec = (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND % 1000) * 1000;
  14401. strm.set_read_timeout(sec, usec);
  14402. status_line_read = read_response_line(strm, req, res, false);
  14403. strm.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  14404. }
  14405. if (!status_line_read) {
  14406. // No interim response within the timeout: send the body and handle the
  14407. // response as usual.
  14408. if (!write_request_body(strm, req, error)) { return false; }
  14409. expect_100_continue = false; // Switch to normal response handling
  14410. }
  14411. }
  14412. // Receive response and headers
  14413. // When using Expect: 100-continue, don't auto-skip `100 Continue` response
  14414. if ((!status_line_read &&
  14415. !read_response_line(strm, req, res, !expect_100_continue)) ||
  14416. !detail::read_headers(strm, res.headers)) {
  14417. if (write_request_success) { error = Error::Read; }
  14418. return false;
  14419. }
  14420. if (!write_request_success) { return false; }
  14421. // Handle Expect: 100-continue response
  14422. if (expect_100_continue) {
  14423. if (res.status == StatusCode::Continue_100) {
  14424. // Server accepted, send the body
  14425. if (!write_request_body(strm, req, error)) { return false; }
  14426. // Read the actual response
  14427. res.headers.clear();
  14428. res.body.clear();
  14429. if (!read_response_line(strm, req, res) ||
  14430. !detail::read_headers(strm, res.headers)) {
  14431. error = Error::Read;
  14432. return false;
  14433. }
  14434. } else {
  14435. // A final response came first, so the body this request declared was
  14436. // never sent, and the server may still be waiting for it. The
  14437. // connection cannot carry another request.
  14438. std::lock_guard<std::mutex> guard(socket_mutex_);
  14439. socket_should_be_closed_when_request_is_done_ = true;
  14440. }
  14441. }
  14442. // Body
  14443. if ((res.status != StatusCode::NoContent_204) && req.method != "HEAD" &&
  14444. req.method != "CONNECT") {
  14445. // Reject ambiguous framing (RFC 9112 §6.3). Unlike a request, a response
  14446. // whose final transfer coding is not chunked is not ambiguous: its body
  14447. // runs until the server closes the connection, so it is not rejected.
  14448. // HEAD/204 are excluded above and a 304 carries no body.
  14449. if (res.status != StatusCode::NotModified_304) {
  14450. if (detail::has_conflicting_content_length(res.headers)) {
  14451. error = Error::Read;
  14452. return false;
  14453. }
  14454. if (detail::has_faulty_transfer_encoding(res)) {
  14455. std::lock_guard<std::mutex> guard(socket_mutex_);
  14456. socket_should_be_closed_when_request_is_done_ = true;
  14457. }
  14458. }
  14459. auto redirect = follow_location_ && detail::is_redirect(res) &&
  14460. res.status != StatusCode::NotModified_304;
  14461. if (req.response_handler && !redirect) {
  14462. if (!req.response_handler(res)) {
  14463. error = Error::Canceled;
  14464. return false;
  14465. }
  14466. }
  14467. auto out =
  14468. req.content_receiver
  14469. ? static_cast<ContentReceiverWithProgress>(
  14470. [&](const char *buf, size_t n, size_t off, size_t len) {
  14471. if (redirect) { return true; }
  14472. auto ret = req.content_receiver(buf, n, off, len);
  14473. if (!ret) { error = Error::Canceled; }
  14474. return ret;
  14475. })
  14476. : static_cast<ContentReceiverWithProgress>(
  14477. [&](const char *buf, size_t n, size_t /*off*/,
  14478. size_t /*len*/) {
  14479. assert(res.body.size() + n <= res.body.max_size());
  14480. if (payload_max_length_ > 0 &&
  14481. (res.body.size() >= payload_max_length_ ||
  14482. n > payload_max_length_ - res.body.size())) {
  14483. return false;
  14484. }
  14485. res.body.append(buf, n);
  14486. return true;
  14487. });
  14488. auto progress = [&](size_t current, size_t total) {
  14489. if (!req.download_progress || redirect) { return true; }
  14490. auto ret = req.download_progress(current, total);
  14491. if (!ret) { error = Error::Canceled; }
  14492. return ret;
  14493. };
  14494. if (res.has_header("Content-Length")) {
  14495. if (!req.content_receiver) {
  14496. auto len = res.get_header_value_u64("Content-Length");
  14497. if (len > res.body.max_size()) {
  14498. error = Error::Read;
  14499. return false;
  14500. }
  14501. // Content-Length is only the server's claim, so reserve no more than
  14502. // payload_max_length_ allows, nor more than 1 MiB before any of the
  14503. // body has arrived. A longer body grows as it is read.
  14504. auto reserve_len =
  14505. (std::min)(static_cast<size_t>(len), size_t(1024 * 1024));
  14506. if (payload_max_length_ > 0) {
  14507. reserve_len = (std::min)(reserve_len, payload_max_length_);
  14508. }
  14509. res.body.reserve(reserve_len);
  14510. }
  14511. }
  14512. if (res.status != StatusCode::NotModified_304) {
  14513. auto content_status = 0;
  14514. auto max_length = (!has_payload_max_length_ && req.content_receiver)
  14515. ? (std::numeric_limits<size_t>::max)()
  14516. : payload_max_length_;
  14517. if (!detail::read_content(strm, res, max_length, content_status,
  14518. std::move(progress), std::move(out),
  14519. decompress_)) {
  14520. if (error != Error::Canceled) {
  14521. // Tell the caller apart from a plain read failure when the body was
  14522. // over the payload limit or could not be decoded because of its
  14523. // Content-Encoding.
  14524. switch (content_status) {
  14525. case StatusCode::PayloadTooLarge_413:
  14526. error = Error::ExceedMaxPayloadSize;
  14527. break;
  14528. case StatusCode::UnsupportedMediaType_415:
  14529. error = Error::UnsupportedContentEncoding;
  14530. break;
  14531. case StatusCode::InternalServerError_500:
  14532. error = Error::Compression;
  14533. break;
  14534. default: error = Error::Read; break;
  14535. }
  14536. }
  14537. return false;
  14538. }
  14539. }
  14540. }
  14541. // Log
  14542. output_log(req, res);
  14543. return true;
  14544. }
  14545. inline ContentProviderWithoutLength ClientImpl::get_multipart_content_provider(
  14546. const std::string &boundary, const UploadFormDataItems &items,
  14547. const FormDataProviderItems &provider_items) const {
  14548. size_t cur_item = 0;
  14549. size_t cur_start = 0;
  14550. // cur_item and cur_start are copied to within the std::function and
  14551. // maintain state between successive calls
  14552. return [&, cur_item, cur_start](size_t offset,
  14553. DataSink &sink) mutable -> bool {
  14554. if (!offset && !items.empty()) {
  14555. sink.os << detail::serialize_multipart_formdata(items, boundary, false);
  14556. return true;
  14557. } else if (cur_item < provider_items.size()) {
  14558. if (!cur_start) {
  14559. const auto &begin = detail::serialize_multipart_formdata_item_begin(
  14560. provider_items[cur_item], boundary);
  14561. offset += begin.size();
  14562. cur_start = offset;
  14563. sink.os << begin;
  14564. }
  14565. DataSink cur_sink;
  14566. auto has_data = true;
  14567. cur_sink.write = sink.write;
  14568. // Forward is_writable so a provider item asking whether it may keep
  14569. // going gets the outer sink's answer rather than the default `true`.
  14570. cur_sink.is_writable = sink.is_writable;
  14571. cur_sink.done = [&]() { has_data = false; };
  14572. if (!provider_items[cur_item].provider(offset - cur_start, cur_sink)) {
  14573. return false;
  14574. }
  14575. if (!has_data) {
  14576. sink.os << detail::serialize_multipart_formdata_item_end();
  14577. cur_item++;
  14578. cur_start = 0;
  14579. }
  14580. return true;
  14581. } else {
  14582. sink.os << detail::serialize_multipart_formdata_finish(boundary);
  14583. sink.done();
  14584. return true;
  14585. }
  14586. };
  14587. }
  14588. inline bool ClientImpl::process_socket(
  14589. const Socket &socket,
  14590. std::chrono::time_point<std::chrono::steady_clock> start_time,
  14591. std::function<bool(Stream &strm)> callback) {
  14592. return detail::process_client_socket(
  14593. socket.sock, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  14594. write_timeout_usec_, max_timeout_msec_, start_time, std::move(callback));
  14595. }
  14596. inline bool ClientImpl::is_ssl() const { return false; }
  14597. inline Result ClientImpl::Get(const std::string &path,
  14598. DownloadProgress progress) {
  14599. return Get(path, Headers(), std::move(progress));
  14600. }
  14601. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14602. DownloadProgress progress) {
  14603. return Get(path, params, Headers(), std::move(progress));
  14604. }
  14605. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14606. const Headers &headers,
  14607. DownloadProgress progress) {
  14608. if (params.empty()) { return Get(path, headers); }
  14609. std::string path_with_query = append_query_params(path, params);
  14610. return Get(path_with_query, headers, std::move(progress));
  14611. }
  14612. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14613. DownloadProgress progress) {
  14614. Request req;
  14615. req.method = "GET";
  14616. req.path = path;
  14617. req.headers = headers;
  14618. req.download_progress = std::move(progress);
  14619. if (max_timeout_msec_ > 0) {
  14620. req.start_time_ = std::chrono::steady_clock::now();
  14621. }
  14622. return send_(std::move(req));
  14623. }
  14624. inline Result ClientImpl::Get(const std::string &path,
  14625. ContentReceiver content_receiver,
  14626. DownloadProgress progress) {
  14627. return Get(path, Headers(), nullptr, std::move(content_receiver),
  14628. std::move(progress));
  14629. }
  14630. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14631. ContentReceiver content_receiver,
  14632. DownloadProgress progress) {
  14633. return Get(path, headers, nullptr, std::move(content_receiver),
  14634. std::move(progress));
  14635. }
  14636. inline Result ClientImpl::Get(const std::string &path,
  14637. ResponseHandler response_handler,
  14638. ContentReceiver content_receiver,
  14639. DownloadProgress progress) {
  14640. return Get(path, Headers(), std::move(response_handler),
  14641. std::move(content_receiver), std::move(progress));
  14642. }
  14643. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14644. ResponseHandler response_handler,
  14645. ContentReceiver content_receiver,
  14646. DownloadProgress progress) {
  14647. Request req;
  14648. req.method = "GET";
  14649. req.path = path;
  14650. req.headers = headers;
  14651. req.response_handler = std::move(response_handler);
  14652. req.content_receiver =
  14653. [content_receiver](const char *data, size_t data_length,
  14654. size_t /*offset*/, size_t /*total_length*/) {
  14655. return content_receiver(data, data_length);
  14656. };
  14657. req.download_progress = std::move(progress);
  14658. if (max_timeout_msec_ > 0) {
  14659. req.start_time_ = std::chrono::steady_clock::now();
  14660. }
  14661. return send_(std::move(req));
  14662. }
  14663. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14664. const Headers &headers,
  14665. ContentReceiver content_receiver,
  14666. DownloadProgress progress) {
  14667. return Get(path, params, headers, nullptr, std::move(content_receiver),
  14668. std::move(progress));
  14669. }
  14670. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14671. const Headers &headers,
  14672. ResponseHandler response_handler,
  14673. ContentReceiver content_receiver,
  14674. DownloadProgress progress) {
  14675. if (params.empty()) {
  14676. return Get(path, headers, std::move(response_handler),
  14677. std::move(content_receiver), std::move(progress));
  14678. }
  14679. std::string path_with_query = append_query_params(path, params);
  14680. return Get(path_with_query, headers, std::move(response_handler),
  14681. std::move(content_receiver), std::move(progress));
  14682. }
  14683. inline Result ClientImpl::Head(const std::string &path) {
  14684. return Head(path, Headers());
  14685. }
  14686. inline Result ClientImpl::Head(const std::string &path,
  14687. const Headers &headers) {
  14688. Request req;
  14689. req.method = "HEAD";
  14690. req.headers = headers;
  14691. req.path = path;
  14692. if (max_timeout_msec_ > 0) {
  14693. req.start_time_ = std::chrono::steady_clock::now();
  14694. }
  14695. return send_(std::move(req));
  14696. }
  14697. inline Result ClientImpl::Post(const std::string &path) {
  14698. return Post(path, std::string(), std::string());
  14699. }
  14700. inline Result ClientImpl::Post(const std::string &path,
  14701. const Headers &headers) {
  14702. return Post(path, headers, nullptr, 0, std::string());
  14703. }
  14704. inline Result ClientImpl::Post(const std::string &path, const char *body,
  14705. size_t content_length,
  14706. const std::string &content_type,
  14707. UploadProgress progress) {
  14708. return Post(path, Headers(), body, content_length, content_type, progress);
  14709. }
  14710. inline Result ClientImpl::Post(const std::string &path, const std::string &body,
  14711. const std::string &content_type,
  14712. UploadProgress progress) {
  14713. return Post(path, Headers(), body, content_type, progress);
  14714. }
  14715. inline Result ClientImpl::Post(const std::string &path, const Params &params) {
  14716. return Post(path, Headers(), params);
  14717. }
  14718. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14719. ContentProvider content_provider,
  14720. const std::string &content_type,
  14721. UploadProgress progress) {
  14722. return Post(path, Headers(), content_length, std::move(content_provider),
  14723. content_type, progress);
  14724. }
  14725. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14726. ContentProvider content_provider,
  14727. const std::string &content_type,
  14728. ContentReceiver content_receiver,
  14729. UploadProgress progress) {
  14730. return Post(path, Headers(), content_length, std::move(content_provider),
  14731. content_type, std::move(content_receiver), progress);
  14732. }
  14733. inline Result ClientImpl::Post(const std::string &path,
  14734. ContentProviderWithoutLength content_provider,
  14735. const std::string &content_type,
  14736. UploadProgress progress) {
  14737. return Post(path, Headers(), std::move(content_provider), content_type,
  14738. progress);
  14739. }
  14740. inline Result ClientImpl::Post(const std::string &path,
  14741. ContentProviderWithoutLength content_provider,
  14742. const std::string &content_type,
  14743. ContentReceiver content_receiver,
  14744. UploadProgress progress) {
  14745. return Post(path, Headers(), std::move(content_provider), content_type,
  14746. std::move(content_receiver), progress);
  14747. }
  14748. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14749. const Params &params) {
  14750. auto query = detail::params_to_query_str(params);
  14751. return Post(path, headers, query, "application/x-www-form-urlencoded");
  14752. }
  14753. inline Result ClientImpl::Post(const std::string &path,
  14754. const UploadFormDataItems &items,
  14755. UploadProgress progress) {
  14756. return Post(path, Headers(), items, progress);
  14757. }
  14758. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14759. const UploadFormDataItems &items,
  14760. UploadProgress progress) {
  14761. const auto &boundary = detail::make_multipart_data_boundary();
  14762. const auto &content_type =
  14763. detail::serialize_multipart_formdata_get_content_type(boundary);
  14764. auto content_length = detail::get_multipart_content_length(items, boundary);
  14765. return Post(path, headers, content_length,
  14766. detail::make_multipart_content_provider(items, boundary),
  14767. content_type, progress);
  14768. }
  14769. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14770. const UploadFormDataItems &items,
  14771. const std::string &boundary,
  14772. UploadProgress progress) {
  14773. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14774. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14775. }
  14776. const auto &content_type =
  14777. detail::serialize_multipart_formdata_get_content_type(boundary);
  14778. auto content_length = detail::get_multipart_content_length(items, boundary);
  14779. return Post(path, headers, content_length,
  14780. detail::make_multipart_content_provider(items, boundary),
  14781. content_type, progress);
  14782. }
  14783. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14784. const char *body, size_t content_length,
  14785. const std::string &content_type,
  14786. UploadProgress progress) {
  14787. return send_with_content_provider_and_receiver(
  14788. "POST", path, headers, body, content_length, nullptr, nullptr,
  14789. content_type, nullptr, progress);
  14790. }
  14791. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14792. const std::string &body,
  14793. const std::string &content_type,
  14794. UploadProgress progress) {
  14795. return send_with_content_provider_and_receiver(
  14796. "POST", path, headers, body.data(), body.size(), nullptr, nullptr,
  14797. content_type, nullptr, progress);
  14798. }
  14799. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14800. size_t content_length,
  14801. ContentProvider content_provider,
  14802. const std::string &content_type,
  14803. UploadProgress progress) {
  14804. return send_with_content_provider_and_receiver(
  14805. "POST", path, headers, nullptr, content_length,
  14806. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14807. }
  14808. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14809. size_t content_length,
  14810. ContentProvider content_provider,
  14811. const std::string &content_type,
  14812. ContentReceiver content_receiver,
  14813. DownloadProgress progress) {
  14814. return send_with_content_provider_and_receiver(
  14815. "POST", path, headers, nullptr, content_length,
  14816. std::move(content_provider), nullptr, content_type,
  14817. std::move(content_receiver), std::move(progress));
  14818. }
  14819. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14820. ContentProviderWithoutLength content_provider,
  14821. const std::string &content_type,
  14822. UploadProgress progress) {
  14823. return send_with_content_provider_and_receiver(
  14824. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14825. content_type, nullptr, progress);
  14826. }
  14827. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14828. ContentProviderWithoutLength content_provider,
  14829. const std::string &content_type,
  14830. ContentReceiver content_receiver,
  14831. DownloadProgress progress) {
  14832. return send_with_content_provider_and_receiver(
  14833. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14834. content_type, std::move(content_receiver), std::move(progress));
  14835. }
  14836. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14837. const UploadFormDataItems &items,
  14838. const FormDataProviderItems &provider_items,
  14839. UploadProgress progress) {
  14840. const auto &boundary = detail::make_multipart_data_boundary();
  14841. const auto &content_type =
  14842. detail::serialize_multipart_formdata_get_content_type(boundary);
  14843. return send_with_content_provider_and_receiver(
  14844. "POST", path, headers, nullptr, 0, nullptr,
  14845. get_multipart_content_provider(boundary, items, provider_items),
  14846. content_type, nullptr, progress);
  14847. }
  14848. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14849. const std::string &body,
  14850. const std::string &content_type,
  14851. ContentReceiver content_receiver,
  14852. DownloadProgress progress) {
  14853. Request req;
  14854. req.method = "POST";
  14855. req.path = path;
  14856. req.headers = headers;
  14857. req.body = body;
  14858. req.content_receiver =
  14859. [content_receiver](const char *data, size_t data_length,
  14860. size_t /*offset*/, size_t /*total_length*/) {
  14861. return content_receiver(data, data_length);
  14862. };
  14863. req.download_progress = std::move(progress);
  14864. if (max_timeout_msec_ > 0) {
  14865. req.start_time_ = std::chrono::steady_clock::now();
  14866. }
  14867. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14868. return send_(std::move(req));
  14869. }
  14870. inline Result ClientImpl::Put(const std::string &path) {
  14871. return Put(path, std::string(), std::string());
  14872. }
  14873. inline Result ClientImpl::Put(const std::string &path, const Headers &headers) {
  14874. return Put(path, headers, nullptr, 0, std::string());
  14875. }
  14876. inline Result ClientImpl::Put(const std::string &path, const char *body,
  14877. size_t content_length,
  14878. const std::string &content_type,
  14879. UploadProgress progress) {
  14880. return Put(path, Headers(), body, content_length, content_type, progress);
  14881. }
  14882. inline Result ClientImpl::Put(const std::string &path, const std::string &body,
  14883. const std::string &content_type,
  14884. UploadProgress progress) {
  14885. return Put(path, Headers(), body, content_type, progress);
  14886. }
  14887. inline Result ClientImpl::Put(const std::string &path, const Params &params) {
  14888. return Put(path, Headers(), params);
  14889. }
  14890. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14891. ContentProvider content_provider,
  14892. const std::string &content_type,
  14893. UploadProgress progress) {
  14894. return Put(path, Headers(), content_length, std::move(content_provider),
  14895. content_type, progress);
  14896. }
  14897. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14898. ContentProvider content_provider,
  14899. const std::string &content_type,
  14900. ContentReceiver content_receiver,
  14901. UploadProgress progress) {
  14902. return Put(path, Headers(), content_length, std::move(content_provider),
  14903. content_type, std::move(content_receiver), progress);
  14904. }
  14905. inline Result ClientImpl::Put(const std::string &path,
  14906. ContentProviderWithoutLength content_provider,
  14907. const std::string &content_type,
  14908. UploadProgress progress) {
  14909. return Put(path, Headers(), std::move(content_provider), content_type,
  14910. progress);
  14911. }
  14912. inline Result ClientImpl::Put(const std::string &path,
  14913. ContentProviderWithoutLength content_provider,
  14914. const std::string &content_type,
  14915. ContentReceiver content_receiver,
  14916. UploadProgress progress) {
  14917. return Put(path, Headers(), std::move(content_provider), content_type,
  14918. std::move(content_receiver), progress);
  14919. }
  14920. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14921. const Params &params) {
  14922. auto query = detail::params_to_query_str(params);
  14923. return Put(path, headers, query, "application/x-www-form-urlencoded");
  14924. }
  14925. inline Result ClientImpl::Put(const std::string &path,
  14926. const UploadFormDataItems &items,
  14927. UploadProgress progress) {
  14928. return Put(path, Headers(), items, progress);
  14929. }
  14930. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14931. const UploadFormDataItems &items,
  14932. UploadProgress progress) {
  14933. const auto &boundary = detail::make_multipart_data_boundary();
  14934. const auto &content_type =
  14935. detail::serialize_multipart_formdata_get_content_type(boundary);
  14936. auto content_length = detail::get_multipart_content_length(items, boundary);
  14937. return Put(path, headers, content_length,
  14938. detail::make_multipart_content_provider(items, boundary),
  14939. content_type, progress);
  14940. }
  14941. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14942. const UploadFormDataItems &items,
  14943. const std::string &boundary,
  14944. UploadProgress progress) {
  14945. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14946. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14947. }
  14948. const auto &content_type =
  14949. detail::serialize_multipart_formdata_get_content_type(boundary);
  14950. auto content_length = detail::get_multipart_content_length(items, boundary);
  14951. return Put(path, headers, content_length,
  14952. detail::make_multipart_content_provider(items, boundary),
  14953. content_type, progress);
  14954. }
  14955. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14956. const char *body, size_t content_length,
  14957. const std::string &content_type,
  14958. UploadProgress progress) {
  14959. return send_with_content_provider_and_receiver(
  14960. "PUT", path, headers, body, content_length, nullptr, nullptr,
  14961. content_type, nullptr, progress);
  14962. }
  14963. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14964. const std::string &body,
  14965. const std::string &content_type,
  14966. UploadProgress progress) {
  14967. return send_with_content_provider_and_receiver(
  14968. "PUT", path, headers, body.data(), body.size(), nullptr, nullptr,
  14969. content_type, nullptr, progress);
  14970. }
  14971. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14972. size_t content_length,
  14973. ContentProvider content_provider,
  14974. const std::string &content_type,
  14975. UploadProgress progress) {
  14976. return send_with_content_provider_and_receiver(
  14977. "PUT", path, headers, nullptr, content_length,
  14978. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14979. }
  14980. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14981. size_t content_length,
  14982. ContentProvider content_provider,
  14983. const std::string &content_type,
  14984. ContentReceiver content_receiver,
  14985. UploadProgress progress) {
  14986. return send_with_content_provider_and_receiver(
  14987. "PUT", path, headers, nullptr, content_length,
  14988. std::move(content_provider), nullptr, content_type,
  14989. std::move(content_receiver), progress);
  14990. }
  14991. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14992. ContentProviderWithoutLength content_provider,
  14993. const std::string &content_type,
  14994. UploadProgress progress) {
  14995. return send_with_content_provider_and_receiver(
  14996. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14997. content_type, nullptr, progress);
  14998. }
  14999. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15000. ContentProviderWithoutLength content_provider,
  15001. const std::string &content_type,
  15002. ContentReceiver content_receiver,
  15003. UploadProgress progress) {
  15004. return send_with_content_provider_and_receiver(
  15005. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15006. content_type, std::move(content_receiver), progress);
  15007. }
  15008. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15009. const UploadFormDataItems &items,
  15010. const FormDataProviderItems &provider_items,
  15011. UploadProgress progress) {
  15012. const auto &boundary = detail::make_multipart_data_boundary();
  15013. const auto &content_type =
  15014. detail::serialize_multipart_formdata_get_content_type(boundary);
  15015. return send_with_content_provider_and_receiver(
  15016. "PUT", path, headers, nullptr, 0, nullptr,
  15017. get_multipart_content_provider(boundary, items, provider_items),
  15018. content_type, nullptr, progress);
  15019. }
  15020. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15021. const std::string &body,
  15022. const std::string &content_type,
  15023. ContentReceiver content_receiver,
  15024. DownloadProgress progress) {
  15025. Request req;
  15026. req.method = "PUT";
  15027. req.path = path;
  15028. req.headers = headers;
  15029. req.body = body;
  15030. req.content_receiver =
  15031. [content_receiver](const char *data, size_t data_length,
  15032. size_t /*offset*/, size_t /*total_length*/) {
  15033. return content_receiver(data, data_length);
  15034. };
  15035. req.download_progress = std::move(progress);
  15036. if (max_timeout_msec_ > 0) {
  15037. req.start_time_ = std::chrono::steady_clock::now();
  15038. }
  15039. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15040. return send_(std::move(req));
  15041. }
  15042. inline Result ClientImpl::Patch(const std::string &path) {
  15043. return Patch(path, std::string(), std::string());
  15044. }
  15045. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15046. UploadProgress progress) {
  15047. return Patch(path, headers, nullptr, 0, std::string(), progress);
  15048. }
  15049. inline Result ClientImpl::Patch(const std::string &path, const char *body,
  15050. size_t content_length,
  15051. const std::string &content_type,
  15052. UploadProgress progress) {
  15053. return Patch(path, Headers(), body, content_length, content_type, progress);
  15054. }
  15055. inline Result ClientImpl::Patch(const std::string &path,
  15056. const std::string &body,
  15057. const std::string &content_type,
  15058. UploadProgress progress) {
  15059. return Patch(path, Headers(), body, content_type, progress);
  15060. }
  15061. inline Result ClientImpl::Patch(const std::string &path, const Params &params) {
  15062. return Patch(path, Headers(), params);
  15063. }
  15064. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  15065. ContentProvider content_provider,
  15066. const std::string &content_type,
  15067. UploadProgress progress) {
  15068. return Patch(path, Headers(), content_length, std::move(content_provider),
  15069. content_type, progress);
  15070. }
  15071. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  15072. ContentProvider content_provider,
  15073. const std::string &content_type,
  15074. ContentReceiver content_receiver,
  15075. UploadProgress progress) {
  15076. return Patch(path, Headers(), content_length, std::move(content_provider),
  15077. content_type, std::move(content_receiver), progress);
  15078. }
  15079. inline Result ClientImpl::Patch(const std::string &path,
  15080. ContentProviderWithoutLength content_provider,
  15081. const std::string &content_type,
  15082. UploadProgress progress) {
  15083. return Patch(path, Headers(), std::move(content_provider), content_type,
  15084. progress);
  15085. }
  15086. inline Result ClientImpl::Patch(const std::string &path,
  15087. ContentProviderWithoutLength content_provider,
  15088. const std::string &content_type,
  15089. ContentReceiver content_receiver,
  15090. UploadProgress progress) {
  15091. return Patch(path, Headers(), std::move(content_provider), content_type,
  15092. std::move(content_receiver), progress);
  15093. }
  15094. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15095. const Params &params) {
  15096. auto query = detail::params_to_query_str(params);
  15097. return Patch(path, headers, query, "application/x-www-form-urlencoded");
  15098. }
  15099. inline Result ClientImpl::Patch(const std::string &path,
  15100. const UploadFormDataItems &items,
  15101. UploadProgress progress) {
  15102. return Patch(path, Headers(), items, progress);
  15103. }
  15104. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15105. const UploadFormDataItems &items,
  15106. UploadProgress progress) {
  15107. const auto &boundary = detail::make_multipart_data_boundary();
  15108. const auto &content_type =
  15109. detail::serialize_multipart_formdata_get_content_type(boundary);
  15110. auto content_length = detail::get_multipart_content_length(items, boundary);
  15111. return Patch(path, headers, content_length,
  15112. detail::make_multipart_content_provider(items, boundary),
  15113. content_type, progress);
  15114. }
  15115. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15116. const UploadFormDataItems &items,
  15117. const std::string &boundary,
  15118. UploadProgress progress) {
  15119. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  15120. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  15121. }
  15122. const auto &content_type =
  15123. detail::serialize_multipart_formdata_get_content_type(boundary);
  15124. auto content_length = detail::get_multipart_content_length(items, boundary);
  15125. return Patch(path, headers, content_length,
  15126. detail::make_multipart_content_provider(items, boundary),
  15127. content_type, progress);
  15128. }
  15129. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15130. const char *body, size_t content_length,
  15131. const std::string &content_type,
  15132. UploadProgress progress) {
  15133. return send_with_content_provider_and_receiver(
  15134. "PATCH", path, headers, body, content_length, nullptr, nullptr,
  15135. content_type, nullptr, progress);
  15136. }
  15137. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15138. const std::string &body,
  15139. const std::string &content_type,
  15140. UploadProgress progress) {
  15141. return send_with_content_provider_and_receiver(
  15142. "PATCH", path, headers, body.data(), body.size(), nullptr, nullptr,
  15143. content_type, nullptr, progress);
  15144. }
  15145. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15146. size_t content_length,
  15147. ContentProvider content_provider,
  15148. const std::string &content_type,
  15149. UploadProgress progress) {
  15150. return send_with_content_provider_and_receiver(
  15151. "PATCH", path, headers, nullptr, content_length,
  15152. std::move(content_provider), nullptr, content_type, nullptr, progress);
  15153. }
  15154. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15155. size_t content_length,
  15156. ContentProvider content_provider,
  15157. const std::string &content_type,
  15158. ContentReceiver content_receiver,
  15159. UploadProgress progress) {
  15160. return send_with_content_provider_and_receiver(
  15161. "PATCH", path, headers, nullptr, content_length,
  15162. std::move(content_provider), nullptr, content_type,
  15163. std::move(content_receiver), progress);
  15164. }
  15165. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15166. ContentProviderWithoutLength content_provider,
  15167. const std::string &content_type,
  15168. UploadProgress progress) {
  15169. return send_with_content_provider_and_receiver(
  15170. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15171. content_type, nullptr, progress);
  15172. }
  15173. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15174. ContentProviderWithoutLength content_provider,
  15175. const std::string &content_type,
  15176. ContentReceiver content_receiver,
  15177. UploadProgress progress) {
  15178. return send_with_content_provider_and_receiver(
  15179. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15180. content_type, std::move(content_receiver), progress);
  15181. }
  15182. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15183. const UploadFormDataItems &items,
  15184. const FormDataProviderItems &provider_items,
  15185. UploadProgress progress) {
  15186. const auto &boundary = detail::make_multipart_data_boundary();
  15187. const auto &content_type =
  15188. detail::serialize_multipart_formdata_get_content_type(boundary);
  15189. return send_with_content_provider_and_receiver(
  15190. "PATCH", path, headers, nullptr, 0, nullptr,
  15191. get_multipart_content_provider(boundary, items, provider_items),
  15192. content_type, nullptr, progress);
  15193. }
  15194. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15195. const std::string &body,
  15196. const std::string &content_type,
  15197. ContentReceiver content_receiver,
  15198. DownloadProgress progress) {
  15199. Request req;
  15200. req.method = "PATCH";
  15201. req.path = path;
  15202. req.headers = headers;
  15203. req.body = body;
  15204. req.content_receiver =
  15205. [content_receiver](const char *data, size_t data_length,
  15206. size_t /*offset*/, size_t /*total_length*/) {
  15207. return content_receiver(data, data_length);
  15208. };
  15209. req.download_progress = std::move(progress);
  15210. if (max_timeout_msec_ > 0) {
  15211. req.start_time_ = std::chrono::steady_clock::now();
  15212. }
  15213. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15214. return send_(std::move(req));
  15215. }
  15216. inline Result ClientImpl::Delete(const std::string &path,
  15217. DownloadProgress progress) {
  15218. return Delete(path, Headers(), std::string(), std::string(), progress);
  15219. }
  15220. inline Result ClientImpl::Delete(const std::string &path,
  15221. const Headers &headers,
  15222. DownloadProgress progress) {
  15223. return Delete(path, headers, std::string(), std::string(), progress);
  15224. }
  15225. inline Result ClientImpl::Delete(const std::string &path, const char *body,
  15226. size_t content_length,
  15227. const std::string &content_type,
  15228. DownloadProgress progress) {
  15229. return Delete(path, Headers(), body, content_length, content_type, progress);
  15230. }
  15231. inline Result ClientImpl::Delete(const std::string &path,
  15232. const std::string &body,
  15233. const std::string &content_type,
  15234. DownloadProgress progress) {
  15235. return Delete(path, Headers(), body.data(), body.size(), content_type,
  15236. progress);
  15237. }
  15238. inline Result ClientImpl::Delete(const std::string &path,
  15239. const Headers &headers,
  15240. const std::string &body,
  15241. const std::string &content_type,
  15242. DownloadProgress progress) {
  15243. return Delete(path, headers, body.data(), body.size(), content_type,
  15244. progress);
  15245. }
  15246. inline Result ClientImpl::Delete(const std::string &path, const Params &params,
  15247. DownloadProgress progress) {
  15248. return Delete(path, Headers(), params, progress);
  15249. }
  15250. inline Result ClientImpl::Delete(const std::string &path,
  15251. const Headers &headers, const Params &params,
  15252. DownloadProgress progress) {
  15253. auto query = detail::params_to_query_str(params);
  15254. return Delete(path, headers, query, "application/x-www-form-urlencoded",
  15255. progress);
  15256. }
  15257. inline Result ClientImpl::Delete(const std::string &path,
  15258. const Headers &headers, const char *body,
  15259. size_t content_length,
  15260. const std::string &content_type,
  15261. DownloadProgress progress) {
  15262. Request req;
  15263. req.method = "DELETE";
  15264. req.headers = headers;
  15265. req.path = path;
  15266. req.download_progress = std::move(progress);
  15267. if (max_timeout_msec_ > 0) {
  15268. req.start_time_ = std::chrono::steady_clock::now();
  15269. }
  15270. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15271. req.body.assign(body, content_length);
  15272. return send_(std::move(req));
  15273. }
  15274. inline Result ClientImpl::Options(const std::string &path) {
  15275. return Options(path, Headers());
  15276. }
  15277. inline Result ClientImpl::Options(const std::string &path,
  15278. const Headers &headers) {
  15279. Request req;
  15280. req.method = "OPTIONS";
  15281. req.headers = headers;
  15282. req.path = path;
  15283. if (max_timeout_msec_ > 0) {
  15284. req.start_time_ = std::chrono::steady_clock::now();
  15285. }
  15286. return send_(std::move(req));
  15287. }
  15288. inline void ClientImpl::stop() {
  15289. std::lock_guard<std::mutex> guard(socket_mutex_);
  15290. // If there is anything ongoing right now, the ONLY thread-safe thing we can
  15291. // do is to shutdown_socket, so that threads using this socket suddenly
  15292. // discover they can't read/write any more and error out. Everything else
  15293. // (closing the socket, shutting ssl down) is unsafe because these actions
  15294. // are not thread-safe.
  15295. if (socket_requests_in_flight_ > 0) {
  15296. shutdown_socket(socket_);
  15297. // Aside from that, we set a flag for the socket to be closed when we're
  15298. // done.
  15299. socket_should_be_closed_when_request_is_done_ = true;
  15300. return;
  15301. }
  15302. disconnect(/*gracefully=*/true);
  15303. }
  15304. inline std::string ClientImpl::host() const { return host_; }
  15305. inline int ClientImpl::port() const { return port_; }
  15306. inline size_t ClientImpl::is_socket_open() const {
  15307. std::lock_guard<std::mutex> guard(socket_mutex_);
  15308. return socket_.is_open();
  15309. }
  15310. inline socket_t ClientImpl::socket() const { return socket_.sock; }
  15311. inline void ClientImpl::set_connection_timeout(time_t sec, time_t usec) {
  15312. connection_timeout_sec_ = sec;
  15313. connection_timeout_usec_ = usec;
  15314. }
  15315. inline void ClientImpl::set_read_timeout(time_t sec, time_t usec) {
  15316. read_timeout_sec_ = sec;
  15317. read_timeout_usec_ = usec;
  15318. }
  15319. inline void ClientImpl::set_write_timeout(time_t sec, time_t usec) {
  15320. write_timeout_sec_ = sec;
  15321. write_timeout_usec_ = usec;
  15322. }
  15323. inline void ClientImpl::set_max_timeout(time_t msec) {
  15324. max_timeout_msec_ = msec;
  15325. }
  15326. inline void ClientImpl::set_basic_auth(const std::string &username,
  15327. const std::string &password) {
  15328. basic_auth_username_ = username;
  15329. basic_auth_password_ = password;
  15330. }
  15331. inline void ClientImpl::set_bearer_token_auth(const std::string &token) {
  15332. bearer_token_auth_token_ = token;
  15333. }
  15334. inline void ClientImpl::set_keep_alive(bool on) { keep_alive_ = on; }
  15335. inline void ClientImpl::set_follow_location(bool on) { follow_location_ = on; }
  15336. inline void ClientImpl::set_path_encode(bool on) { path_encode_ = on; }
  15337. inline void
  15338. ClientImpl::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15339. addr_map_ = std::move(addr_map);
  15340. }
  15341. inline void ClientImpl::set_default_headers(Headers headers) {
  15342. default_headers_ = std::move(headers);
  15343. }
  15344. inline void ClientImpl::set_header_writer(
  15345. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15346. header_writer_ = writer;
  15347. }
  15348. inline void ClientImpl::set_address_family(int family) {
  15349. address_family_ = family;
  15350. }
  15351. inline void ClientImpl::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  15352. inline void ClientImpl::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  15353. inline void ClientImpl::set_socket_options(SocketOptions socket_options) {
  15354. socket_options_ = std::move(socket_options);
  15355. }
  15356. inline void ClientImpl::set_compress(bool on) { compress_ = on; }
  15357. inline void ClientImpl::set_decompress(bool on) { decompress_ = on; }
  15358. inline void ClientImpl::set_payload_max_length(size_t length) {
  15359. payload_max_length_ = length;
  15360. has_payload_max_length_ = true;
  15361. }
  15362. inline void ClientImpl::set_interface(const std::string &intf) {
  15363. interface_ = intf;
  15364. }
  15365. inline void ClientImpl::set_proxy(const std::string &host, int port) {
  15366. proxy_host_ = host;
  15367. proxy_port_ = port;
  15368. std::lock_guard<std::mutex> guard(socket_mutex_);
  15369. disconnect(/*gracefully=*/true);
  15370. }
  15371. inline void ClientImpl::set_proxy_basic_auth(const std::string &username,
  15372. const std::string &password) {
  15373. proxy_basic_auth_username_ = username;
  15374. proxy_basic_auth_password_ = password;
  15375. }
  15376. inline void ClientImpl::set_proxy_bearer_token_auth(const std::string &token) {
  15377. proxy_bearer_token_auth_token_ = token;
  15378. }
  15379. inline void ClientImpl::set_no_proxy(const std::vector<std::string> &patterns) {
  15380. no_proxy_entries_ = detail::parse_no_proxy_entries(patterns);
  15381. std::lock_guard<std::mutex> guard(socket_mutex_);
  15382. disconnect(/*gracefully=*/true);
  15383. }
  15384. #ifdef CPPHTTPLIB_SSL_ENABLED
  15385. inline void ClientImpl::set_digest_auth(const std::string &username,
  15386. const std::string &password) {
  15387. digest_auth_username_ = username;
  15388. digest_auth_password_ = password;
  15389. }
  15390. inline void ClientImpl::set_ca_cert_path(const std::string &ca_cert_file_path,
  15391. const std::string &ca_cert_dir_path) {
  15392. ca_cert_file_path_ = ca_cert_file_path;
  15393. ca_cert_dir_path_ = ca_cert_dir_path;
  15394. }
  15395. inline void ClientImpl::set_proxy_digest_auth(const std::string &username,
  15396. const std::string &password) {
  15397. proxy_digest_auth_username_ = username;
  15398. proxy_digest_auth_password_ = password;
  15399. }
  15400. inline void ClientImpl::enable_server_certificate_verification(bool enabled) {
  15401. server_certificate_verification_ = enabled;
  15402. }
  15403. inline void ClientImpl::enable_server_hostname_verification(bool enabled) {
  15404. server_hostname_verification_ = enabled;
  15405. }
  15406. inline void ClientImpl::enable_system_ca(bool enabled) {
  15407. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  15408. }
  15409. #endif
  15410. inline void ClientImpl::set_logger(Logger logger) {
  15411. logger_ = std::move(logger);
  15412. }
  15413. inline void ClientImpl::set_error_logger(ErrorLogger error_logger) {
  15414. error_logger_ = std::move(error_logger);
  15415. }
  15416. /*
  15417. * SSL/TLS Common Implementation
  15418. */
  15419. inline ClientConnection::~ClientConnection() {
  15420. #ifdef CPPHTTPLIB_SSL_ENABLED
  15421. if (session) {
  15422. tls::shutdown(session, true);
  15423. tls::free_session(session);
  15424. session = nullptr;
  15425. }
  15426. #endif
  15427. if (sock != INVALID_SOCKET) {
  15428. detail::close_socket(sock);
  15429. sock = INVALID_SOCKET;
  15430. }
  15431. }
  15432. // Universal client implementation
  15433. inline Client::Client(const std::string &scheme_host_port)
  15434. : Client(scheme_host_port, std::string(), std::string()) {}
  15435. inline Client::Client(const std::string &scheme_host_port,
  15436. const std::string &client_cert_path,
  15437. const std::string &client_key_path) {
  15438. detail::UrlComponents uc;
  15439. if (detail::parse_url(scheme_host_port, uc) && !uc.host.empty()) {
  15440. auto &scheme = uc.scheme;
  15441. #ifdef CPPHTTPLIB_SSL_ENABLED
  15442. if (!scheme.empty() && (scheme != "http" && scheme != "https")) {
  15443. #else
  15444. if (!scheme.empty() && scheme != "http") {
  15445. #endif
  15446. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  15447. std::string msg = "'" + scheme + "' scheme is not supported.";
  15448. throw std::invalid_argument(msg);
  15449. #endif
  15450. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15451. return;
  15452. }
  15453. auto is_ssl = scheme == "https";
  15454. auto host = std::move(uc.host);
  15455. auto port = is_ssl ? 443 : 80;
  15456. if (!uc.port.empty() && !detail::parse_port(uc.port, port)) {
  15457. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15458. return;
  15459. }
  15460. if (is_ssl) {
  15461. #ifdef CPPHTTPLIB_SSL_ENABLED
  15462. cli_ = detail::make_unique<SSLClient>(host, port, client_cert_path,
  15463. client_key_path);
  15464. is_ssl_ = is_ssl;
  15465. #endif
  15466. } else {
  15467. cli_ = detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15468. client_key_path);
  15469. }
  15470. } else if (scheme_host_port.compare(0, 2, "//") == 0 ||
  15471. scheme_host_port.find("://") < scheme_host_port.find('/')) {
  15472. // A URL, but not one this client can use, such as one with userinfo. A
  15473. // Unix socket path may have "//" further on.
  15474. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15475. } else {
  15476. // NOTE: Update TEST(UniversalClientImplTest, Ipv6LiteralAddress)
  15477. // if port param below changes.
  15478. cli_ = detail::make_unique<ClientImpl>(scheme_host_port, 80,
  15479. client_cert_path, client_key_path);
  15480. }
  15481. }
  15482. inline Client::Client(const std::string &host, int port)
  15483. : Client(host, port, std::string(), std::string()) {}
  15484. inline Client::Client(const std::string &host, int port,
  15485. const std::string &client_cert_path,
  15486. const std::string &client_key_path)
  15487. : cli_(detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15488. client_key_path)) {}
  15489. inline Client::~Client() = default;
  15490. inline bool Client::is_valid() const {
  15491. return cli_ != nullptr && cli_->is_valid();
  15492. }
  15493. inline Result Client::Get(const std::string &path, DownloadProgress progress) {
  15494. return cli_->Get(path, std::move(progress));
  15495. }
  15496. inline Result Client::Get(const std::string &path, const Headers &headers,
  15497. DownloadProgress progress) {
  15498. return cli_->Get(path, headers, std::move(progress));
  15499. }
  15500. inline Result Client::Get(const std::string &path,
  15501. ContentReceiver content_receiver,
  15502. DownloadProgress progress) {
  15503. return cli_->Get(path, std::move(content_receiver), std::move(progress));
  15504. }
  15505. inline Result Client::Get(const std::string &path, const Headers &headers,
  15506. ContentReceiver content_receiver,
  15507. DownloadProgress progress) {
  15508. return cli_->Get(path, headers, std::move(content_receiver),
  15509. std::move(progress));
  15510. }
  15511. inline Result Client::Get(const std::string &path,
  15512. ResponseHandler response_handler,
  15513. ContentReceiver content_receiver,
  15514. DownloadProgress progress) {
  15515. return cli_->Get(path, std::move(response_handler),
  15516. std::move(content_receiver), std::move(progress));
  15517. }
  15518. inline Result Client::Get(const std::string &path, const Headers &headers,
  15519. ResponseHandler response_handler,
  15520. ContentReceiver content_receiver,
  15521. DownloadProgress progress) {
  15522. return cli_->Get(path, headers, std::move(response_handler),
  15523. std::move(content_receiver), std::move(progress));
  15524. }
  15525. inline Result Client::Get(const std::string &path, const Params &params,
  15526. DownloadProgress progress) {
  15527. return cli_->Get(path, params, std::move(progress));
  15528. }
  15529. inline Result Client::Get(const std::string &path, const Params &params,
  15530. const Headers &headers, DownloadProgress progress) {
  15531. return cli_->Get(path, params, headers, std::move(progress));
  15532. }
  15533. inline Result Client::Get(const std::string &path, const Params &params,
  15534. const Headers &headers,
  15535. ContentReceiver content_receiver,
  15536. DownloadProgress progress) {
  15537. return cli_->Get(path, params, headers, std::move(content_receiver),
  15538. std::move(progress));
  15539. }
  15540. inline Result Client::Get(const std::string &path, const Params &params,
  15541. const Headers &headers,
  15542. ResponseHandler response_handler,
  15543. ContentReceiver content_receiver,
  15544. DownloadProgress progress) {
  15545. return cli_->Get(path, params, headers, std::move(response_handler),
  15546. std::move(content_receiver), std::move(progress));
  15547. }
  15548. inline Result Client::Head(const std::string &path) { return cli_->Head(path); }
  15549. inline Result Client::Head(const std::string &path, const Headers &headers) {
  15550. return cli_->Head(path, headers);
  15551. }
  15552. inline Result Client::Post(const std::string &path) { return cli_->Post(path); }
  15553. inline Result Client::Post(const std::string &path, const Headers &headers) {
  15554. return cli_->Post(path, headers);
  15555. }
  15556. inline Result Client::Post(const std::string &path, const char *body,
  15557. size_t content_length,
  15558. const std::string &content_type,
  15559. UploadProgress progress) {
  15560. return cli_->Post(path, body, content_length, content_type, progress);
  15561. }
  15562. inline Result Client::Post(const std::string &path, const Headers &headers,
  15563. const char *body, size_t content_length,
  15564. const std::string &content_type,
  15565. UploadProgress progress) {
  15566. return cli_->Post(path, headers, body, content_length, content_type,
  15567. progress);
  15568. }
  15569. inline Result Client::Post(const std::string &path, const std::string &body,
  15570. const std::string &content_type,
  15571. UploadProgress progress) {
  15572. return cli_->Post(path, body, content_type, progress);
  15573. }
  15574. inline Result Client::Post(const std::string &path, const Headers &headers,
  15575. const std::string &body,
  15576. const std::string &content_type,
  15577. UploadProgress progress) {
  15578. return cli_->Post(path, headers, body, content_type, progress);
  15579. }
  15580. inline Result Client::Post(const std::string &path, size_t content_length,
  15581. ContentProvider content_provider,
  15582. const std::string &content_type,
  15583. UploadProgress progress) {
  15584. return cli_->Post(path, content_length, std::move(content_provider),
  15585. content_type, progress);
  15586. }
  15587. inline Result Client::Post(const std::string &path, size_t content_length,
  15588. ContentProvider content_provider,
  15589. const std::string &content_type,
  15590. ContentReceiver content_receiver,
  15591. UploadProgress progress) {
  15592. return cli_->Post(path, content_length, std::move(content_provider),
  15593. content_type, std::move(content_receiver), progress);
  15594. }
  15595. inline Result Client::Post(const std::string &path,
  15596. ContentProviderWithoutLength content_provider,
  15597. const std::string &content_type,
  15598. UploadProgress progress) {
  15599. return cli_->Post(path, std::move(content_provider), content_type, progress);
  15600. }
  15601. inline Result Client::Post(const std::string &path,
  15602. ContentProviderWithoutLength content_provider,
  15603. const std::string &content_type,
  15604. ContentReceiver content_receiver,
  15605. UploadProgress progress) {
  15606. return cli_->Post(path, std::move(content_provider), content_type,
  15607. std::move(content_receiver), progress);
  15608. }
  15609. inline Result Client::Post(const std::string &path, const Headers &headers,
  15610. size_t content_length,
  15611. ContentProvider content_provider,
  15612. const std::string &content_type,
  15613. UploadProgress progress) {
  15614. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15615. content_type, progress);
  15616. }
  15617. inline Result Client::Post(const std::string &path, const Headers &headers,
  15618. size_t content_length,
  15619. ContentProvider content_provider,
  15620. const std::string &content_type,
  15621. ContentReceiver content_receiver,
  15622. DownloadProgress progress) {
  15623. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15624. content_type, std::move(content_receiver), progress);
  15625. }
  15626. inline Result Client::Post(const std::string &path, const Headers &headers,
  15627. ContentProviderWithoutLength content_provider,
  15628. const std::string &content_type,
  15629. UploadProgress progress) {
  15630. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15631. progress);
  15632. }
  15633. inline Result Client::Post(const std::string &path, const Headers &headers,
  15634. ContentProviderWithoutLength content_provider,
  15635. const std::string &content_type,
  15636. ContentReceiver content_receiver,
  15637. DownloadProgress progress) {
  15638. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15639. std::move(content_receiver), progress);
  15640. }
  15641. inline Result Client::Post(const std::string &path, const Params &params) {
  15642. return cli_->Post(path, params);
  15643. }
  15644. inline Result Client::Post(const std::string &path, const Headers &headers,
  15645. const Params &params) {
  15646. return cli_->Post(path, headers, params);
  15647. }
  15648. inline Result Client::Post(const std::string &path,
  15649. const UploadFormDataItems &items,
  15650. UploadProgress progress) {
  15651. return cli_->Post(path, items, progress);
  15652. }
  15653. inline Result Client::Post(const std::string &path, const Headers &headers,
  15654. const UploadFormDataItems &items,
  15655. UploadProgress progress) {
  15656. return cli_->Post(path, headers, items, progress);
  15657. }
  15658. inline Result Client::Post(const std::string &path, const Headers &headers,
  15659. const UploadFormDataItems &items,
  15660. const std::string &boundary,
  15661. UploadProgress progress) {
  15662. return cli_->Post(path, headers, items, boundary, progress);
  15663. }
  15664. inline Result Client::Post(const std::string &path, const Headers &headers,
  15665. const UploadFormDataItems &items,
  15666. const FormDataProviderItems &provider_items,
  15667. UploadProgress progress) {
  15668. return cli_->Post(path, headers, items, provider_items, progress);
  15669. }
  15670. inline Result Client::Post(const std::string &path, const Headers &headers,
  15671. const std::string &body,
  15672. const std::string &content_type,
  15673. ContentReceiver content_receiver,
  15674. DownloadProgress progress) {
  15675. return cli_->Post(path, headers, body, content_type,
  15676. std::move(content_receiver), progress);
  15677. }
  15678. inline Result Client::Put(const std::string &path) { return cli_->Put(path); }
  15679. inline Result Client::Put(const std::string &path, const Headers &headers) {
  15680. return cli_->Put(path, headers);
  15681. }
  15682. inline Result Client::Put(const std::string &path, const char *body,
  15683. size_t content_length,
  15684. const std::string &content_type,
  15685. UploadProgress progress) {
  15686. return cli_->Put(path, body, content_length, content_type, progress);
  15687. }
  15688. inline Result Client::Put(const std::string &path, const Headers &headers,
  15689. const char *body, size_t content_length,
  15690. const std::string &content_type,
  15691. UploadProgress progress) {
  15692. return cli_->Put(path, headers, body, content_length, content_type, progress);
  15693. }
  15694. inline Result Client::Put(const std::string &path, const std::string &body,
  15695. const std::string &content_type,
  15696. UploadProgress progress) {
  15697. return cli_->Put(path, body, content_type, progress);
  15698. }
  15699. inline Result Client::Put(const std::string &path, const Headers &headers,
  15700. const std::string &body,
  15701. const std::string &content_type,
  15702. UploadProgress progress) {
  15703. return cli_->Put(path, headers, body, content_type, progress);
  15704. }
  15705. inline Result Client::Put(const std::string &path, size_t content_length,
  15706. ContentProvider content_provider,
  15707. const std::string &content_type,
  15708. UploadProgress progress) {
  15709. return cli_->Put(path, content_length, std::move(content_provider),
  15710. content_type, progress);
  15711. }
  15712. inline Result Client::Put(const std::string &path, size_t content_length,
  15713. ContentProvider content_provider,
  15714. const std::string &content_type,
  15715. ContentReceiver content_receiver,
  15716. UploadProgress progress) {
  15717. return cli_->Put(path, content_length, std::move(content_provider),
  15718. content_type, std::move(content_receiver), progress);
  15719. }
  15720. inline Result Client::Put(const std::string &path,
  15721. ContentProviderWithoutLength content_provider,
  15722. const std::string &content_type,
  15723. UploadProgress progress) {
  15724. return cli_->Put(path, std::move(content_provider), content_type, progress);
  15725. }
  15726. inline Result Client::Put(const std::string &path,
  15727. ContentProviderWithoutLength content_provider,
  15728. const std::string &content_type,
  15729. ContentReceiver content_receiver,
  15730. UploadProgress progress) {
  15731. return cli_->Put(path, std::move(content_provider), content_type,
  15732. std::move(content_receiver), progress);
  15733. }
  15734. inline Result Client::Put(const std::string &path, const Headers &headers,
  15735. size_t content_length,
  15736. ContentProvider content_provider,
  15737. const std::string &content_type,
  15738. UploadProgress progress) {
  15739. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15740. content_type, progress);
  15741. }
  15742. inline Result Client::Put(const std::string &path, const Headers &headers,
  15743. size_t content_length,
  15744. ContentProvider content_provider,
  15745. const std::string &content_type,
  15746. ContentReceiver content_receiver,
  15747. UploadProgress progress) {
  15748. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15749. content_type, std::move(content_receiver), progress);
  15750. }
  15751. inline Result Client::Put(const std::string &path, const Headers &headers,
  15752. ContentProviderWithoutLength content_provider,
  15753. const std::string &content_type,
  15754. UploadProgress progress) {
  15755. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15756. progress);
  15757. }
  15758. inline Result Client::Put(const std::string &path, const Headers &headers,
  15759. ContentProviderWithoutLength content_provider,
  15760. const std::string &content_type,
  15761. ContentReceiver content_receiver,
  15762. UploadProgress progress) {
  15763. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15764. std::move(content_receiver), progress);
  15765. }
  15766. inline Result Client::Put(const std::string &path, const Params &params) {
  15767. return cli_->Put(path, params);
  15768. }
  15769. inline Result Client::Put(const std::string &path, const Headers &headers,
  15770. const Params &params) {
  15771. return cli_->Put(path, headers, params);
  15772. }
  15773. inline Result Client::Put(const std::string &path,
  15774. const UploadFormDataItems &items,
  15775. UploadProgress progress) {
  15776. return cli_->Put(path, items, progress);
  15777. }
  15778. inline Result Client::Put(const std::string &path, const Headers &headers,
  15779. const UploadFormDataItems &items,
  15780. UploadProgress progress) {
  15781. return cli_->Put(path, headers, items, progress);
  15782. }
  15783. inline Result Client::Put(const std::string &path, const Headers &headers,
  15784. const UploadFormDataItems &items,
  15785. const std::string &boundary,
  15786. UploadProgress progress) {
  15787. return cli_->Put(path, headers, items, boundary, progress);
  15788. }
  15789. inline Result Client::Put(const std::string &path, const Headers &headers,
  15790. const UploadFormDataItems &items,
  15791. const FormDataProviderItems &provider_items,
  15792. UploadProgress progress) {
  15793. return cli_->Put(path, headers, items, provider_items, progress);
  15794. }
  15795. inline Result Client::Put(const std::string &path, const Headers &headers,
  15796. const std::string &body,
  15797. const std::string &content_type,
  15798. ContentReceiver content_receiver,
  15799. DownloadProgress progress) {
  15800. return cli_->Put(path, headers, body, content_type, content_receiver,
  15801. progress);
  15802. }
  15803. inline Result Client::Patch(const std::string &path) {
  15804. return cli_->Patch(path);
  15805. }
  15806. inline Result Client::Patch(const std::string &path, const Headers &headers) {
  15807. return cli_->Patch(path, headers);
  15808. }
  15809. inline Result Client::Patch(const std::string &path, const char *body,
  15810. size_t content_length,
  15811. const std::string &content_type,
  15812. UploadProgress progress) {
  15813. return cli_->Patch(path, body, content_length, content_type, progress);
  15814. }
  15815. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15816. const char *body, size_t content_length,
  15817. const std::string &content_type,
  15818. UploadProgress progress) {
  15819. return cli_->Patch(path, headers, body, content_length, content_type,
  15820. progress);
  15821. }
  15822. inline Result Client::Patch(const std::string &path, const std::string &body,
  15823. const std::string &content_type,
  15824. UploadProgress progress) {
  15825. return cli_->Patch(path, body, content_type, progress);
  15826. }
  15827. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15828. const std::string &body,
  15829. const std::string &content_type,
  15830. UploadProgress progress) {
  15831. return cli_->Patch(path, headers, body, content_type, progress);
  15832. }
  15833. inline Result Client::Patch(const std::string &path, size_t content_length,
  15834. ContentProvider content_provider,
  15835. const std::string &content_type,
  15836. UploadProgress progress) {
  15837. return cli_->Patch(path, content_length, std::move(content_provider),
  15838. content_type, progress);
  15839. }
  15840. inline Result Client::Patch(const std::string &path, size_t content_length,
  15841. ContentProvider content_provider,
  15842. const std::string &content_type,
  15843. ContentReceiver content_receiver,
  15844. UploadProgress progress) {
  15845. return cli_->Patch(path, content_length, std::move(content_provider),
  15846. content_type, std::move(content_receiver), progress);
  15847. }
  15848. inline Result Client::Patch(const std::string &path,
  15849. ContentProviderWithoutLength content_provider,
  15850. const std::string &content_type,
  15851. UploadProgress progress) {
  15852. return cli_->Patch(path, std::move(content_provider), content_type, progress);
  15853. }
  15854. inline Result Client::Patch(const std::string &path,
  15855. ContentProviderWithoutLength content_provider,
  15856. const std::string &content_type,
  15857. ContentReceiver content_receiver,
  15858. UploadProgress progress) {
  15859. return cli_->Patch(path, std::move(content_provider), content_type,
  15860. std::move(content_receiver), progress);
  15861. }
  15862. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15863. size_t content_length,
  15864. ContentProvider content_provider,
  15865. const std::string &content_type,
  15866. UploadProgress progress) {
  15867. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15868. content_type, progress);
  15869. }
  15870. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15871. size_t content_length,
  15872. ContentProvider content_provider,
  15873. const std::string &content_type,
  15874. ContentReceiver content_receiver,
  15875. UploadProgress progress) {
  15876. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15877. content_type, std::move(content_receiver), progress);
  15878. }
  15879. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15880. ContentProviderWithoutLength content_provider,
  15881. const std::string &content_type,
  15882. UploadProgress progress) {
  15883. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15884. progress);
  15885. }
  15886. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15887. ContentProviderWithoutLength content_provider,
  15888. const std::string &content_type,
  15889. ContentReceiver content_receiver,
  15890. UploadProgress progress) {
  15891. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15892. std::move(content_receiver), progress);
  15893. }
  15894. inline Result Client::Patch(const std::string &path, const Params &params) {
  15895. return cli_->Patch(path, params);
  15896. }
  15897. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15898. const Params &params) {
  15899. return cli_->Patch(path, headers, params);
  15900. }
  15901. inline Result Client::Patch(const std::string &path,
  15902. const UploadFormDataItems &items,
  15903. UploadProgress progress) {
  15904. return cli_->Patch(path, items, progress);
  15905. }
  15906. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15907. const UploadFormDataItems &items,
  15908. UploadProgress progress) {
  15909. return cli_->Patch(path, headers, items, progress);
  15910. }
  15911. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15912. const UploadFormDataItems &items,
  15913. const std::string &boundary,
  15914. UploadProgress progress) {
  15915. return cli_->Patch(path, headers, items, boundary, progress);
  15916. }
  15917. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15918. const UploadFormDataItems &items,
  15919. const FormDataProviderItems &provider_items,
  15920. UploadProgress progress) {
  15921. return cli_->Patch(path, headers, items, provider_items, progress);
  15922. }
  15923. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15924. const std::string &body,
  15925. const std::string &content_type,
  15926. ContentReceiver content_receiver,
  15927. DownloadProgress progress) {
  15928. return cli_->Patch(path, headers, body, content_type, content_receiver,
  15929. progress);
  15930. }
  15931. inline Result Client::Delete(const std::string &path,
  15932. DownloadProgress progress) {
  15933. return cli_->Delete(path, progress);
  15934. }
  15935. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15936. DownloadProgress progress) {
  15937. return cli_->Delete(path, headers, progress);
  15938. }
  15939. inline Result Client::Delete(const std::string &path, const char *body,
  15940. size_t content_length,
  15941. const std::string &content_type,
  15942. DownloadProgress progress) {
  15943. return cli_->Delete(path, body, content_length, content_type, progress);
  15944. }
  15945. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15946. const char *body, size_t content_length,
  15947. const std::string &content_type,
  15948. DownloadProgress progress) {
  15949. return cli_->Delete(path, headers, body, content_length, content_type,
  15950. progress);
  15951. }
  15952. inline Result Client::Delete(const std::string &path, const std::string &body,
  15953. const std::string &content_type,
  15954. DownloadProgress progress) {
  15955. return cli_->Delete(path, body, content_type, progress);
  15956. }
  15957. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15958. const std::string &body,
  15959. const std::string &content_type,
  15960. DownloadProgress progress) {
  15961. return cli_->Delete(path, headers, body, content_type, progress);
  15962. }
  15963. inline Result Client::Delete(const std::string &path, const Params &params,
  15964. DownloadProgress progress) {
  15965. return cli_->Delete(path, params, progress);
  15966. }
  15967. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15968. const Params &params, DownloadProgress progress) {
  15969. return cli_->Delete(path, headers, params, progress);
  15970. }
  15971. inline Result Client::Options(const std::string &path) {
  15972. return cli_->Options(path);
  15973. }
  15974. inline Result Client::Options(const std::string &path, const Headers &headers) {
  15975. return cli_->Options(path, headers);
  15976. }
  15977. inline ClientImpl::StreamHandle
  15978. Client::open_stream(const std::string &method, const std::string &path,
  15979. const Params &params, const Headers &headers,
  15980. const std::string &body, const std::string &content_type) {
  15981. return cli_->open_stream(method, path, params, headers, body, content_type);
  15982. }
  15983. inline bool Client::send(Request &req, Response &res, Error &error) {
  15984. return cli_->send(req, res, error);
  15985. }
  15986. inline Result Client::send(const Request &req) { return cli_->send(req); }
  15987. inline void Client::stop() { cli_->stop(); }
  15988. inline std::string Client::host() const { return cli_->host(); }
  15989. inline int Client::port() const { return cli_->port(); }
  15990. inline size_t Client::is_socket_open() const { return cli_->is_socket_open(); }
  15991. inline socket_t Client::socket() const { return cli_->socket(); }
  15992. inline void
  15993. Client::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15994. cli_->set_hostname_addr_map(std::move(addr_map));
  15995. }
  15996. inline void Client::set_default_headers(Headers headers) {
  15997. cli_->set_default_headers(std::move(headers));
  15998. }
  15999. inline void Client::set_header_writer(
  16000. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  16001. cli_->set_header_writer(writer);
  16002. }
  16003. inline void Client::set_address_family(int family) {
  16004. cli_->set_address_family(family);
  16005. }
  16006. inline void Client::set_tcp_nodelay(bool on) { cli_->set_tcp_nodelay(on); }
  16007. inline void Client::set_socket_options(SocketOptions socket_options) {
  16008. cli_->set_socket_options(std::move(socket_options));
  16009. }
  16010. inline void Client::set_connection_timeout(time_t sec, time_t usec) {
  16011. cli_->set_connection_timeout(sec, usec);
  16012. }
  16013. inline void Client::set_read_timeout(time_t sec, time_t usec) {
  16014. cli_->set_read_timeout(sec, usec);
  16015. }
  16016. inline void Client::set_write_timeout(time_t sec, time_t usec) {
  16017. cli_->set_write_timeout(sec, usec);
  16018. }
  16019. inline void Client::set_basic_auth(const std::string &username,
  16020. const std::string &password) {
  16021. cli_->set_basic_auth(username, password);
  16022. }
  16023. inline void Client::set_bearer_token_auth(const std::string &token) {
  16024. cli_->set_bearer_token_auth(token);
  16025. }
  16026. inline void Client::set_keep_alive(bool on) { cli_->set_keep_alive(on); }
  16027. inline void Client::set_follow_location(bool on) {
  16028. cli_->set_follow_location(on);
  16029. }
  16030. inline void Client::set_path_encode(bool on) { cli_->set_path_encode(on); }
  16031. inline void Client::set_compress(bool on) { cli_->set_compress(on); }
  16032. inline void Client::set_decompress(bool on) { cli_->set_decompress(on); }
  16033. inline void Client::set_payload_max_length(size_t length) {
  16034. cli_->set_payload_max_length(length);
  16035. }
  16036. inline void Client::set_interface(const std::string &intf) {
  16037. cli_->set_interface(intf);
  16038. }
  16039. inline void Client::set_proxy(const std::string &host, int port) {
  16040. cli_->set_proxy(host, port);
  16041. }
  16042. inline void Client::set_proxy_basic_auth(const std::string &username,
  16043. const std::string &password) {
  16044. cli_->set_proxy_basic_auth(username, password);
  16045. }
  16046. inline void Client::set_proxy_bearer_token_auth(const std::string &token) {
  16047. cli_->set_proxy_bearer_token_auth(token);
  16048. }
  16049. inline void Client::set_no_proxy(const std::vector<std::string> &patterns) {
  16050. cli_->set_no_proxy(patterns);
  16051. }
  16052. inline void Client::set_logger(Logger logger) {
  16053. cli_->set_logger(std::move(logger));
  16054. }
  16055. inline void Client::set_error_logger(ErrorLogger error_logger) {
  16056. cli_->set_error_logger(std::move(error_logger));
  16057. }
  16058. /*
  16059. * Group 6: SSL Server and Client implementation
  16060. */
  16061. #ifdef CPPHTTPLIB_SSL_ENABLED
  16062. // SSL HTTP server implementation
  16063. inline SSLServer::SSLServer(const char *cert_path, const char *private_key_path,
  16064. const char *client_ca_cert_file_path,
  16065. const char *client_ca_cert_dir_path,
  16066. const char *private_key_password) {
  16067. using namespace tls;
  16068. ctx_ = create_server_context();
  16069. if (!ctx_) { return; }
  16070. // Load server certificate and private key
  16071. if (!set_server_cert_file(ctx_, cert_path, private_key_path,
  16072. private_key_password)) {
  16073. last_ssl_error_ = static_cast<int>(get_error());
  16074. free_context(ctx_);
  16075. ctx_ = nullptr;
  16076. return;
  16077. }
  16078. // Load client CA certificates for client authentication
  16079. if (client_ca_cert_file_path || client_ca_cert_dir_path) {
  16080. if (!set_client_ca_file(ctx_, client_ca_cert_file_path,
  16081. client_ca_cert_dir_path)) {
  16082. last_ssl_error_ = static_cast<int>(get_error());
  16083. free_context(ctx_);
  16084. ctx_ = nullptr;
  16085. return;
  16086. }
  16087. // Enable client certificate verification
  16088. set_verify_client(ctx_, true);
  16089. }
  16090. }
  16091. inline SSLServer::SSLServer(const PemMemory &pem) {
  16092. using namespace tls;
  16093. ctx_ = create_server_context();
  16094. if (ctx_) {
  16095. std::string cert_buf, key_buf;
  16096. if (!set_server_cert_pem(
  16097. ctx_, detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  16098. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  16099. pem.private_key_password)) {
  16100. last_ssl_error_ = static_cast<int>(get_error());
  16101. free_context(ctx_);
  16102. ctx_ = nullptr;
  16103. } else if (pem.client_ca_pem) {
  16104. auto ca_len = pem.client_ca_pem_len ? pem.client_ca_pem_len
  16105. : strlen(pem.client_ca_pem);
  16106. if (!load_ca_pem(ctx_, pem.client_ca_pem, ca_len)) {
  16107. last_ssl_error_ = static_cast<int>(get_error());
  16108. free_context(ctx_);
  16109. ctx_ = nullptr;
  16110. } else {
  16111. set_verify_client(ctx_, true);
  16112. }
  16113. }
  16114. }
  16115. }
  16116. inline SSLServer::SSLServer(const tls::ContextSetupCallback &setup_callback) {
  16117. using namespace tls;
  16118. ctx_ = create_server_context();
  16119. if (ctx_) {
  16120. if (!setup_callback(ctx_)) {
  16121. free_context(ctx_);
  16122. ctx_ = nullptr;
  16123. }
  16124. }
  16125. }
  16126. inline SSLServer::~SSLServer() {
  16127. if (ctx_) { tls::free_context(ctx_); }
  16128. }
  16129. inline bool SSLServer::is_valid() const {
  16130. return ctx_ != nullptr && Server::is_valid();
  16131. }
  16132. inline bool SSLServer::process_and_close_socket(socket_t sock) {
  16133. using namespace tls;
  16134. session_t session = nullptr;
  16135. {
  16136. std::unique_lock<std::mutex> lock(ctx_mutex_);
  16137. ctx_cv_.wait(lock, [&] { return updates_pending_ == 0; });
  16138. session = create_session(static_cast<ctx_t>(ctx_), sock);
  16139. if (session) { handshakes_in_progress_++; }
  16140. }
  16141. if (!session) {
  16142. last_ssl_error_ = static_cast<int>(get_error());
  16143. detail::shutdown_socket(sock);
  16144. detail::close_socket(sock);
  16145. return false;
  16146. }
  16147. // Use scope_exit to ensure cleanup on all paths (including exceptions)
  16148. bool handshake_done = false;
  16149. bool ret = false;
  16150. bool websocket_upgraded = false;
  16151. auto cleanup = detail::scope_exit([&] {
  16152. if (handshake_done) { shutdown(session, !websocket_upgraded && ret); }
  16153. free_session(session);
  16154. detail::shutdown_socket(sock);
  16155. detail::close_socket(sock);
  16156. });
  16157. // Perform TLS accept handshake with timeout
  16158. TlsError tls_err;
  16159. auto accepted = false;
  16160. {
  16161. auto handshake_left = detail::scope_exit([&] {
  16162. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16163. if (--handshakes_in_progress_ == 0) { ctx_cv_.notify_all(); }
  16164. });
  16165. accepted = accept_nonblocking(session, sock, read_timeout_sec_,
  16166. read_timeout_usec_, &tls_err);
  16167. }
  16168. if (!accepted) {
  16169. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16170. // Map TlsError to legacy ssl_error for backward compatibility
  16171. if (tls_err.code == ErrorCode::WantRead) {
  16172. last_ssl_error_ = SSL_ERROR_WANT_READ;
  16173. } else if (tls_err.code == ErrorCode::WantWrite) {
  16174. last_ssl_error_ = SSL_ERROR_WANT_WRITE;
  16175. } else {
  16176. last_ssl_error_ = SSL_ERROR_SSL;
  16177. }
  16178. #else
  16179. last_ssl_error_ = static_cast<int>(get_error());
  16180. #endif
  16181. return false;
  16182. }
  16183. handshake_done = true;
  16184. std::string remote_addr;
  16185. int remote_port = 0;
  16186. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  16187. std::string local_addr;
  16188. int local_port = 0;
  16189. detail::get_local_ip_and_port(sock, local_addr, local_port);
  16190. ret = serve_guarded([&]() {
  16191. return detail::process_server_socket_ssl(
  16192. svr_sock_, session, sock, keep_alive_max_count_,
  16193. keep_alive_timeout_sec_, read_timeout_sec_, read_timeout_usec_,
  16194. write_timeout_sec_, write_timeout_usec_,
  16195. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  16196. return process_request(
  16197. strm, remote_addr, remote_port, local_addr, local_port,
  16198. close_connection, connection_closed,
  16199. [&](Request &req) { req.ssl = session; }, &websocket_upgraded);
  16200. });
  16201. });
  16202. return ret;
  16203. }
  16204. inline bool SSLServer::update_certs_pem(const char *cert_pem,
  16205. const char *key_pem,
  16206. const char *client_ca_pem,
  16207. const char *password) {
  16208. if (!ctx_) { return false; }
  16209. std::unique_lock<std::mutex> lock(ctx_mutex_);
  16210. updates_pending_++;
  16211. auto se = detail::scope_exit([&] {
  16212. if (--updates_pending_ == 0) { ctx_cv_.notify_all(); }
  16213. });
  16214. ctx_cv_.wait(lock, [&] { return handshakes_in_progress_ == 0; });
  16215. if (!tls::update_server_cert(ctx_, cert_pem, key_pem, password)) {
  16216. return false;
  16217. }
  16218. if (client_ca_pem) {
  16219. if (!tls::update_server_client_ca(ctx_, client_ca_pem)) { return false; }
  16220. // As in the constructors, a client CA makes client certificates required
  16221. tls::set_verify_client(ctx_, true);
  16222. }
  16223. return true;
  16224. }
  16225. // SSL HTTP client implementation
  16226. inline SSLClient::~SSLClient() {
  16227. // Make sure to shut down SSL since shutdown_ssl will resolve to the
  16228. // base function rather than the derived function once we get to the
  16229. // base class destructor, and won't free the SSL (causing a leak).
  16230. // This must happen before the context is freed below: some backends
  16231. // (e.g. mbedTLS) have the SSL session borrow a raw pointer into the
  16232. // context, so freeing the context first leaves close_notify reading
  16233. // freed memory.
  16234. shutdown_ssl_impl(socket_, true);
  16235. if (ctx_) {
  16236. tls::free_context(ctx_);
  16237. ctx_ = nullptr;
  16238. }
  16239. }
  16240. inline bool SSLClient::is_valid() const { return ctx_ != nullptr; }
  16241. inline void SSLClient::shutdown_ssl(Socket &socket, bool shutdown_gracefully) {
  16242. shutdown_ssl_impl(socket, shutdown_gracefully);
  16243. }
  16244. inline void SSLClient::shutdown_ssl_impl(Socket &socket,
  16245. bool shutdown_gracefully) {
  16246. if (socket.sock == INVALID_SOCKET) {
  16247. assert(socket.ssl == nullptr);
  16248. return;
  16249. }
  16250. if (socket.ssl) {
  16251. tls::shutdown(socket.ssl, shutdown_gracefully);
  16252. {
  16253. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16254. tls::free_session(socket.ssl);
  16255. }
  16256. socket.ssl = nullptr;
  16257. }
  16258. assert(socket.ssl == nullptr);
  16259. }
  16260. inline bool SSLClient::process_socket(
  16261. const Socket &socket,
  16262. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16263. std::function<bool(Stream &strm)> callback) {
  16264. assert(socket.ssl);
  16265. return detail::process_client_socket_ssl(
  16266. socket.ssl, socket.sock, read_timeout_sec_, read_timeout_usec_,
  16267. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_, start_time,
  16268. [&](detail::SSLSocketStream &strm) {
  16269. auto ret = callback(strm);
  16270. // A request that failed after the handshake reports Error::Read or
  16271. // Error::Write; keep the TLS error behind it, such as a fatal alert
  16272. // from the server, for Result::ssl_error() and ssl_backend_error()
  16273. const auto &tls_error = strm.tls_error();
  16274. if (!ret && tls_error.code != tls::ErrorCode::Success) {
  16275. last_ssl_error_ = static_cast<int>(tls_error.code);
  16276. last_backend_error_ = tls_error.backend_code;
  16277. }
  16278. return ret;
  16279. });
  16280. }
  16281. inline bool SSLClient::is_ssl() const { return true; }
  16282. inline bool SSLClient::create_and_connect_socket(Socket &socket, Error &error) {
  16283. if (!is_valid()) {
  16284. error = Error::SSLConnection;
  16285. return false;
  16286. }
  16287. return ClientImpl::create_and_connect_socket(socket, error);
  16288. }
  16289. inline bool SSLClient::setup_proxy_connection(
  16290. Socket &socket,
  16291. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16292. Response &res, bool &success, Error &error) {
  16293. if (!is_proxy_enabled_for_host(host_)) { return true; }
  16294. if (!connect_with_proxy(socket, start_time, res, success, error)) {
  16295. return false;
  16296. }
  16297. if (!initialize_ssl(socket, error)) {
  16298. success = false;
  16299. return false;
  16300. }
  16301. return true;
  16302. }
  16303. // Assumes that socket_mutex_ is locked and that there are no requests in
  16304. // flight
  16305. inline bool SSLClient::connect_with_proxy(
  16306. Socket &socket,
  16307. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16308. Response &res, bool &success, Error &error) {
  16309. success = true;
  16310. Response proxy_res;
  16311. if (!detail::process_client_socket(
  16312. socket.sock, read_timeout_sec_, read_timeout_usec_,
  16313. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  16314. start_time, [&](Stream &strm) {
  16315. Request req2;
  16316. req2.method = "CONNECT";
  16317. req2.path =
  16318. detail::make_host_and_port_string_always_port(host_, port_);
  16319. if (max_timeout_msec_ > 0) {
  16320. req2.start_time_ = std::chrono::steady_clock::now();
  16321. }
  16322. return process_request(strm, req2, proxy_res, false, error);
  16323. })) {
  16324. // Thread-safe to close everything because we are assuming there are no
  16325. // requests in flight
  16326. shutdown_ssl(socket, true);
  16327. shutdown_socket(socket);
  16328. close_socket(socket);
  16329. success = false;
  16330. return false;
  16331. }
  16332. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  16333. if (!proxy_digest_auth_username_.empty() &&
  16334. !proxy_digest_auth_password_.empty()) {
  16335. std::map<std::string, std::string> auth;
  16336. if (detail::parse_www_authenticate(proxy_res, auth, true)) {
  16337. // Close the current socket and create a new one for the authenticated
  16338. // request
  16339. shutdown_ssl(socket, true);
  16340. shutdown_socket(socket);
  16341. close_socket(socket);
  16342. // Create a new socket for the authenticated CONNECT request
  16343. if (!ensure_socket_connection(socket, error)) {
  16344. success = false;
  16345. return false;
  16346. }
  16347. proxy_res = Response();
  16348. if (!detail::process_client_socket(
  16349. socket.sock, read_timeout_sec_, read_timeout_usec_,
  16350. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  16351. start_time, [&](Stream &strm) {
  16352. Request req3;
  16353. req3.method = "CONNECT";
  16354. req3.path = detail::make_host_and_port_string_always_port(
  16355. host_, port_);
  16356. req3.headers.insert(detail::make_digest_authentication_header(
  16357. req3, make_request_target(req3), auth, 1,
  16358. detail::random_string(10), proxy_digest_auth_username_,
  16359. proxy_digest_auth_password_, true));
  16360. if (max_timeout_msec_ > 0) {
  16361. req3.start_time_ = std::chrono::steady_clock::now();
  16362. }
  16363. return process_request(strm, req3, proxy_res, false, error);
  16364. })) {
  16365. // Thread-safe to close everything because we are assuming there are
  16366. // no requests in flight
  16367. shutdown_ssl(socket, true);
  16368. shutdown_socket(socket);
  16369. close_socket(socket);
  16370. success = false;
  16371. return false;
  16372. }
  16373. }
  16374. }
  16375. }
  16376. // If status code is not 200, proxy request is failed.
  16377. // Set error to ProxyConnection. A 407 is returned as the response of the
  16378. // request, so the caller sees the proxy asks for credentials; any other
  16379. // status would read as the answer of the origin, which it never reached.
  16380. if (proxy_res.status != StatusCode::OK_200) {
  16381. error = Error::ProxyConnection;
  16382. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  16383. res = std::move(proxy_res);
  16384. } else {
  16385. success = false;
  16386. }
  16387. // Thread-safe to close everything because we are assuming there are
  16388. // no requests in flight
  16389. shutdown_ssl(socket, true);
  16390. shutdown_socket(socket);
  16391. close_socket(socket);
  16392. return false;
  16393. }
  16394. return true;
  16395. }
  16396. inline bool SSLClient::ensure_socket_connection(Socket &socket, Error &error) {
  16397. if (!ClientImpl::ensure_socket_connection(socket, error)) { return false; }
  16398. if (is_proxy_enabled_for_host(host_)) { return true; }
  16399. if (!initialize_ssl(socket, error)) {
  16400. shutdown_socket(socket);
  16401. close_socket(socket);
  16402. return false;
  16403. }
  16404. return true;
  16405. }
  16406. // SSL HTTP client implementation
  16407. inline SSLClient::SSLClient(const std::string &host)
  16408. : SSLClient(host, 443, std::string(), std::string()) {}
  16409. inline SSLClient::SSLClient(const std::string &host, int port)
  16410. : SSLClient(host, port, std::string(), std::string()) {}
  16411. inline void SSLClient::init_ctx() {
  16412. ctx_ = tls::create_client_context();
  16413. if (ctx_) { tls::set_min_version(ctx_, tls::Version::TLS1_2); }
  16414. }
  16415. inline void SSLClient::reset_ctx_on_error() {
  16416. last_backend_error_ = tls::get_error();
  16417. tls::free_context(ctx_);
  16418. ctx_ = nullptr;
  16419. }
  16420. inline SSLClient::SSLClient(const std::string &host, int port,
  16421. const std::string &client_cert_path,
  16422. const std::string &client_key_path,
  16423. const std::string &private_key_password)
  16424. : ClientImpl(host, port, client_cert_path, client_key_path) {
  16425. init_ctx();
  16426. if (!ctx_) { return; }
  16427. if (!client_cert_path.empty() && !client_key_path.empty()) {
  16428. const char *password =
  16429. private_key_password.empty() ? nullptr : private_key_password.c_str();
  16430. if (!tls::set_client_cert_file(ctx_, client_cert_path.c_str(),
  16431. client_key_path.c_str(), password)) {
  16432. reset_ctx_on_error();
  16433. }
  16434. }
  16435. }
  16436. inline SSLClient::SSLClient(const std::string &host, int port,
  16437. const PemMemory &pem)
  16438. : ClientImpl(host, port) {
  16439. init_ctx();
  16440. if (!ctx_) { return; }
  16441. if (pem.cert_pem && pem.key_pem) {
  16442. std::string cert_buf, key_buf;
  16443. if (!tls::set_client_cert_pem(
  16444. ctx_, detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  16445. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  16446. pem.private_key_password)) {
  16447. reset_ctx_on_error();
  16448. }
  16449. }
  16450. }
  16451. inline void SSLClient::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16452. if (ca_cert_store && ctx_) {
  16453. // set_ca_store takes ownership of ca_cert_store
  16454. tls::set_ca_store(ctx_, ca_cert_store);
  16455. ca_cert_store_set_ = true;
  16456. } else if (ca_cert_store) {
  16457. tls::free_ca_store(ca_cert_store);
  16458. }
  16459. custom_ca_loaded_ = true;
  16460. }
  16461. inline void
  16462. SSLClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16463. if (!ctx_) { return; }
  16464. server_certificate_verifier_ = verifier;
  16465. // Under the lock that creating a session from ctx_ takes
  16466. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16467. tls::set_verify_callback(ctx_, std::move(verifier));
  16468. }
  16469. inline void SSLClient::set_session_verifier(
  16470. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16471. session_verifier_ = std::move(verifier);
  16472. }
  16473. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16474. inline void SSLClient::enable_windows_certificate_verification(bool enabled) {
  16475. enable_windows_cert_verification_ = enabled;
  16476. }
  16477. #endif
  16478. inline void SSLClient::load_ca_cert_store(const char *ca_cert,
  16479. std::size_t size) {
  16480. if (ctx_ && ca_cert && size > 0) {
  16481. // Every PEM loaded, for redirect transfer
  16482. if (!ca_cert_pem_.empty() && ca_cert_pem_.back() != '\n') {
  16483. ca_cert_pem_ += '\n';
  16484. }
  16485. ca_cert_pem_.append(ca_cert, size);
  16486. tls::load_ca_pem(ctx_, ca_cert, size);
  16487. }
  16488. custom_ca_loaded_ = true;
  16489. }
  16490. inline bool SSLClient::load_certs() {
  16491. auto ret = true;
  16492. // call_once rather than the plain flag WebSocketClient::create_stream() uses:
  16493. // one client is shared across concurrent requests here.
  16494. std::call_once(initialize_cert_, [&]() {
  16495. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16496. ret = detail::load_client_ca_config(ctx_, ca_cert_file_path_,
  16497. ca_cert_dir_path_, custom_ca_loaded_,
  16498. system_ca_mode_, last_backend_error_);
  16499. });
  16500. return ret;
  16501. }
  16502. inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) {
  16503. // Load CA certificates if server verification is enabled
  16504. if (server_certificate_verification_) {
  16505. if (!load_certs()) {
  16506. error = Error::SSLLoadingCerts;
  16507. return false;
  16508. }
  16509. }
  16510. detail::ClientTlsSessionOptions options;
  16511. options.server_hostname_verification = server_hostname_verification_;
  16512. options.session_verifier = session_verifier_;
  16513. options.ctx_mutex = &ctx_mutex_;
  16514. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16515. // Skip Schannel when a custom CA cert is specified, as the Windows
  16516. // certificate store would not know about user-provided CA certificates.
  16517. // Also skip when system CA trust is explicitly disabled.
  16518. options.windows_cert_verification =
  16519. enable_windows_cert_verification_ &&
  16520. system_ca_mode_ != SystemCAMode::Disabled && ca_cert_file_path_.empty() &&
  16521. ca_cert_dir_path_.empty() && !custom_ca_loaded_;
  16522. // Only a verifier set through set_server_certificate_verifier() is seen
  16523. // here, not one installed with tls::set_verify_callback() directly.
  16524. options.server_certificate_verifier_set =
  16525. static_cast<bool>(server_certificate_verifier_);
  16526. #endif
  16527. tls::session_t session = nullptr;
  16528. // Use scope_exit to ensure session is freed on error paths
  16529. bool success = false;
  16530. auto session_guard = detail::scope_exit([&] {
  16531. if (!success) { tls::free_session(session); }
  16532. });
  16533. detail::ClientTlsSessionError tls_error;
  16534. if (!detail::setup_client_tls_session(
  16535. host_, ctx_, session, socket.sock, server_certificate_verification_,
  16536. connection_timeout_sec_, connection_timeout_usec_, &tls_error,
  16537. options)) {
  16538. error = tls_error.error;
  16539. last_ssl_error_ = tls_error.ssl_error;
  16540. last_backend_error_ = tls_error.backend_error;
  16541. return false;
  16542. }
  16543. success = true;
  16544. socket.ssl = session;
  16545. return true;
  16546. }
  16547. inline void Client::set_digest_auth(const std::string &username,
  16548. const std::string &password) {
  16549. cli_->set_digest_auth(username, password);
  16550. }
  16551. inline void Client::set_proxy_digest_auth(const std::string &username,
  16552. const std::string &password) {
  16553. cli_->set_proxy_digest_auth(username, password);
  16554. }
  16555. inline void Client::enable_server_certificate_verification(bool enabled) {
  16556. cli_->enable_server_certificate_verification(enabled);
  16557. }
  16558. inline void Client::enable_server_hostname_verification(bool enabled) {
  16559. cli_->enable_server_hostname_verification(enabled);
  16560. }
  16561. inline void Client::enable_system_ca(bool enabled) {
  16562. cli_->enable_system_ca(enabled);
  16563. }
  16564. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16565. inline void Client::enable_windows_certificate_verification(bool enabled) {
  16566. if (is_ssl_) {
  16567. static_cast<SSLClient &>(*cli_).enable_windows_certificate_verification(
  16568. enabled);
  16569. }
  16570. }
  16571. #endif
  16572. inline void Client::set_ca_cert_path(const std::string &ca_cert_file_path,
  16573. const std::string &ca_cert_dir_path) {
  16574. cli_->set_ca_cert_path(ca_cert_file_path, ca_cert_dir_path);
  16575. }
  16576. inline void Client::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16577. if (is_ssl_) {
  16578. static_cast<SSLClient &>(*cli_).set_ca_cert_store(ca_cert_store);
  16579. } else if (ca_cert_store) {
  16580. tls::free_ca_store(ca_cert_store);
  16581. }
  16582. }
  16583. inline void Client::load_ca_cert_store(const char *ca_cert, std::size_t size) {
  16584. if (is_ssl_) {
  16585. // Use the PEM-based path so the CA data is retained for redirect transfer
  16586. static_cast<SSLClient &>(*cli_).load_ca_cert_store(ca_cert, size);
  16587. }
  16588. }
  16589. inline void
  16590. Client::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16591. if (is_ssl_) {
  16592. static_cast<SSLClient &>(*cli_).set_server_certificate_verifier(
  16593. std::move(verifier));
  16594. }
  16595. }
  16596. inline void Client::set_session_verifier(
  16597. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16598. if (is_ssl_) {
  16599. static_cast<SSLClient &>(*cli_).set_session_verifier(std::move(verifier));
  16600. }
  16601. }
  16602. inline tls::ctx_t Client::tls_context() const {
  16603. if (is_ssl_) { return static_cast<SSLClient &>(*cli_).tls_context(); }
  16604. return nullptr;
  16605. }
  16606. #endif // CPPHTTPLIB_SSL_ENABLED
  16607. /*
  16608. * Group 7: TLS abstraction layer - Common API
  16609. */
  16610. #ifdef CPPHTTPLIB_SSL_ENABLED
  16611. namespace tls {
  16612. // Helper for PeerCert construction
  16613. inline PeerCert get_peer_cert_from_session(const_session_t session) {
  16614. return PeerCert(get_peer_cert(session));
  16615. }
  16616. namespace impl {
  16617. // set_verify_callback() can replace a callback while handshakes on other
  16618. // threads run it, so they share it, and take their reference under this lock.
  16619. inline std::mutex &verify_callback_mutex() {
  16620. static std::mutex mutex;
  16621. return mutex;
  16622. }
  16623. // The TLS libraries are C, so an exception from a verify callback must not
  16624. // unwind through them. It rejects the certificate instead.
  16625. inline bool run_verify_callback(const VerifyCallback &callback,
  16626. const VerifyContext &ctx) {
  16627. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  16628. return callback(ctx);
  16629. #else
  16630. try {
  16631. return callback(ctx);
  16632. } catch (...) { return false; }
  16633. #endif
  16634. }
  16635. // Check if a string is an IPv4 address
  16636. inline bool is_ipv4_address(const std::string &str) {
  16637. int dots = 0;
  16638. for (char c : str) {
  16639. if (c == '.') {
  16640. dots++;
  16641. } else if (!detail::is_ascii_digit(c)) {
  16642. return false;
  16643. }
  16644. }
  16645. return dots == 3;
  16646. }
  16647. // Parse IPv4 address string to bytes
  16648. inline bool parse_ipv4(const std::string &str, unsigned char *out) {
  16649. const char *p = str.c_str();
  16650. for (int i = 0; i < 4; i++) {
  16651. if (i > 0) {
  16652. if (*p != '.') { return false; }
  16653. p++;
  16654. }
  16655. int val = 0;
  16656. int digits = 0;
  16657. while (detail::is_ascii_digit(*p)) {
  16658. val = val * 10 + (*p - '0');
  16659. if (val > 255) { return false; }
  16660. p++;
  16661. digits++;
  16662. }
  16663. if (digits == 0) { return false; }
  16664. // Reject leading zeros (e.g., "01.002.03.04") to prevent ambiguity
  16665. if (digits > 1 && *(p - digits) == '0') { return false; }
  16666. out[i] = static_cast<unsigned char>(val);
  16667. }
  16668. return *p == '\0';
  16669. }
  16670. // Parse an IP literal (IPv4 or IPv6) into raw network-order bytes.
  16671. // `out` must have room for at least 16 bytes. Returns the address length
  16672. // (4 for IPv4, 16 for IPv6) on success, or 0 if the string is not an IP
  16673. // literal. Used to match a host against iPAddress SANs the same way the
  16674. // OpenSSL backend does via X509_check_ip.
  16675. inline size_t parse_ip_address(const std::string &str, unsigned char *out) {
  16676. if (is_ipv4_address(str)) { return parse_ipv4(str, out) ? 4 : 0; }
  16677. struct in6_addr addr6 = {};
  16678. if (inet_pton(AF_INET6, str.c_str(), &addr6) == 1) {
  16679. memcpy(out, &addr6, 16);
  16680. return 16;
  16681. }
  16682. return 0;
  16683. }
  16684. #ifdef _WIN32
  16685. // Enumerate Windows system certificates and call callback with DER data
  16686. template <typename Callback>
  16687. inline bool enumerate_windows_system_certs(Callback cb) {
  16688. bool loaded = false;
  16689. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16690. for (auto store_name : store_names) {
  16691. HCERTSTORE hStore = CertOpenSystemStoreW(0, store_name);
  16692. if (hStore) {
  16693. PCCERT_CONTEXT pContext = nullptr;
  16694. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16695. nullptr) {
  16696. if (cb(pContext->pbCertEncoded, pContext->cbCertEncoded)) {
  16697. loaded = true;
  16698. }
  16699. }
  16700. CertCloseStore(hStore, 0);
  16701. }
  16702. }
  16703. return loaded;
  16704. }
  16705. #endif
  16706. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16707. // Enumerate macOS Keychain certificates and call callback with DER data
  16708. template <typename Callback>
  16709. inline bool enumerate_macos_keychain_certs(Callback cb) {
  16710. bool loaded = false;
  16711. const SecTrustSettingsDomain domains[] = {
  16712. kSecTrustSettingsDomainSystem,
  16713. kSecTrustSettingsDomainAdmin,
  16714. kSecTrustSettingsDomainUser,
  16715. };
  16716. for (auto domain : domains) {
  16717. CFArrayRef certs = nullptr;
  16718. OSStatus status = SecTrustSettingsCopyCertificates(domain, &certs);
  16719. if (status != errSecSuccess || !certs) {
  16720. if (certs) CFRelease(certs);
  16721. continue;
  16722. }
  16723. CFIndex count = CFArrayGetCount(certs);
  16724. for (CFIndex i = 0; i < count; i++) {
  16725. SecCertificateRef cert =
  16726. (SecCertificateRef)CFArrayGetValueAtIndex(certs, i);
  16727. CFDataRef data = SecCertificateCopyData(cert);
  16728. if (data) {
  16729. if (cb(CFDataGetBytePtr(data),
  16730. static_cast<size_t>(CFDataGetLength(data)))) {
  16731. loaded = true;
  16732. }
  16733. CFRelease(data);
  16734. }
  16735. }
  16736. CFRelease(certs);
  16737. }
  16738. return loaded;
  16739. }
  16740. #endif
  16741. #if !defined(_WIN32) && !(defined(__APPLE__) && \
  16742. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN))
  16743. // Common CA certificate file paths on Linux/Unix
  16744. inline const char **system_ca_paths() {
  16745. static const char *paths[] = {
  16746. "/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu
  16747. "/etc/pki/tls/certs/ca-bundle.crt", // RHEL/CentOS
  16748. "/etc/ssl/ca-bundle.pem", // OpenSUSE
  16749. "/etc/pki/tls/cacert.pem", // OpenELEC
  16750. "/etc/ssl/cert.pem", // Alpine, FreeBSD
  16751. nullptr};
  16752. return paths;
  16753. }
  16754. // Common CA certificate directory paths on Linux/Unix
  16755. inline const char **system_ca_dirs() {
  16756. static const char *dirs[] = {"/etc/ssl/certs", // Debian/Ubuntu
  16757. "/etc/pki/tls/certs", // RHEL/CentOS
  16758. "/usr/share/ca-certificates", // Other
  16759. nullptr};
  16760. return dirs;
  16761. }
  16762. #endif
  16763. } // namespace impl
  16764. inline bool set_client_ca_file(ctx_t ctx, const char *ca_file,
  16765. const char *ca_dir) {
  16766. if (!ctx) { return false; }
  16767. bool success = true;
  16768. if (ca_file && *ca_file) {
  16769. if (!load_ca_file(ctx, ca_file)) { success = false; }
  16770. }
  16771. if (ca_dir && *ca_dir) {
  16772. if (!load_ca_dir(ctx, ca_dir)) { success = false; }
  16773. }
  16774. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16775. // Set CA list for client certificate request (CertificateRequest message)
  16776. if (ca_file && *ca_file) {
  16777. auto list = SSL_load_client_CA_file(ca_file);
  16778. if (list) { SSL_CTX_set_client_CA_list(static_cast<SSL_CTX *>(ctx), list); }
  16779. }
  16780. #endif
  16781. return success;
  16782. }
  16783. inline bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16784. const char *password) {
  16785. return set_client_cert_pem(ctx, cert, key, password);
  16786. }
  16787. inline bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  16788. const char *key_path, const char *password) {
  16789. return set_client_cert_file(ctx, cert_path, key_path, password);
  16790. }
  16791. // PeerCert implementation
  16792. inline PeerCert::PeerCert() = default;
  16793. inline PeerCert::PeerCert(cert_t cert) : cert_(cert) {}
  16794. inline PeerCert::PeerCert(PeerCert &&other) noexcept : cert_(other.cert_) {
  16795. other.cert_ = nullptr;
  16796. }
  16797. inline PeerCert &PeerCert::operator=(PeerCert &&other) noexcept {
  16798. if (this != &other) {
  16799. if (cert_) { free_cert(cert_); }
  16800. cert_ = other.cert_;
  16801. other.cert_ = nullptr;
  16802. }
  16803. return *this;
  16804. }
  16805. inline PeerCert::~PeerCert() {
  16806. if (cert_) { free_cert(cert_); }
  16807. }
  16808. inline PeerCert::operator bool() const { return cert_ != nullptr; }
  16809. inline std::string PeerCert::subject_cn() const {
  16810. return cert_ ? get_cert_subject_cn(cert_) : std::string();
  16811. }
  16812. inline std::string PeerCert::issuer_name() const {
  16813. return cert_ ? get_cert_issuer_name(cert_) : std::string();
  16814. }
  16815. inline bool PeerCert::check_hostname(const char *hostname) const {
  16816. return cert_ ? verify_hostname(cert_, hostname) : false;
  16817. }
  16818. inline std::vector<SanEntry> PeerCert::sans() const {
  16819. std::vector<SanEntry> result;
  16820. if (cert_) { get_cert_sans(cert_, result); }
  16821. return result;
  16822. }
  16823. inline bool PeerCert::validity(time_t &not_before, time_t &not_after) const {
  16824. return cert_ ? get_cert_validity(cert_, not_before, not_after) : false;
  16825. }
  16826. inline std::string PeerCert::serial() const {
  16827. return cert_ ? get_cert_serial(cert_) : std::string();
  16828. }
  16829. // VerifyContext method implementations
  16830. inline std::string VerifyContext::subject_cn() const {
  16831. return cert ? get_cert_subject_cn(cert) : std::string();
  16832. }
  16833. inline std::string VerifyContext::issuer_name() const {
  16834. return cert ? get_cert_issuer_name(cert) : std::string();
  16835. }
  16836. inline bool VerifyContext::check_hostname(const char *hostname) const {
  16837. return cert ? verify_hostname(cert, hostname) : false;
  16838. }
  16839. inline std::vector<SanEntry> VerifyContext::sans() const {
  16840. std::vector<SanEntry> result;
  16841. if (cert) { get_cert_sans(cert, result); }
  16842. return result;
  16843. }
  16844. inline bool VerifyContext::validity(time_t &not_before,
  16845. time_t &not_after) const {
  16846. return cert ? get_cert_validity(cert, not_before, not_after) : false;
  16847. }
  16848. inline std::string VerifyContext::serial() const {
  16849. return cert ? get_cert_serial(cert) : std::string();
  16850. }
  16851. // TlsError static method implementation
  16852. inline std::string TlsError::verify_error_to_string(long error_code) {
  16853. return verify_error_string(error_code);
  16854. }
  16855. } // namespace tls
  16856. // Request::peer_cert() implementation
  16857. inline tls::PeerCert Request::peer_cert() const {
  16858. return tls::get_peer_cert_from_session(ssl);
  16859. }
  16860. // Request::sni() implementation
  16861. inline std::string Request::sni() const {
  16862. if (!ssl) { return std::string(); }
  16863. const char *s = tls::get_sni(ssl);
  16864. return s ? std::string(s) : std::string();
  16865. }
  16866. #endif // CPPHTTPLIB_SSL_ENABLED
  16867. /*
  16868. * Group 8: TLS abstraction layer - OpenSSL backend
  16869. */
  16870. /*
  16871. * OpenSSL Backend Implementation
  16872. */
  16873. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16874. namespace tls {
  16875. namespace impl {
  16876. // Helper to map OpenSSL SSL_get_error to ErrorCode
  16877. inline ErrorCode map_ssl_error(int ssl_error, int &out_errno) {
  16878. switch (ssl_error) {
  16879. case SSL_ERROR_NONE: return ErrorCode::Success;
  16880. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  16881. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  16882. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  16883. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  16884. case SSL_ERROR_SSL:
  16885. default: return ErrorCode::Fatal;
  16886. }
  16887. }
  16888. // Fills in a failed SSL_connect(). One that the server certificate's
  16889. // verification stopped reports the verify result, as the other backends and
  16890. // a check after the handshake do.
  16891. inline void fill_connect_error(SSL *ssl, int ret, TlsError &err) {
  16892. auto ssl_err = SSL_get_error(ssl, ret);
  16893. auto error = ERR_get_error();
  16894. err.code = map_ssl_error(ssl_err, err.sys_errno);
  16895. err.backend_code = error;
  16896. if (ssl_err != SSL_ERROR_SSL || ERR_GET_LIB(error) != ERR_LIB_SSL ||
  16897. ERR_GET_REASON(error) != SSL_R_CERTIFICATE_VERIFY_FAILED) {
  16898. return;
  16899. }
  16900. // A certificate only a verify callback turned down carries no verdict of
  16901. // its own, and fails as any other handshake does
  16902. auto verify_result = SSL_get_verify_result(ssl);
  16903. if (verify_result == X509_V_OK || verify_result == X509_V_ERR_UNSPECIFIED) {
  16904. return;
  16905. }
  16906. err.code = verify_result == X509_V_ERR_HOSTNAME_MISMATCH
  16907. ? ErrorCode::HostnameMismatch
  16908. : ErrorCode::CertVerifyFailed;
  16909. err.backend_code = static_cast<uint64_t>(verify_result);
  16910. }
  16911. // Helper: Create client CA list from PEM string
  16912. // Returns a new STACK_OF(X509_NAME)* or nullptr on failure
  16913. // Caller takes ownership of returned list
  16914. inline STACK_OF(X509_NAME) *
  16915. create_client_ca_list_from_pem(const char *ca_pem) {
  16916. if (!ca_pem) { return nullptr; }
  16917. auto ca_list = sk_X509_NAME_new_null();
  16918. if (!ca_list) { return nullptr; }
  16919. BIO *bio = BIO_new_mem_buf(ca_pem, -1);
  16920. if (!bio) {
  16921. sk_X509_NAME_pop_free(ca_list, X509_NAME_free);
  16922. return nullptr;
  16923. }
  16924. X509 *cert = nullptr;
  16925. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16926. nullptr) {
  16927. const X509_NAME *name = X509_get_subject_name(cert);
  16928. if (name) {
  16929. sk_X509_NAME_push(ca_list, X509_NAME_dup(const_cast<X509_NAME *>(name)));
  16930. }
  16931. X509_free(cert);
  16932. }
  16933. BIO_free(bio);
  16934. return ca_list;
  16935. }
  16936. inline void free_verify_callback(void * /*parent*/, void *ptr,
  16937. CRYPTO_EX_DATA * /*ad*/, int /*idx*/,
  16938. long /*argl*/, void * /*argp*/) {
  16939. delete static_cast<std::shared_ptr<VerifyCallback> *>(ptr);
  16940. }
  16941. // The SSL_CTX owns its verify callback, so each client or server sees only
  16942. // its own, on whichever thread runs the handshake.
  16943. inline int verify_callback_index() {
  16944. static const auto index = SSL_CTX_get_ex_new_index(
  16945. 0, nullptr, nullptr, nullptr, free_verify_callback);
  16946. return index;
  16947. }
  16948. // OpenSSL verify callback wrapper
  16949. inline int openssl_verify_callback(int preverify_ok, X509_STORE_CTX *ctx) {
  16950. // Get SSL object from X509_STORE_CTX
  16951. auto ssl = static_cast<SSL *>(
  16952. X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
  16953. if (!ssl) { return preverify_ok; }
  16954. std::shared_ptr<VerifyCallback> callback;
  16955. {
  16956. std::lock_guard<std::mutex> guard(verify_callback_mutex());
  16957. auto stored = static_cast<std::shared_ptr<VerifyCallback> *>(
  16958. SSL_CTX_get_ex_data(SSL_get_SSL_CTX(ssl), verify_callback_index()));
  16959. if (stored) { callback = *stored; }
  16960. }
  16961. if (!callback) { return preverify_ok; }
  16962. // Get current certificate and depth
  16963. auto cert = X509_STORE_CTX_get_current_cert(ctx);
  16964. int depth = X509_STORE_CTX_get_error_depth(ctx);
  16965. int error = X509_STORE_CTX_get_error(ctx);
  16966. // Build context
  16967. VerifyContext verify_ctx;
  16968. verify_ctx.session = static_cast<session_t>(ssl);
  16969. verify_ctx.cert = static_cast<cert_t>(cert);
  16970. verify_ctx.depth = depth;
  16971. verify_ctx.preverify_ok = (preverify_ok != 0);
  16972. verify_ctx.error_code = error;
  16973. verify_ctx.error_string =
  16974. (error != X509_V_OK) ? X509_verify_cert_error_string(error) : nullptr;
  16975. auto accepted = run_verify_callback(*callback, verify_ctx);
  16976. // A client verifying the server during the handshake, which is what
  16977. // set_verify_client(ctx, true) asks for there, keeps the built-in verdict
  16978. if (!SSL_is_server(ssl) &&
  16979. (SSL_get_verify_mode(ssl) & SSL_VERIFY_FAIL_IF_NO_PEER_CERT)) {
  16980. accepted = accepted && preverify_ok;
  16981. }
  16982. return accepted ? 1 : 0;
  16983. }
  16984. // Sets the verify mode from whether the peer's certificate is required and
  16985. // whether a verify callback is set.
  16986. inline void apply_verify_mode(SSL_CTX *ssl_ctx, bool require) {
  16987. auto has_callback =
  16988. SSL_CTX_get_ex_data(ssl_ctx, verify_callback_index()) != nullptr;
  16989. auto mode = require ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  16990. : (has_callback ? SSL_VERIFY_PEER : SSL_VERIFY_NONE);
  16991. SSL_CTX_set_verify(ssl_ctx, mode,
  16992. has_callback ? openssl_verify_callback : nullptr);
  16993. }
  16994. // X509_STORE_get0_objects is deprecated since OpenSSL 4.0 because it is not
  16995. // thread-safe; X509_STORE_get1_objects (OpenSSL 3.3+) returns a snapshot
  16996. // that must be released with release_store_objects
  16997. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER) && \
  16998. OPENSSL_VERSION_NUMBER >= 0x30300000L
  16999. #define CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  17000. #endif
  17001. inline STACK_OF(X509_OBJECT) * get_store_objects(X509_STORE *store) {
  17002. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  17003. return X509_STORE_get1_objects(store);
  17004. #else
  17005. return X509_STORE_get0_objects(store);
  17006. #endif
  17007. }
  17008. inline void release_store_objects(STACK_OF(X509_OBJECT) * objs) {
  17009. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  17010. sk_X509_OBJECT_pop_free(objs, X509_OBJECT_free);
  17011. #else
  17012. (void)objs; // get0 variant returns an internal pointer; nothing to free
  17013. #endif
  17014. }
  17015. } // namespace impl
  17016. inline ctx_t create_client_context() {
  17017. SSL_CTX *ctx = SSL_CTX_new(TLS_client_method());
  17018. if (ctx) {
  17019. // Disable auto-retry to properly handle non-blocking I/O
  17020. SSL_CTX_clear_mode(ctx, SSL_MODE_AUTO_RETRY);
  17021. // Set minimum TLS version
  17022. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  17023. }
  17024. return static_cast<ctx_t>(ctx);
  17025. }
  17026. inline void free_context(ctx_t ctx) {
  17027. if (ctx) { SSL_CTX_free(static_cast<SSL_CTX *>(ctx)); }
  17028. }
  17029. inline bool set_min_version(ctx_t ctx, Version version) {
  17030. if (!ctx) return false;
  17031. return SSL_CTX_set_min_proto_version(static_cast<SSL_CTX *>(ctx),
  17032. static_cast<uint16_t>(version)) == 1;
  17033. }
  17034. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  17035. if (!ctx || !pem || len == 0) return false;
  17036. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17037. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17038. if (!store) return false;
  17039. auto bio = BIO_new_mem_buf(pem, static_cast<int>(len));
  17040. if (!bio) return false;
  17041. bool ok = true;
  17042. X509 *cert = nullptr;
  17043. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  17044. nullptr) {
  17045. if (X509_STORE_add_cert(store, cert) != 1) {
  17046. // Ignore duplicate errors
  17047. auto err = ERR_peek_last_error();
  17048. if (ERR_GET_REASON(err) != X509_R_CERT_ALREADY_IN_HASH_TABLE) {
  17049. ok = false;
  17050. }
  17051. }
  17052. X509_free(cert);
  17053. if (!ok) break;
  17054. }
  17055. BIO_free(bio);
  17056. // Clear any "no more certificates" errors
  17057. ERR_clear_error();
  17058. return ok;
  17059. }
  17060. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  17061. if (!ctx || !file_path) return false;
  17062. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), file_path,
  17063. nullptr) == 1;
  17064. }
  17065. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  17066. if (!ctx || !dir_path) return false;
  17067. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), nullptr,
  17068. dir_path) == 1;
  17069. }
  17070. inline bool load_system_certs(ctx_t ctx) {
  17071. if (!ctx) return false;
  17072. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17073. #ifdef _WIN32
  17074. // Windows: Load from system certificate store (ROOT and CA)
  17075. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17076. if (!store) return false;
  17077. bool loaded_any = false;
  17078. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  17079. for (auto store_name : store_names) {
  17080. auto hStore = CertOpenSystemStoreW(NULL, store_name);
  17081. if (!hStore) continue;
  17082. PCCERT_CONTEXT pContext = nullptr;
  17083. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  17084. nullptr) {
  17085. const unsigned char *data = pContext->pbCertEncoded;
  17086. auto x509 = d2i_X509(nullptr, &data, pContext->cbCertEncoded);
  17087. if (x509) {
  17088. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  17089. X509_free(x509);
  17090. }
  17091. }
  17092. CertCloseStore(hStore, 0);
  17093. }
  17094. return loaded_any;
  17095. #elif defined(__APPLE__)
  17096. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  17097. // macOS: Load from Keychain
  17098. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17099. if (!store) return false;
  17100. bool loaded_any = false;
  17101. const SecTrustSettingsDomain domains[] = {
  17102. kSecTrustSettingsDomainSystem,
  17103. kSecTrustSettingsDomainAdmin,
  17104. kSecTrustSettingsDomainUser,
  17105. };
  17106. for (auto domain : domains) {
  17107. CFArrayRef certs = nullptr;
  17108. if (SecTrustSettingsCopyCertificates(domain, &certs) != errSecSuccess ||
  17109. !certs) {
  17110. if (certs) CFRelease(certs);
  17111. continue;
  17112. }
  17113. auto count = CFArrayGetCount(certs);
  17114. for (CFIndex i = 0; i < count; i++) {
  17115. auto cert = reinterpret_cast<SecCertificateRef>(
  17116. const_cast<void *>(CFArrayGetValueAtIndex(certs, i)));
  17117. CFDataRef der = SecCertificateCopyData(cert);
  17118. if (der) {
  17119. const unsigned char *data = CFDataGetBytePtr(der);
  17120. auto x509 = d2i_X509(nullptr, &data, CFDataGetLength(der));
  17121. if (x509) {
  17122. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  17123. X509_free(x509);
  17124. }
  17125. CFRelease(der);
  17126. }
  17127. }
  17128. CFRelease(certs);
  17129. }
  17130. return loaded_any || SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17131. #else
  17132. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17133. #endif
  17134. #else
  17135. // Other Unix: use default verify paths
  17136. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17137. #endif
  17138. }
  17139. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17140. const char *password) {
  17141. if (!ctx || !cert || !key) return false;
  17142. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17143. // Load certificate
  17144. auto cert_bio = BIO_new_mem_buf(cert, -1);
  17145. if (!cert_bio) return false;
  17146. auto x509 = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  17147. BIO_free(cert_bio);
  17148. if (!x509) return false;
  17149. auto cert_ok = SSL_CTX_use_certificate(ssl_ctx, x509) == 1;
  17150. X509_free(x509);
  17151. if (!cert_ok) return false;
  17152. // Load private key
  17153. auto key_bio = BIO_new_mem_buf(key, -1);
  17154. if (!key_bio) return false;
  17155. auto pkey = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  17156. password ? const_cast<char *>(password)
  17157. : nullptr);
  17158. BIO_free(key_bio);
  17159. if (!pkey) return false;
  17160. auto key_ok = SSL_CTX_use_PrivateKey(ssl_ctx, pkey) == 1;
  17161. EVP_PKEY_free(pkey);
  17162. return key_ok && SSL_CTX_check_private_key(ssl_ctx) == 1;
  17163. }
  17164. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  17165. const char *key_path, const char *password) {
  17166. if (!ctx || !cert_path || !key_path) return false;
  17167. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17168. if (password && password[0] != '\0') {
  17169. SSL_CTX_set_default_passwd_cb_userdata(
  17170. ssl_ctx, reinterpret_cast<void *>(const_cast<char *>(password)));
  17171. }
  17172. return SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_path) == 1 &&
  17173. SSL_CTX_use_PrivateKey_file(ssl_ctx, key_path, SSL_FILETYPE_PEM) == 1;
  17174. }
  17175. inline ctx_t create_server_context() {
  17176. SSL_CTX *ctx = SSL_CTX_new(TLS_server_method());
  17177. if (ctx) {
  17178. // No renegotiation, as on the other backends: it would run a handshake
  17179. // that SSLServer::update_certs_pem() does not wait for
  17180. SSL_CTX_set_options(ctx, SSL_OP_NO_COMPRESSION |
  17181. SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION |
  17182. SSL_OP_NO_RENEGOTIATION);
  17183. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  17184. // Without one, a client resuming its session is sent a fatal alert once
  17185. // client certificates are verified.
  17186. static const unsigned char sid_ctx[] = "cpp-httplib";
  17187. SSL_CTX_set_session_id_context(ctx, sid_ctx, sizeof(sid_ctx) - 1);
  17188. }
  17189. return static_cast<ctx_t>(ctx);
  17190. }
  17191. inline void set_verify_client(ctx_t ctx, bool require) {
  17192. if (!ctx) return;
  17193. impl::apply_verify_mode(static_cast<SSL_CTX *>(ctx), require);
  17194. }
  17195. inline session_t create_session(ctx_t ctx, socket_t sock) {
  17196. if (!ctx || sock == INVALID_SOCKET) return nullptr;
  17197. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17198. SSL *ssl = SSL_new(ssl_ctx);
  17199. if (!ssl) return nullptr;
  17200. // Disable auto-retry for proper non-blocking I/O handling
  17201. SSL_clear_mode(ssl, SSL_MODE_AUTO_RETRY);
  17202. auto bio = BIO_new_socket(static_cast<int>(sock), BIO_NOCLOSE);
  17203. if (!bio) {
  17204. SSL_free(ssl);
  17205. return nullptr;
  17206. }
  17207. SSL_set_bio(ssl, bio, bio);
  17208. return static_cast<session_t>(ssl);
  17209. }
  17210. inline void free_session(session_t session) {
  17211. if (session) { SSL_free(static_cast<SSL *>(session)); }
  17212. }
  17213. inline bool set_sni(session_t session, const char *hostname,
  17214. bool verify_hostname) {
  17215. if (!session || !hostname) return false;
  17216. auto ssl = static_cast<SSL *>(session);
  17217. // The handshake's chain verification then checks the name as well
  17218. if (verify_hostname &&
  17219. X509_VERIFY_PARAM_set1_host(SSL_get0_param(ssl), hostname,
  17220. strlen(hostname)) != 1) {
  17221. return false;
  17222. }
  17223. #if defined(OPENSSL_IS_BORINGSSL)
  17224. return SSL_set_tlsext_host_name(ssl, hostname) == 1;
  17225. #else
  17226. // Direct call instead of macro to suppress -Wold-style-cast warning
  17227. return SSL_ctrl(ssl, SSL_CTRL_SET_TLSEXT_HOSTNAME, TLSEXT_NAMETYPE_host_name,
  17228. static_cast<void *>(const_cast<char *>(hostname))) == 1;
  17229. #endif
  17230. }
  17231. inline TlsError connect(session_t session) {
  17232. if (!session) { return TlsError(); }
  17233. auto ssl = static_cast<SSL *>(session);
  17234. auto ret = SSL_connect(ssl);
  17235. TlsError err;
  17236. if (ret == 1) {
  17237. err.code = ErrorCode::Success;
  17238. } else {
  17239. impl::fill_connect_error(ssl, ret, err);
  17240. }
  17241. return err;
  17242. }
  17243. inline TlsError accept(session_t session) {
  17244. if (!session) { return TlsError(); }
  17245. auto ssl = static_cast<SSL *>(session);
  17246. auto ret = SSL_accept(ssl);
  17247. TlsError err;
  17248. if (ret == 1) {
  17249. err.code = ErrorCode::Success;
  17250. } else {
  17251. auto ssl_err = SSL_get_error(ssl, ret);
  17252. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17253. err.backend_code = ERR_get_error();
  17254. }
  17255. return err;
  17256. }
  17257. inline bool connect_nonblocking(session_t session, socket_t sock,
  17258. time_t timeout_sec, time_t timeout_usec,
  17259. TlsError *err) {
  17260. if (!session) {
  17261. if (err) { err->code = ErrorCode::Fatal; }
  17262. return false;
  17263. }
  17264. auto ssl = static_cast<SSL *>(session);
  17265. auto bio = SSL_get_rbio(ssl);
  17266. // Set non-blocking mode for handshake
  17267. detail::set_nonblocking(sock, true);
  17268. if (bio) { BIO_set_nbio(bio, 1); }
  17269. auto cleanup = detail::scope_exit([&]() {
  17270. // Restore blocking mode after handshake
  17271. if (bio) { BIO_set_nbio(bio, 0); }
  17272. detail::set_nonblocking(sock, false);
  17273. });
  17274. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  17275. auto res = 0;
  17276. while ((res = SSL_connect(ssl)) != 1) {
  17277. auto ssl_err = SSL_get_error(ssl, res);
  17278. switch (ssl_err) {
  17279. case SSL_ERROR_WANT_READ:
  17280. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  17281. break;
  17282. case SSL_ERROR_WANT_WRITE:
  17283. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  17284. break;
  17285. default: break;
  17286. }
  17287. if (err) { impl::fill_connect_error(ssl, res, *err); }
  17288. return false;
  17289. }
  17290. if (err) { err->code = ErrorCode::Success; }
  17291. return true;
  17292. }
  17293. inline bool accept_nonblocking(session_t session, socket_t sock,
  17294. time_t timeout_sec, time_t timeout_usec,
  17295. TlsError *err) {
  17296. if (!session) {
  17297. if (err) { err->code = ErrorCode::Fatal; }
  17298. return false;
  17299. }
  17300. auto ssl = static_cast<SSL *>(session);
  17301. auto bio = SSL_get_rbio(ssl);
  17302. // Set non-blocking mode for handshake
  17303. detail::set_nonblocking(sock, true);
  17304. if (bio) { BIO_set_nbio(bio, 1); }
  17305. auto cleanup = detail::scope_exit([&]() {
  17306. // Restore blocking mode after handshake
  17307. if (bio) { BIO_set_nbio(bio, 0); }
  17308. detail::set_nonblocking(sock, false);
  17309. });
  17310. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  17311. auto res = 0;
  17312. while ((res = SSL_accept(ssl)) != 1) {
  17313. auto ssl_err = SSL_get_error(ssl, res);
  17314. switch (ssl_err) {
  17315. case SSL_ERROR_WANT_READ:
  17316. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  17317. break;
  17318. case SSL_ERROR_WANT_WRITE:
  17319. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  17320. break;
  17321. default: break;
  17322. }
  17323. if (err) {
  17324. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  17325. err->backend_code = ERR_get_error();
  17326. }
  17327. return false;
  17328. }
  17329. if (err) { err->code = ErrorCode::Success; }
  17330. return true;
  17331. }
  17332. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  17333. if (!session || !buf) {
  17334. err.code = ErrorCode::Fatal;
  17335. return -1;
  17336. }
  17337. auto ssl = static_cast<SSL *>(session);
  17338. constexpr auto max_len =
  17339. static_cast<size_t>((std::numeric_limits<int>::max)());
  17340. if (len > max_len) { len = max_len; }
  17341. auto ret = SSL_read(ssl, buf, static_cast<int>(len));
  17342. if (ret > 0) {
  17343. err.code = ErrorCode::Success;
  17344. return ret;
  17345. }
  17346. auto ssl_err = SSL_get_error(ssl, ret);
  17347. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17348. if (err.code == ErrorCode::PeerClosed) {
  17349. return 0;
  17350. } // Gracefully handle the peer closed state.
  17351. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  17352. return -1;
  17353. }
  17354. inline ssize_t write(session_t session, const void *buf, size_t len,
  17355. TlsError &err) {
  17356. if (!session || !buf) {
  17357. err.code = ErrorCode::Fatal;
  17358. return -1;
  17359. }
  17360. auto ssl = static_cast<SSL *>(session);
  17361. auto ret = SSL_write(ssl, buf, static_cast<int>(len));
  17362. if (ret > 0) {
  17363. err.code = ErrorCode::Success;
  17364. return ret;
  17365. }
  17366. auto ssl_err = SSL_get_error(ssl, ret);
  17367. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17368. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  17369. return -1;
  17370. }
  17371. inline int pending(const_session_t session) {
  17372. if (!session) return 0;
  17373. return SSL_pending(static_cast<SSL *>(const_cast<void *>(session)));
  17374. }
  17375. inline void shutdown(session_t session, bool graceful) {
  17376. if (!session) return;
  17377. auto ssl = static_cast<SSL *>(session);
  17378. if (graceful) {
  17379. // Send close_notify without waiting for the peer's. The connection is
  17380. // closed right after this, so a unidirectional shutdown is enough, and an
  17381. // idle peer that never answers would otherwise hold this thread until the
  17382. // read timeout. The other backends do not wait either.
  17383. SSL_shutdown(ssl);
  17384. }
  17385. }
  17386. inline bool is_peer_closed(session_t session, socket_t sock) {
  17387. if (!session) return true;
  17388. // Temporarily set socket to non-blocking to avoid blocking on SSL_peek
  17389. detail::set_nonblocking(sock, true);
  17390. auto se = detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17391. auto ssl = static_cast<SSL *>(session);
  17392. char buf;
  17393. auto ret = SSL_peek(ssl, &buf, 1);
  17394. if (ret > 0) return false;
  17395. auto err = SSL_get_error(ssl, ret);
  17396. return err == SSL_ERROR_ZERO_RETURN;
  17397. }
  17398. inline cert_t get_peer_cert(const_session_t session) {
  17399. if (!session) return nullptr;
  17400. return static_cast<cert_t>(SSL_get1_peer_certificate(
  17401. static_cast<SSL *>(const_cast<void *>(session))));
  17402. }
  17403. inline size_t get_peer_certs(const_session_t session,
  17404. std::vector<cert_t> &certs) {
  17405. certs.clear();
  17406. if (!session) { return 0; }
  17407. auto ssl = static_cast<const SSL *>(session);
  17408. // On the server side, the chain leaves out the peer's own certificate
  17409. if (SSL_is_server(ssl)) {
  17410. if (auto leaf = get_peer_cert(session)) { certs.push_back(leaf); }
  17411. }
  17412. if (auto sk = SSL_get_peer_cert_chain(ssl)) {
  17413. auto count = sk_X509_num(sk);
  17414. for (decltype(count) i = 0; i < count; i++) {
  17415. auto x509 = sk_X509_value(sk, i);
  17416. X509_up_ref(x509);
  17417. certs.push_back(static_cast<cert_t>(x509));
  17418. }
  17419. }
  17420. return certs.size();
  17421. }
  17422. inline void free_cert(cert_t cert) {
  17423. if (cert) { X509_free(static_cast<X509 *>(cert)); }
  17424. }
  17425. inline bool verify_hostname(cert_t cert, const char *hostname) {
  17426. if (!cert || !hostname) return false;
  17427. auto x509 = static_cast<X509 *>(cert);
  17428. // Use X509_check_ip_asc for IP addresses, X509_check_host for DNS names
  17429. if (detail::is_ip_address(hostname)) {
  17430. return X509_check_ip_asc(x509, hostname, 0) == 1;
  17431. }
  17432. return X509_check_host(x509, hostname, strlen(hostname), 0, nullptr) == 1;
  17433. }
  17434. inline uint64_t hostname_mismatch_code() {
  17435. return static_cast<uint64_t>(X509_V_ERR_HOSTNAME_MISMATCH);
  17436. }
  17437. inline long get_verify_result(const_session_t session) {
  17438. if (!session) return X509_V_ERR_UNSPECIFIED;
  17439. return SSL_get_verify_result(static_cast<SSL *>(const_cast<void *>(session)));
  17440. }
  17441. inline std::string get_cert_subject_cn(cert_t cert) {
  17442. if (!cert) return "";
  17443. auto x509 = static_cast<X509 *>(cert);
  17444. auto subject_name = X509_get_subject_name(x509);
  17445. if (!subject_name) return "";
  17446. // X509_NAME_get_text_by_NID is deprecated since OpenSSL 4.0
  17447. auto idx = X509_NAME_get_index_by_NID(subject_name, NID_commonName, -1);
  17448. if (idx < 0) return "";
  17449. auto entry = X509_NAME_get_entry(subject_name, idx);
  17450. if (!entry) return "";
  17451. auto data = X509_NAME_ENTRY_get_data(entry);
  17452. if (!data) return "";
  17453. return std::string(
  17454. reinterpret_cast<const char *>(ASN1_STRING_get0_data(data)),
  17455. static_cast<size_t>(ASN1_STRING_length(data)));
  17456. }
  17457. inline std::string get_cert_issuer_name(cert_t cert) {
  17458. if (!cert) return "";
  17459. auto x509 = static_cast<X509 *>(cert);
  17460. auto issuer_name = X509_get_issuer_name(x509);
  17461. if (!issuer_name) return "";
  17462. char buf[256];
  17463. X509_NAME_oneline(issuer_name, buf, sizeof(buf));
  17464. return std::string(buf);
  17465. }
  17466. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  17467. sans.clear();
  17468. if (!cert) return false;
  17469. auto x509 = static_cast<X509 *>(cert);
  17470. auto names = static_cast<GENERAL_NAMES *>(
  17471. X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  17472. if (!names) return true; // No SANs is valid
  17473. auto count = sk_GENERAL_NAME_num(names);
  17474. for (decltype(count) i = 0; i < count; i++) {
  17475. auto gen = sk_GENERAL_NAME_value(names, i);
  17476. if (!gen) continue;
  17477. SanEntry entry;
  17478. switch (gen->type) {
  17479. case GEN_DNS:
  17480. entry.type = SanType::DNS;
  17481. if (gen->d.dNSName) {
  17482. entry.value = std::string(
  17483. reinterpret_cast<const char *>(
  17484. ASN1_STRING_get0_data(gen->d.dNSName)),
  17485. static_cast<size_t>(ASN1_STRING_length(gen->d.dNSName)));
  17486. }
  17487. break;
  17488. case GEN_IPADD:
  17489. entry.type = SanType::IP;
  17490. if (gen->d.iPAddress) {
  17491. auto data = ASN1_STRING_get0_data(gen->d.iPAddress);
  17492. auto len = ASN1_STRING_length(gen->d.iPAddress);
  17493. if (len == 4) {
  17494. // IPv4
  17495. char buf[INET_ADDRSTRLEN];
  17496. inet_ntop(AF_INET, data, buf, sizeof(buf));
  17497. entry.value = buf;
  17498. } else if (len == 16) {
  17499. // IPv6
  17500. char buf[INET6_ADDRSTRLEN];
  17501. inet_ntop(AF_INET6, data, buf, sizeof(buf));
  17502. entry.value = buf;
  17503. }
  17504. }
  17505. break;
  17506. case GEN_EMAIL:
  17507. entry.type = SanType::EMAIL;
  17508. if (gen->d.rfc822Name) {
  17509. entry.value = std::string(
  17510. reinterpret_cast<const char *>(
  17511. ASN1_STRING_get0_data(gen->d.rfc822Name)),
  17512. static_cast<size_t>(ASN1_STRING_length(gen->d.rfc822Name)));
  17513. }
  17514. break;
  17515. case GEN_URI:
  17516. entry.type = SanType::URI;
  17517. if (gen->d.uniformResourceIdentifier) {
  17518. entry.value = std::string(
  17519. reinterpret_cast<const char *>(
  17520. ASN1_STRING_get0_data(gen->d.uniformResourceIdentifier)),
  17521. static_cast<size_t>(
  17522. ASN1_STRING_length(gen->d.uniformResourceIdentifier)));
  17523. }
  17524. break;
  17525. default: entry.type = SanType::OTHER; break;
  17526. }
  17527. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  17528. }
  17529. GENERAL_NAMES_free(names);
  17530. return true;
  17531. }
  17532. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  17533. time_t &not_after) {
  17534. if (!cert) return false;
  17535. auto x509 = static_cast<X509 *>(cert);
  17536. auto nb = X509_get0_notBefore(x509);
  17537. auto na = X509_get0_notAfter(x509);
  17538. if (!nb || !na) return false;
  17539. ASN1_TIME *epoch = ASN1_TIME_new();
  17540. if (!epoch) return false;
  17541. auto se = detail::scope_exit([&] { ASN1_TIME_free(epoch); });
  17542. if (!ASN1_TIME_set(epoch, 0)) return false;
  17543. int pday, psec;
  17544. if (!ASN1_TIME_diff(&pday, &psec, epoch, nb)) return false;
  17545. not_before = 86400 * (time_t)pday + psec;
  17546. if (!ASN1_TIME_diff(&pday, &psec, epoch, na)) return false;
  17547. not_after = 86400 * (time_t)pday + psec;
  17548. return true;
  17549. }
  17550. inline std::string get_cert_serial(cert_t cert) {
  17551. if (!cert) return "";
  17552. auto x509 = static_cast<X509 *>(cert);
  17553. auto serial = X509_get_serialNumber(x509);
  17554. if (!serial) return "";
  17555. auto bn = ASN1_INTEGER_to_BN(serial, nullptr);
  17556. if (!bn) return "";
  17557. auto hex = BN_bn2hex(bn);
  17558. BN_free(bn);
  17559. if (!hex) return "";
  17560. std::string result(hex);
  17561. OPENSSL_free(hex);
  17562. return result;
  17563. }
  17564. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  17565. if (!cert) return false;
  17566. auto x509 = static_cast<X509 *>(cert);
  17567. auto len = i2d_X509(x509, nullptr);
  17568. if (len < 0) return false;
  17569. der.resize(static_cast<size_t>(len));
  17570. auto p = der.data();
  17571. i2d_X509(x509, &p);
  17572. return true;
  17573. }
  17574. inline const char *get_sni(const_session_t session) {
  17575. if (!session) return nullptr;
  17576. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17577. return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
  17578. }
  17579. inline uint64_t peek_error() { return ERR_peek_last_error(); }
  17580. inline uint64_t get_error() { return ERR_get_error(); }
  17581. inline std::string error_string(uint64_t code) {
  17582. char buf[256];
  17583. ERR_error_string_n(static_cast<decltype(ERR_get_error())>(code), buf,
  17584. sizeof(buf));
  17585. return std::string(buf);
  17586. }
  17587. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  17588. auto mem = BIO_new_mem_buf(pem, static_cast<int>(len));
  17589. if (!mem) { return nullptr; }
  17590. auto mem_guard = detail::scope_exit([&] { BIO_free_all(mem); });
  17591. auto inf = PEM_X509_INFO_read_bio(mem, nullptr, nullptr, nullptr);
  17592. if (!inf) { return nullptr; }
  17593. auto store = X509_STORE_new();
  17594. if (store) {
  17595. auto count = sk_X509_INFO_num(inf);
  17596. for (decltype(count) i = 0; i < count; i++) {
  17597. auto itmp = sk_X509_INFO_value(inf, i);
  17598. if (!itmp) { continue; }
  17599. if (itmp->x509) { X509_STORE_add_cert(store, itmp->x509); }
  17600. if (itmp->crl) { X509_STORE_add_crl(store, itmp->crl); }
  17601. }
  17602. }
  17603. sk_X509_INFO_pop_free(inf, X509_INFO_free);
  17604. return static_cast<ca_store_t>(store);
  17605. }
  17606. inline void free_ca_store(ca_store_t store) {
  17607. if (store) { X509_STORE_free(static_cast<X509_STORE *>(store)); }
  17608. }
  17609. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  17610. if (!ctx || !store) { return false; }
  17611. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17612. auto x509_store = static_cast<X509_STORE *>(store);
  17613. // Check if same store is already set
  17614. if (SSL_CTX_get_cert_store(ssl_ctx) == x509_store) { return true; }
  17615. // SSL_CTX_set_cert_store takes ownership and frees the old store
  17616. SSL_CTX_set_cert_store(ssl_ctx, x509_store);
  17617. return true;
  17618. }
  17619. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  17620. certs.clear();
  17621. if (!ctx) { return 0; }
  17622. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17623. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17624. if (!store) { return 0; }
  17625. auto objs = impl::get_store_objects(store);
  17626. if (!objs) { return 0; }
  17627. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  17628. auto count = sk_X509_OBJECT_num(objs);
  17629. for (decltype(count) i = 0; i < count; i++) {
  17630. auto obj = sk_X509_OBJECT_value(objs, i);
  17631. if (!obj) { continue; }
  17632. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  17633. auto x509 = X509_OBJECT_get0_X509(obj);
  17634. if (x509) {
  17635. // Increment reference count so caller can free it
  17636. X509_up_ref(x509);
  17637. certs.push_back(static_cast<cert_t>(x509));
  17638. }
  17639. }
  17640. }
  17641. return certs.size();
  17642. }
  17643. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  17644. std::vector<std::string> names;
  17645. if (!ctx) { return names; }
  17646. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17647. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17648. if (!store) { return names; }
  17649. auto objs = impl::get_store_objects(store);
  17650. if (!objs) { return names; }
  17651. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  17652. auto count = sk_X509_OBJECT_num(objs);
  17653. for (decltype(count) i = 0; i < count; i++) {
  17654. auto obj = sk_X509_OBJECT_value(objs, i);
  17655. if (!obj) { continue; }
  17656. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  17657. auto x509 = X509_OBJECT_get0_X509(obj);
  17658. if (x509) {
  17659. auto subject = X509_get_subject_name(x509);
  17660. if (subject) {
  17661. char buf[512];
  17662. X509_NAME_oneline(subject, buf, sizeof(buf));
  17663. names.push_back(buf);
  17664. }
  17665. }
  17666. }
  17667. }
  17668. return names;
  17669. }
  17670. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  17671. const char *key_pem, const char *password) {
  17672. if (!ctx || !cert_pem || !key_pem) { return false; }
  17673. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17674. // Load certificate from PEM
  17675. auto cert_bio = BIO_new_mem_buf(cert_pem, -1);
  17676. if (!cert_bio) { return false; }
  17677. auto cert = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  17678. BIO_free(cert_bio);
  17679. if (!cert) { return false; }
  17680. // Load private key from PEM
  17681. auto key_bio = BIO_new_mem_buf(key_pem, -1);
  17682. if (!key_bio) {
  17683. X509_free(cert);
  17684. return false;
  17685. }
  17686. auto key = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  17687. password ? const_cast<char *>(password)
  17688. : nullptr);
  17689. BIO_free(key_bio);
  17690. if (!key) {
  17691. X509_free(cert);
  17692. return false;
  17693. }
  17694. // Update certificate and key
  17695. auto ret = SSL_CTX_use_certificate(ssl_ctx, cert) == 1 &&
  17696. SSL_CTX_use_PrivateKey(ssl_ctx, key) == 1;
  17697. X509_free(cert);
  17698. EVP_PKEY_free(key);
  17699. return ret;
  17700. }
  17701. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  17702. if (!ctx || !ca_pem) { return false; }
  17703. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17704. // Create new X509_STORE from PEM
  17705. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  17706. if (!store) { return false; }
  17707. // A resumed session is not verified again, so the ticket keys from before
  17708. // go, or a client verified under the old CAs could go on resuming.
  17709. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  17710. unsigned char ticket_keys[48];
  17711. #else
  17712. unsigned char ticket_keys[80];
  17713. #endif
  17714. if (RAND_bytes(ticket_keys, sizeof(ticket_keys)) != 1 ||
  17715. SSL_CTX_set_tlsext_ticket_keys(ssl_ctx, ticket_keys,
  17716. sizeof(ticket_keys)) != 1) {
  17717. free_ca_store(store);
  17718. return false;
  17719. }
  17720. // SSL_CTX_set_cert_store takes ownership
  17721. SSL_CTX_set_cert_store(ssl_ctx, static_cast<X509_STORE *>(store));
  17722. // Set client CA list for client certificate request
  17723. auto ca_list = impl::create_client_ca_list_from_pem(ca_pem);
  17724. if (ca_list) {
  17725. // SSL_CTX_set_client_CA_list takes ownership of ca_list
  17726. SSL_CTX_set_client_CA_list(ssl_ctx, ca_list);
  17727. }
  17728. // The cached sessions go for the same reason.
  17729. #if OPENSSL_VERSION_NUMBER >= 0x30400000L
  17730. SSL_CTX_flush_sessions_ex(ssl_ctx, (std::numeric_limits<time_t>::max)());
  17731. #else
  17732. SSL_CTX_flush_sessions(ssl_ctx, (std::numeric_limits<long>::max)());
  17733. #endif
  17734. return true;
  17735. }
  17736. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  17737. if (!ctx) { return false; }
  17738. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17739. auto index = impl::verify_callback_index();
  17740. if (index < 0) { return false; }
  17741. std::shared_ptr<VerifyCallback> *stored = nullptr;
  17742. if (callback) {
  17743. stored = new std::shared_ptr<VerifyCallback>(
  17744. std::make_shared<VerifyCallback>(std::move(callback)));
  17745. }
  17746. std::shared_ptr<VerifyCallback> *previous = nullptr;
  17747. {
  17748. std::lock_guard<std::mutex> guard(impl::verify_callback_mutex());
  17749. previous = static_cast<std::shared_ptr<VerifyCallback> *>(
  17750. SSL_CTX_get_ex_data(ssl_ctx, index));
  17751. if (SSL_CTX_set_ex_data(ssl_ctx, index, stored) != 1) {
  17752. delete stored;
  17753. return false;
  17754. }
  17755. }
  17756. // A handshake running the previous callback keeps it until it returns.
  17757. delete previous;
  17758. // A resumed handshake shows no certificate to run the callback on.
  17759. if (stored) {
  17760. SSL_CTX_set_options(ssl_ctx, SSL_OP_NO_TICKET);
  17761. SSL_CTX_set_session_cache_mode(ssl_ctx, SSL_SESS_CACHE_OFF);
  17762. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER)
  17763. // TLS 1.3 tickets, which SSL_OP_NO_TICKET leaves on
  17764. SSL_CTX_set_num_tickets(ssl_ctx, 0);
  17765. #endif
  17766. }
  17767. // Keep requiring the peer's certificate if set_verify_client() asked for it
  17768. auto require =
  17769. (SSL_CTX_get_verify_mode(ssl_ctx) & SSL_VERIFY_FAIL_IF_NO_PEER_CERT) != 0;
  17770. impl::apply_verify_mode(ssl_ctx, require);
  17771. return true;
  17772. }
  17773. inline long get_verify_error(const_session_t session) {
  17774. if (!session) { return -1; }
  17775. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17776. return SSL_get_verify_result(ssl);
  17777. }
  17778. inline std::string verify_error_string(long error_code) {
  17779. if (error_code == X509_V_OK) { return ""; }
  17780. const char *str = X509_verify_cert_error_string(static_cast<int>(error_code));
  17781. return str ? str : "unknown error";
  17782. }
  17783. } // namespace tls
  17784. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  17785. /*
  17786. * Group 9: TLS abstraction layer - Mbed TLS backend
  17787. */
  17788. /*
  17789. * Mbed TLS Backend Implementation
  17790. */
  17791. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  17792. namespace tls {
  17793. namespace impl {
  17794. // Mbed TLS session wrapper
  17795. struct MbedTlsSession {
  17796. mbedtls_ssl_context ssl;
  17797. socket_t sock = INVALID_SOCKET;
  17798. std::string hostname; // For client: set via set_sni
  17799. std::string sni_hostname; // For server: received from client via SNI callback
  17800. // Mbed TLS has no SSL_peek() equivalent, so is_peer_closed() must probe with
  17801. // a real 1-byte mbedtls_ssl_read(). If that probe lands on application data
  17802. // (e.g. a response that arrived while this side was still in its post-write
  17803. // check), the byte is pushed back here and served by the next read().
  17804. unsigned char peeked_byte = 0;
  17805. bool has_peeked_byte = false;
  17806. // Set by set_sni() when the caller disabled hostname verification, so the
  17807. // verify callback can clear the CN/SAN mismatch flag while still enforcing
  17808. // the rest of the chain (Mbed TLS ties SNI and identity checking together;
  17809. // OpenSSL and wolfSSL keep them independent).
  17810. bool suppress_hostname_mismatch = false;
  17811. // Copied from the owning MbedTlsContext at creation, so a handshake only
  17812. // ever runs the callback of its own context.
  17813. VerifyCallback verify_callback;
  17814. bool is_server = false;
  17815. MbedTlsSession() { mbedtls_ssl_init(&ssl); }
  17816. ~MbedTlsSession() { mbedtls_ssl_free(&ssl); }
  17817. MbedTlsSession(const MbedTlsSession &) = delete;
  17818. MbedTlsSession &operator=(const MbedTlsSession &) = delete;
  17819. };
  17820. // Thread-local error code accessor for Mbed TLS (since it doesn't have an error
  17821. // queue)
  17822. inline int &mbedtls_last_error() {
  17823. static thread_local int err = 0;
  17824. return err;
  17825. }
  17826. // Helper to map Mbed TLS error to ErrorCode
  17827. inline ErrorCode map_mbedtls_error(int ret, int &out_errno,
  17828. uint32_t verify_flags) {
  17829. if (ret == 0) { return ErrorCode::Success; }
  17830. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return ErrorCode::WantRead; }
  17831. if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) { return ErrorCode::WantWrite; }
  17832. if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
  17833. return ErrorCode::PeerClosed;
  17834. }
  17835. if (ret == MBEDTLS_ERR_NET_CONN_RESET || ret == MBEDTLS_ERR_NET_SEND_FAILED ||
  17836. ret == MBEDTLS_ERR_NET_RECV_FAILED) {
  17837. out_errno = errno;
  17838. return ErrorCode::SyscallError;
  17839. }
  17840. if (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED) {
  17841. // Unlike OpenSSL/wolfSSL, Mbed TLS folds the CN/SAN identity check into
  17842. // the handshake's chain verification (see set_sni()); a mismatch there
  17843. // is reported the same way as any other verify_flags bit. Report it as
  17844. // HostnameMismatch, matching the other backends and the post-handshake
  17845. // identity check below, but only when naming is the sole problem -
  17846. // if the chain itself is also untrusted/expired/etc., that takes
  17847. // priority over the naming detail.
  17848. if (verify_flags == static_cast<uint32_t>(hostname_mismatch_code())) {
  17849. return ErrorCode::HostnameMismatch;
  17850. }
  17851. return ErrorCode::CertVerifyFailed;
  17852. }
  17853. return ErrorCode::Fatal;
  17854. }
  17855. // Populates a TlsError from a failed (non-zero) mbedtls_ssl_handshake()
  17856. // return value, including the verify-flags-dependent HostnameMismatch
  17857. // mapping; shared by connect() and connect_nonblocking() so the
  17858. // backend_code policy for that mapping only lives in one place.
  17859. inline void fill_mbedtls_tls_error(TlsError &err, mbedtls_ssl_context &ssl,
  17860. int ret) {
  17861. auto verify_flags = mbedtls_ssl_get_verify_result(&ssl);
  17862. err.code = map_mbedtls_error(ret, err.sys_errno, verify_flags);
  17863. err.backend_code = err.code == ErrorCode::HostnameMismatch
  17864. ? static_cast<uint64_t>(verify_flags)
  17865. : static_cast<uint64_t>(-ret);
  17866. }
  17867. // A TLS 1.3 NewSessionTicket (signaled by default on Mbed TLS 4.x) is a
  17868. // non-fatal notification delivered between records, not an error and not
  17869. // application data, so I/O calls that see it should just be retried. Kept in
  17870. // one helper so the retry loops keep an intact "do { } while (...)" instead of
  17871. // splitting the closing brace across an #if.
  17872. inline bool mbedtls_is_session_ticket(int ret) {
  17873. #if defined(MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET)
  17874. return ret == MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
  17875. #else
  17876. (void)ret;
  17877. return false;
  17878. #endif
  17879. }
  17880. // BIO-like send callback for Mbed TLS
  17881. inline int mbedtls_net_send_cb(void *ctx, const unsigned char *buf,
  17882. size_t len) {
  17883. auto sock = *static_cast<socket_t *>(ctx);
  17884. #ifdef _WIN32
  17885. auto ret =
  17886. send(sock, reinterpret_cast<const char *>(buf), static_cast<int>(len), 0);
  17887. if (ret == SOCKET_ERROR) {
  17888. int err = WSAGetLastError();
  17889. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_WRITE; }
  17890. return MBEDTLS_ERR_NET_SEND_FAILED;
  17891. }
  17892. #else
  17893. auto ret = send(sock, buf, len, 0);
  17894. if (ret < 0) {
  17895. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17896. return MBEDTLS_ERR_SSL_WANT_WRITE;
  17897. }
  17898. return MBEDTLS_ERR_NET_SEND_FAILED;
  17899. }
  17900. #endif
  17901. return static_cast<int>(ret);
  17902. }
  17903. // BIO-like recv callback for Mbed TLS
  17904. inline int mbedtls_net_recv_cb(void *ctx, unsigned char *buf, size_t len) {
  17905. auto sock = *static_cast<socket_t *>(ctx);
  17906. #ifdef _WIN32
  17907. auto ret =
  17908. recv(sock, reinterpret_cast<char *>(buf), static_cast<int>(len), 0);
  17909. if (ret == SOCKET_ERROR) {
  17910. int err = WSAGetLastError();
  17911. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_READ; }
  17912. return MBEDTLS_ERR_NET_RECV_FAILED;
  17913. }
  17914. #else
  17915. auto ret = recv(sock, buf, len, 0);
  17916. if (ret < 0) {
  17917. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17918. return MBEDTLS_ERR_SSL_WANT_READ;
  17919. }
  17920. return MBEDTLS_ERR_NET_RECV_FAILED;
  17921. }
  17922. #endif
  17923. if (ret == 0) { return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY; }
  17924. return static_cast<int>(ret);
  17925. }
  17926. // MbedTlsContext constructor/destructor implementations
  17927. inline MbedTlsContext::MbedTlsContext() {
  17928. mbedtls_ssl_config_init(&conf);
  17929. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17930. mbedtls_entropy_init(&entropy);
  17931. mbedtls_ctr_drbg_init(&ctr_drbg);
  17932. #endif
  17933. mbedtls_x509_crt_init(&ca_chain);
  17934. mbedtls_x509_crt_init(&own_cert);
  17935. mbedtls_pk_init(&own_key);
  17936. }
  17937. inline MbedTlsContext::~MbedTlsContext() {
  17938. mbedtls_pk_free(&own_key);
  17939. mbedtls_x509_crt_free(&own_cert);
  17940. mbedtls_x509_crt_free(&ca_chain);
  17941. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17942. mbedtls_ctr_drbg_free(&ctr_drbg);
  17943. mbedtls_entropy_free(&entropy);
  17944. #endif
  17945. mbedtls_ssl_config_free(&conf);
  17946. }
  17947. // Thread-local storage for SNI captured during handshake
  17948. // This is needed because the SNI callback doesn't have a way to pass
  17949. // session-specific data before the session is fully set up
  17950. inline std::string &mbedpending_sni() {
  17951. static thread_local std::string sni;
  17952. return sni;
  17953. }
  17954. // SNI callback for Mbed TLS server to capture client's SNI hostname
  17955. inline int mbedtls_sni_callback(void *p_ctx, mbedtls_ssl_context *ssl,
  17956. const unsigned char *name, size_t name_len) {
  17957. (void)p_ctx;
  17958. (void)ssl;
  17959. // Store SNI name in thread-local storage
  17960. // It will be retrieved and stored in the session after handshake
  17961. if (name && name_len > 0) {
  17962. mbedpending_sni().assign(reinterpret_cast<const char *>(name), name_len);
  17963. } else {
  17964. mbedpending_sni().clear();
  17965. }
  17966. return 0; // Accept any SNI
  17967. }
  17968. inline void mbedtls_clear_cn_mismatch(uint32_t *flags) {
  17969. *flags &= ~static_cast<uint32_t>(hostname_mismatch_code());
  17970. }
  17971. // MbedTLS verify callback wrapper
  17972. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  17973. int cert_depth, uint32_t *flags) {
  17974. // data points to the MbedTlsSession
  17975. auto *session = static_cast<MbedTlsSession *>(data);
  17976. // set_sni() disabled hostname verification for this session: ignore the
  17977. // CN/SAN mismatch flag, as the OpenSSL/wolfSSL backends do. The final
  17978. // pass/fail decision still comes from the remaining flags (and, below, from
  17979. // the user's own verify callback).
  17980. if (session->suppress_hostname_mismatch) { mbedtls_clear_cn_mismatch(flags); }
  17981. const auto &callback = session->verify_callback;
  17982. if (!callback) { return 0; } // Continue with default verification
  17983. // Build context
  17984. VerifyContext verify_ctx;
  17985. verify_ctx.session = static_cast<session_t>(session);
  17986. verify_ctx.cert = static_cast<cert_t>(crt);
  17987. verify_ctx.depth = cert_depth;
  17988. verify_ctx.preverify_ok = (*flags == 0);
  17989. verify_ctx.error_code = static_cast<long>(*flags);
  17990. // Convert Mbed TLS flags to error string
  17991. static thread_local char error_buf[256];
  17992. if (*flags != 0) {
  17993. mbedtls_x509_crt_verify_info(error_buf, sizeof(error_buf), "", *flags);
  17994. verify_ctx.error_string = error_buf;
  17995. } else {
  17996. verify_ctx.error_string = nullptr;
  17997. }
  17998. bool accepted = run_verify_callback(callback, verify_ctx);
  17999. if (accepted) {
  18000. // Overrides the built-in verification only on a server, as on OpenSSL and
  18001. // wolfSSL, whose clients check the verify result after the handshake
  18002. if (session->is_server) { *flags = 0; }
  18003. return 0;
  18004. }
  18005. return MBEDTLS_ERR_X509_CERT_VERIFY_FAILED;
  18006. }
  18007. // Sets the authentication mode from whether the peer's certificate is required
  18008. // and whether a verify callback is set. OPTIONAL lets the callback run even if
  18009. // verification is not required (matching OpenSSL's SSL_VERIFY_PEER).
  18010. inline void apply_verify_mode(MbedTlsContext &mctx) {
  18011. auto mode = MBEDTLS_SSL_VERIFY_NONE;
  18012. if (mctx.verify_client) {
  18013. mode = MBEDTLS_SSL_VERIFY_REQUIRED;
  18014. } else if (mctx.verify_callback) {
  18015. mode = MBEDTLS_SSL_VERIFY_OPTIONAL;
  18016. }
  18017. mbedtls_ssl_conf_authmode(&mctx.conf, mode);
  18018. }
  18019. } // namespace impl
  18020. inline ctx_t create_client_context() {
  18021. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  18022. if (!ctx) { return nullptr; }
  18023. ctx->is_server = false;
  18024. #ifdef CPPHTTPLIB_MBEDTLS_V4
  18025. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  18026. if (!detail::ensure_mbedtls_psa_crypto()) {
  18027. delete ctx;
  18028. return nullptr;
  18029. }
  18030. int ret;
  18031. #else
  18032. // Seed the random number generator
  18033. const char *pers = "httplib_client";
  18034. int ret = mbedtls_ctr_drbg_seed(
  18035. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  18036. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  18037. if (ret != 0) {
  18038. impl::mbedtls_last_error() = ret;
  18039. delete ctx;
  18040. return nullptr;
  18041. }
  18042. #endif
  18043. // Set up SSL config for client
  18044. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_CLIENT,
  18045. MBEDTLS_SSL_TRANSPORT_STREAM,
  18046. MBEDTLS_SSL_PRESET_DEFAULT);
  18047. if (ret != 0) {
  18048. impl::mbedtls_last_error() = ret;
  18049. delete ctx;
  18050. return nullptr;
  18051. }
  18052. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18053. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  18054. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  18055. #endif
  18056. // Default: verify peer certificate
  18057. ctx->verify_client = true;
  18058. impl::apply_verify_mode(*ctx);
  18059. // Set minimum TLS version to 1.2
  18060. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18061. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  18062. #else
  18063. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  18064. MBEDTLS_SSL_MINOR_VERSION_3);
  18065. #endif
  18066. return static_cast<ctx_t>(ctx);
  18067. }
  18068. inline ctx_t create_server_context() {
  18069. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  18070. if (!ctx) { return nullptr; }
  18071. ctx->is_server = true;
  18072. #ifdef CPPHTTPLIB_MBEDTLS_V4
  18073. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  18074. if (!detail::ensure_mbedtls_psa_crypto()) {
  18075. delete ctx;
  18076. return nullptr;
  18077. }
  18078. int ret;
  18079. #else
  18080. // Seed the random number generator
  18081. const char *pers = "httplib_server";
  18082. int ret = mbedtls_ctr_drbg_seed(
  18083. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  18084. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  18085. if (ret != 0) {
  18086. impl::mbedtls_last_error() = ret;
  18087. delete ctx;
  18088. return nullptr;
  18089. }
  18090. #endif
  18091. // Set up SSL config for server
  18092. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_SERVER,
  18093. MBEDTLS_SSL_TRANSPORT_STREAM,
  18094. MBEDTLS_SSL_PRESET_DEFAULT);
  18095. if (ret != 0) {
  18096. impl::mbedtls_last_error() = ret;
  18097. delete ctx;
  18098. return nullptr;
  18099. }
  18100. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18101. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  18102. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  18103. #endif
  18104. // Default: don't verify client
  18105. impl::apply_verify_mode(*ctx);
  18106. // Set minimum TLS version to 1.2
  18107. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18108. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  18109. #else
  18110. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  18111. MBEDTLS_SSL_MINOR_VERSION_3);
  18112. #endif
  18113. // Set SNI callback to capture client's SNI hostname
  18114. mbedtls_ssl_conf_sni(&ctx->conf, impl::mbedtls_sni_callback, nullptr);
  18115. return static_cast<ctx_t>(ctx);
  18116. }
  18117. inline void free_context(ctx_t ctx) {
  18118. if (ctx) { delete static_cast<impl::MbedTlsContext *>(ctx); }
  18119. }
  18120. inline bool set_min_version(ctx_t ctx, Version version) {
  18121. if (!ctx) { return false; }
  18122. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18123. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18124. // Mbed TLS 3.x uses mbedtls_ssl_protocol_version enum
  18125. mbedtls_ssl_protocol_version min_ver = MBEDTLS_SSL_VERSION_TLS1_2;
  18126. if (version >= Version::TLS1_3) {
  18127. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  18128. min_ver = MBEDTLS_SSL_VERSION_TLS1_3;
  18129. #endif
  18130. }
  18131. mbedtls_ssl_conf_min_tls_version(&mctx->conf, min_ver);
  18132. #else
  18133. // Mbed TLS 2.x uses major/minor version numbers
  18134. int major = MBEDTLS_SSL_MAJOR_VERSION_3;
  18135. int minor = MBEDTLS_SSL_MINOR_VERSION_3; // TLS 1.2
  18136. if (version >= Version::TLS1_3) {
  18137. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  18138. minor = MBEDTLS_SSL_MINOR_VERSION_4; // TLS 1.3
  18139. #else
  18140. minor = MBEDTLS_SSL_MINOR_VERSION_3; // Fall back to TLS 1.2
  18141. #endif
  18142. }
  18143. mbedtls_ssl_conf_min_version(&mctx->conf, major, minor);
  18144. #endif
  18145. return true;
  18146. }
  18147. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  18148. if (!ctx || !pem) { return false; }
  18149. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18150. // mbedtls_x509_crt_parse expects null-terminated string for PEM
  18151. // Add null terminator if not present
  18152. std::string pem_str(pem, len);
  18153. int ret = mbedtls_x509_crt_parse(
  18154. &mctx->ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  18155. pem_str.size() + 1);
  18156. if (ret != 0) {
  18157. impl::mbedtls_last_error() = ret;
  18158. return false;
  18159. }
  18160. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18161. return true;
  18162. }
  18163. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  18164. if (!ctx || !file_path) { return false; }
  18165. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18166. int ret = mbedtls_x509_crt_parse_file(&mctx->ca_chain, file_path);
  18167. if (ret != 0) {
  18168. impl::mbedtls_last_error() = ret;
  18169. return false;
  18170. }
  18171. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18172. return true;
  18173. }
  18174. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  18175. if (!ctx || !dir_path) { return false; }
  18176. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18177. int ret = mbedtls_x509_crt_parse_path(&mctx->ca_chain, dir_path);
  18178. if (ret < 0) { // Returns number of certs on success, negative on error
  18179. impl::mbedtls_last_error() = ret;
  18180. return false;
  18181. }
  18182. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18183. return true;
  18184. }
  18185. inline bool load_system_certs(ctx_t ctx) {
  18186. if (!ctx) { return false; }
  18187. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18188. bool loaded = false;
  18189. #ifdef _WIN32
  18190. loaded = impl::enumerate_windows_system_certs(
  18191. [&](const unsigned char *data, size_t len) {
  18192. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  18193. });
  18194. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  18195. loaded = impl::enumerate_macos_keychain_certs(
  18196. [&](const unsigned char *data, size_t len) {
  18197. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  18198. });
  18199. #else
  18200. for (auto path = impl::system_ca_paths(); *path; ++path) {
  18201. if (mbedtls_x509_crt_parse_file(&mctx->ca_chain, *path) >= 0) {
  18202. loaded = true;
  18203. break;
  18204. }
  18205. }
  18206. if (!loaded) {
  18207. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  18208. if (mbedtls_x509_crt_parse_path(&mctx->ca_chain, *dir) >= 0) {
  18209. loaded = true;
  18210. break;
  18211. }
  18212. }
  18213. }
  18214. #endif
  18215. if (loaded) {
  18216. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18217. }
  18218. return loaded;
  18219. }
  18220. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  18221. const char *password) {
  18222. if (!ctx || !cert || !key) { return false; }
  18223. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18224. // Parse certificate
  18225. std::string cert_str(cert);
  18226. int ret = mbedtls_x509_crt_parse(
  18227. &mctx->own_cert,
  18228. reinterpret_cast<const unsigned char *>(cert_str.c_str()),
  18229. cert_str.size() + 1);
  18230. if (ret != 0) {
  18231. impl::mbedtls_last_error() = ret;
  18232. return false;
  18233. }
  18234. // Parse private key
  18235. std::string key_str(key);
  18236. const unsigned char *pwd =
  18237. password ? reinterpret_cast<const unsigned char *>(password) : nullptr;
  18238. size_t pwd_len = password ? strlen(password) : 0;
  18239. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18240. ret = mbedtls_pk_parse_key(
  18241. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  18242. key_str.size() + 1, pwd, pwd_len, mbedtls_ctr_drbg_random,
  18243. &mctx->ctr_drbg);
  18244. #else
  18245. ret = mbedtls_pk_parse_key(
  18246. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  18247. key_str.size() + 1, pwd, pwd_len);
  18248. #endif
  18249. if (ret != 0) {
  18250. impl::mbedtls_last_error() = ret;
  18251. return false;
  18252. }
  18253. // Verify that the certificate and private key match.
  18254. // Mbed TLS 4.x: mbedtls_pk_check_pair() reports a spurious mismatch for
  18255. // PSA-backed keys, so skip it and let the handshake surface a real mismatch.
  18256. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18257. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18258. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  18259. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18260. #else
  18261. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  18262. #endif
  18263. if (ret != 0) {
  18264. impl::mbedtls_last_error() = ret;
  18265. return false;
  18266. }
  18267. #endif
  18268. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  18269. if (ret != 0) {
  18270. impl::mbedtls_last_error() = ret;
  18271. return false;
  18272. }
  18273. return true;
  18274. }
  18275. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  18276. const char *key_path, const char *password) {
  18277. if (!ctx || !cert_path || !key_path) { return false; }
  18278. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18279. // Parse certificate file
  18280. int ret = mbedtls_x509_crt_parse_file(&mctx->own_cert, cert_path);
  18281. if (ret != 0) {
  18282. impl::mbedtls_last_error() = ret;
  18283. return false;
  18284. }
  18285. // Parse private key file
  18286. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18287. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password,
  18288. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18289. #else
  18290. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password);
  18291. #endif
  18292. if (ret != 0) {
  18293. impl::mbedtls_last_error() = ret;
  18294. return false;
  18295. }
  18296. // Verify that the certificate and private key match.
  18297. // Mbed TLS 4.x: see set_client_cert() — skip the spurious check_pair.
  18298. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18299. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18300. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  18301. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18302. #else
  18303. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  18304. #endif
  18305. if (ret != 0) {
  18306. impl::mbedtls_last_error() = ret;
  18307. return false;
  18308. }
  18309. #endif
  18310. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  18311. if (ret != 0) {
  18312. impl::mbedtls_last_error() = ret;
  18313. return false;
  18314. }
  18315. return true;
  18316. }
  18317. inline void set_verify_client(ctx_t ctx, bool require) {
  18318. if (!ctx) { return; }
  18319. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18320. mctx->verify_client = require;
  18321. impl::apply_verify_mode(*mctx);
  18322. }
  18323. inline session_t create_session(ctx_t ctx, socket_t sock) {
  18324. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  18325. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18326. auto session = new (std::nothrow) impl::MbedTlsSession();
  18327. if (!session) { return nullptr; }
  18328. session->sock = sock;
  18329. int ret = mbedtls_ssl_setup(&session->ssl, &mctx->conf);
  18330. if (ret != 0) {
  18331. impl::mbedtls_last_error() = ret;
  18332. delete session;
  18333. return nullptr;
  18334. }
  18335. // Explicitly opt out of in-handshake hostname verification by default;
  18336. // since Mbed TLS 3.6.4 a client handshake with certificate verification
  18337. // fails outright when no hostname was set. set_sni() installs the real
  18338. // hostname for DNS hosts; for IP hosts (where SNI must not be set) the
  18339. // caller verifies the certificate identity post-handshake via
  18340. // verify_hostname().
  18341. mbedtls_ssl_set_hostname(&session->ssl, nullptr);
  18342. // Set BIO callbacks
  18343. mbedtls_ssl_set_bio(&session->ssl, &session->sock, impl::mbedtls_net_send_cb,
  18344. impl::mbedtls_net_recv_cb, nullptr);
  18345. // Installed always, as it also masks the hostname mismatch that set_sni()
  18346. // may ask for. The session runs its own copy of the user's callback, which
  18347. // set_verify_callback() cannot replace under a handshake.
  18348. session->verify_callback = mctx->verify_callback;
  18349. session->is_server = mctx->is_server;
  18350. mbedtls_ssl_set_verify(&session->ssl, impl::mbedtls_verify_callback, session);
  18351. return static_cast<session_t>(session);
  18352. }
  18353. inline void free_session(session_t session) {
  18354. if (session) { delete static_cast<impl::MbedTlsSession *>(session); }
  18355. }
  18356. inline bool set_sni(session_t session, const char *hostname,
  18357. bool verify_hostname) {
  18358. if (!session || !hostname) { return false; }
  18359. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18360. // mbedtls_ssl_set_hostname() both sends the SNI extension and binds the
  18361. // handshake-time CN/SAN check to `hostname`; the two can't be requested
  18362. // independently, so a disabled hostname check is handled below by masking
  18363. // the resulting mismatch flag instead of skipping this call.
  18364. int ret = mbedtls_ssl_set_hostname(&msession->ssl, hostname);
  18365. if (ret != 0) {
  18366. impl::mbedtls_last_error() = ret;
  18367. return false;
  18368. }
  18369. msession->hostname = hostname;
  18370. if (!verify_hostname) { msession->suppress_hostname_mismatch = true; }
  18371. return true;
  18372. }
  18373. inline TlsError connect(session_t session) {
  18374. TlsError err;
  18375. if (!session) {
  18376. err.code = ErrorCode::Fatal;
  18377. return err;
  18378. }
  18379. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18380. int ret;
  18381. do {
  18382. ret = mbedtls_ssl_handshake(&msession->ssl);
  18383. } while (impl::mbedtls_is_session_ticket(ret));
  18384. if (ret == 0) {
  18385. err.code = ErrorCode::Success;
  18386. } else {
  18387. impl::fill_mbedtls_tls_error(err, msession->ssl, ret);
  18388. impl::mbedtls_last_error() = ret;
  18389. }
  18390. return err;
  18391. }
  18392. inline TlsError accept(session_t session) {
  18393. // A failed handshake leaves its SNI behind, so start without it
  18394. impl::mbedpending_sni().clear();
  18395. // Same as connect for Mbed TLS - handshake works for both client and server
  18396. auto result = connect(session);
  18397. // After successful handshake, capture SNI from thread-local storage
  18398. if (result.code == ErrorCode::Success && session) {
  18399. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18400. msession->sni_hostname = std::move(impl::mbedpending_sni());
  18401. }
  18402. return result;
  18403. }
  18404. inline bool connect_nonblocking(session_t session, socket_t sock,
  18405. time_t timeout_sec, time_t timeout_usec,
  18406. TlsError *err) {
  18407. if (!session) {
  18408. if (err) { err->code = ErrorCode::Fatal; }
  18409. return false;
  18410. }
  18411. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18412. // Set socket to non-blocking mode
  18413. detail::set_nonblocking(sock, true);
  18414. auto cleanup =
  18415. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18416. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  18417. int ret;
  18418. while ((ret = mbedtls_ssl_handshake(&msession->ssl)) != 0) {
  18419. // Non-fatal TLS 1.3 ticket; retry immediately.
  18420. if (impl::mbedtls_is_session_ticket(ret)) { continue; }
  18421. if (ret == MBEDTLS_ERR_SSL_WANT_READ) {
  18422. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  18423. } else if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) {
  18424. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  18425. }
  18426. // TlsError or timeout
  18427. if (err) { impl::fill_mbedtls_tls_error(*err, msession->ssl, ret); }
  18428. impl::mbedtls_last_error() = ret;
  18429. return false;
  18430. }
  18431. if (err) { err->code = ErrorCode::Success; }
  18432. return true;
  18433. }
  18434. inline bool accept_nonblocking(session_t session, socket_t sock,
  18435. time_t timeout_sec, time_t timeout_usec,
  18436. TlsError *err) {
  18437. // A failed handshake leaves its SNI behind, so start without it
  18438. impl::mbedpending_sni().clear();
  18439. // Same implementation as connect for Mbed TLS
  18440. bool result =
  18441. connect_nonblocking(session, sock, timeout_sec, timeout_usec, err);
  18442. // After successful handshake, capture SNI from thread-local storage
  18443. if (result && session) {
  18444. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18445. msession->sni_hostname = std::move(impl::mbedpending_sni());
  18446. }
  18447. return result;
  18448. }
  18449. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  18450. if (!session || !buf) {
  18451. err.code = ErrorCode::Fatal;
  18452. return -1;
  18453. }
  18454. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18455. // Serve a byte consumed by the is_peer_closed() probe before reading more.
  18456. if (msession->has_peeked_byte) {
  18457. if (len == 0) { return 0; }
  18458. auto p = static_cast<unsigned char *>(buf);
  18459. p[0] = msession->peeked_byte;
  18460. msession->has_peeked_byte = false;
  18461. size_t n = 1;
  18462. // Top up with any already-decrypted bytes without risking a block.
  18463. if (len > 1 && mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  18464. int extra = mbedtls_ssl_read(&msession->ssl, p + 1, len - 1);
  18465. if (extra > 0) { n += static_cast<size_t>(extra); }
  18466. }
  18467. err.code = ErrorCode::Success;
  18468. return static_cast<ssize_t>(n);
  18469. }
  18470. int ret;
  18471. do {
  18472. ret = mbedtls_ssl_read(&msession->ssl, static_cast<unsigned char *>(buf),
  18473. len);
  18474. } while (impl::mbedtls_is_session_ticket(ret));
  18475. if (ret > 0) {
  18476. err.code = ErrorCode::Success;
  18477. return static_cast<ssize_t>(ret);
  18478. }
  18479. if (ret == 0) {
  18480. err.code = ErrorCode::PeerClosed;
  18481. return 0;
  18482. }
  18483. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  18484. err.backend_code = static_cast<uint64_t>(-ret);
  18485. impl::mbedtls_last_error() = ret;
  18486. // mbedTLS signals a clean close_notify via a negative error code rather
  18487. // than 0; surface it as a clean EOF the way OpenSSL/wolfSSL do.
  18488. if (err.code == ErrorCode::PeerClosed) { return 0; }
  18489. return -1;
  18490. }
  18491. inline ssize_t write(session_t session, const void *buf, size_t len,
  18492. TlsError &err) {
  18493. if (!session || !buf) {
  18494. err.code = ErrorCode::Fatal;
  18495. return -1;
  18496. }
  18497. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18498. int ret;
  18499. do {
  18500. ret = mbedtls_ssl_write(&msession->ssl,
  18501. static_cast<const unsigned char *>(buf), len);
  18502. } while (impl::mbedtls_is_session_ticket(ret));
  18503. if (ret > 0) {
  18504. err.code = ErrorCode::Success;
  18505. return static_cast<ssize_t>(ret);
  18506. }
  18507. if (ret == 0) {
  18508. err.code = ErrorCode::PeerClosed;
  18509. return 0;
  18510. }
  18511. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  18512. err.backend_code = static_cast<uint64_t>(-ret);
  18513. impl::mbedtls_last_error() = ret;
  18514. return -1;
  18515. }
  18516. inline int pending(const_session_t session) {
  18517. if (!session) { return 0; }
  18518. auto msession =
  18519. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18520. return static_cast<int>(mbedtls_ssl_get_bytes_avail(&msession->ssl)) +
  18521. (msession->has_peeked_byte ? 1 : 0);
  18522. }
  18523. inline void shutdown(session_t session, bool graceful) {
  18524. if (!session) { return; }
  18525. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18526. if (graceful) {
  18527. // Try to send close_notify, but don't block forever
  18528. int ret;
  18529. int attempts = 0;
  18530. while ((ret = mbedtls_ssl_close_notify(&msession->ssl)) != 0 &&
  18531. attempts < 3) {
  18532. if (ret != MBEDTLS_ERR_SSL_WANT_READ &&
  18533. ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
  18534. break;
  18535. }
  18536. attempts++;
  18537. }
  18538. }
  18539. }
  18540. inline bool is_peer_closed(session_t session, socket_t sock) {
  18541. if (!session || sock == INVALID_SOCKET) { return true; }
  18542. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18543. // Check if there's already decrypted or pushed-back data available.
  18544. // If so, the connection is definitely alive.
  18545. if (msession->has_peeked_byte ||
  18546. mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  18547. return false;
  18548. }
  18549. // Set socket to non-blocking to avoid blocking on read
  18550. detail::set_nonblocking(sock, true);
  18551. auto cleanup =
  18552. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18553. // Probe with a 1-byte read (Mbed TLS has no peek API). If the probe lands
  18554. // on application data — e.g. a response that already arrived — push the
  18555. // byte back so the next read() delivers it instead of losing it.
  18556. unsigned char buf;
  18557. int ret;
  18558. do {
  18559. ret = mbedtls_ssl_read(&msession->ssl, &buf, 1);
  18560. } while (impl::mbedtls_is_session_ticket(ret));
  18561. // If we got data or WANT_READ (would block), connection is alive
  18562. if (ret > 0) {
  18563. msession->peeked_byte = buf;
  18564. msession->has_peeked_byte = true;
  18565. return false;
  18566. }
  18567. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return false; }
  18568. // If we get a peer close notify or a connection reset, the peer is closed
  18569. return ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY ||
  18570. ret == MBEDTLS_ERR_NET_CONN_RESET || ret == 0;
  18571. }
  18572. inline cert_t get_peer_cert(const_session_t session) {
  18573. if (!session) { return nullptr; }
  18574. auto msession =
  18575. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18576. // Mbed TLS returns a pointer to the internal peer cert chain.
  18577. // WARNING: This pointer is only valid while the session is active.
  18578. // Do not use the certificate after calling free_session().
  18579. const mbedtls_x509_crt *cert = mbedtls_ssl_get_peer_cert(&msession->ssl);
  18580. return const_cast<mbedtls_x509_crt *>(cert);
  18581. }
  18582. inline size_t get_peer_certs(const_session_t session,
  18583. std::vector<cert_t> &certs) {
  18584. certs.clear();
  18585. // Mbed TLS parses the whole received chain into a list headed by the peer
  18586. // certificate, owned by the session like get_peer_cert()'s result
  18587. for (auto crt = static_cast<mbedtls_x509_crt *>(get_peer_cert(session));
  18588. crt && crt->raw.len > 0; crt = crt->next) {
  18589. certs.push_back(static_cast<cert_t>(crt));
  18590. }
  18591. return certs.size();
  18592. }
  18593. inline void free_cert(cert_t cert) {
  18594. // Mbed TLS: every cert_t handed out points into a session's or a context's
  18595. // chain, so there is nothing to free. Callers still call this for the other
  18596. // backends.
  18597. (void)cert;
  18598. }
  18599. inline bool verify_hostname(cert_t cert, const char *hostname) {
  18600. if (!cert || !hostname) { return false; }
  18601. auto mcert = static_cast<const mbedtls_x509_crt *>(cert);
  18602. std::string host_str(hostname);
  18603. // Check if hostname is an IP address (IPv4 or IPv6)
  18604. unsigned char ip_bytes[16];
  18605. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  18606. auto is_ip = ip_len > 0;
  18607. // Check Subject Alternative Names (SAN). Mbed TLS keeps the GeneralName type
  18608. // in buf.tag and the raw value in buf.p / buf.len.
  18609. auto has_dns_san = false;
  18610. for (auto san = &mcert->subject_alt_names; san; san = san->next) {
  18611. if (!san->buf.p || san->buf.len == 0) { continue; }
  18612. const unsigned char *p = san->buf.p;
  18613. size_t len = san->buf.len;
  18614. auto san_type = san->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK;
  18615. if (is_ip) {
  18616. // For an IP host, only a matching iPAddress SAN of the same family
  18617. // (4 bytes for IPv4, 16 bytes for IPv6) may authenticate it.
  18618. if (san_type == MBEDTLS_X509_SAN_IP_ADDRESS && len == ip_len &&
  18619. memcmp(p, ip_bytes, ip_len) == 0) {
  18620. return true;
  18621. }
  18622. } else if (san_type == MBEDTLS_X509_SAN_DNS_NAME) {
  18623. has_dns_san = true;
  18624. std::string san_name(reinterpret_cast<const char *>(p), len);
  18625. if (detail::match_hostname(san_name, host_str)) { return true; }
  18626. }
  18627. }
  18628. // Fallback: the Common Names (CN) in the subject, as X509_check_host does it:
  18629. // never for an IP host, which only an iPAddress SAN names, and never next to
  18630. // a DNS SAN (RFC 6125 6.4.4).
  18631. if (is_ip || has_dns_san) { return false; }
  18632. for (auto name = &mcert->subject; name; name = name->next) {
  18633. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  18634. std::string cn(reinterpret_cast<const char *>(name->val.p),
  18635. name->val.len);
  18636. if (detail::match_hostname(cn, host_str)) { return true; }
  18637. }
  18638. }
  18639. return false;
  18640. }
  18641. inline uint64_t hostname_mismatch_code() {
  18642. return static_cast<uint64_t>(MBEDTLS_X509_BADCERT_CN_MISMATCH);
  18643. }
  18644. inline long get_verify_result(const_session_t session) {
  18645. if (!session) { return -1; }
  18646. auto msession =
  18647. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18648. uint32_t flags = mbedtls_ssl_get_verify_result(&msession->ssl);
  18649. // Return 0 (X509_V_OK equivalent) if verification passed
  18650. return flags == 0 ? 0 : static_cast<long>(flags);
  18651. }
  18652. inline std::string get_cert_subject_cn(cert_t cert) {
  18653. if (!cert) return "";
  18654. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18655. // Find the CN in the subject
  18656. const mbedtls_x509_name *name = &x509->subject;
  18657. while (name != nullptr) {
  18658. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  18659. return std::string(reinterpret_cast<const char *>(name->val.p),
  18660. name->val.len);
  18661. }
  18662. name = name->next;
  18663. }
  18664. return "";
  18665. }
  18666. inline std::string get_cert_issuer_name(cert_t cert) {
  18667. if (!cert) return "";
  18668. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18669. // Build a human-readable issuer name string
  18670. char buf[512];
  18671. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &x509->issuer);
  18672. if (ret < 0) return "";
  18673. return std::string(buf);
  18674. }
  18675. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  18676. sans.clear();
  18677. if (!cert) return false;
  18678. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18679. // Parse the Subject Alternative Name extension
  18680. const mbedtls_x509_sequence *cur = &x509->subject_alt_names;
  18681. while (cur != nullptr) {
  18682. if (cur->buf.len > 0) {
  18683. const unsigned char *p = cur->buf.p;
  18684. size_t value_len = cur->buf.len;
  18685. SanEntry entry;
  18686. switch (cur->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK) {
  18687. case MBEDTLS_X509_SAN_DNS_NAME:
  18688. entry.type = SanType::DNS;
  18689. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18690. break;
  18691. case MBEDTLS_X509_SAN_IP_ADDRESS:
  18692. entry.type = SanType::IP;
  18693. if (value_len == 4) {
  18694. // IPv4
  18695. char buf[16];
  18696. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", p[0], p[1], p[2], p[3]);
  18697. entry.value = buf;
  18698. } else if (value_len == 16) {
  18699. // IPv6
  18700. char buf[64];
  18701. snprintf(buf, sizeof(buf),
  18702. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  18703. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  18704. p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8], p[9],
  18705. p[10], p[11], p[12], p[13], p[14], p[15]);
  18706. entry.value = buf;
  18707. }
  18708. break;
  18709. case MBEDTLS_X509_SAN_RFC822_NAME:
  18710. entry.type = SanType::EMAIL;
  18711. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18712. break;
  18713. case MBEDTLS_X509_SAN_UNIFORM_RESOURCE_IDENTIFIER:
  18714. entry.type = SanType::URI;
  18715. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18716. break;
  18717. default: entry.type = SanType::OTHER; break;
  18718. }
  18719. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  18720. }
  18721. cur = cur->next;
  18722. }
  18723. return true;
  18724. }
  18725. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  18726. time_t &not_after) {
  18727. if (!cert) return false;
  18728. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18729. // Convert mbedtls_x509_time to time_t
  18730. auto to_time_t = [](const mbedtls_x509_time &t) -> time_t {
  18731. struct tm tm_time = {};
  18732. tm_time.tm_year = t.year - 1900;
  18733. tm_time.tm_mon = t.mon - 1;
  18734. tm_time.tm_mday = t.day;
  18735. tm_time.tm_hour = t.hour;
  18736. tm_time.tm_min = t.min;
  18737. tm_time.tm_sec = t.sec;
  18738. #ifdef _WIN32
  18739. return _mkgmtime(&tm_time);
  18740. #else
  18741. return timegm(&tm_time);
  18742. #endif
  18743. };
  18744. not_before = to_time_t(x509->valid_from);
  18745. not_after = to_time_t(x509->valid_to);
  18746. return true;
  18747. }
  18748. inline std::string get_cert_serial(cert_t cert) {
  18749. if (!cert) return "";
  18750. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18751. // Convert serial number to hex string
  18752. std::string result;
  18753. result.reserve(x509->serial.len * 2);
  18754. for (size_t i = 0; i < x509->serial.len; i++) {
  18755. char hex[3];
  18756. snprintf(hex, sizeof(hex), "%02X", x509->serial.p[i]);
  18757. result += hex;
  18758. }
  18759. return result;
  18760. }
  18761. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  18762. if (!cert) return false;
  18763. auto crt = static_cast<mbedtls_x509_crt *>(cert);
  18764. if (!crt->raw.p || crt->raw.len == 0) return false;
  18765. der.assign(crt->raw.p, crt->raw.p + crt->raw.len);
  18766. return true;
  18767. }
  18768. inline const char *get_sni(const_session_t session) {
  18769. if (!session) return nullptr;
  18770. auto msession = static_cast<const impl::MbedTlsSession *>(session);
  18771. // For server: return SNI received from client during handshake
  18772. if (!msession->sni_hostname.empty()) {
  18773. return msession->sni_hostname.c_str();
  18774. }
  18775. // For client: return the hostname set via set_sni
  18776. if (!msession->hostname.empty()) { return msession->hostname.c_str(); }
  18777. return nullptr;
  18778. }
  18779. inline uint64_t peek_error() {
  18780. // Mbed TLS doesn't have an error queue, return the last error
  18781. return static_cast<uint64_t>(-impl::mbedtls_last_error());
  18782. }
  18783. inline uint64_t get_error() {
  18784. // Mbed TLS doesn't have an error queue, return and clear the last error
  18785. uint64_t err = static_cast<uint64_t>(-impl::mbedtls_last_error());
  18786. impl::mbedtls_last_error() = 0;
  18787. return err;
  18788. }
  18789. inline std::string error_string(uint64_t code) {
  18790. char buf[256];
  18791. mbedtls_strerror(-static_cast<int>(code), buf, sizeof(buf));
  18792. return std::string(buf);
  18793. }
  18794. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  18795. #ifdef CPPHTTPLIB_MBEDTLS_V4
  18796. // Parsing certificates needs PSA Crypto, and no context may exist yet
  18797. if (!detail::ensure_mbedtls_psa_crypto()) { return nullptr; }
  18798. #endif
  18799. if (!pem) { return nullptr; }
  18800. // mbedtls_x509_crt_parse expects null-terminated PEM
  18801. std::string pem_str(pem, len);
  18802. auto *ca_chain = new (std::nothrow) mbedtls_x509_crt;
  18803. if (!ca_chain) { return nullptr; }
  18804. mbedtls_x509_crt_init(ca_chain);
  18805. auto ret = mbedtls_x509_crt_parse(
  18806. ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  18807. pem_str.size() + 1);
  18808. if (ret != 0) {
  18809. mbedtls_x509_crt_free(ca_chain);
  18810. delete ca_chain;
  18811. return nullptr;
  18812. }
  18813. return static_cast<ca_store_t>(ca_chain);
  18814. }
  18815. inline void free_ca_store(ca_store_t store) {
  18816. if (store) {
  18817. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18818. mbedtls_x509_crt_free(ca_chain);
  18819. delete ca_chain;
  18820. }
  18821. }
  18822. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  18823. if (!ctx || !store) { return false; }
  18824. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18825. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18826. // Free existing CA chain
  18827. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  18828. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  18829. // Copy the CA chain (deep copy)
  18830. // Parse from the raw data of the source cert
  18831. mbedtls_x509_crt *src = ca_chain;
  18832. while (src != nullptr) {
  18833. int ret = mbedtls_x509_crt_parse_der(&mbed_ctx->ca_chain, src->raw.p,
  18834. src->raw.len);
  18835. if (ret != 0) {
  18836. free_ca_store(store);
  18837. return false;
  18838. }
  18839. src = src->next;
  18840. }
  18841. // This function takes ownership of the store; the chain was deep-copied
  18842. // above, so release the source
  18843. free_ca_store(store);
  18844. // Update the SSL config to use the new CA chain
  18845. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18846. return true;
  18847. }
  18848. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  18849. certs.clear();
  18850. if (!ctx) { return 0; }
  18851. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18852. // Owned by the context; see free_cert()
  18853. for (auto cert = &mbed_ctx->ca_chain; cert && cert->raw.len > 0;
  18854. cert = cert->next) {
  18855. certs.push_back(static_cast<cert_t>(cert));
  18856. }
  18857. return certs.size();
  18858. }
  18859. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  18860. std::vector<std::string> names;
  18861. if (!ctx) { return names; }
  18862. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18863. // Iterate through the CA chain
  18864. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  18865. while (cert != nullptr && cert->raw.len > 0) {
  18866. char buf[512];
  18867. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &cert->subject);
  18868. if (ret > 0) { names.push_back(buf); }
  18869. cert = cert->next;
  18870. }
  18871. return names;
  18872. }
  18873. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  18874. const char *key_pem, const char *password) {
  18875. if (!ctx || !cert_pem || !key_pem) { return false; }
  18876. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18877. // Parse into new objects first, so that a bad pair leaves the old one in
  18878. // place, and swap them in after; the old ones are freed on the way out.
  18879. mbedtls_x509_crt cert;
  18880. mbedtls_pk_context key;
  18881. mbedtls_x509_crt_init(&cert);
  18882. mbedtls_pk_init(&key);
  18883. auto se = detail::scope_exit([&] {
  18884. mbedtls_x509_crt_free(&cert);
  18885. mbedtls_pk_free(&key);
  18886. });
  18887. // Parse certificate PEM
  18888. int ret = mbedtls_x509_crt_parse(
  18889. &cert, reinterpret_cast<const unsigned char *>(cert_pem),
  18890. strlen(cert_pem) + 1);
  18891. if (ret != 0) {
  18892. impl::mbedtls_last_error() = ret;
  18893. return false;
  18894. }
  18895. // Parse private key PEM
  18896. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18897. ret = mbedtls_pk_parse_key(
  18898. &key, reinterpret_cast<const unsigned char *>(key_pem),
  18899. strlen(key_pem) + 1,
  18900. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18901. password ? strlen(password) : 0, mbedtls_ctr_drbg_random,
  18902. &mbed_ctx->ctr_drbg);
  18903. #else
  18904. ret = mbedtls_pk_parse_key(
  18905. &key, reinterpret_cast<const unsigned char *>(key_pem),
  18906. strlen(key_pem) + 1,
  18907. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18908. password ? strlen(password) : 0);
  18909. #endif
  18910. if (ret != 0) {
  18911. impl::mbedtls_last_error() = ret;
  18912. return false;
  18913. }
  18914. std::swap(mbed_ctx->own_cert, cert);
  18915. std::swap(mbed_ctx->own_key, key);
  18916. // Configure SSL to use the new certificate and key
  18917. ret = mbedtls_ssl_conf_own_cert(&mbed_ctx->conf, &mbed_ctx->own_cert,
  18918. &mbed_ctx->own_key);
  18919. if (ret != 0) {
  18920. impl::mbedtls_last_error() = ret;
  18921. return false;
  18922. }
  18923. return true;
  18924. }
  18925. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  18926. if (!ctx || !ca_pem) { return false; }
  18927. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18928. // Parse into a new chain first, so that a bad one leaves the old in place
  18929. mbedtls_x509_crt chain;
  18930. mbedtls_x509_crt_init(&chain);
  18931. auto se = detail::scope_exit([&] { mbedtls_x509_crt_free(&chain); });
  18932. // Parse CA PEM
  18933. int ret = mbedtls_x509_crt_parse(
  18934. &chain, reinterpret_cast<const unsigned char *>(ca_pem),
  18935. strlen(ca_pem) + 1);
  18936. if (ret != 0) {
  18937. impl::mbedtls_last_error() = ret;
  18938. return false;
  18939. }
  18940. std::swap(mbed_ctx->ca_chain, chain);
  18941. // Update SSL config to use new CA chain
  18942. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18943. return true;
  18944. }
  18945. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  18946. if (!ctx) { return false; }
  18947. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18948. // create_session() hands each session its own copy to run.
  18949. mbed_ctx->verify_callback = std::move(callback);
  18950. impl::apply_verify_mode(*mbed_ctx);
  18951. return true;
  18952. }
  18953. inline long get_verify_error(const_session_t session) {
  18954. if (!session) { return -1; }
  18955. auto *msession =
  18956. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18957. return static_cast<long>(mbedtls_ssl_get_verify_result(&msession->ssl));
  18958. }
  18959. inline std::string verify_error_string(long error_code) {
  18960. if (error_code == 0) { return ""; }
  18961. char buf[256];
  18962. mbedtls_x509_crt_verify_info(buf, sizeof(buf), "",
  18963. static_cast<uint32_t>(error_code));
  18964. // Remove trailing newline if present
  18965. std::string result(buf);
  18966. while (!result.empty() && (result.back() == '\n' || result.back() == ' ')) {
  18967. result.pop_back();
  18968. }
  18969. return result;
  18970. }
  18971. } // namespace tls
  18972. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  18973. /*
  18974. * Group 10: TLS abstraction layer - wolfSSL backend
  18975. */
  18976. /*
  18977. * wolfSSL Backend Implementation
  18978. */
  18979. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  18980. namespace tls {
  18981. namespace impl {
  18982. // wolfSSL session wrapper
  18983. struct WolfSSLSession {
  18984. WOLFSSL *ssl = nullptr;
  18985. socket_t sock = INVALID_SOCKET;
  18986. std::string hostname; // For client: set via set_sni
  18987. std::string sni_hostname; // For server: received from client via SNI callback
  18988. WolfSSLSession() = default;
  18989. ~WolfSSLSession() {
  18990. if (ssl) { wolfSSL_free(ssl); }
  18991. }
  18992. WolfSSLSession(const WolfSSLSession &) = delete;
  18993. WolfSSLSession &operator=(const WolfSSLSession &) = delete;
  18994. };
  18995. // Thread-local error code accessor for wolfSSL
  18996. inline uint64_t &wolfssl_last_error() {
  18997. static thread_local uint64_t err = 0;
  18998. return err;
  18999. }
  19000. // Helper to map wolfSSL error to ErrorCode.
  19001. // ssl_error is the value from wolfSSL_get_error().
  19002. // raw_ret is the raw return value from the wolfSSL call (for low-level error).
  19003. inline ErrorCode map_wolfssl_error(WOLFSSL *ssl, int ssl_error,
  19004. int &out_errno) {
  19005. switch (ssl_error) {
  19006. case SSL_ERROR_NONE: return ErrorCode::Success;
  19007. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  19008. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  19009. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  19010. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  19011. default:
  19012. if (ssl) {
  19013. // wolfSSL stores the low-level error code as a negative value.
  19014. // DOMAIN_NAME_MISMATCH (-322) indicates hostname verification failure.
  19015. int low_err = ssl_error; // wolfSSL_get_error returns the low-level code
  19016. if (low_err == DOMAIN_NAME_MISMATCH) {
  19017. return ErrorCode::HostnameMismatch;
  19018. }
  19019. // Check verify result to distinguish cert verification from generic SSL
  19020. // errors.
  19021. long vr = wolfSSL_get_verify_result(ssl);
  19022. if (vr != 0) { return ErrorCode::CertVerifyFailed; }
  19023. }
  19024. return ErrorCode::Fatal;
  19025. }
  19026. }
  19027. // WolfSSLContext constructor/destructor implementations
  19028. inline WolfSSLContext::WolfSSLContext() { wolfSSL_Init(); }
  19029. inline WolfSSLContext::~WolfSSLContext() {
  19030. if (ctx) { wolfSSL_CTX_free(ctx); }
  19031. }
  19032. // Thread-local storage for SNI captured during handshake
  19033. inline std::string &wolfssl_pending_sni() {
  19034. static thread_local std::string sni;
  19035. return sni;
  19036. }
  19037. // SNI callback for wolfSSL server to capture client's SNI hostname
  19038. inline int wolfssl_sni_callback(WOLFSSL *ssl, int *ret, void *exArg) {
  19039. (void)ret;
  19040. (void)exArg;
  19041. void *name_data = nullptr;
  19042. unsigned short name_len =
  19043. wolfSSL_SNI_GetRequest(ssl, WOLFSSL_SNI_HOST_NAME, &name_data);
  19044. if (name_data && name_len > 0) {
  19045. wolfssl_pending_sni().assign(static_cast<const char *>(name_data),
  19046. name_len);
  19047. } else {
  19048. wolfssl_pending_sni().clear();
  19049. }
  19050. return 0; // Continue regardless
  19051. }
  19052. // The WOLFSSL_CTX points back to its WolfSSLContext, so a handshake only ever
  19053. // runs the verify callback of its own context.
  19054. inline int context_ex_data_index() {
  19055. static const auto index =
  19056. wolfSSL_CTX_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  19057. return index;
  19058. }
  19059. // Each WOLFSSL points back to its WolfSSLSession, the session_t that every
  19060. // other tls:: function takes.
  19061. inline int session_ex_data_index() {
  19062. static const auto index =
  19063. wolfSSL_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  19064. return index;
  19065. }
  19066. // A resumed session skips the client's certificate, so a server that checks
  19067. // one would let in a certificate checked against another server's CA, as
  19068. // wolfSSL shares its session cache between contexts, or against a CA since
  19069. // replaced by update_server_client_ca().
  19070. inline void disable_server_resumption(WolfSSLContext *wctx) {
  19071. if (!wctx->is_server) { return; }
  19072. wolfSSL_CTX_set_session_cache_mode(wctx->ctx, WOLFSSL_SESS_CACHE_OFF);
  19073. #ifdef HAVE_SESSION_TICKET
  19074. wolfSSL_CTX_NoTicketTLSv12(wctx->ctx);
  19075. #endif
  19076. }
  19077. // wolfSSL verify callback wrapper
  19078. inline int wolfssl_verify_callback(int preverify_ok,
  19079. WOLFSSL_X509_STORE_CTX *x509_ctx) {
  19080. // Get the WOLFSSL object from the X509_STORE_CTX
  19081. WOLFSSL *ssl = static_cast<WOLFSSL *>(wolfSSL_X509_STORE_CTX_get_ex_data(
  19082. x509_ctx, wolfSSL_get_ex_data_X509_STORE_CTX_idx()));
  19083. if (!ssl) { return preverify_ok; }
  19084. auto wctx = static_cast<WolfSSLContext *>(wolfSSL_CTX_get_ex_data(
  19085. wolfSSL_get_SSL_CTX(ssl), context_ex_data_index()));
  19086. if (!wctx) { return preverify_ok; }
  19087. std::shared_ptr<VerifyCallback> callback;
  19088. {
  19089. std::lock_guard<std::mutex> guard(verify_callback_mutex());
  19090. callback = wctx->verify_callback;
  19091. }
  19092. if (!callback) { return preverify_ok; }
  19093. WOLFSSL_X509 *cert = wolfSSL_X509_STORE_CTX_get_current_cert(x509_ctx);
  19094. int depth = wolfSSL_X509_STORE_CTX_get_error_depth(x509_ctx);
  19095. int err = wolfSSL_X509_STORE_CTX_get_error(x509_ctx);
  19096. VerifyContext verify_ctx;
  19097. verify_ctx.session = wolfSSL_get_ex_data(ssl, session_ex_data_index());
  19098. verify_ctx.cert = static_cast<cert_t>(cert);
  19099. verify_ctx.depth = depth;
  19100. verify_ctx.preverify_ok = (preverify_ok != 0);
  19101. verify_ctx.error_code = static_cast<long>(err);
  19102. if (err != 0) {
  19103. verify_ctx.error_string = wolfSSL_X509_verify_cert_error_string(err);
  19104. } else {
  19105. verify_ctx.error_string = nullptr;
  19106. }
  19107. auto accepted = run_verify_callback(*callback, verify_ctx);
  19108. // A client verifying the server during the handshake, which is what
  19109. // set_verify_client(ctx, true) asks for there, keeps the built-in verdict
  19110. if (!wolfSSL_is_server(ssl) &&
  19111. (wolfSSL_get_verify_mode(ssl) & WOLFSSL_VERIFY_FAIL_IF_NO_PEER_CERT)) {
  19112. accepted = accepted && preverify_ok;
  19113. }
  19114. return accepted ? 1 : 0;
  19115. }
  19116. // Sets the verify mode from whether the peer's certificate is required and
  19117. // whether a verify callback is set.
  19118. inline void apply_verify_mode(WolfSSLContext &wctx) {
  19119. auto has_callback = static_cast<bool>(wctx.verify_callback);
  19120. if (wctx.verify_client || has_callback) { disable_server_resumption(&wctx); }
  19121. auto mode = wctx.verify_client
  19122. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  19123. : (has_callback ? SSL_VERIFY_PEER : SSL_VERIFY_NONE);
  19124. wolfSSL_CTX_set_verify(wctx.ctx, mode,
  19125. has_callback ? wolfssl_verify_callback : nullptr);
  19126. }
  19127. inline void set_wolfssl_password_cb(WOLFSSL_CTX *ctx, const char *password) {
  19128. wolfSSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char *>(password));
  19129. wolfSSL_CTX_set_default_passwd_cb(
  19130. ctx, [](char *buf, int size, int /*rwflag*/, void *userdata) -> int {
  19131. auto *pwd = static_cast<const char *>(userdata);
  19132. if (!pwd) return 0;
  19133. auto len = static_cast<int>(strlen(pwd));
  19134. if (len > size) len = size;
  19135. memcpy(buf, pwd, static_cast<size_t>(len));
  19136. return len;
  19137. });
  19138. }
  19139. } // namespace impl
  19140. inline ctx_t create_client_context() {
  19141. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  19142. if (!ctx) { return nullptr; }
  19143. ctx->is_server = false;
  19144. WOLFSSL_METHOD *method = wolfTLSv1_2_client_method();
  19145. if (!method) {
  19146. delete ctx;
  19147. return nullptr;
  19148. }
  19149. ctx->ctx = wolfSSL_CTX_new(method);
  19150. if (!ctx->ctx ||
  19151. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  19152. WOLFSSL_SUCCESS) {
  19153. delete ctx;
  19154. return nullptr;
  19155. }
  19156. // Default: verify peer certificate
  19157. ctx->verify_client = true;
  19158. impl::apply_verify_mode(*ctx);
  19159. return static_cast<ctx_t>(ctx);
  19160. }
  19161. inline ctx_t create_server_context() {
  19162. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  19163. if (!ctx) { return nullptr; }
  19164. ctx->is_server = true;
  19165. WOLFSSL_METHOD *method = wolfTLSv1_2_server_method();
  19166. if (!method) {
  19167. delete ctx;
  19168. return nullptr;
  19169. }
  19170. ctx->ctx = wolfSSL_CTX_new(method);
  19171. if (!ctx->ctx ||
  19172. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  19173. WOLFSSL_SUCCESS) {
  19174. delete ctx;
  19175. return nullptr;
  19176. }
  19177. // Default: don't verify client
  19178. impl::apply_verify_mode(*ctx);
  19179. // Enable SNI on server
  19180. wolfSSL_CTX_SNI_SetOptions(ctx->ctx, WOLFSSL_SNI_HOST_NAME,
  19181. WOLFSSL_SNI_CONTINUE_ON_MISMATCH);
  19182. wolfSSL_CTX_set_servername_callback(ctx->ctx, impl::wolfssl_sni_callback);
  19183. return static_cast<ctx_t>(ctx);
  19184. }
  19185. inline void free_context(ctx_t ctx) {
  19186. if (ctx) { delete static_cast<impl::WolfSSLContext *>(ctx); }
  19187. }
  19188. inline bool set_min_version(ctx_t ctx, Version version) {
  19189. if (!ctx) { return false; }
  19190. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19191. int min_ver = WOLFSSL_TLSV1_2;
  19192. if (version >= Version::TLS1_3) { min_ver = WOLFSSL_TLSV1_3; }
  19193. return wolfSSL_CTX_SetMinVersion(wctx->ctx, min_ver) == WOLFSSL_SUCCESS;
  19194. }
  19195. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  19196. if (!ctx || !pem) { return false; }
  19197. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19198. int ret = wolfSSL_CTX_load_verify_buffer(
  19199. wctx->ctx, reinterpret_cast<const unsigned char *>(pem),
  19200. static_cast<long>(len), 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. wctx->ca_pem_data_.append(pem, len);
  19207. return true;
  19208. }
  19209. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  19210. if (!ctx || !file_path) { return false; }
  19211. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19212. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, file_path, nullptr);
  19213. if (ret != SSL_SUCCESS) {
  19214. impl::wolfssl_last_error() =
  19215. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19216. return false;
  19217. }
  19218. return true;
  19219. }
  19220. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  19221. if (!ctx || !dir_path) { return false; }
  19222. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19223. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, dir_path);
  19224. // wolfSSL may fail if the directory doesn't contain properly hashed certs.
  19225. // Unlike OpenSSL which lazily loads certs from directories, wolfSSL scans
  19226. // immediately. Return true even on failure since the CA file may have
  19227. // already been loaded, matching OpenSSL's lenient behavior.
  19228. (void)ret;
  19229. return true;
  19230. }
  19231. inline bool load_system_certs(ctx_t ctx) {
  19232. if (!ctx) { return false; }
  19233. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19234. bool loaded = false;
  19235. #ifdef _WIN32
  19236. loaded = impl::enumerate_windows_system_certs(
  19237. [&](const unsigned char *data, size_t len) {
  19238. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  19239. static_cast<long>(len),
  19240. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  19241. });
  19242. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  19243. loaded = impl::enumerate_macos_keychain_certs(
  19244. [&](const unsigned char *data, size_t len) {
  19245. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  19246. static_cast<long>(len),
  19247. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  19248. });
  19249. #else
  19250. for (auto path = impl::system_ca_paths(); *path; ++path) {
  19251. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, *path, nullptr) ==
  19252. SSL_SUCCESS) {
  19253. loaded = true;
  19254. break;
  19255. }
  19256. }
  19257. if (!loaded) {
  19258. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  19259. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, *dir) ==
  19260. SSL_SUCCESS) {
  19261. loaded = true;
  19262. break;
  19263. }
  19264. }
  19265. }
  19266. #endif
  19267. return loaded;
  19268. }
  19269. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  19270. const char *password) {
  19271. if (!ctx || !cert || !key) { return false; }
  19272. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19273. // Load certificate
  19274. int ret = wolfSSL_CTX_use_certificate_buffer(
  19275. wctx->ctx, reinterpret_cast<const unsigned char *>(cert),
  19276. static_cast<long>(strlen(cert)), SSL_FILETYPE_PEM);
  19277. if (ret != SSL_SUCCESS) {
  19278. impl::wolfssl_last_error() =
  19279. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19280. return false;
  19281. }
  19282. // Set password callback if password is provided
  19283. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19284. // Load private key
  19285. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  19286. wctx->ctx, reinterpret_cast<const unsigned char *>(key),
  19287. static_cast<long>(strlen(key)), SSL_FILETYPE_PEM);
  19288. if (ret != SSL_SUCCESS) {
  19289. impl::wolfssl_last_error() =
  19290. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19291. return false;
  19292. }
  19293. // Verify that the certificate and private key match
  19294. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  19295. }
  19296. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  19297. const char *key_path, const char *password) {
  19298. if (!ctx || !cert_path || !key_path) { return false; }
  19299. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19300. // Load certificate file
  19301. int ret =
  19302. wolfSSL_CTX_use_certificate_file(wctx->ctx, cert_path, SSL_FILETYPE_PEM);
  19303. if (ret != SSL_SUCCESS) {
  19304. impl::wolfssl_last_error() =
  19305. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19306. return false;
  19307. }
  19308. // Set password callback if password is provided
  19309. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19310. // Load private key file
  19311. ret = wolfSSL_CTX_use_PrivateKey_file(wctx->ctx, key_path, SSL_FILETYPE_PEM);
  19312. if (ret != SSL_SUCCESS) {
  19313. impl::wolfssl_last_error() =
  19314. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19315. return false;
  19316. }
  19317. // Verify that the certificate and private key match
  19318. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  19319. }
  19320. inline void set_verify_client(ctx_t ctx, bool require) {
  19321. if (!ctx) { return; }
  19322. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19323. wctx->verify_client = require;
  19324. impl::apply_verify_mode(*wctx);
  19325. }
  19326. inline session_t create_session(ctx_t ctx, socket_t sock) {
  19327. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  19328. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19329. auto session = new (std::nothrow) impl::WolfSSLSession();
  19330. if (!session) { return nullptr; }
  19331. session->sock = sock;
  19332. session->ssl = wolfSSL_new(wctx->ctx);
  19333. if (!session->ssl) {
  19334. impl::wolfssl_last_error() =
  19335. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19336. delete session;
  19337. return nullptr;
  19338. }
  19339. if (wolfSSL_set_ex_data(session->ssl, impl::session_ex_data_index(),
  19340. session) != WOLFSSL_SUCCESS) {
  19341. delete session;
  19342. return nullptr;
  19343. }
  19344. wolfSSL_set_fd(session->ssl, static_cast<int>(sock));
  19345. return static_cast<session_t>(session);
  19346. }
  19347. inline void free_session(session_t session) {
  19348. if (session) { delete static_cast<impl::WolfSSLSession *>(session); }
  19349. }
  19350. inline bool set_sni(session_t session, const char *hostname,
  19351. bool verify_hostname) {
  19352. if (!session || !hostname) { return false; }
  19353. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19354. int ret = wolfSSL_UseSNI(wsession->ssl, WOLFSSL_SNI_HOST_NAME, hostname,
  19355. static_cast<word16>(strlen(hostname)));
  19356. if (ret != WOLFSSL_SUCCESS) {
  19357. impl::wolfssl_last_error() =
  19358. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19359. return false;
  19360. }
  19361. // wolfSSL_check_domain_name binds identity checking to the handshake,
  19362. // separately from the SNI extension sent above; skip it when hostname
  19363. // verification is disabled so only the chain is checked, matching OpenSSL.
  19364. if (verify_hostname) { wolfSSL_check_domain_name(wsession->ssl, hostname); }
  19365. wsession->hostname = hostname;
  19366. return true;
  19367. }
  19368. inline TlsError connect(session_t session) {
  19369. TlsError err;
  19370. if (!session) {
  19371. err.code = ErrorCode::Fatal;
  19372. return err;
  19373. }
  19374. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19375. int ret = wolfSSL_connect(wsession->ssl);
  19376. if (ret == SSL_SUCCESS) {
  19377. err.code = ErrorCode::Success;
  19378. } else {
  19379. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19380. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19381. err.backend_code = static_cast<uint64_t>(ssl_error);
  19382. impl::wolfssl_last_error() = err.backend_code;
  19383. }
  19384. return err;
  19385. }
  19386. inline TlsError accept(session_t session) {
  19387. TlsError err;
  19388. if (!session) {
  19389. err.code = ErrorCode::Fatal;
  19390. return err;
  19391. }
  19392. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19393. int ret = wolfSSL_accept(wsession->ssl);
  19394. if (ret == SSL_SUCCESS) {
  19395. err.code = ErrorCode::Success;
  19396. // Capture SNI from thread-local storage after successful handshake
  19397. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  19398. impl::wolfssl_pending_sni().clear();
  19399. } else {
  19400. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19401. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19402. err.backend_code = static_cast<uint64_t>(ssl_error);
  19403. impl::wolfssl_last_error() = err.backend_code;
  19404. }
  19405. return err;
  19406. }
  19407. inline bool connect_nonblocking(session_t session, socket_t sock,
  19408. time_t timeout_sec, time_t timeout_usec,
  19409. TlsError *err) {
  19410. if (!session) {
  19411. if (err) { err->code = ErrorCode::Fatal; }
  19412. return false;
  19413. }
  19414. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19415. // Set socket to non-blocking mode
  19416. detail::set_nonblocking(sock, true);
  19417. auto cleanup =
  19418. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19419. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  19420. int ret;
  19421. while ((ret = wolfSSL_connect(wsession->ssl)) != SSL_SUCCESS) {
  19422. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19423. if (ssl_error == SSL_ERROR_WANT_READ) {
  19424. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  19425. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  19426. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  19427. }
  19428. // Error or timeout
  19429. if (err) {
  19430. err->code =
  19431. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  19432. err->backend_code = static_cast<uint64_t>(ssl_error);
  19433. }
  19434. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  19435. return false;
  19436. }
  19437. if (err) { err->code = ErrorCode::Success; }
  19438. return true;
  19439. }
  19440. inline bool accept_nonblocking(session_t session, socket_t sock,
  19441. time_t timeout_sec, time_t timeout_usec,
  19442. TlsError *err) {
  19443. if (!session) {
  19444. if (err) { err->code = ErrorCode::Fatal; }
  19445. return false;
  19446. }
  19447. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19448. // Set socket to non-blocking mode
  19449. detail::set_nonblocking(sock, true);
  19450. auto cleanup =
  19451. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19452. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  19453. int ret;
  19454. while ((ret = wolfSSL_accept(wsession->ssl)) != SSL_SUCCESS) {
  19455. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19456. if (ssl_error == SSL_ERROR_WANT_READ) {
  19457. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  19458. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  19459. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  19460. }
  19461. // Error or timeout
  19462. if (err) {
  19463. err->code =
  19464. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  19465. err->backend_code = static_cast<uint64_t>(ssl_error);
  19466. }
  19467. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  19468. return false;
  19469. }
  19470. if (err) { err->code = ErrorCode::Success; }
  19471. // Capture SNI from thread-local storage after successful handshake
  19472. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  19473. impl::wolfssl_pending_sni().clear();
  19474. return true;
  19475. }
  19476. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  19477. if (!session || !buf) {
  19478. err.code = ErrorCode::Fatal;
  19479. return -1;
  19480. }
  19481. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19482. int ret = wolfSSL_read(wsession->ssl, buf, static_cast<int>(len));
  19483. if (ret > 0) {
  19484. err.code = ErrorCode::Success;
  19485. return static_cast<ssize_t>(ret);
  19486. }
  19487. if (ret == 0) {
  19488. err.code = ErrorCode::PeerClosed;
  19489. return 0;
  19490. }
  19491. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19492. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19493. err.backend_code = static_cast<uint64_t>(ssl_error);
  19494. impl::wolfssl_last_error() = err.backend_code;
  19495. return -1;
  19496. }
  19497. inline ssize_t write(session_t session, const void *buf, size_t len,
  19498. TlsError &err) {
  19499. if (!session || !buf) {
  19500. err.code = ErrorCode::Fatal;
  19501. return -1;
  19502. }
  19503. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19504. int ret = wolfSSL_write(wsession->ssl, buf, static_cast<int>(len));
  19505. if (ret > 0) {
  19506. err.code = ErrorCode::Success;
  19507. return static_cast<ssize_t>(ret);
  19508. }
  19509. // wolfSSL_write returns 0 when the peer has sent a close_notify.
  19510. // Treat this as an error (return -1) so callers don't spin in a
  19511. // write loop adding zero to the offset.
  19512. if (ret == 0) {
  19513. err.code = ErrorCode::PeerClosed;
  19514. return -1;
  19515. }
  19516. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19517. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19518. err.backend_code = static_cast<uint64_t>(ssl_error);
  19519. impl::wolfssl_last_error() = err.backend_code;
  19520. return -1;
  19521. }
  19522. inline int pending(const_session_t session) {
  19523. if (!session) { return 0; }
  19524. auto wsession =
  19525. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19526. return wolfSSL_pending(wsession->ssl);
  19527. }
  19528. inline void shutdown(session_t session, bool graceful) {
  19529. if (!session) { return; }
  19530. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19531. if (graceful) {
  19532. int ret;
  19533. int attempts = 0;
  19534. while ((ret = wolfSSL_shutdown(wsession->ssl)) != SSL_SUCCESS &&
  19535. attempts < 3) {
  19536. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19537. if (ssl_error != SSL_ERROR_WANT_READ &&
  19538. ssl_error != SSL_ERROR_WANT_WRITE) {
  19539. break;
  19540. }
  19541. attempts++;
  19542. }
  19543. } else {
  19544. wolfSSL_shutdown(wsession->ssl);
  19545. }
  19546. }
  19547. inline bool is_peer_closed(session_t session, socket_t sock) {
  19548. if (!session || sock == INVALID_SOCKET) { return true; }
  19549. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19550. // Check if there's already decrypted data available
  19551. if (wolfSSL_pending(wsession->ssl) > 0) { return false; }
  19552. // Set socket to non-blocking to avoid blocking on read
  19553. detail::set_nonblocking(sock, true);
  19554. auto cleanup =
  19555. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19556. // Peek 1 byte to check connection status without consuming data
  19557. unsigned char buf;
  19558. int ret = wolfSSL_peek(wsession->ssl, &buf, 1);
  19559. // If we got data or WANT_READ (would block), connection is alive
  19560. if (ret > 0) { return false; }
  19561. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19562. if (ssl_error == SSL_ERROR_WANT_READ) { return false; }
  19563. return ssl_error == SSL_ERROR_ZERO_RETURN || ssl_error == SSL_ERROR_SYSCALL ||
  19564. ret == 0;
  19565. }
  19566. inline cert_t get_peer_cert(const_session_t session) {
  19567. if (!session) { return nullptr; }
  19568. auto wsession =
  19569. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19570. WOLFSSL_X509 *cert = wolfSSL_get_peer_certificate(wsession->ssl);
  19571. return static_cast<cert_t>(cert);
  19572. }
  19573. inline size_t get_peer_certs(const_session_t session,
  19574. std::vector<cert_t> &certs) {
  19575. certs.clear();
  19576. if (!session) { return 0; }
  19577. // wolfSSL keeps the received chain only when built with SESSION_CERTS
  19578. #ifdef SESSION_CERTS
  19579. auto wsession =
  19580. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19581. auto chain = wolfSSL_get_peer_chain(wsession->ssl);
  19582. auto count = chain ? wolfSSL_get_chain_count(chain) : 0;
  19583. for (int i = 0; i < count; i++) {
  19584. auto x509 = wolfSSL_get_chain_X509(chain, i);
  19585. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19586. }
  19587. #endif
  19588. return certs.size();
  19589. }
  19590. inline void free_cert(cert_t cert) {
  19591. if (cert) { wolfSSL_X509_free(static_cast<WOLFSSL_X509 *>(cert)); }
  19592. }
  19593. inline bool verify_hostname(cert_t cert, const char *hostname) {
  19594. if (!cert || !hostname) { return false; }
  19595. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19596. std::string host_str(hostname);
  19597. // Check if hostname is an IP address (IPv4 or IPv6)
  19598. unsigned char ip_bytes[16];
  19599. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  19600. auto is_ip = ip_len > 0;
  19601. // Check Subject Alternative Names
  19602. auto has_dns_san = false;
  19603. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  19604. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  19605. if (san_names) {
  19606. int san_count = wolfSSL_sk_num(san_names);
  19607. for (int i = 0; i < san_count; i++) {
  19608. auto *names =
  19609. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  19610. if (!names) continue;
  19611. if (!is_ip && names->type == WOLFSSL_GEN_DNS) {
  19612. // DNS name
  19613. has_dns_san = true;
  19614. unsigned char *dns_name = nullptr;
  19615. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, names->d.dNSName);
  19616. if (dns_name && dns_len > 0) {
  19617. std::string san_name(reinterpret_cast<char *>(dns_name),
  19618. static_cast<size_t>(dns_len));
  19619. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  19620. if (detail::match_hostname(san_name, host_str)) {
  19621. wolfSSL_sk_free(san_names);
  19622. return true;
  19623. }
  19624. }
  19625. } else if (is_ip && names->type == WOLFSSL_GEN_IPADD) {
  19626. // IP address: only an iPAddress SAN of the same family (4 bytes for
  19627. // IPv4, 16 bytes for IPv6) may authenticate the host.
  19628. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(names->d.iPAddress);
  19629. auto san_ip_len = wolfSSL_ASN1_STRING_length(names->d.iPAddress);
  19630. if (ip_data && san_ip_len == static_cast<int>(ip_len) &&
  19631. memcmp(ip_data, ip_bytes, ip_len) == 0) {
  19632. wolfSSL_sk_free(san_names);
  19633. return true;
  19634. }
  19635. }
  19636. }
  19637. wolfSSL_sk_free(san_names);
  19638. }
  19639. // Fallback: the Common Name (CN) in the subject, as X509_check_host does it:
  19640. // never for an IP host, which only an iPAddress SAN names, and never next to
  19641. // a DNS SAN (RFC 6125 6.4.4).
  19642. if (is_ip || has_dns_san) { return false; }
  19643. auto cn = get_cert_subject_cn(cert);
  19644. return !cn.empty() && detail::match_hostname(cn, host_str);
  19645. }
  19646. inline uint64_t hostname_mismatch_code() {
  19647. return static_cast<uint64_t>(DOMAIN_NAME_MISMATCH);
  19648. }
  19649. inline long get_verify_result(const_session_t session) {
  19650. if (!session) { return -1; }
  19651. auto wsession =
  19652. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19653. long result = wolfSSL_get_verify_result(wsession->ssl);
  19654. return result;
  19655. }
  19656. inline std::string get_cert_subject_cn(cert_t cert) {
  19657. if (!cert) return "";
  19658. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19659. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19660. if (!subject) return "";
  19661. char cn[256] = {};
  19662. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  19663. sizeof(cn));
  19664. if (cn_len <= 0) return "";
  19665. return std::string(cn, static_cast<size_t>(cn_len));
  19666. }
  19667. inline std::string get_cert_issuer_name(cert_t cert) {
  19668. if (!cert) return "";
  19669. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19670. WOLFSSL_X509_NAME *issuer = wolfSSL_X509_get_issuer_name(x509);
  19671. if (!issuer) return "";
  19672. char *name_str = wolfSSL_X509_NAME_oneline(issuer, nullptr, 0);
  19673. if (!name_str) return "";
  19674. std::string result(name_str);
  19675. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19676. return result;
  19677. }
  19678. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  19679. sans.clear();
  19680. if (!cert) return false;
  19681. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19682. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  19683. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  19684. if (!san_names) return true; // No SANs is not an error
  19685. int count = wolfSSL_sk_num(san_names);
  19686. for (int i = 0; i < count; i++) {
  19687. auto *name =
  19688. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  19689. if (!name) continue;
  19690. SanEntry entry;
  19691. switch (name->type) {
  19692. case WOLFSSL_GEN_DNS: {
  19693. entry.type = SanType::DNS;
  19694. unsigned char *dns_name = nullptr;
  19695. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, name->d.dNSName);
  19696. if (dns_name && dns_len > 0) {
  19697. entry.value = std::string(reinterpret_cast<char *>(dns_name),
  19698. static_cast<size_t>(dns_len));
  19699. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  19700. }
  19701. break;
  19702. }
  19703. case WOLFSSL_GEN_IPADD: {
  19704. entry.type = SanType::IP;
  19705. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(name->d.iPAddress);
  19706. int ip_len = wolfSSL_ASN1_STRING_length(name->d.iPAddress);
  19707. if (ip_data && ip_len == 4) {
  19708. char buf[16];
  19709. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", ip_data[0], ip_data[1],
  19710. ip_data[2], ip_data[3]);
  19711. entry.value = buf;
  19712. } else if (ip_data && ip_len == 16) {
  19713. char buf[64];
  19714. snprintf(buf, sizeof(buf),
  19715. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  19716. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  19717. ip_data[0], ip_data[1], ip_data[2], ip_data[3], ip_data[4],
  19718. ip_data[5], ip_data[6], ip_data[7], ip_data[8], ip_data[9],
  19719. ip_data[10], ip_data[11], ip_data[12], ip_data[13],
  19720. ip_data[14], ip_data[15]);
  19721. entry.value = buf;
  19722. }
  19723. break;
  19724. }
  19725. case WOLFSSL_GEN_EMAIL:
  19726. entry.type = SanType::EMAIL;
  19727. {
  19728. unsigned char *email = nullptr;
  19729. int email_len = wolfSSL_ASN1_STRING_to_UTF8(&email, name->d.rfc822Name);
  19730. if (email && email_len > 0) {
  19731. entry.value = std::string(reinterpret_cast<char *>(email),
  19732. static_cast<size_t>(email_len));
  19733. XFREE(email, nullptr, DYNAMIC_TYPE_OPENSSL);
  19734. }
  19735. }
  19736. break;
  19737. case WOLFSSL_GEN_URI:
  19738. entry.type = SanType::URI;
  19739. {
  19740. unsigned char *uri = nullptr;
  19741. int uri_len = wolfSSL_ASN1_STRING_to_UTF8(
  19742. &uri, name->d.uniformResourceIdentifier);
  19743. if (uri && uri_len > 0) {
  19744. entry.value = std::string(reinterpret_cast<char *>(uri),
  19745. static_cast<size_t>(uri_len));
  19746. XFREE(uri, nullptr, DYNAMIC_TYPE_OPENSSL);
  19747. }
  19748. }
  19749. break;
  19750. default: entry.type = SanType::OTHER; break;
  19751. }
  19752. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  19753. }
  19754. wolfSSL_sk_free(san_names);
  19755. return true;
  19756. }
  19757. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  19758. time_t &not_after) {
  19759. if (!cert) return false;
  19760. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19761. const WOLFSSL_ASN1_TIME *nb = wolfSSL_X509_get_notBefore(x509);
  19762. const WOLFSSL_ASN1_TIME *na = wolfSSL_X509_get_notAfter(x509);
  19763. if (!nb || !na) return false;
  19764. // wolfSSL_ASN1_TIME_to_tm is available
  19765. struct tm tm_nb = {}, tm_na = {};
  19766. if (wolfSSL_ASN1_TIME_to_tm(nb, &tm_nb) != WOLFSSL_SUCCESS) return false;
  19767. if (wolfSSL_ASN1_TIME_to_tm(na, &tm_na) != WOLFSSL_SUCCESS) return false;
  19768. #ifdef _WIN32
  19769. not_before = _mkgmtime(&tm_nb);
  19770. not_after = _mkgmtime(&tm_na);
  19771. #else
  19772. not_before = timegm(&tm_nb);
  19773. not_after = timegm(&tm_na);
  19774. #endif
  19775. return true;
  19776. }
  19777. inline std::string get_cert_serial(cert_t cert) {
  19778. if (!cert) return "";
  19779. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19780. WOLFSSL_ASN1_INTEGER *serial_asn1 = wolfSSL_X509_get_serialNumber(x509);
  19781. if (!serial_asn1) return "";
  19782. // Get the serial number data
  19783. int len = serial_asn1->length;
  19784. unsigned char *data = serial_asn1->data;
  19785. if (!data || len <= 0) return "";
  19786. std::string result;
  19787. result.reserve(static_cast<size_t>(len) * 2);
  19788. for (int i = 0; i < len; i++) {
  19789. char hex[3];
  19790. snprintf(hex, sizeof(hex), "%02X", data[i]);
  19791. result += hex;
  19792. }
  19793. return result;
  19794. }
  19795. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  19796. if (!cert) return false;
  19797. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19798. int der_len = 0;
  19799. const unsigned char *der_data = wolfSSL_X509_get_der(x509, &der_len);
  19800. if (!der_data || der_len <= 0) return false;
  19801. der.assign(der_data, der_data + der_len);
  19802. return true;
  19803. }
  19804. inline const char *get_sni(const_session_t session) {
  19805. if (!session) return nullptr;
  19806. auto wsession = static_cast<const impl::WolfSSLSession *>(session);
  19807. // For server: return SNI received from client during handshake
  19808. if (!wsession->sni_hostname.empty()) {
  19809. return wsession->sni_hostname.c_str();
  19810. }
  19811. // For client: return the hostname set via set_sni
  19812. if (!wsession->hostname.empty()) { return wsession->hostname.c_str(); }
  19813. return nullptr;
  19814. }
  19815. inline uint64_t peek_error() {
  19816. return static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19817. }
  19818. inline uint64_t get_error() {
  19819. uint64_t err = impl::wolfssl_last_error();
  19820. impl::wolfssl_last_error() = 0;
  19821. return err;
  19822. }
  19823. inline std::string error_string(uint64_t code) {
  19824. char buf[256];
  19825. wolfSSL_ERR_error_string(static_cast<unsigned long>(code), buf);
  19826. return std::string(buf);
  19827. }
  19828. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  19829. if (!pem || len == 0) { return nullptr; }
  19830. // Validate by attempting to load into a temporary ctx
  19831. WOLFSSL_CTX *tmp_ctx = wolfSSL_CTX_new(wolfTLSv1_2_client_method());
  19832. if (!tmp_ctx) { return nullptr; }
  19833. int ret = wolfSSL_CTX_load_verify_buffer(
  19834. tmp_ctx, reinterpret_cast<const unsigned char *>(pem),
  19835. static_cast<long>(len), SSL_FILETYPE_PEM);
  19836. wolfSSL_CTX_free(tmp_ctx);
  19837. if (ret != SSL_SUCCESS) { return nullptr; }
  19838. return static_cast<ca_store_t>(
  19839. new impl::WolfSSLCAStore{std::string(pem, len)});
  19840. }
  19841. inline void free_ca_store(ca_store_t store) {
  19842. delete static_cast<impl::WolfSSLCAStore *>(store);
  19843. }
  19844. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  19845. if (!ctx || !store) { return false; }
  19846. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19847. auto *ca = static_cast<impl::WolfSSLCAStore *>(store);
  19848. int ret = wolfSSL_CTX_load_verify_buffer(
  19849. wctx->ctx, reinterpret_cast<const unsigned char *>(ca->pem_data.data()),
  19850. static_cast<long>(ca->pem_data.size()), SSL_FILETYPE_PEM);
  19851. if (ret == SSL_SUCCESS) { wctx->ca_pem_data_ += ca->pem_data; }
  19852. // This function takes ownership of the store; the PEM data was copied into
  19853. // the context, so release the source
  19854. free_ca_store(store);
  19855. return ret == SSL_SUCCESS;
  19856. }
  19857. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  19858. certs.clear();
  19859. if (!ctx) { return 0; }
  19860. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19861. if (wctx->ca_pem_data_.empty()) { return 0; }
  19862. const std::string &pem = wctx->ca_pem_data_;
  19863. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19864. const std::string end_marker = "-----END CERTIFICATE-----";
  19865. size_t pos = 0;
  19866. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19867. size_t end_pos = pem.find(end_marker, pos);
  19868. if (end_pos == std::string::npos) { break; }
  19869. end_pos += end_marker.size();
  19870. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19871. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19872. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19873. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19874. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19875. pos = end_pos;
  19876. }
  19877. return certs.size();
  19878. }
  19879. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  19880. std::vector<std::string> names;
  19881. if (!ctx) { return names; }
  19882. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19883. if (wctx->ca_pem_data_.empty()) { return names; }
  19884. const std::string &pem = wctx->ca_pem_data_;
  19885. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19886. const std::string end_marker = "-----END CERTIFICATE-----";
  19887. size_t pos = 0;
  19888. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19889. size_t end_pos = pem.find(end_marker, pos);
  19890. if (end_pos == std::string::npos) { break; }
  19891. end_pos += end_marker.size();
  19892. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19893. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19894. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19895. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19896. if (x509) {
  19897. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19898. if (subject) {
  19899. char *name_str = wolfSSL_X509_NAME_oneline(subject, nullptr, 0);
  19900. if (name_str) {
  19901. names.push_back(name_str);
  19902. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19903. }
  19904. }
  19905. wolfSSL_X509_free(x509);
  19906. }
  19907. pos = end_pos;
  19908. }
  19909. return names;
  19910. }
  19911. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  19912. const char *key_pem, const char *password) {
  19913. if (!ctx || !cert_pem || !key_pem) { return false; }
  19914. // Try the pair on a scratch context first, so that a bad one leaves the
  19915. // server's certificate and key as they were
  19916. auto tmp = create_server_context();
  19917. if (!tmp) { return false; }
  19918. auto se = detail::scope_exit([&] { free_context(tmp); });
  19919. if (!set_client_cert_pem(tmp, cert_pem, key_pem, password)) { return false; }
  19920. return set_client_cert_pem(ctx, cert_pem, key_pem, password);
  19921. }
  19922. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  19923. if (!ctx || !ca_pem) { return false; }
  19924. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19925. // Replace the CAs rather than add to them, as the other backends do, once
  19926. // the new ones are known to load
  19927. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  19928. if (!store) { return false; }
  19929. free_ca_store(store);
  19930. wolfSSL_CTX_UnloadCAs(wctx->ctx);
  19931. wctx->ca_pem_data_.clear();
  19932. return load_ca_pem(ctx, ca_pem, strlen(ca_pem));
  19933. }
  19934. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  19935. if (!ctx) { return false; }
  19936. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19937. auto stored = callback ? std::make_shared<VerifyCallback>(std::move(callback))
  19938. : nullptr;
  19939. {
  19940. std::lock_guard<std::mutex> guard(impl::verify_callback_mutex());
  19941. // A handshake running the previous callback keeps it until it returns.
  19942. wctx->verify_callback.swap(stored);
  19943. }
  19944. impl::apply_verify_mode(*wctx);
  19945. return true;
  19946. }
  19947. inline long get_verify_error(const_session_t session) {
  19948. if (!session) { return -1; }
  19949. auto *wsession =
  19950. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19951. return wolfSSL_get_verify_result(wsession->ssl);
  19952. }
  19953. inline std::string verify_error_string(long error_code) {
  19954. if (error_code == 0) { return ""; }
  19955. const char *str =
  19956. wolfSSL_X509_verify_cert_error_string(static_cast<int>(error_code));
  19957. return str ? std::string(str) : std::string();
  19958. }
  19959. } // namespace tls
  19960. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  19961. // WebSocket implementation
  19962. namespace ws {
  19963. inline bool WebSocket::send_frame(Opcode op, const char *data, size_t len,
  19964. bool fin) {
  19965. std::lock_guard<std::mutex> lock(write_mutex_);
  19966. if (closed_) { return false; }
  19967. return detail::write_websocket_frame(strm_, op, data, len, fin, !is_server_);
  19968. }
  19969. inline ReadResult WebSocket::read(std::string &msg) {
  19970. // Answers a control frame; any other opcode here is a protocol error.
  19971. // Returns false when the connection is done.
  19972. auto handle_control = [&](Opcode op, const std::string &payload) -> bool {
  19973. switch (op) {
  19974. case Opcode::Ping: {
  19975. std::lock_guard<std::mutex> lock(write_mutex_);
  19976. detail::write_websocket_frame(strm_, Opcode::Pong, payload.data(),
  19977. payload.size(), true, !is_server_);
  19978. return true;
  19979. }
  19980. case Opcode::Pong: {
  19981. std::lock_guard<std::mutex> lock(ping_mutex_);
  19982. unacked_pings_ = 0;
  19983. return true;
  19984. }
  19985. case Opcode::Close: {
  19986. // RFC 6455 §5.5.1: a Close is echoed back, unless its payload is
  19987. // malformed, which is answered with a protocol error instead.
  19988. if (closed_.exchange(true)) { return false; }
  19989. auto reply = payload;
  19990. if (!impl::is_valid_close_payload(payload)) {
  19991. auto code = static_cast<uint16_t>(CloseStatus::ProtocolError);
  19992. reply = {static_cast<char>(code >> 8), static_cast<char>(code & 0xff)};
  19993. }
  19994. std::lock_guard<std::mutex> lock(write_mutex_);
  19995. detail::write_websocket_frame(strm_, Opcode::Close, reply.data(),
  19996. reply.size(), true, !is_server_);
  19997. return false;
  19998. }
  19999. default: closed_ = true; return false;
  20000. }
  20001. };
  20002. std::unique_lock<std::mutex> read_lock(read_mutex_);
  20003. while (!closed_) {
  20004. Opcode opcode;
  20005. std::string payload;
  20006. bool fin;
  20007. impl::FrameRead r =
  20008. impl::read_websocket_frame(strm_, opcode, payload, fin, is_server_,
  20009. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH);
  20010. // A timeout landed on a frame boundary of an open connection: it is
  20011. // untouched and still usable, so hand control back without closing it.
  20012. // That is only useful to a caller who asked for the timeout; the
  20013. // compile-time default is a backstop against a peer gone quiet, and
  20014. // elapsing it closes the connection so a plain `while (ws.read(msg))` loop
  20015. // ends. A wait that a pong timeout cut short finds the connection closed.
  20016. if (r == impl::FrameRead::Timeout && read_timeout_set_ && !closed_) {
  20017. return Timeout;
  20018. }
  20019. if (r != impl::FrameRead::Ok) {
  20020. closed_ = true;
  20021. return Fail;
  20022. }
  20023. switch (opcode) {
  20024. case Opcode::Text:
  20025. case Opcode::Binary: {
  20026. auto result = opcode == Opcode::Text ? Text : Binary;
  20027. msg = std::move(payload);
  20028. // Handle fragmentation
  20029. if (!fin) {
  20030. while (true) {
  20031. Opcode cont_opcode;
  20032. std::string cont_payload;
  20033. bool cont_fin;
  20034. // Only what is left of the limit, but room for a control frame,
  20035. // which may come between the fragments.
  20036. auto max_len =
  20037. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH == 0
  20038. ? size_t(0)
  20039. : (std::max)(size_t(125),
  20040. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH -
  20041. msg.size());
  20042. // A timeout is not reportable here: half of a fragmented message is
  20043. // already in `msg` and read() has no way to resume it, so it is a
  20044. // failure like any other. Timeouts are only ever seen on a message
  20045. // boundary.
  20046. if (impl::read_websocket_frame(strm_, cont_opcode, cont_payload,
  20047. cont_fin, is_server_,
  20048. max_len) != impl::FrameRead::Ok) {
  20049. closed_ = true;
  20050. return Fail;
  20051. }
  20052. // RFC 6455 5.4: the fragments are continuation frames, with only
  20053. // control frames between them.
  20054. if (cont_opcode != Opcode::Continuation) {
  20055. if (handle_control(cont_opcode, cont_payload)) { continue; }
  20056. return Fail;
  20057. }
  20058. msg += cont_payload;
  20059. if (CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH > 0 &&
  20060. msg.size() > CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) {
  20061. closed_ = true;
  20062. return Fail;
  20063. }
  20064. if (cont_fin) { break; }
  20065. }
  20066. }
  20067. // RFC 6455 Section 5.6: text frames must contain valid UTF-8
  20068. if (result == Text && !impl::is_valid_utf8(msg)) {
  20069. // close() takes the read lock to wait for the peer's Close reply, so
  20070. // it must not run while this thread still holds it.
  20071. read_lock.unlock();
  20072. close(CloseStatus::InvalidPayload, "invalid UTF-8");
  20073. return Fail;
  20074. }
  20075. return result;
  20076. }
  20077. default:
  20078. if (handle_control(opcode, payload)) { continue; }
  20079. return Fail;
  20080. }
  20081. }
  20082. return Fail;
  20083. }
  20084. inline bool WebSocket::send(const std::string &data) {
  20085. return send_frame(Opcode::Text, data.data(), data.size());
  20086. }
  20087. inline bool WebSocket::send(const char *data, size_t len) {
  20088. return send_frame(Opcode::Binary, data, len);
  20089. }
  20090. inline void WebSocket::close(CloseStatus status, const std::string &reason) {
  20091. if (closed_.exchange(true)) { return; }
  20092. ping_cv_.notify_all();
  20093. std::string payload;
  20094. auto code = static_cast<uint16_t>(status);
  20095. payload.push_back(static_cast<char>((code >> 8) & 0xFF));
  20096. payload.push_back(static_cast<char>(code & 0xFF));
  20097. // RFC 6455 Section 5.5: control frame payload must not exceed 125 bytes
  20098. // Close frame has 2-byte status code, so reason is limited to 123 bytes,
  20099. // cut back to a whole UTF-8 character
  20100. auto short_reason = reason.substr(0, 123);
  20101. while (!short_reason.empty() && !impl::is_valid_utf8(short_reason)) {
  20102. short_reason.pop_back();
  20103. }
  20104. payload += short_reason;
  20105. // A code that may not be sent, such as NoStatus, goes without a payload
  20106. if (!impl::is_valid_close_payload(payload)) { payload.clear(); }
  20107. {
  20108. std::lock_guard<std::mutex> lock(write_mutex_);
  20109. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  20110. payload.size(), true, !is_server_);
  20111. }
  20112. // RFC 6455 Section 7.1.1: after sending a Close frame, wait for the peer's
  20113. // Close response before closing the TCP connection.
  20114. //
  20115. // Wait only when no other thread is parsing frames. When one is, it is the
  20116. // thread positioned to see the peer's reply, and reading here would take
  20117. // bytes out of the message it is assembling. Bailing out also leaves the
  20118. // stream, including its read timeout, entirely to that thread.
  20119. std::unique_lock<std::mutex> read_lock(read_mutex_, std::try_to_lock);
  20120. if (!read_lock.owns_lock()) { return; }
  20121. // Use a short timeout to avoid hanging if the peer doesn't respond.
  20122. strm_.set_read_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  20123. Opcode op;
  20124. std::string resp;
  20125. bool fin;
  20126. while (impl::read_websocket_frame(strm_, op, resp, fin, is_server_, 125) ==
  20127. impl::FrameRead::Ok) {
  20128. if (op == Opcode::Close) { break; }
  20129. }
  20130. }
  20131. inline WebSocket::~WebSocket() {
  20132. {
  20133. std::lock_guard<std::mutex> lock(ping_mutex_);
  20134. closed_ = true;
  20135. }
  20136. ping_cv_.notify_all();
  20137. if (ping_thread_.joinable()) { ping_thread_.join(); }
  20138. // A server's stream outlives this object
  20139. strm_.set_read_interrupt(nullptr);
  20140. }
  20141. inline void WebSocket::start_heartbeat() {
  20142. if (ping_interval_sec_ <= 0) { return; }
  20143. // A pong timeout ends a read() blocked on the silent peer
  20144. if (max_missed_pongs_ > 0) {
  20145. strm_.set_read_interrupt([this] { return pong_timed_out_.load(); });
  20146. }
  20147. ping_thread_ = std::thread([this]() {
  20148. std::unique_lock<std::mutex> lock(ping_mutex_);
  20149. // The predicate keeps a spurious wakeup from sending a ping early
  20150. while (!ping_cv_.wait_for(lock, std::chrono::seconds(ping_interval_sec_),
  20151. [this]() { return closed_.load(); })) {
  20152. // If the peer has failed to respond to the previous pings, give up.
  20153. // RFC 6455 does not define a pong-timeout mechanism; this is an
  20154. // opt-in liveness check controlled by max_missed_pongs_.
  20155. if (max_missed_pongs_ > 0 && unacked_pings_ >= max_missed_pongs_) {
  20156. lock.unlock();
  20157. close(CloseStatus::GoingAway, "pong timeout");
  20158. pong_timed_out_ = true;
  20159. return;
  20160. }
  20161. lock.unlock();
  20162. if (!send_frame(Opcode::Ping, nullptr, 0)) {
  20163. lock.lock();
  20164. closed_ = true;
  20165. break;
  20166. }
  20167. lock.lock();
  20168. unacked_pings_++;
  20169. }
  20170. });
  20171. }
  20172. inline const Request &WebSocket::request() const { return req_; }
  20173. inline bool WebSocket::is_open() const { return !closed_; }
  20174. inline void WebSocket::set_read_timeout(time_t sec, time_t usec) {
  20175. // 0 waits forever here, as it does for SO_RCVTIMEO. The stream waits with
  20176. // poll(), where 0 would instead mean "return immediately", so hand it the
  20177. // negative poll uses for an unbounded wait.
  20178. if (sec == 0 && usec == 0) { sec = -1; }
  20179. strm_.set_read_timeout(sec, usec);
  20180. read_timeout_set_ = true;
  20181. }
  20182. // WebSocketClient implementation
  20183. inline WebSocketClient::WebSocketClient(
  20184. const std::string &scheme_host_port_path, const Headers &headers)
  20185. : headers_(headers) {
  20186. detail::UrlComponents uc;
  20187. if (detail::parse_url(scheme_host_port_path, uc) && !uc.scheme.empty() &&
  20188. !uc.host.empty() && !uc.path.empty()) {
  20189. auto &scheme = uc.scheme;
  20190. #ifdef CPPHTTPLIB_SSL_ENABLED
  20191. if (scheme != "ws" && scheme != "wss") {
  20192. #else
  20193. if (scheme != "ws") {
  20194. #endif
  20195. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  20196. std::string msg = "'" + scheme + "' scheme is not supported.";
  20197. throw std::invalid_argument(msg);
  20198. #endif
  20199. return;
  20200. }
  20201. auto is_ssl = scheme == "wss";
  20202. host_ = std::move(uc.host);
  20203. port_ = is_ssl ? 443 : 80;
  20204. if (!uc.port.empty() && !detail::parse_port(uc.port, port_)) { return; }
  20205. path_ = std::move(uc.path);
  20206. if (!uc.query.empty()) { path_ += uc.query; }
  20207. #ifdef CPPHTTPLIB_SSL_ENABLED
  20208. is_ssl_ = is_ssl;
  20209. if (is_ssl_) {
  20210. // The context lives as long as the client so that CA configuration
  20211. // survives reconnects; sessions are created per connection.
  20212. tls_ctx_ = tls::create_client_context();
  20213. if (!tls_ctx_) { return; }
  20214. }
  20215. #else
  20216. if (is_ssl) { return; }
  20217. #endif
  20218. is_valid_ = true;
  20219. }
  20220. }
  20221. #ifdef CPPHTTPLIB_SSL_ENABLED
  20222. inline WebSocketClient::WebSocketClient(
  20223. const std::string &scheme_host_port_path, const PemMemory &pem,
  20224. const Headers &headers)
  20225. : WebSocketClient(scheme_host_port_path, headers) {
  20226. // For ws:// URLs the client certificate is silently ignored, consistent
  20227. // with the TLS-only setters such as set_ca_cert_path().
  20228. if (is_valid_ && is_ssl_ && pem.cert_pem && pem.key_pem) {
  20229. std::string cert_buf, key_buf;
  20230. if (!tls::set_client_cert_pem(
  20231. tls_ctx_,
  20232. detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  20233. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  20234. pem.private_key_password)) {
  20235. tls::free_context(tls_ctx_);
  20236. tls_ctx_ = nullptr;
  20237. is_valid_ = false;
  20238. }
  20239. }
  20240. }
  20241. #endif
  20242. inline WebSocketClient::~WebSocketClient() {
  20243. shutdown_and_close();
  20244. #ifdef CPPHTTPLIB_SSL_ENABLED
  20245. if (tls_ctx_) {
  20246. tls::free_context(tls_ctx_);
  20247. tls_ctx_ = nullptr;
  20248. }
  20249. #endif
  20250. }
  20251. inline bool WebSocketClient::is_valid() const { return is_valid_; }
  20252. inline void WebSocketClient::shutdown_and_close() {
  20253. // Send the close frame while the TLS session is still alive: ws_ holds an
  20254. // SSLSocketStream that keeps a raw pointer to tls_session_, so the session
  20255. // must outlive ws_->close() and ws_.reset() to avoid a use-after-free.
  20256. if (ws_ && ws_->is_open()) { ws_->close(); }
  20257. ws_.reset();
  20258. #ifdef CPPHTTPLIB_SSL_ENABLED
  20259. if (is_ssl_) {
  20260. if (tls_session_) {
  20261. tls::shutdown(tls_session_, true);
  20262. tls::free_session(tls_session_);
  20263. tls_session_ = nullptr;
  20264. }
  20265. }
  20266. #endif
  20267. if (sock_ != INVALID_SOCKET) {
  20268. detail::shutdown_socket(sock_);
  20269. detail::close_socket(sock_);
  20270. sock_ = INVALID_SOCKET;
  20271. }
  20272. }
  20273. // The handshakes belong to establishing the connection, so an unset read
  20274. // timeout leaves them bounded by the connection timeout instead of forever.
  20275. inline std::pair<time_t, time_t> WebSocketClient::handshake_timeout() const {
  20276. if (read_timeout_sec_ == 0 && read_timeout_usec_ == 0) {
  20277. return {connection_timeout_sec_, connection_timeout_usec_};
  20278. }
  20279. return {read_timeout_sec_, read_timeout_usec_};
  20280. }
  20281. inline bool WebSocketClient::create_stream(std::unique_ptr<Stream> &strm,
  20282. Error &error, int &ssl_error,
  20283. uint64_t &ssl_backend_error) {
  20284. // A read timeout of 0 means "wait forever", the way SO_RCVTIMEO reads it.
  20285. // The streams wait with poll(), where 0 instead means "return immediately",
  20286. // so they are given the negative poll uses for an unbounded wait.
  20287. auto unbounded = read_timeout_sec_ == 0 && read_timeout_usec_ == 0;
  20288. time_t strm_read_sec = unbounded ? -1 : read_timeout_sec_;
  20289. time_t strm_read_usec = unbounded ? 0 : read_timeout_usec_;
  20290. #ifdef CPPHTTPLIB_SSL_ENABLED
  20291. if (is_ssl_) {
  20292. // A plain flag rather than SSLClient::load_certs()'s call_once: connect()
  20293. // is not safe to call concurrently on one client to begin with, since
  20294. // nothing else here is guarded either.
  20295. if (server_certificate_verification_ && !certs_loaded_) {
  20296. uint64_t backend_error = 0;
  20297. detail::load_client_ca_config(tls_ctx_, ca_cert_file_path_,
  20298. ca_cert_dir_path_, custom_ca_loaded_,
  20299. system_ca_mode_, backend_error);
  20300. certs_loaded_ = true;
  20301. }
  20302. detail::ClientTlsSessionOptions options;
  20303. options.server_hostname_verification = server_hostname_verification_;
  20304. options.session_verifier = session_verifier_;
  20305. auto timeout = handshake_timeout();
  20306. detail::ClientTlsSessionError tls_error;
  20307. if (!detail::setup_client_tls_session(host_, tls_ctx_, tls_session_, sock_,
  20308. server_certificate_verification_,
  20309. timeout.first, timeout.second,
  20310. &tls_error, options)) {
  20311. error = tls_error.error;
  20312. ssl_error = tls_error.ssl_error;
  20313. ssl_backend_error = tls_error.backend_error;
  20314. return false;
  20315. }
  20316. strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  20317. sock_, tls_session_, strm_read_sec, strm_read_usec, write_timeout_sec_,
  20318. write_timeout_usec_));
  20319. return true;
  20320. }
  20321. #else
  20322. (void)error;
  20323. (void)ssl_error;
  20324. (void)ssl_backend_error;
  20325. #endif
  20326. strm = std::unique_ptr<Stream>(
  20327. new detail::SocketStream(sock_, strm_read_sec, strm_read_usec,
  20328. write_timeout_sec_, write_timeout_usec_));
  20329. return true;
  20330. }
  20331. inline void WebSocketClient::prepare_default_headers(Request &req) {
  20332. #ifdef CPPHTTPLIB_SSL_ENABLED
  20333. auto is_ssl = is_ssl_;
  20334. #else
  20335. auto is_ssl = false;
  20336. #endif
  20337. if (!req.has_header("Host")) {
  20338. req.headers.emplace("Host", detail::make_default_host_header_value(
  20339. host_, port_, is_ssl, address_family_));
  20340. }
  20341. detail::add_default_user_agent_header(req);
  20342. }
  20343. inline Result WebSocketClient::connect() {
  20344. if (!is_valid_) { return Result{Error::Connection, -1, Headers{}}; }
  20345. shutdown_and_close();
  20346. auto error = Error::Success;
  20347. if (!create_and_connect_socket(error)) {
  20348. return Result{error, -1, Headers{}};
  20349. }
  20350. if (is_proxy_enabled()) {
  20351. Response proxy_res;
  20352. if (!connect_with_proxy(proxy_res, error)) {
  20353. shutdown_and_close();
  20354. return Result{error, proxy_res.status, std::move(proxy_res.headers)};
  20355. }
  20356. }
  20357. std::unique_ptr<Stream> strm;
  20358. auto stream_error = Error::SSLConnection;
  20359. int ssl_error = 0;
  20360. uint64_t ssl_backend_error = 0;
  20361. if (!create_stream(strm, stream_error, ssl_error, ssl_backend_error)) {
  20362. shutdown_and_close();
  20363. #ifdef CPPHTTPLIB_SSL_ENABLED
  20364. return Result{stream_error, -1, Headers{}, ssl_error, ssl_backend_error};
  20365. #else
  20366. return Result{stream_error, -1, Headers{}};
  20367. #endif
  20368. }
  20369. Request req;
  20370. req.method = "GET";
  20371. req.path = path_;
  20372. req.headers = headers_;
  20373. prepare_default_headers(req);
  20374. detail::WebSocketUpgradeResponse upgrade;
  20375. if (!detail::perform_websocket_handshake(*strm, req, upgrade)) {
  20376. shutdown_and_close();
  20377. return Result{upgrade.error, upgrade.status, std::move(upgrade.headers)};
  20378. }
  20379. subprotocol_ = std::move(upgrade.selected_subprotocol);
  20380. ws_ = std::unique_ptr<WebSocket>(new WebSocket(std::move(strm), req, false,
  20381. websocket_ping_interval_sec_,
  20382. websocket_max_missed_pongs_));
  20383. // The stream was created with the timeout already; tell the WebSocket
  20384. // whether it came from the caller, so read() knows to report it as Timeout.
  20385. ws_->read_timeout_set_ = read_timeout_set_;
  20386. return Result{Error::Success, upgrade.status, std::move(upgrade.headers)};
  20387. }
  20388. inline ReadResult WebSocketClient::read(std::string &msg) {
  20389. if (!ws_) { return Fail; }
  20390. return ws_->read(msg);
  20391. }
  20392. inline bool WebSocketClient::send(const std::string &data) {
  20393. if (!ws_) { return false; }
  20394. return ws_->send(data);
  20395. }
  20396. inline bool WebSocketClient::send(const char *data, size_t len) {
  20397. if (!ws_) { return false; }
  20398. return ws_->send(data, len);
  20399. }
  20400. inline void WebSocketClient::close(CloseStatus status,
  20401. const std::string &reason) {
  20402. if (ws_) { ws_->close(status, reason); }
  20403. }
  20404. inline bool WebSocketClient::is_open() const { return ws_ && ws_->is_open(); }
  20405. inline const std::string &WebSocketClient::subprotocol() const {
  20406. return subprotocol_;
  20407. }
  20408. inline void WebSocketClient::set_read_timeout(time_t sec, time_t usec) {
  20409. read_timeout_sec_ = sec;
  20410. read_timeout_usec_ = usec;
  20411. read_timeout_set_ = true;
  20412. // The members above only seed the next connect(); read() consults the
  20413. // stream, so an already-open connection has to be told directly.
  20414. if (ws_) { ws_->set_read_timeout(sec, usec); }
  20415. }
  20416. inline void WebSocketClient::set_write_timeout(time_t sec, time_t usec) {
  20417. write_timeout_sec_ = sec;
  20418. write_timeout_usec_ = usec;
  20419. }
  20420. inline void WebSocketClient::set_websocket_ping_interval(time_t sec) {
  20421. websocket_ping_interval_sec_ = sec;
  20422. }
  20423. inline void WebSocketClient::set_websocket_max_missed_pongs(int count) {
  20424. websocket_max_missed_pongs_ = count;
  20425. }
  20426. inline void WebSocketClient::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  20427. inline void WebSocketClient::set_address_family(int family) {
  20428. address_family_ = family;
  20429. }
  20430. inline void WebSocketClient::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  20431. inline void WebSocketClient::set_socket_options(SocketOptions socket_options) {
  20432. socket_options_ = std::move(socket_options);
  20433. }
  20434. inline void WebSocketClient::set_connection_timeout(time_t sec, time_t usec) {
  20435. connection_timeout_sec_ = sec;
  20436. connection_timeout_usec_ = usec;
  20437. }
  20438. inline void WebSocketClient::set_interface(const std::string &intf) {
  20439. interface_ = intf;
  20440. }
  20441. inline void WebSocketClient::set_hostname_addr_map(
  20442. std::map<std::string, std::string> addr_map) {
  20443. addr_map_ = std::move(addr_map);
  20444. }
  20445. inline bool WebSocketClient::is_proxy_enabled() const {
  20446. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  20447. if (no_proxy_entries_.empty()) { return true; }
  20448. return !detail::host_matches_no_proxy(detail::normalize_target(host_),
  20449. no_proxy_entries_);
  20450. }
  20451. inline bool WebSocketClient::create_and_connect_socket(Error &error) {
  20452. std::string connect_host;
  20453. std::string ip;
  20454. auto port = port_;
  20455. if (is_proxy_enabled()) {
  20456. connect_host = proxy_host_;
  20457. port = proxy_port_;
  20458. } else {
  20459. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  20460. }
  20461. sock_ = detail::create_client_socket(
  20462. connect_host, ip, port, address_family_, tcp_nodelay_, ipv6_v6only_,
  20463. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  20464. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  20465. write_timeout_usec_, interface_, error);
  20466. if (sock_ != INVALID_SOCKET) { return true; }
  20467. if (error == Error::Success) { error = Error::Connection; }
  20468. return false;
  20469. }
  20470. inline bool WebSocketClient::send_proxy_connect(Request &req,
  20471. Response &proxy_res,
  20472. Error &error) {
  20473. auto timeout = handshake_timeout();
  20474. detail::SocketStream strm(sock_, timeout.first, timeout.second,
  20475. write_timeout_sec_, write_timeout_usec_);
  20476. if (!detail::write_request_head(strm, req, error)) { return false; }
  20477. if (!detail::read_response_head(strm, proxy_res.status, proxy_res.headers)) {
  20478. error = Error::Read;
  20479. return false;
  20480. }
  20481. return true;
  20482. }
  20483. // RFC 6455 4.1: ws:// is tunnelled with CONNECT as well, since a proxy need not
  20484. // forward an Upgrade request.
  20485. inline bool WebSocketClient::connect_with_proxy(Response &proxy_res,
  20486. Error &error) {
  20487. Request req;
  20488. req.method = "CONNECT";
  20489. req.path = detail::make_host_and_port_string_always_port(host_, port_);
  20490. req.headers.emplace("Host", req.path);
  20491. detail::add_default_user_agent_header(req);
  20492. detail::add_authorization_header(req, proxy_basic_auth_username_,
  20493. proxy_basic_auth_password_,
  20494. proxy_bearer_token_auth_token_, true);
  20495. if (!send_proxy_connect(req, proxy_res, error)) { return false; }
  20496. #ifdef CPPHTTPLIB_SSL_ENABLED
  20497. // A Digest challenge gets one retry on a fresh connection, like SSLClient.
  20498. std::map<std::string, std::string> auth;
  20499. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407 &&
  20500. !proxy_digest_auth_username_.empty() &&
  20501. !proxy_digest_auth_password_.empty() &&
  20502. detail::parse_www_authenticate(proxy_res, auth, true)) {
  20503. proxy_res = Response();
  20504. shutdown_and_close();
  20505. if (!create_and_connect_socket(error)) { return false; }
  20506. req.headers.erase("Proxy-Authorization");
  20507. req.headers.insert(detail::make_digest_authentication_header(
  20508. req, req.path, auth, 1, detail::random_string(10),
  20509. proxy_digest_auth_username_, proxy_digest_auth_password_, true));
  20510. if (!send_proxy_connect(req, proxy_res, error)) { return false; }
  20511. }
  20512. #endif
  20513. if (proxy_res.status != StatusCode::OK_200) {
  20514. error = Error::ProxyConnection;
  20515. return false;
  20516. }
  20517. return true;
  20518. }
  20519. inline void WebSocketClient::set_proxy(const std::string &host, int port) {
  20520. proxy_host_ = host;
  20521. proxy_port_ = port;
  20522. }
  20523. inline void WebSocketClient::set_proxy_basic_auth(const std::string &username,
  20524. const std::string &password) {
  20525. proxy_basic_auth_username_ = username;
  20526. proxy_basic_auth_password_ = password;
  20527. }
  20528. inline void
  20529. WebSocketClient::set_proxy_bearer_token_auth(const std::string &token) {
  20530. proxy_bearer_token_auth_token_ = token;
  20531. }
  20532. inline void
  20533. WebSocketClient::set_no_proxy(const std::vector<std::string> &patterns) {
  20534. no_proxy_entries_ = detail::parse_no_proxy_entries(patterns);
  20535. }
  20536. #ifdef CPPHTTPLIB_SSL_ENABLED
  20537. inline void
  20538. WebSocketClient::set_ca_cert_path(const std::string &ca_cert_file_path,
  20539. const std::string &ca_cert_dir_path) {
  20540. ca_cert_file_path_ = ca_cert_file_path;
  20541. ca_cert_dir_path_ = ca_cert_dir_path;
  20542. }
  20543. inline void
  20544. WebSocketClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  20545. if (tls_ctx_) { tls::set_verify_callback(tls_ctx_, std::move(verifier)); }
  20546. }
  20547. inline void WebSocketClient::set_session_verifier(
  20548. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  20549. session_verifier_ = std::move(verifier);
  20550. }
  20551. inline void WebSocketClient::set_ca_cert_store(tls::ca_store_t store) {
  20552. if (store && tls_ctx_) {
  20553. // set_ca_store takes ownership of store
  20554. tls::set_ca_store(tls_ctx_, store);
  20555. } else if (store) {
  20556. tls::free_ca_store(store);
  20557. }
  20558. custom_ca_loaded_ = true;
  20559. }
  20560. inline void WebSocketClient::load_ca_cert_store(const char *ca_cert,
  20561. std::size_t size) {
  20562. if (tls_ctx_ && ca_cert && size > 0) {
  20563. tls::load_ca_pem(tls_ctx_, ca_cert, size);
  20564. }
  20565. custom_ca_loaded_ = true;
  20566. }
  20567. inline void
  20568. WebSocketClient::enable_server_certificate_verification(bool enabled) {
  20569. server_certificate_verification_ = enabled;
  20570. }
  20571. inline void WebSocketClient::enable_server_hostname_verification(bool enabled) {
  20572. server_hostname_verification_ = enabled;
  20573. }
  20574. inline void WebSocketClient::enable_system_ca(bool enabled) {
  20575. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  20576. }
  20577. inline void
  20578. WebSocketClient::set_proxy_digest_auth(const std::string &username,
  20579. const std::string &password) {
  20580. proxy_digest_auth_username_ = username;
  20581. proxy_digest_auth_password_ = password;
  20582. }
  20583. #endif // CPPHTTPLIB_SSL_ENABLED
  20584. } // namespace ws
  20585. // ----------------------------------------------------------------------------
  20586. } // namespace httplib
  20587. #endif // CPPHTTPLIB_HTTPLIB_H