httplib.h 828 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446144471444814449144501445114452144531445414455144561445714458144591446014461144621446314464144651446614467144681446914470144711447214473144741447514476144771447814479144801448114482144831448414485144861448714488144891449014491144921449314494144951449614497144981449914500145011450214503145041450514506145071450814509145101451114512145131451414515145161451714518145191452014521145221452314524145251452614527145281452914530145311453214533145341453514536145371453814539145401454114542145431454414545145461454714548145491455014551145521455314554145551455614557145581455914560145611456214563145641456514566145671456814569145701457114572145731457414575145761457714578145791458014581145821458314584145851458614587145881458914590145911459214593145941459514596145971459814599146001460114602146031460414605146061460714608146091461014611146121461314614146151461614617146181461914620146211462214623146241462514626146271462814629146301463114632146331463414635146361463714638146391464014641146421464314644146451464614647146481464914650146511465214653146541465514656146571465814659146601466114662146631466414665146661466714668146691467014671146721467314674146751467614677146781467914680146811468214683146841468514686146871468814689146901469114692146931469414695146961469714698146991470014701147021470314704147051470614707147081470914710147111471214713147141471514716147171471814719147201472114722147231472414725147261472714728147291473014731147321473314734147351473614737147381473914740147411474214743147441474514746147471474814749147501475114752147531475414755147561475714758147591476014761147621476314764147651476614767147681476914770147711477214773147741477514776147771477814779147801478114782147831478414785147861478714788147891479014791147921479314794147951479614797147981479914800148011480214803148041480514806148071480814809148101481114812148131481414815148161481714818148191482014821148221482314824148251482614827148281482914830148311483214833148341483514836148371483814839148401484114842148431484414845148461484714848148491485014851148521485314854148551485614857148581485914860148611486214863148641486514866148671486814869148701487114872148731487414875148761487714878148791488014881148821488314884148851488614887148881488914890148911489214893148941489514896148971489814899149001490114902149031490414905149061490714908149091491014911149121491314914149151491614917149181491914920149211492214923149241492514926149271492814929149301493114932149331493414935149361493714938149391494014941149421494314944149451494614947149481494914950149511495214953149541495514956149571495814959149601496114962149631496414965149661496714968149691497014971149721497314974149751497614977149781497914980149811498214983149841498514986149871498814989149901499114992149931499414995149961499714998149991500015001150021500315004150051500615007150081500915010150111501215013150141501515016150171501815019150201502115022150231502415025150261502715028150291503015031150321503315034150351503615037150381503915040150411504215043150441504515046150471504815049150501505115052150531505415055150561505715058150591506015061150621506315064150651506615067150681506915070150711507215073150741507515076150771507815079150801508115082150831508415085150861508715088150891509015091150921509315094150951509615097150981509915100151011510215103151041510515106151071510815109151101511115112151131511415115151161511715118151191512015121151221512315124151251512615127151281512915130151311513215133151341513515136151371513815139151401514115142151431514415145151461514715148151491515015151151521515315154151551515615157151581515915160151611516215163151641516515166151671516815169151701517115172151731517415175151761517715178151791518015181151821518315184151851518615187151881518915190151911519215193151941519515196151971519815199152001520115202152031520415205152061520715208152091521015211152121521315214152151521615217152181521915220152211522215223152241522515226152271522815229152301523115232152331523415235152361523715238152391524015241152421524315244152451524615247152481524915250152511525215253152541525515256152571525815259152601526115262152631526415265152661526715268152691527015271152721527315274152751527615277152781527915280152811528215283152841528515286152871528815289152901529115292152931529415295152961529715298152991530015301153021530315304153051530615307153081530915310153111531215313153141531515316153171531815319153201532115322153231532415325153261532715328153291533015331153321533315334153351533615337153381533915340153411534215343153441534515346153471534815349153501535115352153531535415355153561535715358153591536015361153621536315364153651536615367153681536915370153711537215373153741537515376153771537815379153801538115382153831538415385153861538715388153891539015391153921539315394153951539615397153981539915400154011540215403154041540515406154071540815409154101541115412154131541415415154161541715418154191542015421154221542315424154251542615427154281542915430154311543215433154341543515436154371543815439154401544115442154431544415445154461544715448154491545015451154521545315454154551545615457154581545915460154611546215463154641546515466154671546815469154701547115472154731547415475154761547715478154791548015481154821548315484154851548615487154881548915490154911549215493154941549515496154971549815499155001550115502155031550415505155061550715508155091551015511155121551315514155151551615517155181551915520155211552215523155241552515526155271552815529155301553115532155331553415535155361553715538155391554015541155421554315544155451554615547155481554915550155511555215553155541555515556155571555815559155601556115562155631556415565155661556715568155691557015571155721557315574155751557615577155781557915580155811558215583155841558515586155871558815589155901559115592155931559415595155961559715598155991560015601156021560315604156051560615607156081560915610156111561215613156141561515616156171561815619156201562115622156231562415625156261562715628156291563015631156321563315634156351563615637156381563915640156411564215643156441564515646156471564815649156501565115652156531565415655156561565715658156591566015661156621566315664156651566615667156681566915670156711567215673156741567515676156771567815679156801568115682156831568415685156861568715688156891569015691156921569315694156951569615697156981569915700157011570215703157041570515706157071570815709157101571115712157131571415715157161571715718157191572015721157221572315724157251572615727157281572915730157311573215733157341573515736157371573815739157401574115742157431574415745157461574715748157491575015751157521575315754157551575615757157581575915760157611576215763157641576515766157671576815769157701577115772157731577415775157761577715778157791578015781157821578315784157851578615787157881578915790157911579215793157941579515796157971579815799158001580115802158031580415805158061580715808158091581015811158121581315814158151581615817158181581915820158211582215823158241582515826158271582815829158301583115832158331583415835158361583715838158391584015841158421584315844158451584615847158481584915850158511585215853158541585515856158571585815859158601586115862158631586415865158661586715868158691587015871158721587315874158751587615877158781587915880158811588215883158841588515886158871588815889158901589115892158931589415895158961589715898158991590015901159021590315904159051590615907159081590915910159111591215913159141591515916159171591815919159201592115922159231592415925159261592715928159291593015931159321593315934159351593615937159381593915940159411594215943159441594515946159471594815949159501595115952159531595415955159561595715958159591596015961159621596315964159651596615967159681596915970159711597215973159741597515976159771597815979159801598115982159831598415985159861598715988159891599015991159921599315994159951599615997159981599916000160011600216003160041600516006160071600816009160101601116012160131601416015160161601716018160191602016021160221602316024160251602616027160281602916030160311603216033160341603516036160371603816039160401604116042160431604416045160461604716048160491605016051160521605316054160551605616057160581605916060160611606216063160641606516066160671606816069160701607116072160731607416075160761607716078160791608016081160821608316084160851608616087160881608916090160911609216093160941609516096160971609816099161001610116102161031610416105161061610716108161091611016111161121611316114161151611616117161181611916120161211612216123161241612516126161271612816129161301613116132161331613416135161361613716138161391614016141161421614316144161451614616147161481614916150161511615216153161541615516156161571615816159161601616116162161631616416165161661616716168161691617016171161721617316174161751617616177161781617916180161811618216183161841618516186161871618816189161901619116192161931619416195161961619716198161991620016201162021620316204162051620616207162081620916210162111621216213162141621516216162171621816219162201622116222162231622416225162261622716228162291623016231162321623316234162351623616237162381623916240162411624216243162441624516246162471624816249162501625116252162531625416255162561625716258162591626016261162621626316264162651626616267162681626916270162711627216273162741627516276162771627816279162801628116282162831628416285162861628716288162891629016291162921629316294162951629616297162981629916300163011630216303163041630516306163071630816309163101631116312163131631416315163161631716318163191632016321163221632316324163251632616327163281632916330163311633216333163341633516336163371633816339163401634116342163431634416345163461634716348163491635016351163521635316354163551635616357163581635916360163611636216363163641636516366163671636816369163701637116372163731637416375163761637716378163791638016381163821638316384163851638616387163881638916390163911639216393163941639516396163971639816399164001640116402164031640416405164061640716408164091641016411164121641316414164151641616417164181641916420164211642216423164241642516426164271642816429164301643116432164331643416435164361643716438164391644016441164421644316444164451644616447164481644916450164511645216453164541645516456164571645816459164601646116462164631646416465164661646716468164691647016471164721647316474164751647616477164781647916480164811648216483164841648516486164871648816489164901649116492164931649416495164961649716498164991650016501165021650316504165051650616507165081650916510165111651216513165141651516516165171651816519165201652116522165231652416525165261652716528165291653016531165321653316534165351653616537165381653916540165411654216543165441654516546165471654816549165501655116552165531655416555165561655716558165591656016561165621656316564165651656616567165681656916570165711657216573165741657516576165771657816579165801658116582165831658416585165861658716588165891659016591165921659316594165951659616597165981659916600166011660216603166041660516606166071660816609166101661116612166131661416615166161661716618166191662016621166221662316624166251662616627166281662916630166311663216633166341663516636166371663816639166401664116642166431664416645166461664716648166491665016651166521665316654166551665616657166581665916660166611666216663166641666516666166671666816669166701667116672166731667416675166761667716678166791668016681166821668316684166851668616687166881668916690166911669216693166941669516696166971669816699167001670116702167031670416705167061670716708167091671016711167121671316714167151671616717167181671916720167211672216723167241672516726167271672816729167301673116732167331673416735167361673716738167391674016741167421674316744167451674616747167481674916750167511675216753167541675516756167571675816759167601676116762167631676416765167661676716768167691677016771167721677316774167751677616777167781677916780167811678216783167841678516786167871678816789167901679116792167931679416795167961679716798167991680016801168021680316804168051680616807168081680916810168111681216813168141681516816168171681816819168201682116822168231682416825168261682716828168291683016831168321683316834168351683616837168381683916840168411684216843168441684516846168471684816849168501685116852168531685416855168561685716858168591686016861168621686316864168651686616867168681686916870168711687216873168741687516876168771687816879168801688116882168831688416885168861688716888168891689016891168921689316894168951689616897168981689916900169011690216903169041690516906169071690816909169101691116912169131691416915169161691716918169191692016921169221692316924169251692616927169281692916930169311693216933169341693516936169371693816939169401694116942169431694416945169461694716948169491695016951169521695316954169551695616957169581695916960169611696216963169641696516966169671696816969169701697116972169731697416975169761697716978169791698016981169821698316984169851698616987169881698916990169911699216993169941699516996169971699816999170001700117002170031700417005170061700717008170091701017011170121701317014170151701617017170181701917020170211702217023170241702517026170271702817029170301703117032170331703417035170361703717038170391704017041170421704317044170451704617047170481704917050170511705217053170541705517056170571705817059170601706117062170631706417065170661706717068170691707017071170721707317074170751707617077170781707917080170811708217083170841708517086170871708817089170901709117092170931709417095170961709717098170991710017101171021710317104171051710617107171081710917110171111711217113171141711517116171171711817119171201712117122171231712417125171261712717128171291713017131171321713317134171351713617137171381713917140171411714217143171441714517146171471714817149171501715117152171531715417155171561715717158171591716017161171621716317164171651716617167171681716917170171711717217173171741717517176171771717817179171801718117182171831718417185171861718717188171891719017191171921719317194171951719617197171981719917200172011720217203172041720517206172071720817209172101721117212172131721417215172161721717218172191722017221172221722317224172251722617227172281722917230172311723217233172341723517236172371723817239172401724117242172431724417245172461724717248172491725017251172521725317254172551725617257172581725917260172611726217263172641726517266172671726817269172701727117272172731727417275172761727717278172791728017281172821728317284172851728617287172881728917290172911729217293172941729517296172971729817299173001730117302173031730417305173061730717308173091731017311173121731317314173151731617317173181731917320173211732217323173241732517326173271732817329173301733117332173331733417335173361733717338173391734017341173421734317344173451734617347173481734917350173511735217353173541735517356173571735817359173601736117362173631736417365173661736717368173691737017371173721737317374173751737617377173781737917380173811738217383173841738517386173871738817389173901739117392173931739417395173961739717398173991740017401174021740317404174051740617407174081740917410174111741217413174141741517416174171741817419174201742117422174231742417425174261742717428174291743017431174321743317434174351743617437174381743917440174411744217443174441744517446174471744817449174501745117452174531745417455174561745717458174591746017461174621746317464174651746617467174681746917470174711747217473174741747517476174771747817479174801748117482174831748417485174861748717488174891749017491174921749317494174951749617497174981749917500175011750217503175041750517506175071750817509175101751117512175131751417515175161751717518175191752017521175221752317524175251752617527175281752917530175311753217533175341753517536175371753817539175401754117542175431754417545175461754717548175491755017551175521755317554175551755617557175581755917560175611756217563175641756517566175671756817569175701757117572175731757417575175761757717578175791758017581175821758317584175851758617587175881758917590175911759217593175941759517596175971759817599176001760117602176031760417605176061760717608176091761017611176121761317614176151761617617176181761917620176211762217623176241762517626176271762817629176301763117632176331763417635176361763717638176391764017641176421764317644176451764617647176481764917650176511765217653176541765517656176571765817659176601766117662176631766417665176661766717668176691767017671176721767317674176751767617677176781767917680176811768217683176841768517686176871768817689176901769117692176931769417695176961769717698176991770017701177021770317704177051770617707177081770917710177111771217713177141771517716177171771817719177201772117722177231772417725177261772717728177291773017731177321773317734177351773617737177381773917740177411774217743177441774517746177471774817749177501775117752177531775417755177561775717758177591776017761177621776317764177651776617767177681776917770177711777217773177741777517776177771777817779177801778117782177831778417785177861778717788177891779017791177921779317794177951779617797177981779917800178011780217803178041780517806178071780817809178101781117812178131781417815178161781717818178191782017821178221782317824178251782617827178281782917830178311783217833178341783517836178371783817839178401784117842178431784417845178461784717848178491785017851178521785317854178551785617857178581785917860178611786217863178641786517866178671786817869178701787117872178731787417875178761787717878178791788017881178821788317884178851788617887178881788917890178911789217893178941789517896178971789817899179001790117902179031790417905179061790717908179091791017911179121791317914179151791617917179181791917920179211792217923179241792517926179271792817929179301793117932179331793417935179361793717938179391794017941179421794317944179451794617947179481794917950179511795217953179541795517956179571795817959179601796117962179631796417965179661796717968179691797017971179721797317974179751797617977179781797917980179811798217983179841798517986179871798817989179901799117992179931799417995179961799717998179991800018001180021800318004180051800618007180081800918010180111801218013180141801518016180171801818019180201802118022180231802418025180261802718028180291803018031180321803318034180351803618037180381803918040180411804218043180441804518046180471804818049180501805118052180531805418055180561805718058180591806018061180621806318064180651806618067180681806918070180711807218073180741807518076180771807818079180801808118082180831808418085180861808718088180891809018091180921809318094180951809618097180981809918100181011810218103181041810518106181071810818109181101811118112181131811418115181161811718118181191812018121181221812318124181251812618127181281812918130181311813218133181341813518136181371813818139181401814118142181431814418145181461814718148181491815018151181521815318154181551815618157181581815918160181611816218163181641816518166181671816818169181701817118172181731817418175181761817718178181791818018181181821818318184181851818618187181881818918190181911819218193181941819518196181971819818199182001820118202182031820418205182061820718208182091821018211182121821318214182151821618217182181821918220182211822218223182241822518226182271822818229182301823118232182331823418235182361823718238182391824018241182421824318244182451824618247182481824918250182511825218253182541825518256182571825818259182601826118262182631826418265182661826718268182691827018271182721827318274182751827618277182781827918280182811828218283182841828518286182871828818289182901829118292182931829418295182961829718298182991830018301183021830318304183051830618307183081830918310183111831218313183141831518316183171831818319183201832118322183231832418325183261832718328183291833018331183321833318334183351833618337183381833918340183411834218343183441834518346183471834818349183501835118352183531835418355183561835718358183591836018361183621836318364183651836618367183681836918370183711837218373183741837518376183771837818379183801838118382183831838418385183861838718388183891839018391183921839318394183951839618397183981839918400184011840218403184041840518406184071840818409184101841118412184131841418415184161841718418184191842018421184221842318424184251842618427184281842918430184311843218433184341843518436184371843818439184401844118442184431844418445184461844718448184491845018451184521845318454184551845618457184581845918460184611846218463184641846518466184671846818469184701847118472184731847418475184761847718478184791848018481184821848318484184851848618487184881848918490184911849218493184941849518496184971849818499185001850118502185031850418505185061850718508185091851018511185121851318514185151851618517185181851918520185211852218523185241852518526185271852818529185301853118532185331853418535185361853718538185391854018541185421854318544185451854618547185481854918550185511855218553185541855518556185571855818559185601856118562185631856418565185661856718568185691857018571185721857318574185751857618577185781857918580185811858218583185841858518586185871858818589185901859118592185931859418595185961859718598185991860018601186021860318604186051860618607186081860918610186111861218613186141861518616186171861818619186201862118622186231862418625186261862718628186291863018631186321863318634186351863618637186381863918640186411864218643186441864518646186471864818649186501865118652186531865418655186561865718658186591866018661186621866318664186651866618667186681866918670186711867218673186741867518676186771867818679186801868118682186831868418685186861868718688186891869018691186921869318694186951869618697186981869918700187011870218703187041870518706187071870818709187101871118712187131871418715187161871718718187191872018721187221872318724187251872618727187281872918730187311873218733187341873518736187371873818739187401874118742187431874418745187461874718748187491875018751187521875318754187551875618757187581875918760187611876218763187641876518766187671876818769187701877118772187731877418775187761877718778187791878018781187821878318784187851878618787187881878918790187911879218793187941879518796187971879818799188001880118802188031880418805188061880718808188091881018811188121881318814188151881618817188181881918820188211882218823188241882518826188271882818829188301883118832188331883418835188361883718838188391884018841188421884318844188451884618847188481884918850188511885218853188541885518856188571885818859188601886118862188631886418865188661886718868188691887018871188721887318874188751887618877188781887918880188811888218883188841888518886188871888818889188901889118892188931889418895188961889718898188991890018901189021890318904189051890618907189081890918910189111891218913189141891518916189171891818919189201892118922189231892418925189261892718928189291893018931189321893318934189351893618937189381893918940189411894218943189441894518946189471894818949189501895118952189531895418955189561895718958189591896018961189621896318964189651896618967189681896918970189711897218973189741897518976189771897818979189801898118982189831898418985189861898718988189891899018991189921899318994189951899618997189981899919000190011900219003190041900519006190071900819009190101901119012190131901419015190161901719018190191902019021190221902319024190251902619027190281902919030190311903219033190341903519036190371903819039190401904119042190431904419045190461904719048190491905019051190521905319054190551905619057190581905919060190611906219063190641906519066190671906819069190701907119072190731907419075190761907719078190791908019081190821908319084190851908619087190881908919090190911909219093190941909519096190971909819099191001910119102191031910419105191061910719108191091911019111191121911319114191151911619117191181911919120191211912219123191241912519126191271912819129191301913119132191331913419135191361913719138191391914019141191421914319144191451914619147191481914919150191511915219153191541915519156191571915819159191601916119162191631916419165191661916719168191691917019171191721917319174191751917619177191781917919180191811918219183191841918519186191871918819189191901919119192191931919419195191961919719198191991920019201192021920319204192051920619207192081920919210192111921219213192141921519216192171921819219192201922119222192231922419225192261922719228192291923019231192321923319234192351923619237192381923919240192411924219243192441924519246192471924819249192501925119252192531925419255192561925719258192591926019261192621926319264192651926619267192681926919270192711927219273192741927519276192771927819279192801928119282192831928419285192861928719288192891929019291192921929319294192951929619297192981929919300193011930219303193041930519306193071930819309193101931119312193131931419315193161931719318193191932019321193221932319324193251932619327193281932919330193311933219333193341933519336193371933819339193401934119342193431934419345193461934719348193491935019351193521935319354193551935619357193581935919360193611936219363193641936519366193671936819369193701937119372193731937419375193761937719378193791938019381193821938319384193851938619387193881938919390193911939219393193941939519396193971939819399194001940119402194031940419405194061940719408194091941019411194121941319414194151941619417194181941919420194211942219423194241942519426194271942819429194301943119432194331943419435194361943719438194391944019441194421944319444194451944619447194481944919450194511945219453194541945519456194571945819459194601946119462194631946419465194661946719468194691947019471194721947319474194751947619477194781947919480194811948219483194841948519486194871948819489194901949119492194931949419495194961949719498194991950019501195021950319504195051950619507195081950919510195111951219513195141951519516195171951819519195201952119522195231952419525195261952719528195291953019531195321953319534195351953619537195381953919540195411954219543195441954519546195471954819549195501955119552195531955419555195561955719558195591956019561195621956319564195651956619567195681956919570195711957219573195741957519576195771957819579195801958119582195831958419585195861958719588195891959019591195921959319594195951959619597195981959919600196011960219603196041960519606196071960819609196101961119612196131961419615196161961719618196191962019621196221962319624196251962619627196281962919630196311963219633196341963519636196371963819639196401964119642196431964419645196461964719648196491965019651196521965319654196551965619657196581965919660196611966219663196641966519666196671966819669196701967119672196731967419675196761967719678196791968019681196821968319684196851968619687196881968919690196911969219693196941969519696196971969819699197001970119702197031970419705197061970719708197091971019711197121971319714197151971619717197181971919720197211972219723197241972519726197271972819729197301973119732197331973419735197361973719738197391974019741197421974319744197451974619747197481974919750197511975219753197541975519756197571975819759197601976119762197631976419765197661976719768197691977019771197721977319774197751977619777197781977919780197811978219783197841978519786197871978819789197901979119792197931979419795197961979719798197991980019801198021980319804198051980619807198081980919810198111981219813198141981519816198171981819819198201982119822198231982419825198261982719828198291983019831198321983319834198351983619837198381983919840198411984219843198441984519846198471984819849198501985119852198531985419855198561985719858198591986019861198621986319864198651986619867198681986919870198711987219873198741987519876198771987819879198801988119882198831988419885198861988719888198891989019891198921989319894198951989619897198981989919900199011990219903199041990519906199071990819909199101991119912199131991419915199161991719918199191992019921199221992319924199251992619927199281992919930199311993219933199341993519936199371993819939199401994119942199431994419945199461994719948199491995019951199521995319954199551995619957199581995919960199611996219963199641996519966199671996819969199701997119972199731997419975199761997719978199791998019981199821998319984199851998619987199881998919990199911999219993199941999519996199971999819999200002000120002200032000420005200062000720008200092001020011200122001320014200152001620017200182001920020200212002220023200242002520026200272002820029200302003120032200332003420035200362003720038200392004020041200422004320044200452004620047200482004920050200512005220053200542005520056200572005820059200602006120062200632006420065200662006720068200692007020071200722007320074200752007620077200782007920080200812008220083200842008520086200872008820089200902009120092200932009420095200962009720098200992010020101201022010320104201052010620107201082010920110201112011220113201142011520116201172011820119201202012120122201232012420125201262012720128201292013020131201322013320134201352013620137201382013920140201412014220143201442014520146201472014820149201502015120152201532015420155201562015720158201592016020161201622016320164201652016620167201682016920170201712017220173201742017520176201772017820179201802018120182201832018420185201862018720188201892019020191201922019320194201952019620197201982019920200202012020220203202042020520206202072020820209202102021120212202132021420215202162021720218202192022020221202222022320224202252022620227202282022920230202312023220233202342023520236202372023820239202402024120242202432024420245202462024720248202492025020251202522025320254202552025620257202582025920260202612026220263202642026520266202672026820269202702027120272202732027420275202762027720278202792028020281202822028320284202852028620287202882028920290202912029220293202942029520296202972029820299203002030120302203032030420305203062030720308203092031020311203122031320314203152031620317203182031920320203212032220323203242032520326203272032820329203302033120332203332033420335203362033720338203392034020341203422034320344203452034620347203482034920350203512035220353203542035520356203572035820359203602036120362203632036420365203662036720368203692037020371203722037320374203752037620377203782037920380203812038220383203842038520386203872038820389203902039120392203932039420395203962039720398203992040020401204022040320404204052040620407204082040920410204112041220413204142041520416204172041820419204202042120422204232042420425204262042720428204292043020431204322043320434204352043620437204382043920440204412044220443204442044520446204472044820449204502045120452204532045420455204562045720458204592046020461204622046320464204652046620467204682046920470204712047220473204742047520476204772047820479204802048120482204832048420485204862048720488204892049020491204922049320494204952049620497204982049920500205012050220503205042050520506205072050820509205102051120512205132051420515205162051720518205192052020521205222052320524205252052620527205282052920530205312053220533205342053520536205372053820539205402054120542205432054420545205462054720548205492055020551205522055320554205552055620557205582055920560205612056220563205642056520566205672056820569205702057120572205732057420575205762057720578205792058020581205822058320584205852058620587205882058920590205912059220593205942059520596205972059820599206002060120602206032060420605206062060720608206092061020611206122061320614206152061620617206182061920620206212062220623206242062520626206272062820629206302063120632206332063420635206362063720638206392064020641206422064320644206452064620647206482064920650206512065220653206542065520656206572065820659206602066120662206632066420665206662066720668206692067020671206722067320674206752067620677206782067920680206812068220683206842068520686206872068820689206902069120692206932069420695206962069720698206992070020701207022070320704207052070620707207082070920710207112071220713207142071520716207172071820719207202072120722207232072420725207262072720728207292073020731207322073320734207352073620737207382073920740207412074220743207442074520746207472074820749207502075120752207532075420755207562075720758207592076020761207622076320764207652076620767207682076920770207712077220773207742077520776207772077820779207802078120782207832078420785207862078720788207892079020791207922079320794207952079620797207982079920800208012080220803208042080520806208072080820809208102081120812208132081420815208162081720818208192082020821208222082320824208252082620827208282082920830208312083220833208342083520836208372083820839208402084120842208432084420845208462084720848208492085020851208522085320854208552085620857208582085920860208612086220863208642086520866208672086820869208702087120872208732087420875208762087720878208792088020881208822088320884208852088620887208882088920890208912089220893208942089520896208972089820899209002090120902209032090420905209062090720908209092091020911209122091320914209152091620917209182091920920209212092220923209242092520926209272092820929209302093120932209332093420935209362093720938209392094020941209422094320944209452094620947209482094920950209512095220953209542095520956209572095820959209602096120962209632096420965209662096720968209692097020971209722097320974209752097620977209782097920980209812098220983209842098520986209872098820989209902099120992209932099420995209962099720998209992100021001210022100321004210052100621007210082100921010210112101221013210142101521016210172101821019210202102121022210232102421025210262102721028210292103021031210322103321034210352103621037210382103921040210412104221043210442104521046210472104821049210502105121052210532105421055210562105721058210592106021061210622106321064210652106621067210682106921070210712107221073210742107521076210772107821079210802108121082210832108421085210862108721088210892109021091210922109321094210952109621097210982109921100211012110221103211042110521106211072110821109211102111121112211132111421115211162111721118211192112021121211222112321124211252112621127211282112921130211312113221133211342113521136211372113821139211402114121142211432114421145211462114721148211492115021151211522115321154211552115621157211582115921160211612116221163211642116521166211672116821169211702117121172211732117421175211762117721178211792118021181211822118321184211852118621187211882118921190211912119221193211942119521196211972119821199212002120121202212032120421205212062120721208212092121021211212122121321214212152121621217212182121921220212212122221223212242122521226212272122821229212302123121232212332123421235212362123721238212392124021241212422124321244212452124621247212482124921250212512125221253212542125521256212572125821259212602126121262212632126421265212662126721268212692127021271212722127321274212752127621277212782127921280212812128221283212842128521286212872128821289212902129121292212932129421295212962129721298212992130021301213022130321304213052130621307213082130921310213112131221313213142131521316213172131821319213202132121322213232132421325213262132721328213292133021331213322133321334213352133621337213382133921340213412134221343213442134521346213472134821349213502135121352213532135421355213562135721358213592136021361213622136321364213652136621367213682136921370213712137221373213742137521376213772137821379213802138121382213832138421385213862138721388213892139021391213922139321394213952139621397213982139921400214012140221403214042140521406214072140821409214102141121412214132141421415214162141721418214192142021421214222142321424214252142621427214282142921430214312143221433214342143521436214372143821439214402144121442214432144421445214462144721448214492145021451214522145321454214552145621457214582145921460214612146221463214642146521466214672146821469214702147121472214732147421475214762147721478214792148021481214822148321484214852148621487214882148921490214912149221493214942149521496214972149821499215002150121502215032150421505215062150721508215092151021511215122151321514215152151621517215182151921520215212152221523215242152521526215272152821529215302153121532215332153421535215362153721538215392154021541215422154321544215452154621547215482154921550215512155221553215542155521556215572155821559215602156121562215632156421565215662156721568215692157021571215722157321574215752157621577215782157921580215812158221583215842158521586215872158821589215902159121592215932159421595215962159721598215992160021601216022160321604216052160621607216082160921610216112161221613216142161521616216172161821619216202162121622216232162421625216262162721628216292163021631216322163321634216352163621637216382163921640216412164221643216442164521646216472164821649216502165121652216532165421655216562165721658216592166021661216622166321664216652166621667216682166921670216712167221673216742167521676216772167821679216802168121682216832168421685216862168721688216892169021691216922169321694216952169621697216982169921700217012170221703217042170521706217072170821709217102171121712217132171421715217162171721718217192172021721217222172321724217252172621727217282172921730217312173221733217342173521736217372173821739217402174121742217432174421745217462174721748217492175021751217522175321754217552175621757217582175921760217612176221763217642176521766217672176821769217702177121772217732177421775217762177721778217792178021781217822178321784217852178621787217882178921790217912179221793217942179521796217972179821799218002180121802218032180421805218062180721808218092181021811218122181321814218152181621817218182181921820218212182221823218242182521826218272182821829218302183121832218332183421835218362183721838218392184021841218422184321844218452184621847218482184921850218512185221853218542185521856218572185821859218602186121862218632186421865218662186721868218692187021871218722187321874218752187621877218782187921880218812188221883218842188521886218872188821889218902189121892218932189421895218962189721898218992190021901219022190321904219052190621907219082190921910219112191221913219142191521916219172191821919219202192121922219232192421925219262192721928219292193021931219322193321934219352193621937219382193921940219412194221943219442194521946219472194821949219502195121952219532195421955219562195721958219592196021961219622196321964219652196621967219682196921970219712197221973219742197521976219772197821979219802198121982219832198421985219862198721988219892199021991219922199321994219952199621997219982199922000220012200222003220042200522006220072200822009220102201122012220132201422015220162201722018220192202022021220222202322024220252202622027220282202922030220312203222033220342203522036220372203822039220402204122042220432204422045220462204722048220492205022051220522205322054220552205622057220582205922060220612206222063220642206522066220672206822069220702207122072220732207422075220762207722078220792208022081220822208322084220852208622087220882208922090220912209222093220942209522096220972209822099221002210122102221032210422105221062210722108221092211022111221122211322114221152211622117221182211922120221212212222123221242212522126221272212822129221302213122132221332213422135221362213722138221392214022141221422214322144221452214622147221482214922150221512215222153221542215522156221572215822159221602216122162221632216422165221662216722168221692217022171221722217322174221752217622177221782217922180221812218222183221842218522186221872218822189221902219122192221932219422195221962219722198221992220022201222022220322204222052220622207222082220922210222112221222213222142221522216222172221822219222202222122222222232222422225222262222722228222292223022231222322223322234222352223622237222382223922240222412224222243222442224522246222472224822249222502225122252222532225422255222562225722258222592226022261222622226322264222652226622267222682226922270222712227222273222742227522276222772227822279222802228122282222832228422285222862228722288222892229022291222922229322294222952229622297222982229922300223012230222303223042230522306223072230822309223102231122312223132231422315223162231722318223192232022321223222232322324223252232622327223282232922330223312233222333223342233522336223372233822339223402234122342223432234422345223462234722348223492235022351223522235322354223552235622357223582235922360223612236222363223642236522366223672236822369223702237122372223732237422375223762237722378223792238022381223822238322384223852238622387223882238922390223912239222393223942239522396223972239822399224002240122402224032240422405224062240722408224092241022411224122241322414224152241622417224182241922420224212242222423224242242522426224272242822429224302243122432224332243422435224362243722438224392244022441224422244322444224452244622447224482244922450224512245222453224542245522456224572245822459224602246122462224632246422465224662246722468224692247022471224722247322474224752247622477224782247922480224812248222483224842248522486224872248822489224902249122492224932249422495224962249722498224992250022501225022250322504225052250622507225082250922510225112251222513225142251522516225172251822519225202252122522225232252422525225262252722528225292253022531225322253322534225352253622537225382253922540225412254222543225442254522546225472254822549225502255122552225532255422555225562255722558225592256022561225622256322564225652256622567225682256922570225712257222573225742257522576225772257822579225802258122582225832258422585225862258722588225892259022591225922259322594225952259622597225982259922600226012260222603226042260522606226072260822609226102261122612226132261422615226162261722618226192262022621226222262322624226252262622627226282262922630226312263222633226342263522636226372263822639226402264122642226432264422645226462264722648226492265022651226522265322654226552265622657226582265922660226612266222663226642266522666226672266822669226702267122672226732267422675226762267722678226792268022681226822268322684226852268622687226882268922690226912269222693226942269522696226972269822699227002270122702227032270422705227062270722708227092271022711227122271322714227152271622717227182271922720227212272222723227242272522726227272272822729227302273122732227332273422735227362273722738227392274022741227422274322744227452274622747227482274922750227512275222753227542275522756227572275822759227602276122762227632276422765227662276722768227692277022771227722277322774227752277622777227782277922780227812278222783227842278522786227872278822789227902279122792227932279422795227962279722798227992280022801228022280322804228052280622807228082280922810228112281222813228142281522816228172281822819228202282122822228232282422825228262282722828228292283022831228322283322834228352283622837228382283922840228412284222843228442284522846228472284822849228502285122852228532285422855228562285722858228592286022861228622286322864228652286622867228682286922870228712287222873228742287522876228772287822879228802288122882228832288422885228862288722888228892289022891228922289322894228952289622897228982289922900229012290222903229042290522906229072290822909229102291122912229132291422915229162291722918229192292022921229222292322924229252292622927229282292922930229312293222933229342293522936229372293822939229402294122942229432294422945229462294722948229492295022951229522295322954229552295622957229582295922960229612296222963229642296522966229672296822969229702297122972229732297422975229762297722978229792298022981229822298322984229852298622987229882298922990229912299222993229942299522996229972299822999230002300123002230032300423005230062300723008230092301023011230122301323014230152301623017230182301923020230212302223023230242302523026230272302823029230302303123032230332303423035230362303723038230392304023041230422304323044230452304623047230482304923050230512305223053230542305523056230572305823059230602306123062230632306423065230662306723068230692307023071230722307323074230752307623077230782307923080230812308223083230842308523086230872308823089230902309123092230932309423095230962309723098230992310023101231022310323104231052310623107231082310923110231112311223113231142311523116231172311823119231202312123122231232312423125231262312723128231292313023131231322313323134231352313623137231382313923140231412314223143231442314523146231472314823149231502315123152231532315423155231562315723158231592316023161231622316323164231652316623167231682316923170231712317223173231742317523176231772317823179231802318123182231832318423185231862318723188231892319023191231922319323194231952319623197231982319923200232012320223203232042320523206232072320823209232102321123212232132321423215232162321723218232192322023221232222322323224232252322623227232282322923230232312323223233232342323523236232372323823239232402324123242232432324423245232462324723248232492325023251232522325323254232552325623257232582325923260232612326223263232642326523266232672326823269232702327123272232732327423275232762327723278232792328023281232822328323284232852328623287232882328923290232912329223293232942329523296232972329823299233002330123302233032330423305233062330723308233092331023311233122331323314233152331623317233182331923320233212332223323233242332523326233272332823329233302333123332233332333423335233362333723338233392334023341233422334323344233452334623347233482334923350233512335223353233542335523356233572335823359233602336123362233632336423365233662336723368233692337023371233722337323374233752337623377233782337923380233812338223383233842338523386233872338823389233902339123392233932339423395233962339723398233992340023401234022340323404234052340623407234082340923410234112341223413234142341523416234172341823419234202342123422234232342423425234262342723428234292343023431234322343323434234352343623437234382343923440234412344223443234442344523446234472344823449234502345123452234532345423455234562345723458234592346023461234622346323464234652346623467234682346923470234712347223473234742347523476234772347823479234802348123482234832348423485234862348723488234892349023491234922349323494234952349623497234982349923500235012350223503235042350523506235072350823509235102351123512235132351423515235162351723518235192352023521235222352323524235252352623527235282352923530235312353223533235342353523536235372353823539235402354123542235432354423545235462354723548235492355023551235522355323554235552355623557235582355923560235612356223563235642356523566235672356823569235702357123572235732357423575235762357723578235792358023581235822358323584235852358623587235882358923590235912359223593235942359523596235972359823599236002360123602236032360423605236062360723608236092361023611236122361323614236152361623617236182361923620236212362223623236242362523626236272362823629236302363123632236332363423635236362363723638236392364023641236422364323644236452364623647236482364923650236512365223653236542365523656236572365823659236602366123662236632366423665236662366723668236692367023671236722367323674236752367623677236782367923680236812368223683236842368523686236872368823689236902369123692236932369423695236962369723698236992370023701237022370323704237052370623707237082370923710237112371223713237142371523716237172371823719237202372123722237232372423725237262372723728237292373023731237322373323734237352373623737237382373923740237412374223743237442374523746237472374823749237502375123752237532375423755237562375723758237592376023761237622376323764237652376623767237682376923770237712377223773237742377523776237772377823779237802378123782237832378423785237862378723788237892379023791237922379323794237952379623797237982379923800238012380223803238042380523806238072380823809238102381123812238132381423815238162381723818238192382023821238222382323824238252382623827238282382923830238312383223833238342383523836238372383823839238402384123842238432384423845238462384723848238492385023851238522385323854238552385623857238582385923860238612386223863238642386523866238672386823869238702387123872238732387423875238762387723878238792388023881238822388323884238852388623887238882388923890238912389223893238942389523896238972389823899239002390123902239032390423905239062390723908239092391023911239122391323914239152391623917239182391923920239212392223923239242392523926239272392823929239302393123932239332393423935239362393723938239392394023941239422394323944239452394623947239482394923950239512395223953239542395523956239572395823959239602396123962239632396423965239662396723968239692397023971239722397323974239752397623977239782397923980239812398223983239842398523986239872398823989239902399123992239932399423995239962399723998239992400024001240022400324004240052400624007240082400924010240112401224013
  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.62.0"
  10. #define CPPHTTPLIB_VERSION_NUM "0x003e00"
  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_static_file_compression(bool on);
  1959. Server &set_static_file_compression_min_length(size_t length);
  1960. Server &set_static_file_compression_max_length(size_t length);
  1961. Server &set_websocket_ping_interval(time_t sec);
  1962. template <class Rep, class Period>
  1963. Server &set_websocket_ping_interval(
  1964. const std::chrono::duration<Rep, Period> &duration);
  1965. Server &set_websocket_max_missed_pongs(int count);
  1966. bool bind_to_port(const std::string &host, int port, int socket_flags = 0);
  1967. int bind_to_any_port(const std::string &host, int socket_flags = 0);
  1968. bool listen_after_bind();
  1969. bool listen(const std::string &host, int port, int socket_flags = 0);
  1970. bool is_running() const;
  1971. void wait_until_ready() const;
  1972. void stop() noexcept;
  1973. void decommission();
  1974. std::function<TaskQueue *(void)> new_task_queue;
  1975. protected:
  1976. bool process_request(Stream &strm, const std::string &remote_addr,
  1977. int remote_port, const std::string &local_addr,
  1978. int local_port, bool close_connection,
  1979. bool &connection_closed,
  1980. const std::function<void(Request &)> &setup_request,
  1981. bool *websocket_upgraded = nullptr);
  1982. // Runs the per-connection serving loop and stops an exception thrown by a
  1983. // user callback from escaping the worker thread.
  1984. //
  1985. // process_request() wraps only routing() in a try/catch. Content providers,
  1986. // the post-routing, error, logging and expect-100 handlers and WebSocket
  1987. // handlers all run outside it, and the task queue calls the job without a
  1988. // catch, so an exception from any of those would terminate the process.
  1989. //
  1990. // No 500 is possible here: by the time a content provider runs, the status
  1991. // line and headers are already on the wire. Report it through the error
  1992. // logger and drop the connection, which is what the peer observes either
  1993. // way. Other connections are unaffected.
  1994. template <typename Serve> bool serve_guarded(Serve &&serve) const {
  1995. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  1996. return serve();
  1997. #else
  1998. try {
  1999. return serve();
  2000. } catch (...) {
  2001. // The error logger is a user callback too, so it must not be able to
  2002. // throw the guard back open.
  2003. try {
  2004. output_error_log(Error::UserCallbackException, nullptr);
  2005. } catch (...) {}
  2006. return false;
  2007. }
  2008. #endif
  2009. }
  2010. std::atomic<socket_t> svr_sock_{INVALID_SOCKET};
  2011. std::vector<std::string> trusted_proxies_;
  2012. size_t keep_alive_max_count_ = CPPHTTPLIB_KEEPALIVE_MAX_COUNT;
  2013. time_t keep_alive_timeout_sec_ = CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND;
  2014. time_t read_timeout_sec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND;
  2015. time_t read_timeout_usec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND;
  2016. time_t write_timeout_sec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND;
  2017. time_t write_timeout_usec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND;
  2018. time_t idle_interval_sec_ = CPPHTTPLIB_IDLE_INTERVAL_SECOND;
  2019. time_t idle_interval_usec_ = CPPHTTPLIB_IDLE_INTERVAL_USECOND;
  2020. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2021. bool static_file_compression_ = false;
  2022. size_t static_file_compression_min_length_ =
  2023. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH;
  2024. size_t static_file_compression_max_length_ =
  2025. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH;
  2026. time_t websocket_ping_interval_sec_ =
  2027. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  2028. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  2029. private:
  2030. using Handlers =
  2031. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, Handler>>;
  2032. using HandlersForContentReader =
  2033. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>,
  2034. HandlerWithContentReader>>;
  2035. // Both handler tables for one custom method live in a single entry, so that
  2036. // routing() needs only one map lookup per request to reach either of them.
  2037. struct CustomHandlerEntry {
  2038. Handlers handlers;
  2039. HandlersForContentReader handlers_for_content_reader;
  2040. };
  2041. using CustomHandlers = std::map<std::string, CustomHandlerEntry>;
  2042. static std::unique_ptr<detail::MatcherBase>
  2043. make_matcher(const std::string &pattern);
  2044. static const std::set<std::string> &builtin_methods();
  2045. CustomHandlerEntry *custom_entry_for_registration(const std::string &method);
  2046. const CustomHandlerEntry *find_custom_entry(const std::string &method) const;
  2047. template <typename H>
  2048. Server &add_handler(
  2049. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, H>> &handlers,
  2050. const std::string &pattern, H handler) {
  2051. handlers.emplace_back(make_matcher(pattern), std::move(handler));
  2052. return *this;
  2053. }
  2054. Server &set_error_handler_core(HandlerWithResponse handler, std::true_type);
  2055. Server &set_error_handler_core(Handler handler, std::false_type);
  2056. socket_t create_server_socket(const std::string &host, int port,
  2057. int socket_flags,
  2058. SocketOptions socket_options) const;
  2059. int bind_internal(const std::string &host, int port, int socket_flags);
  2060. bool listen_internal();
  2061. bool routing(Request &req, Response &res, Stream &strm,
  2062. bool skip_pre_routing);
  2063. bool handle_file_request(Request &req, Response &res);
  2064. bool check_if_not_modified(const Request &req, Response &res,
  2065. const std::string &etag, time_t mtime) const;
  2066. bool check_if_range(Request &req, const std::string &etag,
  2067. time_t mtime) const;
  2068. bool dispatch_request(Request &req, Response &res, const Handlers &handlers,
  2069. Stream &strm);
  2070. bool dispatch_request_for_content_reader(
  2071. Request &req, Response &res, ContentReader content_reader,
  2072. const HandlersForContentReader &handlers) const;
  2073. bool parse_request_line(const char *s, Request &req) const;
  2074. detail::EncodingType static_file_encoding(const Request &req,
  2075. const Response &res,
  2076. const std::string &content_type,
  2077. size_t length) const;
  2078. bool apply_static_file_compression(const Request &req, Response &res) const;
  2079. void apply_ranges(const Request &req, Response &res,
  2080. std::string &content_type, std::string &boundary) const;
  2081. bool write_response(Stream &strm, bool close_connection, Request &req,
  2082. Response &res);
  2083. bool write_response_with_content(Stream &strm, bool close_connection,
  2084. const Request &req, Response &res);
  2085. bool write_response_core(Stream &strm, bool close_connection,
  2086. const Request &req, Response &res,
  2087. bool need_apply_ranges);
  2088. bool write_content_with_provider(Stream &strm, const Request &req,
  2089. Response &res, const std::string &boundary,
  2090. const std::string &content_type);
  2091. bool read_content(Stream &strm, Request &req, Response &res);
  2092. bool read_content_with_content_receiver(Stream &strm, Request &req,
  2093. Response &res,
  2094. ContentReceiver receiver,
  2095. FormDataHeader multipart_header,
  2096. ContentReceiver multipart_receiver);
  2097. bool read_content_core(Stream &strm, Request &req, Response &res,
  2098. ContentReceiver receiver,
  2099. FormDataHeader multipart_header,
  2100. ContentReceiver multipart_receiver) const;
  2101. virtual bool process_and_close_socket(socket_t sock);
  2102. void output_log(const Request &req, const Response &res) const;
  2103. void output_pre_compression_log(const Request &req,
  2104. const Response &res) const;
  2105. void output_error_log(const Error &err, const Request *req) const;
  2106. std::atomic<bool> is_running_{false};
  2107. std::atomic<bool> is_decommissioned{false};
  2108. // Set when CustomRoute() refuses a registration. Written before listen(),
  2109. // read by is_valid() on the same thread, so it needs no synchronization.
  2110. bool has_invalid_registration_ = false;
  2111. struct MountPointEntry {
  2112. std::string mount_point;
  2113. std::string base_dir;
  2114. std::string resolved_base_dir;
  2115. Headers headers;
  2116. };
  2117. std::vector<MountPointEntry> base_dirs_;
  2118. std::map<std::string, std::string> file_extension_and_mimetype_map_;
  2119. std::string default_file_mimetype_ = "application/octet-stream";
  2120. Handler file_request_handler_;
  2121. Handlers get_handlers_;
  2122. Handlers post_handlers_;
  2123. HandlersForContentReader post_handlers_for_content_reader_;
  2124. Handlers put_handlers_;
  2125. HandlersForContentReader put_handlers_for_content_reader_;
  2126. Handlers patch_handlers_;
  2127. HandlersForContentReader patch_handlers_for_content_reader_;
  2128. Handlers delete_handlers_;
  2129. HandlersForContentReader delete_handlers_for_content_reader_;
  2130. Handlers options_handlers_;
  2131. CustomHandlers custom_handlers_;
  2132. struct WebSocketHandlerEntry {
  2133. std::unique_ptr<detail::MatcherBase> matcher;
  2134. WebSocketHandler handler;
  2135. SubProtocolSelector sub_protocol_selector;
  2136. };
  2137. using WebSocketHandlers = std::vector<WebSocketHandlerEntry>;
  2138. WebSocketHandlers websocket_handlers_;
  2139. HandlerWithResponse error_handler_;
  2140. ExceptionHandler exception_handler_;
  2141. HandlerWithResponse pre_routing_handler_;
  2142. Handler post_routing_handler_;
  2143. HandlerWithResponse pre_request_handler_;
  2144. Expect100ContinueHandler expect_100_continue_handler_;
  2145. StartHandler start_handler_;
  2146. mutable std::mutex logger_mutex_;
  2147. Logger logger_;
  2148. Logger pre_compression_logger_;
  2149. ErrorLogger error_logger_;
  2150. int address_family_ = AF_UNSPEC;
  2151. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2152. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2153. SocketOptions socket_options_ = default_socket_options;
  2154. Headers default_headers_;
  2155. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2156. detail::write_headers;
  2157. };
  2158. class Result {
  2159. public:
  2160. Result() = default;
  2161. Result(std::unique_ptr<Response> &&res, Error err,
  2162. Headers &&request_headers = Headers{})
  2163. : res_(std::move(res)), err_(err),
  2164. request_headers_(std::move(request_headers)) {}
  2165. // Response
  2166. operator bool() const { return res_ != nullptr; }
  2167. bool operator==(std::nullptr_t) const { return res_ == nullptr; }
  2168. bool operator!=(std::nullptr_t) const { return res_ != nullptr; }
  2169. const Response &value() const { return *res_; }
  2170. Response &value() { return *res_; }
  2171. const Response &operator*() const { return *res_; }
  2172. Response &operator*() { return *res_; }
  2173. const Response *operator->() const { return res_.get(); }
  2174. Response *operator->() { return res_.get(); }
  2175. // Error
  2176. Error error() const { return err_; }
  2177. // Request Headers
  2178. bool has_request_header(const std::string &key) const;
  2179. std::string get_request_header_value(const std::string &key,
  2180. const char *def = "",
  2181. size_t id = 0) const;
  2182. size_t get_request_header_value_u64(const std::string &key, size_t def = 0,
  2183. size_t id = 0) const;
  2184. size_t get_request_header_value_count(const std::string &key) const;
  2185. private:
  2186. std::unique_ptr<Response> res_;
  2187. Error err_ = Error::Unknown;
  2188. Headers request_headers_;
  2189. #ifdef CPPHTTPLIB_SSL_ENABLED
  2190. public:
  2191. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2192. int ssl_error)
  2193. : res_(std::move(res)), err_(err),
  2194. request_headers_(std::move(request_headers)), ssl_error_(ssl_error) {}
  2195. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2196. int ssl_error, uint64_t ssl_backend_error)
  2197. : res_(std::move(res)), err_(err),
  2198. request_headers_(std::move(request_headers)), ssl_error_(ssl_error),
  2199. ssl_backend_error_(ssl_backend_error) {}
  2200. int ssl_error() const { return ssl_error_; }
  2201. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  2202. private:
  2203. int ssl_error_ = 0;
  2204. uint64_t ssl_backend_error_ = 0;
  2205. #endif
  2206. };
  2207. struct ClientConnection {
  2208. socket_t sock = INVALID_SOCKET;
  2209. bool is_open() const { return sock != INVALID_SOCKET; }
  2210. ClientConnection() = default;
  2211. ~ClientConnection();
  2212. ClientConnection(const ClientConnection &) = delete;
  2213. ClientConnection &operator=(const ClientConnection &) = delete;
  2214. ClientConnection(ClientConnection &&other) noexcept
  2215. : sock(other.sock)
  2216. #ifdef CPPHTTPLIB_SSL_ENABLED
  2217. ,
  2218. session(other.session)
  2219. #endif
  2220. {
  2221. other.sock = INVALID_SOCKET;
  2222. #ifdef CPPHTTPLIB_SSL_ENABLED
  2223. other.session = nullptr;
  2224. #endif
  2225. }
  2226. ClientConnection &operator=(ClientConnection &&other) noexcept {
  2227. if (this != &other) {
  2228. sock = other.sock;
  2229. other.sock = INVALID_SOCKET;
  2230. #ifdef CPPHTTPLIB_SSL_ENABLED
  2231. session = other.session;
  2232. other.session = nullptr;
  2233. #endif
  2234. }
  2235. return *this;
  2236. }
  2237. #ifdef CPPHTTPLIB_SSL_ENABLED
  2238. tls::session_t session = nullptr;
  2239. #endif
  2240. };
  2241. namespace detail {
  2242. struct ChunkedDecoder;
  2243. struct BodyReader {
  2244. Stream *stream = nullptr;
  2245. bool has_content_length = false;
  2246. size_t content_length = 0;
  2247. size_t payload_max_length = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2248. size_t bytes_read = 0;
  2249. bool chunked = false;
  2250. bool eof = false;
  2251. std::unique_ptr<ChunkedDecoder> chunked_decoder;
  2252. Error last_error = Error::Success;
  2253. ssize_t read(char *buf, size_t len);
  2254. bool has_error() const { return last_error != Error::Success; }
  2255. };
  2256. inline ssize_t read_body_content(Stream *stream, BodyReader &br, char *buf,
  2257. size_t len) {
  2258. (void)stream;
  2259. return br.read(buf, len);
  2260. }
  2261. class decompressor;
  2262. enum class NoProxyKind {
  2263. Wildcard, // "*"
  2264. HostnameSuffix, // "example.com" or ".example.com"
  2265. IPv4Cidr, // "10.0.0.0/8" (or single IP, treated as /32)
  2266. IPv6Cidr, // "fe80::/10" (or single IP, treated as /128)
  2267. };
  2268. // Unified 16-byte buffer holding either a v4 (first 4 bytes) or v6 address.
  2269. // Lets one CIDR matcher cover both families.
  2270. using IPBytes = std::array<uint8_t, 16>;
  2271. struct NoProxyEntry {
  2272. NoProxyKind kind = NoProxyKind::Wildcard;
  2273. std::string hostname_pattern; // lowercased, leading/trailing dot stripped
  2274. IPBytes net{};
  2275. int prefix_bits = 0;
  2276. };
  2277. struct NormalizedTarget {
  2278. std::string hostname; // lowercase; brackets and trailing dot removed
  2279. bool is_ipv4 = false;
  2280. bool is_ipv6 = false;
  2281. IPBytes ip{};
  2282. };
  2283. } // namespace detail
  2284. class ClientImpl {
  2285. public:
  2286. explicit ClientImpl(const std::string &host);
  2287. explicit ClientImpl(const std::string &host, int port);
  2288. explicit ClientImpl(const std::string &host, int port,
  2289. const std::string &client_cert_path,
  2290. const std::string &client_key_path);
  2291. virtual ~ClientImpl();
  2292. virtual bool is_valid() const;
  2293. struct StreamHandle {
  2294. std::unique_ptr<Response> response;
  2295. Error error = Error::Success;
  2296. StreamHandle() = default;
  2297. StreamHandle(const StreamHandle &) = delete;
  2298. StreamHandle &operator=(const StreamHandle &) = delete;
  2299. StreamHandle(StreamHandle &&) = default;
  2300. StreamHandle &operator=(StreamHandle &&) = default;
  2301. ~StreamHandle() = default;
  2302. bool is_valid() const {
  2303. return response != nullptr && error == Error::Success;
  2304. }
  2305. ssize_t read(char *buf, size_t len);
  2306. void parse_trailers_if_needed();
  2307. Error get_read_error() const { return body_reader_.last_error; }
  2308. bool has_read_error() const { return body_reader_.has_error(); }
  2309. bool trailers_parsed_ = false;
  2310. private:
  2311. friend class ClientImpl;
  2312. friend class sse::SSEClient;
  2313. ssize_t read_with_decompression(char *buf, size_t len);
  2314. std::unique_ptr<ClientConnection> connection_;
  2315. std::unique_ptr<Stream> socket_stream_;
  2316. Stream *stream_ = nullptr;
  2317. detail::BodyReader body_reader_;
  2318. std::unique_ptr<detail::decompressor> decompressor_;
  2319. std::string decompress_buffer_;
  2320. size_t decompress_offset_ = 0;
  2321. size_t decompressed_bytes_read_ = 0;
  2322. };
  2323. // clang-format off
  2324. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2325. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2326. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2327. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2328. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2329. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2330. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2331. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2332. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2333. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2334. Result Head(const std::string &path);
  2335. Result Head(const std::string &path, const Headers &headers);
  2336. Result Post(const std::string &path);
  2337. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2338. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2339. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2340. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2341. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2342. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2343. Result Post(const std::string &path, const Params &params);
  2344. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2345. Result Post(const std::string &path, const Headers &headers);
  2346. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2347. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2348. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2349. 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);
  2350. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2351. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2352. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2353. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2354. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2355. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2356. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2357. Result Put(const std::string &path);
  2358. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2359. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2360. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2361. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2362. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2363. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2364. Result Put(const std::string &path, const Params &params);
  2365. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2366. Result Put(const std::string &path, const Headers &headers);
  2367. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2368. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2369. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2370. 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);
  2371. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2372. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2373. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2374. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2375. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2376. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2377. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2378. Result Patch(const std::string &path);
  2379. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2380. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2381. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2382. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2383. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2384. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2385. Result Patch(const std::string &path, const Params &params);
  2386. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2387. Result Patch(const std::string &path, const Headers &headers, UploadProgress progress = nullptr);
  2388. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2389. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2390. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2391. 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);
  2392. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2393. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2394. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2395. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2396. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2397. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2398. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2399. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2400. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2401. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2402. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2403. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2404. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2405. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2406. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2407. Result Options(const std::string &path);
  2408. Result Options(const std::string &path, const Headers &headers);
  2409. // clang-format on
  2410. // Streaming API: Open a stream for reading response body incrementally
  2411. // Socket ownership is transferred to StreamHandle for true streaming
  2412. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2413. StreamHandle open_stream(const std::string &method, const std::string &path,
  2414. const Params &params = {},
  2415. const Headers &headers = {},
  2416. const std::string &body = {},
  2417. const std::string &content_type = {});
  2418. bool send(Request &req, Response &res, Error &error);
  2419. Result send(const Request &req);
  2420. void stop();
  2421. std::string host() const;
  2422. int port() const;
  2423. size_t is_socket_open() const;
  2424. socket_t socket() const;
  2425. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2426. void set_default_headers(Headers headers);
  2427. void
  2428. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2429. void set_address_family(int family);
  2430. void set_tcp_nodelay(bool on);
  2431. void set_ipv6_v6only(bool on);
  2432. void set_socket_options(SocketOptions socket_options);
  2433. void set_connection_timeout(time_t sec, time_t usec = 0);
  2434. template <class Rep, class Period>
  2435. void
  2436. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2437. void set_read_timeout(time_t sec, time_t usec = 0);
  2438. template <class Rep, class Period>
  2439. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2440. void set_write_timeout(time_t sec, time_t usec = 0);
  2441. template <class Rep, class Period>
  2442. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2443. void set_max_timeout(time_t msec);
  2444. template <class Rep, class Period>
  2445. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2446. void set_basic_auth(const std::string &username, const std::string &password);
  2447. void set_bearer_token_auth(const std::string &token);
  2448. void set_keep_alive(bool on);
  2449. void set_follow_location(bool on);
  2450. void set_path_encode(bool on);
  2451. void set_compress(bool on);
  2452. void set_decompress(bool on);
  2453. void set_payload_max_length(size_t length);
  2454. void set_interface(const std::string &intf);
  2455. void set_proxy(const std::string &host, int port);
  2456. void set_proxy_basic_auth(const std::string &username,
  2457. const std::string &password);
  2458. void set_proxy_bearer_token_auth(const std::string &token);
  2459. void set_no_proxy(const std::vector<std::string> &patterns);
  2460. void set_logger(Logger logger);
  2461. void set_error_logger(ErrorLogger error_logger);
  2462. protected:
  2463. struct Socket {
  2464. socket_t sock = INVALID_SOCKET;
  2465. // For Mbed TLS compatibility: start_time for request timeout tracking
  2466. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  2467. bool is_open() const { return sock != INVALID_SOCKET; }
  2468. #ifdef CPPHTTPLIB_SSL_ENABLED
  2469. tls::session_t ssl = nullptr;
  2470. #endif
  2471. };
  2472. virtual bool create_and_connect_socket(Socket &socket, Error &error);
  2473. virtual bool ensure_socket_connection(Socket &socket, Error &error);
  2474. virtual bool setup_proxy_connection(
  2475. Socket &socket,
  2476. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2477. Response &res, bool &success, Error &error);
  2478. bool is_proxy_enabled_for_host(const std::string &host) const;
  2479. // All of:
  2480. // shutdown_ssl
  2481. // shutdown_socket
  2482. // close_socket
  2483. // disconnect
  2484. // should ONLY be called when socket_mutex_ is locked, and only when
  2485. // no other thread is using the socket.
  2486. virtual void shutdown_ssl(Socket &socket, bool shutdown_gracefully);
  2487. void shutdown_socket(Socket &socket) const;
  2488. void close_socket(Socket &socket);
  2489. void disconnect(bool gracefully);
  2490. std::string make_request_target(const Request &req) const;
  2491. bool process_request(Stream &strm, Request &req, Response &res,
  2492. bool close_connection, Error &error);
  2493. bool write_content_with_provider(Stream &strm, const Request &req,
  2494. Error &error) const;
  2495. void output_log(const Request &req, const Response &res) const;
  2496. void output_error_log(const Error &err, const Request *req) const;
  2497. // Socket endpoint information
  2498. const std::string host_;
  2499. const int port_;
  2500. // Current open socket
  2501. Socket socket_;
  2502. mutable std::mutex socket_mutex_;
  2503. std::recursive_mutex request_mutex_;
  2504. // How many send() calls are running on this client, guarded by
  2505. // request_mutex_
  2506. size_t send_depth_ = 0;
  2507. // These are all protected under socket_mutex
  2508. size_t socket_requests_in_flight_ = 0;
  2509. std::thread::id socket_requests_are_from_thread_ = std::thread::id();
  2510. bool socket_should_be_closed_when_request_is_done_ = false;
  2511. // Hostname to connection target map. The value is an IP literal or another
  2512. // hostname; only the connection target changes, never the identity.
  2513. std::map<std::string, std::string> addr_map_;
  2514. // Default headers
  2515. Headers default_headers_;
  2516. // Header writer
  2517. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2518. detail::write_headers;
  2519. // Settings
  2520. std::string client_cert_path_;
  2521. std::string client_key_path_;
  2522. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  2523. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  2524. time_t read_timeout_sec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND;
  2525. time_t read_timeout_usec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND;
  2526. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  2527. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  2528. time_t max_timeout_msec_ = CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND;
  2529. std::string basic_auth_username_;
  2530. std::string basic_auth_password_;
  2531. std::string bearer_token_auth_token_;
  2532. bool keep_alive_ = false;
  2533. bool follow_location_ = false;
  2534. bool path_encode_ = true;
  2535. int address_family_ = AF_UNSPEC;
  2536. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2537. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2538. SocketOptions socket_options_ = nullptr;
  2539. bool compress_ = false;
  2540. bool decompress_ = true;
  2541. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2542. bool has_payload_max_length_ = false;
  2543. std::string interface_;
  2544. std::string proxy_host_;
  2545. int proxy_port_ = -1;
  2546. std::string proxy_basic_auth_username_;
  2547. std::string proxy_basic_auth_password_;
  2548. std::string proxy_bearer_token_auth_token_;
  2549. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  2550. mutable detail::NormalizedTarget host_normalized_;
  2551. mutable bool host_normalized_valid_ = false;
  2552. mutable std::mutex logger_mutex_;
  2553. Logger logger_;
  2554. ErrorLogger error_logger_;
  2555. private:
  2556. bool send_(Request &req, Response &res, Error &error);
  2557. Result send_(Request &&req);
  2558. socket_t create_client_socket(Error &error) const;
  2559. bool read_response_line(Stream &strm, const Request &req, Response &res,
  2560. bool skip_100_continue = true) const;
  2561. bool write_request(Stream &strm, Request &req, bool close_connection,
  2562. Error &error, bool skip_body, bool &rejected_locally);
  2563. bool write_request_body(Stream &strm, Request &req, Error &error);
  2564. void prepare_default_headers(Request &r, bool for_stream,
  2565. const std::string &ct);
  2566. bool redirect(Request &req, Response &res, Error &error);
  2567. bool create_redirect_client(const std::string &scheme,
  2568. const std::string &host, int port, Request &req,
  2569. Response &res, const std::string &path,
  2570. const std::string &location, Error &error);
  2571. template <typename ClientType> void setup_redirect_client(ClientType &client);
  2572. bool handle_request(Stream &strm, Request &req, Response &res,
  2573. bool close_connection, Error &error);
  2574. std::unique_ptr<Response> send_with_content_provider_and_receiver(
  2575. Request &req, const char *body, size_t content_length,
  2576. ContentProvider content_provider,
  2577. ContentProviderWithoutLength content_provider_without_length,
  2578. const std::string &content_type, ContentReceiver content_receiver,
  2579. Error &error);
  2580. Result send_with_content_provider_and_receiver(
  2581. const std::string &method, const std::string &path,
  2582. const Headers &headers, const char *body, size_t content_length,
  2583. ContentProvider content_provider,
  2584. ContentProviderWithoutLength content_provider_without_length,
  2585. const std::string &content_type, ContentReceiver content_receiver,
  2586. UploadProgress progress);
  2587. ContentProviderWithoutLength get_multipart_content_provider(
  2588. const std::string &boundary, const UploadFormDataItems &items,
  2589. const FormDataProviderItems &provider_items) const;
  2590. virtual bool
  2591. process_socket(const Socket &socket,
  2592. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2593. std::function<bool(Stream &strm)> callback);
  2594. virtual bool is_ssl() const;
  2595. void transfer_socket_ownership_to_handle(StreamHandle &handle);
  2596. StreamHandle open_stream_(Request &req);
  2597. void add_credential_headers(Request &req);
  2598. std::string proxy_target_prefix() const;
  2599. #ifdef CPPHTTPLIB_SSL_ENABLED
  2600. public:
  2601. void set_digest_auth(const std::string &username,
  2602. const std::string &password);
  2603. void set_proxy_digest_auth(const std::string &username,
  2604. const std::string &password);
  2605. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2606. const std::string &ca_cert_dir_path = std::string());
  2607. void enable_server_certificate_verification(bool enabled);
  2608. void enable_server_hostname_verification(bool enabled);
  2609. void enable_system_ca(bool enabled);
  2610. protected:
  2611. std::string digest_auth_username_;
  2612. std::string digest_auth_password_;
  2613. std::string proxy_digest_auth_username_;
  2614. std::string proxy_digest_auth_password_;
  2615. std::string ca_cert_file_path_;
  2616. std::string ca_cert_dir_path_;
  2617. bool server_certificate_verification_ = true;
  2618. bool server_hostname_verification_ = true;
  2619. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  2620. std::string ca_cert_pem_; // Store CA cert PEM for redirect transfer
  2621. int last_ssl_error_ = 0;
  2622. uint64_t last_backend_error_ = 0;
  2623. #endif
  2624. };
  2625. namespace detail {
  2626. // Stands in for a client that Client could not make from its arguments, so a
  2627. // request fails rather than going through a null pointer.
  2628. class InvalidClientImpl final : public ClientImpl {
  2629. public:
  2630. InvalidClientImpl() : ClientImpl(std::string(), 0) {}
  2631. bool is_valid() const override { return false; }
  2632. private:
  2633. bool create_and_connect_socket(Socket &, Error &error) override {
  2634. error = Error::Connection;
  2635. return false;
  2636. }
  2637. };
  2638. } // namespace detail
  2639. class Client {
  2640. public:
  2641. // Universal interface
  2642. explicit Client(const std::string &scheme_host_port);
  2643. explicit Client(const std::string &scheme_host_port,
  2644. const std::string &client_cert_path,
  2645. const std::string &client_key_path);
  2646. // HTTP only interface
  2647. explicit Client(const std::string &host, int port);
  2648. explicit Client(const std::string &host, int port,
  2649. const std::string &client_cert_path,
  2650. const std::string &client_key_path);
  2651. Client(Client &&) = default;
  2652. Client &operator=(Client &&) = default;
  2653. ~Client();
  2654. bool is_valid() const;
  2655. // clang-format off
  2656. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2657. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2658. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2659. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2660. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2661. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2662. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2663. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2664. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2665. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2666. Result Head(const std::string &path);
  2667. Result Head(const std::string &path, const Headers &headers);
  2668. Result Post(const std::string &path);
  2669. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2670. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2671. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2672. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2673. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2674. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2675. Result Post(const std::string &path, const Params &params);
  2676. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2677. Result Post(const std::string &path, const Headers &headers);
  2678. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2679. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2680. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2681. 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);
  2682. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2683. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2684. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2685. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2686. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2687. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2688. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2689. Result Put(const std::string &path);
  2690. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2691. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2692. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2693. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2694. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2695. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2696. Result Put(const std::string &path, const Params &params);
  2697. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2698. Result Put(const std::string &path, const Headers &headers);
  2699. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2700. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2701. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2702. 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);
  2703. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2704. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2705. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2706. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2707. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2708. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2709. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2710. Result Patch(const std::string &path);
  2711. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2712. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2713. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2714. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2715. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2716. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2717. Result Patch(const std::string &path, const Params &params);
  2718. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2719. Result Patch(const std::string &path, const Headers &headers);
  2720. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2721. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2722. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2723. 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);
  2724. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2725. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2726. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2727. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2728. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2729. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2730. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2731. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2732. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2733. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2734. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2735. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2736. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2737. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2738. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2739. Result Options(const std::string &path);
  2740. Result Options(const std::string &path, const Headers &headers);
  2741. // clang-format on
  2742. // Streaming API: Open a stream for reading response body incrementally
  2743. // Socket ownership is transferred to StreamHandle for true streaming
  2744. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2745. ClientImpl::StreamHandle open_stream(const std::string &method,
  2746. const std::string &path,
  2747. const Params &params = {},
  2748. const Headers &headers = {},
  2749. const std::string &body = {},
  2750. const std::string &content_type = {});
  2751. bool send(Request &req, Response &res, Error &error);
  2752. Result send(const Request &req);
  2753. void stop();
  2754. std::string host() const;
  2755. int port() const;
  2756. size_t is_socket_open() const;
  2757. socket_t socket() const;
  2758. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2759. void set_default_headers(Headers headers);
  2760. void
  2761. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2762. void set_address_family(int family);
  2763. void set_tcp_nodelay(bool on);
  2764. void set_socket_options(SocketOptions socket_options);
  2765. void set_connection_timeout(time_t sec, time_t usec = 0);
  2766. template <class Rep, class Period>
  2767. void
  2768. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2769. void set_read_timeout(time_t sec, time_t usec = 0);
  2770. template <class Rep, class Period>
  2771. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2772. void set_write_timeout(time_t sec, time_t usec = 0);
  2773. template <class Rep, class Period>
  2774. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2775. void set_max_timeout(time_t msec);
  2776. template <class Rep, class Period>
  2777. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2778. void set_basic_auth(const std::string &username, const std::string &password);
  2779. void set_bearer_token_auth(const std::string &token);
  2780. void set_keep_alive(bool on);
  2781. void set_follow_location(bool on);
  2782. void set_path_encode(bool on);
  2783. void set_compress(bool on);
  2784. void set_decompress(bool on);
  2785. void set_payload_max_length(size_t length);
  2786. void set_interface(const std::string &intf);
  2787. void set_proxy(const std::string &host, int port);
  2788. void set_proxy_basic_auth(const std::string &username,
  2789. const std::string &password);
  2790. void set_proxy_bearer_token_auth(const std::string &token);
  2791. void set_no_proxy(const std::vector<std::string> &patterns);
  2792. void set_logger(Logger logger);
  2793. void set_error_logger(ErrorLogger error_logger);
  2794. private:
  2795. std::unique_ptr<ClientImpl> cli_;
  2796. #ifdef CPPHTTPLIB_SSL_ENABLED
  2797. public:
  2798. void set_digest_auth(const std::string &username,
  2799. const std::string &password);
  2800. void set_proxy_digest_auth(const std::string &username,
  2801. const std::string &password);
  2802. void enable_server_certificate_verification(bool enabled);
  2803. void enable_server_hostname_verification(bool enabled);
  2804. void enable_system_ca(bool enabled);
  2805. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2806. const std::string &ca_cert_dir_path = std::string());
  2807. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2808. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2809. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2810. void set_session_verifier(
  2811. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2812. tls::ctx_t tls_context() const;
  2813. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2814. void enable_windows_certificate_verification(bool enabled);
  2815. #endif
  2816. private:
  2817. bool is_ssl_ = false;
  2818. #endif
  2819. };
  2820. #ifdef CPPHTTPLIB_SSL_ENABLED
  2821. class SSLServer : public Server {
  2822. public:
  2823. SSLServer(const char *cert_path, const char *private_key_path,
  2824. const char *client_ca_cert_file_path = nullptr,
  2825. const char *client_ca_cert_dir_path = nullptr,
  2826. const char *private_key_password = nullptr);
  2827. struct PemMemory {
  2828. const char *cert_pem;
  2829. size_t cert_pem_len;
  2830. const char *key_pem;
  2831. size_t key_pem_len;
  2832. const char *client_ca_pem;
  2833. size_t client_ca_pem_len;
  2834. const char *private_key_password;
  2835. };
  2836. explicit SSLServer(const PemMemory &pem);
  2837. // The callback receives the ctx_t handle which can be cast to the
  2838. // appropriate backend type (SSL_CTX* for OpenSSL,
  2839. // tls::impl::MbedTlsContext* for Mbed TLS)
  2840. explicit SSLServer(const tls::ContextSetupCallback &setup_callback);
  2841. ~SSLServer() override;
  2842. bool is_valid() const override;
  2843. bool update_certs_pem(const char *cert_pem, const char *key_pem,
  2844. const char *client_ca_pem = nullptr,
  2845. const char *password = nullptr);
  2846. tls::ctx_t tls_context() const { return ctx_; }
  2847. int ssl_last_error() const { return last_ssl_error_; }
  2848. private:
  2849. bool process_and_close_socket(socket_t sock) override;
  2850. tls::ctx_t ctx_ = nullptr;
  2851. // update_certs_pem() replaces the certificates and CAs that handshakes read
  2852. // from ctx_, so it waits for the handshakes in progress, which their timeout
  2853. // bounds, and new ones wait while it is pending so that they cannot keep it
  2854. // waiting.
  2855. std::mutex ctx_mutex_;
  2856. std::condition_variable ctx_cv_;
  2857. size_t handshakes_in_progress_ = 0;
  2858. size_t updates_pending_ = 0;
  2859. int last_ssl_error_ = 0;
  2860. };
  2861. class SSLClient final : public ClientImpl {
  2862. public:
  2863. explicit SSLClient(const std::string &host);
  2864. explicit SSLClient(const std::string &host, int port);
  2865. explicit SSLClient(const std::string &host, int port,
  2866. const std::string &client_cert_path,
  2867. const std::string &client_key_path,
  2868. const std::string &private_key_password = std::string());
  2869. struct PemMemory {
  2870. const char *cert_pem;
  2871. size_t cert_pem_len;
  2872. const char *key_pem;
  2873. size_t key_pem_len;
  2874. const char *private_key_password;
  2875. };
  2876. explicit SSLClient(const std::string &host, int port, const PemMemory &pem);
  2877. ~SSLClient() override;
  2878. bool is_valid() const override;
  2879. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2880. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2881. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2882. // Post-handshake session verifier (backend-independent)
  2883. void set_session_verifier(
  2884. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2885. tls::ctx_t tls_context() const { return ctx_; }
  2886. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2887. void enable_windows_certificate_verification(bool enabled);
  2888. #endif
  2889. private:
  2890. bool create_and_connect_socket(Socket &socket, Error &error) override;
  2891. bool ensure_socket_connection(Socket &socket, Error &error) override;
  2892. void shutdown_ssl(Socket &socket, bool shutdown_gracefully) override;
  2893. void shutdown_ssl_impl(Socket &socket, bool shutdown_gracefully);
  2894. bool
  2895. process_socket(const Socket &socket,
  2896. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2897. std::function<bool(Stream &strm)> callback) override;
  2898. bool is_ssl() const override;
  2899. bool setup_proxy_connection(
  2900. Socket &socket,
  2901. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2902. Response &res, bool &success, Error &error) override;
  2903. bool connect_with_proxy(
  2904. Socket &sock,
  2905. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2906. Response &res, bool &success, Error &error);
  2907. bool initialize_ssl(Socket &socket, Error &error);
  2908. void init_ctx();
  2909. void reset_ctx_on_error();
  2910. bool load_certs();
  2911. tls::ctx_t ctx_ = nullptr;
  2912. std::mutex ctx_mutex_;
  2913. std::once_flag initialize_cert_;
  2914. // Tracks whether a custom CA store was applied via set_ca_cert_store(),
  2915. // since the store handle itself is owned by ctx_ and leaves no other trace.
  2916. bool ca_cert_store_set_ = false;
  2917. // Set by set_ca_cert_store() and load_ca_cert_store() even when they bring
  2918. // no certificate, so that a CA that failed to come through fails
  2919. // verification instead of letting the system CAs in.
  2920. bool custom_ca_loaded_ = false;
  2921. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  2922. // Like ca_cert_store_set_, keeps what ctx_ cannot report back: the verifier
  2923. // set_server_certificate_verifier() installed there.
  2924. tls::VerifyCallback server_certificate_verifier_;
  2925. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2926. bool enable_windows_cert_verification_ = true;
  2927. #endif
  2928. friend class ClientImpl;
  2929. };
  2930. #endif // CPPHTTPLIB_SSL_ENABLED
  2931. namespace detail {
  2932. template <typename T, typename U>
  2933. inline void duration_to_sec_and_usec(const T &duration, U callback) {
  2934. auto sec = std::chrono::duration_cast<std::chrono::seconds>(duration).count();
  2935. auto usec = std::chrono::duration_cast<std::chrono::microseconds>(
  2936. duration - std::chrono::seconds(sec))
  2937. .count();
  2938. callback(static_cast<time_t>(sec), static_cast<time_t>(usec));
  2939. }
  2940. template <size_t N> inline constexpr size_t str_len(const char (&)[N]) {
  2941. return N - 1;
  2942. }
  2943. inline bool is_numeric(const std::string &str) {
  2944. return !str.empty() && std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  2945. }
  2946. // std::ranges::next(first, n, last) for C++11
  2947. template <typename It> inline It bounded_next(It first, size_t n, It last) {
  2948. for (; n > 0 && first != last; --n) {
  2949. ++first;
  2950. }
  2951. return first;
  2952. }
  2953. inline size_t get_header_value_u64(const Headers &headers,
  2954. const std::string &key, size_t def,
  2955. size_t id, bool &is_invalid_value) {
  2956. is_invalid_value = false;
  2957. auto rng = headers.equal_range(key);
  2958. auto it = bounded_next(rng.first, id, rng.second);
  2959. if (it != rng.second) {
  2960. if (is_numeric(it->second)) {
  2961. // Parse at size_t width so an out-of-range Content-Length is reported
  2962. // rather than silently saturated/truncated (a value above 2^32 would
  2963. // otherwise wrap to a small framing length on 32-bit builds). Flag it
  2964. // and return SIZE_MAX so the existing oversized-value guards reject it.
  2965. size_t val = 0;
  2966. const auto &s = it->second;
  2967. auto r = from_chars(s.data(), s.data() + s.size(), val);
  2968. if (r.ec == std::errc::result_out_of_range) {
  2969. is_invalid_value = true;
  2970. return (std::numeric_limits<size_t>::max)();
  2971. }
  2972. return val;
  2973. } else {
  2974. is_invalid_value = true;
  2975. }
  2976. }
  2977. return def;
  2978. }
  2979. inline size_t get_header_value_u64(const Headers &headers,
  2980. const std::string &key, size_t def,
  2981. size_t id) {
  2982. auto dummy = false;
  2983. return get_header_value_u64(headers, key, def, id, dummy);
  2984. }
  2985. } // namespace detail
  2986. template <class Rep, class Period>
  2987. inline Server &
  2988. Server::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2989. detail::duration_to_sec_and_usec(
  2990. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  2991. return *this;
  2992. }
  2993. template <class Rep, class Period>
  2994. inline Server &
  2995. Server::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2996. detail::duration_to_sec_and_usec(
  2997. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  2998. return *this;
  2999. }
  3000. template <class Rep, class Period>
  3001. inline Server &
  3002. Server::set_idle_interval(const std::chrono::duration<Rep, Period> &duration) {
  3003. detail::duration_to_sec_and_usec(
  3004. duration, [&](time_t sec, time_t usec) { set_idle_interval(sec, usec); });
  3005. return *this;
  3006. }
  3007. template <class Rep, class Period>
  3008. inline void ClientImpl::set_connection_timeout(
  3009. const std::chrono::duration<Rep, Period> &duration) {
  3010. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  3011. set_connection_timeout(sec, usec);
  3012. });
  3013. }
  3014. template <class Rep, class Period>
  3015. inline void ClientImpl::set_read_timeout(
  3016. const std::chrono::duration<Rep, Period> &duration) {
  3017. detail::duration_to_sec_and_usec(
  3018. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3019. }
  3020. template <class Rep, class Period>
  3021. inline void ClientImpl::set_write_timeout(
  3022. const std::chrono::duration<Rep, Period> &duration) {
  3023. detail::duration_to_sec_and_usec(
  3024. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3025. }
  3026. template <class Rep, class Period>
  3027. inline void ClientImpl::set_max_timeout(
  3028. const std::chrono::duration<Rep, Period> &duration) {
  3029. auto msec =
  3030. std::chrono::duration_cast<std::chrono::milliseconds>(duration).count();
  3031. set_max_timeout(static_cast<time_t>(msec));
  3032. }
  3033. template <class Rep, class Period>
  3034. inline void Client::set_connection_timeout(
  3035. const std::chrono::duration<Rep, Period> &duration) {
  3036. cli_->set_connection_timeout(duration);
  3037. }
  3038. template <class Rep, class Period>
  3039. inline void
  3040. Client::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3041. cli_->set_read_timeout(duration);
  3042. }
  3043. template <class Rep, class Period>
  3044. inline void
  3045. Client::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3046. cli_->set_write_timeout(duration);
  3047. }
  3048. inline void Client::set_max_timeout(time_t msec) {
  3049. cli_->set_max_timeout(msec);
  3050. }
  3051. template <class Rep, class Period>
  3052. inline void
  3053. Client::set_max_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3054. cli_->set_max_timeout(duration);
  3055. }
  3056. /*
  3057. * Forward declarations and types that will be part of the .h file if split into
  3058. * .h + .cc.
  3059. */
  3060. std::string hosted_at(const std::string &hostname);
  3061. void hosted_at(const std::string &hostname, std::vector<std::string> &addrs);
  3062. // JavaScript-style URL encoding/decoding functions
  3063. std::string encode_uri_component(const std::string &value);
  3064. std::string encode_uri(const std::string &value);
  3065. std::string decode_uri_component(const std::string &value);
  3066. std::string decode_uri(const std::string &value);
  3067. // RFC 3986 compliant URL component encoding/decoding functions
  3068. std::string encode_path_component(const std::string &component);
  3069. std::string decode_path_component(const std::string &component);
  3070. std::string encode_query_component(const std::string &component,
  3071. bool space_as_plus = true);
  3072. std::string decode_query_component(const std::string &component,
  3073. bool plus_as_space = true);
  3074. std::string sanitize_filename(const std::string &filename);
  3075. std::string append_query_params(const std::string &path, const Params &params);
  3076. std::pair<std::string, std::string> make_range_header(const Ranges &ranges);
  3077. std::pair<std::string, std::string>
  3078. make_basic_authentication_header(const std::string &username,
  3079. const std::string &password,
  3080. bool is_proxy = false);
  3081. namespace detail {
  3082. #if defined(_WIN32)
  3083. inline std::wstring u8string_to_wstring(const char *s) {
  3084. if (!s) { return std::wstring(); }
  3085. auto len = static_cast<int>(strlen(s));
  3086. if (!len) { return std::wstring(); }
  3087. auto wlen = ::MultiByteToWideChar(CP_UTF8, 0, s, len, nullptr, 0);
  3088. if (!wlen) { return std::wstring(); }
  3089. std::wstring ws;
  3090. ws.resize(wlen);
  3091. wlen = ::MultiByteToWideChar(
  3092. CP_UTF8, 0, s, len,
  3093. const_cast<LPWSTR>(reinterpret_cast<LPCWSTR>(ws.data())), wlen);
  3094. if (wlen != static_cast<int>(ws.size())) { ws.clear(); }
  3095. return ws;
  3096. }
  3097. #endif
  3098. struct FileStat {
  3099. FileStat(const std::string &path);
  3100. bool is_file() const;
  3101. bool is_dir() const;
  3102. time_t mtime() const;
  3103. size_t size() const;
  3104. private:
  3105. #if defined(_WIN32)
  3106. struct _stat st_;
  3107. #else
  3108. struct stat st_;
  3109. #endif
  3110. int ret_ = -1;
  3111. };
  3112. std::string make_host_and_port_string(const std::string &host, int port,
  3113. bool is_ssl);
  3114. template <typename T>
  3115. bool check_and_write_headers(Stream &strm, Headers &headers, T header_writer,
  3116. Error &error);
  3117. std::string trim_copy(const std::string &s);
  3118. void divide(
  3119. const char *data, std::size_t size, char d,
  3120. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3121. fn);
  3122. void divide(
  3123. const std::string &str, char d,
  3124. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3125. fn);
  3126. void split(const char *b, const char *e, char d,
  3127. std::function<void(const char *, const char *)> fn);
  3128. void split(const char *b, const char *e, char d, size_t m,
  3129. std::function<void(const char *, const char *)> fn);
  3130. bool split_find(const char *b, const char *e, char d,
  3131. std::function<bool(const char *, const char *)> fn);
  3132. bool has_header_token(const Headers &headers, const std::string &key,
  3133. const std::string &token);
  3134. std::string websocket_accept_key(const std::string &client_key);
  3135. bool is_websocket_upgrade(const Request &req);
  3136. bool process_client_socket(
  3137. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  3138. time_t write_timeout_sec, time_t write_timeout_usec,
  3139. time_t max_timeout_msec,
  3140. std::chrono::time_point<std::chrono::steady_clock> start_time,
  3141. std::function<bool(Stream &)> callback);
  3142. socket_t create_client_socket(const std::string &host, const std::string &ip,
  3143. int port, int address_family, bool tcp_nodelay,
  3144. bool ipv6_v6only, SocketOptions socket_options,
  3145. time_t connection_timeout_sec,
  3146. time_t connection_timeout_usec,
  3147. time_t read_timeout_sec, time_t read_timeout_usec,
  3148. time_t write_timeout_sec,
  3149. time_t write_timeout_usec,
  3150. const std::string &intf, Error &error);
  3151. const char *get_header_value(const Headers &headers, const std::string &key,
  3152. const char *def, size_t id);
  3153. std::string get_combined_header_value(const Headers &headers,
  3154. const std::string &key);
  3155. std::string params_to_query_str(const Params &params);
  3156. void parse_query_text(const char *data, std::size_t size, Params &params);
  3157. void parse_query_text(const std::string &s, Params &params);
  3158. bool parse_multipart_boundary(const std::string &content_type,
  3159. std::string &boundary);
  3160. bool parse_range_header(const std::string &s, Ranges &ranges);
  3161. bool parse_accept_header(const std::string &s,
  3162. std::vector<std::string> &content_types);
  3163. void parse_disposition_params(const std::string &s, Params &params);
  3164. ssize_t send_socket(socket_t sock, const void *ptr, size_t size, int flags);
  3165. ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags);
  3166. EncodingType encoding_type(const Request &req, const std::string &content_type);
  3167. EncodingType encoding_type(const Request &req, const Response &res,
  3168. const std::string &content_type);
  3169. EncodingType encoding_type(const Request &req, const Response &res);
  3170. class BufferStream final : public Stream {
  3171. public:
  3172. BufferStream() = default;
  3173. ~BufferStream() override = default;
  3174. bool is_readable() const override;
  3175. bool wait_readable() const override;
  3176. bool wait_writable() const override;
  3177. ssize_t read(char *ptr, size_t size) override;
  3178. ssize_t write(const char *ptr, size_t size) override;
  3179. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  3180. void get_local_ip_and_port(std::string &ip, int &port) const override;
  3181. socket_t socket() const override;
  3182. time_t duration() const override;
  3183. const std::string &get_buffer() const;
  3184. private:
  3185. std::string buffer;
  3186. size_t position = 0;
  3187. };
  3188. class compressor {
  3189. public:
  3190. virtual ~compressor() = default;
  3191. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3192. virtual bool compress(const char *data, size_t data_length, bool last,
  3193. Callback callback) = 0;
  3194. };
  3195. class decompressor {
  3196. public:
  3197. virtual ~decompressor() = default;
  3198. virtual bool is_valid() const = 0;
  3199. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3200. virtual bool decompress(const char *data, size_t data_length,
  3201. Callback callback) = 0;
  3202. };
  3203. class nocompressor final : public compressor {
  3204. public:
  3205. ~nocompressor() override = default;
  3206. bool compress(const char *data, size_t data_length, bool /*last*/,
  3207. Callback callback) override;
  3208. };
  3209. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  3210. class gzip_compressor final : public compressor {
  3211. public:
  3212. gzip_compressor();
  3213. ~gzip_compressor() override;
  3214. bool compress(const char *data, size_t data_length, bool last,
  3215. Callback callback) override;
  3216. private:
  3217. bool is_valid_ = false;
  3218. z_stream strm_;
  3219. };
  3220. class gzip_decompressor final : public decompressor {
  3221. public:
  3222. gzip_decompressor();
  3223. ~gzip_decompressor() override;
  3224. bool is_valid() const override;
  3225. bool decompress(const char *data, size_t data_length,
  3226. Callback callback) override;
  3227. private:
  3228. bool is_valid_ = false;
  3229. z_stream strm_;
  3230. };
  3231. #endif
  3232. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  3233. class brotli_compressor final : public compressor {
  3234. public:
  3235. brotli_compressor();
  3236. ~brotli_compressor();
  3237. bool compress(const char *data, size_t data_length, bool last,
  3238. Callback callback) override;
  3239. private:
  3240. BrotliEncoderState *state_ = nullptr;
  3241. };
  3242. class brotli_decompressor final : public decompressor {
  3243. public:
  3244. brotli_decompressor();
  3245. ~brotli_decompressor();
  3246. bool is_valid() const override;
  3247. bool decompress(const char *data, size_t data_length,
  3248. Callback callback) override;
  3249. private:
  3250. BrotliDecoderResult decoder_r;
  3251. BrotliDecoderState *decoder_s = nullptr;
  3252. };
  3253. #endif
  3254. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  3255. class zstd_compressor : public compressor {
  3256. public:
  3257. zstd_compressor();
  3258. ~zstd_compressor();
  3259. bool compress(const char *data, size_t data_length, bool last,
  3260. Callback callback) override;
  3261. private:
  3262. ZSTD_CCtx *ctx_ = nullptr;
  3263. };
  3264. class zstd_decompressor : public decompressor {
  3265. public:
  3266. zstd_decompressor();
  3267. ~zstd_decompressor();
  3268. bool is_valid() const override;
  3269. bool decompress(const char *data, size_t data_length,
  3270. Callback callback) override;
  3271. private:
  3272. ZSTD_DCtx *ctx_ = nullptr;
  3273. };
  3274. #endif
  3275. // NOTE: until the read size reaches `fixed_buffer_size`, use `fixed_buffer`
  3276. // to store data. The call can set memory on stack for performance.
  3277. class stream_line_reader {
  3278. public:
  3279. stream_line_reader(Stream &strm, char *fixed_buffer,
  3280. size_t fixed_buffer_size);
  3281. const char *ptr() const;
  3282. size_t size() const;
  3283. bool end_with_crlf() const;
  3284. bool getline();
  3285. private:
  3286. void append(char c);
  3287. void append(const char *data, size_t size);
  3288. Stream &strm_;
  3289. char *fixed_buffer_;
  3290. const size_t fixed_buffer_size_;
  3291. size_t fixed_buffer_used_size_ = 0;
  3292. std::string growable_buffer_;
  3293. };
  3294. bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  3295. const Headers &src_headers);
  3296. struct ChunkedDecoder {
  3297. Stream &strm;
  3298. size_t chunk_remaining = 0;
  3299. bool finished = false;
  3300. char line_buf[64];
  3301. size_t last_chunk_total = 0;
  3302. size_t last_chunk_offset = 0;
  3303. explicit ChunkedDecoder(Stream &s);
  3304. ssize_t read_payload(char *buf, size_t len, size_t &out_chunk_offset,
  3305. size_t &out_chunk_total);
  3306. bool parse_trailers_into(Headers &dest, const Headers &src_headers);
  3307. };
  3308. // A regular file opened to be served: mapped on Windows, read with pread()
  3309. // elsewhere.
  3310. class mmap {
  3311. public:
  3312. mmap(const char *path);
  3313. ~mmap();
  3314. bool open(const char *path);
  3315. void close();
  3316. bool is_open() const;
  3317. size_t size() const;
  3318. // Copies up to len bytes from offset into buf and returns how many: fewer,
  3319. // down to 0, if the file has shrunk since it was opened.
  3320. size_t read(size_t offset, char *buf, size_t len) const;
  3321. private:
  3322. #if defined(_WIN32)
  3323. HANDLE hFile_ = NULL;
  3324. HANDLE hMapping_ = NULL;
  3325. void *addr_ = nullptr;
  3326. bool is_open_empty_file = false;
  3327. #else
  3328. int fd_ = -1;
  3329. #endif
  3330. size_t size_ = 0;
  3331. };
  3332. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  3333. namespace fields {
  3334. bool is_token_char(char c);
  3335. bool is_token(const std::string &s);
  3336. bool is_field_name(const std::string &s);
  3337. bool is_vchar(char c);
  3338. bool is_obs_text(char c);
  3339. bool is_field_vchar(char c);
  3340. bool is_field_content(const std::string &s);
  3341. bool is_field_value(const std::string &s);
  3342. bool is_field_valid(const std::string &name, const std::string &value);
  3343. bool is_request_target(const std::string &s);
  3344. bool is_host(const std::string &s);
  3345. } // namespace fields
  3346. } // namespace detail
  3347. /*
  3348. * TLS Abstraction Layer Declarations
  3349. */
  3350. #ifdef CPPHTTPLIB_SSL_ENABLED
  3351. // TLS abstraction layer - backend-specific type declarations
  3352. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  3353. namespace tls {
  3354. namespace impl {
  3355. // Mbed TLS context wrapper (holds config, entropy, DRBG, CA chain, own
  3356. // cert/key). This struct is accessible via tls::impl for use in SSL context
  3357. // setup callbacks (cast ctx_t to tls::impl::MbedTlsContext*).
  3358. struct MbedTlsContext {
  3359. mbedtls_ssl_config conf;
  3360. #ifndef CPPHTTPLIB_MBEDTLS_V4
  3361. // Mbed TLS 4.x uses PSA Crypto's internal RNG; no explicit entropy/DRBG.
  3362. mbedtls_entropy_context entropy;
  3363. mbedtls_ctr_drbg_context ctr_drbg;
  3364. #endif
  3365. mbedtls_x509_crt ca_chain;
  3366. mbedtls_x509_crt own_cert;
  3367. mbedtls_pk_context own_key;
  3368. bool is_server = false;
  3369. // Peer certificate required (set_verify_client()); a client defaults to true
  3370. bool verify_client = false;
  3371. // Set by tls::set_verify_callback().
  3372. VerifyCallback verify_callback;
  3373. MbedTlsContext();
  3374. ~MbedTlsContext();
  3375. MbedTlsContext(const MbedTlsContext &) = delete;
  3376. MbedTlsContext &operator=(const MbedTlsContext &) = delete;
  3377. };
  3378. } // namespace impl
  3379. } // namespace tls
  3380. #endif
  3381. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  3382. namespace tls {
  3383. namespace impl {
  3384. // wolfSSL context wrapper (holds WOLFSSL_CTX and related state).
  3385. // This struct is accessible via tls::impl for use in SSL context
  3386. // setup callbacks (cast ctx_t to tls::impl::WolfSSLContext*).
  3387. struct WolfSSLContext {
  3388. WOLFSSL_CTX *ctx = nullptr;
  3389. bool is_server = false;
  3390. // Peer certificate required (set_verify_client()); a client defaults to true
  3391. bool verify_client = false;
  3392. // Replaced under verify_callback_mutex()
  3393. std::shared_ptr<VerifyCallback> verify_callback;
  3394. std::string ca_pem_data_; // accumulated PEM for get_ca_names/get_ca_certs
  3395. WolfSSLContext();
  3396. ~WolfSSLContext();
  3397. WolfSSLContext(const WolfSSLContext &) = delete;
  3398. WolfSSLContext &operator=(const WolfSSLContext &) = delete;
  3399. };
  3400. // CA store for wolfSSL: holds raw PEM bytes to allow reloading into any ctx
  3401. struct WolfSSLCAStore {
  3402. std::string pem_data;
  3403. };
  3404. } // namespace impl
  3405. } // namespace tls
  3406. #endif
  3407. #endif // CPPHTTPLIB_SSL_ENABLED
  3408. namespace stream {
  3409. class Result {
  3410. public:
  3411. Result();
  3412. explicit Result(ClientImpl::StreamHandle &&handle, size_t chunk_size = 8192);
  3413. Result(Result &&other) noexcept;
  3414. Result &operator=(Result &&other) noexcept;
  3415. Result(const Result &) = delete;
  3416. Result &operator=(const Result &) = delete;
  3417. // Response info
  3418. bool is_valid() const;
  3419. explicit operator bool() const;
  3420. int status() const;
  3421. const Headers &headers() const;
  3422. std::string get_header_value(const std::string &key,
  3423. const char *def = "") const;
  3424. bool has_header(const std::string &key) const;
  3425. Error error() const;
  3426. Error read_error() const;
  3427. bool has_read_error() const;
  3428. // Stream reading
  3429. bool next();
  3430. const char *data() const;
  3431. size_t size() const;
  3432. std::string read_all();
  3433. private:
  3434. ClientImpl::StreamHandle handle_;
  3435. std::string buffer_;
  3436. size_t current_size_ = 0;
  3437. size_t chunk_size_;
  3438. bool finished_ = false;
  3439. };
  3440. // GET
  3441. template <typename ClientType>
  3442. inline Result Get(ClientType &cli, const std::string &path,
  3443. size_t chunk_size = 8192) {
  3444. return Result{cli.open_stream("GET", path), chunk_size};
  3445. }
  3446. template <typename ClientType>
  3447. inline Result Get(ClientType &cli, const std::string &path,
  3448. const Headers &headers, size_t chunk_size = 8192) {
  3449. return Result{cli.open_stream("GET", path, {}, headers), chunk_size};
  3450. }
  3451. template <typename ClientType>
  3452. inline Result Get(ClientType &cli, const std::string &path,
  3453. const Params &params, size_t chunk_size = 8192) {
  3454. return Result{cli.open_stream("GET", path, params), chunk_size};
  3455. }
  3456. template <typename ClientType>
  3457. inline Result Get(ClientType &cli, const std::string &path,
  3458. const Params &params, const Headers &headers,
  3459. size_t chunk_size = 8192) {
  3460. return Result{cli.open_stream("GET", path, params, headers), chunk_size};
  3461. }
  3462. // POST
  3463. template <typename ClientType>
  3464. inline Result Post(ClientType &cli, const std::string &path,
  3465. const std::string &body, const std::string &content_type,
  3466. size_t chunk_size = 8192) {
  3467. return Result{cli.open_stream("POST", path, {}, {}, body, content_type),
  3468. chunk_size};
  3469. }
  3470. template <typename ClientType>
  3471. inline Result Post(ClientType &cli, const std::string &path,
  3472. const Headers &headers, const std::string &body,
  3473. const std::string &content_type, size_t chunk_size = 8192) {
  3474. return Result{cli.open_stream("POST", path, {}, headers, body, content_type),
  3475. chunk_size};
  3476. }
  3477. template <typename ClientType>
  3478. inline Result Post(ClientType &cli, const std::string &path,
  3479. const Params &params, const std::string &body,
  3480. const std::string &content_type, size_t chunk_size = 8192) {
  3481. return Result{cli.open_stream("POST", path, params, {}, body, content_type),
  3482. chunk_size};
  3483. }
  3484. template <typename ClientType>
  3485. inline Result Post(ClientType &cli, const std::string &path,
  3486. const Params &params, const Headers &headers,
  3487. const std::string &body, const std::string &content_type,
  3488. size_t chunk_size = 8192) {
  3489. return Result{
  3490. cli.open_stream("POST", path, params, headers, body, content_type),
  3491. chunk_size};
  3492. }
  3493. // PUT
  3494. template <typename ClientType>
  3495. inline Result Put(ClientType &cli, const std::string &path,
  3496. const std::string &body, const std::string &content_type,
  3497. size_t chunk_size = 8192) {
  3498. return Result{cli.open_stream("PUT", path, {}, {}, body, content_type),
  3499. chunk_size};
  3500. }
  3501. template <typename ClientType>
  3502. inline Result Put(ClientType &cli, const std::string &path,
  3503. const Headers &headers, const std::string &body,
  3504. const std::string &content_type, size_t chunk_size = 8192) {
  3505. return Result{cli.open_stream("PUT", path, {}, headers, body, content_type),
  3506. chunk_size};
  3507. }
  3508. template <typename ClientType>
  3509. inline Result Put(ClientType &cli, const std::string &path,
  3510. const Params &params, const std::string &body,
  3511. const std::string &content_type, size_t chunk_size = 8192) {
  3512. return Result{cli.open_stream("PUT", path, params, {}, body, content_type),
  3513. chunk_size};
  3514. }
  3515. template <typename ClientType>
  3516. inline Result Put(ClientType &cli, const std::string &path,
  3517. const Params &params, const Headers &headers,
  3518. const std::string &body, const std::string &content_type,
  3519. size_t chunk_size = 8192) {
  3520. return Result{
  3521. cli.open_stream("PUT", path, params, headers, body, content_type),
  3522. chunk_size};
  3523. }
  3524. // PATCH
  3525. template <typename ClientType>
  3526. inline Result Patch(ClientType &cli, const std::string &path,
  3527. const std::string &body, const std::string &content_type,
  3528. size_t chunk_size = 8192) {
  3529. return Result{cli.open_stream("PATCH", path, {}, {}, body, content_type),
  3530. chunk_size};
  3531. }
  3532. template <typename ClientType>
  3533. inline Result Patch(ClientType &cli, const std::string &path,
  3534. const Headers &headers, const std::string &body,
  3535. const std::string &content_type, size_t chunk_size = 8192) {
  3536. return Result{cli.open_stream("PATCH", path, {}, headers, body, content_type),
  3537. chunk_size};
  3538. }
  3539. template <typename ClientType>
  3540. inline Result Patch(ClientType &cli, const std::string &path,
  3541. const Params &params, const std::string &body,
  3542. const std::string &content_type, size_t chunk_size = 8192) {
  3543. return Result{cli.open_stream("PATCH", path, params, {}, body, content_type),
  3544. chunk_size};
  3545. }
  3546. template <typename ClientType>
  3547. inline Result Patch(ClientType &cli, const std::string &path,
  3548. const Params &params, const Headers &headers,
  3549. const std::string &body, const std::string &content_type,
  3550. size_t chunk_size = 8192) {
  3551. return Result{
  3552. cli.open_stream("PATCH", path, params, headers, body, content_type),
  3553. chunk_size};
  3554. }
  3555. // DELETE
  3556. template <typename ClientType>
  3557. inline Result Delete(ClientType &cli, const std::string &path,
  3558. size_t chunk_size = 8192) {
  3559. return Result{cli.open_stream("DELETE", path), chunk_size};
  3560. }
  3561. template <typename ClientType>
  3562. inline Result Delete(ClientType &cli, const std::string &path,
  3563. const Headers &headers, size_t chunk_size = 8192) {
  3564. return Result{cli.open_stream("DELETE", path, {}, headers), chunk_size};
  3565. }
  3566. template <typename ClientType>
  3567. inline Result Delete(ClientType &cli, const std::string &path,
  3568. const std::string &body, const std::string &content_type,
  3569. size_t chunk_size = 8192) {
  3570. return Result{cli.open_stream("DELETE", path, {}, {}, body, content_type),
  3571. chunk_size};
  3572. }
  3573. template <typename ClientType>
  3574. inline Result Delete(ClientType &cli, const std::string &path,
  3575. const Headers &headers, const std::string &body,
  3576. const std::string &content_type,
  3577. size_t chunk_size = 8192) {
  3578. return Result{
  3579. cli.open_stream("DELETE", path, {}, headers, body, content_type),
  3580. chunk_size};
  3581. }
  3582. template <typename ClientType>
  3583. inline Result Delete(ClientType &cli, const std::string &path,
  3584. const Params &params, size_t chunk_size = 8192) {
  3585. return Result{cli.open_stream("DELETE", path, params), chunk_size};
  3586. }
  3587. template <typename ClientType>
  3588. inline Result Delete(ClientType &cli, const std::string &path,
  3589. const Params &params, const Headers &headers,
  3590. size_t chunk_size = 8192) {
  3591. return Result{cli.open_stream("DELETE", path, params, headers), chunk_size};
  3592. }
  3593. template <typename ClientType>
  3594. inline Result Delete(ClientType &cli, const std::string &path,
  3595. const Params &params, const std::string &body,
  3596. const std::string &content_type,
  3597. size_t chunk_size = 8192) {
  3598. return Result{cli.open_stream("DELETE", path, params, {}, body, content_type),
  3599. chunk_size};
  3600. }
  3601. template <typename ClientType>
  3602. inline Result Delete(ClientType &cli, const std::string &path,
  3603. const Params &params, const Headers &headers,
  3604. const std::string &body, const std::string &content_type,
  3605. size_t chunk_size = 8192) {
  3606. return Result{
  3607. cli.open_stream("DELETE", path, params, headers, body, content_type),
  3608. chunk_size};
  3609. }
  3610. // HEAD
  3611. template <typename ClientType>
  3612. inline Result Head(ClientType &cli, const std::string &path,
  3613. size_t chunk_size = 8192) {
  3614. return Result{cli.open_stream("HEAD", path), chunk_size};
  3615. }
  3616. template <typename ClientType>
  3617. inline Result Head(ClientType &cli, const std::string &path,
  3618. const Headers &headers, size_t chunk_size = 8192) {
  3619. return Result{cli.open_stream("HEAD", path, {}, headers), chunk_size};
  3620. }
  3621. template <typename ClientType>
  3622. inline Result Head(ClientType &cli, const std::string &path,
  3623. const Params &params, size_t chunk_size = 8192) {
  3624. return Result{cli.open_stream("HEAD", path, params), chunk_size};
  3625. }
  3626. template <typename ClientType>
  3627. inline Result Head(ClientType &cli, const std::string &path,
  3628. const Params &params, const Headers &headers,
  3629. size_t chunk_size = 8192) {
  3630. return Result{cli.open_stream("HEAD", path, params, headers), chunk_size};
  3631. }
  3632. // OPTIONS
  3633. template <typename ClientType>
  3634. inline Result Options(ClientType &cli, const std::string &path,
  3635. size_t chunk_size = 8192) {
  3636. return Result{cli.open_stream("OPTIONS", path), chunk_size};
  3637. }
  3638. template <typename ClientType>
  3639. inline Result Options(ClientType &cli, const std::string &path,
  3640. const Headers &headers, size_t chunk_size = 8192) {
  3641. return Result{cli.open_stream("OPTIONS", path, {}, headers), chunk_size};
  3642. }
  3643. template <typename ClientType>
  3644. inline Result Options(ClientType &cli, const std::string &path,
  3645. const Params &params, size_t chunk_size = 8192) {
  3646. return Result{cli.open_stream("OPTIONS", path, params), chunk_size};
  3647. }
  3648. template <typename ClientType>
  3649. inline Result Options(ClientType &cli, const std::string &path,
  3650. const Params &params, const Headers &headers,
  3651. size_t chunk_size = 8192) {
  3652. return Result{cli.open_stream("OPTIONS", path, params, headers), chunk_size};
  3653. }
  3654. } // namespace stream
  3655. namespace sse {
  3656. struct SSEMessage {
  3657. std::string event; // Event type (default: "message")
  3658. std::string data; // Event payload
  3659. std::string id; // Event ID for Last-Event-ID header
  3660. SSEMessage();
  3661. void clear();
  3662. };
  3663. class SSEClient {
  3664. public:
  3665. using MessageHandler = std::function<void(const SSEMessage &)>;
  3666. using ErrorHandler = std::function<void(Error)>;
  3667. using OpenHandler = std::function<void()>;
  3668. SSEClient(Client &client, const std::string &path);
  3669. SSEClient(Client &client, const std::string &path, const Headers &headers);
  3670. ~SSEClient();
  3671. SSEClient(const SSEClient &) = delete;
  3672. SSEClient &operator=(const SSEClient &) = delete;
  3673. // Event handlers
  3674. SSEClient &on_message(MessageHandler handler);
  3675. SSEClient &on_event(const std::string &type, MessageHandler handler);
  3676. SSEClient &on_open(OpenHandler handler);
  3677. SSEClient &on_error(ErrorHandler handler);
  3678. SSEClient &set_reconnect_interval(int ms);
  3679. SSEClient &set_max_reconnect_attempts(int n);
  3680. // Update headers (thread-safe)
  3681. SSEClient &set_headers(const Headers &headers);
  3682. // State accessors
  3683. bool is_connected() const;
  3684. const std::string &last_event_id() const;
  3685. // Blocking start - runs event loop with auto-reconnect
  3686. void start();
  3687. // Non-blocking start - runs in background thread
  3688. void start_async();
  3689. // Stop the client (thread-safe)
  3690. void stop();
  3691. private:
  3692. bool parse_sse_line(const std::string &line, SSEMessage &msg, int &retry_ms,
  3693. bool &has_data, bool &has_id);
  3694. void run_event_loop();
  3695. void dispatch_event(const SSEMessage &msg);
  3696. bool should_reconnect(int count) const;
  3697. void wait_for_reconnect();
  3698. // Client and path
  3699. Client &client_;
  3700. std::string path_;
  3701. Headers headers_;
  3702. mutable std::mutex headers_mutex_;
  3703. // Callbacks
  3704. MessageHandler on_message_;
  3705. std::map<std::string, MessageHandler> event_handlers_;
  3706. OpenHandler on_open_;
  3707. ErrorHandler on_error_;
  3708. // Configuration
  3709. int reconnect_interval_ms_ = 3000;
  3710. int max_reconnect_attempts_ = 0; // 0 = unlimited
  3711. // State
  3712. std::atomic<bool> running_{false};
  3713. std::atomic<bool> connected_{false};
  3714. std::string last_event_id_;
  3715. // Async support
  3716. std::thread async_thread_;
  3717. };
  3718. } // namespace sse
  3719. namespace ws {
  3720. class WebSocketClient;
  3721. enum class Opcode : uint8_t {
  3722. Continuation = 0x0,
  3723. Text = 0x1,
  3724. Binary = 0x2,
  3725. Close = 0x8,
  3726. Ping = 0x9,
  3727. Pong = 0xA,
  3728. };
  3729. enum class CloseStatus : uint16_t {
  3730. Normal = 1000,
  3731. GoingAway = 1001,
  3732. ProtocolError = 1002,
  3733. UnsupportedData = 1003,
  3734. NoStatus = 1005,
  3735. Abnormal = 1006,
  3736. InvalidPayload = 1007,
  3737. PolicyViolation = 1008,
  3738. MessageTooBig = 1009,
  3739. MandatoryExtension = 1010,
  3740. InternalError = 1011,
  3741. };
  3742. // Timeout is returned only when a read timeout was set and it elapsed before
  3743. // any byte of a frame arrived: nothing was consumed and the connection is
  3744. // still open, so the caller can send on it and read again. `msg` is left
  3745. // untouched, so a `while (ws.read(msg))` loop must not treat it as a message.
  3746. enum ReadResult : int { Fail = 0, Text = 1, Binary = 2, Timeout = 3 };
  3747. // Result of WebSocketClient::connect(). Truthy only when the WebSocket
  3748. // upgrade handshake fully succeeded. On failure error() identifies the
  3749. // failing layer; status()/headers() expose the server's upgrade response
  3750. // when one was received (status() is -1 otherwise), or the proxy's reply to
  3751. // CONNECT when error() is ProxyConnection.
  3752. class Result {
  3753. public:
  3754. Result() = default;
  3755. Result(Error err, int status, Headers &&headers)
  3756. : err_(err), status_(status), headers_(std::move(headers)) {}
  3757. explicit operator bool() const { return err_ == Error::Success; }
  3758. Error error() const { return err_; }
  3759. // Upgrade response info
  3760. int status() const { return status_; }
  3761. const Headers &headers() const { return headers_; }
  3762. std::string get_header_value(const std::string &key,
  3763. const char *def = "") const {
  3764. return detail::get_header_value(headers_, key, def, 0);
  3765. }
  3766. bool has_header(const std::string &key) const {
  3767. return headers_.find(key) != headers_.end();
  3768. }
  3769. #ifdef CPPHTTPLIB_SSL_ENABLED
  3770. Result(Error err, int status, Headers &&headers, int ssl_error,
  3771. uint64_t ssl_backend_error)
  3772. : err_(err), status_(status), headers_(std::move(headers)),
  3773. ssl_error_(ssl_error), ssl_backend_error_(ssl_backend_error) {}
  3774. int ssl_error() const { return ssl_error_; }
  3775. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  3776. #endif
  3777. private:
  3778. Error err_ = Error::Unknown; // a default-constructed Result is falsy
  3779. int status_ = -1;
  3780. Headers headers_;
  3781. #ifdef CPPHTTPLIB_SSL_ENABLED
  3782. int ssl_error_ = 0;
  3783. uint64_t ssl_backend_error_ = 0;
  3784. #endif
  3785. };
  3786. class WebSocket {
  3787. public:
  3788. WebSocket(const WebSocket &) = delete;
  3789. WebSocket &operator=(const WebSocket &) = delete;
  3790. ~WebSocket();
  3791. ReadResult read(std::string &msg);
  3792. bool send(const std::string &data);
  3793. bool send(const char *data, size_t len);
  3794. void close(CloseStatus status = CloseStatus::Normal,
  3795. const std::string &reason = "");
  3796. const Request &request() const;
  3797. bool is_open() const;
  3798. // Bound how long read() waits before returning Timeout. 0 waits forever.
  3799. // A server handler owns its connection's timeout this way; a client sets it
  3800. // through WebSocketClient. Safe to call while another thread is in read().
  3801. //
  3802. // Only a timeout set here is reported as Timeout. The compile-time default
  3803. // (CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND) is a backstop rather
  3804. // than a request for control, so when it elapses read() returns Fail and
  3805. // closes the connection, and `while (ws.read(msg))` ends as it always has.
  3806. void set_read_timeout(time_t sec, time_t usec = 0);
  3807. template <class Rep, class Period>
  3808. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3809. private:
  3810. friend class httplib::Server;
  3811. friend class httplib::ws::WebSocketClient;
  3812. WebSocket(
  3813. Stream &strm, const Request &req, bool is_server,
  3814. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3815. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3816. : strm_(strm), req_(req), is_server_(is_server),
  3817. ping_interval_sec_(ping_interval_sec),
  3818. max_missed_pongs_(max_missed_pongs) {
  3819. start_heartbeat();
  3820. }
  3821. WebSocket(
  3822. std::unique_ptr<Stream> &&owned_strm, const Request &req, bool is_server,
  3823. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3824. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3825. : strm_(*owned_strm), owned_strm_(std::move(owned_strm)), req_(req),
  3826. is_server_(is_server), ping_interval_sec_(ping_interval_sec),
  3827. max_missed_pongs_(max_missed_pongs) {
  3828. start_heartbeat();
  3829. }
  3830. void start_heartbeat();
  3831. bool send_frame(Opcode op, const char *data, size_t len, bool fin = true);
  3832. Stream &strm_;
  3833. std::unique_ptr<Stream> owned_strm_;
  3834. Request req_;
  3835. bool is_server_;
  3836. time_t ping_interval_sec_;
  3837. int max_missed_pongs_;
  3838. int unacked_pings_ = 0;
  3839. std::atomic<bool> closed_{false};
  3840. // Set when the peer stopped answering pings, to end a read() waiting on it
  3841. std::atomic<bool> pong_timed_out_{false};
  3842. // Set once the caller has bounded read() through set_read_timeout(). Until
  3843. // then the timeout in effect is the compile-time default, and elapsing it
  3844. // is a failure that closes the connection, not a Timeout.
  3845. std::atomic<bool> read_timeout_set_{false};
  3846. std::mutex write_mutex_;
  3847. // Owned by whichever thread is parsing frames off strm_. Only one thread
  3848. // may do so: read_websocket_frame() reads a payload until it has the whole
  3849. // declared length, so a second parser stealing bytes silently corrupts the
  3850. // message the first one is assembling.
  3851. std::mutex read_mutex_;
  3852. std::thread ping_thread_;
  3853. std::mutex ping_mutex_;
  3854. std::condition_variable ping_cv_;
  3855. };
  3856. class WebSocketClient {
  3857. public:
  3858. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3859. const Headers &headers = {});
  3860. ~WebSocketClient();
  3861. WebSocketClient(const WebSocketClient &) = delete;
  3862. WebSocketClient &operator=(const WebSocketClient &) = delete;
  3863. bool is_valid() const;
  3864. Result connect();
  3865. ReadResult read(std::string &msg);
  3866. bool send(const std::string &data);
  3867. bool send(const char *data, size_t len);
  3868. void close(CloseStatus status = CloseStatus::Normal,
  3869. const std::string &reason = "");
  3870. bool is_open() const;
  3871. const std::string &subprotocol() const;
  3872. void set_read_timeout(time_t sec, time_t usec = 0);
  3873. template <class Rep, class Period>
  3874. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3875. void set_write_timeout(time_t sec, time_t usec = 0);
  3876. template <class Rep, class Period>
  3877. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  3878. void set_websocket_ping_interval(time_t sec);
  3879. void set_websocket_max_missed_pongs(int count);
  3880. void set_tcp_nodelay(bool on);
  3881. void set_address_family(int family);
  3882. void set_ipv6_v6only(bool on);
  3883. void set_socket_options(SocketOptions socket_options);
  3884. void set_connection_timeout(time_t sec, time_t usec = 0);
  3885. template <class Rep, class Period>
  3886. void
  3887. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  3888. void set_interface(const std::string &intf);
  3889. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  3890. void set_proxy(const std::string &host, int port);
  3891. void set_proxy_basic_auth(const std::string &username,
  3892. const std::string &password);
  3893. void set_proxy_bearer_token_auth(const std::string &token);
  3894. void set_no_proxy(const std::vector<std::string> &patterns);
  3895. #ifdef CPPHTTPLIB_SSL_ENABLED
  3896. struct PemMemory {
  3897. const char *cert_pem;
  3898. size_t cert_pem_len;
  3899. const char *key_pem;
  3900. size_t key_pem_len;
  3901. const char *private_key_password;
  3902. };
  3903. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3904. const PemMemory &pem, const Headers &headers = {});
  3905. void set_ca_cert_path(const std::string &ca_cert_file_path,
  3906. const std::string &ca_cert_dir_path = std::string());
  3907. void set_ca_cert_store(tls::ca_store_t store);
  3908. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  3909. void enable_server_certificate_verification(bool enabled);
  3910. void enable_server_hostname_verification(bool enabled);
  3911. void enable_system_ca(bool enabled);
  3912. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  3913. void set_session_verifier(
  3914. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  3915. void set_proxy_digest_auth(const std::string &username,
  3916. const std::string &password);
  3917. #endif
  3918. private:
  3919. void shutdown_and_close();
  3920. std::pair<time_t, time_t> handshake_timeout() const;
  3921. bool create_stream(std::unique_ptr<Stream> &strm, Error &error,
  3922. int &ssl_error, uint64_t &ssl_backend_error);
  3923. void prepare_default_headers(Request &req);
  3924. bool is_proxy_enabled() const;
  3925. bool create_and_connect_socket(Error &error);
  3926. bool send_proxy_connect(Request &req, Response &proxy_res, Error &error);
  3927. bool connect_with_proxy(Response &proxy_res, Error &error);
  3928. std::string host_;
  3929. int port_;
  3930. std::string path_;
  3931. Headers headers_;
  3932. std::string subprotocol_;
  3933. bool is_valid_ = false;
  3934. socket_t sock_ = INVALID_SOCKET;
  3935. std::unique_ptr<WebSocket> ws_;
  3936. time_t read_timeout_sec_ = CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND;
  3937. time_t read_timeout_usec_ = 0;
  3938. bool read_timeout_set_ = false; // see WebSocket::read_timeout_set_
  3939. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  3940. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  3941. time_t websocket_ping_interval_sec_ =
  3942. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  3943. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  3944. int address_family_ = AF_UNSPEC;
  3945. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  3946. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  3947. SocketOptions socket_options_ = nullptr;
  3948. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  3949. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  3950. std::string interface_;
  3951. // Hostname to connection target map. The value is an IP literal or another
  3952. // hostname; only the connection target changes, never the identity.
  3953. std::map<std::string, std::string> addr_map_;
  3954. std::string proxy_host_;
  3955. int proxy_port_ = -1;
  3956. std::string proxy_basic_auth_username_;
  3957. std::string proxy_basic_auth_password_;
  3958. std::string proxy_bearer_token_auth_token_;
  3959. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  3960. #ifdef CPPHTTPLIB_SSL_ENABLED
  3961. bool is_ssl_ = false;
  3962. tls::ctx_t tls_ctx_ = nullptr;
  3963. tls::session_t tls_session_ = nullptr;
  3964. std::string ca_cert_file_path_;
  3965. std::string ca_cert_dir_path_;
  3966. // Set by set_ca_cert_store() and load_ca_cert_store() even when they bring
  3967. // no certificate, so that a CA that failed to come through fails
  3968. // verification instead of letting the system CAs in.
  3969. bool custom_ca_loaded_ = false;
  3970. bool certs_loaded_ = false;
  3971. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  3972. bool server_certificate_verification_ = true;
  3973. bool server_hostname_verification_ = true;
  3974. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  3975. std::string proxy_digest_auth_username_;
  3976. std::string proxy_digest_auth_password_;
  3977. #endif
  3978. };
  3979. template <class Rep, class Period>
  3980. inline void WebSocket::set_read_timeout(
  3981. const std::chrono::duration<Rep, Period> &duration) {
  3982. detail::duration_to_sec_and_usec(
  3983. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3984. }
  3985. template <class Rep, class Period>
  3986. inline void WebSocketClient::set_read_timeout(
  3987. const std::chrono::duration<Rep, Period> &duration) {
  3988. detail::duration_to_sec_and_usec(
  3989. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3990. }
  3991. template <class Rep, class Period>
  3992. inline void WebSocketClient::set_write_timeout(
  3993. const std::chrono::duration<Rep, Period> &duration) {
  3994. detail::duration_to_sec_and_usec(
  3995. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3996. }
  3997. template <class Rep, class Period>
  3998. inline void WebSocketClient::set_connection_timeout(
  3999. const std::chrono::duration<Rep, Period> &duration) {
  4000. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  4001. set_connection_timeout(sec, usec);
  4002. });
  4003. }
  4004. namespace impl {
  4005. bool is_valid_utf8(const std::string &s);
  4006. // Three states, because a failure that consumed bytes and one that consumed
  4007. // none are not the same thing: the first has left the stream in the middle of
  4008. // a frame and the connection cannot be reused, the second can just be retried.
  4009. enum class FrameRead { Ok, Fail, Timeout };
  4010. FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  4011. std::string &payload, bool &fin,
  4012. bool expect_masked, size_t max_len);
  4013. } // namespace impl
  4014. } // namespace ws
  4015. // ----------------------------------------------------------------------------
  4016. /*
  4017. * Implementation that will be part of the .cc file if split into .h + .cc.
  4018. */
  4019. namespace stream {
  4020. // stream::Result implementations
  4021. inline Result::Result() : chunk_size_(8192) {}
  4022. inline Result::Result(ClientImpl::StreamHandle &&handle, size_t chunk_size)
  4023. : handle_(std::move(handle)), chunk_size_(chunk_size) {}
  4024. inline Result::Result(Result &&other) noexcept
  4025. : handle_(std::move(other.handle_)), buffer_(std::move(other.buffer_)),
  4026. current_size_(other.current_size_), chunk_size_(other.chunk_size_),
  4027. finished_(other.finished_) {
  4028. other.current_size_ = 0;
  4029. other.finished_ = true;
  4030. }
  4031. inline Result &Result::operator=(Result &&other) noexcept {
  4032. if (this != &other) {
  4033. handle_ = std::move(other.handle_);
  4034. buffer_ = std::move(other.buffer_);
  4035. current_size_ = other.current_size_;
  4036. chunk_size_ = other.chunk_size_;
  4037. finished_ = other.finished_;
  4038. other.current_size_ = 0;
  4039. other.finished_ = true;
  4040. }
  4041. return *this;
  4042. }
  4043. inline bool Result::is_valid() const { return handle_.is_valid(); }
  4044. inline Result::operator bool() const { return is_valid(); }
  4045. inline int Result::status() const {
  4046. return handle_.response ? handle_.response->status : -1;
  4047. }
  4048. inline const Headers &Result::headers() const {
  4049. static const Headers empty_headers;
  4050. return handle_.response ? handle_.response->headers : empty_headers;
  4051. }
  4052. inline std::string Result::get_header_value(const std::string &key,
  4053. const char *def) const {
  4054. return handle_.response ? handle_.response->get_header_value(key, def) : def;
  4055. }
  4056. inline bool Result::has_header(const std::string &key) const {
  4057. return handle_.response ? handle_.response->has_header(key) : false;
  4058. }
  4059. inline Error Result::error() const { return handle_.error; }
  4060. inline Error Result::read_error() const { return handle_.get_read_error(); }
  4061. inline bool Result::has_read_error() const { return handle_.has_read_error(); }
  4062. inline bool Result::next() {
  4063. if (!handle_.is_valid() || finished_) { return false; }
  4064. if (buffer_.size() < chunk_size_) { buffer_.resize(chunk_size_); }
  4065. ssize_t n = handle_.read(&buffer_[0], chunk_size_);
  4066. if (n > 0) {
  4067. current_size_ = static_cast<size_t>(n);
  4068. return true;
  4069. }
  4070. current_size_ = 0;
  4071. finished_ = true;
  4072. return false;
  4073. }
  4074. inline const char *Result::data() const { return buffer_.data(); }
  4075. inline size_t Result::size() const { return current_size_; }
  4076. inline std::string Result::read_all() {
  4077. std::string result;
  4078. while (next()) {
  4079. result.append(data(), size());
  4080. }
  4081. return result;
  4082. }
  4083. } // namespace stream
  4084. namespace sse {
  4085. // SSEMessage implementations
  4086. inline SSEMessage::SSEMessage() : event("message") {}
  4087. inline void SSEMessage::clear() {
  4088. event = "message";
  4089. data.clear();
  4090. id.clear();
  4091. }
  4092. // SSEClient implementations
  4093. inline SSEClient::SSEClient(Client &client, const std::string &path)
  4094. : client_(client), path_(path) {}
  4095. inline SSEClient::SSEClient(Client &client, const std::string &path,
  4096. const Headers &headers)
  4097. : client_(client), path_(path), headers_(headers) {}
  4098. inline SSEClient::~SSEClient() { stop(); }
  4099. inline SSEClient &SSEClient::on_message(MessageHandler handler) {
  4100. on_message_ = std::move(handler);
  4101. return *this;
  4102. }
  4103. inline SSEClient &SSEClient::on_event(const std::string &type,
  4104. MessageHandler handler) {
  4105. event_handlers_[type] = std::move(handler);
  4106. return *this;
  4107. }
  4108. inline SSEClient &SSEClient::on_open(OpenHandler handler) {
  4109. on_open_ = std::move(handler);
  4110. return *this;
  4111. }
  4112. inline SSEClient &SSEClient::on_error(ErrorHandler handler) {
  4113. on_error_ = std::move(handler);
  4114. return *this;
  4115. }
  4116. inline SSEClient &SSEClient::set_reconnect_interval(int ms) {
  4117. reconnect_interval_ms_ = ms;
  4118. return *this;
  4119. }
  4120. inline SSEClient &SSEClient::set_max_reconnect_attempts(int n) {
  4121. max_reconnect_attempts_ = n;
  4122. return *this;
  4123. }
  4124. inline SSEClient &SSEClient::set_headers(const Headers &headers) {
  4125. std::lock_guard<std::mutex> lock(headers_mutex_);
  4126. headers_ = headers;
  4127. return *this;
  4128. }
  4129. inline bool SSEClient::is_connected() const { return connected_.load(); }
  4130. inline const std::string &SSEClient::last_event_id() const {
  4131. return last_event_id_;
  4132. }
  4133. inline void SSEClient::start() {
  4134. running_.store(true);
  4135. run_event_loop();
  4136. }
  4137. inline void SSEClient::start_async() {
  4138. running_.store(true);
  4139. async_thread_ = std::thread([this]() { run_event_loop(); });
  4140. }
  4141. inline void SSEClient::stop() {
  4142. running_.store(false);
  4143. client_.stop(); // Cancel any pending operations
  4144. if (async_thread_.joinable()) { async_thread_.join(); }
  4145. }
  4146. inline bool SSEClient::parse_sse_line(const std::string &line, SSEMessage &msg,
  4147. int &retry_ms, bool &has_data,
  4148. bool &has_id) {
  4149. // Blank line signals end of event
  4150. if (line.empty()) { return true; }
  4151. // Lines starting with ':' are comments (ignored)
  4152. if (line[0] == ':') { return false; }
  4153. // Find the colon separator
  4154. auto colon_pos = line.find(':');
  4155. auto field = line.substr(0, colon_pos);
  4156. std::string value;
  4157. // Value starts after colon, skip optional single space
  4158. if (colon_pos != std::string::npos && colon_pos + 1 < line.size()) {
  4159. auto value_start = colon_pos + 1;
  4160. if (line[value_start] == ' ') { value_start++; }
  4161. value = line.substr(value_start);
  4162. }
  4163. // Handle known fields
  4164. if (field == "event") {
  4165. // An empty event type is dispatched as "message" per the SSE spec
  4166. msg.event = value.empty() ? std::string("message") : std::move(value);
  4167. } else if (field == "data") {
  4168. // Multiple data lines are concatenated with newlines
  4169. if (has_data) { msg.data += "\n"; }
  4170. msg.data += value;
  4171. has_data = true;
  4172. } else if (field == "id") {
  4173. // An id that cannot be sent back as Last-Event-ID is ignored. Empty id is
  4174. // valid (clears the last event ID)
  4175. if (detail::fields::is_field_value(value)) {
  4176. msg.id = value;
  4177. has_id = true;
  4178. }
  4179. } else if (field == "retry") {
  4180. // Parse retry interval in milliseconds
  4181. // Per the SSE spec, a value that is not all ASCII digits is ignored.
  4182. if (detail::is_numeric(value)) {
  4183. int v = 0;
  4184. auto res =
  4185. detail::from_chars(value.data(), value.data() + value.size(), v);
  4186. if (res.ec == std::errc{}) { retry_ms = v; }
  4187. }
  4188. }
  4189. // Unknown fields are ignored per SSE spec
  4190. return false;
  4191. }
  4192. inline void SSEClient::run_event_loop() {
  4193. auto reconnect_count = 0;
  4194. while (running_.load()) {
  4195. // Build headers, including Last-Event-ID if we have one
  4196. Headers request_headers;
  4197. {
  4198. std::lock_guard<std::mutex> lock(headers_mutex_);
  4199. request_headers = headers_;
  4200. }
  4201. if (!last_event_id_.empty()) {
  4202. request_headers.emplace("Last-Event-ID", last_event_id_);
  4203. }
  4204. // Open streaming connection. An event stream has no end, so each event is
  4205. // bounded instead of the whole body.
  4206. auto handle = client_.open_stream("GET", path_, {}, request_headers);
  4207. handle.body_reader_.payload_max_length = 0;
  4208. // stop() ends a read that is waiting for the next event
  4209. if (handle.stream_) {
  4210. handle.stream_->set_read_interrupt([this] { return !running_.load(); });
  4211. }
  4212. stream::Result result{std::move(handle)};
  4213. // Connection error handling
  4214. if (!result) {
  4215. connected_.store(false);
  4216. if (on_error_) { on_error_(result.error()); }
  4217. if (!should_reconnect(reconnect_count)) { break; }
  4218. wait_for_reconnect();
  4219. reconnect_count++;
  4220. continue;
  4221. }
  4222. if (result.status() != StatusCode::OK_200) {
  4223. connected_.store(false);
  4224. if (on_error_) { on_error_(Error::Connection); }
  4225. // For certain errors, don't reconnect.
  4226. // Note: 401 is intentionally absent so that handlers can refresh
  4227. // credentials via set_headers() and let the client reconnect.
  4228. if (result.status() == StatusCode::NoContent_204 ||
  4229. result.status() == StatusCode::NotFound_404 ||
  4230. result.status() == StatusCode::Forbidden_403) {
  4231. break;
  4232. }
  4233. if (!should_reconnect(reconnect_count)) { break; }
  4234. wait_for_reconnect();
  4235. reconnect_count++;
  4236. continue;
  4237. }
  4238. // Connection successful
  4239. connected_.store(true);
  4240. reconnect_count = 0;
  4241. if (on_open_) { on_open_(); }
  4242. // Event receiving loop
  4243. std::string buffer;
  4244. SSEMessage current_msg;
  4245. auto has_data = false;
  4246. auto has_id = false;
  4247. auto first_line = true;
  4248. auto after_cr = false;
  4249. auto event_too_long = false;
  4250. while (running_.load() && result.next()) {
  4251. // What is left in the buffer has no line ending
  4252. auto search_pos = buffer.size();
  4253. buffer.append(result.data(), result.size());
  4254. // Process complete lines in the buffer. A line ends with \r\n, \n or \r
  4255. // per the SSE spec
  4256. size_t line_start = 0;
  4257. size_t eol_pos;
  4258. while ((eol_pos = buffer.find_first_of("\r\n", search_pos)) !=
  4259. std::string::npos) {
  4260. auto line = buffer.substr(line_start, eol_pos - line_start);
  4261. line_start = eol_pos + 1;
  4262. search_pos = line_start;
  4263. // The \n of a \r\n may arrive in a later chunk than its \r
  4264. auto is_lf_of_crlf =
  4265. after_cr && line.empty() && buffer[eol_pos] == '\n';
  4266. after_cr = buffer[eol_pos] == '\r';
  4267. if (is_lf_of_crlf) { continue; }
  4268. // A UTF-8 BOM at the start of the stream is ignored per the SSE spec
  4269. if (first_line) {
  4270. first_line = false;
  4271. if (line.compare(0, 3, "\xEF\xBB\xBF") == 0) { line.erase(0, 3); }
  4272. }
  4273. // Parse the line and check if event is complete
  4274. auto event_complete = parse_sse_line(
  4275. line, current_msg, reconnect_interval_ms_, has_data, has_id);
  4276. if (event_complete) {
  4277. // Update last_event_id for reconnection, even for an event that
  4278. // has no data. An empty id clears it.
  4279. if (has_id) { last_event_id_ = current_msg.id; }
  4280. // An event without a data field is not dispatched
  4281. if (has_data) { dispatch_event(current_msg); }
  4282. // Reset the message for the next event either way
  4283. current_msg.clear();
  4284. has_data = false;
  4285. has_id = false;
  4286. }
  4287. }
  4288. // Keep unprocessed data in buffer
  4289. buffer.erase(0, line_start);
  4290. // Neither an event nor a line still waiting for its end may grow
  4291. // without bound. 0 means no limit.
  4292. if (CPPHTTPLIB_SSE_MAX_EVENT_LENGTH > 0 &&
  4293. buffer.size() + current_msg.data.size() >
  4294. CPPHTTPLIB_SSE_MAX_EVENT_LENGTH) {
  4295. if (on_error_) { on_error_(Error::ExceedMaxPayloadSize); }
  4296. event_too_long = true;
  4297. break;
  4298. }
  4299. }
  4300. // Connection ended
  4301. connected_.store(false);
  4302. // Reconnecting would only get the same event again
  4303. if (!running_.load() || event_too_long) { break; }
  4304. // Check for read errors
  4305. if (result.has_read_error()) {
  4306. if (on_error_) { on_error_(result.read_error()); }
  4307. }
  4308. if (!should_reconnect(reconnect_count)) { break; }
  4309. wait_for_reconnect();
  4310. reconnect_count++;
  4311. }
  4312. connected_.store(false);
  4313. }
  4314. inline void SSEClient::dispatch_event(const SSEMessage &msg) {
  4315. // Check for specific event type handler first
  4316. auto it = event_handlers_.find(msg.event);
  4317. if (it != event_handlers_.end()) {
  4318. it->second(msg);
  4319. return;
  4320. }
  4321. // Fall back to generic message handler
  4322. if (on_message_) { on_message_(msg); }
  4323. }
  4324. inline bool SSEClient::should_reconnect(int count) const {
  4325. if (!running_.load()) { return false; }
  4326. if (max_reconnect_attempts_ == 0) { return true; } // unlimited
  4327. return count < max_reconnect_attempts_;
  4328. }
  4329. inline void SSEClient::wait_for_reconnect() {
  4330. // Use small increments to check running_ flag frequently.
  4331. // Always wait at least one increment, so that a zero interval (e.g.
  4332. // "retry: 0" from the server) cannot cause a busy reconnect loop.
  4333. const auto step_ms = 100;
  4334. auto interval_ms = (std::max)(reconnect_interval_ms_, step_ms);
  4335. auto waited = 0;
  4336. while (running_.load() && waited < interval_ms) {
  4337. std::this_thread::sleep_for(std::chrono::milliseconds(step_ms));
  4338. waited += step_ms;
  4339. }
  4340. }
  4341. } // namespace sse
  4342. #ifdef CPPHTTPLIB_SSL_ENABLED
  4343. /*
  4344. * TLS abstraction layer - internal function declarations
  4345. * These are implementation details and not part of the public API.
  4346. */
  4347. namespace tls {
  4348. // Client context
  4349. ctx_t create_client_context();
  4350. void free_context(ctx_t ctx);
  4351. bool set_min_version(ctx_t ctx, Version version);
  4352. bool load_ca_pem(ctx_t ctx, const char *pem, size_t len);
  4353. bool load_ca_file(ctx_t ctx, const char *file_path);
  4354. bool load_ca_dir(ctx_t ctx, const char *dir_path);
  4355. bool load_system_certs(ctx_t ctx);
  4356. bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4357. const char *password);
  4358. bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  4359. const char *key_path, const char *password);
  4360. // Server context
  4361. ctx_t create_server_context();
  4362. bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4363. const char *password);
  4364. bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  4365. const char *key_path, const char *password);
  4366. bool set_client_ca_file(ctx_t ctx, const char *ca_file, const char *ca_dir);
  4367. void set_verify_client(ctx_t ctx, bool require);
  4368. // Session management
  4369. session_t create_session(ctx_t ctx, socket_t sock);
  4370. void free_session(session_t session);
  4371. bool set_sni(session_t session, const char *hostname, bool verify_hostname);
  4372. // Handshake (non-blocking capable)
  4373. TlsError connect(session_t session);
  4374. TlsError accept(session_t session);
  4375. // Handshake with timeout (blocking until timeout)
  4376. bool connect_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4377. time_t timeout_usec, TlsError *err);
  4378. bool accept_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4379. time_t timeout_usec, TlsError *err);
  4380. // I/O (non-blocking capable)
  4381. ssize_t read(session_t session, void *buf, size_t len, TlsError &err);
  4382. ssize_t write(session_t session, const void *buf, size_t len, TlsError &err);
  4383. int pending(const_session_t session);
  4384. void shutdown(session_t session, bool graceful);
  4385. // Connection state
  4386. bool is_peer_closed(session_t session, socket_t sock);
  4387. // Certificate verification
  4388. cert_t get_peer_cert(const_session_t session);
  4389. // The certificates the peer sent, leaf first. Free each with free_cert(), and
  4390. // do not use them after free_session(), as with get_peer_cert().
  4391. size_t get_peer_certs(const_session_t session, std::vector<cert_t> &certs);
  4392. void free_cert(cert_t cert);
  4393. bool verify_hostname(cert_t cert, const char *hostname);
  4394. uint64_t hostname_mismatch_code();
  4395. long get_verify_result(const_session_t session);
  4396. // Certificate introspection
  4397. std::string get_cert_subject_cn(cert_t cert);
  4398. std::string get_cert_issuer_name(cert_t cert);
  4399. bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans);
  4400. bool get_cert_validity(cert_t cert, time_t &not_before, time_t &not_after);
  4401. std::string get_cert_serial(cert_t cert);
  4402. bool get_cert_der(cert_t cert, std::vector<unsigned char> &der);
  4403. const char *get_sni(const_session_t session);
  4404. // CA store management
  4405. ca_store_t create_ca_store(const char *pem, size_t len);
  4406. void free_ca_store(ca_store_t store);
  4407. bool set_ca_store(ctx_t ctx, ca_store_t store);
  4408. // Free each with free_cert(), and do not use them once the context's CA
  4409. // certificates change.
  4410. size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs);
  4411. std::vector<std::string> get_ca_names(ctx_t ctx);
  4412. // Dynamic certificate update (for servers)
  4413. bool update_server_cert(ctx_t ctx, const char *cert_pem, const char *key_pem,
  4414. const char *password);
  4415. bool update_server_client_ca(ctx_t ctx, const char *ca_pem);
  4416. // Certificate verification callback
  4417. bool set_verify_callback(ctx_t ctx, VerifyCallback callback);
  4418. long get_verify_error(const_session_t session);
  4419. std::string verify_error_string(long error_code);
  4420. // TlsError information
  4421. uint64_t peek_error();
  4422. uint64_t get_error();
  4423. std::string error_string(uint64_t code);
  4424. } // namespace tls
  4425. #endif // CPPHTTPLIB_SSL_ENABLED
  4426. /*
  4427. * Group 1: detail namespace - Non-SSL utilities
  4428. */
  4429. namespace detail {
  4430. inline bool set_socket_opt_impl(socket_t sock, int level, int optname,
  4431. const void *optval, socklen_t optlen) {
  4432. return setsockopt(sock, level, optname,
  4433. #ifdef _WIN32
  4434. reinterpret_cast<const char *>(optval),
  4435. #else
  4436. optval,
  4437. #endif
  4438. optlen) == 0;
  4439. }
  4440. inline bool set_socket_opt_time(socket_t sock, int level, int optname,
  4441. time_t sec, time_t usec) {
  4442. #ifdef _WIN32
  4443. auto timeout = static_cast<uint32_t>(sec * 1000 + usec / 1000);
  4444. #else
  4445. timeval timeout;
  4446. timeout.tv_sec = static_cast<long>(sec);
  4447. timeout.tv_usec = static_cast<decltype(timeout.tv_usec)>(usec);
  4448. #endif
  4449. return set_socket_opt_impl(sock, level, optname, &timeout, sizeof(timeout));
  4450. }
  4451. inline bool is_hex(char c, int &v) {
  4452. if (is_ascii_digit(c)) {
  4453. v = c - '0';
  4454. return true;
  4455. } else if ('A' <= c && c <= 'F') {
  4456. v = c - 'A' + 10;
  4457. return true;
  4458. } else if ('a' <= c && c <= 'f') {
  4459. v = c - 'a' + 10;
  4460. return true;
  4461. }
  4462. return false;
  4463. }
  4464. inline bool from_hex_to_i(const std::string &s, size_t i, size_t cnt,
  4465. int &val) {
  4466. if (i >= s.size()) { return false; }
  4467. val = 0;
  4468. for (; cnt; i++, cnt--) {
  4469. if (!s[i]) { return false; }
  4470. auto v = 0;
  4471. if (is_hex(s[i], v)) {
  4472. val = val * 16 + v;
  4473. } else {
  4474. return false;
  4475. }
  4476. }
  4477. return true;
  4478. }
  4479. inline std::string from_i_to_hex(size_t n) {
  4480. static const auto charset = "0123456789abcdef";
  4481. std::string ret;
  4482. do {
  4483. ret = charset[n & 15] + ret;
  4484. n >>= 4;
  4485. } while (n > 0);
  4486. return ret;
  4487. }
  4488. // A round trip rather than `n <= SIZE_MAX`, which is always true on 64-bit
  4489. // builds and trips -Wtautological-type-limit-compare.
  4490. inline bool fits_in_size_t(uint64_t n) {
  4491. return static_cast<uint64_t>(static_cast<size_t>(n)) == n;
  4492. }
  4493. inline std::string compute_etag(const FileStat &fs,
  4494. const std::string &suffix = std::string()) {
  4495. if (!fs.is_file()) { return std::string(); }
  4496. // If mtime cannot be determined (negative value indicates an error
  4497. // or sentinel), do not generate an ETag. Returning a neutral / fixed
  4498. // value like 0 could collide with a real file that legitimately has
  4499. // mtime == 0 (epoch) and lead to misleading validators.
  4500. auto mtime_raw = fs.mtime();
  4501. if (mtime_raw < 0) { return std::string(); }
  4502. auto mtime = static_cast<size_t>(mtime_raw);
  4503. auto size = fs.size();
  4504. return std::string("W/\"") + from_i_to_hex(mtime) + "-" +
  4505. from_i_to_hex(size) + suffix + "\"";
  4506. }
  4507. // Format time_t as HTTP-date (RFC 9110 Section 5.6.7): "Sun, 06 Nov 1994
  4508. // 08:49:37 GMT" This implementation is defensive: it validates `mtime`, checks
  4509. // return values from `gmtime_r`/`gmtime_s`, and ensures `strftime` succeeds.
  4510. inline std::string file_mtime_to_http_date(time_t mtime) {
  4511. if (mtime < 0) { return std::string(); }
  4512. struct tm tm_buf;
  4513. #ifdef _WIN32
  4514. if (gmtime_s(&tm_buf, &mtime) != 0) { return std::string(); }
  4515. #else
  4516. if (gmtime_r(&mtime, &tm_buf) == nullptr) { return std::string(); }
  4517. #endif
  4518. char buf[64];
  4519. if (strftime(buf, sizeof(buf), "%a, %d %b %Y %H:%M:%S GMT", &tm_buf) == 0) {
  4520. return std::string();
  4521. }
  4522. return std::string(buf);
  4523. }
  4524. // Parse HTTP-date (RFC 9110 Section 5.6.7) to time_t. Returns -1 on failure.
  4525. inline time_t parse_http_date(const std::string &date_str) {
  4526. struct tm tm_buf;
  4527. // Create a classic locale object once for all parsing attempts
  4528. const std::locale classic_locale = std::locale::classic();
  4529. // Try to parse using std::get_time (C++11, cross-platform)
  4530. auto try_parse = [&](const char *fmt) -> bool {
  4531. std::istringstream ss(date_str);
  4532. ss.imbue(classic_locale);
  4533. memset(&tm_buf, 0, sizeof(tm_buf));
  4534. ss >> std::get_time(&tm_buf, fmt);
  4535. return !ss.fail();
  4536. };
  4537. // RFC 9110 preferred format (HTTP-date): "Sun, 06 Nov 1994 08:49:37 GMT"
  4538. if (!try_parse("%a, %d %b %Y %H:%M:%S")) {
  4539. // RFC 850 format: "Sunday, 06-Nov-94 08:49:37 GMT"
  4540. if (!try_parse("%A, %d-%b-%y %H:%M:%S")) {
  4541. // asctime format: "Sun Nov 6 08:49:37 1994"
  4542. if (!try_parse("%a %b %d %H:%M:%S %Y")) {
  4543. return static_cast<time_t>(-1);
  4544. }
  4545. }
  4546. }
  4547. #ifdef _WIN32
  4548. return _mkgmtime(&tm_buf);
  4549. #elif defined _AIX
  4550. return mktime(&tm_buf);
  4551. #else
  4552. return timegm(&tm_buf);
  4553. #endif
  4554. }
  4555. inline bool is_weak_etag(const std::string &s) {
  4556. // Check if the string is a weak ETag (starts with 'W/"')
  4557. return s.size() > 3 && s[0] == 'W' && s[1] == '/' && s[2] == '"';
  4558. }
  4559. inline bool is_strong_etag(const std::string &s) {
  4560. // Check if the string is a strong ETag (starts and ends with '"', at least 2
  4561. // chars)
  4562. return s.size() >= 2 && s[0] == '"' && s.back() == '"';
  4563. }
  4564. inline size_t to_utf8(int code, char *buff) {
  4565. if (code < 0x0080) {
  4566. buff[0] = static_cast<char>(code & 0x7F);
  4567. return 1;
  4568. } else if (code < 0x0800) {
  4569. buff[0] = static_cast<char>(0xC0 | ((code >> 6) & 0x1F));
  4570. buff[1] = static_cast<char>(0x80 | (code & 0x3F));
  4571. return 2;
  4572. } else if (code < 0xD800) {
  4573. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4574. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4575. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4576. return 3;
  4577. } else if (code < 0xE000) { // D800 - DFFF is invalid...
  4578. return 0;
  4579. } else if (code < 0x10000) {
  4580. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4581. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4582. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4583. return 3;
  4584. } else if (code < 0x110000) {
  4585. buff[0] = static_cast<char>(0xF0 | ((code >> 18) & 0x7));
  4586. buff[1] = static_cast<char>(0x80 | ((code >> 12) & 0x3F));
  4587. buff[2] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4588. buff[3] = static_cast<char>(0x80 | (code & 0x3F));
  4589. return 4;
  4590. }
  4591. // NOTREACHED
  4592. return 0;
  4593. }
  4594. } // namespace detail
  4595. namespace ws {
  4596. namespace impl {
  4597. inline bool is_valid_utf8(const std::string &s) {
  4598. size_t i = 0;
  4599. auto n = s.size();
  4600. while (i < n) {
  4601. auto c = static_cast<unsigned char>(s[i]);
  4602. size_t len;
  4603. uint32_t cp;
  4604. if (c < 0x80) {
  4605. i++;
  4606. continue;
  4607. } else if ((c & 0xE0) == 0xC0) {
  4608. len = 2;
  4609. cp = c & 0x1F;
  4610. } else if ((c & 0xF0) == 0xE0) {
  4611. len = 3;
  4612. cp = c & 0x0F;
  4613. } else if ((c & 0xF8) == 0xF0) {
  4614. len = 4;
  4615. cp = c & 0x07;
  4616. } else {
  4617. return false;
  4618. }
  4619. if (i + len > n) { return false; }
  4620. for (size_t j = 1; j < len; j++) {
  4621. auto b = static_cast<unsigned char>(s[i + j]);
  4622. if ((b & 0xC0) != 0x80) { return false; }
  4623. cp = (cp << 6) | (b & 0x3F);
  4624. }
  4625. // Overlong encoding check
  4626. if (len == 2 && cp < 0x80) { return false; }
  4627. if (len == 3 && cp < 0x800) { return false; }
  4628. if (len == 4 && cp < 0x10000) { return false; }
  4629. // Surrogate halves (U+D800..U+DFFF) and beyond U+10FFFF are invalid
  4630. if (cp >= 0xD800 && cp <= 0xDFFF) { return false; }
  4631. if (cp > 0x10FFFF) { return false; }
  4632. i += len;
  4633. }
  4634. return true;
  4635. }
  4636. } // namespace impl
  4637. } // namespace ws
  4638. namespace detail {
  4639. // NOTE: This code came up with the following stackoverflow post:
  4640. // https://stackoverflow.com/questions/180947/base64-decode-snippet-in-c
  4641. inline std::string base64_encode(const std::string &in) {
  4642. static const auto lookup =
  4643. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4644. std::string out;
  4645. out.reserve(in.size());
  4646. // Unsigned: the accumulator is never masked, so with a signed int the
  4647. // `val << 8` below overflows once enough bytes are folded in (undefined
  4648. // behaviour before C++20). Only the low bits are ever emitted, so the
  4649. // wrap-around of an unsigned accumulator does not affect the output.
  4650. uint32_t val = 0;
  4651. auto valb = -6;
  4652. for (auto c : in) {
  4653. val = (val << 8) + static_cast<uint8_t>(c);
  4654. valb += 8;
  4655. while (valb >= 0) {
  4656. out.push_back(lookup[(val >> valb) & 0x3F]);
  4657. valb -= 6;
  4658. }
  4659. }
  4660. if (valb > -6) { out.push_back(lookup[((val << 8) >> (valb + 8)) & 0x3F]); }
  4661. while (out.size() % 4) {
  4662. out.push_back('=');
  4663. }
  4664. return out;
  4665. }
  4666. inline std::string sha1(const std::string &input) {
  4667. // RFC 3174 SHA-1 implementation
  4668. auto left_rotate = [](uint32_t x, uint32_t n) -> uint32_t {
  4669. return (x << n) | (x >> (32 - n));
  4670. };
  4671. uint32_t h0 = 0x67452301;
  4672. uint32_t h1 = 0xEFCDAB89;
  4673. uint32_t h2 = 0x98BADCFE;
  4674. uint32_t h3 = 0x10325476;
  4675. uint32_t h4 = 0xC3D2E1F0;
  4676. // Pre-processing: adding padding bits
  4677. std::string msg = input;
  4678. uint64_t original_bit_len = static_cast<uint64_t>(msg.size()) * 8;
  4679. msg.push_back(static_cast<char>(0x80u));
  4680. while (msg.size() % 64 != 56) {
  4681. msg.push_back(0);
  4682. }
  4683. // Append original length in bits as 64-bit big-endian
  4684. for (int i = 56; i >= 0; i -= 8) {
  4685. msg.push_back(static_cast<char>((original_bit_len >> i) & 0xFF));
  4686. }
  4687. // Process each 512-bit chunk
  4688. for (size_t offset = 0; offset < msg.size(); offset += 64) {
  4689. uint32_t w[80];
  4690. for (size_t i = 0; i < 16; i++) {
  4691. w[i] =
  4692. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4]))
  4693. << 24) |
  4694. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 1]))
  4695. << 16) |
  4696. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 2]))
  4697. << 8) |
  4698. (static_cast<uint32_t>(
  4699. static_cast<uint8_t>(msg[offset + i * 4 + 3])));
  4700. }
  4701. for (int i = 16; i < 80; i++) {
  4702. w[i] = left_rotate(w[i - 3] ^ w[i - 8] ^ w[i - 14] ^ w[i - 16], 1);
  4703. }
  4704. uint32_t a = h0, b = h1, c = h2, d = h3, e = h4;
  4705. for (int i = 0; i < 80; i++) {
  4706. uint32_t f, k;
  4707. if (i < 20) {
  4708. f = (b & c) | ((~b) & d);
  4709. k = 0x5A827999;
  4710. } else if (i < 40) {
  4711. f = b ^ c ^ d;
  4712. k = 0x6ED9EBA1;
  4713. } else if (i < 60) {
  4714. f = (b & c) | (b & d) | (c & d);
  4715. k = 0x8F1BBCDC;
  4716. } else {
  4717. f = b ^ c ^ d;
  4718. k = 0xCA62C1D6;
  4719. }
  4720. uint32_t temp = left_rotate(a, 5) + f + e + k + w[i];
  4721. e = d;
  4722. d = c;
  4723. c = left_rotate(b, 30);
  4724. b = a;
  4725. a = temp;
  4726. }
  4727. h0 += a;
  4728. h1 += b;
  4729. h2 += c;
  4730. h3 += d;
  4731. h4 += e;
  4732. }
  4733. // Produce the final hash as a 20-byte binary string
  4734. std::string hash(20, '\0');
  4735. for (size_t i = 0; i < 4; i++) {
  4736. hash[i] = static_cast<char>((h0 >> (24 - i * 8)) & 0xFF);
  4737. hash[4 + i] = static_cast<char>((h1 >> (24 - i * 8)) & 0xFF);
  4738. hash[8 + i] = static_cast<char>((h2 >> (24 - i * 8)) & 0xFF);
  4739. hash[12 + i] = static_cast<char>((h3 >> (24 - i * 8)) & 0xFF);
  4740. hash[16 + i] = static_cast<char>((h4 >> (24 - i * 8)) & 0xFF);
  4741. }
  4742. return hash;
  4743. }
  4744. inline std::string websocket_accept_key(const std::string &client_key) {
  4745. const std::string magic = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
  4746. return base64_encode(sha1(client_key + magic));
  4747. }
  4748. inline bool is_websocket_upgrade(const Request &req) {
  4749. if (req.method != "GET") { return false; }
  4750. // Check Upgrade: websocket. RFC 9110 7.8 defines Upgrade as a comma-separated
  4751. // list of protocols and asks recipients to match each name
  4752. // case-insensitively, so look for the token rather than compare the whole
  4753. // field value.
  4754. if (!has_header_token(req.headers, "Upgrade", "websocket")) { return false; }
  4755. // Check Connection: Upgrade
  4756. if (!has_header_token(req.headers, "Connection", "upgrade")) { return false; }
  4757. // Check Sec-WebSocket-Key is a valid base64-encoded 16-byte value (24 chars)
  4758. // RFC 6455 Section 4.2.1
  4759. auto ws_key = req.get_header_value("Sec-WebSocket-Key");
  4760. if (ws_key.size() != 24 || ws_key[22] != '=' || ws_key[23] != '=') {
  4761. return false;
  4762. }
  4763. static const std::string b64chars =
  4764. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4765. for (size_t i = 0; i < 22; i++) {
  4766. if (b64chars.find(ws_key[i]) == std::string::npos) { return false; }
  4767. }
  4768. // Check Sec-WebSocket-Version: 13
  4769. auto version = req.get_header_value("Sec-WebSocket-Version");
  4770. if (version != "13") { return false; }
  4771. return true;
  4772. }
  4773. // Unpredictable bytes for masking keys (RFC 6455 Section 5.3) and nonces
  4774. inline void fill_random_bytes(unsigned char *out, size_t n) {
  4775. thread_local std::random_device rd;
  4776. size_t filled = 0;
  4777. while (filled < n) {
  4778. auto v = rd();
  4779. for (size_t b = 0; b < sizeof(v) && filled < n; ++b, ++filled) {
  4780. out[filled] = static_cast<unsigned char>((v >> (b * 8)) & 0xFFu);
  4781. }
  4782. }
  4783. }
  4784. inline bool write_websocket_frame(Stream &strm, ws::Opcode opcode,
  4785. const char *data, size_t len, bool fin,
  4786. bool mask) {
  4787. // First byte: FIN + opcode
  4788. uint8_t header[2];
  4789. header[0] = static_cast<uint8_t>((fin ? 0x80 : 0x00) |
  4790. (static_cast<uint8_t>(opcode) & 0x0F));
  4791. // Second byte: MASK + payload length
  4792. if (len < 126) {
  4793. header[1] = static_cast<uint8_t>(len);
  4794. if (mask) { header[1] |= 0x80; }
  4795. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4796. } else if (len <= 0xFFFF) {
  4797. header[1] = 126;
  4798. if (mask) { header[1] |= 0x80; }
  4799. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4800. uint8_t ext[2];
  4801. ext[0] = static_cast<uint8_t>((len >> 8) & 0xFF);
  4802. ext[1] = static_cast<uint8_t>(len & 0xFF);
  4803. if (strm.write(reinterpret_cast<char *>(ext), 2) < 0) { return false; }
  4804. } else {
  4805. header[1] = 127;
  4806. if (mask) { header[1] |= 0x80; }
  4807. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4808. uint8_t ext[8];
  4809. for (int i = 7; i >= 0; i--) {
  4810. ext[7 - i] =
  4811. static_cast<uint8_t>((static_cast<uint64_t>(len) >> (i * 8)) & 0xFF);
  4812. }
  4813. if (strm.write(reinterpret_cast<char *>(ext), 8) < 0) { return false; }
  4814. }
  4815. if (mask) {
  4816. // Generate random mask key
  4817. uint8_t mask_key[4];
  4818. fill_random_bytes(mask_key, sizeof(mask_key));
  4819. if (strm.write(reinterpret_cast<char *>(mask_key), 4) < 0) { return false; }
  4820. // Write masked payload in chunks
  4821. const size_t chunk_size = 4096;
  4822. std::vector<char> buf((std::min)(len, chunk_size));
  4823. for (size_t offset = 0; offset < len; offset += chunk_size) {
  4824. size_t n = (std::min)(chunk_size, len - offset);
  4825. for (size_t i = 0; i < n; i++) {
  4826. buf[i] =
  4827. data[offset + i] ^ static_cast<char>(mask_key[(offset + i) % 4]);
  4828. }
  4829. if (strm.write(buf.data(), n) < 0) { return false; }
  4830. }
  4831. } else {
  4832. if (len > 0) {
  4833. if (strm.write(data, len) < 0) { return false; }
  4834. }
  4835. }
  4836. return true;
  4837. }
  4838. } // namespace detail
  4839. namespace ws {
  4840. namespace impl {
  4841. // Read exactly `size` bytes. Stream::read may return less than asked for -- it
  4842. // hands back whatever its buffer already holds -- so every multi-byte field has
  4843. // to loop. Reading a 2-byte header with a single read() fails whenever the
  4844. // header straddles the read buffer's boundary.
  4845. //
  4846. // Timeout is reported only when nothing at all was consumed. Once a byte has
  4847. // been taken the stream sits mid-field and cannot be resumed, so a timeout
  4848. // there is a failure like any other. (When read() fails it always records why,
  4849. // so the error belongs to this call and not to an earlier one.)
  4850. inline FrameRead read_exact(Stream &strm, void *buf, size_t size) {
  4851. auto p = static_cast<char *>(buf);
  4852. size_t total = 0;
  4853. while (total < size) {
  4854. auto n = strm.read(p + total, size - total);
  4855. if (n <= 0) {
  4856. auto timed_out = total == 0 && strm.get_error() == Error::Timeout;
  4857. return timed_out ? FrameRead::Timeout : FrameRead::Fail;
  4858. }
  4859. total += static_cast<size_t>(n);
  4860. }
  4861. return FrameRead::Ok;
  4862. }
  4863. inline FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  4864. std::string &payload, bool &fin,
  4865. bool expect_masked, size_t max_len) {
  4866. // Read first 2 bytes. This is the only read that may report a timeout: it
  4867. // sits on a frame boundary, where nothing has been consumed yet.
  4868. uint8_t header[2];
  4869. FrameRead first = read_exact(strm, header, 2);
  4870. if (first != FrameRead::Ok) { return first; }
  4871. fin = (header[0] & 0x80) != 0;
  4872. // RSV1, RSV2, RSV3 must be 0 when no extension is negotiated
  4873. if (header[0] & 0x70) { return FrameRead::Fail; }
  4874. opcode = static_cast<Opcode>(header[0] & 0x0F);
  4875. bool masked = (header[1] & 0x80) != 0;
  4876. uint64_t payload_len = header[1] & 0x7F;
  4877. // RFC 6455 Section 5.5: control frames MUST NOT be fragmented and
  4878. // MUST have a payload length of 125 bytes or less
  4879. bool is_control = (static_cast<uint8_t>(opcode) & 0x08) != 0;
  4880. if (is_control) {
  4881. if (!fin) { return FrameRead::Fail; }
  4882. if (payload_len > 125) { return FrameRead::Fail; }
  4883. }
  4884. if (masked != expect_masked) { return FrameRead::Fail; }
  4885. // Extended payload length
  4886. if (payload_len == 126) {
  4887. uint8_t ext[2];
  4888. if (read_exact(strm, ext, 2) != FrameRead::Ok) { return FrameRead::Fail; }
  4889. payload_len = (static_cast<uint64_t>(ext[0]) << 8) | ext[1];
  4890. } else if (payload_len == 127) {
  4891. uint8_t ext[8];
  4892. if (read_exact(strm, ext, 8) != FrameRead::Ok) { return FrameRead::Fail; }
  4893. // RFC 6455 Section 5.2: the most significant bit MUST be 0
  4894. if (ext[0] & 0x80) { return FrameRead::Fail; }
  4895. payload_len = 0;
  4896. for (int i = 0; i < 8; i++) {
  4897. payload_len = (payload_len << 8) | ext[i];
  4898. }
  4899. }
  4900. // A max_len of 0 means no limit, as payload_max_length does, and a length
  4901. // size_t cannot hold (32-bit builds) is refused either way.
  4902. if ((max_len > 0 && payload_len > max_len) ||
  4903. !detail::fits_in_size_t(payload_len)) {
  4904. return FrameRead::Fail;
  4905. }
  4906. // Read mask key if present
  4907. uint8_t mask_key[4] = {0};
  4908. if (masked) {
  4909. if (read_exact(strm, mask_key, 4) != FrameRead::Ok) {
  4910. return FrameRead::Fail;
  4911. }
  4912. }
  4913. // Grow the payload only as it arrives, since a header alone can announce
  4914. // max_len bytes that never come.
  4915. payload.clear();
  4916. auto len = static_cast<size_t>(payload_len);
  4917. while (payload.size() < len) {
  4918. auto offset = payload.size();
  4919. auto n = (std::min)(len - offset, CPPHTTPLIB_RECV_BUFSIZ);
  4920. payload.resize(offset + n);
  4921. if (read_exact(strm, &payload[offset], n) != FrameRead::Ok) {
  4922. return FrameRead::Fail;
  4923. }
  4924. }
  4925. // Unmask if needed
  4926. if (masked) {
  4927. for (size_t i = 0; i < payload.size(); i++) {
  4928. payload[i] ^= static_cast<char>(mask_key[i % 4]);
  4929. }
  4930. }
  4931. return FrameRead::Ok;
  4932. }
  4933. // RFC 6455 §5.5.1, §7.4: a Close payload is empty, or a status code that may
  4934. // be sent followed by a UTF-8 reason.
  4935. inline bool is_valid_close_payload(const std::string &payload) {
  4936. if (payload.empty()) { return true; }
  4937. if (payload.size() < 2) { return false; }
  4938. auto code = (static_cast<uint8_t>(payload[0]) << 8) |
  4939. static_cast<uint8_t>(payload[1]);
  4940. auto may_be_sent = (1000 <= code && code <= 1003) ||
  4941. (1007 <= code && code <= 1014) ||
  4942. (3000 <= code && code <= 4999);
  4943. return may_be_sent && is_valid_utf8(payload.substr(2));
  4944. }
  4945. } // namespace impl
  4946. } // namespace ws
  4947. namespace detail {
  4948. // A path a mount point serves: absolute, with no ".", ".." or empty segment
  4949. // except a trailing '/', so the file served is the one that req.path names to
  4950. // the handlers that ran before it.
  4951. inline bool is_valid_path(const std::string &path) {
  4952. if (path.empty() || path[0] != '/') { return false; }
  4953. auto beg = size_t{1};
  4954. for (auto i = beg; i <= path.size(); i++) {
  4955. if (i < path.size() && path[i] != '/') {
  4956. if (path[i] == '\0' || path[i] == '\\') { return false; }
  4957. continue;
  4958. }
  4959. auto len = i - beg;
  4960. if ((len == 0 && i < path.size()) || (len == 1 && path[beg] == '.') ||
  4961. (len == 2 && path[beg] == '.' && path[beg + 1] == '.')) {
  4962. return false;
  4963. }
  4964. beg = i + 1;
  4965. }
  4966. return true;
  4967. }
  4968. inline bool canonicalize_path(const char *path, std::string &resolved) {
  4969. #if defined(_WIN32)
  4970. char buf[_MAX_PATH];
  4971. if (_fullpath(buf, path, _MAX_PATH) == nullptr) { return false; }
  4972. resolved = buf;
  4973. #elif defined(PATH_MAX)
  4974. char buf[PATH_MAX];
  4975. if (realpath(path, buf) == nullptr) { return false; }
  4976. resolved = buf;
  4977. #else
  4978. auto buf = realpath(path, nullptr);
  4979. auto guard = scope_exit([&]() { std::free(buf); });
  4980. if (buf == nullptr) { return false; }
  4981. resolved = buf;
  4982. #endif
  4983. return true;
  4984. }
  4985. inline bool is_path_within_base(const std::string &resolved_path,
  4986. const std::string &resolved_base) {
  4987. #if defined(_WIN32)
  4988. return _strnicmp(resolved_path.c_str(), resolved_base.c_str(),
  4989. resolved_base.size()) == 0;
  4990. #else
  4991. return strncmp(resolved_path.c_str(), resolved_base.c_str(),
  4992. resolved_base.size()) == 0;
  4993. #endif
  4994. }
  4995. inline FileStat::FileStat(const std::string &path) {
  4996. #if defined(_WIN32)
  4997. auto wpath = u8string_to_wstring(path.c_str());
  4998. ret_ = _wstat(wpath.c_str(), &st_);
  4999. #else
  5000. ret_ = stat(path.c_str(), &st_);
  5001. #endif
  5002. }
  5003. inline bool FileStat::is_file() const {
  5004. return ret_ >= 0 && S_ISREG(st_.st_mode);
  5005. }
  5006. inline bool FileStat::is_dir() const {
  5007. return ret_ >= 0 && S_ISDIR(st_.st_mode);
  5008. }
  5009. inline time_t FileStat::mtime() const {
  5010. return ret_ >= 0 ? static_cast<time_t>(st_.st_mtime)
  5011. : static_cast<time_t>(-1);
  5012. }
  5013. inline size_t FileStat::size() const {
  5014. return ret_ >= 0 ? static_cast<size_t>(st_.st_size) : 0;
  5015. }
  5016. inline std::string encode_path(const std::string &s) {
  5017. std::string result;
  5018. result.reserve(s.size());
  5019. for (size_t i = 0; s[i]; i++) {
  5020. switch (s[i]) {
  5021. case ' ': result += "%20"; break;
  5022. case '+': result += "%2B"; break;
  5023. case '\'': result += "%27"; break;
  5024. case ',': result += "%2C"; break;
  5025. // case ':': result += "%3A"; break; // ok? probably...
  5026. case ';': result += "%3B"; break;
  5027. default:
  5028. auto c = static_cast<uint8_t>(s[i]);
  5029. // Control characters (incl. CR/LF) and non-ASCII bytes are not allowed
  5030. // in a request-target as-is.
  5031. if (c < 0x20 || c == 0x7f || c >= 0x80) {
  5032. result += '%';
  5033. char hex[4];
  5034. auto len = snprintf(hex, sizeof(hex) - 1, "%02X", c);
  5035. assert(len == 2);
  5036. result.append(hex, static_cast<size_t>(len));
  5037. } else {
  5038. result += s[i];
  5039. }
  5040. break;
  5041. }
  5042. }
  5043. return result;
  5044. }
  5045. inline std::string file_extension(const std::string &path) {
  5046. auto i = path.size();
  5047. while (i > 0 && is_ascii_alnum(path[i - 1])) {
  5048. i--;
  5049. }
  5050. if (i == path.size() || i == 0 || path[i - 1] != '.') {
  5051. return std::string();
  5052. }
  5053. return path.substr(i);
  5054. }
  5055. inline bool is_space_or_tab(char c) { return c == ' ' || c == '\t'; }
  5056. template <typename T>
  5057. inline bool parse_header(const char *beg, const char *end, T fn);
  5058. template <typename T>
  5059. inline bool parse_header(const char *beg, const char *end, T fn) {
  5060. // Skip trailing spaces and tabs.
  5061. while (beg < end && is_space_or_tab(end[-1])) {
  5062. end--;
  5063. }
  5064. auto p = beg;
  5065. while (p < end && *p != ':') {
  5066. p++;
  5067. }
  5068. auto name = std::string(beg, p);
  5069. if (!detail::fields::is_field_name(name)) { return false; }
  5070. if (p == end) { return false; }
  5071. auto key_end = p;
  5072. if (*p++ != ':') { return false; }
  5073. while (p < end && is_space_or_tab(*p)) {
  5074. p++;
  5075. }
  5076. if (p <= end) {
  5077. auto key_len = key_end - beg;
  5078. if (!key_len) { return false; }
  5079. auto key = std::string(beg, key_end);
  5080. auto val = std::string(p, end);
  5081. if (!detail::fields::is_field_value(val)) { return false; }
  5082. // RFC 9110 §5.5: header field values are opaque octets and MUST NOT be
  5083. // percent-decoded by the recipient. Applications that need to interpret a
  5084. // value as a URI component should call httplib::decode_uri_component()
  5085. // (or decode_path_component()) explicitly.
  5086. fn(key, val);
  5087. return true;
  5088. }
  5089. return false;
  5090. }
  5091. inline bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  5092. const Headers &src_headers) {
  5093. // NOTE: In RFC 9112, '7.1 Chunked Transfer Coding' mentions "The chunked
  5094. // transfer coding is complete when a chunk with a chunk-size of zero is
  5095. // received, possibly followed by a trailer section, and finally terminated by
  5096. // an empty line". https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1
  5097. //
  5098. // In '7.1.3. Decoding Chunked', however, the pseudo-code in the section
  5099. // doesn't care for the existence of the final CRLF. In other words, it seems
  5100. // to be ok whether the final CRLF exists or not in the chunked data.
  5101. // https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1.3
  5102. //
  5103. // According to the reference code in RFC 9112, cpp-httplib now allows
  5104. // chunked transfer coding data without the final CRLF.
  5105. // RFC 7230 Section 4.1.2 - Headers prohibited in trailers
  5106. thread_local case_ignore::unordered_set<std::string> prohibited_trailers = {
  5107. "transfer-encoding",
  5108. "content-length",
  5109. "host",
  5110. "authorization",
  5111. "www-authenticate",
  5112. "proxy-authenticate",
  5113. "proxy-authorization",
  5114. "cookie",
  5115. "set-cookie",
  5116. "cache-control",
  5117. "expect",
  5118. "max-forwards",
  5119. "pragma",
  5120. "range",
  5121. "te",
  5122. "age",
  5123. "expires",
  5124. "date",
  5125. "location",
  5126. "retry-after",
  5127. "vary",
  5128. "warning",
  5129. "content-encoding",
  5130. "content-type",
  5131. "content-range",
  5132. "trailer"};
  5133. case_ignore::unordered_set<std::string> declared_trailers;
  5134. auto trailer_header = get_combined_header_value(src_headers, "Trailer");
  5135. if (!trailer_header.empty()) {
  5136. // split() trims each token and skips empty ones, so the name arrives ready
  5137. // to look up.
  5138. split(trailer_header.data(), trailer_header.data() + trailer_header.size(),
  5139. ',', [&](const char *b, const char *e) {
  5140. // A legitimate message declares only a handful of trailers. Cap the
  5141. // set so a peer cannot grow it without bound: an oversized set only
  5142. // arises from an attempt to force many colliding names into
  5143. // quadratic lookups (case_ignore::hash is unkeyed).
  5144. if (declared_trailers.size() >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  5145. return;
  5146. }
  5147. std::string key(b, e);
  5148. if (prohibited_trailers.find(key) == prohibited_trailers.end()) {
  5149. declared_trailers.insert(key);
  5150. }
  5151. });
  5152. }
  5153. size_t trailer_header_count = 0;
  5154. while (strcmp(line_reader.ptr(), "\r\n") != 0) {
  5155. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  5156. // Count every received trailer field, not only the declared ones stored in
  5157. // dest, so undeclared fields cannot keep this loop running past the limit.
  5158. if (trailer_header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  5159. constexpr auto line_terminator_len = 2;
  5160. auto line_beg = line_reader.ptr();
  5161. auto line_end =
  5162. line_reader.ptr() + line_reader.size() - line_terminator_len;
  5163. if (!parse_header(line_beg, line_end,
  5164. [&](const std::string &key, const std::string &val) {
  5165. if (declared_trailers.find(key) !=
  5166. declared_trailers.end()) {
  5167. dest.emplace(key, val);
  5168. }
  5169. })) {
  5170. return false;
  5171. }
  5172. trailer_header_count++;
  5173. if (!line_reader.getline()) { return false; }
  5174. }
  5175. return true;
  5176. }
  5177. inline std::pair<size_t, size_t> trim(const char *b, const char *e, size_t left,
  5178. size_t right) {
  5179. while (b + left < e && is_space_or_tab(b[left])) {
  5180. left++;
  5181. }
  5182. while (right > 0 && is_space_or_tab(b[right - 1])) {
  5183. right--;
  5184. }
  5185. return std::make_pair(left, right);
  5186. }
  5187. inline std::string trim_copy(const std::string &s) {
  5188. auto r = trim(s.data(), s.data() + s.size(), 0, s.size());
  5189. return s.substr(r.first, r.second - r.first);
  5190. }
  5191. inline std::string trim_double_quotes_copy(const std::string &s) {
  5192. if (s.length() >= 2 && s.front() == '"' && s.back() == '"') {
  5193. return s.substr(1, s.size() - 2);
  5194. }
  5195. return s;
  5196. }
  5197. // Takes the quotes off a parameter value. Only \" and \\ are quoted-pairs
  5198. // here, as browsers send any other backslash, such as one in a Windows path,
  5199. // as it is.
  5200. inline std::string unquote_param(const std::string &s) {
  5201. if (s.size() < 2 || s.front() != '"' || s.back() != '"') { return s; }
  5202. std::string out;
  5203. for (size_t i = 1; i + 1 < s.size(); i++) {
  5204. if (s[i] == '\\' && i + 2 < s.size() &&
  5205. (s[i + 1] == '"' || s[i + 1] == '\\')) {
  5206. i++;
  5207. }
  5208. out += s[i];
  5209. }
  5210. return out;
  5211. }
  5212. inline void
  5213. divide(const char *data, std::size_t size, char d,
  5214. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5215. fn) {
  5216. const auto it = std::find(data, data + size, d);
  5217. const auto found = static_cast<std::size_t>(it != data + size);
  5218. const auto lhs_data = data;
  5219. const auto lhs_size = static_cast<std::size_t>(it - data);
  5220. const auto rhs_data = it + found;
  5221. const auto rhs_size = size - lhs_size - found;
  5222. fn(lhs_data, lhs_size, rhs_data, rhs_size);
  5223. }
  5224. inline void
  5225. divide(const std::string &str, char d,
  5226. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5227. fn) {
  5228. divide(str.data(), str.size(), d, std::move(fn));
  5229. }
  5230. inline void split(const char *b, const char *e, char d,
  5231. std::function<void(const char *, const char *)> fn) {
  5232. return split(b, e, d, (std::numeric_limits<size_t>::max)(), std::move(fn));
  5233. }
  5234. inline void split(const char *b, const char *e, char d, size_t m,
  5235. std::function<void(const char *, const char *)> fn) {
  5236. size_t i = 0;
  5237. size_t beg = 0;
  5238. size_t count = 1;
  5239. while (e ? (b + i < e) : (b[i] != '\0')) {
  5240. if (b[i] == d && count < m) {
  5241. auto r = trim(b, e, beg, i);
  5242. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5243. beg = i + 1;
  5244. count++;
  5245. }
  5246. i++;
  5247. }
  5248. if (i) {
  5249. auto r = trim(b, e, beg, i);
  5250. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5251. }
  5252. }
  5253. // Same contract as split(), except that a delimiter inside a quoted-string is
  5254. // not a delimiter. RFC 9110 Section 5.6.6 lets a parameter value be a
  5255. // quoted-string, and ';' and '=' are legal characters inside one.
  5256. inline void split_unquoted(const char *b, const char *e, char d, size_t m,
  5257. std::function<void(const char *, const char *)> fn) {
  5258. size_t i = 0;
  5259. size_t beg = 0;
  5260. size_t count = 1;
  5261. auto in_quotes = false;
  5262. auto has = [&](size_t j) { return e ? (b + j < e) : (b[j] != '\0'); };
  5263. while (has(i)) {
  5264. if (in_quotes && b[i] == '\\' && has(i + 1)) {
  5265. // A quoted-pair, whose second character does not end the string.
  5266. i++;
  5267. } else if (b[i] == '"') {
  5268. in_quotes = !in_quotes;
  5269. } else if (b[i] == d && !in_quotes && count < m) {
  5270. auto r = trim(b, e, beg, i);
  5271. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5272. beg = i + 1;
  5273. count++;
  5274. }
  5275. i++;
  5276. }
  5277. if (i) {
  5278. auto r = trim(b, e, beg, i);
  5279. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5280. }
  5281. }
  5282. inline void split_unquoted(const char *b, const char *e, char d,
  5283. std::function<void(const char *, const char *)> fn) {
  5284. return split_unquoted(b, e, d, (std::numeric_limits<size_t>::max)(),
  5285. std::move(fn));
  5286. }
  5287. // Divide a header parameter at its first '='. RFC 9110 Section 5.6.6 makes the
  5288. // key a token, so the first '=' is the separator even when the value is a
  5289. // quoted-string carrying more of them.
  5290. inline void divide_param_pair(const char *b, const char *e, std::string &key,
  5291. std::string &val) {
  5292. divide(
  5293. b, static_cast<std::size_t>(e - b), '=',
  5294. [&](const char *kb, std::size_t klen, const char *vb, std::size_t vlen) {
  5295. const auto kr = trim(kb, kb + klen, 0, klen);
  5296. key.assign(kb + kr.first, kb + kr.second);
  5297. const auto vr = trim(vb, vb + vlen, 0, vlen);
  5298. val.assign(vb + vr.first, vb + vr.second);
  5299. });
  5300. }
  5301. inline bool split_find(const char *b, const char *e, char d, size_t m,
  5302. std::function<bool(const char *, const char *)> fn) {
  5303. size_t i = 0;
  5304. size_t beg = 0;
  5305. size_t count = 1;
  5306. while (e ? (b + i < e) : (b[i] != '\0')) {
  5307. if (b[i] == d && count < m) {
  5308. auto r = trim(b, e, beg, i);
  5309. if (r.first < r.second) {
  5310. auto found = fn(&b[r.first], &b[r.second]);
  5311. if (found) { return true; }
  5312. }
  5313. beg = i + 1;
  5314. count++;
  5315. }
  5316. i++;
  5317. }
  5318. if (i) {
  5319. auto r = trim(b, e, beg, i);
  5320. if (r.first < r.second) {
  5321. auto found = fn(&b[r.first], &b[r.second]);
  5322. if (found) { return true; }
  5323. }
  5324. }
  5325. return false;
  5326. }
  5327. inline bool split_find(const char *b, const char *e, char d,
  5328. std::function<bool(const char *, const char *)> fn) {
  5329. return split_find(b, e, d, (std::numeric_limits<size_t>::max)(),
  5330. std::move(fn));
  5331. }
  5332. inline stream_line_reader::stream_line_reader(Stream &strm, char *fixed_buffer,
  5333. size_t fixed_buffer_size)
  5334. : strm_(strm), fixed_buffer_(fixed_buffer),
  5335. fixed_buffer_size_(fixed_buffer_size) {}
  5336. inline const char *stream_line_reader::ptr() const {
  5337. if (growable_buffer_.empty()) {
  5338. return fixed_buffer_;
  5339. } else {
  5340. return growable_buffer_.data();
  5341. }
  5342. }
  5343. inline size_t stream_line_reader::size() const {
  5344. if (growable_buffer_.empty()) {
  5345. return fixed_buffer_used_size_;
  5346. } else {
  5347. return growable_buffer_.size();
  5348. }
  5349. }
  5350. inline bool stream_line_reader::end_with_crlf() const {
  5351. auto end = ptr() + size();
  5352. return size() >= 2 && end[-2] == '\r' && end[-1] == '\n';
  5353. }
  5354. inline bool stream_line_reader::getline() {
  5355. fixed_buffer_used_size_ = 0;
  5356. growable_buffer_.clear();
  5357. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5358. char prev_byte = 0;
  5359. #endif
  5360. for (size_t i = 0;; i++) {
  5361. // Fast path: whatever the stream has already buffered can be scanned for
  5362. // the terminator in one pass. Asking for a byte at a time costs a virtual
  5363. // call, a bounds check and a one-byte copy per character of the request.
  5364. size_t buffered_size = 0;
  5365. if (auto buffered = strm_.buffered_data(buffered_size)) {
  5366. auto take = buffered_size;
  5367. auto terminated = false;
  5368. for (size_t at = 0; at < buffered_size;) {
  5369. auto nl = static_cast<const char *>(
  5370. memchr(buffered + at, '\n', buffered_size - at));
  5371. if (!nl) { break; }
  5372. auto pos = static_cast<size_t>(nl - buffered);
  5373. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5374. take = pos + 1;
  5375. terminated = true;
  5376. break;
  5377. #else
  5378. // A bare LF does not end the line; keep looking for CRLF. The CR may
  5379. // be the last byte of an earlier chunk, hence prev_byte.
  5380. if ((pos > 0 ? buffered[pos - 1] : prev_byte) == '\r') {
  5381. take = pos + 1;
  5382. terminated = true;
  5383. break;
  5384. }
  5385. at = pos + 1;
  5386. #endif
  5387. }
  5388. if (size() + take > CPPHTTPLIB_MAX_LINE_LENGTH) { return false; }
  5389. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5390. prev_byte = buffered[take - 1];
  5391. #endif
  5392. append(buffered, take);
  5393. strm_.consume_buffered(take);
  5394. i += take;
  5395. if (terminated) { return true; }
  5396. continue;
  5397. }
  5398. if (size() >= CPPHTTPLIB_MAX_LINE_LENGTH) {
  5399. // Treat exceptionally long lines as an error to
  5400. // prevent infinite loops/memory exhaustion
  5401. return false;
  5402. }
  5403. char byte;
  5404. auto n = strm_.read(&byte, 1);
  5405. if (n < 0) {
  5406. return false;
  5407. } else if (n == 0) {
  5408. if (i == 0) {
  5409. return false;
  5410. } else {
  5411. break;
  5412. }
  5413. }
  5414. append(byte);
  5415. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5416. if (byte == '\n') { break; }
  5417. #else
  5418. if (prev_byte == '\r' && byte == '\n') { break; }
  5419. prev_byte = byte;
  5420. #endif
  5421. }
  5422. return true;
  5423. }
  5424. inline void stream_line_reader::append(char c) { append(&c, 1); }
  5425. inline void stream_line_reader::append(const char *data, size_t size) {
  5426. // Once the line has outgrown the fixed buffer everything must keep going to
  5427. // the growable one, even if a later chunk would have fit. Without the
  5428. // emptiness check a short append after a long one would land in the fixed
  5429. // buffer, which ptr() and size() no longer look at, and be lost.
  5430. if (growable_buffer_.empty() &&
  5431. fixed_buffer_used_size_ + size < fixed_buffer_size_) {
  5432. memcpy(fixed_buffer_ + fixed_buffer_used_size_, data, size);
  5433. fixed_buffer_used_size_ += size;
  5434. fixed_buffer_[fixed_buffer_used_size_] = '\0';
  5435. } else {
  5436. // Unlike the per-character overload, this can be the very first append of
  5437. // the line, so the fixed buffer may hold nothing and carry no terminator
  5438. // yet. assign() takes an explicit length and does not need one.
  5439. if (growable_buffer_.empty()) {
  5440. growable_buffer_.assign(fixed_buffer_, fixed_buffer_used_size_);
  5441. }
  5442. growable_buffer_.append(data, size);
  5443. }
  5444. }
  5445. inline mmap::mmap(const char *path) { open(path); }
  5446. inline mmap::~mmap() { close(); }
  5447. inline bool mmap::open(const char *path) {
  5448. close();
  5449. #if defined(_WIN32)
  5450. auto wpath = u8string_to_wstring(path);
  5451. if (wpath.empty()) { return false; }
  5452. hFile_ =
  5453. ::CreateFile2(wpath.c_str(), GENERIC_READ,
  5454. FILE_SHARE_READ | FILE_SHARE_WRITE, OPEN_EXISTING, NULL);
  5455. if (hFile_ == INVALID_HANDLE_VALUE) { return false; }
  5456. LARGE_INTEGER size{};
  5457. if (!::GetFileSizeEx(hFile_, &size)) { return false; }
  5458. // If the following line doesn't compile due to QuadPart, update Windows SDK.
  5459. // See:
  5460. // https://github.com/yhirose/cpp-httplib/issues/1903#issuecomment-2316520721
  5461. if (!fits_in_size_t(static_cast<uint64_t>(size.QuadPart))) { return false; }
  5462. size_ = static_cast<size_t>(size.QuadPart);
  5463. hMapping_ =
  5464. ::CreateFileMappingFromApp(hFile_, NULL, PAGE_READONLY, size_, NULL);
  5465. // Special treatment for an empty file...
  5466. if (hMapping_ == NULL && size_ == 0) {
  5467. close();
  5468. is_open_empty_file = true;
  5469. return true;
  5470. }
  5471. if (hMapping_ == NULL) {
  5472. close();
  5473. return false;
  5474. }
  5475. addr_ = ::MapViewOfFileFromApp(hMapping_, FILE_MAP_READ, 0, 0);
  5476. if (addr_ == nullptr) {
  5477. close();
  5478. return false;
  5479. }
  5480. #else
  5481. // O_NONBLOCK so that opening a FIFO does not wait for a writer.
  5482. fd_ = ::open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC);
  5483. if (fd_ == -1) { return false; }
  5484. // Only a regular file has a size to serve, unlike a directory or a device.
  5485. struct stat sb;
  5486. if (fstat(fd_, &sb) == -1 || !S_ISREG(sb.st_mode) ||
  5487. !fits_in_size_t(static_cast<uint64_t>(sb.st_size))) {
  5488. close();
  5489. return false;
  5490. }
  5491. size_ = static_cast<size_t>(sb.st_size);
  5492. #endif
  5493. return true;
  5494. }
  5495. inline bool mmap::is_open() const {
  5496. #if defined(_WIN32)
  5497. return is_open_empty_file ? true : addr_ != nullptr;
  5498. #else
  5499. return fd_ != -1;
  5500. #endif
  5501. }
  5502. inline size_t mmap::size() const { return size_; }
  5503. inline void mmap::close() {
  5504. #if defined(_WIN32)
  5505. if (addr_) {
  5506. ::UnmapViewOfFile(addr_);
  5507. addr_ = nullptr;
  5508. }
  5509. if (hMapping_) {
  5510. ::CloseHandle(hMapping_);
  5511. hMapping_ = NULL;
  5512. }
  5513. if (hFile_ != INVALID_HANDLE_VALUE) {
  5514. ::CloseHandle(hFile_);
  5515. hFile_ = INVALID_HANDLE_VALUE;
  5516. }
  5517. is_open_empty_file = false;
  5518. #else
  5519. if (fd_ != -1) {
  5520. ::close(fd_);
  5521. fd_ = -1;
  5522. }
  5523. #endif
  5524. size_ = 0;
  5525. }
  5526. inline int close_socket(socket_t sock) noexcept {
  5527. #ifdef _WIN32
  5528. return closesocket(sock);
  5529. #else
  5530. return close(sock);
  5531. #endif
  5532. }
  5533. template <typename T> inline ssize_t handle_EINTR(T fn) {
  5534. ssize_t res = 0;
  5535. while (true) {
  5536. res = fn();
  5537. if (res < 0 && errno == EINTR) {
  5538. std::this_thread::sleep_for(std::chrono::microseconds{1});
  5539. continue;
  5540. }
  5541. break;
  5542. }
  5543. return res;
  5544. }
  5545. inline size_t mmap::read(size_t offset, char *buf, size_t len) const {
  5546. if (offset >= size_) { return 0; }
  5547. len = (std::min)(len, size_ - offset);
  5548. #if defined(_WIN32)
  5549. // Windows does not let a mapped file be truncated.
  5550. std::memcpy(buf, static_cast<const char *>(addr_) + offset, len);
  5551. return len;
  5552. #else
  5553. auto n = handle_EINTR(
  5554. [&]() { return ::pread(fd_, buf, len, static_cast<off_t>(offset)); });
  5555. return n > 0 ? static_cast<size_t>(n) : 0;
  5556. #endif
  5557. }
  5558. inline ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags) {
  5559. return handle_EINTR([&]() {
  5560. return recv(sock,
  5561. #ifdef _WIN32
  5562. static_cast<char *>(ptr), static_cast<int>(size),
  5563. #else
  5564. ptr, size,
  5565. #endif
  5566. flags);
  5567. });
  5568. }
  5569. inline ssize_t send_socket(socket_t sock, const void *ptr, size_t size,
  5570. int flags) {
  5571. return handle_EINTR([&]() {
  5572. return send(sock,
  5573. #ifdef _WIN32
  5574. static_cast<const char *>(ptr), static_cast<int>(size),
  5575. #else
  5576. ptr, size,
  5577. #endif
  5578. flags);
  5579. });
  5580. }
  5581. inline int poll_wrapper(struct pollfd *fds, nfds_t nfds, int timeout) {
  5582. #ifdef _WIN32
  5583. return ::WSAPoll(fds, nfds, timeout);
  5584. #else
  5585. return ::poll(fds, nfds, timeout);
  5586. #endif
  5587. }
  5588. inline ssize_t select_impl(socket_t sock, short events, time_t sec,
  5589. time_t usec) {
  5590. struct pollfd pfd;
  5591. pfd.fd = sock;
  5592. pfd.events = events;
  5593. pfd.revents = 0;
  5594. // A negative timeout waits forever, poll's own convention. 0 keeps meaning
  5595. // "return immediately", which callers here rely on to probe a socket.
  5596. auto timeout = sec < 0 ? -1 : static_cast<int>(sec * 1000 + usec / 1000);
  5597. return handle_EINTR([&]() { return poll_wrapper(&pfd, 1, timeout); });
  5598. }
  5599. inline ssize_t select_read(socket_t sock, time_t sec, time_t usec) {
  5600. return select_impl(sock, POLLIN, sec, usec);
  5601. }
  5602. inline ssize_t select_write(socket_t sock, time_t sec, time_t usec) {
  5603. return select_impl(sock, POLLOUT, sec, usec);
  5604. }
  5605. // The point sec and usec from now, for select_until(). A negative sec never
  5606. // comes, as a negative timeout waits forever in select_impl().
  5607. inline std::chrono::steady_clock::time_point deadline_after(time_t sec,
  5608. time_t usec) {
  5609. if (sec < 0) { return (std::chrono::steady_clock::time_point::max)(); }
  5610. return std::chrono::steady_clock::now() + std::chrono::seconds(sec) +
  5611. std::chrono::microseconds(usec);
  5612. }
  5613. // Waits only for the time left until deadline, so that all the waits of one
  5614. // TLS handshake come out of a single timeout.
  5615. inline ssize_t select_until(socket_t sock, short events,
  5616. std::chrono::steady_clock::time_point deadline) {
  5617. if (deadline == (std::chrono::steady_clock::time_point::max)()) {
  5618. return select_impl(sock, events, -1, 0);
  5619. }
  5620. auto left = std::chrono::duration_cast<std::chrono::microseconds>(
  5621. deadline - std::chrono::steady_clock::now())
  5622. .count();
  5623. if (left <= 0) { return 0; }
  5624. return select_impl(sock, events, static_cast<time_t>(left / 1000000),
  5625. static_cast<time_t>(left % 1000000));
  5626. }
  5627. // select_read(), but waits in slices and gives up once interrupted() returns
  5628. // true. A local shutdown() would not wake the wait on Windows.
  5629. inline ssize_t
  5630. select_read_interruptible(socket_t sock, time_t sec, time_t usec,
  5631. const std::function<bool()> &interrupted) {
  5632. if (!interrupted) { return select_read(sock, sec, usec); }
  5633. const auto slice = std::chrono::microseconds(100000);
  5634. auto deadline = deadline_after(sec, usec);
  5635. while (!interrupted()) {
  5636. auto left = std::chrono::duration_cast<std::chrono::microseconds>(
  5637. deadline - std::chrono::steady_clock::now());
  5638. auto wait =
  5639. (std::max)((std::min)(left, slice), std::chrono::microseconds(0));
  5640. auto ret = select_impl(sock, POLLIN, 0, static_cast<time_t>(wait.count()));
  5641. if (ret != 0 || wait < slice) { return ret; }
  5642. }
  5643. return 0;
  5644. }
  5645. inline Error wait_until_socket_is_ready(socket_t sock, time_t sec,
  5646. time_t usec) {
  5647. struct pollfd pfd_read;
  5648. pfd_read.fd = sock;
  5649. pfd_read.events = POLLIN | POLLOUT;
  5650. pfd_read.revents = 0;
  5651. auto timeout = static_cast<int>(sec * 1000 + usec / 1000);
  5652. auto poll_res =
  5653. handle_EINTR([&]() { return poll_wrapper(&pfd_read, 1, timeout); });
  5654. if (poll_res == 0) { return Error::ConnectionTimeout; }
  5655. if (poll_res > 0 && pfd_read.revents & (POLLIN | POLLOUT)) {
  5656. auto error = 0;
  5657. socklen_t len = sizeof(error);
  5658. auto res = getsockopt(sock, SOL_SOCKET, SO_ERROR,
  5659. reinterpret_cast<char *>(&error), &len);
  5660. auto successful = res >= 0 && !error;
  5661. return successful ? Error::Success : Error::Connection;
  5662. }
  5663. return Error::Connection;
  5664. }
  5665. inline bool is_socket_alive(socket_t sock) {
  5666. const auto val = detail::select_read(sock, 0, 0);
  5667. if (val == 0) {
  5668. return true;
  5669. } else if (val < 0 && errno == EBADF) {
  5670. return false;
  5671. }
  5672. char buf[1];
  5673. return detail::read_socket(sock, &buf[0], sizeof(buf), MSG_PEEK) > 0;
  5674. }
  5675. class SocketStream final : public Stream {
  5676. public:
  5677. SocketStream(socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5678. time_t write_timeout_sec, time_t write_timeout_usec,
  5679. time_t max_timeout_msec = 0,
  5680. std::chrono::time_point<std::chrono::steady_clock> start_time =
  5681. (std::chrono::steady_clock::time_point::min)());
  5682. ~SocketStream() override;
  5683. bool is_readable() const override;
  5684. bool wait_readable() const override;
  5685. bool wait_writable() const override;
  5686. bool is_peer_alive() const override;
  5687. ssize_t read(char *ptr, size_t size) override;
  5688. ssize_t write(const char *ptr, size_t size) override;
  5689. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  5690. void get_local_ip_and_port(std::string &ip, int &port) const override;
  5691. socket_t socket() const override;
  5692. time_t duration() const override;
  5693. void set_read_timeout(time_t sec, time_t usec = 0) override;
  5694. void set_max_timeout(time_t msec) override;
  5695. void set_read_interrupt(std::function<bool()> interrupted) override;
  5696. const char *buffered_data(size_t &size) const override;
  5697. void consume_buffered(size_t size) override;
  5698. // The caller has just seen this socket become readable. Lets the next read
  5699. // skip its own readiness wait, which would otherwise ask the kernel a
  5700. // question that was answered a moment ago. Consumed by that read.
  5701. void set_readable_hint() { readable_hint_ = true; }
  5702. private:
  5703. bool ensure_readable();
  5704. socket_t sock_;
  5705. // Atomic because ws::WebSocket::set_read_timeout() reaches this from another
  5706. // thread while a read is in flight -- that is the point of it, for a caller
  5707. // holding one connection and wanting control back to send on it.
  5708. std::atomic<time_t> read_timeout_sec_;
  5709. std::atomic<time_t> read_timeout_usec_;
  5710. time_t write_timeout_sec_;
  5711. time_t write_timeout_usec_;
  5712. time_t max_timeout_msec_;
  5713. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  5714. std::function<bool()> read_interrupted_;
  5715. std::vector<char> read_buff_;
  5716. size_t read_buff_off_ = 0;
  5717. size_t read_buff_content_size_ = 0;
  5718. bool readable_hint_ = false;
  5719. static const size_t read_buff_size_ = 1024l * 4;
  5720. };
  5721. inline bool keep_alive(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5722. time_t keep_alive_timeout_sec) {
  5723. using namespace std::chrono;
  5724. const auto interval_usec =
  5725. CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND;
  5726. // Avoid expensive `steady_clock::now()` call for the first time
  5727. if (select_read(sock, 0, interval_usec) > 0) { return true; }
  5728. const auto start = steady_clock::now() - microseconds{interval_usec};
  5729. const auto timeout = seconds{keep_alive_timeout_sec};
  5730. while (true) {
  5731. if (svr_sock == INVALID_SOCKET) {
  5732. break; // Server socket is closed
  5733. }
  5734. auto val = select_read(sock, 0, interval_usec);
  5735. if (val < 0) {
  5736. break; // Ssocket error
  5737. } else if (val == 0) {
  5738. if (steady_clock::now() - start > timeout) {
  5739. break; // Timeout
  5740. }
  5741. } else {
  5742. return true; // Ready for read
  5743. }
  5744. }
  5745. return false;
  5746. }
  5747. // `has_buffered_request` reports whether the connection's stream already holds
  5748. // bytes of the next request. A client may pipeline its requests (RFC 9112
  5749. // 9.3.2), so reading one request can pull the start of the next one into the
  5750. // stream's buffer; that request must be served without waiting for the socket
  5751. // to become readable again, since its bytes are no longer on the socket.
  5752. // `callback` is told whether keep_alive() has just seen the socket go readable.
  5753. template <typename P, typename T>
  5754. inline bool process_server_socket_core(const std::atomic<socket_t> &svr_sock,
  5755. socket_t sock,
  5756. size_t keep_alive_max_count,
  5757. time_t keep_alive_timeout_sec,
  5758. P has_buffered_request, T callback) {
  5759. auto ret = false;
  5760. // A keep_alive_max_count of 0 sets no limit.
  5761. for (size_t served = 0;
  5762. keep_alive_max_count == 0 || served < keep_alive_max_count; served++) {
  5763. auto socket_readable = false;
  5764. if (!has_buffered_request()) {
  5765. if (!keep_alive(svr_sock, sock, keep_alive_timeout_sec)) { break; }
  5766. socket_readable = true;
  5767. }
  5768. auto close_connection = served + 1 == keep_alive_max_count;
  5769. auto connection_closed = false;
  5770. ret = callback(socket_readable, close_connection, connection_closed);
  5771. if (!ret || connection_closed) { break; }
  5772. }
  5773. return ret;
  5774. }
  5775. template <typename T>
  5776. inline bool
  5777. process_server_socket(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5778. size_t keep_alive_max_count,
  5779. time_t keep_alive_timeout_sec, time_t read_timeout_sec,
  5780. time_t read_timeout_usec, time_t write_timeout_sec,
  5781. time_t write_timeout_usec, T callback) {
  5782. // One stream per connection: its read buffer can already hold the start of
  5783. // the next, pipelined request.
  5784. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5785. write_timeout_sec, write_timeout_usec);
  5786. return process_server_socket_core(
  5787. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  5788. [&]() { return strm.is_readable(); },
  5789. [&](bool socket_readable, bool close_connection,
  5790. bool &connection_closed) {
  5791. if (socket_readable) { strm.set_readable_hint(); }
  5792. return callback(strm, close_connection, connection_closed);
  5793. });
  5794. }
  5795. inline bool process_client_socket(
  5796. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5797. time_t write_timeout_sec, time_t write_timeout_usec,
  5798. time_t max_timeout_msec,
  5799. std::chrono::time_point<std::chrono::steady_clock> start_time,
  5800. std::function<bool(Stream &)> callback) {
  5801. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5802. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  5803. start_time);
  5804. return callback(strm);
  5805. }
  5806. inline int shutdown_socket(socket_t sock) noexcept {
  5807. #ifdef _WIN32
  5808. return shutdown(sock, SD_BOTH);
  5809. #else
  5810. return shutdown(sock, SHUT_RDWR);
  5811. #endif
  5812. }
  5813. // Half-closes the write side and drains any in-flight/queued bytes before
  5814. // the final shutdown+close. Closing with unread data in the receive queue
  5815. // (or bytes arriving after the receive side is closed) makes the stack send
  5816. // an abortive RST instead of a graceful FIN, which can make the peer see the
  5817. // response as a failed read even though it was fully written.
  5818. inline void drain_and_close_socket(socket_t sock) noexcept {
  5819. #ifdef _WIN32
  5820. shutdown(sock, SD_SEND);
  5821. #else
  5822. shutdown(sock, SHUT_WR);
  5823. #endif
  5824. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  5825. size_t total = 0;
  5826. const auto deadline = std::chrono::steady_clock::now() +
  5827. std::chrono::milliseconds(100); // bound #1
  5828. while (total < size_t(1024u * 1024u)) { // bound #2
  5829. const auto remaining =
  5830. std::chrono::duration_cast<std::chrono::microseconds>(
  5831. deadline - std::chrono::steady_clock::now())
  5832. .count();
  5833. if (remaining <= 0) { break; }
  5834. if (select_read(sock, 0, static_cast<time_t>(remaining)) <= 0) { break; }
  5835. const auto n = read_socket(sock, buf, sizeof(buf), CPPHTTPLIB_RECV_FLAGS);
  5836. if (n <= 0) { break; }
  5837. total += static_cast<size_t>(n);
  5838. }
  5839. shutdown_socket(sock);
  5840. close_socket(sock);
  5841. }
  5842. inline std::string escape_abstract_namespace_unix_domain(const std::string &s) {
  5843. if (s.size() > 1 && s[0] == '\0') {
  5844. auto ret = s;
  5845. ret[0] = '@';
  5846. return ret;
  5847. }
  5848. return s;
  5849. }
  5850. inline std::string
  5851. unescape_abstract_namespace_unix_domain(const std::string &s) {
  5852. if (s.size() > 1 && s[0] == '@') {
  5853. auto ret = s;
  5854. ret[0] = '\0';
  5855. return ret;
  5856. }
  5857. return s;
  5858. }
  5859. inline int getaddrinfo_with_timeout(const char *node, const char *service,
  5860. const struct addrinfo *hints,
  5861. struct addrinfo **res, time_t timeout_sec) {
  5862. #ifdef CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO
  5863. if (timeout_sec <= 0) {
  5864. // No timeout specified, use standard getaddrinfo
  5865. return getaddrinfo(node, service, hints, res);
  5866. }
  5867. #ifdef _WIN32
  5868. // Windows-specific implementation using GetAddrInfoEx with overlapped I/O
  5869. OVERLAPPED overlapped = {};
  5870. HANDLE event = CreateEventW(nullptr, TRUE, FALSE, nullptr);
  5871. if (!event) { return EAI_FAIL; }
  5872. overlapped.hEvent = event;
  5873. PADDRINFOEXW result_addrinfo = nullptr;
  5874. HANDLE cancel_handle = nullptr;
  5875. ADDRINFOEXW hints_ex = {};
  5876. if (hints) {
  5877. hints_ex.ai_flags = hints->ai_flags;
  5878. hints_ex.ai_family = hints->ai_family;
  5879. hints_ex.ai_socktype = hints->ai_socktype;
  5880. hints_ex.ai_protocol = hints->ai_protocol;
  5881. }
  5882. auto wnode = u8string_to_wstring(node);
  5883. auto wservice = u8string_to_wstring(service);
  5884. auto ret = ::GetAddrInfoExW(wnode.data(), wservice.data(), NS_DNS, nullptr,
  5885. hints ? &hints_ex : nullptr, &result_addrinfo,
  5886. nullptr, &overlapped, nullptr, &cancel_handle);
  5887. if (ret == WSA_IO_PENDING) {
  5888. auto wait_result =
  5889. ::WaitForSingleObject(event, static_cast<DWORD>(timeout_sec * 1000));
  5890. if (wait_result == WAIT_TIMEOUT) {
  5891. if (cancel_handle) { ::GetAddrInfoExCancel(&cancel_handle); }
  5892. ::CloseHandle(event);
  5893. return EAI_AGAIN;
  5894. }
  5895. DWORD bytes_returned;
  5896. if (!::GetOverlappedResult((HANDLE)INVALID_SOCKET, &overlapped,
  5897. &bytes_returned, FALSE)) {
  5898. ::CloseHandle(event);
  5899. return ::WSAGetLastError();
  5900. }
  5901. }
  5902. ::CloseHandle(event);
  5903. if (ret == NO_ERROR || ret == WSA_IO_PENDING) {
  5904. *res = reinterpret_cast<struct addrinfo *>(result_addrinfo);
  5905. return 0;
  5906. }
  5907. return ret;
  5908. #elif TARGET_OS_MAC && defined(__clang__)
  5909. if (!node) { return EAI_NONAME; }
  5910. // macOS implementation using CFHost API for asynchronous DNS resolution
  5911. CFStringRef hostname_ref = CFStringCreateWithCString(
  5912. kCFAllocatorDefault, node, kCFStringEncodingUTF8);
  5913. if (!hostname_ref) { return EAI_MEMORY; }
  5914. CFHostRef host_ref = CFHostCreateWithName(kCFAllocatorDefault, hostname_ref);
  5915. CFRelease(hostname_ref);
  5916. if (!host_ref) { return EAI_MEMORY; }
  5917. // Set up context for callback
  5918. struct CFHostContext {
  5919. bool completed = false;
  5920. bool success = false;
  5921. CFArrayRef addresses = nullptr;
  5922. std::mutex mutex;
  5923. std::condition_variable cv;
  5924. } context;
  5925. CFHostClientContext client_context;
  5926. memset(&client_context, 0, sizeof(client_context));
  5927. client_context.info = &context;
  5928. // Set callback
  5929. auto callback = [](CFHostRef theHost, CFHostInfoType /*typeInfo*/,
  5930. const CFStreamError *error, void *info) {
  5931. auto ctx = static_cast<CFHostContext *>(info);
  5932. std::lock_guard<std::mutex> lock(ctx->mutex);
  5933. if (error && error->error != 0) {
  5934. ctx->success = false;
  5935. } else {
  5936. Boolean hasBeenResolved;
  5937. ctx->addresses = CFHostGetAddressing(theHost, &hasBeenResolved);
  5938. if (ctx->addresses && hasBeenResolved) {
  5939. CFRetain(ctx->addresses);
  5940. ctx->success = true;
  5941. } else {
  5942. ctx->success = false;
  5943. }
  5944. }
  5945. ctx->completed = true;
  5946. ctx->cv.notify_one();
  5947. };
  5948. if (!CFHostSetClient(host_ref, callback, &client_context)) {
  5949. CFRelease(host_ref);
  5950. return EAI_SYSTEM;
  5951. }
  5952. // Schedule on run loop
  5953. CFRunLoopRef run_loop = CFRunLoopGetCurrent();
  5954. CFHostScheduleWithRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5955. // Start resolution
  5956. CFStreamError stream_error;
  5957. if (!CFHostStartInfoResolution(host_ref, kCFHostAddresses, &stream_error)) {
  5958. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5959. CFRelease(host_ref);
  5960. return EAI_FAIL;
  5961. }
  5962. // Wait for completion with timeout
  5963. auto timeout_time =
  5964. std::chrono::steady_clock::now() + std::chrono::seconds(timeout_sec);
  5965. bool timed_out = false;
  5966. {
  5967. std::unique_lock<std::mutex> lock(context.mutex);
  5968. while (!context.completed) {
  5969. auto now = std::chrono::steady_clock::now();
  5970. if (now >= timeout_time) {
  5971. timed_out = true;
  5972. break;
  5973. }
  5974. // Run the runloop for a short time
  5975. lock.unlock();
  5976. CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.1, true);
  5977. lock.lock();
  5978. }
  5979. }
  5980. // Clean up
  5981. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5982. CFHostSetClient(host_ref, nullptr, nullptr);
  5983. if (timed_out || !context.completed) {
  5984. CFHostCancelInfoResolution(host_ref, kCFHostAddresses);
  5985. CFRelease(host_ref);
  5986. return EAI_AGAIN;
  5987. }
  5988. if (!context.success || !context.addresses) {
  5989. CFRelease(host_ref);
  5990. return EAI_NODATA;
  5991. }
  5992. // Convert CFArray to addrinfo
  5993. CFIndex count = CFArrayGetCount(context.addresses);
  5994. if (count == 0) {
  5995. CFRelease(context.addresses);
  5996. CFRelease(host_ref);
  5997. return EAI_NODATA;
  5998. }
  5999. struct addrinfo *result_addrinfo = nullptr;
  6000. struct addrinfo **current = &result_addrinfo;
  6001. for (CFIndex i = 0; i < count; i++) {
  6002. CFDataRef addr_data =
  6003. static_cast<CFDataRef>(CFArrayGetValueAtIndex(context.addresses, i));
  6004. if (!addr_data) continue;
  6005. const struct sockaddr *sockaddr_ptr =
  6006. reinterpret_cast<const struct sockaddr *>(CFDataGetBytePtr(addr_data));
  6007. socklen_t sockaddr_len = static_cast<socklen_t>(CFDataGetLength(addr_data));
  6008. // Allocate addrinfo structure
  6009. *current = static_cast<struct addrinfo *>(malloc(sizeof(struct addrinfo)));
  6010. if (!*current) {
  6011. freeaddrinfo(result_addrinfo);
  6012. CFRelease(context.addresses);
  6013. CFRelease(host_ref);
  6014. return EAI_MEMORY;
  6015. }
  6016. memset(*current, 0, sizeof(struct addrinfo));
  6017. // Set up addrinfo fields
  6018. (*current)->ai_family = sockaddr_ptr->sa_family;
  6019. (*current)->ai_socktype = hints ? hints->ai_socktype : SOCK_STREAM;
  6020. (*current)->ai_protocol = hints ? hints->ai_protocol : IPPROTO_TCP;
  6021. (*current)->ai_addrlen = sockaddr_len;
  6022. // Copy sockaddr
  6023. (*current)->ai_addr = static_cast<struct sockaddr *>(malloc(sockaddr_len));
  6024. if (!(*current)->ai_addr) {
  6025. freeaddrinfo(result_addrinfo);
  6026. CFRelease(context.addresses);
  6027. CFRelease(host_ref);
  6028. return EAI_MEMORY;
  6029. }
  6030. memcpy((*current)->ai_addr, sockaddr_ptr, sockaddr_len);
  6031. // Set port if service is specified
  6032. if (service && *service) {
  6033. int port = 0;
  6034. if (parse_port(service, strlen(service), port)) {
  6035. if (sockaddr_ptr->sa_family == AF_INET) {
  6036. reinterpret_cast<struct sockaddr_in *>((*current)->ai_addr)
  6037. ->sin_port = htons(static_cast<uint16_t>(port));
  6038. } else if (sockaddr_ptr->sa_family == AF_INET6) {
  6039. reinterpret_cast<struct sockaddr_in6 *>((*current)->ai_addr)
  6040. ->sin6_port = htons(static_cast<uint16_t>(port));
  6041. }
  6042. }
  6043. }
  6044. current = &((*current)->ai_next);
  6045. }
  6046. CFRelease(context.addresses);
  6047. CFRelease(host_ref);
  6048. *res = result_addrinfo;
  6049. return 0;
  6050. #elif defined(_GNU_SOURCE) && defined(__GLIBC__) && \
  6051. (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 2)) && \
  6052. !defined(CPPHTTPLIB_THREAD_SANITIZER)
  6053. // Skipped under TSan: glibc's internal resolver thread is invisible to it.
  6054. // #2431: gai_cancel() is non-blocking and may return EAI_NOTCANCELED while
  6055. // the resolver worker still references the stack-local gaicb. The cancel
  6056. // path therefore waits (gai_suspend with no timeout) for the worker to
  6057. // actually finish before letting the stack frame go. The trade-off is that
  6058. // a wedged DNS server can hold this thread for the system resolver timeout
  6059. // (~30s by default) past the caller's connection timeout.
  6060. struct gaicb request{};
  6061. struct gaicb *requests[1] = {&request};
  6062. struct sigevent sevp{};
  6063. struct timespec timeout{timeout_sec, 0};
  6064. request.ar_name = node;
  6065. request.ar_service = service;
  6066. request.ar_request = hints;
  6067. sevp.sigev_notify = SIGEV_NONE;
  6068. int rc = getaddrinfo_a(GAI_NOWAIT, requests, 1, &sevp);
  6069. if (rc != 0) { return rc; }
  6070. auto cleanup = scope_exit([&] {
  6071. if (request.ar_result) { freeaddrinfo(request.ar_result); }
  6072. });
  6073. int wait_result = gai_suspend(requests, 1, &timeout);
  6074. if (wait_result == 0 || wait_result == EAI_ALLDONE) {
  6075. int gai_result = gai_error(&request);
  6076. if (gai_result == 0) {
  6077. *res = request.ar_result;
  6078. request.ar_result = nullptr;
  6079. return 0;
  6080. }
  6081. return gai_result;
  6082. }
  6083. gai_cancel(&request);
  6084. while (gai_error(&request) == EAI_INPROGRESS) {
  6085. gai_suspend(requests, 1, nullptr);
  6086. }
  6087. return wait_result;
  6088. #else
  6089. // Fallback implementation using thread-based timeout for other Unix systems.
  6090. struct GetAddrInfoState {
  6091. ~GetAddrInfoState() {
  6092. if (info) { freeaddrinfo(info); }
  6093. }
  6094. std::mutex mutex;
  6095. std::condition_variable result_cv;
  6096. bool completed = false;
  6097. int result = EAI_SYSTEM;
  6098. std::string node;
  6099. std::string service;
  6100. struct addrinfo hints;
  6101. struct addrinfo *info = nullptr;
  6102. };
  6103. // Allocate on the heap, so the resolver thread can keep using the data.
  6104. auto state = std::make_shared<GetAddrInfoState>();
  6105. if (node) { state->node = node; }
  6106. state->service = service;
  6107. state->hints = *hints;
  6108. std::thread resolve_thread([state]() {
  6109. auto thread_result =
  6110. getaddrinfo(state->node.c_str(), state->service.c_str(), &state->hints,
  6111. &state->info);
  6112. std::lock_guard<std::mutex> lock(state->mutex);
  6113. state->result = thread_result;
  6114. state->completed = true;
  6115. state->result_cv.notify_one();
  6116. });
  6117. // Wait for completion or timeout
  6118. std::unique_lock<std::mutex> lock(state->mutex);
  6119. auto finished =
  6120. state->result_cv.wait_for(lock, std::chrono::seconds(timeout_sec),
  6121. [&] { return state->completed; });
  6122. if (finished) {
  6123. // Operation completed within timeout
  6124. resolve_thread.join();
  6125. *res = state->info;
  6126. state->info = nullptr; // Pass ownership to caller
  6127. return state->result;
  6128. } else {
  6129. // Timeout occurred
  6130. resolve_thread.detach(); // Let the thread finish in background
  6131. return EAI_AGAIN; // Return timeout error
  6132. }
  6133. #endif
  6134. #else
  6135. (void)(timeout_sec); // Unused parameter for non-blocking getaddrinfo
  6136. return getaddrinfo(node, service, hints, res);
  6137. #endif
  6138. }
  6139. template <typename BindOrConnect>
  6140. socket_t create_socket(const std::string &host, const std::string &ip, int port,
  6141. int address_family, int socket_flags, bool tcp_nodelay,
  6142. bool ipv6_v6only, SocketOptions socket_options,
  6143. BindOrConnect bind_or_connect, time_t timeout_sec = 0) {
  6144. // Get address info
  6145. const char *node = nullptr;
  6146. struct addrinfo hints;
  6147. struct addrinfo *result;
  6148. memset(&hints, 0, sizeof(struct addrinfo));
  6149. hints.ai_socktype = SOCK_STREAM;
  6150. hints.ai_protocol = IPPROTO_IP;
  6151. if (!ip.empty()) {
  6152. node = ip.c_str();
  6153. // Ask getaddrinfo to convert IP in c-string to address
  6154. hints.ai_family = AF_UNSPEC;
  6155. hints.ai_flags = AI_NUMERICHOST;
  6156. } else {
  6157. if (!host.empty()) { node = host.c_str(); }
  6158. hints.ai_family = address_family;
  6159. hints.ai_flags = socket_flags;
  6160. }
  6161. #if !defined(_WIN32) || defined(CPPHTTPLIB_HAVE_AFUNIX_H)
  6162. if (hints.ai_family == AF_UNIX) {
  6163. const auto addrlen = host.length();
  6164. if (addrlen > sizeof(sockaddr_un::sun_path)) { return INVALID_SOCKET; }
  6165. #ifdef SOCK_CLOEXEC
  6166. auto sock = socket(hints.ai_family, hints.ai_socktype | SOCK_CLOEXEC,
  6167. hints.ai_protocol);
  6168. #else
  6169. auto sock = socket(hints.ai_family, hints.ai_socktype, hints.ai_protocol);
  6170. #endif
  6171. if (sock != INVALID_SOCKET) {
  6172. sockaddr_un addr{};
  6173. addr.sun_family = AF_UNIX;
  6174. auto unescaped_host = unescape_abstract_namespace_unix_domain(host);
  6175. std::copy(unescaped_host.begin(), unescaped_host.end(), addr.sun_path);
  6176. hints.ai_addr = reinterpret_cast<sockaddr *>(&addr);
  6177. hints.ai_addrlen = static_cast<socklen_t>(
  6178. sizeof(addr) - sizeof(addr.sun_path) + addrlen);
  6179. #ifndef SOCK_CLOEXEC
  6180. #ifndef _WIN32
  6181. fcntl(sock, F_SETFD, FD_CLOEXEC);
  6182. #endif
  6183. #endif
  6184. if (socket_options) { socket_options(sock); }
  6185. #ifdef _WIN32
  6186. // Setting SO_REUSEADDR seems not to work well with AF_UNIX on windows, so
  6187. // remove the option.
  6188. set_socket_opt(sock, SOL_SOCKET, SO_REUSEADDR, 0);
  6189. #endif
  6190. bool dummy;
  6191. if (!bind_or_connect(sock, hints, dummy)) {
  6192. close_socket(sock);
  6193. sock = INVALID_SOCKET;
  6194. }
  6195. }
  6196. return sock;
  6197. }
  6198. #endif
  6199. auto service = std::to_string(port);
  6200. if (getaddrinfo_with_timeout(node, service.c_str(), &hints, &result,
  6201. timeout_sec)) {
  6202. #if defined __linux__ && !defined __ANDROID__
  6203. res_init();
  6204. #endif
  6205. return INVALID_SOCKET;
  6206. }
  6207. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6208. for (auto rp = result; rp; rp = rp->ai_next) {
  6209. // Create a socket
  6210. #ifdef _WIN32
  6211. auto sock =
  6212. WSASocketW(rp->ai_family, rp->ai_socktype, rp->ai_protocol, nullptr, 0,
  6213. WSA_FLAG_NO_HANDLE_INHERIT | WSA_FLAG_OVERLAPPED);
  6214. /**
  6215. * Since the WSA_FLAG_NO_HANDLE_INHERIT is only supported on Windows 7 SP1
  6216. * and above the socket creation fails on older Windows Systems.
  6217. *
  6218. * Let's try to create a socket the old way in this case.
  6219. *
  6220. * Reference:
  6221. * https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketa
  6222. *
  6223. * WSA_FLAG_NO_HANDLE_INHERIT:
  6224. * This flag is supported on Windows 7 with SP1, Windows Server 2008 R2 with
  6225. * SP1, and later
  6226. *
  6227. */
  6228. if (sock == INVALID_SOCKET) {
  6229. sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6230. }
  6231. #else
  6232. #ifdef SOCK_CLOEXEC
  6233. auto sock =
  6234. socket(rp->ai_family, rp->ai_socktype | SOCK_CLOEXEC, rp->ai_protocol);
  6235. #else
  6236. auto sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6237. #endif
  6238. #endif
  6239. if (sock == INVALID_SOCKET) { continue; }
  6240. #if !defined _WIN32 && !defined SOCK_CLOEXEC
  6241. if (fcntl(sock, F_SETFD, FD_CLOEXEC) == -1) {
  6242. close_socket(sock);
  6243. continue;
  6244. }
  6245. #endif
  6246. if (tcp_nodelay) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  6247. if (rp->ai_family == AF_INET6) {
  6248. set_socket_opt(sock, IPPROTO_IPV6, IPV6_V6ONLY, ipv6_v6only ? 1 : 0);
  6249. }
  6250. if (socket_options) { socket_options(sock); }
  6251. // bind or connect
  6252. auto quit = false;
  6253. if (bind_or_connect(sock, *rp, quit)) { return sock; }
  6254. close_socket(sock);
  6255. if (quit) { break; }
  6256. }
  6257. return INVALID_SOCKET;
  6258. }
  6259. inline void set_nonblocking(socket_t sock, bool nonblocking) {
  6260. #ifdef _WIN32
  6261. auto flags = nonblocking ? 1UL : 0UL;
  6262. ioctlsocket(sock, FIONBIO, &flags);
  6263. #else
  6264. auto flags = fcntl(sock, F_GETFL, 0);
  6265. fcntl(sock, F_SETFL,
  6266. nonblocking ? (flags | O_NONBLOCK) : (flags & (~O_NONBLOCK)));
  6267. #endif
  6268. }
  6269. inline bool is_connection_error() {
  6270. #ifdef _WIN32
  6271. return WSAGetLastError() != WSAEWOULDBLOCK;
  6272. #else
  6273. return errno != EINPROGRESS;
  6274. #endif
  6275. }
  6276. // accept() failed because the process or the network stack is temporarily out
  6277. // of resources. The listening socket is still usable, so back off briefly and
  6278. // try again.
  6279. inline bool is_accept_resource_error() {
  6280. #ifdef _WIN32
  6281. auto err = WSAGetLastError();
  6282. return err == WSAEMFILE || err == WSAENOBUFS;
  6283. #else
  6284. auto err = errno;
  6285. return err == EMFILE || err == ENFILE || err == ENOBUFS || err == ENOMEM;
  6286. #endif
  6287. }
  6288. // accept() failed for a reason that says nothing about the listening socket:
  6289. // the pending connection went away before it could be accepted, or the call
  6290. // was interrupted. Retry immediately. WSAAccept()'s own documentation omits
  6291. // WSAECONNRESET, but the accept() it wraps reports an aborted pending
  6292. // connection that way.
  6293. inline bool is_accept_transient_error() {
  6294. #ifdef _WIN32
  6295. auto err = WSAGetLastError();
  6296. return err == WSAEINTR || err == WSAEWOULDBLOCK || err == WSAECONNRESET ||
  6297. err == WSAECONNABORTED;
  6298. #else
  6299. auto err = errno;
  6300. return err == EINTR || err == EAGAIN || err == EWOULDBLOCK ||
  6301. err == ECONNABORTED;
  6302. #endif
  6303. }
  6304. inline bool bind_ip_address(socket_t sock, const std::string &host) {
  6305. struct addrinfo hints;
  6306. struct addrinfo *result;
  6307. memset(&hints, 0, sizeof(struct addrinfo));
  6308. hints.ai_family = AF_UNSPEC;
  6309. hints.ai_socktype = SOCK_STREAM;
  6310. hints.ai_protocol = 0;
  6311. if (getaddrinfo_with_timeout(host.c_str(), "0", &hints, &result, 0)) {
  6312. return false;
  6313. }
  6314. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6315. auto ret = false;
  6316. for (auto rp = result; rp; rp = rp->ai_next) {
  6317. const auto &ai = *rp;
  6318. if (!::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  6319. ret = true;
  6320. break;
  6321. }
  6322. }
  6323. return ret;
  6324. }
  6325. #if !defined _WIN32 && !defined ANDROID && !defined _AIX && !defined __MVS__
  6326. #define USE_IF2IP
  6327. #endif
  6328. #ifdef USE_IF2IP
  6329. inline std::string if2ip(int address_family, const std::string &ifn) {
  6330. struct ifaddrs *ifap;
  6331. getifaddrs(&ifap);
  6332. auto se = detail::scope_exit([&] { freeifaddrs(ifap); });
  6333. std::string addr_candidate;
  6334. for (auto ifa = ifap; ifa; ifa = ifa->ifa_next) {
  6335. if (ifa->ifa_addr && ifn == ifa->ifa_name &&
  6336. (AF_UNSPEC == address_family ||
  6337. ifa->ifa_addr->sa_family == address_family)) {
  6338. if (ifa->ifa_addr->sa_family == AF_INET) {
  6339. auto sa = reinterpret_cast<struct sockaddr_in *>(ifa->ifa_addr);
  6340. char buf[INET_ADDRSTRLEN];
  6341. if (inet_ntop(AF_INET, &sa->sin_addr, buf, INET_ADDRSTRLEN)) {
  6342. return std::string(buf, INET_ADDRSTRLEN);
  6343. }
  6344. } else if (ifa->ifa_addr->sa_family == AF_INET6) {
  6345. auto sa = reinterpret_cast<struct sockaddr_in6 *>(ifa->ifa_addr);
  6346. if (!IN6_IS_ADDR_LINKLOCAL(&sa->sin6_addr)) {
  6347. char buf[INET6_ADDRSTRLEN] = {};
  6348. if (inet_ntop(AF_INET6, &sa->sin6_addr, buf, INET6_ADDRSTRLEN)) {
  6349. // equivalent to mac's IN6_IS_ADDR_UNIQUE_LOCAL
  6350. auto s6_addr_head = sa->sin6_addr.s6_addr[0];
  6351. if (s6_addr_head == 0xfc || s6_addr_head == 0xfd) {
  6352. addr_candidate = std::string(buf, INET6_ADDRSTRLEN);
  6353. } else {
  6354. return std::string(buf, INET6_ADDRSTRLEN);
  6355. }
  6356. }
  6357. }
  6358. }
  6359. }
  6360. }
  6361. return addr_candidate;
  6362. }
  6363. #endif
  6364. inline socket_t create_client_socket(
  6365. const std::string &host, const std::string &ip, int port,
  6366. int address_family, bool tcp_nodelay, bool ipv6_v6only,
  6367. SocketOptions socket_options, time_t connection_timeout_sec,
  6368. time_t connection_timeout_usec, time_t read_timeout_sec,
  6369. time_t read_timeout_usec, time_t write_timeout_sec,
  6370. time_t write_timeout_usec, const std::string &intf, Error &error) {
  6371. auto sock = create_socket(
  6372. host, ip, port, address_family, 0, tcp_nodelay, ipv6_v6only,
  6373. std::move(socket_options),
  6374. [&](socket_t sock2, struct addrinfo &ai, bool &quit) -> bool {
  6375. if (!intf.empty()) {
  6376. #ifdef USE_IF2IP
  6377. auto ip_from_if = if2ip(address_family, intf);
  6378. if (ip_from_if.empty()) { ip_from_if = intf; }
  6379. if (!bind_ip_address(sock2, ip_from_if)) {
  6380. error = Error::BindIPAddress;
  6381. return false;
  6382. }
  6383. #endif
  6384. }
  6385. set_nonblocking(sock2, true);
  6386. auto ret =
  6387. ::connect(sock2, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen));
  6388. if (ret < 0) {
  6389. if (is_connection_error()) {
  6390. error = Error::Connection;
  6391. return false;
  6392. }
  6393. error = wait_until_socket_is_ready(sock2, connection_timeout_sec,
  6394. connection_timeout_usec);
  6395. if (error != Error::Success) {
  6396. if (error == Error::ConnectionTimeout) { quit = true; }
  6397. return false;
  6398. }
  6399. }
  6400. set_nonblocking(sock2, false);
  6401. set_socket_opt_time(sock2, SOL_SOCKET, SO_RCVTIMEO, read_timeout_sec,
  6402. read_timeout_usec);
  6403. set_socket_opt_time(sock2, SOL_SOCKET, SO_SNDTIMEO, write_timeout_sec,
  6404. write_timeout_usec);
  6405. error = Error::Success;
  6406. return true;
  6407. },
  6408. connection_timeout_sec); // Pass DNS timeout
  6409. if (sock != INVALID_SOCKET) {
  6410. error = Error::Success;
  6411. } else {
  6412. if (error == Error::Success) { error = Error::Connection; }
  6413. }
  6414. return sock;
  6415. }
  6416. inline bool get_ip_and_port(const struct sockaddr_storage &addr,
  6417. socklen_t addr_len, std::string &ip, int &port) {
  6418. if (addr.ss_family == AF_INET) {
  6419. port = ntohs(reinterpret_cast<const struct sockaddr_in *>(&addr)->sin_port);
  6420. } else if (addr.ss_family == AF_INET6) {
  6421. port =
  6422. ntohs(reinterpret_cast<const struct sockaddr_in6 *>(&addr)->sin6_port);
  6423. } else {
  6424. return false;
  6425. }
  6426. std::array<char, NI_MAXHOST> ipstr{};
  6427. if (getnameinfo(reinterpret_cast<const struct sockaddr *>(&addr), addr_len,
  6428. ipstr.data(), static_cast<socklen_t>(ipstr.size()), nullptr,
  6429. 0, NI_NUMERICHOST)) {
  6430. return false;
  6431. }
  6432. ip = ipstr.data();
  6433. return true;
  6434. }
  6435. inline void get_local_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6436. struct sockaddr_storage addr;
  6437. socklen_t addr_len = sizeof(addr);
  6438. if (!getsockname(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6439. &addr_len)) {
  6440. get_ip_and_port(addr, addr_len, ip, port);
  6441. }
  6442. }
  6443. inline void get_remote_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6444. struct sockaddr_storage addr;
  6445. socklen_t addr_len = sizeof(addr);
  6446. if (!getpeername(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6447. &addr_len)) {
  6448. #ifndef _WIN32
  6449. if (addr.ss_family == AF_UNIX) {
  6450. #if defined(__linux__)
  6451. struct ucred ucred;
  6452. socklen_t len = sizeof(ucred);
  6453. if (getsockopt(sock, SOL_SOCKET, SO_PEERCRED, &ucred, &len) == 0) {
  6454. port = ucred.pid;
  6455. }
  6456. #elif defined(SOL_LOCAL) && defined(SO_PEERPID)
  6457. pid_t pid;
  6458. socklen_t len = sizeof(pid);
  6459. if (getsockopt(sock, SOL_LOCAL, SO_PEERPID, &pid, &len) == 0) {
  6460. port = pid;
  6461. }
  6462. #endif
  6463. return;
  6464. }
  6465. #endif
  6466. get_ip_and_port(addr, addr_len, ip, port);
  6467. }
  6468. }
  6469. inline std::string
  6470. find_content_type(const std::string &path,
  6471. const std::map<std::string, std::string> &user_data,
  6472. const std::string &default_content_type) {
  6473. auto ext = file_extension(path);
  6474. // Extensions are matched regardless of case, as web servers do, with an
  6475. // exact match to a user mapping first
  6476. auto lower_ext = case_ignore::to_lower(ext);
  6477. auto it = user_data.find(ext);
  6478. if (it == user_data.end()) { it = user_data.find(lower_ext); }
  6479. if (it != user_data.end()) { return it->second; }
  6480. static const struct {
  6481. const char *ext;
  6482. const char *type;
  6483. } types[] = {
  6484. {"css", "text/css"},
  6485. {"csv", "text/csv"},
  6486. {"htm", "text/html"},
  6487. {"html", "text/html"},
  6488. {"js", "text/javascript"},
  6489. {"mjs", "text/javascript"},
  6490. {"txt", "text/plain"},
  6491. {"vtt", "text/vtt"},
  6492. {"apng", "image/apng"},
  6493. {"avif", "image/avif"},
  6494. {"bmp", "image/bmp"},
  6495. {"gif", "image/gif"},
  6496. {"png", "image/png"},
  6497. {"svg", "image/svg+xml"},
  6498. {"webp", "image/webp"},
  6499. {"ico", "image/x-icon"},
  6500. {"tif", "image/tiff"},
  6501. {"tiff", "image/tiff"},
  6502. {"jpg", "image/jpeg"},
  6503. {"jpeg", "image/jpeg"},
  6504. {"mp4", "video/mp4"},
  6505. {"mpeg", "video/mpeg"},
  6506. {"webm", "video/webm"},
  6507. {"mp3", "audio/mp3"},
  6508. {"mpga", "audio/mpeg"},
  6509. {"weba", "audio/webm"},
  6510. {"wav", "audio/wave"},
  6511. {"otf", "font/otf"},
  6512. {"ttf", "font/ttf"},
  6513. {"woff", "font/woff"},
  6514. {"woff2", "font/woff2"},
  6515. {"7z", "application/x-7z-compressed"},
  6516. {"atom", "application/atom+xml"},
  6517. {"pdf", "application/pdf"},
  6518. {"json", "application/json"},
  6519. {"rss", "application/rss+xml"},
  6520. {"tar", "application/x-tar"},
  6521. {"xht", "application/xhtml+xml"},
  6522. {"xhtml", "application/xhtml+xml"},
  6523. {"xslt", "application/xslt+xml"},
  6524. {"xml", "application/xml"},
  6525. {"gz", "application/gzip"},
  6526. {"zip", "application/zip"},
  6527. {"wasm", "application/wasm"},
  6528. };
  6529. for (const auto &t : types) {
  6530. if (lower_ext == t.ext) { return t.type; }
  6531. }
  6532. return default_content_type;
  6533. }
  6534. inline std::string
  6535. extract_media_type(const std::string &content_type,
  6536. std::map<std::string, std::string> *params = nullptr) {
  6537. // Extract type/subtype from Content-Type value (RFC 2045)
  6538. // e.g. "application/json; charset=utf-8" -> "application/json"
  6539. auto media_type = content_type;
  6540. auto semicolon_pos = media_type.find(';');
  6541. if (semicolon_pos != std::string::npos) {
  6542. auto param_str = media_type.substr(semicolon_pos + 1);
  6543. media_type = media_type.substr(0, semicolon_pos);
  6544. if (params) {
  6545. // Parse parameters: key=value pairs separated by ';'
  6546. split_unquoted(param_str.data(), param_str.data() + param_str.size(), ';',
  6547. [&](const char *b, const char *e) {
  6548. std::string key;
  6549. std::string val;
  6550. divide_param_pair(b, e, key, val);
  6551. // Parameter names are case-insensitive (RFC 9110
  6552. // §5.6.6)
  6553. if (!key.empty()) {
  6554. params->emplace(case_ignore::to_lower(trim_copy(key)),
  6555. unquote_param(val));
  6556. }
  6557. });
  6558. }
  6559. }
  6560. // Trim whitespace from media type
  6561. return trim_copy(media_type);
  6562. }
  6563. inline bool can_compress_content_type(const std::string &content_type) {
  6564. // Media types are case-insensitive (RFC 9110 §8.3.1)
  6565. auto mime_type = case_ignore::to_lower(extract_media_type(content_type));
  6566. static const char *const compressible[] = {
  6567. "image/svg+xml",
  6568. "application/javascript",
  6569. "application/x-javascript",
  6570. "application/json",
  6571. "application/ld+json",
  6572. "application/xml",
  6573. "application/xhtml+xml",
  6574. "application/rss+xml",
  6575. "application/atom+xml",
  6576. "application/xslt+xml",
  6577. "application/protobuf",
  6578. };
  6579. for (auto type : compressible) {
  6580. if (mime_type == type) { return true; }
  6581. }
  6582. return mime_type != "text/event-stream" && !mime_type.rfind("text/", 0);
  6583. }
  6584. inline bool parse_quality(const char *b, const char *e, std::string &token,
  6585. double &quality) {
  6586. quality = 1.0;
  6587. token.clear();
  6588. // Split on first ';': left = token name, right = parameters
  6589. const char *params_b = nullptr;
  6590. std::size_t params_len = 0;
  6591. divide(
  6592. b, static_cast<std::size_t>(e - b), ';',
  6593. [&](const char *lb, std::size_t llen, const char *rb, std::size_t rlen) {
  6594. auto r = trim(lb, lb + llen, 0, llen);
  6595. if (r.first < r.second) { token.assign(lb + r.first, lb + r.second); }
  6596. params_b = rb;
  6597. params_len = rlen;
  6598. });
  6599. if (token.empty()) { return false; }
  6600. if (params_len == 0) { return true; }
  6601. // Scan parameters for q= (stops on first match)
  6602. bool invalid = false;
  6603. split_find(params_b, params_b + params_len, ';',
  6604. (std::numeric_limits<size_t>::max)(),
  6605. [&](const char *pb, const char *pe) -> bool {
  6606. // Match exactly "q=" or "Q=" (not "query=" etc.)
  6607. auto len = static_cast<size_t>(pe - pb);
  6608. if (len < 2) { return false; }
  6609. if ((pb[0] != 'q' && pb[0] != 'Q') || pb[1] != '=') {
  6610. return false;
  6611. }
  6612. // Trim the value portion
  6613. auto r = trim(pb, pe, 2, len);
  6614. if (r.first >= r.second) {
  6615. invalid = true;
  6616. return true;
  6617. }
  6618. double v = 0.0;
  6619. auto res = from_chars(pb + r.first, pb + r.second, v);
  6620. if (res.ec != std::errc{} || res.ptr != pb + r.second ||
  6621. v < 0.0 || v > 1.0) {
  6622. invalid = true;
  6623. return true;
  6624. }
  6625. quality = v;
  6626. return true;
  6627. });
  6628. return !invalid;
  6629. }
  6630. inline EncodingType encoding_type(const Request &req,
  6631. const std::string &content_type) {
  6632. if (!can_compress_content_type(content_type)) { return EncodingType::None; }
  6633. auto s = get_combined_header_value(req.headers, "Accept-Encoding");
  6634. if (s.empty()) { return EncodingType::None; }
  6635. // Single-pass: iterate tokens and track the best supported encoding.
  6636. // Server preference breaks ties (br > gzip > zstd).
  6637. EncodingType best = EncodingType::None;
  6638. double best_q = 0.0; // q=0 means "not acceptable"
  6639. // Server preference: Brotli > Gzip > Zstd (lower = more preferred)
  6640. auto priority = [](EncodingType t) -> int {
  6641. switch (t) {
  6642. case EncodingType::Brotli: return 0;
  6643. case EncodingType::Gzip: return 1;
  6644. case EncodingType::Zstd: return 2;
  6645. default: return 3;
  6646. }
  6647. };
  6648. std::string name;
  6649. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  6650. double quality = 1.0;
  6651. if (!parse_quality(b, e, name, quality)) { return; }
  6652. if (quality <= 0.0) { return; }
  6653. EncodingType type = EncodingType::None;
  6654. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6655. if (case_ignore::equal(name, "br")) { type = EncodingType::Brotli; }
  6656. #endif
  6657. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6658. if (type == EncodingType::None && case_ignore::equal(name, "gzip")) {
  6659. type = EncodingType::Gzip;
  6660. }
  6661. #endif
  6662. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6663. if (type == EncodingType::None && case_ignore::equal(name, "zstd")) {
  6664. type = EncodingType::Zstd;
  6665. }
  6666. #endif
  6667. if (type == EncodingType::None) { return; }
  6668. // Higher q-value wins; for equal q, server preference breaks ties
  6669. if (quality > best_q ||
  6670. (quality == best_q && priority(type) < priority(best))) {
  6671. best_q = quality;
  6672. best = type;
  6673. }
  6674. });
  6675. return best;
  6676. }
  6677. // `content_type` is taken separately because a file-backed response has not
  6678. // been given one yet when its coding has to be decided.
  6679. inline EncodingType encoding_type(const Request &req, const Response &res,
  6680. const std::string &content_type) {
  6681. // The response already names a content coding of its own: a handler serving
  6682. // a body it encoded itself (pre-compressed static assets, say), or a mount
  6683. // point whose headers name the coding its files are stored in. Applying one
  6684. // on top of that would double-encode the body and append a second
  6685. // `Content-Encoding` field line.
  6686. if (res.has_header("Content-Encoding")) { return EncodingType::None; }
  6687. return encoding_type(req, content_type);
  6688. }
  6689. inline EncodingType encoding_type(const Request &req, const Response &res) {
  6690. return encoding_type(req, res, res.get_header_value("Content-Type"));
  6691. }
  6692. inline std::unique_ptr<compressor> make_compressor(EncodingType type) {
  6693. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6694. if (type == EncodingType::Gzip) {
  6695. return detail::make_unique<gzip_compressor>();
  6696. }
  6697. #endif
  6698. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6699. if (type == EncodingType::Brotli) {
  6700. return detail::make_unique<brotli_compressor>();
  6701. }
  6702. #endif
  6703. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6704. if (type == EncodingType::Zstd) {
  6705. return detail::make_unique<zstd_compressor>();
  6706. }
  6707. #endif
  6708. (void)type;
  6709. return nullptr;
  6710. }
  6711. inline const char *encoding_name(EncodingType type) {
  6712. switch (type) {
  6713. case EncodingType::Gzip: return "gzip";
  6714. case EncodingType::Brotli: return "br";
  6715. case EncodingType::Zstd: return "zstd";
  6716. default: return "";
  6717. }
  6718. }
  6719. inline bool nocompressor::compress(const char *data, size_t data_length,
  6720. bool /*last*/, Callback callback) {
  6721. if (!data_length) { return true; }
  6722. return callback(data, data_length);
  6723. }
  6724. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6725. inline gzip_compressor::gzip_compressor() {
  6726. std::memset(&strm_, 0, sizeof(strm_));
  6727. strm_.zalloc = Z_NULL;
  6728. strm_.zfree = Z_NULL;
  6729. strm_.opaque = Z_NULL;
  6730. is_valid_ = deflateInit2(&strm_, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 31, 8,
  6731. Z_DEFAULT_STRATEGY) == Z_OK;
  6732. }
  6733. inline gzip_compressor::~gzip_compressor() { deflateEnd(&strm_); }
  6734. inline bool gzip_compressor::compress(const char *data, size_t data_length,
  6735. bool last, Callback callback) {
  6736. assert(is_valid_);
  6737. do {
  6738. constexpr size_t max_avail_in =
  6739. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6740. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6741. (std::min)(data_length, max_avail_in));
  6742. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6743. data_length -= strm_.avail_in;
  6744. data += strm_.avail_in;
  6745. auto flush = (last && data_length == 0) ? Z_FINISH : Z_NO_FLUSH;
  6746. auto ret = Z_OK;
  6747. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6748. do {
  6749. strm_.avail_out = static_cast<uInt>(buff.size());
  6750. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6751. ret = deflate(&strm_, flush);
  6752. if (ret == Z_STREAM_ERROR) { return false; }
  6753. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6754. return false;
  6755. }
  6756. } while (strm_.avail_out == 0);
  6757. assert((flush == Z_FINISH && ret == Z_STREAM_END) ||
  6758. (flush == Z_NO_FLUSH && ret == Z_OK));
  6759. assert(strm_.avail_in == 0);
  6760. } while (data_length > 0);
  6761. return true;
  6762. }
  6763. inline gzip_decompressor::gzip_decompressor() {
  6764. std::memset(&strm_, 0, sizeof(strm_));
  6765. strm_.zalloc = Z_NULL;
  6766. strm_.zfree = Z_NULL;
  6767. strm_.opaque = Z_NULL;
  6768. // 15 is the value of wbits, which should be at the maximum possible value
  6769. // to ensure that any gzip stream can be decoded. The offset of 32 specifies
  6770. // that the stream type should be automatically detected either gzip or
  6771. // deflate.
  6772. is_valid_ = inflateInit2(&strm_, 32 + 15) == Z_OK;
  6773. }
  6774. inline gzip_decompressor::~gzip_decompressor() { inflateEnd(&strm_); }
  6775. inline bool gzip_decompressor::is_valid() const { return is_valid_; }
  6776. inline bool gzip_decompressor::decompress(const char *data, size_t data_length,
  6777. Callback callback) {
  6778. assert(is_valid_);
  6779. auto ret = Z_OK;
  6780. do {
  6781. constexpr size_t max_avail_in =
  6782. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6783. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6784. (std::min)(data_length, max_avail_in));
  6785. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6786. data_length -= strm_.avail_in;
  6787. data += strm_.avail_in;
  6788. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6789. while (strm_.avail_in > 0 && ret == Z_OK) {
  6790. strm_.avail_out = static_cast<uInt>(buff.size());
  6791. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6792. ret = inflate(&strm_, Z_NO_FLUSH);
  6793. assert(ret != Z_STREAM_ERROR);
  6794. switch (ret) {
  6795. case Z_NEED_DICT:
  6796. case Z_DATA_ERROR:
  6797. case Z_MEM_ERROR: inflateEnd(&strm_); return false;
  6798. }
  6799. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6800. return false;
  6801. }
  6802. }
  6803. if (ret != Z_OK && ret != Z_STREAM_END) { return false; }
  6804. } while (data_length > 0);
  6805. return true;
  6806. }
  6807. #endif
  6808. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6809. inline brotli_compressor::brotli_compressor() {
  6810. state_ = BrotliEncoderCreateInstance(nullptr, nullptr, nullptr);
  6811. }
  6812. inline brotli_compressor::~brotli_compressor() {
  6813. BrotliEncoderDestroyInstance(state_);
  6814. }
  6815. inline bool brotli_compressor::compress(const char *data, size_t data_length,
  6816. bool last, Callback callback) {
  6817. std::array<uint8_t, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6818. auto operation = last ? BROTLI_OPERATION_FINISH : BROTLI_OPERATION_PROCESS;
  6819. auto available_in = data_length;
  6820. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6821. for (;;) {
  6822. if (last) {
  6823. if (BrotliEncoderIsFinished(state_)) { break; }
  6824. } else {
  6825. if (!available_in) { break; }
  6826. }
  6827. auto available_out = buff.size();
  6828. auto next_out = buff.data();
  6829. if (!BrotliEncoderCompressStream(state_, operation, &available_in, &next_in,
  6830. &available_out, &next_out, nullptr)) {
  6831. return false;
  6832. }
  6833. auto output_bytes = buff.size() - available_out;
  6834. if (output_bytes) {
  6835. callback(reinterpret_cast<const char *>(buff.data()), output_bytes);
  6836. }
  6837. }
  6838. return true;
  6839. }
  6840. inline brotli_decompressor::brotli_decompressor() {
  6841. decoder_s = BrotliDecoderCreateInstance(0, 0, 0);
  6842. decoder_r = decoder_s ? BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT
  6843. : BROTLI_DECODER_RESULT_ERROR;
  6844. }
  6845. inline brotli_decompressor::~brotli_decompressor() {
  6846. if (decoder_s) { BrotliDecoderDestroyInstance(decoder_s); }
  6847. }
  6848. inline bool brotli_decompressor::is_valid() const { return decoder_s; }
  6849. inline bool brotli_decompressor::decompress(const char *data,
  6850. size_t data_length,
  6851. Callback callback) {
  6852. if (decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6853. decoder_r == BROTLI_DECODER_RESULT_ERROR) {
  6854. return 0;
  6855. }
  6856. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6857. size_t avail_in = data_length;
  6858. size_t total_out;
  6859. decoder_r = BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT;
  6860. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6861. while (decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT) {
  6862. char *next_out = buff.data();
  6863. size_t avail_out = buff.size();
  6864. decoder_r = BrotliDecoderDecompressStream(
  6865. decoder_s, &avail_in, &next_in, &avail_out,
  6866. reinterpret_cast<uint8_t **>(&next_out), &total_out);
  6867. if (decoder_r == BROTLI_DECODER_RESULT_ERROR) { return false; }
  6868. if (!callback(buff.data(), buff.size() - avail_out)) { return false; }
  6869. }
  6870. return decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6871. decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT;
  6872. }
  6873. #endif
  6874. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6875. inline zstd_compressor::zstd_compressor() {
  6876. ctx_ = ZSTD_createCCtx();
  6877. ZSTD_CCtx_setParameter(ctx_, ZSTD_c_compressionLevel, ZSTD_fast);
  6878. }
  6879. inline zstd_compressor::~zstd_compressor() { ZSTD_freeCCtx(ctx_); }
  6880. inline bool zstd_compressor::compress(const char *data, size_t data_length,
  6881. bool last, Callback callback) {
  6882. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6883. ZSTD_EndDirective mode = last ? ZSTD_e_end : ZSTD_e_continue;
  6884. ZSTD_inBuffer input = {data, data_length, 0};
  6885. bool finished;
  6886. do {
  6887. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6888. size_t const remaining = ZSTD_compressStream2(ctx_, &output, &input, mode);
  6889. if (ZSTD_isError(remaining)) { return false; }
  6890. if (!callback(buff.data(), output.pos)) { return false; }
  6891. finished = last ? (remaining == 0) : (input.pos == input.size);
  6892. } while (!finished);
  6893. return true;
  6894. }
  6895. inline zstd_decompressor::zstd_decompressor() { ctx_ = ZSTD_createDCtx(); }
  6896. inline zstd_decompressor::~zstd_decompressor() { ZSTD_freeDCtx(ctx_); }
  6897. inline bool zstd_decompressor::is_valid() const { return ctx_ != nullptr; }
  6898. inline bool zstd_decompressor::decompress(const char *data, size_t data_length,
  6899. Callback callback) {
  6900. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6901. ZSTD_inBuffer input = {data, data_length, 0};
  6902. while (input.pos < input.size) {
  6903. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6904. size_t const remaining = ZSTD_decompressStream(ctx_, &output, &input);
  6905. if (ZSTD_isError(remaining)) { return false; }
  6906. if (!callback(buff.data(), output.pos)) { return false; }
  6907. }
  6908. return true;
  6909. }
  6910. #endif
  6911. // Content codings are case-insensitive (RFC 9110 8.4.1). Matching them
  6912. // case-sensitively would make a response labeled e.g. "GZIP" look like an
  6913. // unknown coding, and its payload would be handed back still compressed.
  6914. inline bool is_zlib_encoding(const std::string &encoding) {
  6915. return case_ignore::equal(encoding, "gzip") ||
  6916. case_ignore::equal(encoding, "deflate");
  6917. }
  6918. inline bool is_brotli_encoding(const std::string &encoding) {
  6919. return case_ignore::equal(encoding, "br");
  6920. }
  6921. inline bool is_zstd_encoding(const std::string &encoding) {
  6922. return case_ignore::equal(encoding, "zstd");
  6923. }
  6924. // Returns true if the content coding is one cpp-httplib is able to decompress
  6925. // when the corresponding support is compiled in.
  6926. inline bool is_known_content_encoding(const std::string &encoding) {
  6927. return is_zlib_encoding(encoding) || is_brotli_encoding(encoding) ||
  6928. is_zstd_encoding(encoding);
  6929. }
  6930. inline std::unique_ptr<decompressor>
  6931. create_decompressor(const std::string &encoding) {
  6932. std::unique_ptr<decompressor> decompressor;
  6933. if (is_zlib_encoding(encoding)) {
  6934. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6935. decompressor = detail::make_unique<gzip_decompressor>();
  6936. #endif
  6937. } else if (is_brotli_encoding(encoding)) {
  6938. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6939. decompressor = detail::make_unique<brotli_decompressor>();
  6940. #endif
  6941. } else if (is_zstd_encoding(encoding)) {
  6942. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6943. decompressor = detail::make_unique<zstd_decompressor>();
  6944. #endif
  6945. }
  6946. return decompressor;
  6947. }
  6948. // Returns the best available compressor and its Content-Encoding name.
  6949. // Priority: Brotli > Gzip > Zstd (matches server-side preference).
  6950. inline std::pair<std::unique_ptr<compressor>, const char *>
  6951. create_compressor() {
  6952. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6953. return {detail::make_unique<brotli_compressor>(), "br"};
  6954. #elif defined(CPPHTTPLIB_ZLIB_SUPPORT)
  6955. return {detail::make_unique<gzip_compressor>(), "gzip"};
  6956. #elif defined(CPPHTTPLIB_ZSTD_SUPPORT)
  6957. return {detail::make_unique<zstd_compressor>(), "zstd"};
  6958. #else
  6959. return {nullptr, nullptr};
  6960. #endif
  6961. }
  6962. inline bool is_prohibited_header_name(const std::string &name) {
  6963. // Field names are case-insensitive (RFC 9110 §5.1)
  6964. return case_ignore::equal(name, "REMOTE_ADDR") ||
  6965. case_ignore::equal(name, "REMOTE_PORT") ||
  6966. case_ignore::equal(name, "LOCAL_ADDR") ||
  6967. case_ignore::equal(name, "LOCAL_PORT");
  6968. }
  6969. inline bool has_header(const Headers &headers, const std::string &key) {
  6970. if (is_prohibited_header_name(key)) { return false; }
  6971. return headers.find(key) != headers.end();
  6972. }
  6973. inline const char *get_header_value(const Headers &headers,
  6974. const std::string &key, const char *def,
  6975. size_t id) {
  6976. if (is_prohibited_header_name(key)) {
  6977. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  6978. std::string msg = "Prohibited header name '" + key + "' is specified.";
  6979. throw std::invalid_argument(msg);
  6980. #else
  6981. return "";
  6982. #endif
  6983. }
  6984. auto rng = headers.equal_range(key);
  6985. auto it = bounded_next(rng.first, id, rng.second);
  6986. if (it != rng.second) { return it->second.c_str(); }
  6987. return def;
  6988. }
  6989. inline size_t get_header_value_count(const Headers &headers,
  6990. const std::string &key) {
  6991. return headers.count(key);
  6992. }
  6993. // RFC 9110 Section 5.2 and 5.3: a field that is defined as a comma-separated
  6994. // list may be sent as several field lines, and the combined field value is
  6995. // those values joined by commas in the order they were received. Callers that
  6996. // parse such a list must work on the combined value; reading only the first
  6997. // occurrence silently drops whatever the later field lines carry.
  6998. inline std::string get_combined_header_value(const Headers &headers,
  6999. const std::string &key) {
  7000. std::string combined;
  7001. auto rng = headers.equal_range(key);
  7002. for (auto it = rng.first; it != rng.second; ++it) {
  7003. // RFC 9110 Section 5.6.1.2: a recipient has to parse and ignore empty list
  7004. // elements, so an empty field line must not contribute a bare comma to the
  7005. // combined value.
  7006. if (it->second.empty()) { continue; }
  7007. if (!combined.empty()) { combined += ", "; }
  7008. combined += it->second;
  7009. }
  7010. return combined;
  7011. }
  7012. inline bool has_header_token(const Headers &headers, const std::string &key,
  7013. const std::string &token) {
  7014. // RFC 9110 7.6.1: a comma-separated token list field such as Connection may
  7015. // carry several tokens, and RFC 9110 5.3 lets that list be split across
  7016. // several lines. Match complete tokens rather than searching the raw value,
  7017. // so that a value such as "notupgrade" is not read as the token "upgrade".
  7018. auto rng = headers.equal_range(key);
  7019. for (auto it = rng.first; it != rng.second; ++it) {
  7020. const auto &value = it->second;
  7021. if (split_find(value.data(), value.data() + value.size(), ',',
  7022. [&](const char *b, const char *e) {
  7023. return case_ignore::equal(std::string(b, e), token);
  7024. })) {
  7025. return true;
  7026. }
  7027. }
  7028. return false;
  7029. }
  7030. template <typename Map>
  7031. inline typename Map::mapped_type
  7032. get_multimap_value(const Map &m, const std::string &key, size_t id) {
  7033. auto rng = m.equal_range(key);
  7034. auto it = bounded_next(rng.first, id, rng.second);
  7035. if (it != rng.second) { return it->second; }
  7036. return typename Map::mapped_type();
  7037. }
  7038. inline void set_header(Headers &headers, const std::string &key,
  7039. const std::string &val) {
  7040. if (fields::is_field_valid(key, val)) { headers.emplace(key, val); }
  7041. }
  7042. inline bool read_headers(Stream &strm, Headers &headers) {
  7043. const auto bufsiz = 2048;
  7044. char buf[bufsiz];
  7045. stream_line_reader line_reader(strm, buf, bufsiz);
  7046. size_t header_count = 0;
  7047. for (;;) {
  7048. if (!line_reader.getline()) { return false; }
  7049. // Check if the line ends with CRLF.
  7050. auto line_terminator_len = 2;
  7051. if (line_reader.end_with_crlf()) {
  7052. // Blank line indicates end of headers.
  7053. if (line_reader.size() == 2) { break; }
  7054. } else {
  7055. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  7056. // Blank line indicates end of headers.
  7057. if (line_reader.size() == 1) { break; }
  7058. line_terminator_len = 1;
  7059. #else
  7060. continue; // Skip invalid line.
  7061. #endif
  7062. }
  7063. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  7064. // Check header count limit
  7065. if (header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  7066. // Exclude line terminator
  7067. auto end = line_reader.ptr() + line_reader.size() - line_terminator_len;
  7068. if (!parse_header(line_reader.ptr(), end,
  7069. [&](const std::string &key, const std::string &val) {
  7070. headers.emplace(key, val);
  7071. })) {
  7072. return false;
  7073. }
  7074. header_count++;
  7075. }
  7076. // RFC 9110 Section 8.6: Reject requests with multiple Content-Length
  7077. // headers that have different values to prevent request smuggling.
  7078. auto cl_range = headers.equal_range("Content-Length");
  7079. if (cl_range.first != cl_range.second) {
  7080. const auto &first_val = cl_range.first->second;
  7081. for (auto it = std::next(cl_range.first); it != cl_range.second; ++it) {
  7082. if (it->second != first_val) { return false; }
  7083. }
  7084. }
  7085. return true;
  7086. }
  7087. // Parsed by hand: std::regex_match recurses once per character of the reason
  7088. // phrase, which a server can make as long as a whole line.
  7089. inline bool parse_status_line(const char *line, std::string &version,
  7090. int &status, std::string &reason) {
  7091. if (std::strncmp(line, "HTTP/1.", 7) != 0 ||
  7092. (line[7] != '0' && line[7] != '1') || line[8] != ' ' ||
  7093. !is_ascii_digit(line[9]) || !is_ascii_digit(line[10]) ||
  7094. !is_ascii_digit(line[11])) {
  7095. return false;
  7096. }
  7097. auto p = line + 12;
  7098. auto reason_begin = p;
  7099. if (*p == ' ') {
  7100. reason_begin = ++p;
  7101. p += std::strcspn(p, "\r\n");
  7102. }
  7103. auto reason_end = p;
  7104. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  7105. if (*p == '\r') { p++; }
  7106. #else
  7107. if (*p++ != '\r') { return false; }
  7108. #endif
  7109. if (*p++ != '\n' || *p != '\0') { return false; }
  7110. version.assign(line, 8);
  7111. status = (line[9] - '0') * 100 + (line[10] - '0') * 10 + (line[11] - '0');
  7112. reason.assign(reason_begin, reason_end);
  7113. return true;
  7114. }
  7115. // Everything WebSocketClient::connect() reports about the upgrade exchange.
  7116. // status stays -1 until a status line is parsed, mirroring stream::Result.
  7117. struct WebSocketUpgradeResponse {
  7118. Error error = Error::Success;
  7119. int status = -1;
  7120. Headers headers;
  7121. std::string selected_subprotocol;
  7122. };
  7123. // Reads a response's status line and headers, leaving any body unread. An
  7124. // unparsable status line is no stream error; it just leaves `status` as is.
  7125. inline bool read_response_head(Stream &strm, int &status, Headers &headers) {
  7126. const auto bufsiz = 2048;
  7127. char buf[bufsiz];
  7128. stream_line_reader line_reader(strm, buf, bufsiz);
  7129. if (!line_reader.getline()) { return false; }
  7130. std::string version;
  7131. std::string reason;
  7132. if (!parse_status_line(line_reader.ptr(), version, status, reason)) {
  7133. return true;
  7134. }
  7135. return read_headers(strm, headers);
  7136. }
  7137. inline bool
  7138. read_websocket_upgrade_response(Stream &strm,
  7139. const std::string &expected_accept,
  7140. const std::string &offered_subprotocols,
  7141. WebSocketUpgradeResponse &upgrade) {
  7142. // The headers of a rejection are kept so the caller can see why the server
  7143. // refused the upgrade.
  7144. if (!read_response_head(strm, upgrade.status, upgrade.headers)) {
  7145. upgrade.error = Error::Read;
  7146. return false;
  7147. }
  7148. const auto &headers = upgrade.headers;
  7149. if (upgrade.status != StatusCode::SwitchingProtocol_101) {
  7150. upgrade.error = Error::WebSocketHandshake;
  7151. return false;
  7152. }
  7153. // Verify Upgrade: websocket (a comma-separated list, matched per token)
  7154. if (!has_header_token(headers, "Upgrade", "websocket")) {
  7155. upgrade.error = Error::WebSocketHandshake;
  7156. return false;
  7157. }
  7158. // Verify Connection: Upgrade
  7159. if (!has_header_token(headers, "Connection", "upgrade")) {
  7160. upgrade.error = Error::WebSocketHandshake;
  7161. return false;
  7162. }
  7163. // Verify Sec-WebSocket-Accept header value
  7164. auto it = headers.find("Sec-WebSocket-Accept");
  7165. if (it == headers.end() || it->second != expected_accept) {
  7166. upgrade.error = Error::WebSocketHandshake;
  7167. return false;
  7168. }
  7169. // Extract negotiated subprotocol
  7170. auto proto_it = headers.find("Sec-WebSocket-Protocol");
  7171. if (proto_it != headers.end()) {
  7172. upgrade.selected_subprotocol = proto_it->second;
  7173. }
  7174. // Verify the subprotocol is one the client offered (RFC 6455 4.1)
  7175. if (!upgrade.selected_subprotocol.empty()) {
  7176. auto was_offered = false;
  7177. split(offered_subprotocols.data(),
  7178. offered_subprotocols.data() + offered_subprotocols.size(), ',',
  7179. [&](const char *b, const char *e) {
  7180. if (std::string(b, e) == upgrade.selected_subprotocol) {
  7181. was_offered = true;
  7182. }
  7183. });
  7184. if (!was_offered) {
  7185. upgrade.error = Error::WebSocketHandshake;
  7186. return false;
  7187. }
  7188. }
  7189. return true;
  7190. }
  7191. enum class ReadContentResult {
  7192. Success, // Successfully read the content
  7193. PayloadTooLarge, // The content exceeds the specified payload limit
  7194. Error // An error occurred while reading the content
  7195. };
  7196. inline ReadContentResult read_content_with_length(
  7197. Stream &strm, size_t len, DownloadProgress progress,
  7198. ContentReceiverWithProgress out,
  7199. size_t payload_max_length = (std::numeric_limits<size_t>::max)()) {
  7200. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7201. detail::BodyReader br;
  7202. br.stream = &strm;
  7203. br.has_content_length = true;
  7204. br.content_length = len;
  7205. br.payload_max_length = payload_max_length;
  7206. br.chunked = false;
  7207. br.bytes_read = 0;
  7208. br.last_error = Error::Success;
  7209. size_t r = 0;
  7210. while (r < len) {
  7211. auto read_len = static_cast<size_t>(len - r);
  7212. auto to_read = (std::min)(read_len, CPPHTTPLIB_RECV_BUFSIZ);
  7213. auto n = detail::read_body_content(&strm, br, buf, to_read);
  7214. if (n <= 0) {
  7215. // Check if it was a payload size error
  7216. if (br.last_error == Error::ExceedMaxPayloadSize) {
  7217. return ReadContentResult::PayloadTooLarge;
  7218. }
  7219. return ReadContentResult::Error;
  7220. }
  7221. if (!out(buf, static_cast<size_t>(n), r, len)) {
  7222. return ReadContentResult::Error;
  7223. }
  7224. r += static_cast<size_t>(n);
  7225. if (progress) {
  7226. if (!progress(r, len)) { return ReadContentResult::Error; }
  7227. }
  7228. }
  7229. return ReadContentResult::Success;
  7230. }
  7231. inline ReadContentResult
  7232. read_content_without_length(Stream &strm, size_t payload_max_length,
  7233. ContentReceiverWithProgress out) {
  7234. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7235. size_t r = 0;
  7236. for (;;) {
  7237. auto n = strm.read(buf, CPPHTTPLIB_RECV_BUFSIZ);
  7238. if (n == 0) { return ReadContentResult::Success; }
  7239. if (n < 0) { return ReadContentResult::Error; }
  7240. // Check if adding this data would exceed the payload limit
  7241. if (payload_max_length > 0 &&
  7242. (r > payload_max_length ||
  7243. payload_max_length - r < static_cast<size_t>(n))) {
  7244. return ReadContentResult::PayloadTooLarge;
  7245. }
  7246. if (!out(buf, static_cast<size_t>(n), r, 0)) {
  7247. return ReadContentResult::Error;
  7248. }
  7249. r += static_cast<size_t>(n);
  7250. }
  7251. return ReadContentResult::Success;
  7252. }
  7253. template <typename T>
  7254. inline ReadContentResult read_content_chunked(Stream &strm, T &x,
  7255. size_t payload_max_length,
  7256. ContentReceiverWithProgress out) {
  7257. detail::ChunkedDecoder dec(strm);
  7258. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7259. size_t total_len = 0;
  7260. for (;;) {
  7261. size_t chunk_offset = 0;
  7262. size_t chunk_total = 0;
  7263. auto n = dec.read_payload(buf, sizeof(buf), chunk_offset, chunk_total);
  7264. if (n < 0) { return ReadContentResult::Error; }
  7265. if (n == 0) {
  7266. if (!dec.parse_trailers_into(x.trailers, x.headers)) {
  7267. return ReadContentResult::Error;
  7268. }
  7269. return ReadContentResult::Success;
  7270. }
  7271. if (payload_max_length > 0 &&
  7272. (total_len > payload_max_length ||
  7273. payload_max_length - total_len < static_cast<size_t>(n))) {
  7274. return ReadContentResult::PayloadTooLarge;
  7275. }
  7276. if (!out(buf, static_cast<size_t>(n), chunk_offset, chunk_total)) {
  7277. return ReadContentResult::Error;
  7278. }
  7279. total_len += static_cast<size_t>(n);
  7280. }
  7281. }
  7282. inline bool is_chunked_transfer_encoding(const Headers &headers) {
  7283. // RFC 9112 6.1: a message is framed with the chunked coding when "chunked"
  7284. // is the final transfer coding. A single field value may list several
  7285. // codings ("gzip, chunked"), and RFC 9110 5.3 lets that list be split across
  7286. // several Transfer-Encoding lines, which combine into one comma-separated
  7287. // list in the order the lines were received. Headers preserves that order,
  7288. // so the final coding is the last token of the last line. Match it
  7289. // case-insensitively rather than comparing the whole value against
  7290. // "chunked".
  7291. //
  7292. // Security: reading a chunked message as unframed leaves its body in the
  7293. // socket, where a keep-alive connection parses it as a smuggled request.
  7294. // Server::process_request() answers 400 and closes when the final coding is
  7295. // not chunked, so a request whose framing cannot be determined never
  7296. // reaches the "no body" path.
  7297. auto rng = headers.equal_range("Transfer-Encoding");
  7298. if (rng.first == rng.second) { return false; }
  7299. // Cleared per line, so a trailing line carrying no coding at all leaves the
  7300. // combined list ending in nothing rather than inheriting the line before it.
  7301. std::string last_coding;
  7302. for (auto it = rng.first; it != rng.second; ++it) {
  7303. const auto &value = it->second;
  7304. last_coding.clear();
  7305. split(value.data(), value.data() + value.size(), ',',
  7306. [&](const char *b, const char *e) { last_coding.assign(b, e); });
  7307. }
  7308. return case_ignore::equal(last_coding, "chunked");
  7309. }
  7310. // RFC 9112 6.1: a message framed by Transfer-Encoding next to a Content-Length,
  7311. // or in HTTP/1.0, leaves the connection unfit to carry another one.
  7312. template <typename T> inline bool has_faulty_transfer_encoding(const T &msg) {
  7313. return msg.has_header("Transfer-Encoding") &&
  7314. (msg.has_header("Content-Length") || msg.version == "HTTP/1.0");
  7315. }
  7316. inline bool has_conflicting_content_length(const Headers &headers) {
  7317. // RFC 9112 §6.3: a message carrying both Transfer-Encoding and a non-zero
  7318. // Content-Length is framed ambiguously. The body readers here delimit it by
  7319. // the transfer coding and drop Content-Length, while an intermediary may do
  7320. // the reverse, so the two disagree on where the body ends and a reused
  7321. // connection is desynchronised (request/response smuggling). Content-Length:
  7322. // 0 is tolerated for compatibility with existing peers.
  7323. return has_header(headers, "Transfer-Encoding") &&
  7324. get_header_value_u64(headers, "Content-Length", 0, 0) > 0;
  7325. }
  7326. template <typename T, typename U>
  7327. bool prepare_content_receiver(T &x, int &status,
  7328. ContentReceiverWithProgress receiver,
  7329. bool decompress, size_t payload_max_length,
  7330. bool &exceed_payload_max_length, U callback) {
  7331. if (decompress) {
  7332. auto encoding = get_combined_header_value(x.headers, "Content-Encoding");
  7333. std::unique_ptr<decompressor> decompressor;
  7334. if (!encoding.empty()) {
  7335. // A coding we know about but were not built with is an error. An
  7336. // unrecognized coding (including "identity") is left alone and the
  7337. // payload is passed through as-is, since some servers misuse the header,
  7338. // e.g. by sending a character set such as "Content-Encoding: UTF-8".
  7339. decompressor = detail::create_decompressor(encoding);
  7340. if (!decompressor && detail::is_known_content_encoding(encoding)) {
  7341. status = StatusCode::UnsupportedMediaType_415;
  7342. return false;
  7343. }
  7344. }
  7345. if (decompressor) {
  7346. if (decompressor->is_valid()) {
  7347. size_t decompressed_size = 0;
  7348. ContentReceiverWithProgress out = [&](const char *buf, size_t n,
  7349. size_t off, size_t len) {
  7350. return decompressor->decompress(
  7351. buf, n, [&](const char *buf2, size_t n2) {
  7352. // Guard against zip-bomb: check
  7353. // decompressed size against limit.
  7354. if (payload_max_length > 0 &&
  7355. (decompressed_size >= payload_max_length ||
  7356. n2 > payload_max_length - decompressed_size)) {
  7357. exceed_payload_max_length = true;
  7358. return false;
  7359. }
  7360. decompressed_size += n2;
  7361. return receiver(buf2, n2, off, len);
  7362. });
  7363. };
  7364. return callback(std::move(out));
  7365. } else {
  7366. status = StatusCode::InternalServerError_500;
  7367. return false;
  7368. }
  7369. }
  7370. }
  7371. ContentReceiverWithProgress out = [&](const char *buf, size_t n, size_t off,
  7372. size_t len) {
  7373. return receiver(buf, n, off, len);
  7374. };
  7375. return callback(std::move(out));
  7376. }
  7377. template <typename T>
  7378. bool read_content(Stream &strm, T &x, size_t payload_max_length, int &status,
  7379. DownloadProgress progress,
  7380. ContentReceiverWithProgress receiver, bool decompress) {
  7381. bool exceed_payload_max_length = false;
  7382. return prepare_content_receiver(
  7383. x, status, std::move(receiver), decompress, payload_max_length,
  7384. exceed_payload_max_length, [&](const ContentReceiverWithProgress &out) {
  7385. auto ret = true;
  7386. // Note: exceed_payload_max_length may also be set by the decompressor
  7387. // wrapper in prepare_content_receiver when the decompressed payload
  7388. // size exceeds the limit.
  7389. if (is_chunked_transfer_encoding(x.headers)) {
  7390. auto result = read_content_chunked(strm, x, payload_max_length, out);
  7391. if (result == ReadContentResult::Success) {
  7392. ret = true;
  7393. } else if (result == ReadContentResult::PayloadTooLarge) {
  7394. exceed_payload_max_length = true;
  7395. ret = false;
  7396. } else {
  7397. ret = false;
  7398. }
  7399. } else if (!has_header(x.headers, "Content-Length")) {
  7400. auto result =
  7401. read_content_without_length(strm, payload_max_length, out);
  7402. if (result == ReadContentResult::Success) {
  7403. ret = true;
  7404. } else if (result == ReadContentResult::PayloadTooLarge) {
  7405. exceed_payload_max_length = true;
  7406. ret = false;
  7407. } else {
  7408. ret = false;
  7409. }
  7410. } else {
  7411. auto is_invalid_value = false;
  7412. auto len = get_header_value_u64(x.headers, "Content-Length",
  7413. (std::numeric_limits<size_t>::max)(),
  7414. 0, is_invalid_value);
  7415. if (is_invalid_value) {
  7416. ret = false;
  7417. } else if (len > 0) {
  7418. auto result = read_content_with_length(
  7419. strm, len, std::move(progress), out, payload_max_length);
  7420. ret = (result == ReadContentResult::Success);
  7421. if (result == ReadContentResult::PayloadTooLarge) {
  7422. exceed_payload_max_length = true;
  7423. }
  7424. }
  7425. }
  7426. if (!ret) {
  7427. status = exceed_payload_max_length ? StatusCode::PayloadTooLarge_413
  7428. : StatusCode::BadRequest_400;
  7429. }
  7430. return ret;
  7431. });
  7432. }
  7433. inline ssize_t write_request_line(Stream &strm, const std::string &method,
  7434. const std::string &path) {
  7435. // Neither the method nor the request target may carry CR/LF, SP or other
  7436. // control octets; otherwise a value smuggled into either splits the request
  7437. // line and injects headers or a whole request.
  7438. if (!fields::is_token(method)) { return -1; }
  7439. if (!fields::is_request_target(path)) { return -1; }
  7440. std::string s = method;
  7441. s += ' ';
  7442. s += path;
  7443. s += " HTTP/1.1\r\n";
  7444. return strm.write(s.data(), s.size());
  7445. }
  7446. inline ssize_t write_response_line(Stream &strm, int status) {
  7447. std::string s = "HTTP/1.1 ";
  7448. s += std::to_string(status);
  7449. s += ' ';
  7450. s += httplib::status_message(status);
  7451. s += "\r\n";
  7452. return strm.write(s.data(), s.size());
  7453. }
  7454. inline ssize_t write_headers(Stream &strm, const Headers &headers) {
  7455. ssize_t write_len = 0;
  7456. for (const auto &x : headers) {
  7457. // Skip fields with invalid names or values to prevent response splitting
  7458. // via CR/LF injection, matching set_header(). The client validates request
  7459. // headers up front in check_and_write_headers, but the server passes
  7460. // res.headers straight to this writer, and res.headers is a public field
  7461. // an application can populate directly with request-derived values.
  7462. if (!fields::is_field_valid(x.first, x.second)) { continue; }
  7463. std::string s;
  7464. s = x.first;
  7465. s += ": ";
  7466. s += x.second;
  7467. s += "\r\n";
  7468. auto len = strm.write(s.data(), s.size());
  7469. if (len < 0) { return len; }
  7470. write_len += len;
  7471. }
  7472. auto len = strm.write("\r\n");
  7473. if (len < 0) { return len; }
  7474. write_len += len;
  7475. return write_len;
  7476. }
  7477. inline bool write_data(Stream &strm, const char *d, size_t l) {
  7478. size_t offset = 0;
  7479. while (offset < l) {
  7480. auto length = strm.write(d + offset, l - offset);
  7481. if (length < 0) { return false; }
  7482. offset += static_cast<size_t>(length);
  7483. }
  7484. return true;
  7485. }
  7486. template <typename T>
  7487. inline bool write_content_with_progress(Stream &strm,
  7488. const ContentProvider &content_provider,
  7489. size_t offset, size_t length,
  7490. T is_shutting_down,
  7491. const UploadProgress &upload_progress,
  7492. Error &error) {
  7493. size_t end_offset = offset + length;
  7494. size_t start_offset = offset;
  7495. auto ok = true;
  7496. auto finished = false;
  7497. DataSink data_sink;
  7498. data_sink.write = [&](const char *d, size_t l) -> bool {
  7499. if (ok) {
  7500. // Bytes past `length` would follow the framed body, where the peer reads
  7501. // them as the next message. Write only what fits and fail the rest.
  7502. if (l > end_offset - offset) {
  7503. l = end_offset - offset;
  7504. ok = false;
  7505. }
  7506. if (write_data(strm, d, l)) {
  7507. offset += l;
  7508. if (upload_progress && length > 0) {
  7509. size_t current_written = offset - start_offset;
  7510. if (!upload_progress(current_written, length)) {
  7511. ok = false;
  7512. return false;
  7513. }
  7514. }
  7515. } else {
  7516. ok = false;
  7517. }
  7518. }
  7519. return ok;
  7520. };
  7521. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7522. // The body is framed by `length`, so a provider that reports itself done
  7523. // early has truncated it. Record that and let the short-body check below
  7524. // fail the write, rather than calling the provider again forever.
  7525. data_sink.done = [&]() { finished = true; };
  7526. while (offset < end_offset && !finished && !is_shutting_down()) {
  7527. auto last_offset = offset;
  7528. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7529. error = Error::Write;
  7530. return false;
  7531. } else if (!content_provider(offset, end_offset - offset, data_sink)) {
  7532. error = Error::Canceled;
  7533. return false;
  7534. } else if (!ok) {
  7535. error = Error::Write;
  7536. return false;
  7537. }
  7538. // A provider that reports success without writing anything and without
  7539. // reporting itself done gets handed the same offset and length again on
  7540. // the next pass, so it would spin here for as long as the peer stays
  7541. // connected. Treat making no progress as a short body, like done() early.
  7542. if (!finished && offset == last_offset) {
  7543. error = Error::Write;
  7544. return false;
  7545. }
  7546. }
  7547. if (offset < end_offset) { // done() called early, or is_shutting_down()
  7548. error = Error::Write;
  7549. return false;
  7550. }
  7551. error = Error::Success;
  7552. return true;
  7553. }
  7554. template <typename T>
  7555. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7556. size_t offset, size_t length, T is_shutting_down,
  7557. Error &error) {
  7558. return write_content_with_progress<T>(strm, content_provider, offset, length,
  7559. is_shutting_down, nullptr, error);
  7560. }
  7561. template <typename T>
  7562. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7563. size_t offset, size_t length,
  7564. const T &is_shutting_down) {
  7565. auto error = Error::Success;
  7566. return write_content(strm, content_provider, offset, length, is_shutting_down,
  7567. error);
  7568. }
  7569. template <typename T>
  7570. inline bool
  7571. write_content_without_length(Stream &strm,
  7572. const ContentProvider &content_provider,
  7573. const T &is_shutting_down) {
  7574. size_t offset = 0;
  7575. auto data_available = true;
  7576. auto ok = true;
  7577. DataSink data_sink;
  7578. data_sink.write = [&](const char *d, size_t l) -> bool {
  7579. if (ok) {
  7580. offset += l;
  7581. if (!write_data(strm, d, l)) { ok = false; }
  7582. }
  7583. return ok;
  7584. };
  7585. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7586. data_sink.done = [&](void) { data_available = false; };
  7587. while (data_available && !is_shutting_down()) {
  7588. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7589. return false;
  7590. } else if (!content_provider(offset, 0, data_sink)) {
  7591. return false;
  7592. } else if (!ok) {
  7593. return false;
  7594. }
  7595. }
  7596. return !data_available; // true only if done() was called, false if shutting
  7597. // down
  7598. }
  7599. // Runs a known-length content provider to completion and compresses what it
  7600. // writes into `out`, chunk by chunk, without holding the identity form.
  7601. inline bool compress_content_provider(const ContentProvider &content_provider,
  7602. size_t length, compressor &cmp,
  7603. std::string &out) {
  7604. size_t offset = 0;
  7605. auto ok = true;
  7606. auto finished = false;
  7607. DataSink data_sink;
  7608. auto append = [&](const char *data, size_t data_len) {
  7609. out.append(data, data_len);
  7610. return true;
  7611. };
  7612. data_sink.write = [&](const char *d, size_t l) -> bool {
  7613. if (!ok) { return false; }
  7614. offset += l;
  7615. if (l > 0 && !cmp.compress(d, l, false, append)) { ok = false; }
  7616. return ok;
  7617. };
  7618. // The body is framed by `length`, so a provider that reports itself done
  7619. // early has truncated it; the short-body check below turns that into a
  7620. // failure rather than calling the provider again forever.
  7621. data_sink.done = [&]() { finished = true; };
  7622. while (offset < length && !finished) {
  7623. auto prev_offset = offset;
  7624. if (!content_provider(offset, length - offset, data_sink) || !ok) {
  7625. return false;
  7626. }
  7627. // No Stream to block on here, so a provider that keeps returning true
  7628. // without writing would spin. Treat a pass that made no progress as a
  7629. // failure.
  7630. if (offset == prev_offset) { return false; }
  7631. }
  7632. if (offset != length) { return false; }
  7633. return cmp.compress(nullptr, 0, true, append);
  7634. }
  7635. // Serves `m` as the response body. `set_content_provider()` clears the coding
  7636. // and the file flag, so recording them has to come after; keeping all of it
  7637. // here means a third file-serving path cannot get that order wrong.
  7638. inline void set_file_content_provider(Response &res,
  7639. const std::shared_ptr<mmap> &m,
  7640. const std::string &content_type,
  7641. EncodingType encoding) {
  7642. // One read and one write move up to this much of the file at a time.
  7643. auto buf = std::make_shared<std::vector<char>>(
  7644. (std::min)(m->size(), size_t(256 * 1024)));
  7645. res.set_content_provider(
  7646. m->size(), content_type,
  7647. [m, buf](size_t offset, size_t length, DataSink &sink) -> bool {
  7648. // Never read past the file, which ends the response early if it has
  7649. // shrunk since it was opened.
  7650. auto n = m->read(offset, buf->data(), (std::min)(length, buf->size()));
  7651. if (n == 0) { return false; }
  7652. sink.write(buf->data(), n);
  7653. return true;
  7654. });
  7655. res.is_file_content_provider_ = true;
  7656. res.content_coding_ = encoding;
  7657. }
  7658. template <typename T, typename U>
  7659. inline bool
  7660. write_content_chunked(Stream &strm, const ContentProvider &content_provider,
  7661. const T &is_shutting_down, U &compressor, Error &error) {
  7662. size_t offset = 0;
  7663. auto data_available = true;
  7664. auto ok = true;
  7665. DataSink data_sink;
  7666. data_sink.write = [&](const char *d, size_t l) -> bool {
  7667. // Only done()/done_with_trailer() end a chunked body. A pass with nothing
  7668. // to hand over is ordinary (an empty buffer popped off a queue), and a
  7669. // zero-length chunk is the terminator, so it must not be emitted here.
  7670. if (ok && l > 0) {
  7671. offset += l;
  7672. std::string payload;
  7673. if (compressor.compress(d, l, false,
  7674. [&](const char *data, size_t data_len) {
  7675. payload.append(data, data_len);
  7676. return true;
  7677. })) {
  7678. if (!payload.empty()) {
  7679. // Emit chunked response header and footer for each chunk
  7680. auto chunk =
  7681. from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7682. if (!write_data(strm, chunk.data(), chunk.size())) { ok = false; }
  7683. }
  7684. } else {
  7685. ok = false;
  7686. }
  7687. }
  7688. return ok;
  7689. };
  7690. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7691. auto done_with_trailer = [&](const Headers *trailer) {
  7692. if (!ok) { return; }
  7693. data_available = false;
  7694. std::string payload;
  7695. if (!compressor.compress(nullptr, 0, true,
  7696. [&](const char *data, size_t data_len) {
  7697. payload.append(data, data_len);
  7698. return true;
  7699. })) {
  7700. ok = false;
  7701. return;
  7702. }
  7703. if (!payload.empty()) {
  7704. // Emit chunked response header and footer for each chunk
  7705. auto chunk = from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7706. if (!write_data(strm, chunk.data(), chunk.size())) {
  7707. ok = false;
  7708. return;
  7709. }
  7710. }
  7711. constexpr const char done_marker[] = "0\r\n";
  7712. if (!write_data(strm, done_marker, str_len(done_marker))) { ok = false; }
  7713. // Trailer
  7714. if (trailer) {
  7715. for (const auto &kv : *trailer) {
  7716. // Skip fields with invalid names or values to prevent response
  7717. // splitting via CR/LF injection, matching set_header().
  7718. if (!fields::is_field_valid(kv.first, kv.second)) { continue; }
  7719. std::string field_line = kv.first + ": " + kv.second + "\r\n";
  7720. if (!write_data(strm, field_line.data(), field_line.size())) {
  7721. ok = false;
  7722. }
  7723. }
  7724. }
  7725. constexpr const char crlf[] = "\r\n";
  7726. if (!write_data(strm, crlf, str_len(crlf))) { ok = false; }
  7727. };
  7728. data_sink.done = [&](void) { done_with_trailer(nullptr); };
  7729. data_sink.done_with_trailer = [&](const Headers &trailer) {
  7730. done_with_trailer(&trailer);
  7731. };
  7732. while (data_available && !is_shutting_down()) {
  7733. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7734. error = Error::Write;
  7735. return false;
  7736. } else if (!content_provider(offset, 0, data_sink)) {
  7737. error = Error::Canceled;
  7738. return false;
  7739. } else if (!ok) {
  7740. error = Error::Write;
  7741. return false;
  7742. }
  7743. }
  7744. if (data_available) { // exited due to is_shutting_down(), not done()
  7745. error = Error::Write;
  7746. return false;
  7747. }
  7748. error = Error::Success;
  7749. return true;
  7750. }
  7751. template <typename T, typename U>
  7752. inline bool write_content_chunked(Stream &strm,
  7753. const ContentProvider &content_provider,
  7754. const T &is_shutting_down, U &compressor) {
  7755. auto error = Error::Success;
  7756. return write_content_chunked(strm, content_provider, is_shutting_down,
  7757. compressor, error);
  7758. }
  7759. template <typename T>
  7760. inline bool redirect(T &cli, Request &req, Response &res,
  7761. const std::string &path, const std::string &location,
  7762. Error &error) {
  7763. Request new_req = req;
  7764. new_req.path = path;
  7765. new_req.redirect_count_ -= 1;
  7766. if (res.status == StatusCode::SeeOther_303 &&
  7767. (req.method != "GET" && req.method != "HEAD")) {
  7768. new_req.method = "GET";
  7769. new_req.body.clear();
  7770. new_req.headers.clear();
  7771. new_req.content_length_ = 0;
  7772. new_req.content_provider_ = nullptr;
  7773. new_req.is_chunked_content_provider_ = false;
  7774. }
  7775. Response new_res;
  7776. auto ret = cli.send(new_req, new_res, error);
  7777. if (ret) {
  7778. req = std::move(new_req);
  7779. res = std::move(new_res);
  7780. if (res.location.empty()) { res.location = location; }
  7781. }
  7782. return ret;
  7783. }
  7784. inline std::string params_to_query_str(const Params &params) {
  7785. std::string query;
  7786. for (auto it = params.begin(); it != params.end(); ++it) {
  7787. if (it != params.begin()) { query += '&'; }
  7788. query += encode_query_component(it->first);
  7789. query += '=';
  7790. query += encode_query_component(it->second);
  7791. }
  7792. return query;
  7793. }
  7794. // Splits one "key=value" span of a query string at its first '='. A span with
  7795. // no '=' at all lands entirely in key, leaving val empty, which is how a bare
  7796. // "?flag" keeps its name.
  7797. inline void divide_query_pair(const char *b, const char *e, std::string &key,
  7798. std::string &val) {
  7799. divide(b, static_cast<std::size_t>(e - b), '=',
  7800. [&](const char *lhs_data, std::size_t lhs_size, const char *rhs_data,
  7801. std::size_t rhs_size) {
  7802. key.assign(lhs_data, lhs_size);
  7803. val.assign(rhs_data, rhs_size);
  7804. });
  7805. }
  7806. inline void parse_query_text(const char *data, std::size_t size,
  7807. Params &params) {
  7808. std::set<std::string> cache;
  7809. split(data, data + size, '&', [&](const char *b, const char *e) {
  7810. std::string kv(b, e);
  7811. if (cache.find(kv) != cache.end()) { return; }
  7812. cache.insert(std::move(kv));
  7813. std::string key;
  7814. std::string val;
  7815. divide_query_pair(b, e, key, val);
  7816. if (!key.empty()) {
  7817. params.emplace(decode_query_component(key), decode_query_component(val));
  7818. }
  7819. });
  7820. }
  7821. inline void parse_query_text(const std::string &s, Params &params) {
  7822. parse_query_text(s.data(), s.size(), params);
  7823. }
  7824. // Normalize a query string by decoding and re-encoding each key/value pair
  7825. // while preserving the original parameter order. This avoids double-encoding
  7826. // and ensures consistent encoding. It works on the raw string rather than
  7827. // parsing into Params and re-serializing, because that round trip cannot
  7828. // reproduce the input: params_to_query_str() always emits '=', so a bare
  7829. // "flag" would come back as "flag=", and parse_query_text() drops exactly
  7830. // duplicated pairs.
  7831. inline std::string normalize_query_string(const std::string &query) {
  7832. std::string result;
  7833. split(query.data(), query.data() + query.size(), '&',
  7834. [&](const char *b, const char *e) {
  7835. std::string key;
  7836. std::string val;
  7837. divide_query_pair(b, e, key, val);
  7838. if (!key.empty()) {
  7839. auto dec_key = decode_query_component(key);
  7840. auto dec_val = decode_query_component(val);
  7841. if (!result.empty()) { result += '&'; }
  7842. result += encode_query_component(dec_key);
  7843. if (!val.empty() || std::find(b, e, '=') != e) {
  7844. result += '=';
  7845. result += encode_query_component(dec_val);
  7846. }
  7847. }
  7848. });
  7849. return result;
  7850. }
  7851. // The query of a client's path: what follows '?', up to the fragment.
  7852. inline std::string query_of(const std::string &path) {
  7853. auto fragment_pos = path.find('#');
  7854. auto query_pos = path.find('?');
  7855. return query_pos < fragment_pos
  7856. ? path.substr(query_pos + 1, fragment_pos - query_pos - 1)
  7857. : std::string();
  7858. }
  7859. // Build the request target that goes on the wire from a caller-supplied path.
  7860. // Shared by the buffered send path and the streaming API so that both put the
  7861. // same bytes in the request line for the same input.
  7862. inline std::string encode_request_target(const std::string &uri,
  7863. bool path_encode) {
  7864. // The fragment stays with the client (RFC 9110 §7.1).
  7865. auto target = uri.substr(0, uri.find('#'));
  7866. // `substr(0, npos)` yields the whole string, which is what the no-query
  7867. // case needs.
  7868. auto query_pos = target.find('?');
  7869. auto path_part = target.substr(0, query_pos);
  7870. std::string query_part;
  7871. if (query_pos != std::string::npos) {
  7872. query_part = target.substr(query_pos + 1);
  7873. }
  7874. auto result = path_encode ? encode_path(path_part) : std::move(path_part);
  7875. if (!query_part.empty()) {
  7876. // When path encoding is disabled the caller has supplied an already-encoded
  7877. // target and expects the exact bytes to be sent on the wire, so skip
  7878. // normalization for the query too. Normalizing would decode-then-re-encode
  7879. // it and corrupt pre-encoded binary payloads (e.g. turning `%20` into `+`,
  7880. // which a strict RFC 3986 server decodes back as `+`, not a space).
  7881. if (path_encode) {
  7882. auto normalized = normalize_query_string(query_part);
  7883. if (!normalized.empty()) {
  7884. result += '?';
  7885. result += normalized;
  7886. }
  7887. } else {
  7888. result += '?';
  7889. result += query_part;
  7890. }
  7891. }
  7892. return result;
  7893. }
  7894. inline bool parse_multipart_boundary(const std::string &content_type,
  7895. std::string &boundary) {
  7896. std::map<std::string, std::string> params;
  7897. extract_media_type(content_type, &params);
  7898. auto it = params.find("boundary");
  7899. if (it == params.end()) { return false; }
  7900. boundary = it->second;
  7901. // RFC 2046 5.1.1 caps a boundary at 70 characters. The parser scans the body
  7902. // for "--" + boundary, so a body crafted to repeat that delimiter's leading
  7903. // bytes costs a nearly full comparison at nearly every position: the
  7904. // boundary's length multiplies the worst-case cost of scanning a body.
  7905. return !boundary.empty() && boundary.size() <= 70;
  7906. }
  7907. inline void parse_disposition_params(const std::string &s, Params &params) {
  7908. std::set<std::string> cache;
  7909. split_unquoted(
  7910. s.data(), s.data() + s.size(), ';', [&](const char *b, const char *e) {
  7911. std::string kv(b, e);
  7912. if (cache.find(kv) != cache.end()) { return; }
  7913. cache.insert(kv);
  7914. std::string key;
  7915. std::string val;
  7916. divide_param_pair(b, e, key, val);
  7917. if (!key.empty()) {
  7918. params.emplace(trim_double_quotes_copy(key), unquote_param(val));
  7919. }
  7920. });
  7921. }
  7922. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7923. inline bool parse_range_header(const std::string &s, Ranges &ranges) {
  7924. #else
  7925. inline bool parse_range_header(const std::string &s, Ranges &ranges) try {
  7926. #endif
  7927. auto is_valid = [](const std::string &str) {
  7928. return std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  7929. };
  7930. if (s.size() > 7 && case_ignore::equal(s.substr(0, 6), "bytes=")) {
  7931. const auto pos = static_cast<size_t>(6);
  7932. const auto len = static_cast<size_t>(s.size() - 6);
  7933. auto all_valid_ranges = true;
  7934. split(&s[pos], &s[pos + len], ',', [&](const char *b, const char *e) {
  7935. if (!all_valid_ranges) { return; }
  7936. const auto it = std::find(b, e, '-');
  7937. if (it == e) {
  7938. all_valid_ranges = false;
  7939. return;
  7940. }
  7941. const auto lhs = std::string(b, it);
  7942. const auto rhs = std::string(it + 1, e);
  7943. if (!is_valid(lhs) || !is_valid(rhs)) {
  7944. all_valid_ranges = false;
  7945. return;
  7946. }
  7947. ssize_t first = -1;
  7948. if (!lhs.empty()) {
  7949. // Reject an overflowing first-byte-pos; treating it as absent (-1)
  7950. // would turn the range into a suffix range.
  7951. auto res =
  7952. detail::from_chars(lhs.data(), lhs.data() + lhs.size(), first);
  7953. if (res.ec != std::errc{}) {
  7954. all_valid_ranges = false;
  7955. return;
  7956. }
  7957. }
  7958. ssize_t last = -1;
  7959. if (!rhs.empty()) {
  7960. // An overflowing last-byte-pos is past any content length, so keeping
  7961. // -1 ("remainder", RFC 9110 14.1.2) is correct here.
  7962. ssize_t v;
  7963. auto res = detail::from_chars(rhs.data(), rhs.data() + rhs.size(), v);
  7964. if (res.ec == std::errc{}) { last = v; }
  7965. }
  7966. if ((first == -1 && last == -1) ||
  7967. (first != -1 && last != -1 && first > last)) {
  7968. all_valid_ranges = false;
  7969. return;
  7970. }
  7971. ranges.emplace_back(first, last);
  7972. });
  7973. return all_valid_ranges && !ranges.empty();
  7974. }
  7975. return false;
  7976. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7977. }
  7978. #else
  7979. } catch (...) { return false; }
  7980. #endif
  7981. // Removes each quoted-string, honoring a quoted-pair (RFC 9110 Section 5.6.4)
  7982. inline std::string remove_quoted_strings(const std::string &s) {
  7983. std::string out;
  7984. auto in_quotes = false;
  7985. for (size_t i = 0; i < s.size(); i++) {
  7986. if (s[i] == '"') {
  7987. in_quotes = !in_quotes;
  7988. } else if (!in_quotes) {
  7989. out += s[i];
  7990. } else if (s[i] == '\\') {
  7991. i++;
  7992. }
  7993. }
  7994. return out;
  7995. }
  7996. inline bool parse_accept_header(const std::string &s,
  7997. std::vector<std::string> &content_types) {
  7998. // Parameter values are not used here, so a quoted-string is dropped rather
  7999. // than parsed: a ',' or ';' inside one must not be read as a delimiter.
  8000. if (s.find('"') != std::string::npos) {
  8001. return parse_accept_header(remove_quoted_strings(s), content_types);
  8002. }
  8003. content_types.clear();
  8004. // Empty string is considered valid (no preference)
  8005. if (s.empty()) { return true; }
  8006. struct AcceptEntry {
  8007. std::string media_type;
  8008. double quality;
  8009. int order;
  8010. };
  8011. std::vector<AcceptEntry> entries;
  8012. int order = 0;
  8013. bool has_invalid_entry = false;
  8014. // Split by comma and parse each entry. RFC 9110 Section 5.6.1.2: a recipient
  8015. // has to parse and ignore empty list elements, so a leading, trailing or
  8016. // doubled comma must not turn a legal Accept value into 400 Bad Request.
  8017. // split() skips them, and the header length limit bounds how many a sender
  8018. // can send, so ignoring all of them cannot be used as a denial-of-service
  8019. // vector.
  8020. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  8021. std::string entry(b, e);
  8022. entry = trim_copy(entry);
  8023. AcceptEntry accept_entry;
  8024. accept_entry.order = order++;
  8025. if (!parse_quality(entry.data(), entry.data() + entry.size(),
  8026. accept_entry.media_type, accept_entry.quality)) {
  8027. has_invalid_entry = true;
  8028. return;
  8029. }
  8030. // Remove additional parameters from media type
  8031. accept_entry.media_type = extract_media_type(accept_entry.media_type);
  8032. // Basic validation of media type format
  8033. if (accept_entry.media_type.empty()) {
  8034. has_invalid_entry = true;
  8035. return;
  8036. }
  8037. // Check for basic media type format (should contain '/' or be '*')
  8038. if (accept_entry.media_type != "*" &&
  8039. accept_entry.media_type.find('/') == std::string::npos) {
  8040. has_invalid_entry = true;
  8041. return;
  8042. }
  8043. entries.push_back(std::move(accept_entry));
  8044. });
  8045. // Return false if any invalid entry was found
  8046. if (has_invalid_entry) { return false; }
  8047. // Sort by quality (descending), then by original order (ascending)
  8048. std::sort(entries.begin(), entries.end(),
  8049. [](const AcceptEntry &a, const AcceptEntry &b) {
  8050. if (a.quality != b.quality) {
  8051. return a.quality > b.quality; // Higher quality first
  8052. }
  8053. return a.order < b.order; // Earlier order first for same quality
  8054. });
  8055. // Extract sorted media types
  8056. content_types.reserve(entries.size());
  8057. for (auto &entry : entries) {
  8058. content_types.push_back(std::move(entry.media_type));
  8059. }
  8060. return true;
  8061. }
  8062. class FormDataParser {
  8063. public:
  8064. FormDataParser() = default;
  8065. void set_boundary(std::string &&boundary) {
  8066. boundary_ = std::move(boundary);
  8067. dash_boundary_crlf_ = dash_ + boundary_ + crlf_;
  8068. crlf_dash_boundary_ = crlf_ + dash_ + boundary_;
  8069. }
  8070. bool is_valid() const { return is_valid_; }
  8071. bool parse(const char *buf, size_t n, const FormDataHeader &header_callback,
  8072. const ContentReceiver &content_callback) {
  8073. // Once the close delimiter has been seen the rest of the body is epilogue
  8074. // to be discarded (RFC 2046). Drop it without buffering so a large epilogue
  8075. // spread across reads is not copied in only to be erased right away.
  8076. if (state_ == 5) { return true; }
  8077. buf_append(buf, n);
  8078. while (buf_size() > 0) {
  8079. switch (state_) {
  8080. case 0: { // Initial boundary
  8081. auto pos = buf_find(dash_boundary_crlf_);
  8082. if (pos == buf_size()) {
  8083. // Not found yet: keep only a possible partial boundary at the tail so
  8084. // that a body which never contains the boundary cannot grow the
  8085. // buffer (and get rescanned from the start) without bound.
  8086. auto keep = dash_boundary_crlf_.size() - 1;
  8087. if (buf_size() > keep) { buf_erase(buf_size() - keep); }
  8088. return true;
  8089. }
  8090. buf_erase(pos + dash_boundary_crlf_.size());
  8091. state_ = 1;
  8092. break;
  8093. }
  8094. case 1: { // New entry
  8095. clear_file_info();
  8096. header_searched_ = 0;
  8097. state_ = 2;
  8098. break;
  8099. }
  8100. case 2: { // Headers
  8101. // Resume where the last call stopped looking, so that a line arriving
  8102. // a few bytes at a time is not searched from its start each time.
  8103. auto pos = buf_find(crlf_, header_searched_);
  8104. if (pos > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  8105. while (pos < buf_size()) {
  8106. // Empty line
  8107. if (pos == 0) {
  8108. if (!header_callback(file_)) {
  8109. is_valid_ = false;
  8110. return false;
  8111. }
  8112. buf_erase(crlf_.size());
  8113. state_ = 3;
  8114. break;
  8115. }
  8116. // Check header count limit
  8117. if (header_count_ >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  8118. is_valid_ = false;
  8119. return false;
  8120. }
  8121. header_count_++;
  8122. const auto header = buf_head(pos);
  8123. if (!parse_header(header.data(), header.data() + header.size(),
  8124. [&](const std::string &, const std::string &) {})) {
  8125. is_valid_ = false;
  8126. return false;
  8127. }
  8128. // Parse and emplace space trimmed headers into a map
  8129. if (!parse_header(
  8130. header.data(), header.data() + header.size(),
  8131. [&](const std::string &key, const std::string &val) {
  8132. file_.headers.emplace(key, val);
  8133. })) {
  8134. is_valid_ = false;
  8135. return false;
  8136. }
  8137. constexpr const char header_content_type[] = "Content-Type:";
  8138. if (start_with_case_ignore(header, header_content_type)) {
  8139. file_.content_type =
  8140. trim_copy(header.substr(str_len(header_content_type)));
  8141. } else {
  8142. std::string disposition_params;
  8143. if (parse_content_disposition(header, disposition_params)) {
  8144. Params params;
  8145. parse_disposition_params(disposition_params, params);
  8146. auto it = params.find("name");
  8147. if (it != params.end()) {
  8148. file_.name = it->second;
  8149. } else {
  8150. is_valid_ = false;
  8151. return false;
  8152. }
  8153. it = params.find("filename");
  8154. if (it != params.end()) { file_.filename = it->second; }
  8155. it = params.find("filename*");
  8156. if (it != params.end()) {
  8157. // RFC 5987: only UTF-8 encoding is allowed
  8158. const auto &val = it->second;
  8159. constexpr const char utf8_prefix[] = "UTF-8''";
  8160. constexpr size_t prefix_len = str_len(utf8_prefix);
  8161. if (val.size() > prefix_len &&
  8162. start_with_case_ignore(val, utf8_prefix)) {
  8163. file_.filename = decode_path_component(
  8164. val.substr(prefix_len)); // override...
  8165. } else {
  8166. is_valid_ = false;
  8167. return false;
  8168. }
  8169. }
  8170. }
  8171. }
  8172. buf_erase(pos + crlf_.size());
  8173. pos = buf_find(crlf_);
  8174. }
  8175. if (state_ != 3) {
  8176. // The CR of the CRLF may be the last byte so far.
  8177. header_searched_ = buf_size() > 0 ? buf_size() - 1 : 0;
  8178. return true;
  8179. }
  8180. break;
  8181. }
  8182. case 3: { // Body
  8183. if (crlf_dash_boundary_.size() > buf_size()) { return true; }
  8184. auto pos = buf_find(crlf_dash_boundary_);
  8185. if (pos < buf_size()) {
  8186. if (!content_callback(buf_data(), pos)) {
  8187. is_valid_ = false;
  8188. return false;
  8189. }
  8190. buf_erase(pos + crlf_dash_boundary_.size());
  8191. state_ = 4;
  8192. } else {
  8193. auto len = buf_size() - crlf_dash_boundary_.size();
  8194. if (len > 0) {
  8195. if (!content_callback(buf_data(), len)) {
  8196. is_valid_ = false;
  8197. return false;
  8198. }
  8199. buf_erase(len);
  8200. }
  8201. return true;
  8202. }
  8203. break;
  8204. }
  8205. case 4: { // Boundary
  8206. if (crlf_.size() > buf_size()) { return true; }
  8207. if (buf_start_with(crlf_)) {
  8208. buf_erase(crlf_.size());
  8209. state_ = 1;
  8210. } else if (buf_start_with(dash_)) {
  8211. buf_erase(dash_.size());
  8212. is_valid_ = true;
  8213. state_ = 5;
  8214. } else {
  8215. // Only CRLF (another part follows) and "--" (close-delimiter) are
  8216. // accepted after a boundary; RFC 2046 allows transport-padding in
  8217. // between, but this parser has never supported it. Either way the
  8218. // body is already destined to be rejected, so fail now instead of
  8219. // buffering the rest of it. Both are two bytes, so the check above
  8220. // already guarantees enough buffered data to decide.
  8221. is_valid_ = false;
  8222. return false;
  8223. }
  8224. break;
  8225. }
  8226. case 5: { // Epilogue
  8227. buf_erase(buf_size());
  8228. break;
  8229. }
  8230. }
  8231. }
  8232. return true;
  8233. }
  8234. private:
  8235. void clear_file_info() {
  8236. file_.name.clear();
  8237. file_.filename.clear();
  8238. file_.content_type.clear();
  8239. file_.headers.clear();
  8240. header_count_ = 0;
  8241. }
  8242. bool start_with_case_ignore(const std::string &a, const char *b,
  8243. size_t offset = 0) const {
  8244. const auto b_len = strlen(b);
  8245. if (a.size() < offset + b_len) { return false; }
  8246. for (size_t i = 0; i < b_len; i++) {
  8247. if (case_ignore::to_lower(a[offset + i]) != case_ignore::to_lower(b[i])) {
  8248. return false;
  8249. }
  8250. }
  8251. return true;
  8252. }
  8253. // Parses "Content-Disposition: form-data; <params>" without std::regex.
  8254. // Returns true if header matches, with the params portion in `params_out`.
  8255. bool parse_content_disposition(const std::string &header,
  8256. std::string &params_out) const {
  8257. constexpr const char prefix[] = "Content-Disposition:";
  8258. constexpr size_t prefix_len = str_len(prefix);
  8259. if (!start_with_case_ignore(header, prefix)) { return false; }
  8260. // Skip whitespace after "Content-Disposition:"
  8261. auto pos = prefix_len;
  8262. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8263. pos++;
  8264. }
  8265. // Match "form-data;" (case-insensitive)
  8266. constexpr const char form_data[] = "form-data;";
  8267. constexpr size_t form_data_len = str_len(form_data);
  8268. if (!start_with_case_ignore(header, form_data, pos)) { return false; }
  8269. pos += form_data_len;
  8270. // Skip whitespace after "form-data;"
  8271. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8272. pos++;
  8273. }
  8274. params_out = header.substr(pos);
  8275. return true;
  8276. }
  8277. const std::string dash_ = "--";
  8278. const std::string crlf_ = "\r\n";
  8279. std::string boundary_;
  8280. std::string dash_boundary_crlf_;
  8281. std::string crlf_dash_boundary_;
  8282. size_t state_ = 0;
  8283. bool is_valid_ = false;
  8284. FormData file_;
  8285. size_t header_count_ = 0;
  8286. size_t header_searched_ = 0;
  8287. // Buffer
  8288. bool start_with(const std::string &a, size_t spos, size_t epos,
  8289. const std::string &b) const {
  8290. if (epos - spos < b.size()) { return false; }
  8291. for (size_t i = 0; i < b.size(); i++) {
  8292. if (a[i + spos] != b[i]) { return false; }
  8293. }
  8294. return true;
  8295. }
  8296. size_t buf_size() const { return buf_epos_ - buf_spos_; }
  8297. const char *buf_data() const { return &buf_[buf_spos_]; }
  8298. std::string buf_head(size_t l) const { return buf_.substr(buf_spos_, l); }
  8299. bool buf_start_with(const std::string &s) const {
  8300. return start_with(buf_, buf_spos_, buf_epos_, s);
  8301. }
  8302. size_t buf_find(const std::string &s, size_t from = 0) const {
  8303. auto c = s.front();
  8304. size_t off = buf_spos_ + from;
  8305. while (off < buf_epos_) {
  8306. auto pos = off;
  8307. while (true) {
  8308. if (pos == buf_epos_) { return buf_size(); }
  8309. if (buf_[pos] == c) { break; }
  8310. pos++;
  8311. }
  8312. auto remaining_size = buf_epos_ - pos;
  8313. if (s.size() > remaining_size) { return buf_size(); }
  8314. if (start_with(buf_, pos, buf_epos_, s)) { return pos - buf_spos_; }
  8315. off = pos + 1;
  8316. }
  8317. return buf_size();
  8318. }
  8319. void buf_append(const char *data, size_t n) {
  8320. auto remaining_size = buf_size();
  8321. if (remaining_size > 0 && buf_spos_ > 0) {
  8322. for (size_t i = 0; i < remaining_size; i++) {
  8323. buf_[i] = buf_[buf_spos_ + i];
  8324. }
  8325. }
  8326. buf_spos_ = 0;
  8327. buf_epos_ = remaining_size;
  8328. if (remaining_size + n > buf_.size()) { buf_.resize(remaining_size + n); }
  8329. for (size_t i = 0; i < n; i++) {
  8330. buf_[buf_epos_ + i] = data[i];
  8331. }
  8332. buf_epos_ += n;
  8333. }
  8334. void buf_erase(size_t size) { buf_spos_ += size; }
  8335. std::string buf_;
  8336. size_t buf_spos_ = 0;
  8337. size_t buf_epos_ = 0;
  8338. };
  8339. inline std::string random_string(size_t length) {
  8340. constexpr const char data[] =
  8341. "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
  8342. std::string result(length, '\0');
  8343. fill_random_bytes(reinterpret_cast<unsigned char *>(&result[0]), length);
  8344. for (auto &c : result) {
  8345. c = data[static_cast<unsigned char>(c) % (sizeof(data) - 1)];
  8346. }
  8347. return result;
  8348. }
  8349. inline std::string make_multipart_data_boundary() {
  8350. return "--cpp-httplib-multipart-data-" + detail::random_string(16);
  8351. }
  8352. inline bool is_multipart_boundary_chars_valid(const std::string &boundary) {
  8353. auto valid = true;
  8354. for (size_t i = 0; i < boundary.size(); i++) {
  8355. auto c = boundary[i];
  8356. if (!is_ascii_alnum(c) && c != '-' && c != '_') {
  8357. valid = false;
  8358. break;
  8359. }
  8360. }
  8361. return valid;
  8362. }
  8363. // Escape a multipart field name/filename following the WHATWG HTML standard
  8364. // ("escape a multipart form-data name"): '"' -> %22, CR -> %0D, LF -> %0A.
  8365. // As the value is a quoted-string, '\' -> '\\' too, which browsers leave out.
  8366. // With quoted = false, only CR and LF are escaped; this is for header values
  8367. // outside a quoted-string (e.g. Content-Type), where '"' and '\' are legal.
  8368. inline std::string escape_multipart_field(const std::string &s,
  8369. bool quoted = true) {
  8370. std::string result;
  8371. result.reserve(s.size());
  8372. for (auto c : s) {
  8373. switch (c) {
  8374. case '"':
  8375. if (quoted) {
  8376. result += "%22";
  8377. } else {
  8378. result += c;
  8379. }
  8380. break;
  8381. case '\\':
  8382. // A lone backslash would escape the character after it (RFC 9110
  8383. // 5.6.4).
  8384. if (quoted) { result += '\\'; }
  8385. result += c;
  8386. break;
  8387. case '\r': result += "%0D"; break;
  8388. case '\n': result += "%0A"; break;
  8389. default: result += c; break;
  8390. }
  8391. }
  8392. return result;
  8393. }
  8394. template <typename T>
  8395. inline std::string
  8396. serialize_multipart_formdata_item_begin(const T &item,
  8397. const std::string &boundary) {
  8398. std::string body = "--" + boundary + "\r\n";
  8399. body += "Content-Disposition: form-data; name=\"" +
  8400. escape_multipart_field(item.name) + "\"";
  8401. if (!item.filename.empty()) {
  8402. body += "; filename=\"" + escape_multipart_field(item.filename) + "\"";
  8403. }
  8404. body += "\r\n";
  8405. if (!item.content_type.empty()) {
  8406. body +=
  8407. "Content-Type: " + escape_multipart_field(item.content_type, false) +
  8408. "\r\n";
  8409. }
  8410. body += "\r\n";
  8411. return body;
  8412. }
  8413. inline std::string serialize_multipart_formdata_item_end() { return "\r\n"; }
  8414. inline std::string
  8415. serialize_multipart_formdata_finish(const std::string &boundary) {
  8416. return "--" + boundary + "--\r\n";
  8417. }
  8418. inline std::string
  8419. serialize_multipart_formdata_get_content_type(const std::string &boundary) {
  8420. return "multipart/form-data; boundary=" + boundary;
  8421. }
  8422. inline std::string
  8423. serialize_multipart_formdata(const UploadFormDataItems &items,
  8424. const std::string &boundary, bool finish = true) {
  8425. std::string body;
  8426. for (const auto &item : items) {
  8427. body += serialize_multipart_formdata_item_begin(item, boundary);
  8428. body += item.content + serialize_multipart_formdata_item_end();
  8429. }
  8430. if (finish) { body += serialize_multipart_formdata_finish(boundary); }
  8431. return body;
  8432. }
  8433. inline size_t get_multipart_content_length(const UploadFormDataItems &items,
  8434. const std::string &boundary) {
  8435. size_t total = 0;
  8436. for (const auto &item : items) {
  8437. total += serialize_multipart_formdata_item_begin(item, boundary).size();
  8438. total += item.content.size();
  8439. total += serialize_multipart_formdata_item_end().size();
  8440. }
  8441. total += serialize_multipart_formdata_finish(boundary).size();
  8442. return total;
  8443. }
  8444. struct MultipartSegment {
  8445. const char *data;
  8446. size_t size;
  8447. };
  8448. // NOTE: items must outlive the returned ContentProvider
  8449. // (safe for synchronous use inside Post/Put/Patch)
  8450. inline ContentProvider
  8451. make_multipart_content_provider(const UploadFormDataItems &items,
  8452. const std::string &boundary) {
  8453. // Own the per-item header strings and the finish string
  8454. std::vector<std::string> owned;
  8455. owned.reserve(items.size() + 1);
  8456. for (const auto &item : items)
  8457. owned.push_back(serialize_multipart_formdata_item_begin(item, boundary));
  8458. owned.push_back(serialize_multipart_formdata_finish(boundary));
  8459. // Flat segment list: [header, content, "\r\n"] * N + [finish]
  8460. std::vector<MultipartSegment> segs;
  8461. segs.reserve(items.size() * 3 + 1);
  8462. static const char crlf[] = "\r\n";
  8463. for (size_t i = 0; i < items.size(); i++) {
  8464. segs.push_back({owned[i].data(), owned[i].size()});
  8465. segs.push_back({items[i].content.data(), items[i].content.size()});
  8466. segs.push_back({crlf, 2});
  8467. }
  8468. segs.push_back({owned.back().data(), owned.back().size()});
  8469. struct MultipartState {
  8470. std::vector<std::string> owned;
  8471. std::vector<MultipartSegment> segs;
  8472. std::vector<char> buf = std::vector<char>(CPPHTTPLIB_SEND_BUFSIZ);
  8473. };
  8474. auto state = std::make_shared<MultipartState>();
  8475. state->owned = std::move(owned);
  8476. // `segs` holds raw pointers into owned strings; std::string move preserves
  8477. // the data pointer, so these pointers remain valid after the move above.
  8478. state->segs = std::move(segs);
  8479. return [state](size_t offset, size_t length, DataSink &sink) -> bool {
  8480. // Buffer multiple small segments into fewer, larger writes to avoid
  8481. // excessive TCP packets when there are many form data items (#2410)
  8482. auto &buf = state->buf;
  8483. auto buf_size = buf.size();
  8484. size_t buf_len = 0;
  8485. size_t remaining = length;
  8486. // Find the first segment containing 'offset'
  8487. size_t pos = 0;
  8488. size_t seg_idx = 0;
  8489. for (; seg_idx < state->segs.size(); seg_idx++) {
  8490. const auto &seg = state->segs[seg_idx];
  8491. if (seg.size > 0 && offset - pos < seg.size) { break; }
  8492. pos += seg.size;
  8493. }
  8494. size_t seg_offset = (seg_idx < state->segs.size()) ? offset - pos : 0;
  8495. for (; seg_idx < state->segs.size() && remaining > 0; seg_idx++) {
  8496. const auto &seg = state->segs[seg_idx];
  8497. size_t available = seg.size - seg_offset;
  8498. size_t to_copy = (std::min)(available, remaining);
  8499. const char *src = seg.data + seg_offset;
  8500. seg_offset = 0; // only the first segment has a non-zero offset
  8501. while (to_copy > 0) {
  8502. size_t space = buf_size - buf_len;
  8503. size_t chunk = (std::min)(to_copy, space);
  8504. std::memcpy(buf.data() + buf_len, src, chunk);
  8505. buf_len += chunk;
  8506. src += chunk;
  8507. to_copy -= chunk;
  8508. remaining -= chunk;
  8509. if (buf_len == buf_size) {
  8510. if (!sink.write(buf.data(), buf_len)) { return false; }
  8511. buf_len = 0;
  8512. }
  8513. }
  8514. }
  8515. if (buf_len > 0) { return sink.write(buf.data(), buf_len); }
  8516. return true;
  8517. };
  8518. }
  8519. inline void coalesce_ranges(Ranges &ranges, size_t content_length) {
  8520. if (ranges.size() <= 1) return;
  8521. // Sort ranges by start position
  8522. std::sort(ranges.begin(), ranges.end(),
  8523. [](const Range &a, const Range &b) { return a.first < b.first; });
  8524. Ranges coalesced;
  8525. coalesced.reserve(ranges.size());
  8526. for (auto &r : ranges) {
  8527. auto first_pos = r.first;
  8528. auto last_pos = r.second;
  8529. // Handle special cases like in range_error
  8530. if (first_pos == -1 && last_pos == -1) {
  8531. first_pos = 0;
  8532. last_pos = static_cast<ssize_t>(content_length);
  8533. }
  8534. if (first_pos == -1) {
  8535. first_pos = static_cast<ssize_t>(content_length) - last_pos;
  8536. last_pos = static_cast<ssize_t>(content_length) - 1;
  8537. }
  8538. if (last_pos == -1 || last_pos >= static_cast<ssize_t>(content_length)) {
  8539. last_pos = static_cast<ssize_t>(content_length) - 1;
  8540. }
  8541. // Skip invalid ranges
  8542. if (!(0 <= first_pos && first_pos <= last_pos &&
  8543. last_pos < static_cast<ssize_t>(content_length))) {
  8544. continue;
  8545. }
  8546. // Coalesce with previous range if overlapping or adjacent (but not
  8547. // identical)
  8548. if (!coalesced.empty()) {
  8549. auto &prev = coalesced.back();
  8550. // Check if current range overlaps or is adjacent to previous range
  8551. // but don't coalesce identical ranges (allow duplicates)
  8552. if (first_pos <= prev.second + 1 &&
  8553. !(first_pos == prev.first && last_pos == prev.second)) {
  8554. // Extend the previous range
  8555. prev.second = (std::max)(prev.second, last_pos);
  8556. continue;
  8557. }
  8558. }
  8559. // Add new range
  8560. coalesced.emplace_back(first_pos, last_pos);
  8561. }
  8562. ranges = std::move(coalesced);
  8563. }
  8564. inline bool range_error(Request &req, Response &res) {
  8565. if (!req.ranges.empty() && 200 <= res.status && res.status < 300) {
  8566. if (res.body.empty() && res.content_provider_ && res.content_length_ == 0) {
  8567. req.ranges.clear();
  8568. if (res.status == StatusCode::PartialContent_206) {
  8569. res.status = StatusCode::OK_200;
  8570. }
  8571. return false;
  8572. }
  8573. ssize_t content_len = static_cast<ssize_t>(
  8574. res.content_length_ ? res.content_length_ : res.body.size());
  8575. std::vector<std::pair<ssize_t, ssize_t>> processed_ranges;
  8576. size_t overwrapping_count = 0;
  8577. // NOTE: The following Range check is based on '14.2. Range' in RFC 9110
  8578. // 'HTTP Semantics' to avoid potential denial-of-service attacks.
  8579. // https://www.rfc-editor.org/rfc/rfc9110#section-14.2
  8580. // Too many ranges
  8581. if (CPPHTTPLIB_RANGE_MAX_COUNT > 0 &&
  8582. req.ranges.size() > CPPHTTPLIB_RANGE_MAX_COUNT) {
  8583. return true;
  8584. }
  8585. for (auto &r : req.ranges) {
  8586. auto &first_pos = r.first;
  8587. auto &last_pos = r.second;
  8588. if (first_pos == -1 && last_pos == -1) {
  8589. first_pos = 0;
  8590. last_pos = content_len;
  8591. }
  8592. // RFC 9110 14.1.2: a suffix-length longer than the representation
  8593. // selects the entire representation.
  8594. if (first_pos == -1) {
  8595. first_pos = (std::max)(static_cast<ssize_t>(0), content_len - last_pos);
  8596. last_pos = content_len - 1;
  8597. }
  8598. // NOTE: RFC-9110 '14.1.2. Byte Ranges':
  8599. // A client can limit the number of bytes requested without knowing the
  8600. // size of the selected representation. If the last-pos value is absent,
  8601. // or if the value is greater than or equal to the current length of the
  8602. // representation data, the byte range is interpreted as the remainder of
  8603. // the representation (i.e., the server replaces the value of last-pos
  8604. // with a value that is one less than the current length of the selected
  8605. // representation).
  8606. // https://www.rfc-editor.org/rfc/rfc9110.html#section-14.1.2-6
  8607. if (last_pos == -1 || last_pos >= content_len) {
  8608. last_pos = content_len - 1;
  8609. }
  8610. // Range must be within content length
  8611. if (!(0 <= first_pos && first_pos <= last_pos &&
  8612. last_pos <= content_len - 1)) {
  8613. return true;
  8614. }
  8615. // Request must not have more than two overlapping ranges
  8616. for (const auto &processed_range : processed_ranges) {
  8617. if (!(last_pos < processed_range.first ||
  8618. first_pos > processed_range.second)) {
  8619. overwrapping_count++;
  8620. if (overwrapping_count > 2) { return true; }
  8621. break; // Only count once per range
  8622. }
  8623. }
  8624. processed_ranges.emplace_back(first_pos, last_pos);
  8625. }
  8626. // After validation, coalesce overlapping ranges as per RFC 9110
  8627. coalesce_ranges(req.ranges, static_cast<size_t>(content_len));
  8628. }
  8629. return false;
  8630. }
  8631. inline std::pair<size_t, size_t>
  8632. get_range_offset_and_length(Range r, size_t content_length) {
  8633. assert(r.first != -1 && r.second != -1);
  8634. assert(0 <= r.first && r.first < static_cast<ssize_t>(content_length));
  8635. assert(r.first <= r.second &&
  8636. r.second < static_cast<ssize_t>(content_length));
  8637. (void)(content_length);
  8638. return std::make_pair(static_cast<size_t>(r.first),
  8639. static_cast<size_t>(r.second - r.first) + 1);
  8640. }
  8641. inline std::string make_content_range_header_field(
  8642. const std::pair<size_t, size_t> &offset_and_length, size_t content_length) {
  8643. auto st = offset_and_length.first;
  8644. auto ed = st + offset_and_length.second - 1;
  8645. std::string field = "bytes ";
  8646. field += std::to_string(st);
  8647. field += '-';
  8648. field += std::to_string(ed);
  8649. field += '/';
  8650. field += std::to_string(content_length);
  8651. return field;
  8652. }
  8653. template <typename SToken, typename CToken, typename Content>
  8654. bool process_multipart_ranges_data(const Request &req,
  8655. const std::string &boundary,
  8656. const std::string &content_type,
  8657. size_t content_length, SToken stoken,
  8658. CToken ctoken, Content content) {
  8659. for (size_t i = 0; i < req.ranges.size(); i++) {
  8660. ctoken("--");
  8661. stoken(boundary);
  8662. ctoken("\r\n");
  8663. if (!content_type.empty()) {
  8664. ctoken("Content-Type: ");
  8665. stoken(content_type);
  8666. ctoken("\r\n");
  8667. }
  8668. auto offset_and_length =
  8669. get_range_offset_and_length(req.ranges[i], content_length);
  8670. ctoken("Content-Range: ");
  8671. stoken(make_content_range_header_field(offset_and_length, content_length));
  8672. ctoken("\r\n");
  8673. ctoken("\r\n");
  8674. if (!content(offset_and_length.first, offset_and_length.second)) {
  8675. return false;
  8676. }
  8677. ctoken("\r\n");
  8678. }
  8679. ctoken("--");
  8680. stoken(boundary);
  8681. ctoken("--");
  8682. return true;
  8683. }
  8684. inline void make_multipart_ranges_data(const Request &req, Response &res,
  8685. const std::string &boundary,
  8686. const std::string &content_type,
  8687. size_t content_length,
  8688. std::string &data) {
  8689. process_multipart_ranges_data(
  8690. req, boundary, content_type, content_length,
  8691. [&](const std::string &token) { data += token; },
  8692. [&](const std::string &token) { data += token; },
  8693. [&](size_t offset, size_t length) {
  8694. assert(offset + length <= content_length);
  8695. data += res.body.substr(offset, length);
  8696. return true;
  8697. });
  8698. }
  8699. inline size_t get_multipart_ranges_data_length(const Request &req,
  8700. const std::string &boundary,
  8701. const std::string &content_type,
  8702. size_t content_length) {
  8703. size_t data_length = 0;
  8704. process_multipart_ranges_data(
  8705. req, boundary, content_type, content_length,
  8706. [&](const std::string &token) { data_length += token.size(); },
  8707. [&](const std::string &token) { data_length += token.size(); },
  8708. [&](size_t /*offset*/, size_t length) {
  8709. data_length += length;
  8710. return true;
  8711. });
  8712. return data_length;
  8713. }
  8714. template <typename T>
  8715. inline bool
  8716. write_multipart_ranges_data(Stream &strm, const Request &req, Response &res,
  8717. const std::string &boundary,
  8718. const std::string &content_type,
  8719. size_t content_length, const T &is_shutting_down) {
  8720. return process_multipart_ranges_data(
  8721. req, boundary, content_type, content_length,
  8722. [&](const std::string &token) { strm.write(token); },
  8723. [&](const std::string &token) { strm.write(token); },
  8724. [&](size_t offset, size_t length) {
  8725. return write_content(strm, res.content_provider_, offset, length,
  8726. is_shutting_down);
  8727. });
  8728. }
  8729. inline bool has_framed_body(const Request &req) {
  8730. return is_chunked_transfer_encoding(req.headers) ||
  8731. req.get_header_value_u64("Content-Length") > 0;
  8732. }
  8733. inline bool is_connection_persistent(const Request &req) {
  8734. if (has_header_token(req.headers, "Connection", "close")) { return false; }
  8735. if (req.version == "HTTP/1.0" &&
  8736. !has_header_token(req.headers, "Connection", "keep-alive")) {
  8737. return false;
  8738. }
  8739. return true;
  8740. }
  8741. inline bool expect_content(const Request &req) {
  8742. if (req.method == "POST" || req.method == "PUT" || req.method == "PATCH" ||
  8743. req.method == "DELETE") {
  8744. return true;
  8745. }
  8746. return has_framed_body(req);
  8747. }
  8748. #ifdef _WIN32
  8749. class WSInit {
  8750. public:
  8751. WSInit() {
  8752. WSADATA wsaData;
  8753. if (WSAStartup(0x0002, &wsaData) == 0) is_valid_ = true;
  8754. }
  8755. ~WSInit() {
  8756. if (is_valid_) WSACleanup();
  8757. }
  8758. bool is_valid_ = false;
  8759. };
  8760. static WSInit wsinit_;
  8761. #endif
  8762. inline std::string unescape_quoted_pairs(const std::string &s) {
  8763. std::string out;
  8764. out.reserve(s.size());
  8765. for (size_t i = 0; i < s.size(); i++) {
  8766. if (s[i] == '\\' && i + 1 < s.size()) {
  8767. out += s[++i];
  8768. } else {
  8769. out += s[i];
  8770. }
  8771. }
  8772. return out;
  8773. }
  8774. // Inverse of unescape_quoted_pairs: prepares a value to sit inside a
  8775. // quoted-string. RFC 9110 §5.6.4 requires a literal '\' or '"' to be sent as a
  8776. // quoted-pair, so the recipient recovers the original value.
  8777. inline std::string escape_quoted_pairs(const std::string &s) {
  8778. std::string out;
  8779. out.reserve(s.size());
  8780. for (auto c : s) {
  8781. if (c == '\\' || c == '"') { out += '\\'; }
  8782. out += c;
  8783. }
  8784. return out;
  8785. }
  8786. // RFC 9110 Section 11.6.1 defines a challenge list as
  8787. // WWW-Authenticate = #challenge
  8788. // challenge = auth-scheme [ 1*SP ( token68 / [ #auth-param ] ) ]
  8789. // auth-param = token BWS "=" BWS ( token / quoted-string )
  8790. // so a server may offer several schemes, each with its own comma-separated
  8791. // auth-param list, in either order and either as separate field lines or
  8792. // packed into one. Splitting on every comma would break apart a challenge's
  8793. // own param list; splitting only on the first space would miss a Digest
  8794. // challenge that isn't first. Split on commas that aren't inside a
  8795. // quoted-string instead (split_unquoted), then track which scheme each
  8796. // resulting segment belongs to: a segment whose text before "=" contains
  8797. // whitespace (or that has no "=" at all) starts a new challenge named by its
  8798. // leading token.
  8799. inline bool parse_www_authenticate(const Response &res,
  8800. std::map<std::string, std::string> &auth,
  8801. bool is_proxy) {
  8802. auto auth_key = is_proxy ? "Proxy-Authenticate" : "WWW-Authenticate";
  8803. auto combined = get_combined_header_value(res.headers, auth_key);
  8804. if (combined.empty()) { return false; }
  8805. auto found_digest = false;
  8806. auto in_digest_challenge = false;
  8807. split_unquoted(
  8808. combined.data(), combined.data() + combined.size(), ',',
  8809. [&](const char *b, const char *e) {
  8810. std::string segment(b, e);
  8811. auto eq_pos = segment.find('=');
  8812. // BWS is allowed on both sides of "=", so the text naming the key (or,
  8813. // for the first segment of a challenge, "<scheme> <key>") must be
  8814. // trimmed before its boundaries are inspected.
  8815. auto key_part = trim_copy(
  8816. eq_pos == std::string::npos ? segment : segment.substr(0, eq_pos));
  8817. auto space_pos = key_part.find_last_of(" \t");
  8818. if (space_pos != std::string::npos || eq_pos == std::string::npos) {
  8819. // "<scheme>[ <key>]" starts a new challenge.
  8820. auto scheme_end =
  8821. space_pos == std::string::npos ? key_part.size() : space_pos;
  8822. // RFC 7616 Section 3.7: a server may offer more than one Digest
  8823. // challenge (e.g. SHA-256 and MD5); keep only the first so a nonce
  8824. // from one challenge is never paired with another's algorithm.
  8825. in_digest_challenge =
  8826. !found_digest &&
  8827. case_ignore::equal(key_part.substr(0, scheme_end), "Digest");
  8828. if (in_digest_challenge) { found_digest = true; }
  8829. if (space_pos == std::string::npos) {
  8830. // Bare scheme (or a token68), no auth-param on this segment.
  8831. return;
  8832. }
  8833. key_part = key_part.substr(space_pos + 1);
  8834. }
  8835. if (!in_digest_challenge) { return; }
  8836. auto val = trim_copy(segment.substr(eq_pos + 1));
  8837. auto unquoted = trim_double_quotes_copy(val);
  8838. if (unquoted.size() != val.size()) {
  8839. unquoted = unescape_quoted_pairs(unquoted);
  8840. }
  8841. auth[std::move(key_part)] = std::move(unquoted);
  8842. });
  8843. // RFC 7616 Section 3.3 requires realm and nonce on every Digest challenge;
  8844. // make_digest_authentication_header() dereferences both unconditionally, so
  8845. // a challenge missing either can't produce a usable Authorization header.
  8846. // Treat it the same as no Digest challenge at all.
  8847. return found_digest && auth.find("realm") != auth.end() &&
  8848. auth.find("nonce") != auth.end();
  8849. }
  8850. class ContentProviderAdapter {
  8851. public:
  8852. explicit ContentProviderAdapter(
  8853. ContentProviderWithoutLength &&content_provider)
  8854. : content_provider_(std::move(content_provider)) {}
  8855. bool operator()(size_t offset, size_t, DataSink &sink) {
  8856. return content_provider_(offset, sink);
  8857. }
  8858. private:
  8859. ContentProviderWithoutLength content_provider_;
  8860. };
  8861. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  8862. namespace fields {
  8863. inline bool is_token_char(char c) {
  8864. return is_ascii_alnum(c) || c == '!' || c == '#' || c == '$' || c == '%' ||
  8865. c == '&' || c == '\'' || c == '*' || c == '+' || c == '-' ||
  8866. c == '.' || c == '^' || c == '_' || c == '`' || c == '|' || c == '~';
  8867. }
  8868. inline bool is_token(const std::string &s) {
  8869. if (s.empty()) { return false; }
  8870. for (auto c : s) {
  8871. if (!is_token_char(c)) { return false; }
  8872. }
  8873. return true;
  8874. }
  8875. inline bool is_field_name(const std::string &s) { return is_token(s); }
  8876. inline bool is_vchar(char c) { return c >= 33 && c <= 126; }
  8877. inline bool is_obs_text(char c) { return 128 <= static_cast<unsigned char>(c); }
  8878. inline bool is_field_vchar(char c) { return is_vchar(c) || is_obs_text(c); }
  8879. inline bool is_field_content(const std::string &s) {
  8880. if (s.empty()) { return true; }
  8881. if (s.size() == 1) {
  8882. return is_field_vchar(s[0]);
  8883. } else if (s.size() == 2) {
  8884. return is_field_vchar(s[0]) && is_field_vchar(s[1]);
  8885. } else {
  8886. size_t i = 0;
  8887. if (!is_field_vchar(s[i])) { return false; }
  8888. i++;
  8889. while (i < s.size() - 1) {
  8890. auto c = s[i++];
  8891. if (c == ' ' || c == '\t' || is_field_vchar(c)) {
  8892. } else {
  8893. return false;
  8894. }
  8895. }
  8896. return is_field_vchar(s[i]);
  8897. }
  8898. }
  8899. inline bool is_field_value(const std::string &s) { return is_field_content(s); }
  8900. inline bool is_field_valid(const std::string &name, const std::string &value) {
  8901. return is_field_name(name) && is_field_value(value);
  8902. }
  8903. // RFC 9112 §2.2/§3.2: the request-target has no SP, HTAB or other control
  8904. // characters (incl. bare CR). obs-text (raw UTF-8) is allowed.
  8905. inline bool is_request_target(const std::string &s) {
  8906. return std::all_of(s.begin(), s.end(), is_field_vchar);
  8907. }
  8908. // RFC 9110 §7.2: the bytes of uri-host [ ":" port ], i.e. unreserved,
  8909. // sub-delims, "%", ":" and the IP-literal brackets. An empty value is valid.
  8910. inline bool is_host(const std::string &s) {
  8911. return std::all_of(s.begin(), s.end(), [](char c) {
  8912. return is_ascii_alnum(c) || c == '-' || c == '.' || c == '_' || c == '~' ||
  8913. c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  8914. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  8915. c == '=' || c == '%' || c == ':' || c == '[' || c == ']';
  8916. });
  8917. }
  8918. } // namespace fields
  8919. // Built in memory first, like ClientImpl::write_request, so a rejected header
  8920. // never leaves a partial request on the wire.
  8921. inline bool write_request_head(Stream &strm, Request &req, Error &error) {
  8922. BufferStream bstrm;
  8923. if (write_request_line(bstrm, req.method, req.path) < 0) {
  8924. error = Error::Write;
  8925. return false;
  8926. }
  8927. if (!check_and_write_headers(bstrm, req.headers, write_headers, error)) {
  8928. return false;
  8929. }
  8930. const auto &data = bstrm.get_buffer();
  8931. if (!write_data(strm, data.data(), data.size())) {
  8932. error = Error::Write;
  8933. return false;
  8934. }
  8935. return true;
  8936. }
  8937. inline bool perform_websocket_handshake(Stream &strm, Request &req,
  8938. WebSocketUpgradeResponse &upgrade) {
  8939. // Generate a random 16-byte Sec-WebSocket-Key (RFC 6455 Section 4.1)
  8940. std::string key_bytes(16, '\0');
  8941. fill_random_bytes(reinterpret_cast<unsigned char *>(&key_bytes[0]),
  8942. key_bytes.size());
  8943. auto client_key = base64_encode(key_bytes);
  8944. req.headers.erase("Upgrade");
  8945. req.headers.erase("Connection");
  8946. req.headers.erase("Sec-WebSocket-Key");
  8947. req.headers.erase("Sec-WebSocket-Version");
  8948. req.headers.emplace("Upgrade", "websocket");
  8949. req.headers.emplace("Connection", "Upgrade");
  8950. req.headers.emplace("Sec-WebSocket-Key", client_key);
  8951. req.headers.emplace("Sec-WebSocket-Version", "13");
  8952. if (!write_request_head(strm, req, upgrade.error)) { return false; }
  8953. // Verify 101 response and Sec-WebSocket-Accept header
  8954. auto expected_accept = websocket_accept_key(client_key);
  8955. auto offered_subprotocols =
  8956. get_combined_header_value(req.headers, "Sec-WebSocket-Protocol");
  8957. return read_websocket_upgrade_response(strm, expected_accept,
  8958. offered_subprotocols, upgrade);
  8959. }
  8960. inline bool is_ip_address(const std::string &host) {
  8961. struct in_addr addr4;
  8962. struct in6_addr addr6;
  8963. return inet_pton(AF_INET, host.c_str(), &addr4) == 1 ||
  8964. inet_pton(AF_INET6, host.c_str(), &addr6) == 1;
  8965. }
  8966. // Resolve where a client should connect for `host`, honoring a user-supplied
  8967. // hostname-to-address map. `host` itself is never rewritten, so it keeps
  8968. // supplying the Host header and SNI; only the connection target changes.
  8969. //
  8970. // A mapped IP literal goes to `ip`, which keeps create_socket's AI_NUMERICHOST
  8971. // path. Anything else goes to `connect_host`, which create_socket resolves as
  8972. // a name, or uses as the socket path when the address family is AF_UNIX. An
  8973. // absent or empty mapping leaves `host` as the connection target; without the
  8974. // empty check the value would reach getaddrinfo as a null node and silently
  8975. // resolve to loopback.
  8976. inline void apply_addr_map(const std::map<std::string, std::string> &addr_map,
  8977. const std::string &host, std::string &connect_host,
  8978. std::string &ip) {
  8979. connect_host = host;
  8980. ip.clear();
  8981. auto it = addr_map.find(host);
  8982. if (it == addr_map.end() || it->second.empty()) { return; }
  8983. if (is_ip_address(it->second)) {
  8984. ip = it->second;
  8985. } else {
  8986. connect_host = it->second;
  8987. }
  8988. }
  8989. } // namespace detail
  8990. /*
  8991. * Group 2: detail namespace - SSL common utilities
  8992. */
  8993. #ifdef CPPHTTPLIB_SSL_ENABLED
  8994. namespace detail {
  8995. class SSLSocketStream final : public Stream {
  8996. public:
  8997. SSLSocketStream(
  8998. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  8999. time_t read_timeout_usec, time_t write_timeout_sec,
  9000. time_t write_timeout_usec, time_t max_timeout_msec = 0,
  9001. std::chrono::time_point<std::chrono::steady_clock> start_time =
  9002. (std::chrono::steady_clock::time_point::min)());
  9003. ~SSLSocketStream() override;
  9004. bool is_readable() const override;
  9005. bool wait_readable() const override;
  9006. bool wait_writable() const override;
  9007. bool is_peer_alive() const override;
  9008. ssize_t read(char *ptr, size_t size) override;
  9009. ssize_t write(const char *ptr, size_t size) override;
  9010. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  9011. void get_local_ip_and_port(std::string &ip, int &port) const override;
  9012. socket_t socket() const override;
  9013. time_t duration() const override;
  9014. void set_read_timeout(time_t sec, time_t usec = 0) override;
  9015. void set_max_timeout(time_t msec) override;
  9016. void set_read_interrupt(std::function<bool()> interrupted) override;
  9017. // See SocketStream::set_readable_hint().
  9018. void set_readable_hint() { readable_hint_ = true; }
  9019. // The error from the last read() or write() that failed in the TLS layer,
  9020. // with code Success if none did
  9021. const tls::TlsError &tls_error() const { return tls_error_; }
  9022. private:
  9023. bool ensure_readable();
  9024. socket_t sock_;
  9025. tls::session_t session_;
  9026. time_t read_timeout_sec_;
  9027. time_t read_timeout_usec_;
  9028. time_t write_timeout_sec_;
  9029. time_t write_timeout_usec_;
  9030. time_t max_timeout_msec_;
  9031. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  9032. std::function<bool()> read_interrupted_;
  9033. bool readable_hint_ = false;
  9034. tls::TlsError tls_error_;
  9035. };
  9036. // A TLS stream for WebSocket connections, where the receive path and the
  9037. // send path (application send() plus the heartbeat ping thread) run on
  9038. // different threads. A single TLS session must never be entered
  9039. // concurrently, so every call into the session is serialized by one mutex.
  9040. //
  9041. // Unlike SSLSocketStream, the socket is kept non-blocking for the stream's
  9042. // whole lifetime and each read()/write() performs a single non-blocking TLS
  9043. // call under the lock, then waits for readiness with select() outside the
  9044. // lock. The lock is therefore held only for CPU-bound work, so a reader
  9045. // blocked waiting for data never stalls a concurrent sender.
  9046. //
  9047. // This stream is used only for wss:// connections. Plain ws:// and ordinary
  9048. // HTTP/HTTPS keep using SocketStream/SSLSocketStream unchanged.
  9049. class WebSocketSSLStream final : public Stream {
  9050. public:
  9051. WebSocketSSLStream(socket_t sock, tls::session_t session,
  9052. time_t read_timeout_sec, time_t read_timeout_usec,
  9053. time_t write_timeout_sec, time_t write_timeout_usec);
  9054. ~WebSocketSSLStream() override;
  9055. bool is_readable() const override;
  9056. bool wait_readable() const override;
  9057. bool wait_writable() const override;
  9058. ssize_t read(char *ptr, size_t size) override;
  9059. ssize_t write(const char *ptr, size_t size) override;
  9060. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  9061. void get_local_ip_and_port(std::string &ip, int &port) const override;
  9062. socket_t socket() const override;
  9063. time_t duration() const override;
  9064. void set_read_timeout(time_t sec, time_t usec = 0) override;
  9065. void set_read_interrupt(std::function<bool()> interrupted) override;
  9066. private:
  9067. mutable std::mutex session_mutex_;
  9068. socket_t sock_;
  9069. tls::session_t session_;
  9070. // WebSocket::close() shortens the read timeout from the closing thread
  9071. // while the receive thread is inside wait_readable(), so these two are read
  9072. // and written concurrently. The write timeouts are never mutated.
  9073. std::atomic<time_t> read_timeout_sec_;
  9074. std::atomic<time_t> read_timeout_usec_;
  9075. time_t write_timeout_sec_;
  9076. time_t write_timeout_usec_;
  9077. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  9078. std::function<bool()> read_interrupted_;
  9079. };
  9080. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  9081. inline std::string message_digest(const std::string &s, const EVP_MD *algo) {
  9082. auto context = std::unique_ptr<EVP_MD_CTX, decltype(&EVP_MD_CTX_free)>(
  9083. EVP_MD_CTX_new(), EVP_MD_CTX_free);
  9084. unsigned int hash_length = 0;
  9085. unsigned char hash[EVP_MAX_MD_SIZE];
  9086. EVP_DigestInit_ex(context.get(), algo, nullptr);
  9087. EVP_DigestUpdate(context.get(), s.c_str(), s.size());
  9088. EVP_DigestFinal_ex(context.get(), hash, &hash_length);
  9089. std::stringstream ss;
  9090. for (auto i = 0u; i < hash_length; ++i) {
  9091. ss << std::hex << std::setw(2) << std::setfill('0')
  9092. << static_cast<unsigned int>(hash[i]);
  9093. }
  9094. return ss.str();
  9095. }
  9096. inline std::string MD5(const std::string &s) {
  9097. return message_digest(s, EVP_md5());
  9098. }
  9099. inline std::string SHA_256(const std::string &s) {
  9100. return message_digest(s, EVP_sha256());
  9101. }
  9102. inline std::string SHA_512(const std::string &s) {
  9103. return message_digest(s, EVP_sha512());
  9104. }
  9105. #elif defined(CPPHTTPLIB_MBEDTLS_SUPPORT)
  9106. namespace {
  9107. template <size_t N>
  9108. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  9109. std::stringstream ss;
  9110. for (size_t i = 0; i < N; ++i) {
  9111. ss << std::hex << std::setw(2) << std::setfill('0')
  9112. << static_cast<unsigned int>(hash[i]);
  9113. }
  9114. return ss.str();
  9115. }
  9116. } // namespace
  9117. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9118. // Mbed TLS 4.x provides hashing (and TLS RNG) via PSA Crypto, which must be
  9119. // initialized once. PSA state is process-global; do not free it.
  9120. inline bool ensure_mbedtls_psa_crypto() {
  9121. static std::once_flag once;
  9122. static bool ok = false;
  9123. std::call_once(once, []() { ok = (psa_crypto_init() == PSA_SUCCESS); });
  9124. return ok;
  9125. }
  9126. inline bool psa_hash(psa_algorithm_t alg, const std::string &s,
  9127. unsigned char *out, size_t out_size) {
  9128. if (!ensure_mbedtls_psa_crypto()) { return false; }
  9129. size_t olen = 0;
  9130. return psa_hash_compute(alg, reinterpret_cast<const uint8_t *>(s.data()),
  9131. s.size(), out, out_size, &olen) == PSA_SUCCESS &&
  9132. olen == out_size;
  9133. }
  9134. #endif
  9135. inline std::string MD5(const std::string &s) {
  9136. unsigned char hash[16];
  9137. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9138. if (!psa_hash(PSA_ALG_MD5, s, hash, sizeof(hash))) { return {}; }
  9139. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9140. mbedtls_md5(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9141. hash);
  9142. #else
  9143. mbedtls_md5_ret(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9144. hash);
  9145. #endif
  9146. return hash_to_hex(hash);
  9147. }
  9148. inline std::string SHA_256(const std::string &s) {
  9149. unsigned char hash[32];
  9150. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9151. if (!psa_hash(PSA_ALG_SHA_256, s, hash, sizeof(hash))) { return {}; }
  9152. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9153. mbedtls_sha256(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9154. hash, 0);
  9155. #else
  9156. mbedtls_sha256_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9157. s.size(), hash, 0);
  9158. #endif
  9159. return hash_to_hex(hash);
  9160. }
  9161. inline std::string SHA_512(const std::string &s) {
  9162. unsigned char hash[64];
  9163. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9164. if (!psa_hash(PSA_ALG_SHA_512, s, hash, sizeof(hash))) { return {}; }
  9165. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9166. mbedtls_sha512(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9167. hash, 0);
  9168. #else
  9169. mbedtls_sha512_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9170. s.size(), hash, 0);
  9171. #endif
  9172. return hash_to_hex(hash);
  9173. }
  9174. #elif defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9175. namespace {
  9176. template <size_t N>
  9177. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  9178. std::stringstream ss;
  9179. for (size_t i = 0; i < N; ++i) {
  9180. ss << std::hex << std::setw(2) << std::setfill('0')
  9181. << static_cast<unsigned int>(hash[i]);
  9182. }
  9183. return ss.str();
  9184. }
  9185. } // namespace
  9186. inline std::string MD5(const std::string &s) {
  9187. unsigned char hash[WC_MD5_DIGEST_SIZE];
  9188. wc_Md5Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9189. static_cast<word32>(s.size()), hash);
  9190. return hash_to_hex(hash);
  9191. }
  9192. inline std::string SHA_256(const std::string &s) {
  9193. unsigned char hash[WC_SHA256_DIGEST_SIZE];
  9194. wc_Sha256Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9195. static_cast<word32>(s.size()), hash);
  9196. return hash_to_hex(hash);
  9197. }
  9198. inline std::string SHA_512(const std::string &s) {
  9199. unsigned char hash[WC_SHA512_DIGEST_SIZE];
  9200. wc_Sha512Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9201. static_cast<word32>(s.size()), hash);
  9202. return hash_to_hex(hash);
  9203. }
  9204. #endif
  9205. template <typename T>
  9206. inline bool process_server_socket_ssl(
  9207. const std::atomic<socket_t> &svr_sock, tls::session_t session,
  9208. socket_t sock, size_t keep_alive_max_count, time_t keep_alive_timeout_sec,
  9209. time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec,
  9210. time_t write_timeout_usec, T callback) {
  9211. // See process_server_socket(). The TLS library keeps already decrypted bytes
  9212. // of a pipelined request, which keep_alive() cannot see on the socket.
  9213. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9214. write_timeout_sec, write_timeout_usec);
  9215. return process_server_socket_core(
  9216. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  9217. [&]() { return strm.is_readable(); },
  9218. [&](bool socket_readable, bool close_connection,
  9219. bool &connection_closed) {
  9220. if (socket_readable) { strm.set_readable_hint(); }
  9221. return callback(strm, close_connection, connection_closed);
  9222. });
  9223. }
  9224. template <typename T>
  9225. inline bool process_client_socket_ssl(
  9226. tls::session_t session, socket_t sock, time_t read_timeout_sec,
  9227. time_t read_timeout_usec, time_t write_timeout_sec,
  9228. time_t write_timeout_usec, time_t max_timeout_msec,
  9229. std::chrono::time_point<std::chrono::steady_clock> start_time, T callback) {
  9230. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9231. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  9232. start_time);
  9233. return callback(strm);
  9234. }
  9235. // `uri` is req's request-target in origin form, as curl sends it, also when
  9236. // the request line carries the absolute form for a proxy.
  9237. inline std::pair<std::string, std::string> make_digest_authentication_header(
  9238. const Request &req, const std::string &uri,
  9239. const std::map<std::string, std::string> &auth, size_t cnonce_count,
  9240. const std::string &cnonce, const std::string &username,
  9241. const std::string &password, bool is_proxy = false) {
  9242. std::string nc;
  9243. {
  9244. std::stringstream ss;
  9245. ss << std::setfill('0') << std::setw(8) << std::hex << cnonce_count;
  9246. nc = ss.str();
  9247. }
  9248. std::string qop;
  9249. if (auth.find("qop") != auth.end()) {
  9250. qop = auth.at("qop");
  9251. if (qop.find("auth-int") != std::string::npos) {
  9252. qop = "auth-int";
  9253. } else if (qop.find("auth") != std::string::npos) {
  9254. qop = "auth";
  9255. } else {
  9256. qop.clear();
  9257. }
  9258. }
  9259. std::string algo = "MD5";
  9260. if (auth.find("algorithm") != auth.end()) {
  9261. // algorithm is an unquoted token (RFC 7616 §3.4). A server value that is
  9262. // not a token would otherwise be emitted verbatim and could carry commas
  9263. // or quotes that inject further auth-params into the header below.
  9264. const auto &a = auth.at("algorithm");
  9265. if (fields::is_token(a)) { algo = a; }
  9266. }
  9267. std::string response;
  9268. {
  9269. auto H = algo == "SHA-256" ? detail::SHA_256
  9270. : algo == "SHA-512" ? detail::SHA_512
  9271. : detail::MD5;
  9272. auto A1 = username + ":" + auth.at("realm") + ":" + password;
  9273. auto A2 = req.method + ":" + uri;
  9274. if (qop == "auth-int") { A2 += ":" + H(req.body); }
  9275. if (qop.empty()) {
  9276. response = H(H(A1) + ":" + auth.at("nonce") + ":" + H(A2));
  9277. } else {
  9278. response = H(H(A1) + ":" + auth.at("nonce") + ":" + nc + ":" + cnonce +
  9279. ":" + qop + ":" + H(A2));
  9280. }
  9281. }
  9282. auto opaque = (auth.find("opaque") != auth.end()) ? auth.at("opaque") : "";
  9283. // Every value placed inside a quoted-string is escaped so a '"' in it cannot
  9284. // close the string early. realm, nonce and opaque come straight from the
  9285. // server's challenge (parse_www_authenticate() already de-escaped them), so
  9286. // without this a crafted challenge injects extra auth-params into the header.
  9287. auto field =
  9288. "Digest username=\"" + detail::escape_quoted_pairs(username) +
  9289. "\", realm=\"" + detail::escape_quoted_pairs(auth.at("realm")) +
  9290. "\", nonce=\"" + detail::escape_quoted_pairs(auth.at("nonce")) +
  9291. "\", uri=\"" + detail::escape_quoted_pairs(uri) +
  9292. "\", algorithm=" + algo +
  9293. (qop.empty() ? ", response=\""
  9294. : ", qop=" + qop + ", nc=" + nc + ", cnonce=\"" + cnonce +
  9295. "\", response=\"") +
  9296. response + "\"" +
  9297. (opaque.empty()
  9298. ? ""
  9299. : ", opaque=\"" + detail::escape_quoted_pairs(opaque) + "\"");
  9300. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9301. return std::make_pair(key, field);
  9302. }
  9303. // Follows X509_check_host, which the OpenSSL backend uses, so that every
  9304. // backend accepts the same names.
  9305. inline bool match_hostname(const std::string &pattern,
  9306. const std::string &hostname) {
  9307. // A trailing dot on the host is ignored
  9308. auto host = hostname;
  9309. if (host.size() > 1 && host.back() == '.') { host.pop_back(); }
  9310. // Exact match (case-insensitive)
  9311. if (detail::case_ignore::equal(host, pattern)) { return true; }
  9312. // Split both pattern and hostname into components by '.', keeping any empty
  9313. // one, which no name may have
  9314. auto labels = [](const std::string &s) {
  9315. std::vector<std::string> v;
  9316. size_t b = 0;
  9317. while (true) {
  9318. auto e = s.find('.', b);
  9319. v.push_back(s.substr(b, e - b));
  9320. if (e == std::string::npos) { return v; }
  9321. b = e + 1;
  9322. }
  9323. };
  9324. auto pattern_components = labels(pattern);
  9325. auto host_components = labels(host);
  9326. auto has_empty_label = [](const std::vector<std::string> &v) {
  9327. return std::any_of(v.begin(), v.end(),
  9328. [](const std::string &l) { return l.empty(); });
  9329. };
  9330. if (has_empty_label(pattern_components) || has_empty_label(host_components)) {
  9331. return false;
  9332. }
  9333. // Component count must match
  9334. if (host_components.size() != pattern_components.size()) { return false; }
  9335. // A wildcard needs two labels after it, so that "*.com" matches nothing,
  9336. // and an IDNA label may not have one
  9337. const auto &leftmost = pattern_components.front();
  9338. if (leftmost.find('*') != std::string::npos &&
  9339. (pattern_components.size() < 3 ||
  9340. case_ignore::equal(leftmost.substr(0, 4), "xn--"))) {
  9341. return false;
  9342. }
  9343. // Compare each component with wildcard support
  9344. // Supports: "*" (full wildcard), "prefix*" (partial wildcard)
  9345. // https://bugs.launchpad.net/ubuntu/+source/firefox-3.0/+bug/376484
  9346. // Only the leftmost label may carry a wildcard (RFC 6125 6.4.3)
  9347. auto itr = pattern_components.begin();
  9348. for (const auto &h : host_components) {
  9349. auto &p = *itr;
  9350. auto is_leftmost = itr == pattern_components.begin();
  9351. if (!detail::case_ignore::equal(p, h) && !(is_leftmost && p == "*")) {
  9352. bool partial_match = false;
  9353. if (is_leftmost && !p.empty() && p[p.size() - 1] == '*') {
  9354. const auto prefix_length = p.size() - 1;
  9355. if (prefix_length == 0) {
  9356. partial_match = true;
  9357. } else if (h.size() >= prefix_length) {
  9358. partial_match =
  9359. std::equal(p.begin(),
  9360. p.begin() + static_cast<std::string::difference_type>(
  9361. prefix_length),
  9362. h.begin(), [](const char ca, const char cb) {
  9363. return detail::case_ignore::to_lower(ca) ==
  9364. detail::case_ignore::to_lower(cb);
  9365. });
  9366. }
  9367. }
  9368. if (!partial_match) { return false; }
  9369. }
  9370. ++itr;
  9371. }
  9372. return true;
  9373. }
  9374. #ifdef _WIN32
  9375. // Verify certificate using Windows CertGetCertificateChain API.
  9376. // This provides real-time certificate validation with Windows Update
  9377. // integration, independent of the TLS backend.
  9378. inline bool verify_cert_with_windows_schannel(
  9379. const std::vector<unsigned char> &der_cert, const std::string &hostname,
  9380. bool verify_hostname, uint64_t &out_error, tls::const_session_t session) {
  9381. if (der_cert.empty()) { return false; }
  9382. out_error = 0;
  9383. // Create Windows certificate context from DER data
  9384. auto cert_context = CertCreateCertificateContext(
  9385. X509_ASN_ENCODING | PKCS_7_ASN_ENCODING, der_cert.data(),
  9386. static_cast<DWORD>(der_cert.size()));
  9387. if (!cert_context) {
  9388. out_error = GetLastError();
  9389. return false;
  9390. }
  9391. auto cert_guard =
  9392. scope_exit([&] { CertFreeCertificateContext(cert_context); });
  9393. // Give CryptoAPI the certificates the server sent. Without them it follows
  9394. // the leaf's AIA URL, which may lead to an issuer under an untrusted root.
  9395. std::vector<tls::cert_t> peer_certs;
  9396. tls::get_peer_certs(session, peer_certs);
  9397. auto store = CertOpenStore(CERT_STORE_PROV_MEMORY, 0, 0, 0, nullptr);
  9398. auto store_guard = scope_exit([&] {
  9399. for (auto cert : peer_certs) {
  9400. tls::free_cert(cert);
  9401. }
  9402. if (store) { CertCloseStore(store, 0); }
  9403. });
  9404. for (auto cert : peer_certs) {
  9405. std::vector<unsigned char> der;
  9406. if (store && tls::get_cert_der(cert, der)) {
  9407. CertAddEncodedCertificateToStore(store, X509_ASN_ENCODING, der.data(),
  9408. static_cast<DWORD>(der.size()),
  9409. CERT_STORE_ADD_USE_EXISTING, nullptr);
  9410. }
  9411. }
  9412. // Setup chain parameters
  9413. CERT_CHAIN_PARA chain_para = {};
  9414. chain_para.cbSize = sizeof(chain_para);
  9415. // Require the server authentication usage along the chain, which also
  9416. // rejects roots that Windows trusts only for other purposes.
  9417. LPSTR server_auth = const_cast<LPSTR>(szOID_PKIX_KP_SERVER_AUTH);
  9418. chain_para.RequestedUsage.dwType = USAGE_MATCH_TYPE_AND;
  9419. chain_para.RequestedUsage.Usage.cUsageIdentifier = 1;
  9420. chain_para.RequestedUsage.Usage.rgpszUsageIdentifier = &server_auth;
  9421. // Build certificate chain with revocation checking
  9422. PCCERT_CHAIN_CONTEXT chain_context = nullptr;
  9423. auto chain_result = CertGetCertificateChain(
  9424. nullptr, cert_context, nullptr, store, &chain_para,
  9425. CERT_CHAIN_CACHE_END_CERT | CERT_CHAIN_REVOCATION_CHECK_END_CERT |
  9426. CERT_CHAIN_REVOCATION_ACCUMULATIVE_TIMEOUT,
  9427. nullptr, &chain_context);
  9428. if (!chain_result || !chain_context) {
  9429. out_error = GetLastError();
  9430. return false;
  9431. }
  9432. auto chain_guard =
  9433. scope_exit([&] { CertFreeCertificateChain(chain_context); });
  9434. // Verify SSL policy
  9435. SSL_EXTRA_CERT_CHAIN_POLICY_PARA extra_policy_para = {};
  9436. extra_policy_para.cbSize = sizeof(extra_policy_para);
  9437. #ifdef AUTHTYPE_SERVER
  9438. extra_policy_para.dwAuthType = AUTHTYPE_SERVER;
  9439. #endif
  9440. std::wstring whost;
  9441. if (verify_hostname) {
  9442. whost = u8string_to_wstring(hostname.c_str());
  9443. extra_policy_para.pwszServerName = const_cast<wchar_t *>(whost.c_str());
  9444. }
  9445. CERT_CHAIN_POLICY_PARA policy_para = {};
  9446. policy_para.cbSize = sizeof(policy_para);
  9447. #ifdef CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS
  9448. policy_para.dwFlags = CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS;
  9449. #else
  9450. policy_para.dwFlags = 0;
  9451. #endif
  9452. policy_para.pvExtraPolicyPara = &extra_policy_para;
  9453. CERT_CHAIN_POLICY_STATUS policy_status = {};
  9454. policy_status.cbSize = sizeof(policy_status);
  9455. if (!CertVerifyCertificateChainPolicy(CERT_CHAIN_POLICY_SSL, chain_context,
  9456. &policy_para, &policy_status)) {
  9457. out_error = GetLastError();
  9458. return false;
  9459. }
  9460. if (policy_status.dwError != 0) {
  9461. out_error = policy_status.dwError;
  9462. return false;
  9463. }
  9464. return true;
  9465. }
  9466. #endif // _WIN32
  9467. // Loads CA file/dir configuration and applies the system CA policy to a
  9468. // client TLS context. PEM data and native stores are applied to the context
  9469. // directly at set time; has_custom_store reflects them for the Auto policy
  9470. // decision.
  9471. inline bool load_client_ca_config(tls::ctx_t ctx,
  9472. const std::string &ca_cert_file_path,
  9473. const std::string &ca_cert_dir_path,
  9474. bool has_custom_store, SystemCAMode mode,
  9475. uint64_t &backend_error) {
  9476. auto ret = true;
  9477. if (!ca_cert_file_path.empty()) {
  9478. if (!tls::load_ca_file(ctx, ca_cert_file_path.c_str())) {
  9479. backend_error = tls::get_error();
  9480. ret = false;
  9481. }
  9482. } else if (!ca_cert_dir_path.empty()) {
  9483. if (!tls::load_ca_dir(ctx, ca_cert_dir_path.c_str())) {
  9484. backend_error = tls::get_error();
  9485. ret = false;
  9486. }
  9487. }
  9488. auto has_custom_ca = !ca_cert_file_path.empty() ||
  9489. !ca_cert_dir_path.empty() || has_custom_store;
  9490. if (mode == SystemCAMode::Enabled ||
  9491. (mode == SystemCAMode::Auto && !has_custom_ca)) {
  9492. if (!tls::load_system_certs(ctx)) { backend_error = tls::get_error(); }
  9493. }
  9494. return ret;
  9495. }
  9496. // Serializes the CA certificates installed in ctx as PEM, so they can be
  9497. // loaded into another context.
  9498. inline std::string ca_certs_to_pem(tls::ctx_t ctx) {
  9499. std::string pem;
  9500. std::vector<tls::cert_t> certs;
  9501. tls::get_ca_certs(ctx, certs);
  9502. for (auto cert : certs) {
  9503. std::vector<unsigned char> der;
  9504. if (tls::get_cert_der(cert, der)) {
  9505. auto b64 = base64_encode(std::string(der.begin(), der.end()));
  9506. pem += "-----BEGIN CERTIFICATE-----\n";
  9507. for (size_t i = 0; i < b64.size(); i += 64) {
  9508. pem += b64.substr(i, 64);
  9509. pem += '\n';
  9510. }
  9511. pem += "-----END CERTIFICATE-----\n";
  9512. }
  9513. tls::free_cert(cert);
  9514. }
  9515. return pem;
  9516. }
  9517. // Returns a PemMemory field as a NUL-terminated string: its first len bytes,
  9518. // copied to buf, or pem itself when len is 0.
  9519. inline const char *pem_c_str(const char *pem, size_t len, std::string &buf) {
  9520. if (!pem || len == 0) { return pem; }
  9521. buf.assign(pem, len);
  9522. return buf.c_str();
  9523. }
  9524. // The parts of session setup that only SSLClient needs, plus the handful
  9525. // WebSocketClient also exposes; everything else takes the defaults, which is
  9526. // what keeps the two clients on one implementation.
  9527. struct ClientTlsSessionOptions {
  9528. // Both SSLClient and WebSocketClient expose this independently of
  9529. // certificate verification.
  9530. bool server_hostname_verification = true;
  9531. std::function<SSLVerifierResponse(tls::session_t)> session_verifier;
  9532. // When non-null, guards session creation against concurrent use of the
  9533. // context. A WebSocketClient is not safe to use from several threads to
  9534. // begin with, so it passes nothing.
  9535. std::mutex *ctx_mutex = nullptr;
  9536. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9537. // The caller decides whether Schannel has anything to say about this
  9538. // connection; see SSLClient::initialize_ssl().
  9539. bool windows_cert_verification = false;
  9540. // A server certificate verifier works on the backend's chain verification,
  9541. // so the backend keeps deciding and Schannel only adds its own check.
  9542. bool server_certificate_verifier_set = false;
  9543. #endif
  9544. };
  9545. // Filled in on failure for callers that report error details.
  9546. struct ClientTlsSessionError {
  9547. Error error = Error::Success;
  9548. int ssl_error = 0;
  9549. uint64_t backend_error = 0;
  9550. };
  9551. // Establishes a client TLS session on an already connected socket. On failure
  9552. // the session is left for the caller to free: SSLClient frees it right away,
  9553. // WebSocketClient keeps it in a member that shutdown_and_close() cleans up.
  9554. inline bool setup_client_tls_session(
  9555. const std::string &host, tls::ctx_t ctx, tls::session_t &session,
  9556. socket_t sock, bool server_certificate_verification, time_t timeout_sec,
  9557. time_t timeout_usec, ClientTlsSessionError *out_error = nullptr,
  9558. const ClientTlsSessionOptions &options = ClientTlsSessionOptions()) {
  9559. using namespace tls;
  9560. auto fail = [&](Error error, int ssl_error, uint64_t backend_error) {
  9561. if (out_error) {
  9562. out_error->error = error;
  9563. out_error->ssl_error = ssl_error;
  9564. out_error->backend_error = backend_error;
  9565. }
  9566. return false;
  9567. };
  9568. if (!ctx) {
  9569. session = nullptr;
  9570. return fail(Error::SSLConnection, 0, 0);
  9571. }
  9572. // With Windows verification on and no server certificate verifier set,
  9573. // Schannel is the only chain verifier. The backend's trust store is a
  9574. // snapshot of the Windows stores that lacks the roots Windows fetches on
  9575. // demand, so the backend's verdict is not used.
  9576. auto windows_verifies_chain = false;
  9577. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9578. windows_verifies_chain = options.windows_cert_verification &&
  9579. !options.server_certificate_verifier_set;
  9580. #endif
  9581. {
  9582. std::unique_lock<std::mutex> guard;
  9583. if (options.ctx_mutex) {
  9584. guard = std::unique_lock<std::mutex>(*options.ctx_mutex);
  9585. }
  9586. #if defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9587. // Mbed TLS and wolfSSL need the verification mode set explicitly, on the
  9588. // context, so under the same lock; OpenSSL uses SSL_VERIFY_NONE and does
  9589. // all verification post-handshake. Unless Schannel verifies the chain
  9590. // instead, chain verification happens during the handshake even for IP
  9591. // hosts; the certificate identity is verified post-handshake via
  9592. // verify_hostname().
  9593. set_verify_client(ctx, server_certificate_verification &&
  9594. !windows_verifies_chain);
  9595. #endif
  9596. session = create_session(ctx, sock);
  9597. }
  9598. if (!session) { return fail(Error::SSLConnection, 0, get_error()); }
  9599. // RFC 6066: SNI must not be set for IP addresses; skip it for IP hosts, so
  9600. // their identity is checked post-handshake below instead. On Mbed TLS and
  9601. // wolfSSL, set_sni also drives handshake-time hostname verification, so
  9602. // options.server_hostname_verification is threaded through here.
  9603. if (!is_ip_address(host)) {
  9604. if (!set_sni(session, host.c_str(), options.server_hostname_verification)) {
  9605. return fail(Error::SSLConnection, 0, get_error());
  9606. }
  9607. }
  9608. TlsError tls_err;
  9609. if (!connect_nonblocking(session, sock, timeout_sec, timeout_usec,
  9610. &tls_err)) {
  9611. auto error = Error::SSLConnection;
  9612. if (tls_err.code == ErrorCode::CertVerifyFailed) {
  9613. error = Error::SSLServerVerification;
  9614. } else if (tls_err.code == ErrorCode::HostnameMismatch) {
  9615. error = Error::SSLServerHostnameVerification;
  9616. }
  9617. return fail(error, static_cast<int>(tls_err.code), tls_err.backend_code);
  9618. }
  9619. auto verification_status = SSLVerifierResponse::NoDecisionMade;
  9620. if (options.session_verifier) {
  9621. verification_status = options.session_verifier(session);
  9622. }
  9623. if (verification_status == SSLVerifierResponse::CertificateRejected) {
  9624. return fail(Error::SSLServerVerification, 0, get_error());
  9625. }
  9626. if (verification_status == SSLVerifierResponse::NoDecisionMade &&
  9627. server_certificate_verification) {
  9628. if (!windows_verifies_chain) {
  9629. auto verify_result = get_verify_result(session);
  9630. if (verify_result != 0) {
  9631. return fail(Error::SSLServerVerification, 0,
  9632. static_cast<uint64_t>(verify_result));
  9633. }
  9634. }
  9635. auto server_cert = get_peer_cert(session);
  9636. if (!server_cert) {
  9637. return fail(Error::SSLServerVerification, 0, get_error());
  9638. }
  9639. auto cert_guard = detail::scope_exit([&] { free_cert(server_cert); });
  9640. // Identity check against the peer certificate, post-handshake for all
  9641. // backends. For IP hosts this is the only identity verification, since no
  9642. // hostname is bound during the handshake.
  9643. if (options.server_hostname_verification) {
  9644. if (!verify_hostname(server_cert, host.c_str())) {
  9645. return fail(Error::SSLServerHostnameVerification, 0,
  9646. hostname_mismatch_code());
  9647. }
  9648. }
  9649. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9650. // Windows Schannel verification, which lets Windows fetch missing roots
  9651. // and intermediates on demand. It must not be skipped: unless a server
  9652. // certificate verifier is set, it is the only chain check.
  9653. if (options.windows_cert_verification) {
  9654. std::vector<unsigned char> der;
  9655. uint64_t wincrypt_error = 0;
  9656. if (!get_cert_der(server_cert, der) ||
  9657. !verify_cert_with_windows_schannel(
  9658. der, host, options.server_hostname_verification, wincrypt_error,
  9659. session)) {
  9660. return fail(Error::SSLServerVerification, 0, wincrypt_error);
  9661. }
  9662. }
  9663. #endif
  9664. }
  9665. return true;
  9666. }
  9667. } // namespace detail
  9668. #endif // CPPHTTPLIB_SSL_ENABLED
  9669. /*
  9670. * Group 3: httplib namespace - Non-SSL public API implementations
  9671. */
  9672. inline void default_socket_options(socket_t sock) {
  9673. set_socket_opt(sock, SOL_SOCKET,
  9674. #ifdef SO_REUSEPORT
  9675. SO_REUSEPORT,
  9676. #else
  9677. SO_REUSEADDR,
  9678. #endif
  9679. 1);
  9680. }
  9681. inline bool set_socket_opt(socket_t sock, int level, int optname, int optval) {
  9682. return detail::set_socket_opt_impl(sock, level, optname, &optval,
  9683. sizeof(optval));
  9684. }
  9685. inline std::string get_bearer_token_auth(const Request &req) {
  9686. // The auth scheme is case-insensitive (RFC 9110 11.1), and a value shorter
  9687. // than the prefix carries no token.
  9688. constexpr const char bearer_prefix[] = "Bearer ";
  9689. constexpr auto bearer_prefix_len = detail::str_len(bearer_prefix);
  9690. auto value = req.get_header_value("Authorization");
  9691. if (value.size() >= bearer_prefix_len &&
  9692. detail::case_ignore::equal(value.substr(0, bearer_prefix_len),
  9693. bearer_prefix)) {
  9694. return value.substr(bearer_prefix_len);
  9695. }
  9696. return "";
  9697. }
  9698. inline const char *status_message(int status) {
  9699. switch (status) {
  9700. case StatusCode::Continue_100: return "Continue";
  9701. case StatusCode::SwitchingProtocol_101: return "Switching Protocol";
  9702. case StatusCode::Processing_102: return "Processing";
  9703. case StatusCode::EarlyHints_103: return "Early Hints";
  9704. case StatusCode::OK_200: return "OK";
  9705. case StatusCode::Created_201: return "Created";
  9706. case StatusCode::Accepted_202: return "Accepted";
  9707. case StatusCode::NonAuthoritativeInformation_203:
  9708. return "Non-Authoritative Information";
  9709. case StatusCode::NoContent_204: return "No Content";
  9710. case StatusCode::ResetContent_205: return "Reset Content";
  9711. case StatusCode::PartialContent_206: return "Partial Content";
  9712. case StatusCode::MultiStatus_207: return "Multi-Status";
  9713. case StatusCode::AlreadyReported_208: return "Already Reported";
  9714. case StatusCode::IMUsed_226: return "IM Used";
  9715. case StatusCode::MultipleChoices_300: return "Multiple Choices";
  9716. case StatusCode::MovedPermanently_301: return "Moved Permanently";
  9717. case StatusCode::Found_302: return "Found";
  9718. case StatusCode::SeeOther_303: return "See Other";
  9719. case StatusCode::NotModified_304: return "Not Modified";
  9720. case StatusCode::UseProxy_305: return "Use Proxy";
  9721. case StatusCode::unused_306: return "unused";
  9722. case StatusCode::TemporaryRedirect_307: return "Temporary Redirect";
  9723. case StatusCode::PermanentRedirect_308: return "Permanent Redirect";
  9724. case StatusCode::BadRequest_400: return "Bad Request";
  9725. case StatusCode::Unauthorized_401: return "Unauthorized";
  9726. case StatusCode::PaymentRequired_402: return "Payment Required";
  9727. case StatusCode::Forbidden_403: return "Forbidden";
  9728. case StatusCode::NotFound_404: return "Not Found";
  9729. case StatusCode::MethodNotAllowed_405: return "Method Not Allowed";
  9730. case StatusCode::NotAcceptable_406: return "Not Acceptable";
  9731. case StatusCode::ProxyAuthenticationRequired_407:
  9732. return "Proxy Authentication Required";
  9733. case StatusCode::RequestTimeout_408: return "Request Timeout";
  9734. case StatusCode::Conflict_409: return "Conflict";
  9735. case StatusCode::Gone_410: return "Gone";
  9736. case StatusCode::LengthRequired_411: return "Length Required";
  9737. case StatusCode::PreconditionFailed_412: return "Precondition Failed";
  9738. case StatusCode::PayloadTooLarge_413: return "Payload Too Large";
  9739. case StatusCode::UriTooLong_414: return "URI Too Long";
  9740. case StatusCode::UnsupportedMediaType_415: return "Unsupported Media Type";
  9741. case StatusCode::RangeNotSatisfiable_416: return "Range Not Satisfiable";
  9742. case StatusCode::ExpectationFailed_417: return "Expectation Failed";
  9743. case StatusCode::ImATeapot_418: return "I'm a teapot";
  9744. case StatusCode::MisdirectedRequest_421: return "Misdirected Request";
  9745. case StatusCode::UnprocessableContent_422: return "Unprocessable Content";
  9746. case StatusCode::Locked_423: return "Locked";
  9747. case StatusCode::FailedDependency_424: return "Failed Dependency";
  9748. case StatusCode::TooEarly_425: return "Too Early";
  9749. case StatusCode::UpgradeRequired_426: return "Upgrade Required";
  9750. case StatusCode::PreconditionRequired_428: return "Precondition Required";
  9751. case StatusCode::TooManyRequests_429: return "Too Many Requests";
  9752. case StatusCode::RequestHeaderFieldsTooLarge_431:
  9753. return "Request Header Fields Too Large";
  9754. case StatusCode::UnavailableForLegalReasons_451:
  9755. return "Unavailable For Legal Reasons";
  9756. case StatusCode::NotImplemented_501: return "Not Implemented";
  9757. case StatusCode::BadGateway_502: return "Bad Gateway";
  9758. case StatusCode::ServiceUnavailable_503: return "Service Unavailable";
  9759. case StatusCode::GatewayTimeout_504: return "Gateway Timeout";
  9760. case StatusCode::HttpVersionNotSupported_505:
  9761. return "HTTP Version Not Supported";
  9762. case StatusCode::VariantAlsoNegotiates_506: return "Variant Also Negotiates";
  9763. case StatusCode::InsufficientStorage_507: return "Insufficient Storage";
  9764. case StatusCode::LoopDetected_508: return "Loop Detected";
  9765. case StatusCode::NotExtended_510: return "Not Extended";
  9766. case StatusCode::NetworkAuthenticationRequired_511:
  9767. return "Network Authentication Required";
  9768. default:
  9769. case StatusCode::InternalServerError_500: return "Internal Server Error";
  9770. }
  9771. }
  9772. inline std::string to_string(const Error error) {
  9773. switch (error) {
  9774. case Error::Success: return "Success (no error)";
  9775. case Error::Unknown: return "Unknown";
  9776. case Error::Connection: return "Could not establish connection";
  9777. case Error::BindIPAddress: return "Failed to bind IP address";
  9778. case Error::Read: return "Failed to read connection";
  9779. case Error::Write: return "Failed to write connection";
  9780. case Error::ExceedRedirectCount: return "Maximum redirect count exceeded";
  9781. case Error::Canceled: return "Connection handling canceled";
  9782. case Error::SSLConnection: return "SSL connection failed";
  9783. case Error::SSLLoadingCerts: return "SSL certificate loading failed";
  9784. case Error::SSLServerVerification: return "SSL server verification failed";
  9785. case Error::SSLServerHostnameVerification:
  9786. return "SSL server hostname verification failed";
  9787. case Error::UnsupportedMultipartBoundaryChars:
  9788. return "Unsupported HTTP multipart boundary characters";
  9789. case Error::Compression: return "Compression failed";
  9790. case Error::ConnectionTimeout: return "Connection timed out";
  9791. case Error::ProxyConnection: return "Proxy connection failed";
  9792. case Error::ConnectionClosed: return "Connection closed by server";
  9793. case Error::Timeout: return "Read timeout";
  9794. case Error::ResourceExhaustion: return "Resource exhaustion";
  9795. case Error::TooManyFormDataFiles: return "Too many form data files";
  9796. case Error::ExceedMaxPayloadSize: return "Exceeded maximum payload size";
  9797. case Error::ExceedUriMaxLength: return "Exceeded maximum URI length";
  9798. case Error::ExceedMaxSocketDescriptorCount:
  9799. return "Exceeded maximum socket descriptor count";
  9800. case Error::InvalidRequestLine: return "Invalid request line";
  9801. case Error::InvalidHTTPMethod: return "Invalid HTTP method";
  9802. case Error::InvalidHTTPVersion: return "Invalid HTTP version";
  9803. case Error::InvalidHeaders: return "Invalid headers";
  9804. case Error::MultipartParsing: return "Multipart parsing failed";
  9805. case Error::OpenFile: return "Failed to open file";
  9806. case Error::Listen: return "Failed to listen on socket";
  9807. case Error::GetSockName: return "Failed to get socket name";
  9808. case Error::UnsupportedAddressFamily: return "Unsupported address family";
  9809. case Error::HTTPParsing: return "HTTP parsing failed";
  9810. case Error::InvalidRangeHeader: return "Invalid Range header";
  9811. case Error::UnsupportedContentEncoding: return "Unsupported Content-Encoding";
  9812. case Error::WebSocketHandshake: return "WebSocket handshake failed";
  9813. case Error::UserCallbackException: return "User callback threw an exception";
  9814. default: break;
  9815. }
  9816. return "Invalid";
  9817. }
  9818. inline std::ostream &operator<<(std::ostream &os, const Error &obj) {
  9819. os << to_string(obj);
  9820. os << " (" << static_cast<std::underlying_type<Error>::type>(obj) << ')';
  9821. return os;
  9822. }
  9823. inline std::string hosted_at(const std::string &hostname) {
  9824. std::vector<std::string> addrs;
  9825. hosted_at(hostname, addrs);
  9826. if (addrs.empty()) { return std::string(); }
  9827. return addrs[0];
  9828. }
  9829. inline void hosted_at(const std::string &hostname,
  9830. std::vector<std::string> &addrs) {
  9831. struct addrinfo hints;
  9832. struct addrinfo *result;
  9833. memset(&hints, 0, sizeof(struct addrinfo));
  9834. hints.ai_family = AF_UNSPEC;
  9835. hints.ai_socktype = SOCK_STREAM;
  9836. hints.ai_protocol = 0;
  9837. if (detail::getaddrinfo_with_timeout(hostname.c_str(), nullptr, &hints,
  9838. &result, 0)) {
  9839. #if defined __linux__ && !defined __ANDROID__
  9840. res_init();
  9841. #endif
  9842. return;
  9843. }
  9844. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  9845. for (auto rp = result; rp; rp = rp->ai_next) {
  9846. const auto &addr =
  9847. *reinterpret_cast<struct sockaddr_storage *>(rp->ai_addr);
  9848. std::string ip;
  9849. auto dummy = -1;
  9850. if (detail::get_ip_and_port(addr, sizeof(struct sockaddr_storage), ip,
  9851. dummy)) {
  9852. addrs.emplace_back(std::move(ip));
  9853. }
  9854. }
  9855. }
  9856. inline std::string encode_uri_component(const std::string &value) {
  9857. std::ostringstream escaped;
  9858. escaped.fill('0');
  9859. escaped << std::hex;
  9860. for (auto c : value) {
  9861. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9862. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')') {
  9863. escaped << c;
  9864. } else {
  9865. escaped << std::uppercase;
  9866. escaped << '%' << std::setw(2)
  9867. << static_cast<int>(static_cast<unsigned char>(c));
  9868. escaped << std::nouppercase;
  9869. }
  9870. }
  9871. return escaped.str();
  9872. }
  9873. inline std::string encode_uri(const std::string &value) {
  9874. std::ostringstream escaped;
  9875. escaped.fill('0');
  9876. escaped << std::hex;
  9877. for (auto c : value) {
  9878. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9879. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')' ||
  9880. c == ';' || c == '/' || c == '?' || c == ':' || c == '@' || c == '&' ||
  9881. c == '=' || c == '+' || c == '$' || c == ',' || c == '#') {
  9882. escaped << c;
  9883. } else {
  9884. escaped << std::uppercase;
  9885. escaped << '%' << std::setw(2)
  9886. << static_cast<int>(static_cast<unsigned char>(c));
  9887. escaped << std::nouppercase;
  9888. }
  9889. }
  9890. return escaped.str();
  9891. }
  9892. inline std::string decode_uri_component(const std::string &value) {
  9893. std::string result;
  9894. for (size_t i = 0; i < value.size(); i++) {
  9895. if (value[i] == '%' && i + 2 < value.size()) {
  9896. auto val = 0;
  9897. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9898. result += static_cast<char>(val);
  9899. i += 2;
  9900. } else {
  9901. result += value[i];
  9902. }
  9903. } else {
  9904. result += value[i];
  9905. }
  9906. }
  9907. return result;
  9908. }
  9909. inline std::string decode_uri(const std::string &value) {
  9910. std::string result;
  9911. for (size_t i = 0; i < value.size(); i++) {
  9912. if (value[i] == '%' && i + 2 < value.size()) {
  9913. auto val = 0;
  9914. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9915. auto c = static_cast<char>(val);
  9916. // Keep escapes of the reserved characters that encode_uri leaves
  9917. // literal, so decode_uri is the inverse of encode_uri and an escaped
  9918. // delimiter is not promoted into a real one (as with JS decodeURI).
  9919. if (c == ';' || c == '/' || c == '?' || c == ':' || c == '@' ||
  9920. c == '&' || c == '=' || c == '+' || c == '$' || c == ',' ||
  9921. c == '#') {
  9922. result += value[i];
  9923. result += value[i + 1];
  9924. result += value[i + 2];
  9925. } else {
  9926. result += c;
  9927. }
  9928. i += 2;
  9929. } else {
  9930. result += value[i];
  9931. }
  9932. } else {
  9933. result += value[i];
  9934. }
  9935. }
  9936. return result;
  9937. }
  9938. inline std::string encode_path_component(const std::string &component) {
  9939. std::string result;
  9940. result.reserve(component.size() * 3);
  9941. for (size_t i = 0; i < component.size(); i++) {
  9942. auto c = static_cast<unsigned char>(component[i]);
  9943. // Unreserved characters per RFC 3986: ALPHA / DIGIT / "-" / "." / "_" / "~"
  9944. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9945. c == '_' || c == '~') {
  9946. result += static_cast<char>(c);
  9947. }
  9948. // Path-safe sub-delimiters: "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" /
  9949. // "," / ";" / "="
  9950. else if (c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  9951. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  9952. c == '=') {
  9953. result += static_cast<char>(c);
  9954. }
  9955. // Colon is allowed in path segments except first segment
  9956. else if (c == ':') {
  9957. result += static_cast<char>(c);
  9958. }
  9959. // @ is allowed in path
  9960. else if (c == '@') {
  9961. result += static_cast<char>(c);
  9962. } else {
  9963. result += '%';
  9964. char hex[3];
  9965. snprintf(hex, sizeof(hex), "%02X", c);
  9966. result.append(hex, 2);
  9967. }
  9968. }
  9969. return result;
  9970. }
  9971. inline std::string decode_path_component(const std::string &component) {
  9972. std::string result;
  9973. result.reserve(component.size());
  9974. for (size_t i = 0; i < component.size(); i++) {
  9975. if (component[i] == '%' && i + 1 < component.size()) {
  9976. if (component[i + 1] == 'u') {
  9977. // Unicode %uXXXX encoding
  9978. auto val = 0;
  9979. // 4 digits Unicode codes: val is 0x0000-0xFFFF (from 4 hex digits),
  9980. // so to_utf8 writes at most 3 bytes. buff[4] is safe.
  9981. char buff[4];
  9982. size_t len = 0;
  9983. if (detail::from_hex_to_i(component, i + 2, 4, val) &&
  9984. (len = detail::to_utf8(val, buff)) > 0) {
  9985. result.append(buff, len);
  9986. i += 5; // 'u0000'
  9987. } else {
  9988. // Not 4 hex digits, or a surrogate, which is no character: the
  9989. // escape is kept as it is rather than joining its neighbours
  9990. result += component[i];
  9991. }
  9992. } else {
  9993. // Standard %XX encoding
  9994. auto val = 0;
  9995. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9996. // 2 digits hex codes
  9997. result += static_cast<char>(val);
  9998. i += 2; // 'XX'
  9999. } else {
  10000. result += component[i];
  10001. }
  10002. }
  10003. } else {
  10004. result += component[i];
  10005. }
  10006. }
  10007. return result;
  10008. }
  10009. inline std::string encode_query_component(const std::string &component,
  10010. bool space_as_plus) {
  10011. std::string result;
  10012. result.reserve(component.size() * 3);
  10013. for (size_t i = 0; i < component.size(); i++) {
  10014. auto c = static_cast<unsigned char>(component[i]);
  10015. // Unreserved characters per RFC 3986
  10016. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  10017. c == '_' || c == '~') {
  10018. result += static_cast<char>(c);
  10019. }
  10020. // Space handling
  10021. else if (c == ' ') {
  10022. if (space_as_plus) {
  10023. result += '+';
  10024. } else {
  10025. result += "%20";
  10026. }
  10027. }
  10028. // Plus sign handling
  10029. else if (c == '+') {
  10030. if (space_as_plus) {
  10031. result += "%2B";
  10032. } else {
  10033. result += static_cast<char>(c);
  10034. }
  10035. }
  10036. // Query-safe sub-delimiters (excluding & and = which are query delimiters)
  10037. else if (c == '!' || c == '$' || c == '\'' || c == '(' || c == ')' ||
  10038. c == '*' || c == ',' || c == ';') {
  10039. result += static_cast<char>(c);
  10040. }
  10041. // Colon and @ are allowed in query
  10042. else if (c == ':' || c == '@') {
  10043. result += static_cast<char>(c);
  10044. }
  10045. // Forward slash is allowed in query values
  10046. else if (c == '/') {
  10047. result += static_cast<char>(c);
  10048. }
  10049. // Question mark is allowed in query values (after first ?)
  10050. else if (c == '?') {
  10051. result += static_cast<char>(c);
  10052. } else {
  10053. result += '%';
  10054. char hex[3];
  10055. snprintf(hex, sizeof(hex), "%02X", c);
  10056. result.append(hex, 2);
  10057. }
  10058. }
  10059. return result;
  10060. }
  10061. inline std::string decode_query_component(const std::string &component,
  10062. bool plus_as_space) {
  10063. std::string result;
  10064. result.reserve(component.size());
  10065. for (size_t i = 0; i < component.size(); i++) {
  10066. if (component[i] == '%' && i + 2 < component.size()) {
  10067. auto val = 0;
  10068. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  10069. result += static_cast<char>(val);
  10070. i += 2;
  10071. } else {
  10072. result += component[i];
  10073. }
  10074. } else if (component[i] == '+' && plus_as_space) {
  10075. result += ' '; // + becomes space in form-urlencoded
  10076. } else {
  10077. result += component[i];
  10078. }
  10079. }
  10080. return result;
  10081. }
  10082. inline std::string sanitize_filename(const std::string &filename) {
  10083. // Extract basename: find the last path separator (/ or \)
  10084. auto pos = filename.find_last_of("/\\");
  10085. auto result =
  10086. (pos != std::string::npos) ? filename.substr(pos + 1) : filename;
  10087. // Strip null bytes
  10088. result.erase(std::remove(result.begin(), result.end(), '\0'), result.end());
  10089. // Trim whitespace
  10090. {
  10091. auto start = result.find_first_not_of(" \t");
  10092. auto end = result.find_last_not_of(" \t");
  10093. result = (start == std::string::npos)
  10094. ? ""
  10095. : result.substr(start, end - start + 1);
  10096. }
  10097. // Reject . and ..
  10098. if (result == "." || result == "..") { return ""; }
  10099. return result;
  10100. }
  10101. inline std::string append_query_params(const std::string &path,
  10102. const Params &params) {
  10103. // The query ends at the fragment (RFC 3986 3.5), so the params go before it.
  10104. auto fragment_pos = path.find('#');
  10105. auto path_with_query = path.substr(0, fragment_pos);
  10106. path_with_query += path_with_query.find('?') == std::string::npos ? '?' : '&';
  10107. path_with_query += detail::params_to_query_str(params);
  10108. if (fragment_pos != std::string::npos) {
  10109. path_with_query.append(path, fragment_pos, std::string::npos);
  10110. }
  10111. return path_with_query;
  10112. }
  10113. // Header utilities
  10114. inline std::pair<std::string, std::string>
  10115. make_range_header(const Ranges &ranges) {
  10116. std::string field = "bytes=";
  10117. auto i = 0;
  10118. for (const auto &r : ranges) {
  10119. if (i != 0) { field += ", "; }
  10120. if (r.first != -1) { field += std::to_string(r.first); }
  10121. field += '-';
  10122. if (r.second != -1) { field += std::to_string(r.second); }
  10123. i++;
  10124. }
  10125. return std::make_pair("Range", std::move(field));
  10126. }
  10127. inline std::pair<std::string, std::string>
  10128. make_basic_authentication_header(const std::string &username,
  10129. const std::string &password, bool is_proxy) {
  10130. auto field = "Basic " + detail::base64_encode(username + ":" + password);
  10131. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  10132. return std::make_pair(key, std::move(field));
  10133. }
  10134. inline std::pair<std::string, std::string>
  10135. make_bearer_token_authentication_header(const std::string &token,
  10136. bool is_proxy = false) {
  10137. auto field = "Bearer " + token;
  10138. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  10139. return std::make_pair(key, std::move(field));
  10140. }
  10141. namespace detail {
  10142. // Basic auth when a username or password is set, otherwise a bearer token,
  10143. // unless the request already carries the header.
  10144. inline void add_authorization_header(Request &req, const std::string &username,
  10145. const std::string &password,
  10146. const std::string &token, bool is_proxy) {
  10147. if (req.has_header(is_proxy ? "Proxy-Authorization" : "Authorization")) {
  10148. return;
  10149. }
  10150. if (!username.empty() || !password.empty()) {
  10151. req.headers.insert(
  10152. make_basic_authentication_header(username, password, is_proxy));
  10153. } else if (!token.empty()) {
  10154. req.headers.insert(
  10155. make_bearer_token_authentication_header(token, is_proxy));
  10156. }
  10157. }
  10158. } // namespace detail
  10159. // Request implementation
  10160. inline size_t Request::get_header_value_u64(const std::string &key, size_t def,
  10161. size_t id) const {
  10162. return detail::get_header_value_u64(headers, key, def, id);
  10163. }
  10164. inline bool Request::has_header(const std::string &key) const {
  10165. return detail::has_header(headers, key);
  10166. }
  10167. inline std::string Request::get_header_value(const std::string &key,
  10168. const char *def, size_t id) const {
  10169. return detail::get_header_value(headers, key, def, id);
  10170. }
  10171. inline size_t Request::get_header_value_count(const std::string &key) const {
  10172. return detail::get_header_value_count(headers, key);
  10173. }
  10174. inline void Request::set_header(const std::string &key,
  10175. const std::string &val) {
  10176. detail::set_header(headers, key, val);
  10177. }
  10178. inline bool Request::has_trailer(const std::string &key) const {
  10179. return trailers.find(key) != trailers.end();
  10180. }
  10181. inline std::string Request::get_trailer_value(const std::string &key,
  10182. size_t id) const {
  10183. return detail::get_multimap_value(trailers, key, id);
  10184. }
  10185. inline size_t Request::get_trailer_value_count(const std::string &key) const {
  10186. return trailers.count(key);
  10187. }
  10188. inline bool Request::has_param(const std::string &key) const {
  10189. return params.find(key) != params.end();
  10190. }
  10191. inline std::string Request::get_param_value(const std::string &key,
  10192. size_t id) const {
  10193. return detail::get_multimap_value(params, key, id);
  10194. }
  10195. inline std::vector<std::string>
  10196. Request::get_param_values(const std::string &key) const {
  10197. auto rng = params.equal_range(key);
  10198. std::vector<std::string> values;
  10199. values.reserve(static_cast<size_t>(std::distance(rng.first, rng.second)));
  10200. for (auto it = rng.first; it != rng.second; ++it) {
  10201. values.push_back(it->second);
  10202. }
  10203. return values;
  10204. }
  10205. inline size_t Request::get_param_value_count(const std::string &key) const {
  10206. return params.count(key);
  10207. }
  10208. inline bool Request::is_multipart_form_data() const {
  10209. const auto &content_type = get_header_value("Content-Type");
  10210. return detail::case_ignore::equal(detail::extract_media_type(content_type),
  10211. "multipart/form-data");
  10212. }
  10213. // Multipart FormData implementation
  10214. inline std::string MultipartFormData::get_field(const std::string &key,
  10215. size_t id) const {
  10216. auto rng = fields.equal_range(key);
  10217. auto it = detail::bounded_next(rng.first, id, rng.second);
  10218. if (it != rng.second) { return it->second.content; }
  10219. return std::string();
  10220. }
  10221. inline std::vector<std::string>
  10222. MultipartFormData::get_fields(const std::string &key) const {
  10223. std::vector<std::string> values;
  10224. auto rng = fields.equal_range(key);
  10225. for (auto it = rng.first; it != rng.second; it++) {
  10226. values.push_back(it->second.content);
  10227. }
  10228. return values;
  10229. }
  10230. inline bool MultipartFormData::has_field(const std::string &key) const {
  10231. return fields.find(key) != fields.end();
  10232. }
  10233. inline size_t MultipartFormData::get_field_count(const std::string &key) const {
  10234. return fields.count(key);
  10235. }
  10236. inline FormData MultipartFormData::get_file(const std::string &key,
  10237. size_t id) const {
  10238. return detail::get_multimap_value(files, key, id);
  10239. }
  10240. inline std::vector<FormData>
  10241. MultipartFormData::get_files(const std::string &key) const {
  10242. std::vector<FormData> values;
  10243. auto rng = files.equal_range(key);
  10244. for (auto it = rng.first; it != rng.second; it++) {
  10245. values.push_back(it->second);
  10246. }
  10247. return values;
  10248. }
  10249. inline bool MultipartFormData::has_file(const std::string &key) const {
  10250. return files.find(key) != files.end();
  10251. }
  10252. inline size_t MultipartFormData::get_file_count(const std::string &key) const {
  10253. return files.count(key);
  10254. }
  10255. // Multipart FormData writer implementation
  10256. inline bool is_valid_multipart_boundary(const std::string &boundary) {
  10257. return detail::is_multipart_boundary_chars_valid(boundary);
  10258. }
  10259. inline MultipartFormDataWriter::MultipartFormDataWriter()
  10260. : boundary_(detail::make_multipart_data_boundary()) {}
  10261. inline MultipartFormDataWriter::MultipartFormDataWriter(std::string boundary)
  10262. : boundary_(std::move(boundary)) {}
  10263. inline const std::string &MultipartFormDataWriter::boundary() const {
  10264. return boundary_;
  10265. }
  10266. inline std::string MultipartFormDataWriter::content_type() const {
  10267. return detail::serialize_multipart_formdata_get_content_type(boundary_);
  10268. }
  10269. inline std::string
  10270. MultipartFormDataWriter::serialize(const UploadFormDataItems &items) const {
  10271. return detail::serialize_multipart_formdata(items, boundary_);
  10272. }
  10273. inline size_t MultipartFormDataWriter::content_length(
  10274. const UploadFormDataItems &items) const {
  10275. return detail::get_multipart_content_length(items, boundary_);
  10276. }
  10277. inline std::string
  10278. MultipartFormDataWriter::item_begin(const UploadFormData &item) const {
  10279. return detail::serialize_multipart_formdata_item_begin(item, boundary_);
  10280. }
  10281. inline std::string MultipartFormDataWriter::item_end() {
  10282. return detail::serialize_multipart_formdata_item_end();
  10283. }
  10284. inline std::string MultipartFormDataWriter::finish() const {
  10285. return detail::serialize_multipart_formdata_finish(boundary_);
  10286. }
  10287. // Response implementation
  10288. namespace detail {
  10289. // A response has one content source: `body`, a content provider, or a file.
  10290. // Each content setter calls this so that the one called last wins.
  10291. inline void clear_content_provider(Response &res) {
  10292. auto releaser = std::move(res.content_provider_resource_releaser_);
  10293. auto success = res.content_provider_success_;
  10294. res.content_length_ = 0;
  10295. res.content_provider_ = nullptr;
  10296. res.content_provider_resource_releaser_ = nullptr;
  10297. res.is_chunked_content_provider_ = false;
  10298. res.is_file_content_provider_ = false;
  10299. res.content_provider_success_ = false;
  10300. res.content_coding_ = EncodingType::None;
  10301. res.file_content_path_.clear();
  10302. res.file_content_content_type_.clear();
  10303. if (releaser) { releaser(success); }
  10304. }
  10305. inline void clear_content(Response &res) {
  10306. res.body.clear();
  10307. clear_content_provider(res);
  10308. }
  10309. // The Content-Type of the old content goes with it.
  10310. inline void set_content_type(Response &res, const std::string &content_type) {
  10311. res.headers.erase("Content-Type");
  10312. res.set_header("Content-Type", content_type);
  10313. }
  10314. // `body` is public, so it can be assigned directly after a provider or a file
  10315. // was set. It came last, so it wins.
  10316. inline void prefer_assigned_body(Response &res) {
  10317. if (!res.body.empty() &&
  10318. (res.content_provider_ || !res.file_content_path_.empty())) {
  10319. clear_content_provider(res);
  10320. }
  10321. }
  10322. // RFC 9112 6.3: a 1xx, 204 or 304 response ends with its header section.
  10323. inline bool body_allowed_for_status(int status) {
  10324. return status >= 200 && status != StatusCode::NoContent_204 &&
  10325. status != StatusCode::NotModified_304;
  10326. }
  10327. // Only a 206 response is served as a partial representation. range_error()
  10328. // validates `req.ranges` only for a 2xx status, so slicing under any other
  10329. // status would start from an unchecked offset.
  10330. inline bool is_partial_content(const Request &req, const Response &res) {
  10331. return !req.ranges.empty() && res.status == StatusCode::PartialContent_206;
  10332. }
  10333. // Sets the Content-Length or Transfer-Encoding framing the body that
  10334. // Server::write_response_core() writes, or closes the connection after a body
  10335. // that has neither. Only the library sets them: one from a handler would go
  10336. // out next to it, or describe some other body.
  10337. inline void set_framing_headers(const Request &req, Response &res,
  10338. const std::string &boundary,
  10339. const std::string &content_type) {
  10340. // A HEAD response may give the length a GET would have had (RFC 9110 9.3.2).
  10341. auto head_length = req.method == "HEAD"
  10342. ? res.get_header_value("Content-Length")
  10343. : std::string();
  10344. res.headers.erase("Content-Length");
  10345. res.headers.erase("Transfer-Encoding");
  10346. if (!body_allowed_for_status(res.status)) { return; }
  10347. if (res.content_provider_) {
  10348. if (res.content_length_ == 0) {
  10349. if (res.is_chunked_content_provider_) {
  10350. res.set_header("Transfer-Encoding", "chunked");
  10351. } else if (req.method != "HEAD") {
  10352. // RFC 9112 6.3: a body with neither ends where the connection does.
  10353. res.headers.erase("Keep-Alive");
  10354. if (!has_header_token(res.headers, "Connection", "close")) {
  10355. res.set_header("Connection", "close");
  10356. }
  10357. }
  10358. return;
  10359. }
  10360. // The part Server::write_content_with_provider() writes.
  10361. auto length = res.content_length_;
  10362. if (is_partial_content(req, res)) {
  10363. length = req.ranges.size() == 1
  10364. ? get_range_offset_and_length(req.ranges[0], length).second
  10365. : get_multipart_ranges_data_length(req, boundary,
  10366. content_type, length);
  10367. }
  10368. res.set_header("Content-Length", std::to_string(length));
  10369. } else if (!res.body.empty()) {
  10370. res.set_header("Content-Length", std::to_string(res.body.size()));
  10371. } else {
  10372. res.set_header("Content-Length", head_length.empty() ? "0" : head_length);
  10373. }
  10374. }
  10375. } // namespace detail
  10376. inline size_t Response::get_header_value_u64(const std::string &key, size_t def,
  10377. size_t id) const {
  10378. return detail::get_header_value_u64(headers, key, def, id);
  10379. }
  10380. inline bool Response::has_header(const std::string &key) const {
  10381. return headers.find(key) != headers.end();
  10382. }
  10383. inline std::string Response::get_header_value(const std::string &key,
  10384. const char *def,
  10385. size_t id) const {
  10386. return detail::get_header_value(headers, key, def, id);
  10387. }
  10388. inline size_t Response::get_header_value_count(const std::string &key) const {
  10389. return detail::get_header_value_count(headers, key);
  10390. }
  10391. inline void Response::set_header(const std::string &key,
  10392. const std::string &val) {
  10393. detail::set_header(headers, key, val);
  10394. }
  10395. inline bool Response::has_trailer(const std::string &key) const {
  10396. return trailers.find(key) != trailers.end();
  10397. }
  10398. inline std::string Response::get_trailer_value(const std::string &key,
  10399. size_t id) const {
  10400. return detail::get_multimap_value(trailers, key, id);
  10401. }
  10402. inline size_t Response::get_trailer_value_count(const std::string &key) const {
  10403. return trailers.count(key);
  10404. }
  10405. inline void Response::set_redirect(const std::string &url, int stat) {
  10406. if (detail::fields::is_field_value(url)) {
  10407. set_header("Location", url);
  10408. if (300 <= stat && stat < 400) {
  10409. this->status = stat;
  10410. } else {
  10411. this->status = StatusCode::Found_302;
  10412. }
  10413. }
  10414. }
  10415. inline void Response::set_content(const char *s, size_t n,
  10416. const std::string &content_type) {
  10417. body.assign(s, n); // Before the releaser runs; it may own `s`.
  10418. detail::clear_content_provider(*this);
  10419. detail::set_content_type(*this, content_type);
  10420. }
  10421. inline void Response::set_content(const std::string &s,
  10422. const std::string &content_type) {
  10423. set_content(s.data(), s.size(), content_type);
  10424. }
  10425. inline void Response::set_content(std::string &&s,
  10426. const std::string &content_type) {
  10427. body = std::move(s);
  10428. detail::clear_content_provider(*this);
  10429. detail::set_content_type(*this, content_type);
  10430. }
  10431. inline void Response::set_content_provider(
  10432. size_t in_length, const std::string &content_type, ContentProvider provider,
  10433. ContentProviderResourceReleaser resource_releaser) {
  10434. detail::clear_content(*this);
  10435. detail::set_content_type(*this, content_type);
  10436. content_length_ = in_length;
  10437. if (in_length > 0) { content_provider_ = std::move(provider); }
  10438. content_provider_resource_releaser_ = std::move(resource_releaser);
  10439. }
  10440. inline void Response::set_content_provider(
  10441. const std::string &content_type, ContentProviderWithoutLength provider,
  10442. ContentProviderResourceReleaser resource_releaser) {
  10443. detail::clear_content(*this);
  10444. detail::set_content_type(*this, content_type);
  10445. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  10446. content_provider_resource_releaser_ = std::move(resource_releaser);
  10447. }
  10448. inline void Response::set_chunked_content_provider(
  10449. const std::string &content_type, ContentProviderWithoutLength provider,
  10450. ContentProviderResourceReleaser resource_releaser) {
  10451. set_content_provider(content_type, std::move(provider),
  10452. std::move(resource_releaser));
  10453. is_chunked_content_provider_ = true;
  10454. }
  10455. inline void Response::set_file_content(const std::string &path,
  10456. const std::string &content_type) {
  10457. detail::clear_content(*this);
  10458. headers.erase("Content-Type");
  10459. file_content_path_ = path;
  10460. file_content_content_type_ = content_type;
  10461. }
  10462. inline void Response::set_file_content(const std::string &path) {
  10463. set_file_content(path, std::string());
  10464. }
  10465. // Result implementation
  10466. inline size_t Result::get_request_header_value_u64(const std::string &key,
  10467. size_t def,
  10468. size_t id) const {
  10469. return detail::get_header_value_u64(request_headers_, key, def, id);
  10470. }
  10471. inline bool Result::has_request_header(const std::string &key) const {
  10472. return request_headers_.find(key) != request_headers_.end();
  10473. }
  10474. inline std::string Result::get_request_header_value(const std::string &key,
  10475. const char *def,
  10476. size_t id) const {
  10477. return detail::get_header_value(request_headers_, key, def, id);
  10478. }
  10479. inline size_t
  10480. Result::get_request_header_value_count(const std::string &key) const {
  10481. return request_headers_.count(key);
  10482. }
  10483. // Stream implementation
  10484. inline ssize_t Stream::write(const char *ptr) {
  10485. return write(ptr, strlen(ptr));
  10486. }
  10487. inline ssize_t Stream::write(const std::string &s) {
  10488. return write(s.data(), s.size());
  10489. }
  10490. // BodyReader implementation
  10491. inline ssize_t detail::BodyReader::read(char *buf, size_t len) {
  10492. if (!stream) {
  10493. last_error = Error::Connection;
  10494. return -1;
  10495. }
  10496. if (eof) { return 0; }
  10497. if (!chunked) {
  10498. // Content-Length based reading
  10499. if (has_content_length && bytes_read >= content_length) {
  10500. eof = true;
  10501. return 0;
  10502. }
  10503. auto to_read = len;
  10504. if (has_content_length) {
  10505. auto remaining = content_length - bytes_read;
  10506. to_read = (std::min)(len, remaining);
  10507. }
  10508. auto n = stream->read(buf, to_read);
  10509. // Without Content-Length the body ends when the connection closes
  10510. // (RFC 9112 §6.3); with one, an EOF here came too early
  10511. if (n < 0 || (n == 0 && has_content_length)) {
  10512. last_error = stream->get_error();
  10513. if (last_error == Error::Success) { last_error = Error::Read; }
  10514. }
  10515. if (n <= 0) {
  10516. eof = true;
  10517. return n;
  10518. }
  10519. bytes_read += static_cast<size_t>(n);
  10520. if (has_content_length && bytes_read >= content_length) { eof = true; }
  10521. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10522. last_error = Error::ExceedMaxPayloadSize;
  10523. eof = true;
  10524. return -1;
  10525. }
  10526. return n;
  10527. }
  10528. // Chunked transfer encoding: delegate to shared decoder instance.
  10529. if (!chunked_decoder) { chunked_decoder.reset(new ChunkedDecoder(*stream)); }
  10530. size_t chunk_offset = 0;
  10531. size_t chunk_total = 0;
  10532. auto n = chunked_decoder->read_payload(buf, len, chunk_offset, chunk_total);
  10533. if (n < 0) {
  10534. last_error = stream->get_error();
  10535. if (last_error == Error::Success) { last_error = Error::Read; }
  10536. eof = true;
  10537. return n;
  10538. }
  10539. if (n == 0) {
  10540. // Final chunk observed. Leave trailer parsing to the caller (StreamHandle).
  10541. eof = true;
  10542. return 0;
  10543. }
  10544. bytes_read += static_cast<size_t>(n);
  10545. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10546. last_error = Error::ExceedMaxPayloadSize;
  10547. eof = true;
  10548. return -1;
  10549. }
  10550. return n;
  10551. }
  10552. // ThreadPool implementation
  10553. inline ThreadPool::ThreadPool(size_t n, size_t max_n, size_t mqr,
  10554. time_t idle_timeout_sec)
  10555. : base_thread_count_(n), max_queued_requests_(mqr),
  10556. idle_timeout_sec_(idle_timeout_sec), idle_thread_count_(0),
  10557. shutdown_(false) {
  10558. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10559. if (max_n != 0 && max_n < n) {
  10560. std::string msg = "max_threads must be >= base_threads";
  10561. throw std::invalid_argument(msg);
  10562. }
  10563. #endif
  10564. max_thread_count_ = max_n == 0 ? n : max_n;
  10565. threads_.reserve(base_thread_count_);
  10566. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10567. try {
  10568. #endif
  10569. for (size_t i = 0; i < base_thread_count_; i++) {
  10570. threads_.emplace_back(std::thread([this]() { worker(false); }));
  10571. }
  10572. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10573. } catch (...) {
  10574. // If thread creation fails partway (e.g., pthread_create returns EAGAIN),
  10575. // signal the workers we already spawned to exit and join them so the
  10576. // vector destructor does not see joinable threads (which would call
  10577. // std::terminate). Then rethrow so the caller learns of the failure.
  10578. {
  10579. std::unique_lock<std::mutex> lock(mutex_);
  10580. shutdown_ = true;
  10581. }
  10582. cond_.notify_all();
  10583. for (auto &t : threads_) {
  10584. if (t.joinable()) { t.join(); }
  10585. }
  10586. throw;
  10587. }
  10588. #endif
  10589. }
  10590. inline bool ThreadPool::enqueue(std::function<void()> fn) {
  10591. {
  10592. std::unique_lock<std::mutex> lock(mutex_);
  10593. if (shutdown_) { return false; }
  10594. if (max_queued_requests_ > 0 && jobs_.size() >= max_queued_requests_) {
  10595. return false;
  10596. }
  10597. jobs_.push_back(std::move(fn));
  10598. // Spawn a dynamic thread if jobs outnumber idle threads and under max
  10599. if (jobs_.size() > idle_thread_count_ &&
  10600. threads_.size() + dynamic_threads_.size() < max_thread_count_) {
  10601. cleanup_finished_threads();
  10602. dynamic_threads_.emplace_back(std::thread([this]() { worker(true); }));
  10603. }
  10604. }
  10605. cond_.notify_one();
  10606. return true;
  10607. }
  10608. inline void ThreadPool::shutdown() {
  10609. {
  10610. std::unique_lock<std::mutex> lock(mutex_);
  10611. shutdown_ = true;
  10612. }
  10613. cond_.notify_all();
  10614. for (auto &t : threads_) {
  10615. if (t.joinable()) { t.join(); }
  10616. }
  10617. // Move dynamic_threads_ to a local list under the lock to avoid racing
  10618. // with worker threads that call move_to_finished() concurrently.
  10619. std::list<std::thread> remaining_dynamic;
  10620. {
  10621. std::unique_lock<std::mutex> lock(mutex_);
  10622. remaining_dynamic = std::move(dynamic_threads_);
  10623. }
  10624. for (auto &t : remaining_dynamic) {
  10625. if (t.joinable()) { t.join(); }
  10626. }
  10627. std::unique_lock<std::mutex> lock(mutex_);
  10628. cleanup_finished_threads();
  10629. }
  10630. inline void ThreadPool::move_to_finished(std::thread::id id) {
  10631. // Must be called with mutex_ held
  10632. for (auto it = dynamic_threads_.begin(); it != dynamic_threads_.end(); ++it) {
  10633. if (it->get_id() == id) {
  10634. finished_threads_.push_back(std::move(*it));
  10635. dynamic_threads_.erase(it);
  10636. return;
  10637. }
  10638. }
  10639. }
  10640. inline void ThreadPool::cleanup_finished_threads() {
  10641. // Must be called with mutex_ held
  10642. for (auto &t : finished_threads_) {
  10643. if (t.joinable()) { t.join(); }
  10644. }
  10645. finished_threads_.clear();
  10646. }
  10647. inline void ThreadPool::worker(bool is_dynamic) {
  10648. for (;;) {
  10649. std::function<void()> fn;
  10650. {
  10651. std::unique_lock<std::mutex> lock(mutex_);
  10652. idle_thread_count_++;
  10653. if (is_dynamic) {
  10654. auto has_work =
  10655. cond_.wait_for(lock, std::chrono::seconds(idle_timeout_sec_),
  10656. [&] { return !jobs_.empty() || shutdown_; });
  10657. if (!has_work) {
  10658. // Timed out with no work - exit this dynamic thread
  10659. idle_thread_count_--;
  10660. move_to_finished(std::this_thread::get_id());
  10661. break;
  10662. }
  10663. } else {
  10664. cond_.wait(lock, [&] { return !jobs_.empty() || shutdown_; });
  10665. }
  10666. idle_thread_count_--;
  10667. if (shutdown_ && jobs_.empty()) { break; }
  10668. fn = std::move(jobs_.front());
  10669. jobs_.pop_front();
  10670. }
  10671. assert(true == static_cast<bool>(fn));
  10672. fn();
  10673. }
  10674. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(OPENSSL_IS_BORINGSSL) && \
  10675. !defined(LIBRESSL_VERSION_NUMBER)
  10676. OPENSSL_thread_stop();
  10677. #endif
  10678. }
  10679. /*
  10680. * Group 1 (continued): detail namespace - Stream implementations
  10681. */
  10682. namespace detail {
  10683. inline void calc_actual_timeout(time_t max_timeout_msec, time_t duration_msec,
  10684. time_t timeout_sec, time_t timeout_usec,
  10685. time_t &actual_timeout_sec,
  10686. time_t &actual_timeout_usec) {
  10687. auto timeout_msec = (timeout_sec * 1000) + (timeout_usec / 1000);
  10688. auto actual_timeout_msec =
  10689. (std::min)(max_timeout_msec - duration_msec, timeout_msec);
  10690. if (actual_timeout_msec < 0) { actual_timeout_msec = 0; }
  10691. actual_timeout_sec = actual_timeout_msec / 1000;
  10692. actual_timeout_usec = (actual_timeout_msec % 1000) * 1000;
  10693. }
  10694. // Socket stream implementation
  10695. inline SocketStream::SocketStream(
  10696. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  10697. time_t write_timeout_sec, time_t write_timeout_usec,
  10698. time_t max_timeout_msec,
  10699. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10700. : sock_(sock), read_timeout_sec_(read_timeout_sec),
  10701. read_timeout_usec_(read_timeout_usec),
  10702. write_timeout_sec_(write_timeout_sec),
  10703. write_timeout_usec_(write_timeout_usec),
  10704. max_timeout_msec_(max_timeout_msec), start_time_(start_time),
  10705. read_buff_(read_buff_size_, 0) {}
  10706. inline SocketStream::~SocketStream() = default;
  10707. inline bool SocketStream::is_readable() const {
  10708. return read_buff_off_ < read_buff_content_size_;
  10709. }
  10710. inline bool SocketStream::wait_readable() const {
  10711. if (max_timeout_msec_ <= 0) {
  10712. return select_read_interruptible(sock_, read_timeout_sec_,
  10713. read_timeout_usec_, read_interrupted_) > 0;
  10714. }
  10715. time_t read_timeout_sec;
  10716. time_t read_timeout_usec;
  10717. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10718. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10719. return select_read_interruptible(sock_, read_timeout_sec, read_timeout_usec,
  10720. read_interrupted_) > 0;
  10721. }
  10722. inline bool SocketStream::wait_writable() const {
  10723. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10724. }
  10725. inline bool SocketStream::ensure_readable() {
  10726. if (readable_hint_) {
  10727. readable_hint_ = false;
  10728. return true;
  10729. }
  10730. return wait_readable();
  10731. }
  10732. inline const char *SocketStream::buffered_data(size_t &size) const {
  10733. size = read_buff_content_size_ - read_buff_off_;
  10734. return size ? read_buff_.data() + read_buff_off_ : nullptr;
  10735. }
  10736. inline void SocketStream::consume_buffered(size_t size) {
  10737. assert(size <= read_buff_content_size_ - read_buff_off_);
  10738. read_buff_off_ += size;
  10739. }
  10740. inline bool SocketStream::is_peer_alive() const {
  10741. return detail::is_socket_alive(sock_);
  10742. }
  10743. inline ssize_t SocketStream::read(char *ptr, size_t size) {
  10744. #ifdef _WIN32
  10745. size =
  10746. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10747. #else
  10748. size = (std::min)(size,
  10749. static_cast<size_t>((std::numeric_limits<ssize_t>::max)()));
  10750. #endif
  10751. if (read_buff_off_ < read_buff_content_size_) {
  10752. auto remaining_size = read_buff_content_size_ - read_buff_off_;
  10753. if (size <= remaining_size) {
  10754. memcpy(ptr, read_buff_.data() + read_buff_off_, size);
  10755. read_buff_off_ += size;
  10756. return static_cast<ssize_t>(size);
  10757. } else {
  10758. memcpy(ptr, read_buff_.data() + read_buff_off_, remaining_size);
  10759. read_buff_off_ += remaining_size;
  10760. return static_cast<ssize_t>(remaining_size);
  10761. }
  10762. }
  10763. if (!ensure_readable()) {
  10764. error_ = Error::Timeout;
  10765. return -1;
  10766. }
  10767. read_buff_off_ = 0;
  10768. read_buff_content_size_ = 0;
  10769. if (size < read_buff_size_) {
  10770. auto n = read_socket(sock_, read_buff_.data(), read_buff_size_,
  10771. CPPHTTPLIB_RECV_FLAGS);
  10772. if (n <= 0) {
  10773. if (n == 0) {
  10774. error_ = Error::ConnectionClosed;
  10775. } else {
  10776. error_ = Error::Read;
  10777. }
  10778. return n;
  10779. } else if (n <= static_cast<ssize_t>(size)) {
  10780. memcpy(ptr, read_buff_.data(), static_cast<size_t>(n));
  10781. return n;
  10782. } else {
  10783. memcpy(ptr, read_buff_.data(), size);
  10784. read_buff_off_ = size;
  10785. read_buff_content_size_ = static_cast<size_t>(n);
  10786. return static_cast<ssize_t>(size);
  10787. }
  10788. } else {
  10789. auto n = read_socket(sock_, ptr, size, CPPHTTPLIB_RECV_FLAGS);
  10790. if (n <= 0) {
  10791. if (n == 0) {
  10792. error_ = Error::ConnectionClosed;
  10793. } else {
  10794. error_ = Error::Read;
  10795. }
  10796. }
  10797. return n;
  10798. }
  10799. }
  10800. inline ssize_t SocketStream::write(const char *ptr, size_t size) {
  10801. if (!wait_writable()) { return -1; }
  10802. #if defined(_WIN32) && !defined(_WIN64)
  10803. size =
  10804. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10805. #endif
  10806. return send_socket(sock_, ptr, size, CPPHTTPLIB_SEND_FLAGS);
  10807. }
  10808. inline void SocketStream::get_remote_ip_and_port(std::string &ip,
  10809. int &port) const {
  10810. return detail::get_remote_ip_and_port(sock_, ip, port);
  10811. }
  10812. inline void SocketStream::get_local_ip_and_port(std::string &ip,
  10813. int &port) const {
  10814. return detail::get_local_ip_and_port(sock_, ip, port);
  10815. }
  10816. inline socket_t SocketStream::socket() const { return sock_; }
  10817. inline time_t SocketStream::duration() const {
  10818. return static_cast<time_t>(
  10819. std::chrono::duration_cast<std::chrono::milliseconds>(
  10820. std::chrono::steady_clock::now() - start_time_)
  10821. .count());
  10822. }
  10823. inline void SocketStream::set_read_timeout(time_t sec, time_t usec) {
  10824. read_timeout_sec_ = sec;
  10825. read_timeout_usec_ = usec;
  10826. }
  10827. inline void SocketStream::set_max_timeout(time_t msec) {
  10828. max_timeout_msec_ = msec;
  10829. start_time_ = std::chrono::steady_clock::now();
  10830. }
  10831. inline void
  10832. SocketStream::set_read_interrupt(std::function<bool()> interrupted) {
  10833. read_interrupted_ = std::move(interrupted);
  10834. }
  10835. // Buffer stream implementation
  10836. inline bool BufferStream::is_readable() const { return true; }
  10837. inline bool BufferStream::wait_readable() const { return true; }
  10838. inline bool BufferStream::wait_writable() const { return true; }
  10839. inline ssize_t BufferStream::read(char *ptr, size_t size) {
  10840. #if defined(_MSC_VER) && _MSC_VER < 1910
  10841. auto len_read = buffer._Copy_s(ptr, size, size, position);
  10842. #else
  10843. auto len_read = buffer.copy(ptr, size, position);
  10844. #endif
  10845. position += static_cast<size_t>(len_read);
  10846. return static_cast<ssize_t>(len_read);
  10847. }
  10848. inline ssize_t BufferStream::write(const char *ptr, size_t size) {
  10849. buffer.append(ptr, size);
  10850. return static_cast<ssize_t>(size);
  10851. }
  10852. inline void BufferStream::get_remote_ip_and_port(std::string & /*ip*/,
  10853. int & /*port*/) const {}
  10854. inline void BufferStream::get_local_ip_and_port(std::string & /*ip*/,
  10855. int & /*port*/) const {}
  10856. inline socket_t BufferStream::socket() const { return 0; }
  10857. inline time_t BufferStream::duration() const { return 0; }
  10858. inline const std::string &BufferStream::get_buffer() const { return buffer; }
  10859. inline PathParamsMatcher::PathParamsMatcher(const std::string &pattern)
  10860. : MatcherBase(pattern) {
  10861. constexpr const char marker[] = "/:";
  10862. // One past the last ending position of a path param substring
  10863. std::size_t last_param_end = 0;
  10864. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10865. // Needed to ensure that parameter names are unique during matcher
  10866. // construction
  10867. // If exceptions are disabled, only last duplicate path
  10868. // parameter will be set
  10869. std::unordered_set<std::string> param_name_set;
  10870. #endif
  10871. while (true) {
  10872. const auto marker_pos = pattern.find(
  10873. marker, last_param_end == 0 ? last_param_end : last_param_end - 1);
  10874. if (marker_pos == std::string::npos) { break; }
  10875. static_fragments_.push_back(
  10876. pattern.substr(last_param_end, marker_pos - last_param_end + 1));
  10877. const auto param_name_start = marker_pos + str_len(marker);
  10878. auto sep_pos = pattern.find(separator, param_name_start);
  10879. if (sep_pos == std::string::npos) { sep_pos = pattern.length(); }
  10880. auto param_name =
  10881. pattern.substr(param_name_start, sep_pos - param_name_start);
  10882. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10883. if (param_name_set.find(param_name) != param_name_set.cend()) {
  10884. std::string msg = "Encountered path parameter '" + param_name +
  10885. "' multiple times in route pattern '" + pattern + "'.";
  10886. throw std::invalid_argument(msg);
  10887. }
  10888. #endif
  10889. param_names_.push_back(std::move(param_name));
  10890. last_param_end = sep_pos + 1;
  10891. }
  10892. if (last_param_end < pattern.length()) {
  10893. static_fragments_.push_back(pattern.substr(last_param_end));
  10894. }
  10895. }
  10896. inline bool PathParamsMatcher::match(Request &request) const {
  10897. request.matches = std::smatch();
  10898. request.path_params.clear();
  10899. // A pattern without parameters is just a literal path to compare against
  10900. if (param_names_.empty()) { return request.path == pattern(); }
  10901. request.path_params.reserve(param_names_.size());
  10902. // One past the position at which the path matched the pattern last time
  10903. std::size_t starting_pos = 0;
  10904. for (size_t i = 0; i < static_fragments_.size(); ++i) {
  10905. const auto &fragment = static_fragments_[i];
  10906. if (starting_pos + fragment.length() > request.path.length()) {
  10907. return false;
  10908. }
  10909. // Avoid unnecessary allocation by using strncmp instead of substr +
  10910. // comparison
  10911. if (std::strncmp(request.path.c_str() + starting_pos, fragment.c_str(),
  10912. fragment.length()) != 0) {
  10913. return false;
  10914. }
  10915. starting_pos += fragment.length();
  10916. // Should only happen when we have a static fragment after a param
  10917. // Example: '/users/:id/subscriptions'
  10918. // The 'subscriptions' fragment here does not have a corresponding param
  10919. if (i >= param_names_.size()) { continue; }
  10920. auto sep_pos = request.path.find(separator, starting_pos);
  10921. if (sep_pos == std::string::npos) { sep_pos = request.path.length(); }
  10922. const auto &param_name = param_names_[i];
  10923. request.path_params.emplace(
  10924. param_name, request.path.substr(starting_pos, sep_pos - starting_pos));
  10925. // Mark everything up to '/' as matched
  10926. starting_pos = sep_pos + 1;
  10927. }
  10928. // Returns false if the path is longer than the pattern
  10929. return starting_pos >= request.path.length();
  10930. }
  10931. inline bool RegexMatcher::match(Request &request) const {
  10932. request.path_params.clear();
  10933. // See CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH: an overlong path is treated as
  10934. // a non-match rather than risking a stack overflow in std::regex_match.
  10935. if (request.path.length() > CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH) {
  10936. return false;
  10937. }
  10938. return std::regex_match(request.path, request.matches, regex_);
  10939. }
  10940. // Enclose IPv6 address in brackets if needed
  10941. inline std::string prepare_host_string(const std::string &host) {
  10942. // Enclose IPv6 address in brackets (but not if already enclosed)
  10943. if (host.find(':') == std::string::npos ||
  10944. (!host.empty() && host[0] == '[')) {
  10945. // IPv4, hostname, or already bracketed IPv6
  10946. return host;
  10947. } else {
  10948. // IPv6 address without brackets
  10949. return "[" + host + "]";
  10950. }
  10951. }
  10952. inline std::string make_host_and_port_string(const std::string &host, int port,
  10953. bool is_ssl) {
  10954. auto result = prepare_host_string(host);
  10955. // Append port if not default
  10956. if ((!is_ssl && port == 80) || (is_ssl && port == 443)) {
  10957. ; // do nothing
  10958. } else {
  10959. result += ":" + std::to_string(port);
  10960. }
  10961. return result;
  10962. }
  10963. // Create "host:port" string always including port number (for CONNECT method)
  10964. inline std::string
  10965. make_host_and_port_string_always_port(const std::string &host, int port) {
  10966. return prepare_host_string(host) + ":" + std::to_string(port);
  10967. }
  10968. // Value for the Host header a client sends when the caller supplied none.
  10969. // Only the value: callers decide where in their header list it goes.
  10970. inline std::string make_default_host_header_value(const std::string &host,
  10971. int port, bool is_ssl,
  10972. int address_family) {
  10973. if (address_family == AF_UNIX) { return "localhost"; }
  10974. return make_host_and_port_string(host, port, is_ssl);
  10975. }
  10976. inline void add_default_user_agent_header(Request &req) {
  10977. #ifndef CPPHTTPLIB_NO_DEFAULT_USER_AGENT
  10978. if (!req.has_header("User-Agent")) {
  10979. req.set_header("User-Agent",
  10980. std::string("cpp-httplib/") + CPPHTTPLIB_VERSION);
  10981. }
  10982. #else
  10983. (void)req;
  10984. #endif
  10985. }
  10986. bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out);
  10987. NormalizedTarget normalize_target(const std::string &host);
  10988. bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits);
  10989. bool host_matches_no_proxy(const NormalizedTarget &target,
  10990. const std::vector<NoProxyEntry> &entries);
  10991. inline bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits) {
  10992. if (prefix_bits < 0 || prefix_bits > 128) { return false; }
  10993. if (prefix_bits == 0) { return true; }
  10994. int full_bytes = prefix_bits / 8;
  10995. int rem_bits = prefix_bits % 8;
  10996. if (full_bytes > 0 && std::memcmp(ip.data(), net.data(),
  10997. static_cast<size_t>(full_bytes)) != 0) {
  10998. return false;
  10999. }
  11000. if (rem_bits == 0) { return true; }
  11001. auto i = static_cast<size_t>(full_bytes);
  11002. auto mask = static_cast<uint8_t>(0xFFu << (8 - rem_bits));
  11003. return (ip[i] & mask) == (net[i] & mask);
  11004. }
  11005. inline bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out) {
  11006. if (token.empty()) { return false; }
  11007. if (token == "*") {
  11008. out.kind = NoProxyKind::Wildcard;
  11009. return true;
  11010. }
  11011. auto slash = token.find('/');
  11012. std::string addr_part =
  11013. (slash == std::string::npos) ? token : token.substr(0, slash);
  11014. std::string prefix_part =
  11015. (slash == std::string::npos) ? std::string() : token.substr(slash + 1);
  11016. // A bare slash or trailing-slash CIDR like "10.0.0.0/" is malformed;
  11017. // don't silently treat it as a /32 (or /128).
  11018. if (slash != std::string::npos && prefix_part.empty()) { return false; }
  11019. // Accept the bracketed IPv6 form ("[::1]", "[fe80::]/10") as well as the
  11020. // bare form. Brackets have no meaning for IPv4, so skip the IPv4 attempt
  11021. // when brackets are present.
  11022. bool bracketed = addr_part.size() >= 2 && addr_part.front() == '[' &&
  11023. addr_part.back() == ']';
  11024. if (bracketed) { addr_part = addr_part.substr(1, addr_part.size() - 2); }
  11025. if (!bracketed) {
  11026. struct in_addr v4;
  11027. if (inet_pton(AF_INET, addr_part.c_str(), &v4) == 1) {
  11028. int prefix = 32;
  11029. if (!prefix_part.empty() &&
  11030. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 32,
  11031. prefix)) {
  11032. return false;
  11033. }
  11034. out.kind = NoProxyKind::IPv4Cidr;
  11035. std::memcpy(out.net.data(), &v4, sizeof(v4));
  11036. out.prefix_bits = prefix;
  11037. return true;
  11038. }
  11039. }
  11040. struct in6_addr v6;
  11041. if (inet_pton(AF_INET6, addr_part.c_str(), &v6) == 1) {
  11042. int prefix = 128;
  11043. if (!prefix_part.empty() &&
  11044. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 128,
  11045. prefix)) {
  11046. return false;
  11047. }
  11048. out.kind = NoProxyKind::IPv6Cidr;
  11049. std::memcpy(out.net.data(), &v6, sizeof(v6));
  11050. out.prefix_bits = prefix;
  11051. return true;
  11052. }
  11053. // Bracketed entries can only be IPv6. If the IPv6 parse above failed,
  11054. // the entry is malformed — don't fall through to the hostname branch.
  11055. if (bracketed) { return false; }
  11056. // A '/' on a non-IP token means a CIDR prefix without an address. Reject.
  11057. if (slash != std::string::npos) { return false; }
  11058. // Port-specific entries (host:port) are not supported.
  11059. if (token.find(':') != std::string::npos) { return false; }
  11060. std::string hostname = case_ignore::to_lower(token);
  11061. while (!hostname.empty() && hostname.front() == '.') {
  11062. hostname.erase(hostname.begin());
  11063. }
  11064. while (!hostname.empty() && hostname.back() == '.') {
  11065. hostname.pop_back();
  11066. }
  11067. if (hostname.empty()) { return false; }
  11068. out.kind = NoProxyKind::HostnameSuffix;
  11069. out.hostname_pattern = std::move(hostname);
  11070. return true;
  11071. }
  11072. inline std::vector<NoProxyEntry>
  11073. parse_no_proxy_entries(const std::vector<std::string> &patterns) {
  11074. std::vector<NoProxyEntry> entries;
  11075. entries.reserve(patterns.size());
  11076. for (const auto &p : patterns) {
  11077. auto trimmed = trim_copy(p);
  11078. if (trimmed.empty()) { continue; }
  11079. NoProxyEntry entry;
  11080. if (parse_no_proxy_entry(trimmed, entry)) {
  11081. entries.push_back(std::move(entry));
  11082. }
  11083. }
  11084. return entries;
  11085. }
  11086. inline NormalizedTarget normalize_target(const std::string &host) {
  11087. NormalizedTarget t;
  11088. std::string h = host;
  11089. if (h.size() >= 2 && h.front() == '[' && h.back() == ']') {
  11090. h = h.substr(1, h.size() - 2);
  11091. }
  11092. // Strip a single trailing dot so "example.com." canonicalizes to
  11093. // "example.com".
  11094. if (!h.empty() && h.back() == '.') { h.pop_back(); }
  11095. t.hostname = case_ignore::to_lower(h);
  11096. if (!t.hostname.empty()) {
  11097. struct in_addr v4;
  11098. struct in6_addr v6;
  11099. if (inet_pton(AF_INET, t.hostname.c_str(), &v4) == 1) {
  11100. t.is_ipv4 = true;
  11101. std::memcpy(t.ip.data(), &v4, sizeof(v4));
  11102. } else if (inet_pton(AF_INET6, t.hostname.c_str(), &v6) == 1) {
  11103. t.is_ipv6 = true;
  11104. std::memcpy(t.ip.data(), &v6, sizeof(v6));
  11105. }
  11106. }
  11107. return t;
  11108. }
  11109. inline bool host_matches_no_proxy(const NormalizedTarget &target,
  11110. const std::vector<NoProxyEntry> &entries) {
  11111. if (target.hostname.empty()) { return false; }
  11112. for (const auto &e : entries) {
  11113. switch (e.kind) {
  11114. case NoProxyKind::Wildcard: return true;
  11115. case NoProxyKind::IPv4Cidr:
  11116. if (target.is_ipv4 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  11117. return true;
  11118. }
  11119. break;
  11120. case NoProxyKind::IPv6Cidr:
  11121. if (target.is_ipv6 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  11122. return true;
  11123. }
  11124. break;
  11125. case NoProxyKind::HostnameSuffix:
  11126. if (target.is_ipv4 || target.is_ipv6) { break; }
  11127. if (target.hostname == e.hostname_pattern) { return true; }
  11128. // Dot-boundary suffix match: prevents "evilexample.com" from matching
  11129. // an entry of "example.com".
  11130. if (target.hostname.size() > e.hostname_pattern.size() + 1) {
  11131. auto offset = target.hostname.size() - e.hostname_pattern.size();
  11132. if (target.hostname[offset - 1] == '.' &&
  11133. target.hostname.compare(offset, e.hostname_pattern.size(),
  11134. e.hostname_pattern) == 0) {
  11135. return true;
  11136. }
  11137. }
  11138. break;
  11139. }
  11140. }
  11141. return false;
  11142. }
  11143. template <typename T>
  11144. inline bool check_and_write_headers(Stream &strm, Headers &headers,
  11145. T header_writer, Error &error) {
  11146. for (const auto &h : headers) {
  11147. if (!detail::fields::is_field_valid(h.first, h.second)) {
  11148. error = Error::InvalidHeaders;
  11149. return false;
  11150. }
  11151. }
  11152. if (header_writer(strm, headers) <= 0) {
  11153. error = Error::Write;
  11154. return false;
  11155. }
  11156. return true;
  11157. }
  11158. } // namespace detail
  11159. /*
  11160. * Group 2 (continued): detail namespace - SSLSocketStream implementation
  11161. */
  11162. #ifdef CPPHTTPLIB_SSL_ENABLED
  11163. namespace detail {
  11164. // SSL socket stream implementation
  11165. inline SSLSocketStream::SSLSocketStream(
  11166. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  11167. time_t read_timeout_usec, time_t write_timeout_sec,
  11168. time_t write_timeout_usec, time_t max_timeout_msec,
  11169. std::chrono::time_point<std::chrono::steady_clock> start_time)
  11170. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  11171. read_timeout_usec_(read_timeout_usec),
  11172. write_timeout_sec_(write_timeout_sec),
  11173. write_timeout_usec_(write_timeout_usec),
  11174. max_timeout_msec_(max_timeout_msec), start_time_(start_time) {
  11175. tls_error_.code = tls::ErrorCode::Success;
  11176. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  11177. // Clear AUTO_RETRY for proper non-blocking I/O timeout handling
  11178. // Note: create_session() also clears this, but SSLClient currently
  11179. // uses ssl_new() which does not. Until full TLS API migration is complete,
  11180. // we need to ensure AUTO_RETRY is cleared here regardless of how the
  11181. // SSL session was created.
  11182. SSL_clear_mode(static_cast<SSL *>(session), SSL_MODE_AUTO_RETRY);
  11183. #endif
  11184. }
  11185. inline SSLSocketStream::~SSLSocketStream() = default;
  11186. inline bool SSLSocketStream::is_readable() const {
  11187. return tls::pending(session_) > 0;
  11188. }
  11189. inline bool SSLSocketStream::wait_readable() const {
  11190. if (max_timeout_msec_ <= 0) {
  11191. return select_read_interruptible(sock_, read_timeout_sec_,
  11192. read_timeout_usec_, read_interrupted_) > 0;
  11193. }
  11194. time_t read_timeout_sec;
  11195. time_t read_timeout_usec;
  11196. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  11197. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  11198. return select_read_interruptible(sock_, read_timeout_sec, read_timeout_usec,
  11199. read_interrupted_) > 0;
  11200. }
  11201. inline bool SSLSocketStream::wait_writable() const {
  11202. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0 &&
  11203. !tls::is_peer_closed(session_, sock_);
  11204. }
  11205. inline bool SSLSocketStream::ensure_readable() {
  11206. if (readable_hint_) {
  11207. readable_hint_ = false;
  11208. return true;
  11209. }
  11210. return wait_readable();
  11211. }
  11212. inline bool SSLSocketStream::is_peer_alive() const {
  11213. return !tls::is_peer_closed(session_, sock_);
  11214. }
  11215. inline ssize_t SSLSocketStream::read(char *ptr, size_t size) {
  11216. if (tls::pending(session_) > 0) {
  11217. tls::TlsError err;
  11218. auto ret = tls::read(session_, ptr, size, err);
  11219. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11220. error_ = Error::ConnectionClosed;
  11221. } else if (ret < 0) {
  11222. tls_error_ = err;
  11223. }
  11224. return ret;
  11225. } else if (ensure_readable()) {
  11226. tls::TlsError err;
  11227. auto ret = tls::read(session_, ptr, size, err);
  11228. if (ret < 0) {
  11229. auto n = 1000;
  11230. #ifdef _WIN32
  11231. while (--n >= 0 && (err.code == tls::ErrorCode::WantRead ||
  11232. (err.code == tls::ErrorCode::SyscallError &&
  11233. WSAGetLastError() == WSAETIMEDOUT))) {
  11234. #else
  11235. while (--n >= 0 && err.code == tls::ErrorCode::WantRead) {
  11236. #endif
  11237. if (tls::pending(session_) > 0) {
  11238. ret = tls::read(session_, ptr, size, err);
  11239. if (ret >= 0) { return ret; }
  11240. break;
  11241. } else if (wait_readable()) {
  11242. std::this_thread::sleep_for(std::chrono::microseconds{10});
  11243. ret = tls::read(session_, ptr, size, err);
  11244. if (ret >= 0) { return ret; }
  11245. } else {
  11246. break;
  11247. }
  11248. }
  11249. assert(ret < 0);
  11250. tls_error_ = err;
  11251. } else if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11252. error_ = Error::ConnectionClosed;
  11253. }
  11254. return ret;
  11255. } else {
  11256. error_ = Error::Timeout;
  11257. return -1;
  11258. }
  11259. }
  11260. inline ssize_t SSLSocketStream::write(const char *ptr, size_t size) {
  11261. if (wait_writable()) {
  11262. auto handle_size =
  11263. std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11264. tls::TlsError err;
  11265. auto ret = tls::write(session_, ptr, handle_size, err);
  11266. if (ret < 0) {
  11267. auto n = 1000;
  11268. #ifdef _WIN32
  11269. while (--n >= 0 && (err.code == tls::ErrorCode::WantWrite ||
  11270. (err.code == tls::ErrorCode::SyscallError &&
  11271. WSAGetLastError() == WSAETIMEDOUT))) {
  11272. #else
  11273. while (--n >= 0 && err.code == tls::ErrorCode::WantWrite) {
  11274. #endif
  11275. if (wait_writable()) {
  11276. std::this_thread::sleep_for(std::chrono::microseconds{10});
  11277. ret = tls::write(session_, ptr, handle_size, err);
  11278. if (ret >= 0) { return ret; }
  11279. } else {
  11280. break;
  11281. }
  11282. }
  11283. assert(ret < 0);
  11284. tls_error_ = err;
  11285. }
  11286. return ret;
  11287. }
  11288. return -1;
  11289. }
  11290. inline void SSLSocketStream::get_remote_ip_and_port(std::string &ip,
  11291. int &port) const {
  11292. detail::get_remote_ip_and_port(sock_, ip, port);
  11293. }
  11294. inline void SSLSocketStream::get_local_ip_and_port(std::string &ip,
  11295. int &port) const {
  11296. detail::get_local_ip_and_port(sock_, ip, port);
  11297. }
  11298. inline socket_t SSLSocketStream::socket() const { return sock_; }
  11299. inline time_t SSLSocketStream::duration() const {
  11300. return static_cast<time_t>(
  11301. std::chrono::duration_cast<std::chrono::milliseconds>(
  11302. std::chrono::steady_clock::now() - start_time_)
  11303. .count());
  11304. }
  11305. inline void SSLSocketStream::set_read_timeout(time_t sec, time_t usec) {
  11306. read_timeout_sec_ = sec;
  11307. read_timeout_usec_ = usec;
  11308. }
  11309. inline void SSLSocketStream::set_max_timeout(time_t msec) {
  11310. max_timeout_msec_ = msec;
  11311. start_time_ = std::chrono::steady_clock::now();
  11312. }
  11313. inline void
  11314. SSLSocketStream::set_read_interrupt(std::function<bool()> interrupted) {
  11315. read_interrupted_ = std::move(interrupted);
  11316. }
  11317. inline WebSocketSSLStream::WebSocketSSLStream(socket_t sock,
  11318. tls::session_t session,
  11319. time_t read_timeout_sec,
  11320. time_t read_timeout_usec,
  11321. time_t write_timeout_sec,
  11322. time_t write_timeout_usec)
  11323. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  11324. read_timeout_usec_(read_timeout_usec),
  11325. write_timeout_sec_(write_timeout_sec),
  11326. write_timeout_usec_(write_timeout_usec),
  11327. start_time_(std::chrono::steady_clock::now()) {
  11328. // The receive and send paths run on different threads, so each TLS call is
  11329. // driven in non-blocking mode and readiness is awaited with select()
  11330. // outside the session lock. Set the socket non-blocking once here; it is
  11331. // never flipped back, so no thread races on the flag.
  11332. detail::set_nonblocking(sock_, true);
  11333. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  11334. SSL_clear_mode(static_cast<SSL *>(session_), SSL_MODE_AUTO_RETRY);
  11335. #endif
  11336. }
  11337. inline WebSocketSSLStream::~WebSocketSSLStream() = default;
  11338. inline bool WebSocketSSLStream::is_readable() const {
  11339. std::lock_guard<std::mutex> guard(session_mutex_);
  11340. return tls::pending(session_) > 0;
  11341. }
  11342. inline bool WebSocketSSLStream::wait_readable() const {
  11343. return select_read_interruptible(sock_, read_timeout_sec_, read_timeout_usec_,
  11344. read_interrupted_) > 0;
  11345. }
  11346. inline bool WebSocketSSLStream::wait_writable() const {
  11347. // Unlike SSLSocketStream, this deliberately does not call is_peer_closed():
  11348. // that probe toggles the socket's blocking flag, which would race with the
  11349. // concurrent reader on a permanently non-blocking socket.
  11350. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  11351. }
  11352. inline ssize_t WebSocketSSLStream::read(char *ptr, size_t size) {
  11353. tls::TlsError err;
  11354. auto n = 1000;
  11355. while (--n >= 0) {
  11356. {
  11357. std::lock_guard<std::mutex> guard(session_mutex_);
  11358. auto ret = tls::read(session_, ptr, size, err);
  11359. if (ret > 0) { return ret; }
  11360. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11361. error_ = Error::ConnectionClosed;
  11362. return ret;
  11363. }
  11364. }
  11365. // ret < 0. On a non-blocking socket a TLS read can stop needing either
  11366. // direction: the send path shares this session, so output it left pending
  11367. // has to be flushed before more input can be decrypted. Anything else is
  11368. // a hard error.
  11369. auto needs_readable = err.code == tls::ErrorCode::WantRead;
  11370. #ifdef _WIN32
  11371. // On Windows a socket timeout surfaces as a syscall error, not WantRead.
  11372. needs_readable =
  11373. needs_readable || (err.code == tls::ErrorCode::SyscallError &&
  11374. WSAGetLastError() == WSAETIMEDOUT);
  11375. #endif
  11376. if (!needs_readable && err.code != tls::ErrorCode::WantWrite) {
  11377. error_ = Error::Read;
  11378. return -1;
  11379. }
  11380. if (!(needs_readable ? wait_readable() : wait_writable())) {
  11381. error_ = Error::Timeout;
  11382. return -1;
  11383. }
  11384. }
  11385. // Out of retries. Recording a reason matters: a caller that reads get_error()
  11386. // to tell a timeout from a close would otherwise see whatever the previous
  11387. // failure left behind (error_ is never cleared on success).
  11388. error_ = Error::Read;
  11389. return -1;
  11390. }
  11391. inline ssize_t WebSocketSSLStream::write(const char *ptr, size_t size) {
  11392. auto handle_size = std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11393. tls::TlsError err;
  11394. auto n = 1000;
  11395. while (--n >= 0) {
  11396. {
  11397. std::lock_guard<std::mutex> guard(session_mutex_);
  11398. auto ret = tls::write(session_, ptr, handle_size, err);
  11399. if (ret >= 0) { return ret; }
  11400. }
  11401. // ret < 0. As in read(), either direction can be needed: a renegotiation
  11402. // or a post-handshake message must be consumed before the record goes
  11403. // out. Anything else is a hard error.
  11404. auto needs_writable = err.code == tls::ErrorCode::WantWrite;
  11405. #ifdef _WIN32
  11406. // On Windows a socket timeout surfaces as a syscall error, not WantWrite.
  11407. needs_writable =
  11408. needs_writable || (err.code == tls::ErrorCode::SyscallError &&
  11409. WSAGetLastError() == WSAETIMEDOUT);
  11410. #endif
  11411. if (!needs_writable && err.code != tls::ErrorCode::WantRead) { return -1; }
  11412. if (!(needs_writable ? wait_writable() : wait_readable())) { return -1; }
  11413. }
  11414. return -1;
  11415. }
  11416. inline void WebSocketSSLStream::get_remote_ip_and_port(std::string &ip,
  11417. int &port) const {
  11418. detail::get_remote_ip_and_port(sock_, ip, port);
  11419. }
  11420. inline void WebSocketSSLStream::get_local_ip_and_port(std::string &ip,
  11421. int &port) const {
  11422. detail::get_local_ip_and_port(sock_, ip, port);
  11423. }
  11424. inline socket_t WebSocketSSLStream::socket() const { return sock_; }
  11425. inline time_t WebSocketSSLStream::duration() const {
  11426. return static_cast<time_t>(
  11427. std::chrono::duration_cast<std::chrono::milliseconds>(
  11428. std::chrono::steady_clock::now() - start_time_)
  11429. .count());
  11430. }
  11431. inline void WebSocketSSLStream::set_read_timeout(time_t sec, time_t usec) {
  11432. read_timeout_sec_ = sec;
  11433. read_timeout_usec_ = usec;
  11434. }
  11435. inline void
  11436. WebSocketSSLStream::set_read_interrupt(std::function<bool()> interrupted) {
  11437. read_interrupted_ = std::move(interrupted);
  11438. }
  11439. } // namespace detail
  11440. #endif // CPPHTTPLIB_SSL_ENABLED
  11441. /*
  11442. * Group 4: Server implementation
  11443. */
  11444. // HTTP server implementation
  11445. inline Server::Server()
  11446. : new_task_queue([] {
  11447. return new ThreadPool(CPPHTTPLIB_THREAD_POOL_COUNT,
  11448. CPPHTTPLIB_THREAD_POOL_MAX_COUNT);
  11449. }) {
  11450. #ifndef _WIN32
  11451. signal(SIGPIPE, SIG_IGN);
  11452. #endif
  11453. }
  11454. inline Server::~Server() = default;
  11455. inline std::unique_ptr<detail::MatcherBase>
  11456. Server::make_matcher(const std::string &pattern) {
  11457. // Path params take precedence, so "/users/:id/(.*)" keeps being matched as
  11458. // a path params pattern
  11459. if (pattern.find("/:") != std::string::npos) {
  11460. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11461. }
  11462. // A pattern with no regex metacharacter only has to be compared literally,
  11463. // which is what PathParamsMatcher already does when it captures no
  11464. // parameter, so std::regex is only worth building for the patterns that
  11465. // actually need it
  11466. if (pattern.find_first_of(".^$|()[]{}*+?\\") == std::string::npos) {
  11467. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11468. }
  11469. return detail::make_unique<detail::RegexMatcher>(pattern);
  11470. }
  11471. inline Server &Server::Get(const std::string &pattern, Handler handler) {
  11472. return add_handler(get_handlers_, pattern, std::move(handler));
  11473. }
  11474. inline Server &Server::Post(const std::string &pattern, Handler handler) {
  11475. return add_handler(post_handlers_, pattern, std::move(handler));
  11476. }
  11477. inline Server &Server::Post(const std::string &pattern,
  11478. HandlerWithContentReader handler) {
  11479. return add_handler(post_handlers_for_content_reader_, pattern,
  11480. std::move(handler));
  11481. }
  11482. inline Server &Server::Put(const std::string &pattern, Handler handler) {
  11483. return add_handler(put_handlers_, pattern, std::move(handler));
  11484. }
  11485. inline Server &Server::Put(const std::string &pattern,
  11486. HandlerWithContentReader handler) {
  11487. return add_handler(put_handlers_for_content_reader_, pattern,
  11488. std::move(handler));
  11489. }
  11490. inline Server &Server::Patch(const std::string &pattern, Handler handler) {
  11491. return add_handler(patch_handlers_, pattern, std::move(handler));
  11492. }
  11493. inline Server &Server::Patch(const std::string &pattern,
  11494. HandlerWithContentReader handler) {
  11495. return add_handler(patch_handlers_for_content_reader_, pattern,
  11496. std::move(handler));
  11497. }
  11498. inline Server &Server::Delete(const std::string &pattern, Handler handler) {
  11499. return add_handler(delete_handlers_, pattern, std::move(handler));
  11500. }
  11501. inline Server &Server::Delete(const std::string &pattern,
  11502. HandlerWithContentReader handler) {
  11503. return add_handler(delete_handlers_for_content_reader_, pattern,
  11504. std::move(handler));
  11505. }
  11506. inline Server &Server::Options(const std::string &pattern, Handler handler) {
  11507. return add_handler(options_handlers_, pattern, std::move(handler));
  11508. }
  11509. inline const std::set<std::string> &Server::builtin_methods() {
  11510. thread_local const std::set<std::string> methods{
  11511. "GET", "HEAD", "POST", "PUT", "DELETE",
  11512. "CONNECT", "OPTIONS", "TRACE", "PATCH", "PRI"};
  11513. return methods;
  11514. }
  11515. inline Server::CustomHandlerEntry *
  11516. Server::custom_entry_for_registration(const std::string &method) {
  11517. // Built-in methods are refused for two different reasons. GET, HEAD, POST,
  11518. // PUT, DELETE, OPTIONS and PATCH are dispatched by the if/else chain in
  11519. // routing() before the custom tables are consulted, so a route registered
  11520. // for one of them could never fire. CONNECT, TRACE and PRI have no branch
  11521. // there and would be reachable, but they carry protocol-level meaning
  11522. // (tunnel setup, request echo, the HTTP/2 connection preface) that this
  11523. // library does not route.
  11524. if (!detail::fields::is_token(method) || builtin_methods().count(method)) {
  11525. output_error_log(Error::InvalidHTTPMethod, nullptr);
  11526. has_invalid_registration_ = true;
  11527. return nullptr;
  11528. }
  11529. return &custom_handlers_[method];
  11530. }
  11531. inline Server &Server::CustomRoute(const std::string &method,
  11532. const std::string &pattern,
  11533. Handler handler) {
  11534. auto *entry = custom_entry_for_registration(method);
  11535. if (!entry) { return *this; }
  11536. return add_handler(entry->handlers, pattern, std::move(handler));
  11537. }
  11538. inline Server &Server::CustomRoute(const std::string &method,
  11539. const std::string &pattern,
  11540. HandlerWithContentReader handler) {
  11541. auto *entry = custom_entry_for_registration(method);
  11542. if (!entry) { return *this; }
  11543. return add_handler(entry->handlers_for_content_reader, pattern,
  11544. std::move(handler));
  11545. }
  11546. inline const Server::CustomHandlerEntry *
  11547. Server::find_custom_entry(const std::string &method) const {
  11548. // find() alone would be correct here. The empty() check is what keeps the
  11549. // per-request cost off servers that never call CustomRoute(), which is the
  11550. // overwhelmingly common case; keep it rather than walking into the tree.
  11551. if (custom_handlers_.empty()) { return nullptr; }
  11552. auto it = custom_handlers_.find(method);
  11553. return it == custom_handlers_.end() ? nullptr : &it->second;
  11554. }
  11555. inline Server &Server::WebSocket(const std::string &pattern,
  11556. WebSocketHandler handler) {
  11557. websocket_handlers_.push_back(
  11558. {make_matcher(pattern), std::move(handler), nullptr});
  11559. return *this;
  11560. }
  11561. inline Server &Server::WebSocket(const std::string &pattern,
  11562. WebSocketHandler handler,
  11563. SubProtocolSelector sub_protocol_selector) {
  11564. websocket_handlers_.push_back({make_matcher(pattern), std::move(handler),
  11565. std::move(sub_protocol_selector)});
  11566. return *this;
  11567. }
  11568. inline bool Server::set_base_dir(const std::string &dir,
  11569. const std::string &mount_point) {
  11570. return set_mount_point(mount_point, dir);
  11571. }
  11572. inline bool Server::set_mount_point(const std::string &mount_point,
  11573. const std::string &dir, Headers headers) {
  11574. detail::FileStat stat(dir);
  11575. if (stat.is_dir()) {
  11576. std::string mnt = !mount_point.empty() ? mount_point : "/";
  11577. if (!mnt.empty() && mnt[0] == '/') {
  11578. // Without the resolved directory, a file could not be checked to be
  11579. // inside it.
  11580. std::string resolved_base;
  11581. if (!detail::canonicalize_path(dir.c_str(), resolved_base)) {
  11582. return false;
  11583. }
  11584. #if defined(_WIN32)
  11585. if (resolved_base.back() != '\\' && resolved_base.back() != '/') {
  11586. resolved_base += '\\';
  11587. }
  11588. #else
  11589. if (resolved_base.back() != '/') { resolved_base += '/'; }
  11590. #endif
  11591. base_dirs_.push_back(
  11592. {std::move(mnt), dir, std::move(resolved_base), std::move(headers)});
  11593. return true;
  11594. }
  11595. }
  11596. return false;
  11597. }
  11598. inline bool Server::remove_mount_point(const std::string &mount_point) {
  11599. for (auto it = base_dirs_.begin(); it != base_dirs_.end(); ++it) {
  11600. if (it->mount_point == mount_point) {
  11601. base_dirs_.erase(it);
  11602. return true;
  11603. }
  11604. }
  11605. return false;
  11606. }
  11607. inline Server &
  11608. Server::set_file_extension_and_mimetype_mapping(const std::string &ext,
  11609. const std::string &mime) {
  11610. file_extension_and_mimetype_map_[ext] = mime;
  11611. return *this;
  11612. }
  11613. inline Server &Server::set_default_file_mimetype(const std::string &mime) {
  11614. default_file_mimetype_ = mime;
  11615. return *this;
  11616. }
  11617. inline Server &Server::set_file_request_handler(Handler handler) {
  11618. file_request_handler_ = std::move(handler);
  11619. return *this;
  11620. }
  11621. inline Server &Server::set_error_handler_core(HandlerWithResponse handler,
  11622. std::true_type) {
  11623. error_handler_ = std::move(handler);
  11624. return *this;
  11625. }
  11626. inline Server &Server::set_error_handler_core(Handler handler,
  11627. std::false_type) {
  11628. error_handler_ = [handler](const Request &req, Response &res) {
  11629. handler(req, res);
  11630. return HandlerResponse::Handled;
  11631. };
  11632. return *this;
  11633. }
  11634. inline Server &Server::set_exception_handler(ExceptionHandler handler) {
  11635. exception_handler_ = std::move(handler);
  11636. return *this;
  11637. }
  11638. inline Server &Server::set_pre_routing_handler(HandlerWithResponse handler) {
  11639. pre_routing_handler_ = std::move(handler);
  11640. return *this;
  11641. }
  11642. inline Server &Server::set_post_routing_handler(Handler handler) {
  11643. post_routing_handler_ = std::move(handler);
  11644. return *this;
  11645. }
  11646. inline Server &Server::set_pre_request_handler(HandlerWithResponse handler) {
  11647. pre_request_handler_ = std::move(handler);
  11648. return *this;
  11649. }
  11650. inline Server &Server::set_logger(Logger logger) {
  11651. logger_ = std::move(logger);
  11652. return *this;
  11653. }
  11654. inline Server &Server::set_error_logger(ErrorLogger error_logger) {
  11655. error_logger_ = std::move(error_logger);
  11656. return *this;
  11657. }
  11658. inline Server &Server::set_pre_compression_logger(Logger logger) {
  11659. pre_compression_logger_ = std::move(logger);
  11660. return *this;
  11661. }
  11662. inline Server &
  11663. Server::set_expect_100_continue_handler(Expect100ContinueHandler handler) {
  11664. expect_100_continue_handler_ = std::move(handler);
  11665. return *this;
  11666. }
  11667. inline Server &Server::set_start_handler(StartHandler handler) {
  11668. start_handler_ = std::move(handler);
  11669. return *this;
  11670. }
  11671. inline Server &Server::set_address_family(int family) {
  11672. address_family_ = family;
  11673. return *this;
  11674. }
  11675. inline Server &Server::set_tcp_nodelay(bool on) {
  11676. tcp_nodelay_ = on;
  11677. return *this;
  11678. }
  11679. inline Server &Server::set_ipv6_v6only(bool on) {
  11680. ipv6_v6only_ = on;
  11681. return *this;
  11682. }
  11683. inline Server &Server::set_socket_options(SocketOptions socket_options) {
  11684. socket_options_ = std::move(socket_options);
  11685. return *this;
  11686. }
  11687. inline Server &Server::set_default_headers(Headers headers) {
  11688. default_headers_ = std::move(headers);
  11689. return *this;
  11690. }
  11691. inline Server &Server::set_header_writer(
  11692. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  11693. header_writer_ = writer;
  11694. return *this;
  11695. }
  11696. inline Server &
  11697. Server::set_trusted_proxies(const std::vector<std::string> &proxies) {
  11698. trusted_proxies_ = proxies;
  11699. return *this;
  11700. }
  11701. inline Server &Server::set_keep_alive_max_count(size_t count) {
  11702. keep_alive_max_count_ = count;
  11703. return *this;
  11704. }
  11705. inline Server &Server::set_keep_alive_timeout(time_t sec) {
  11706. keep_alive_timeout_sec_ = sec;
  11707. return *this;
  11708. }
  11709. template <class Rep, class Period>
  11710. inline Server &Server::set_keep_alive_timeout(
  11711. const std::chrono::duration<Rep, Period> &duration) {
  11712. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11713. set_keep_alive_timeout(sec);
  11714. });
  11715. return *this;
  11716. }
  11717. inline Server &Server::set_read_timeout(time_t sec, time_t usec) {
  11718. read_timeout_sec_ = sec;
  11719. read_timeout_usec_ = usec;
  11720. return *this;
  11721. }
  11722. inline Server &Server::set_write_timeout(time_t sec, time_t usec) {
  11723. write_timeout_sec_ = sec;
  11724. write_timeout_usec_ = usec;
  11725. return *this;
  11726. }
  11727. inline Server &Server::set_idle_interval(time_t sec, time_t usec) {
  11728. idle_interval_sec_ = sec;
  11729. idle_interval_usec_ = usec;
  11730. return *this;
  11731. }
  11732. inline Server &Server::set_payload_max_length(size_t length) {
  11733. payload_max_length_ = length;
  11734. return *this;
  11735. }
  11736. inline Server &Server::set_static_file_compression(bool on) {
  11737. static_file_compression_ = on;
  11738. return *this;
  11739. }
  11740. inline Server &Server::set_static_file_compression_min_length(size_t length) {
  11741. static_file_compression_min_length_ = length;
  11742. return *this;
  11743. }
  11744. inline Server &Server::set_static_file_compression_max_length(size_t length) {
  11745. static_file_compression_max_length_ = length;
  11746. return *this;
  11747. }
  11748. inline Server &Server::set_websocket_max_missed_pongs(int count) {
  11749. websocket_max_missed_pongs_ = count;
  11750. return *this;
  11751. }
  11752. inline Server &Server::set_websocket_ping_interval(time_t sec) {
  11753. websocket_ping_interval_sec_ = sec;
  11754. return *this;
  11755. }
  11756. template <class Rep, class Period>
  11757. inline Server &Server::set_websocket_ping_interval(
  11758. const std::chrono::duration<Rep, Period> &duration) {
  11759. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11760. set_websocket_ping_interval(sec);
  11761. });
  11762. return *this;
  11763. }
  11764. inline bool Server::bind_to_port(const std::string &host, int port,
  11765. int socket_flags) {
  11766. auto ret = bind_internal(host, port, socket_flags);
  11767. if (ret == -1) { is_decommissioned = true; }
  11768. return ret >= 0;
  11769. }
  11770. inline int Server::bind_to_any_port(const std::string &host, int socket_flags) {
  11771. auto ret = bind_internal(host, 0, socket_flags);
  11772. if (ret == -1) { is_decommissioned = true; }
  11773. return ret;
  11774. }
  11775. inline bool Server::listen_after_bind() { return listen_internal(); }
  11776. inline bool Server::listen(const std::string &host, int port,
  11777. int socket_flags) {
  11778. return bind_to_port(host, port, socket_flags) && listen_internal();
  11779. }
  11780. inline bool Server::is_running() const { return is_running_; }
  11781. inline void Server::wait_until_ready() const {
  11782. while (!is_running_ && !is_decommissioned) {
  11783. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  11784. }
  11785. }
  11786. inline void Server::stop() noexcept {
  11787. // Release the listening socket whether or not the accept loop is running:
  11788. // bind_to_port() without listen_after_bind() still owns the descriptor. The
  11789. // exchange is what makes this safe to call concurrently with the accept loop.
  11790. socket_t sock = svr_sock_.exchange(INVALID_SOCKET);
  11791. if (sock != INVALID_SOCKET) {
  11792. detail::shutdown_socket(sock);
  11793. detail::close_socket(sock);
  11794. }
  11795. is_decommissioned = false;
  11796. }
  11797. inline void Server::decommission() { is_decommissioned = true; }
  11798. inline bool Server::parse_request_line(const char *s, Request &req) const {
  11799. auto len = strlen(s);
  11800. if (len < 2 || s[len - 2] != '\r' || s[len - 1] != '\n') { return false; }
  11801. len -= 2;
  11802. {
  11803. // RFC 9112 §3: exactly one SP between the method, the target and the
  11804. // version. Taking other whitespace as a separator too lets recipients
  11805. // that parse more strictly see a different request.
  11806. auto end = s + len;
  11807. if (std::count(s, end, ' ') != 2) { return false; }
  11808. auto sp1 = std::find(s, end, ' ');
  11809. auto sp2 = std::find(sp1 + 1, end, ' ');
  11810. if (sp1 == s || sp2 == sp1 + 1 || sp2 + 1 == end) { return false; }
  11811. req.method.assign(s, sp1);
  11812. req.target.assign(sp1 + 1, sp2);
  11813. req.version.assign(sp2 + 1, end);
  11814. }
  11815. // A method outside the built-in set is accepted only when a handler has been
  11816. // registered for it with CustomRoute().
  11817. const auto &methods = builtin_methods();
  11818. if (methods.find(req.method) == methods.end() &&
  11819. !find_custom_entry(req.method)) {
  11820. output_error_log(Error::InvalidHTTPMethod, &req);
  11821. return false;
  11822. }
  11823. if (req.version != "HTTP/1.1" && req.version != "HTTP/1.0") {
  11824. output_error_log(Error::InvalidHTTPVersion, &req);
  11825. return false;
  11826. }
  11827. // A request-target has no fragment (RFC 9112 §3.2), and one stripped here
  11828. // would leave this server routing a different path than a cache or a
  11829. // filter in front of it sees.
  11830. if (!detail::fields::is_request_target(req.target) ||
  11831. req.target.find('#') != std::string::npos) {
  11832. return false;
  11833. }
  11834. {
  11835. detail::divide(req.target, '?',
  11836. [&](const char *lhs_data, std::size_t lhs_size,
  11837. const char *rhs_data, std::size_t rhs_size) {
  11838. req.path =
  11839. decode_path_component(std::string(lhs_data, lhs_size));
  11840. detail::parse_query_text(rhs_data, rhs_size, req.params);
  11841. });
  11842. }
  11843. return true;
  11844. }
  11845. inline bool Server::write_response(Stream &strm, bool close_connection,
  11846. Request &req, Response &res) {
  11847. // NOTE: `req.ranges` should be empty, otherwise it will be applied
  11848. // incorrectly to the error content.
  11849. req.ranges.clear();
  11850. return write_response_core(strm, close_connection, req, res, false);
  11851. }
  11852. inline bool Server::write_response_with_content(Stream &strm,
  11853. bool close_connection,
  11854. const Request &req,
  11855. Response &res) {
  11856. return write_response_core(strm, close_connection, req, res, true);
  11857. }
  11858. inline bool Server::write_response_core(Stream &strm, bool close_connection,
  11859. const Request &req, Response &res,
  11860. bool need_apply_ranges) {
  11861. assert(res.status != -1);
  11862. if (400 <= res.status && error_handler_ &&
  11863. error_handler_(req, res) == HandlerResponse::Handled) {
  11864. need_apply_ranges = true;
  11865. }
  11866. if (!detail::body_allowed_for_status(res.status)) {
  11867. detail::clear_content(res);
  11868. }
  11869. detail::prefer_assigned_body(res);
  11870. std::string content_type;
  11871. std::string boundary;
  11872. if (need_apply_ranges) { apply_ranges(req, res, content_type, boundary); }
  11873. // Prepare additional headers
  11874. if (close_connection ||
  11875. detail::has_header_token(req.headers, "Connection", "close") ||
  11876. 400 <= res.status || // Don't leave connections open after errors
  11877. // The client withholds the body until `100 Continue`, which was never
  11878. // sent, so whether and when the body follows is unknown.
  11879. (req.expect_100_continue_pending_ && detail::has_framed_body(req)) ||
  11880. // The body was left partway, e.g. by a content receiver that returned
  11881. // false, so the rest of it cannot be told from the next request.
  11882. (req.body_read_started_ && !req.body_consumed_)) {
  11883. res.set_header("Connection", "close");
  11884. } else {
  11885. std::string s = "timeout=";
  11886. s += std::to_string(keep_alive_timeout_sec_);
  11887. if (keep_alive_max_count_ > 0) {
  11888. s += ", max=";
  11889. s += std::to_string(keep_alive_max_count_);
  11890. }
  11891. res.set_header("Keep-Alive", s);
  11892. }
  11893. if ((!res.body.empty() || res.content_length_ > 0 || res.content_provider_) &&
  11894. !res.has_header("Content-Type")) {
  11895. res.set_header("Content-Type", "text/plain");
  11896. }
  11897. detail::set_framing_headers(req, res, boundary, content_type);
  11898. if (req.method == "HEAD" && !res.has_header("Accept-Ranges")) {
  11899. res.set_header("Accept-Ranges", "bytes");
  11900. }
  11901. if (post_routing_handler_) {
  11902. post_routing_handler_(req, res);
  11903. // Again, for a body or framing headers the handler changed.
  11904. detail::set_framing_headers(req, res, boundary, content_type);
  11905. }
  11906. // Response line and headers
  11907. detail::BufferStream bstrm;
  11908. if (!detail::write_response_line(bstrm, res.status)) { return false; }
  11909. if (header_writer_(bstrm, res.headers) <= 0) { return false; }
  11910. // Combine a small body with the headers so the whole response leaves in a
  11911. // single write. A large body is written on its own instead: a copy of it
  11912. // costs more than the extra write saves.
  11913. auto send_body =
  11914. req.method != "HEAD" && detail::body_allowed_for_status(res.status);
  11915. auto body_is_separate = false;
  11916. auto provider_done = false;
  11917. if (send_body && !res.body.empty() && !res.content_provider_) {
  11918. if (res.body.size() < CPPHTTPLIB_SEND_BUFSIZ) {
  11919. bstrm.write(res.body.data(), res.body.size());
  11920. } else {
  11921. body_is_separate = true;
  11922. }
  11923. } else if (send_body && res.content_provider_ &&
  11924. res.is_file_content_provider_ &&
  11925. res.content_length_ < CPPHTTPLIB_SEND_BUFSIZ) {
  11926. // A small file is read into the same buffer. Other providers may produce
  11927. // their data over time, so they are never held back.
  11928. if (!write_content_with_provider(bstrm, req, res, boundary, content_type)) {
  11929. return false;
  11930. }
  11931. provider_done = true;
  11932. }
  11933. // Log before writing to avoid race condition with client-side code that
  11934. // accesses logger-captured data immediately after receiving the response.
  11935. output_log(req, res);
  11936. // Flush buffer
  11937. auto &data = bstrm.get_buffer();
  11938. if (!detail::write_data(strm, data.data(), data.size())) { return false; }
  11939. if (body_is_separate) {
  11940. return detail::write_data(strm, res.body.data(), res.body.size());
  11941. }
  11942. // Streaming body
  11943. if (send_body && res.content_provider_) {
  11944. if (!provider_done &&
  11945. !write_content_with_provider(strm, req, res, boundary, content_type)) {
  11946. return false;
  11947. }
  11948. res.content_provider_success_ = true;
  11949. }
  11950. return true;
  11951. }
  11952. inline bool
  11953. Server::write_content_with_provider(Stream &strm, const Request &req,
  11954. Response &res, const std::string &boundary,
  11955. const std::string &content_type) {
  11956. auto is_shutting_down = [this]() {
  11957. return this->svr_sock_ == INVALID_SOCKET;
  11958. };
  11959. if (res.content_length_ > 0) {
  11960. if (!detail::is_partial_content(req, res)) {
  11961. return detail::write_content(strm, res.content_provider_, 0,
  11962. res.content_length_, is_shutting_down);
  11963. } else if (req.ranges.size() == 1) {
  11964. auto offset_and_length = detail::get_range_offset_and_length(
  11965. req.ranges[0], res.content_length_);
  11966. return detail::write_content(strm, res.content_provider_,
  11967. offset_and_length.first,
  11968. offset_and_length.second, is_shutting_down);
  11969. } else {
  11970. return detail::write_multipart_ranges_data(
  11971. strm, req, res, boundary, content_type, res.content_length_,
  11972. is_shutting_down);
  11973. }
  11974. } else {
  11975. if (res.is_chunked_content_provider_) {
  11976. // Use the coding `apply_ranges()` chose when it wrote the headers;
  11977. // re-negotiating here would disagree with them, e.g. once a handler's
  11978. // own Content-Encoding header suppresses the negotiation.
  11979. auto compressor = detail::make_compressor(res.content_coding_);
  11980. if (!compressor) {
  11981. compressor = detail::make_unique<detail::nocompressor>();
  11982. }
  11983. return detail::write_content_chunked(strm, res.content_provider_,
  11984. is_shutting_down, *compressor);
  11985. } else {
  11986. return detail::write_content_without_length(strm, res.content_provider_,
  11987. is_shutting_down);
  11988. }
  11989. }
  11990. }
  11991. inline bool Server::read_content(Stream &strm, Request &req, Response &res) {
  11992. FormFields::iterator cur_field;
  11993. FormFiles::iterator cur_file;
  11994. auto is_text_field = false;
  11995. size_t count = 0;
  11996. if (read_content_core(
  11997. strm, req, res,
  11998. // Regular
  11999. [&](const char *buf, size_t n) {
  12000. // Prevent arithmetic overflow when checking sizes.
  12001. // Avoid computing (req.body.size() + n) directly because
  12002. // adding two unsigned `size_t` values can wrap around and
  12003. // produce a small result instead of indicating overflow.
  12004. // Instead, check using subtraction: ensure `n` does not
  12005. // exceed the remaining capacity `max_size() - size()`.
  12006. if (req.body.size() >= req.body.max_size() ||
  12007. n > req.body.max_size() - req.body.size()) {
  12008. return false;
  12009. }
  12010. // Limit decompressed body size to payload_max_length_ to protect
  12011. // against "zip bomb" attacks where a small compressed payload
  12012. // decompresses to a massive size.
  12013. if (payload_max_length_ > 0 &&
  12014. (req.body.size() >= payload_max_length_ ||
  12015. n > payload_max_length_ - req.body.size())) {
  12016. return false;
  12017. }
  12018. req.body.append(buf, n);
  12019. return true;
  12020. },
  12021. // Multipart FormData
  12022. [&](const FormData &file) {
  12023. if (CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT > 0 &&
  12024. count++ == CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT) {
  12025. output_error_log(Error::TooManyFormDataFiles, &req);
  12026. return false;
  12027. }
  12028. if (file.filename.empty()) {
  12029. cur_field = req.form.fields.emplace(
  12030. file.name, FormField{file.name, file.content, file.headers});
  12031. is_text_field = true;
  12032. } else {
  12033. cur_file = req.form.files.emplace(file.name, file);
  12034. is_text_field = false;
  12035. }
  12036. return true;
  12037. },
  12038. [&](const char *buf, size_t n) {
  12039. if (is_text_field) {
  12040. auto &content = cur_field->second.content;
  12041. if (content.size() + n > content.max_size()) { return false; }
  12042. content.append(buf, n);
  12043. } else {
  12044. auto &content = cur_file->second.content;
  12045. if (content.size() + n > content.max_size()) { return false; }
  12046. content.append(buf, n);
  12047. }
  12048. return true;
  12049. })) {
  12050. const auto &content_type = req.get_header_value("Content-Type");
  12051. if (detail::case_ignore::equal(detail::extract_media_type(content_type),
  12052. "application/x-www-form-urlencoded")) {
  12053. if (CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH > 0 &&
  12054. req.body.size() > CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH) {
  12055. res.status = StatusCode::PayloadTooLarge_413; // NOTE: should be 414?
  12056. output_error_log(Error::ExceedMaxPayloadSize, &req);
  12057. return false;
  12058. }
  12059. detail::parse_query_text(req.body, req.params);
  12060. }
  12061. return true;
  12062. }
  12063. return false;
  12064. }
  12065. inline bool Server::read_content_with_content_receiver(
  12066. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  12067. FormDataHeader multipart_header, ContentReceiver multipart_receiver) {
  12068. return read_content_core(strm, req, res, std::move(receiver),
  12069. std::move(multipart_header),
  12070. std::move(multipart_receiver));
  12071. }
  12072. inline bool Server::read_content_core(
  12073. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  12074. FormDataHeader multipart_header, ContentReceiver multipart_receiver) const {
  12075. detail::FormDataParser multipart_form_data_parser;
  12076. ContentReceiverWithProgress out;
  12077. if (req.is_multipart_form_data()) {
  12078. const auto &content_type = req.get_header_value("Content-Type");
  12079. std::string boundary;
  12080. if (!detail::parse_multipart_boundary(content_type, boundary)) {
  12081. res.status = StatusCode::BadRequest_400;
  12082. output_error_log(Error::MultipartParsing, &req);
  12083. return false;
  12084. }
  12085. multipart_form_data_parser.set_boundary(std::move(boundary));
  12086. out = [&](const char *buf, size_t n, size_t /*off*/, size_t /*len*/) {
  12087. return multipart_form_data_parser.parse(buf, n, multipart_header,
  12088. multipart_receiver);
  12089. };
  12090. } else {
  12091. out = [receiver](const char *buf, size_t n, size_t /*off*/,
  12092. size_t /*len*/) { return receiver(buf, n); };
  12093. }
  12094. // RFC 9112 §6: no Transfer-Encoding and no Content-Length means no body.
  12095. // For non-SSL builds we still scan non-persistent connections for stray
  12096. // body bytes so the payload limit is enforced (413). On keep-alive,
  12097. // pending bytes may be the next request (issue #2450), so skip.
  12098. #if !defined(CPPHTTPLIB_SSL_ENABLED)
  12099. if (!req.has_header("Content-Length") &&
  12100. !detail::is_chunked_transfer_encoding(req.headers)) {
  12101. if (!detail::is_connection_persistent(req) && payload_max_length_ > 0 &&
  12102. payload_max_length_ < (std::numeric_limits<size_t>::max)()) {
  12103. auto has_data = strm.is_readable();
  12104. if (!has_data) {
  12105. auto s = strm.socket();
  12106. if (s != INVALID_SOCKET) {
  12107. has_data = detail::select_read(s, 0, 0) > 0;
  12108. }
  12109. }
  12110. if (has_data) {
  12111. // Route through the same decompressing reader used by the
  12112. // length-framed and chunked paths below, so payload_max_length_ is
  12113. // enforced on the decompressed size here too instead of only on the
  12114. // compressed wire bytes.
  12115. return detail::read_content(strm, req, payload_max_length_, res.status,
  12116. nullptr, out, true);
  12117. }
  12118. }
  12119. return true;
  12120. }
  12121. #else
  12122. if (!req.has_header("Content-Length") &&
  12123. !detail::is_chunked_transfer_encoding(req.headers)) {
  12124. return true;
  12125. }
  12126. #endif
  12127. // A second read would start where the first one stopped, or in the next
  12128. // request.
  12129. if (req.body_read_started_) { return false; }
  12130. // The client is waiting for this before it sends the body.
  12131. if (req.expect_100_continue_pending_) {
  12132. req.expect_100_continue_pending_ = false;
  12133. detail::write_response_line(strm, StatusCode::Continue_100);
  12134. strm.write("\r\n");
  12135. }
  12136. // Set before reading, since a receiver may also stop by throwing.
  12137. req.body_read_started_ = true;
  12138. if (!detail::read_content(strm, req, payload_max_length_, res.status, nullptr,
  12139. out, true)) {
  12140. return false;
  12141. }
  12142. req.body_consumed_ = true;
  12143. if (req.is_multipart_form_data()) {
  12144. if (!multipart_form_data_parser.is_valid()) {
  12145. res.status = StatusCode::BadRequest_400;
  12146. output_error_log(Error::MultipartParsing, &req);
  12147. return false;
  12148. }
  12149. }
  12150. return true;
  12151. }
  12152. inline bool Server::handle_file_request(Request &req, Response &res) {
  12153. if (!detail::is_valid_path(req.path)) { return false; }
  12154. for (const auto &entry : base_dirs_) {
  12155. // Prefix match, on a path segment boundary. A mount point of "/mount"
  12156. // covers "/mount" and "/mount/...", but must not swallow "/mountdir/...".
  12157. // One that already ends in '/' (the root mount among them) carries its own
  12158. // boundary; set_mount_point() guarantees the mount point is not empty.
  12159. if (!req.path.compare(0, entry.mount_point.size(), entry.mount_point) &&
  12160. (entry.mount_point.back() == '/' ||
  12161. req.path.size() == entry.mount_point.size() ||
  12162. req.path[entry.mount_point.size()] == '/')) {
  12163. std::string sub_path = "/" + req.path.substr(entry.mount_point.size());
  12164. auto path = entry.base_dir + sub_path;
  12165. if (path.back() == '/') { path += "index.html"; }
  12166. // Defense-in-depth: is_valid_path blocks ".." traversal in the URL,
  12167. // but symlinks/junctions can still escape the base directory. A path
  12168. // that cannot be resolved, which includes one that does not exist, is
  12169. // not served from here.
  12170. std::string resolved_path;
  12171. if (!detail::canonicalize_path(path.c_str(), resolved_path)) { continue; }
  12172. if (!detail::is_path_within_base(resolved_path,
  12173. entry.resolved_base_dir)) {
  12174. res.status = StatusCode::Forbidden_403;
  12175. return true;
  12176. }
  12177. detail::FileStat stat(path);
  12178. if (stat.is_dir()) {
  12179. // Relative, so "//dir" cannot name another host; "./" keeps a ':'
  12180. // in the name from reading as a scheme.
  12181. auto name = req.path.substr(req.path.rfind('/') + 1);
  12182. res.set_redirect("./" + encode_path_component(name) + "/",
  12183. StatusCode::MovedPermanently_301);
  12184. return true;
  12185. }
  12186. if (stat.is_file()) {
  12187. for (const auto &kv : entry.headers) {
  12188. res.set_header(kv.first, kv.second);
  12189. }
  12190. auto content_type = detail::find_content_type(
  12191. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  12192. auto encoding = detail::EncodingType::None;
  12193. if (static_file_compression_) {
  12194. encoding = static_file_encoding(req, res, content_type, stat.size());
  12195. }
  12196. // The ETag names the representation actually sent, so a client that
  12197. // cached the compressed form revalidates against the compressed ETag
  12198. // and still gets a 304, while one that took identity keeps the plain
  12199. // ETag.
  12200. auto etag = detail::compute_etag(
  12201. stat, encoding == detail::EncodingType::None
  12202. ? std::string()
  12203. : std::string("-") + detail::encoding_name(encoding));
  12204. if (!etag.empty()) { res.set_header("ETag", etag); }
  12205. auto mtime = stat.mtime();
  12206. auto last_modified = detail::file_mtime_to_http_date(mtime);
  12207. if (!last_modified.empty()) {
  12208. res.set_header("Last-Modified", last_modified);
  12209. }
  12210. if (check_if_not_modified(req, res, etag, mtime)) { return true; }
  12211. check_if_range(req, etag, mtime);
  12212. auto mm = std::make_shared<detail::mmap>(path.c_str());
  12213. if (!mm->is_open()) {
  12214. output_error_log(Error::OpenFile, &req);
  12215. return false;
  12216. }
  12217. detail::set_file_content_provider(res, mm, content_type, encoding);
  12218. if (req.method != "HEAD" && file_request_handler_) {
  12219. file_request_handler_(req, res);
  12220. }
  12221. return true;
  12222. } else {
  12223. output_error_log(Error::OpenFile, &req);
  12224. }
  12225. }
  12226. }
  12227. return false;
  12228. }
  12229. inline bool Server::check_if_not_modified(const Request &req, Response &res,
  12230. const std::string &etag,
  12231. time_t mtime) const {
  12232. // Handle conditional GET:
  12233. // 1. If-None-Match takes precedence (RFC 9110 Section 13.1.2)
  12234. // 2. If-Modified-Since is checked only when If-None-Match is absent
  12235. if (req.has_header("If-None-Match")) {
  12236. if (!etag.empty()) {
  12237. auto val =
  12238. detail::get_combined_header_value(req.headers, "If-None-Match");
  12239. // NOTE: We use exact string matching here. This works correctly
  12240. // because our server always generates weak ETags (W/"..."), and
  12241. // clients typically send back the same ETag they received.
  12242. // RFC 9110 Section 8.8.3.2 allows weak comparison for
  12243. // If-None-Match, where W/"x" and "x" would match, but this
  12244. // simplified implementation requires exact matches.
  12245. auto ret = detail::split_find(val.data(), val.data() + val.size(), ',',
  12246. [&](const char *b, const char *e) {
  12247. auto seg_len = static_cast<size_t>(e - b);
  12248. return (seg_len == 1 && *b == '*') ||
  12249. (seg_len == etag.size() &&
  12250. std::equal(b, e, etag.begin()));
  12251. });
  12252. if (ret) {
  12253. res.status = StatusCode::NotModified_304;
  12254. return true;
  12255. }
  12256. }
  12257. } else if (req.has_header("If-Modified-Since")) {
  12258. auto val = req.get_header_value("If-Modified-Since");
  12259. auto t = detail::parse_http_date(val);
  12260. if (t != static_cast<time_t>(-1) && mtime <= t) {
  12261. res.status = StatusCode::NotModified_304;
  12262. return true;
  12263. }
  12264. }
  12265. return false;
  12266. }
  12267. inline bool Server::check_if_range(Request &req, const std::string &etag,
  12268. time_t mtime) const {
  12269. // Handle If-Range for partial content requests (RFC 9110
  12270. // Section 13.1.5). If-Range is only evaluated when Range header is
  12271. // present. If the validator matches, serve partial content; otherwise
  12272. // serve full content.
  12273. if (!req.ranges.empty() && req.has_header("If-Range")) {
  12274. auto val = req.get_header_value("If-Range");
  12275. auto is_valid_range = [&]() {
  12276. if (detail::is_strong_etag(val)) {
  12277. // RFC 9110 Section 13.1.5: If-Range requires strong ETag
  12278. // comparison.
  12279. return (!etag.empty() && val == etag);
  12280. } else if (detail::is_weak_etag(val)) {
  12281. // Weak ETags are not valid for If-Range (RFC 9110 Section 13.1.5)
  12282. return false;
  12283. } else {
  12284. // HTTP-date comparison
  12285. auto t = detail::parse_http_date(val);
  12286. return (t != static_cast<time_t>(-1) && mtime <= t);
  12287. }
  12288. };
  12289. if (!is_valid_range()) {
  12290. // Validator doesn't match: ignore Range and serve full content
  12291. req.ranges.clear();
  12292. return false;
  12293. }
  12294. }
  12295. return true;
  12296. }
  12297. inline socket_t
  12298. Server::create_server_socket(const std::string &host, int port,
  12299. int socket_flags,
  12300. SocketOptions socket_options) const {
  12301. return detail::create_socket(
  12302. host, std::string(), port, address_family_, socket_flags, tcp_nodelay_,
  12303. ipv6_v6only_, std::move(socket_options),
  12304. [&](socket_t sock, struct addrinfo &ai, bool & /*quit*/) -> bool {
  12305. if (::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  12306. output_error_log(Error::BindIPAddress, nullptr);
  12307. return false;
  12308. }
  12309. if (::listen(sock, CPPHTTPLIB_LISTEN_BACKLOG)) {
  12310. output_error_log(Error::Listen, nullptr);
  12311. return false;
  12312. }
  12313. return true;
  12314. });
  12315. }
  12316. inline int Server::bind_internal(const std::string &host, int port,
  12317. int socket_flags) {
  12318. if (is_decommissioned) { return -1; }
  12319. if (!is_valid()) { return -1; }
  12320. svr_sock_ = create_server_socket(host, port, socket_flags, socket_options_);
  12321. if (svr_sock_ == INVALID_SOCKET) { return -1; }
  12322. if (port == 0) {
  12323. struct sockaddr_storage addr;
  12324. socklen_t addr_len = sizeof(addr);
  12325. if (getsockname(svr_sock_, reinterpret_cast<struct sockaddr *>(&addr),
  12326. &addr_len) == -1) {
  12327. output_error_log(Error::GetSockName, nullptr);
  12328. return -1;
  12329. }
  12330. if (addr.ss_family == AF_INET) {
  12331. return ntohs(reinterpret_cast<struct sockaddr_in *>(&addr)->sin_port);
  12332. } else if (addr.ss_family == AF_INET6) {
  12333. return ntohs(reinterpret_cast<struct sockaddr_in6 *>(&addr)->sin6_port);
  12334. } else {
  12335. output_error_log(Error::UnsupportedAddressFamily, nullptr);
  12336. return -1;
  12337. }
  12338. } else {
  12339. return port;
  12340. }
  12341. }
  12342. inline bool Server::listen_internal() {
  12343. // A stop() between bind and listen leaves nothing to accept on. Report
  12344. // failure instead of returning success without ever serving, and mark the
  12345. // server decommissioned the way any failed listen does so that a concurrent
  12346. // wait_until_ready() wakes up instead of spinning forever.
  12347. if (is_decommissioned || svr_sock_ == INVALID_SOCKET) {
  12348. is_decommissioned = true;
  12349. return false;
  12350. }
  12351. auto ret = true;
  12352. is_running_ = true;
  12353. auto se = detail::scope_exit([&]() { is_running_ = false; });
  12354. if (start_handler_) { start_handler_(); }
  12355. {
  12356. std::unique_ptr<TaskQueue> task_queue(new_task_queue());
  12357. while (svr_sock_ != INVALID_SOCKET) {
  12358. #ifndef _WIN32
  12359. if (idle_interval_sec_ > 0 || idle_interval_usec_ > 0) {
  12360. #endif
  12361. auto val = detail::select_read(svr_sock_, idle_interval_sec_,
  12362. idle_interval_usec_);
  12363. if (val == 0) { // Timeout
  12364. task_queue->on_idle();
  12365. continue;
  12366. }
  12367. #ifndef _WIN32
  12368. }
  12369. #endif
  12370. #if defined _WIN32
  12371. // sockets connected via WASAccept inherit flags NO_HANDLE_INHERIT,
  12372. // OVERLAPPED
  12373. socket_t sock = WSAAccept(svr_sock_, nullptr, nullptr, nullptr, 0);
  12374. #elif defined SOCK_CLOEXEC
  12375. socket_t sock = accept4(svr_sock_, nullptr, nullptr, SOCK_CLOEXEC);
  12376. #else
  12377. socket_t sock = accept(svr_sock_, nullptr, nullptr);
  12378. #endif
  12379. if (sock == INVALID_SOCKET) {
  12380. // NOTE: Winsock reports failures through WSAGetLastError() and never
  12381. // touches the CRT errno, so the two have to be asked platform by
  12382. // platform rather than by testing errno here.
  12383. if (detail::is_accept_resource_error()) {
  12384. // The per-process descriptor limit or the network stack's buffer
  12385. // space has been reached. Try to accept new connections after a
  12386. // short sleep.
  12387. std::this_thread::sleep_for(std::chrono::microseconds{1});
  12388. continue;
  12389. } else if (detail::is_accept_transient_error()) {
  12390. continue;
  12391. }
  12392. // Take the descriptor out of svr_sock_ before closing it: a later
  12393. // stop() would otherwise shutdown()/close() a value the OS may have
  12394. // reused, and keep_alive() watches svr_sock_ to notice the server is
  12395. // gone. The exchange also settles the race with a concurrent stop(),
  12396. // since whichever side takes the descriptor closes it exactly once.
  12397. auto listen_sock = svr_sock_.exchange(INVALID_SOCKET);
  12398. if (listen_sock != INVALID_SOCKET) {
  12399. detail::close_socket(listen_sock);
  12400. ret = false;
  12401. output_error_log(Error::Connection, nullptr);
  12402. } else {
  12403. ; // The server socket was closed by user.
  12404. }
  12405. break;
  12406. }
  12407. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO,
  12408. read_timeout_sec_, read_timeout_usec_);
  12409. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_SNDTIMEO,
  12410. write_timeout_sec_, write_timeout_usec_);
  12411. if (tcp_nodelay_) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  12412. if (!task_queue->enqueue(
  12413. [this, sock]() { process_and_close_socket(sock); })) {
  12414. output_error_log(Error::ResourceExhaustion, nullptr);
  12415. detail::shutdown_socket(sock);
  12416. detail::close_socket(sock);
  12417. }
  12418. }
  12419. task_queue->shutdown();
  12420. }
  12421. is_decommissioned = !ret;
  12422. return ret;
  12423. }
  12424. inline bool Server::routing(Request &req, Response &res, Stream &strm,
  12425. bool skip_pre_routing) {
  12426. if (!skip_pre_routing && pre_routing_handler_ &&
  12427. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12428. return true;
  12429. }
  12430. // File handler
  12431. if ((req.method == "GET" || req.method == "HEAD") &&
  12432. handle_file_request(req, res)) {
  12433. return true;
  12434. }
  12435. const auto *custom = find_custom_entry(req.method);
  12436. // The second clause mirrors what expect_content() does unconditionally for
  12437. // POST/PUT/PATCH/DELETE: a content reader route fires even when the request
  12438. // carries no body. Without it a body-less PROPFIND (RFC 4918 treats one as
  12439. // `allprop`) would skip its handler and fall through to 404.
  12440. if (detail::expect_content(req) ||
  12441. (custom && !custom->handlers_for_content_reader.empty())) {
  12442. // Content reader handler
  12443. {
  12444. // Track whether the ContentReader was aborted due to the decompressed
  12445. // payload exceeding `payload_max_length_`.
  12446. // The user handler runs after the lambda returns, so we must restore the
  12447. // 413 status if the handler overwrites it.
  12448. bool content_reader_payload_too_large = false;
  12449. ContentReader reader(
  12450. [&](ContentReceiver receiver) {
  12451. auto result = read_content_with_content_receiver(
  12452. strm, req, res, std::move(receiver), nullptr, nullptr);
  12453. if (!result) {
  12454. output_error_log(Error::Read, &req);
  12455. if (res.status == StatusCode::PayloadTooLarge_413) {
  12456. content_reader_payload_too_large = true;
  12457. }
  12458. }
  12459. return result;
  12460. },
  12461. [&](FormDataHeader header, ContentReceiver receiver) {
  12462. auto result = read_content_with_content_receiver(
  12463. strm, req, res, nullptr, std::move(header),
  12464. std::move(receiver));
  12465. if (!result) {
  12466. output_error_log(Error::Read, &req);
  12467. if (res.status == StatusCode::PayloadTooLarge_413) {
  12468. content_reader_payload_too_large = true;
  12469. }
  12470. }
  12471. return result;
  12472. });
  12473. bool dispatched = false;
  12474. if (req.method == "POST") {
  12475. dispatched = dispatch_request_for_content_reader(
  12476. req, res, std::move(reader), post_handlers_for_content_reader_);
  12477. } else if (req.method == "PUT") {
  12478. dispatched = dispatch_request_for_content_reader(
  12479. req, res, std::move(reader), put_handlers_for_content_reader_);
  12480. } else if (req.method == "PATCH") {
  12481. dispatched = dispatch_request_for_content_reader(
  12482. req, res, std::move(reader), patch_handlers_for_content_reader_);
  12483. } else if (req.method == "DELETE") {
  12484. dispatched = dispatch_request_for_content_reader(
  12485. req, res, std::move(reader), delete_handlers_for_content_reader_);
  12486. } else if (custom) {
  12487. dispatched = dispatch_request_for_content_reader(
  12488. req, res, std::move(reader), custom->handlers_for_content_reader);
  12489. }
  12490. if (dispatched) {
  12491. if (content_reader_payload_too_large) {
  12492. // Enforce the limit: override any status the handler may have set
  12493. // and return false so the error path sends a plain 413 response.
  12494. res.status = StatusCode::PayloadTooLarge_413;
  12495. detail::clear_content(res);
  12496. return false;
  12497. }
  12498. return true;
  12499. }
  12500. }
  12501. // NOTE: `req.body` is not read here. For a regular handler the body is
  12502. // read inside dispatch_request(), after the route has matched and the
  12503. // pre-request handler has approved the request, so that a rejected
  12504. // request (e.g. failed authentication) never forces us to buffer a
  12505. // potentially large body.
  12506. }
  12507. // Regular handler
  12508. if (req.method == "GET" || req.method == "HEAD") {
  12509. return dispatch_request(req, res, get_handlers_, strm);
  12510. } else if (req.method == "POST") {
  12511. return dispatch_request(req, res, post_handlers_, strm);
  12512. } else if (req.method == "PUT") {
  12513. return dispatch_request(req, res, put_handlers_, strm);
  12514. } else if (req.method == "DELETE") {
  12515. return dispatch_request(req, res, delete_handlers_, strm);
  12516. } else if (req.method == "OPTIONS") {
  12517. return dispatch_request(req, res, options_handlers_, strm);
  12518. } else if (req.method == "PATCH") {
  12519. return dispatch_request(req, res, patch_handlers_, strm);
  12520. } else if (custom) {
  12521. return dispatch_request(req, res, custom->handlers, strm);
  12522. }
  12523. res.status = StatusCode::BadRequest_400;
  12524. return false;
  12525. }
  12526. inline bool Server::dispatch_request(Request &req, Response &res,
  12527. const Handlers &handlers, Stream &strm) {
  12528. for (const auto &x : handlers) {
  12529. const auto &matcher = x.first;
  12530. const auto &handler = x.second;
  12531. if (matcher->match(req)) {
  12532. req.matched_route = matcher->pattern();
  12533. // Run the pre-request handler before reading the body so a rejected
  12534. // request (e.g. failed authentication) never forces us to buffer a
  12535. // potentially large body. `req.matched_route` is available here.
  12536. if (pre_request_handler_ &&
  12537. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12538. return true;
  12539. }
  12540. // The route matched and the request was approved; read the body now.
  12541. if (detail::expect_content(req) && !read_content(strm, req, res)) {
  12542. output_error_log(Error::Read, &req);
  12543. return false;
  12544. }
  12545. handler(req, res);
  12546. return true;
  12547. }
  12548. }
  12549. return false;
  12550. }
  12551. // Decides the content coding for a response served straight from a file. Both
  12552. // the ETag, which has to name the representation actually sent, and
  12553. // `apply_static_file_compression()` go through this, so the two cannot drift
  12554. // apart.
  12555. inline detail::EncodingType
  12556. Server::static_file_encoding(const Request &req, const Response &res,
  12557. const std::string &content_type,
  12558. size_t length) const {
  12559. if (!static_file_compression_) { return detail::EncodingType::None; }
  12560. // Nothing to compress, and an empty file already answers with
  12561. // `Content-Length: 0`. Checked on its own so that a zero floor still cannot
  12562. // turn an empty body into a 20-byte gzip stream.
  12563. if (length == 0) { return detail::EncodingType::None; }
  12564. // A file that already fits in a single packet gains nothing from being made
  12565. // smaller, since it still travels in that one segment, and a file of a few
  12566. // bytes comes out larger than it went in.
  12567. if (length < static_file_compression_min_length_) {
  12568. return detail::EncodingType::None;
  12569. }
  12570. // RFC 9110 applies Range to the representation after content coding, so a
  12571. // compressed 206 would mean compressing the whole file and then slicing it.
  12572. // Serve ranges from the identity representation instead.
  12573. if (!req.ranges.empty()) { return detail::EncodingType::None; }
  12574. if (static_file_compression_max_length_ > 0 &&
  12575. length > static_file_compression_max_length_) {
  12576. return detail::EncodingType::None;
  12577. }
  12578. return detail::encoding_type(req, res, content_type);
  12579. }
  12580. // Compresses a file-backed content provider into `res.body`. Returns false when
  12581. // the response is left untouched.
  12582. inline bool Server::apply_static_file_compression(const Request &req,
  12583. Response &res) const {
  12584. auto type = res.content_coding_;
  12585. if (type == detail::EncodingType::None || !res.content_provider_) {
  12586. return false;
  12587. }
  12588. auto compressor = detail::make_compressor(type);
  12589. if (!compressor) { return false; }
  12590. output_pre_compression_log(req, res);
  12591. std::string compressed;
  12592. if (!detail::compress_content_provider(res.content_provider_,
  12593. res.content_length_, *compressor,
  12594. compressed)) {
  12595. return false;
  12596. }
  12597. res.body.swap(compressed);
  12598. // The provider was consumed in full, so its releaser hears about a success.
  12599. res.content_provider_success_ = true;
  12600. detail::clear_content_provider(res);
  12601. res.set_header("Content-Encoding", detail::encoding_name(type));
  12602. res.set_header("Vary", "Accept-Encoding");
  12603. return true;
  12604. }
  12605. inline void Server::apply_ranges(const Request &req, Response &res,
  12606. std::string &content_type,
  12607. std::string &boundary) const {
  12608. // A known-length content provider leaves `res.body` empty, so the compressor
  12609. // at the end of this function never runs for one (issue #2545). A file-backed
  12610. // provider is fully readable right here, so compress it and answer with an
  12611. // ordinary body: `Content-Length` and HEAD keep working, and the response
  12612. // takes the same path as `set_content()` from here on. Range requests never
  12613. // get a content coding, so `Content-Range` still names identity bytes and
  12614. // none of the range handling below applies.
  12615. if (apply_static_file_compression(req, res)) { return; }
  12616. if (req.ranges.size() > 1 && res.status == StatusCode::PartialContent_206) {
  12617. auto it = res.headers.find("Content-Type");
  12618. if (it != res.headers.end()) {
  12619. content_type = it->second;
  12620. res.headers.erase(it);
  12621. }
  12622. boundary = detail::make_multipart_data_boundary();
  12623. res.set_header("Content-Type",
  12624. "multipart/byteranges; boundary=" + boundary);
  12625. }
  12626. auto type = detail::encoding_type(req, res);
  12627. if (res.body.empty()) {
  12628. if (res.content_length_ > 0 && req.ranges.size() == 1 &&
  12629. res.status == StatusCode::PartialContent_206) {
  12630. auto offset_and_length = detail::get_range_offset_and_length(
  12631. req.ranges[0], res.content_length_);
  12632. auto content_range = detail::make_content_range_header_field(
  12633. offset_and_length, res.content_length_);
  12634. res.set_header("Content-Range", content_range);
  12635. } else if (res.is_chunked_content_provider_) {
  12636. res.content_coding_ = type;
  12637. if (type != detail::EncodingType::None) {
  12638. res.set_header("Content-Encoding", detail::encoding_name(type));
  12639. res.set_header("Vary", "Accept-Encoding");
  12640. }
  12641. }
  12642. } else {
  12643. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12644. ;
  12645. } else if (req.ranges.size() == 1) {
  12646. auto offset_and_length =
  12647. detail::get_range_offset_and_length(req.ranges[0], res.body.size());
  12648. auto offset = offset_and_length.first;
  12649. auto length = offset_and_length.second;
  12650. auto content_range = detail::make_content_range_header_field(
  12651. offset_and_length, res.body.size());
  12652. res.set_header("Content-Range", content_range);
  12653. assert(offset + length <= res.body.size());
  12654. res.body = res.body.substr(offset, length);
  12655. } else {
  12656. std::string data;
  12657. detail::make_multipart_ranges_data(req, res, boundary, content_type,
  12658. res.body.size(), data);
  12659. res.body.swap(data);
  12660. }
  12661. if (type != detail::EncodingType::None) {
  12662. output_pre_compression_log(req, res);
  12663. if (auto compressor = detail::make_compressor(type)) {
  12664. std::string compressed;
  12665. if (compressor->compress(res.body.data(), res.body.size(), true,
  12666. [&](const char *data, size_t data_len) {
  12667. compressed.append(data, data_len);
  12668. return true;
  12669. })) {
  12670. res.body.swap(compressed);
  12671. res.set_header("Content-Encoding", detail::encoding_name(type));
  12672. res.set_header("Vary", "Accept-Encoding");
  12673. }
  12674. }
  12675. }
  12676. res.content_length_ = res.body.size();
  12677. }
  12678. }
  12679. inline bool Server::dispatch_request_for_content_reader(
  12680. Request &req, Response &res, ContentReader content_reader,
  12681. const HandlersForContentReader &handlers) const {
  12682. for (const auto &x : handlers) {
  12683. const auto &matcher = x.first;
  12684. const auto &handler = x.second;
  12685. if (matcher->match(req)) {
  12686. req.matched_route = matcher->pattern();
  12687. if (!pre_request_handler_ ||
  12688. pre_request_handler_(req, res) != HandlerResponse::Handled) {
  12689. handler(req, res, content_reader);
  12690. }
  12691. return true;
  12692. }
  12693. }
  12694. return false;
  12695. }
  12696. inline std::string
  12697. get_client_ip(const std::string &x_forwarded_for,
  12698. const std::vector<std::string> &trusted_proxies) {
  12699. // X-Forwarded-For is a comma-separated list per RFC 7239
  12700. std::vector<std::string> ip_list;
  12701. detail::split(x_forwarded_for.data(),
  12702. x_forwarded_for.data() + x_forwarded_for.size(), ',',
  12703. [&](const char *b, const char *e) {
  12704. auto r = detail::trim(b, e, 0, static_cast<size_t>(e - b));
  12705. ip_list.emplace_back(std::string(b + r.first, b + r.second));
  12706. });
  12707. // A malformed X-Forwarded-For (empty, comma-only, whitespace-only) yields
  12708. // no segments. Signal "no client IP derived" with an empty string so the
  12709. // caller can fall back to the connection-level remote address.
  12710. if (ip_list.empty()) { return std::string(); }
  12711. // Each hop appends the address it received the request from, so the rightmost
  12712. // entries are the ones written by our own infrastructure while the leftmost
  12713. // are whatever the original client chose to send. Walk from the right and
  12714. // skip trusted proxies; the first address that is not a trusted proxy is the
  12715. // furthest point still attributable to a real hop, i.e. the client. Scanning
  12716. // from the left instead lets a client forge an arbitrary address by following
  12717. // it with a trusted proxy's address, which the left-to-right scan then
  12718. // returned as the client.
  12719. for (size_t i = ip_list.size(); i-- > 0;) {
  12720. const auto &ip = ip_list[i];
  12721. auto is_trusted_proxy =
  12722. std::any_of(trusted_proxies.begin(), trusted_proxies.end(),
  12723. [&](const std::string &proxy) { return ip == proxy; });
  12724. if (!is_trusted_proxy) { return ip; }
  12725. }
  12726. // Every hop was a trusted proxy; fall back to the first entry.
  12727. return ip_list.front();
  12728. }
  12729. inline bool
  12730. Server::process_request(Stream &strm, const std::string &remote_addr,
  12731. int remote_port, const std::string &local_addr,
  12732. int local_port, bool close_connection,
  12733. bool &connection_closed,
  12734. const std::function<void(Request &)> &setup_request,
  12735. bool *websocket_upgraded) {
  12736. std::array<char, 2048> buf{};
  12737. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12738. // The read timeout bounds the request line and headers as a whole, so a
  12739. // client sending them a byte at a time cannot hold the worker any longer.
  12740. strm.set_max_timeout(read_timeout_sec_ * 1000 + read_timeout_usec_ / 1000);
  12741. // Connection has been closed on client
  12742. if (!line_reader.getline()) { return false; }
  12743. // RFC 9112 2.2: ignore an empty line received before the request-line. Some
  12744. // clients send an extra CRLF after a request body, which would otherwise be
  12745. // parsed as the next request on a persistent connection.
  12746. if (strcmp(line_reader.ptr(), "\r\n") == 0 && !line_reader.getline()) {
  12747. return false;
  12748. }
  12749. Request req;
  12750. req.start_time_ = std::chrono::steady_clock::now();
  12751. req.remote_addr = remote_addr;
  12752. req.remote_port = remote_port;
  12753. req.local_addr = local_addr;
  12754. req.local_port = local_port;
  12755. Response res;
  12756. res.version = "HTTP/1.1";
  12757. res.headers = default_headers_;
  12758. // RFC 9112 §9.6: a server that sends the "close" connection option must
  12759. // close the connection after that response, whichever path wrote it (an
  12760. // error status, a handler, or a rejected request). Reading on would also
  12761. // parse whatever the client sent next on a connection it considers done.
  12762. auto honor_connection_close = detail::scope_exit([&] {
  12763. if (detail::has_header_token(res.headers, "Connection", "close")) {
  12764. connection_closed = true;
  12765. }
  12766. });
  12767. // Request line and headers. A rejected message leaves the rest of it (and
  12768. // any body) unread, so the connection cannot be reused: the leftover bytes
  12769. // would be parsed as the next request.
  12770. if (!parse_request_line(line_reader.ptr(), req)) {
  12771. connection_closed = true;
  12772. res.status = StatusCode::BadRequest_400;
  12773. output_error_log(Error::InvalidRequestLine, &req);
  12774. return write_response(strm, close_connection, req, res);
  12775. }
  12776. // Request headers
  12777. if (!detail::read_headers(strm, req.headers)) {
  12778. connection_closed = true;
  12779. res.status = StatusCode::BadRequest_400;
  12780. output_error_log(Error::InvalidHeaders, &req);
  12781. return write_response(strm, close_connection, req, res);
  12782. }
  12783. strm.set_max_timeout(0);
  12784. // RFC 9112 §6.3: Reject requests whose framing is invalid or ambiguous,
  12785. // which would otherwise let an intermediary and this parser disagree on
  12786. // where the body ends and enable request smuggling. Three cases: a
  12787. // Content-Length that is not a valid decimal length (e.g. "42, 42", "+42"
  12788. // or empty), which would otherwise be read as "no body"; a non-zero
  12789. // Content-Length alongside any Transfer-Encoding (Content-Length: 0 is
  12790. // tolerated for compatibility with existing clients); and a
  12791. // Transfer-Encoding whose final coding is not chunked, which leaves the body
  12792. // length undeterminable. None of them may fall through to the "no body"
  12793. // path, or the body bytes are parsed as the next request on a persistent
  12794. // connection.
  12795. auto is_invalid_content_length = false;
  12796. detail::get_header_value_u64(req.headers, "Content-Length", 0, 0,
  12797. is_invalid_content_length);
  12798. if (is_invalid_content_length ||
  12799. detail::has_conflicting_content_length(req.headers) ||
  12800. (req.has_header("Transfer-Encoding") &&
  12801. !detail::is_chunked_transfer_encoding(req.headers))) {
  12802. connection_closed = true;
  12803. res.status = StatusCode::BadRequest_400;
  12804. return write_response(strm, close_connection, req, res);
  12805. }
  12806. // RFC 9112 §6.1: a Transfer-Encoding alongside a Content-Length, or in an
  12807. // HTTP/1.0 request, is honoured, but the connection closes after the
  12808. // response.
  12809. if (detail::has_faulty_transfer_encoding(req)) { connection_closed = true; }
  12810. // RFC 9112 §3.2: Reject more than one Host field line, an invalid Host
  12811. // value, or none in HTTP/1.1, so that every recipient of the request sees
  12812. // the same authority.
  12813. auto host_count = req.get_header_value_count("Host");
  12814. if (host_count > 1 || (host_count == 0 && req.version == "HTTP/1.1") ||
  12815. !detail::fields::is_host(req.get_header_value("Host"))) {
  12816. connection_closed = true;
  12817. res.status = StatusCode::BadRequest_400;
  12818. output_error_log(Error::InvalidHeaders, &req);
  12819. return write_response(strm, close_connection, req, res);
  12820. }
  12821. // Check if the request URI doesn't exceed the limit
  12822. if (req.target.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  12823. connection_closed = true;
  12824. res.status = StatusCode::UriTooLong_414;
  12825. output_error_log(Error::ExceedUriMaxLength, &req);
  12826. return write_response(strm, close_connection, req, res);
  12827. }
  12828. if (detail::has_header_token(req.headers, "Connection", "close")) {
  12829. connection_closed = true;
  12830. }
  12831. if (req.version == "HTTP/1.0" &&
  12832. !detail::has_header_token(req.headers, "Connection", "keep-alive")) {
  12833. connection_closed = true;
  12834. }
  12835. // Only honor X-Forwarded-For if the peer on the actual TCP connection is
  12836. // itself a trusted proxy. Otherwise any direct client could spoof
  12837. // remote_addr simply by sending an arbitrary X-Forwarded-For header.
  12838. auto is_trusted_peer = std::any_of(
  12839. trusted_proxies_.begin(), trusted_proxies_.end(),
  12840. [&](const std::string &proxy) { return proxy == remote_addr; });
  12841. if (is_trusted_peer && req.has_header("X-Forwarded-For")) {
  12842. // Some proxies append the address they observed as a separate
  12843. // X-Forwarded-For field line instead of extending the one the client sent
  12844. // (e.g. HAProxy's "option forwardfor"), so the whole combined value has to
  12845. // be scanned. Reading only the first occurrence would hand back the
  12846. // client-supplied, and therefore forgeable, value.
  12847. auto x_forwarded_for =
  12848. detail::get_combined_header_value(req.headers, "X-Forwarded-For");
  12849. auto derived = get_client_ip(x_forwarded_for, trusted_proxies_);
  12850. req.remote_addr = derived.empty() ? remote_addr : derived;
  12851. } else {
  12852. req.remote_addr = remote_addr;
  12853. }
  12854. req.remote_port = remote_port;
  12855. req.local_addr = local_addr;
  12856. req.local_port = local_port;
  12857. if (req.has_header("Accept")) {
  12858. auto accept_header =
  12859. detail::get_combined_header_value(req.headers, "Accept");
  12860. if (!detail::parse_accept_header(accept_header, req.accept_content_types)) {
  12861. connection_closed = true;
  12862. res.status = StatusCode::BadRequest_400;
  12863. output_error_log(Error::HTTPParsing, &req);
  12864. return write_response(strm, close_connection, req, res);
  12865. }
  12866. }
  12867. if (req.has_header("Range")) {
  12868. const auto &range_header_value = req.get_header_value("Range");
  12869. if (!detail::parse_range_header(range_header_value, req.ranges)) {
  12870. connection_closed = true;
  12871. res.status = StatusCode::RangeNotSatisfiable_416;
  12872. output_error_log(Error::InvalidRangeHeader, &req);
  12873. return write_response(strm, close_connection, req, res);
  12874. }
  12875. }
  12876. if (setup_request) { setup_request(req); }
  12877. // RFC 9110 10.1.1: Expect is a comma-separated list whose value is
  12878. // case-insensitive, and a 100-continue expectation in an HTTP/1.0 request
  12879. // must be ignored. An expectation we do not recognize is left alone; the
  12880. // 417 the section allows for one is a MAY, not a requirement.
  12881. //
  12882. // `100 Continue` itself is deferred until the body is actually read (see
  12883. // read_content_core), so a request rejected by a later handler never
  12884. // invites the client to send a body nobody will read.
  12885. if (req.version != "HTTP/1.0" &&
  12886. detail::has_header_token(req.headers, "Expect", "100-continue")) {
  12887. int status = StatusCode::Continue_100;
  12888. if (expect_100_continue_handler_) {
  12889. status = expect_100_continue_handler_(req, res);
  12890. }
  12891. if (status == StatusCode::Continue_100) {
  12892. req.expect_100_continue_pending_ = true;
  12893. } else {
  12894. if (res.status == -1) { res.status = status; }
  12895. connection_closed = true;
  12896. return write_response(strm, true, req, res);
  12897. }
  12898. }
  12899. // Setup `is_connection_closed` method
  12900. auto sock = strm.socket();
  12901. req.is_connection_closed = [sock]() {
  12902. return !detail::is_socket_alive(sock);
  12903. };
  12904. // WebSocket upgrade
  12905. // Run pre_routing_handler_ and pre_request_handler_ before upgrading so
  12906. // that authentication and other middleware can reject the request with an
  12907. // HTTP response (e.g., 401) before the protocol switches.
  12908. // The response says so when this connection closes after it.
  12909. auto close_after_response = close_connection || connection_closed;
  12910. // An upgrade request has been through pre-routing before it reaches routing()
  12911. auto is_upgrade = detail::is_websocket_upgrade(req);
  12912. if (is_upgrade) {
  12913. // A response given here leaves the body unread, and it would be parsed as
  12914. // the next request.
  12915. auto close_if_answered =
  12916. close_after_response || detail::has_framed_body(req);
  12917. if (pre_routing_handler_ &&
  12918. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12919. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12920. return write_response_with_content(strm, close_if_answered, req, res);
  12921. }
  12922. // Find matching WebSocket handler
  12923. for (const auto &entry : websocket_handlers_) {
  12924. if (entry.matcher->match(req)) {
  12925. req.matched_route = entry.matcher->pattern();
  12926. if (pre_request_handler_ &&
  12927. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12928. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12929. return write_response_with_content(strm, close_if_answered, req, res);
  12930. }
  12931. // Compute accept key
  12932. auto client_key = req.get_header_value("Sec-WebSocket-Key");
  12933. auto accept_key = detail::websocket_accept_key(client_key);
  12934. // Negotiate subprotocol
  12935. std::string selected_subprotocol;
  12936. if (entry.sub_protocol_selector) {
  12937. auto protocol_header = detail::get_combined_header_value(
  12938. req.headers, "Sec-WebSocket-Protocol");
  12939. if (!protocol_header.empty()) {
  12940. std::vector<std::string> protocols;
  12941. detail::split(protocol_header.data(),
  12942. protocol_header.data() + protocol_header.size(), ',',
  12943. [&](const char *b, const char *e) {
  12944. protocols.emplace_back(b, e);
  12945. });
  12946. selected_subprotocol = entry.sub_protocol_selector(protocols);
  12947. // Ignore a selection the client did not offer (RFC 6455 4.2.2)
  12948. if (std::find(protocols.begin(), protocols.end(),
  12949. selected_subprotocol) == protocols.end()) {
  12950. selected_subprotocol.clear();
  12951. }
  12952. }
  12953. }
  12954. // Send 101 Switching Protocols
  12955. std::string handshake_response = "HTTP/1.1 101 Switching Protocols\r\n"
  12956. "Upgrade: websocket\r\n"
  12957. "Connection: Upgrade\r\n"
  12958. "Sec-WebSocket-Accept: " +
  12959. accept_key + "\r\n";
  12960. if (!selected_subprotocol.empty()) {
  12961. if (!detail::fields::is_field_value(selected_subprotocol)) {
  12962. return false;
  12963. }
  12964. handshake_response +=
  12965. "Sec-WebSocket-Protocol: " + selected_subprotocol + "\r\n";
  12966. }
  12967. handshake_response += "\r\n";
  12968. if (strm.write(handshake_response.data(), handshake_response.size()) <
  12969. 0) {
  12970. return false;
  12971. }
  12972. connection_closed = true;
  12973. if (websocket_upgraded) { *websocket_upgraded = true; }
  12974. {
  12975. #ifdef CPPHTTPLIB_SSL_ENABLED
  12976. if (req.ssl) {
  12977. // wss: the heartbeat ping thread and the read path enter the same
  12978. // TLS session from different threads. Hand the WebSocket a stream
  12979. // that serializes every TLS call, so the shared SSLSocketStream on
  12980. // the plain HTTP/HTTPS paths stays untouched.
  12981. auto ws_strm =
  12982. std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  12983. strm.socket(), const_cast<tls::session_t>(req.ssl),
  12984. CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0,
  12985. write_timeout_sec_, write_timeout_usec_));
  12986. ws::WebSocket ws(std::move(ws_strm), req, true,
  12987. websocket_ping_interval_sec_,
  12988. websocket_max_missed_pongs_);
  12989. entry.handler(req, ws);
  12990. return true;
  12991. }
  12992. #endif
  12993. // Use WebSocket-specific read timeout instead of HTTP timeout
  12994. strm.set_read_timeout(CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND,
  12995. 0);
  12996. ws::WebSocket ws(strm, req, true, websocket_ping_interval_sec_,
  12997. websocket_max_missed_pongs_);
  12998. entry.handler(req, ws);
  12999. }
  13000. return true;
  13001. }
  13002. }
  13003. // No WebSocket route: route it as a plain HTTP request
  13004. }
  13005. // Routing
  13006. auto routed = false;
  13007. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  13008. routed = routing(req, res, strm, is_upgrade);
  13009. #else
  13010. try {
  13011. routed = routing(req, res, strm, is_upgrade);
  13012. } catch (std::exception &) {
  13013. if (exception_handler_) {
  13014. auto ep = std::current_exception();
  13015. exception_handler_(req, res, ep);
  13016. routed = true;
  13017. } else {
  13018. res.status = StatusCode::InternalServerError_500;
  13019. }
  13020. } catch (...) {
  13021. if (exception_handler_) {
  13022. auto ep = std::current_exception();
  13023. exception_handler_(req, res, ep);
  13024. routed = true;
  13025. } else {
  13026. res.status = StatusCode::InternalServerError_500;
  13027. }
  13028. }
  13029. #endif
  13030. auto ret = false;
  13031. if (routed) {
  13032. if (res.status == -1) {
  13033. res.status = req.ranges.empty() ? StatusCode::OK_200
  13034. : StatusCode::PartialContent_206;
  13035. }
  13036. // Before the Range checks below, so they see the body's own length.
  13037. detail::prefer_assigned_body(res);
  13038. // Serve file content by using a content provider
  13039. auto file_open_error = false;
  13040. if (!res.file_content_path_.empty()) {
  13041. const auto &path = res.file_content_path_;
  13042. auto mm = std::make_shared<detail::mmap>(path.c_str());
  13043. if (!mm->is_open()) {
  13044. res.status = StatusCode::NotFound_404;
  13045. output_error_log(Error::OpenFile, &req);
  13046. file_open_error = true;
  13047. } else {
  13048. auto content_type = res.file_content_content_type_;
  13049. if (content_type.empty()) {
  13050. // One the handler set after set_file_content()
  13051. content_type = res.get_header_value("Content-Type");
  13052. }
  13053. if (content_type.empty()) {
  13054. content_type = detail::find_content_type(
  13055. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  13056. }
  13057. detail::set_file_content_provider(
  13058. res, mm, content_type,
  13059. static_file_encoding(req, res, content_type, mm->size()));
  13060. }
  13061. }
  13062. if (file_open_error) {
  13063. ret = write_response(strm, close_after_response, req, res);
  13064. } else if (detail::range_error(req, res)) {
  13065. detail::clear_content(res);
  13066. res.status = StatusCode::RangeNotSatisfiable_416;
  13067. ret = write_response(strm, close_after_response, req, res);
  13068. } else {
  13069. ret = write_response_with_content(strm, close_after_response, req, res);
  13070. }
  13071. } else {
  13072. if (res.status == -1) { res.status = StatusCode::NotFound_404; }
  13073. ret = write_response(strm, close_after_response, req, res);
  13074. }
  13075. // Drain any unconsumed framed body to prevent request smuggling on
  13076. // keep-alive. Without framing there is no body to drain — reading would
  13077. // consume the next request (issue #2450). If the response has committed the
  13078. // connection to close, there is no next request to protect. A body read in
  13079. // part cannot be drained from where it stopped, so the connection closes.
  13080. if (!req.body_consumed_ && detail::has_framed_body(req) &&
  13081. !detail::has_header_token(res.headers, "Connection", "close")) {
  13082. int dummy_status;
  13083. if (req.body_read_started_ ||
  13084. !detail::read_content(
  13085. strm, req, payload_max_length_, dummy_status, nullptr,
  13086. [](const char *, size_t, size_t, size_t) { return true; }, false)) {
  13087. connection_closed = true;
  13088. }
  13089. }
  13090. return ret;
  13091. }
  13092. inline bool Server::is_valid() const { return !has_invalid_registration_; }
  13093. inline bool Server::process_and_close_socket(socket_t sock) {
  13094. std::string remote_addr;
  13095. int remote_port = 0;
  13096. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  13097. std::string local_addr;
  13098. int local_port = 0;
  13099. detail::get_local_ip_and_port(sock, local_addr, local_port);
  13100. bool websocket_upgraded = false;
  13101. auto ret = serve_guarded([&]() {
  13102. return detail::process_server_socket(
  13103. svr_sock_, sock, keep_alive_max_count_, keep_alive_timeout_sec_,
  13104. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13105. write_timeout_usec_,
  13106. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  13107. return process_request(strm, remote_addr, remote_port, local_addr,
  13108. local_port, close_connection,
  13109. connection_closed, nullptr,
  13110. &websocket_upgraded);
  13111. });
  13112. });
  13113. detail::drain_and_close_socket(sock);
  13114. return ret;
  13115. }
  13116. inline void Server::output_log(const Request &req, const Response &res) const {
  13117. if (logger_) {
  13118. std::lock_guard<std::mutex> guard(logger_mutex_);
  13119. logger_(req, res);
  13120. }
  13121. }
  13122. inline void Server::output_pre_compression_log(const Request &req,
  13123. const Response &res) const {
  13124. if (pre_compression_logger_) {
  13125. std::lock_guard<std::mutex> guard(logger_mutex_);
  13126. pre_compression_logger_(req, res);
  13127. }
  13128. }
  13129. inline void Server::output_error_log(const Error &err,
  13130. const Request *req) const {
  13131. if (error_logger_) {
  13132. std::lock_guard<std::mutex> guard(logger_mutex_);
  13133. error_logger_(err, req);
  13134. }
  13135. }
  13136. /*
  13137. * Group 5: ClientImpl and Client (Universal) implementation
  13138. */
  13139. // HTTP client implementation
  13140. inline ClientImpl::ClientImpl(const std::string &host)
  13141. : ClientImpl(host, 80, std::string(), std::string()) {}
  13142. inline ClientImpl::ClientImpl(const std::string &host, int port)
  13143. : ClientImpl(host, port, std::string(), std::string()) {}
  13144. inline ClientImpl::ClientImpl(const std::string &host, int port,
  13145. const std::string &client_cert_path,
  13146. const std::string &client_key_path)
  13147. : host_(detail::escape_abstract_namespace_unix_domain(host)), port_(port),
  13148. client_cert_path_(client_cert_path), client_key_path_(client_key_path) {}
  13149. inline ClientImpl::~ClientImpl() {
  13150. // Wait until all the requests in flight are handled.
  13151. size_t retry_count = 10;
  13152. while (retry_count-- > 0) {
  13153. {
  13154. std::lock_guard<std::mutex> guard(socket_mutex_);
  13155. if (socket_requests_in_flight_ == 0) { break; }
  13156. }
  13157. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  13158. }
  13159. std::lock_guard<std::mutex> guard(socket_mutex_);
  13160. shutdown_socket(socket_);
  13161. close_socket(socket_);
  13162. }
  13163. inline bool ClientImpl::is_valid() const { return true; }
  13164. inline bool
  13165. ClientImpl::is_proxy_enabled_for_host(const std::string &host) const {
  13166. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  13167. if (no_proxy_entries_.empty()) { return true; }
  13168. // host_ is const so its normalized form is invariant; cache it. The
  13169. // cross-host path (setup_redirect_client passing next_host) re-normalizes.
  13170. if (host == host_) {
  13171. if (!host_normalized_valid_) {
  13172. host_normalized_ = detail::normalize_target(host_);
  13173. host_normalized_valid_ = true;
  13174. }
  13175. return !detail::host_matches_no_proxy(host_normalized_, no_proxy_entries_);
  13176. }
  13177. auto target = detail::normalize_target(host);
  13178. return !detail::host_matches_no_proxy(target, no_proxy_entries_);
  13179. }
  13180. inline socket_t ClientImpl::create_client_socket(Error &error) const {
  13181. if (is_proxy_enabled_for_host(host_)) {
  13182. return detail::create_client_socket(
  13183. proxy_host_, std::string(), proxy_port_, address_family_, tcp_nodelay_,
  13184. ipv6_v6only_, socket_options_, connection_timeout_sec_,
  13185. connection_timeout_usec_, read_timeout_sec_, read_timeout_usec_,
  13186. write_timeout_sec_, write_timeout_usec_, interface_, error);
  13187. }
  13188. // Check is custom IP or hostname specified for host_
  13189. std::string connect_host;
  13190. std::string ip;
  13191. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  13192. return detail::create_client_socket(
  13193. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  13194. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  13195. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13196. write_timeout_usec_, interface_, error);
  13197. }
  13198. inline bool ClientImpl::create_and_connect_socket(Socket &socket,
  13199. Error &error) {
  13200. auto sock = create_client_socket(error);
  13201. if (sock == INVALID_SOCKET) { return false; }
  13202. socket.sock = sock;
  13203. return true;
  13204. }
  13205. inline bool ClientImpl::ensure_socket_connection(Socket &socket, Error &error) {
  13206. return create_and_connect_socket(socket, error);
  13207. }
  13208. inline bool ClientImpl::setup_proxy_connection(
  13209. Socket & /*socket*/,
  13210. std::chrono::time_point<std::chrono::steady_clock> /*start_time*/,
  13211. Response & /*res*/, bool & /*success*/, Error & /*error*/) {
  13212. return true;
  13213. }
  13214. inline void ClientImpl::shutdown_ssl(Socket & /*socket*/,
  13215. bool /*shutdown_gracefully*/) {
  13216. // If there are any requests in flight from threads other than us, then it's
  13217. // a thread-unsafe race because individual ssl* objects are not thread-safe.
  13218. assert(socket_requests_in_flight_ == 0 ||
  13219. socket_requests_are_from_thread_ == std::this_thread::get_id());
  13220. }
  13221. inline void ClientImpl::shutdown_socket(Socket &socket) const {
  13222. if (socket.sock == INVALID_SOCKET) { return; }
  13223. detail::shutdown_socket(socket.sock);
  13224. }
  13225. inline void ClientImpl::close_socket(Socket &socket) {
  13226. // If there are requests in flight in another thread, usually closing
  13227. // the socket will be fine and they will simply receive an error when
  13228. // using the closed socket, but it is still a bug since rarely the OS
  13229. // may reassign the socket id to be used for a new socket, and then
  13230. // suddenly they will be operating on a live socket that is different
  13231. // than the one they intended!
  13232. assert(socket_requests_in_flight_ == 0 ||
  13233. socket_requests_are_from_thread_ == std::this_thread::get_id());
  13234. // It is also a bug if this happens while SSL is still active
  13235. #ifdef CPPHTTPLIB_SSL_ENABLED
  13236. assert(socket.ssl == nullptr);
  13237. #endif
  13238. if (socket.sock == INVALID_SOCKET) { return; }
  13239. detail::close_socket(socket.sock);
  13240. socket.sock = INVALID_SOCKET;
  13241. }
  13242. inline void ClientImpl::disconnect(bool gracefully) {
  13243. shutdown_ssl(socket_, gracefully);
  13244. shutdown_socket(socket_);
  13245. close_socket(socket_);
  13246. }
  13247. inline bool ClientImpl::read_response_line(Stream &strm, const Request &req,
  13248. Response &res,
  13249. bool skip_100_continue) const {
  13250. std::array<char, 2048> buf{};
  13251. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  13252. if (!line_reader.getline()) { return false; }
  13253. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  13254. res.reason)) {
  13255. return req.method == "CONNECT";
  13256. }
  13257. // Skip interim (1xx) responses along with their header fields, except a 100
  13258. // Continue the caller handles itself for Expect: 100-continue. 101 ends
  13259. // HTTP on the connection, so it is final. A server sending them without end
  13260. // would hold the client, so there may be only so many.
  13261. size_t interim_count = 0;
  13262. while (100 <= res.status && res.status < 200 &&
  13263. res.status != StatusCode::SwitchingProtocol_101 &&
  13264. (skip_100_continue || res.status != StatusCode::Continue_100)) {
  13265. if (++interim_count > CPPHTTPLIB_INTERIM_RESPONSE_MAX_COUNT) {
  13266. return false;
  13267. }
  13268. Headers interim_headers;
  13269. if (!detail::read_headers(strm, interim_headers)) { return false; }
  13270. if (!line_reader.getline()) { return false; } // next response line
  13271. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  13272. res.reason)) {
  13273. return false;
  13274. }
  13275. }
  13276. return true;
  13277. }
  13278. inline bool ClientImpl::send(Request &req, Response &res, Error &error) {
  13279. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  13280. // A same-origin redirect and a digest retry send through here again. Only
  13281. // the call the caller made reports a failure, once, with its request.
  13282. auto outermost = send_depth_++ == 0;
  13283. auto se = detail::scope_exit([&] { send_depth_--; });
  13284. if (outermost) { error = Error::Success; }
  13285. auto ret = send_(req, res, error);
  13286. if (error == Error::SSLPeerCouldBeClosed_) {
  13287. assert(!ret);
  13288. ret = send_(req, res, error);
  13289. // If still failing with SSLPeerCouldBeClosed_, convert to Read error
  13290. if (error == Error::SSLPeerCouldBeClosed_) { error = Error::Read; }
  13291. }
  13292. // Also an answer that carries an error, such as a proxy's 407
  13293. if (outermost && error != Error::Success) { output_error_log(error, &req); }
  13294. return ret;
  13295. }
  13296. inline bool ClientImpl::send_(Request &req, Response &res, Error &error) {
  13297. #ifdef CPPHTTPLIB_SSL_ENABLED
  13298. // Don't let an earlier attempt's TLS error show up in this one's Result. A
  13299. // client that failed to set up its TLS context keeps reporting why.
  13300. if (is_valid()) {
  13301. last_ssl_error_ = 0;
  13302. last_backend_error_ = 0;
  13303. }
  13304. #endif
  13305. {
  13306. std::lock_guard<std::mutex> guard(socket_mutex_);
  13307. // Set this to false immediately - if it ever gets set to true by the end
  13308. // of the request, we know another thread instructed us to close the
  13309. // socket.
  13310. socket_should_be_closed_when_request_is_done_ = false;
  13311. auto is_alive = false;
  13312. if (socket_.is_open()) {
  13313. is_alive = detail::is_socket_alive(socket_.sock);
  13314. #ifdef CPPHTTPLIB_SSL_ENABLED
  13315. if (is_alive && is_ssl()) {
  13316. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13317. is_alive = false;
  13318. }
  13319. }
  13320. #endif
  13321. if (!is_alive) {
  13322. // Peer seems gone — non-graceful shutdown to avoid SIGPIPE.
  13323. disconnect(/*gracefully=*/false);
  13324. }
  13325. }
  13326. if (!is_alive) {
  13327. if (!ensure_socket_connection(socket_, error)) { return false; }
  13328. {
  13329. auto success = true;
  13330. if (!setup_proxy_connection(socket_, req.start_time_, res, success,
  13331. error)) {
  13332. return success;
  13333. }
  13334. }
  13335. }
  13336. // Mark the current socket as being in use so that it cannot be closed by
  13337. // anyone else while this request is ongoing, even though we will be
  13338. // releasing the mutex.
  13339. if (socket_requests_in_flight_ > 1) {
  13340. assert(socket_requests_are_from_thread_ == std::this_thread::get_id());
  13341. }
  13342. socket_requests_in_flight_ += 1;
  13343. socket_requests_are_from_thread_ = std::this_thread::get_id();
  13344. }
  13345. for (const auto &header : default_headers_) {
  13346. if (req.headers.find(header.first) == req.headers.end()) {
  13347. req.headers.insert(header);
  13348. }
  13349. }
  13350. auto ret = false;
  13351. auto close_connection = !keep_alive_;
  13352. auto se = detail::scope_exit([&]() {
  13353. // Briefly lock mutex in order to mark that a request is no longer ongoing
  13354. std::lock_guard<std::mutex> guard(socket_mutex_);
  13355. socket_requests_in_flight_ -= 1;
  13356. if (socket_requests_in_flight_ <= 0) {
  13357. assert(socket_requests_in_flight_ == 0);
  13358. socket_requests_are_from_thread_ = std::thread::id();
  13359. }
  13360. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  13361. !ret) {
  13362. disconnect(/*gracefully=*/true);
  13363. }
  13364. });
  13365. ret = process_socket(socket_, req.start_time_, [&](Stream &strm) {
  13366. return handle_request(strm, req, res, close_connection, error);
  13367. });
  13368. if (!ret) {
  13369. if (error == Error::Success) { error = Error::Unknown; }
  13370. }
  13371. return ret;
  13372. }
  13373. inline Result ClientImpl::send(const Request &req) {
  13374. auto req2 = req;
  13375. return send_(std::move(req2));
  13376. }
  13377. inline Result ClientImpl::send_(Request &&req) {
  13378. auto res = detail::make_unique<Response>();
  13379. auto error = Error::Success;
  13380. #ifdef CPPHTTPLIB_SSL_ENABLED
  13381. // Hold the request lock until the Result has read this request's TLS error
  13382. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  13383. #endif
  13384. auto ret = send(req, *res, error);
  13385. #ifdef CPPHTTPLIB_SSL_ENABLED
  13386. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers),
  13387. last_ssl_error_, last_backend_error_};
  13388. #else
  13389. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers)};
  13390. #endif
  13391. }
  13392. inline void ClientImpl::prepare_default_headers(Request &r, bool for_stream,
  13393. const std::string &ct) {
  13394. (void)for_stream;
  13395. // Default headers are meant for the origin and may carry its credentials, so
  13396. // keep them off the CONNECT request the proxy reads.
  13397. if (r.method != "CONNECT") {
  13398. for (const auto &header : default_headers_) {
  13399. if (!r.has_header(header.first)) { r.headers.insert(header); }
  13400. }
  13401. }
  13402. // RFC 9110 5.3 recommends sending control data such as Host first, so
  13403. // prepend it rather than appending it after the caller's own fields.
  13404. if (!r.has_header("Host")) {
  13405. r.headers.emplace_front(
  13406. "Host", detail::make_default_host_header_value(host_, port_, is_ssl(),
  13407. address_family_));
  13408. }
  13409. if (!r.has_header("Accept")) { r.headers.emplace("Accept", "*/*"); }
  13410. if (!r.content_receiver) {
  13411. if (!r.has_header("Accept-Encoding")) {
  13412. std::string accept_encoding;
  13413. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  13414. accept_encoding = "br";
  13415. #endif
  13416. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  13417. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13418. accept_encoding += "gzip, deflate";
  13419. #endif
  13420. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  13421. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13422. accept_encoding += "zstd";
  13423. #endif
  13424. r.set_header("Accept-Encoding", accept_encoding);
  13425. }
  13426. detail::add_default_user_agent_header(r);
  13427. }
  13428. if (!r.body.empty()) {
  13429. if (!ct.empty() && !r.has_header("Content-Type")) {
  13430. r.headers.emplace("Content-Type", ct);
  13431. }
  13432. if (!r.has_header("Content-Length")) {
  13433. r.headers.emplace("Content-Length", std::to_string(r.body.size()));
  13434. }
  13435. }
  13436. }
  13437. inline ClientImpl::StreamHandle
  13438. ClientImpl::open_stream(const std::string &method, const std::string &path,
  13439. const Params &params, const Headers &headers,
  13440. const std::string &body,
  13441. const std::string &content_type) {
  13442. // Encode the target exactly like the buffered send path does, so that the
  13443. // same `path` produces the same request line through either API.
  13444. auto raw_query_path =
  13445. params.empty() ? path : append_query_params(path, params);
  13446. Request req;
  13447. req.method = method;
  13448. req.path = detail::encode_request_target(raw_query_path, path_encode_);
  13449. req.headers = headers;
  13450. req.body = body;
  13451. prepare_default_headers(req, true, content_type);
  13452. auto handle = open_stream_(req);
  13453. // Like a buffered request, a stream that fails to open is reported once
  13454. if (handle.error != Error::Success) { output_error_log(handle.error, &req); }
  13455. return handle;
  13456. }
  13457. inline ClientImpl::StreamHandle ClientImpl::open_stream_(Request &req) {
  13458. StreamHandle handle;
  13459. handle.response = detail::make_unique<Response>();
  13460. handle.error = Error::Success;
  13461. handle.connection_ = detail::make_unique<ClientConnection>();
  13462. {
  13463. std::lock_guard<std::mutex> guard(socket_mutex_);
  13464. auto is_alive = false;
  13465. if (socket_.is_open()) {
  13466. is_alive = detail::is_socket_alive(socket_.sock);
  13467. #ifdef CPPHTTPLIB_SSL_ENABLED
  13468. if (is_alive && is_ssl()) {
  13469. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13470. is_alive = false;
  13471. }
  13472. }
  13473. #endif
  13474. if (!is_alive) { disconnect(/*gracefully=*/false); }
  13475. }
  13476. if (!is_alive) {
  13477. if (!ensure_socket_connection(socket_, handle.error)) {
  13478. handle.response.reset();
  13479. return handle;
  13480. }
  13481. {
  13482. auto success = true;
  13483. auto start_time = std::chrono::steady_clock::now();
  13484. if (!setup_proxy_connection(socket_, start_time, *handle.response,
  13485. success, handle.error)) {
  13486. if (!success) { handle.response.reset(); }
  13487. return handle;
  13488. }
  13489. }
  13490. }
  13491. transfer_socket_ownership_to_handle(handle);
  13492. }
  13493. #ifdef CPPHTTPLIB_SSL_ENABLED
  13494. if (is_ssl() && handle.connection_->session) {
  13495. handle.socket_stream_ = detail::make_unique<detail::SSLSocketStream>(
  13496. handle.connection_->sock, handle.connection_->session,
  13497. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13498. write_timeout_usec_);
  13499. } else {
  13500. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13501. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13502. write_timeout_sec_, write_timeout_usec_);
  13503. }
  13504. #else
  13505. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13506. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13507. write_timeout_sec_, write_timeout_usec_);
  13508. #endif
  13509. handle.stream_ = handle.socket_stream_.get();
  13510. auto &strm = *handle.stream_;
  13511. // After connecting, as for a buffered request
  13512. add_credential_headers(req);
  13513. // Build the request line and headers in memory first, like write_request()
  13514. // does, so that a rejected header leaves nothing on the wire.
  13515. {
  13516. detail::BufferStream bstrm;
  13517. if (detail::write_request_line(bstrm, req.method,
  13518. proxy_target_prefix() + req.path) < 0) {
  13519. handle.error = Error::Write;
  13520. handle.response.reset();
  13521. return handle;
  13522. }
  13523. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13524. handle.error)) {
  13525. handle.response.reset();
  13526. return handle;
  13527. }
  13528. const auto &data = bstrm.get_buffer();
  13529. if (!detail::write_data(strm, data.data(), data.size())) {
  13530. handle.error = Error::Write;
  13531. handle.response.reset();
  13532. return handle;
  13533. }
  13534. }
  13535. if (!req.body.empty()) {
  13536. if (strm.write(req.body.data(), req.body.size()) < 0) {
  13537. handle.error = Error::Write;
  13538. handle.response.reset();
  13539. return handle;
  13540. }
  13541. }
  13542. if (!read_response_line(strm, req, *handle.response) ||
  13543. !detail::read_headers(strm, handle.response->headers)) {
  13544. handle.error = Error::Read;
  13545. handle.response.reset();
  13546. return handle;
  13547. }
  13548. handle.body_reader_.stream = handle.stream_;
  13549. handle.body_reader_.payload_max_length = payload_max_length_;
  13550. // RFC 9112 6.3: a response to HEAD, and a 204 or 304 response, ends with its
  13551. // header section, so none of its framing or coding headers apply.
  13552. if (req.method == "HEAD" ||
  13553. handle.response->status == StatusCode::NoContent_204 ||
  13554. handle.response->status == StatusCode::NotModified_304) {
  13555. handle.body_reader_.eof = true;
  13556. return handle;
  13557. }
  13558. // Same framing check as ClientImpl::process_request()
  13559. if (detail::has_conflicting_content_length(handle.response->headers)) {
  13560. handle.error = Error::Read;
  13561. handle.response.reset();
  13562. return handle;
  13563. }
  13564. if (handle.response->has_header("Content-Length")) {
  13565. bool is_invalid = false;
  13566. auto content_length = detail::get_header_value_u64(
  13567. handle.response->headers, "Content-Length", 0, 0, is_invalid);
  13568. if (is_invalid) {
  13569. handle.error = Error::Read;
  13570. handle.response.reset();
  13571. return handle;
  13572. }
  13573. handle.body_reader_.has_content_length = true;
  13574. handle.body_reader_.content_length = content_length;
  13575. }
  13576. handle.body_reader_.chunked =
  13577. detail::is_chunked_transfer_encoding(handle.response->headers);
  13578. auto content_encoding = detail::get_combined_header_value(
  13579. handle.response->headers, "Content-Encoding");
  13580. if (!content_encoding.empty()) {
  13581. // Same policy as prepare_content_receiver(): reject a coding we know about
  13582. // but were not built with, pass an unrecognized one through as-is.
  13583. handle.decompressor_ = detail::create_decompressor(content_encoding);
  13584. if (!handle.decompressor_) {
  13585. if (detail::is_known_content_encoding(content_encoding)) {
  13586. handle.error = Error::UnsupportedContentEncoding;
  13587. handle.response.reset();
  13588. return handle;
  13589. }
  13590. } else if (!handle.decompressor_->is_valid()) {
  13591. handle.error = Error::Compression;
  13592. handle.response.reset();
  13593. return handle;
  13594. }
  13595. }
  13596. return handle;
  13597. }
  13598. inline ssize_t ClientImpl::StreamHandle::read(char *buf, size_t len) {
  13599. if (!is_valid() || !response) { return -1; }
  13600. auto n = decompressor_
  13601. ? read_with_decompression(buf, len)
  13602. : detail::read_body_content(stream_, body_reader_, buf, len);
  13603. if (n == 0) { parse_trailers_if_needed(); }
  13604. return n;
  13605. }
  13606. inline ssize_t ClientImpl::StreamHandle::read_with_decompression(char *buf,
  13607. size_t len) {
  13608. if (decompress_offset_ < decompress_buffer_.size()) {
  13609. auto available = decompress_buffer_.size() - decompress_offset_;
  13610. auto to_copy = (std::min)(len, available);
  13611. std::memcpy(buf, decompress_buffer_.data() + decompress_offset_, to_copy);
  13612. decompress_offset_ += to_copy;
  13613. decompressed_bytes_read_ += to_copy;
  13614. return static_cast<ssize_t>(to_copy);
  13615. }
  13616. decompress_buffer_.clear();
  13617. decompress_offset_ = 0;
  13618. constexpr size_t kDecompressionBufferSize = 8192;
  13619. char compressed_buf[kDecompressionBufferSize];
  13620. while (true) {
  13621. auto n = detail::read_body_content(stream_, body_reader_, compressed_buf,
  13622. sizeof(compressed_buf));
  13623. if (n <= 0) { return n; }
  13624. auto exceeded = false;
  13625. bool decompress_ok = decompressor_->decompress(
  13626. compressed_buf, static_cast<size_t>(n),
  13627. [&](const char *data, size_t data_len) {
  13628. decompress_buffer_.append(data, data_len);
  13629. auto limit = body_reader_.payload_max_length;
  13630. exceeded =
  13631. limit > 0 &&
  13632. decompressed_bytes_read_ + decompress_buffer_.size() > limit;
  13633. return !exceeded;
  13634. });
  13635. if (!decompress_ok) {
  13636. body_reader_.last_error =
  13637. exceeded ? Error::ExceedMaxPayloadSize : Error::Read;
  13638. return -1;
  13639. }
  13640. if (!decompress_buffer_.empty()) { break; }
  13641. }
  13642. auto to_copy = (std::min)(len, decompress_buffer_.size());
  13643. std::memcpy(buf, decompress_buffer_.data(), to_copy);
  13644. decompress_offset_ = to_copy;
  13645. decompressed_bytes_read_ += to_copy;
  13646. return static_cast<ssize_t>(to_copy);
  13647. }
  13648. inline void ClientImpl::StreamHandle::parse_trailers_if_needed() {
  13649. // The trailers follow the last chunk, so there are none before it
  13650. auto &decoder = body_reader_.chunked_decoder;
  13651. if (!response || trailers_parsed_ || !decoder || !decoder->finished) {
  13652. return;
  13653. }
  13654. trailers_parsed_ = true;
  13655. decoder->parse_trailers_into(response->trailers, response->headers);
  13656. }
  13657. namespace detail {
  13658. inline ChunkedDecoder::ChunkedDecoder(Stream &s) : strm(s) {}
  13659. inline ssize_t ChunkedDecoder::read_payload(char *buf, size_t len,
  13660. size_t &out_chunk_offset,
  13661. size_t &out_chunk_total) {
  13662. if (finished) { return 0; }
  13663. if (chunk_remaining == 0) {
  13664. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13665. if (!lr.getline()) { return -1; }
  13666. // Everything below is bounded by eol rather than by the buffer's NUL, so
  13667. // the line terminator is never mistaken for line content.
  13668. const char *eol = lr.ptr() + lr.size();
  13669. if (lr.end_with_crlf()) {
  13670. eol -= 2;
  13671. } else if (eol != lr.ptr() && eol[-1] == '\n') {
  13672. // Only reachable under CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR, where
  13673. // getline() ends the line on a bare LF. That LF is the terminator, so it
  13674. // has to come off here or the check below would reject the line.
  13675. eol -= 1;
  13676. }
  13677. // RFC 9112 §7.1: chunk-size = 1*HEXDIG
  13678. const char *p = lr.ptr();
  13679. int v = 0;
  13680. if (p == eol || !is_hex(*p, v)) { return -1; }
  13681. size_t chunk_len = 0;
  13682. constexpr size_t chunk_len_max = (std::numeric_limits<size_t>::max)();
  13683. for (; p < eol && is_hex(*p, v); ++p) {
  13684. if (chunk_len > (chunk_len_max >> 4)) { return -1; }
  13685. chunk_len = (chunk_len << 4) | static_cast<size_t>(v);
  13686. }
  13687. while (p < eol && is_space_or_tab(*p)) {
  13688. ++p;
  13689. }
  13690. // RFC 9112 §7.1.1: only a chunk-ext may sit between the size and the line
  13691. // terminator, and it is built from tokens and quoted-strings, so it never
  13692. // holds a CR, LF or any other control character. getline() reads up to the
  13693. // CRLF, so a bare LF left in here would be swallowed as extension text
  13694. // while an intermediary that ends the line on it delimits the chunks
  13695. // differently, and the two disagree on where the body ends (request
  13696. // smuggling).
  13697. if (p < eol && *p != ';') { return -1; }
  13698. for (; p < eol; ++p) {
  13699. if (!is_space_or_tab(*p) && !fields::is_field_vchar(*p)) { return -1; }
  13700. }
  13701. if (chunk_len == 0) {
  13702. chunk_remaining = 0;
  13703. finished = true;
  13704. out_chunk_offset = 0;
  13705. out_chunk_total = 0;
  13706. return 0;
  13707. }
  13708. chunk_remaining = chunk_len;
  13709. last_chunk_total = chunk_remaining;
  13710. last_chunk_offset = 0;
  13711. }
  13712. auto to_read = (std::min)(chunk_remaining, len);
  13713. auto n = strm.read(buf, to_read);
  13714. if (n <= 0) { return -1; }
  13715. auto offset_before = last_chunk_offset;
  13716. last_chunk_offset += static_cast<size_t>(n);
  13717. chunk_remaining -= static_cast<size_t>(n);
  13718. out_chunk_offset = offset_before;
  13719. out_chunk_total = last_chunk_total;
  13720. if (chunk_remaining == 0) {
  13721. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13722. if (!lr.getline()) { return -1; }
  13723. if (std::strcmp(lr.ptr(), "\r\n") != 0) { return -1; }
  13724. }
  13725. return n;
  13726. }
  13727. inline bool ChunkedDecoder::parse_trailers_into(Headers &dest,
  13728. const Headers &src_headers) {
  13729. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13730. if (!lr.getline()) { return false; }
  13731. return parse_trailers(lr, dest, src_headers);
  13732. }
  13733. // A 3xx without a Location, such as a 304, is a final response
  13734. inline bool is_redirect(const Response &res) {
  13735. return 300 < res.status && res.status < 400 &&
  13736. !res.get_header_value("Location").empty();
  13737. }
  13738. } // namespace detail
  13739. inline void
  13740. ClientImpl::transfer_socket_ownership_to_handle(StreamHandle &handle) {
  13741. handle.connection_->sock = socket_.sock;
  13742. #ifdef CPPHTTPLIB_SSL_ENABLED
  13743. handle.connection_->session = socket_.ssl;
  13744. socket_.ssl = nullptr;
  13745. #endif
  13746. socket_.sock = INVALID_SOCKET;
  13747. }
  13748. // A plain HTTP proxy reads the target in absolute-form (RFC 9112 3.2.2)
  13749. inline std::string ClientImpl::proxy_target_prefix() const {
  13750. if (is_ssl() || !is_proxy_enabled_for_host(host_)) { return std::string(); }
  13751. return "http://" + detail::make_host_and_port_string(host_, port_, false);
  13752. }
  13753. inline bool ClientImpl::handle_request(Stream &strm, Request &req,
  13754. Response &res, bool close_connection,
  13755. Error &error) {
  13756. if (req.path.empty()) {
  13757. error = Error::Connection;
  13758. return false;
  13759. }
  13760. auto req_save = req;
  13761. bool ret;
  13762. auto prefix = proxy_target_prefix();
  13763. if (!prefix.empty()) {
  13764. auto req2 = req;
  13765. req2.path = prefix + req.path;
  13766. ret = process_request(strm, req2, res, close_connection, error);
  13767. req = std::move(req2);
  13768. req.path = req_save.path;
  13769. } else {
  13770. ret = process_request(strm, req, res, close_connection, error);
  13771. }
  13772. if (!ret) { return false; }
  13773. {
  13774. // NOTE: this requires a not-entirely-obvious chain of calls to be correct
  13775. // for this to be safe.
  13776. // This is safe to call because handle_request is only called by send_
  13777. // which locks the request mutex during the process. It would be a bug
  13778. // to call it from a different thread since it's a thread-safety issue
  13779. // to do these things to the socket if another thread is using the socket.
  13780. std::lock_guard<std::mutex> guard(socket_mutex_);
  13781. // Also when the request asked for it (e.g. a body that was never sent),
  13782. // so that a redirect or an auth retry below does not reuse the socket.
  13783. if (socket_should_be_closed_when_request_is_done_ ||
  13784. detail::has_header_token(res.headers, "Connection", "close") ||
  13785. (res.version == "HTTP/1.0" && res.reason != "Connection established")) {
  13786. disconnect(/*gracefully=*/true);
  13787. }
  13788. }
  13789. if (follow_location_ && detail::is_redirect(res)) {
  13790. req = std::move(req_save);
  13791. // The client that followed the redirect has answered any challenge it
  13792. // could. Retrying below would sign another host's challenge and send it
  13793. // here.
  13794. return redirect(req, res, error);
  13795. }
  13796. #ifdef CPPHTTPLIB_SSL_ENABLED
  13797. if ((res.status == StatusCode::Unauthorized_401 ||
  13798. res.status == StatusCode::ProxyAuthenticationRequired_407) &&
  13799. req.authorization_count_ < 5) {
  13800. auto is_proxy = res.status == StatusCode::ProxyAuthenticationRequired_407;
  13801. // Only retry when the 407 actually came from a proxy hop: plain HTTP
  13802. // through an enabled proxy. HTTPS via CONNECT tunnels the 407 from the
  13803. // origin (#2457); direct/bypassed origins have no proxy hop at all.
  13804. if (is_proxy && !(!is_ssl() && is_proxy_enabled_for_host(host_))) {
  13805. return ret;
  13806. }
  13807. const auto &username =
  13808. is_proxy ? proxy_digest_auth_username_ : digest_auth_username_;
  13809. const auto &password =
  13810. is_proxy ? proxy_digest_auth_password_ : digest_auth_password_;
  13811. if (!username.empty() && !password.empty()) {
  13812. std::map<std::string, std::string> auth;
  13813. if (detail::parse_www_authenticate(res, auth, is_proxy)) {
  13814. Request new_req = req;
  13815. new_req.authorization_count_ += 1;
  13816. new_req.headers.erase(is_proxy ? "Proxy-Authorization"
  13817. : "Authorization");
  13818. new_req.headers.insert(detail::make_digest_authentication_header(
  13819. req, make_request_target(req), auth, new_req.authorization_count_,
  13820. detail::random_string(10), username, password, is_proxy));
  13821. Response new_res;
  13822. ret = send(new_req, new_res, error);
  13823. if (ret) { res = std::move(new_res); }
  13824. }
  13825. }
  13826. }
  13827. #endif
  13828. return ret;
  13829. }
  13830. inline bool ClientImpl::redirect(Request &req, Response &res, Error &error) {
  13831. if (req.redirect_count_ == 0) {
  13832. error = Error::ExceedRedirectCount;
  13833. return false;
  13834. }
  13835. auto location = res.get_header_value("location");
  13836. if (location.empty()) { return false; }
  13837. detail::UrlComponents uc;
  13838. if (!detail::parse_url(detail::resolve_relative_location(location, req.path),
  13839. uc)) {
  13840. return false;
  13841. }
  13842. // Only follow http/https redirects
  13843. if (!uc.scheme.empty() && uc.scheme != "http" && uc.scheme != "https") {
  13844. return false;
  13845. }
  13846. auto scheme = is_ssl() ? "https" : "http";
  13847. auto next_scheme = std::move(uc.scheme);
  13848. auto next_host = std::move(uc.host);
  13849. auto port_str = std::move(uc.port);
  13850. auto next_path = std::move(uc.path);
  13851. auto next_query = std::move(uc.query);
  13852. auto next_port = port_;
  13853. if (!port_str.empty()) {
  13854. if (!detail::parse_port(port_str, next_port)) { return false; }
  13855. } else if (!next_scheme.empty()) {
  13856. next_port = next_scheme == "https" ? 443 : 80;
  13857. }
  13858. if (next_scheme.empty()) { next_scheme = scheme; }
  13859. if (next_host.empty()) { next_host = host_; }
  13860. if (next_path.empty()) { next_path = "/"; }
  13861. auto path = std::move(next_path) + next_query;
  13862. // Same host redirect - use current client
  13863. if (next_scheme == scheme && next_host == host_ && next_port == port_) {
  13864. return detail::redirect(*this, req, res, path, location, error);
  13865. }
  13866. // Cross-host/scheme redirect - create new client with robust setup
  13867. return create_redirect_client(next_scheme, next_host, next_port, req, res,
  13868. path, location, error);
  13869. }
  13870. // New method for robust redirect client creation
  13871. inline bool ClientImpl::create_redirect_client(
  13872. const std::string &scheme, const std::string &host, int port, Request &req,
  13873. Response &res, const std::string &path, const std::string &location,
  13874. Error &error) {
  13875. // Determine if we need SSL
  13876. auto need_ssl = (scheme == "https");
  13877. // Clean up request headers that are host/client specific
  13878. // Remove headers that should not be carried over to new host
  13879. auto headers_to_remove = std::vector<std::string>{
  13880. "Host", "Proxy-Authorization", "Authorization", "Cookie", "Cookie2"};
  13881. for (const auto &header_name : headers_to_remove) {
  13882. auto it = req.headers.find(header_name);
  13883. while (it != req.headers.end()) {
  13884. it = req.headers.erase(it);
  13885. it = req.headers.find(header_name);
  13886. }
  13887. }
  13888. // Create appropriate client type and handle redirect
  13889. if (need_ssl) {
  13890. #ifdef CPPHTTPLIB_SSL_ENABLED
  13891. // Create SSL client for HTTPS redirect
  13892. SSLClient redirect_client(host, port);
  13893. // Setup basic client configuration first
  13894. setup_redirect_client(redirect_client);
  13895. redirect_client.enable_server_certificate_verification(
  13896. server_certificate_verification_);
  13897. redirect_client.enable_server_hostname_verification(
  13898. server_hostname_verification_);
  13899. redirect_client.system_ca_mode_ = system_ca_mode_;
  13900. // Transfer CA certificate to redirect client
  13901. redirect_client.set_ca_cert_path(ca_cert_file_path_, ca_cert_dir_path_);
  13902. if (is_ssl()) {
  13903. auto &self = static_cast<SSLClient &>(*this);
  13904. // A store given to set_ca_cert_store() lives only in this client's
  13905. // context, which then holds all that is trusted.
  13906. if (self.ca_cert_store_set_) {
  13907. std::string pem;
  13908. {
  13909. std::lock_guard<std::mutex> guard(self.ctx_mutex_);
  13910. pem = detail::ca_certs_to_pem(self.ctx_);
  13911. }
  13912. redirect_client.load_ca_cert_store(pem.data(), pem.size());
  13913. redirect_client.ca_cert_store_set_ = true;
  13914. } else if (self.custom_ca_loaded_) {
  13915. redirect_client.load_ca_cert_store(ca_cert_pem_.c_str(),
  13916. ca_cert_pem_.size());
  13917. }
  13918. redirect_client.set_session_verifier(self.session_verifier_);
  13919. if (self.server_certificate_verifier_) {
  13920. redirect_client.set_server_certificate_verifier(
  13921. self.server_certificate_verifier_);
  13922. }
  13923. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  13924. redirect_client.enable_windows_cert_verification_ =
  13925. self.enable_windows_cert_verification_;
  13926. #endif
  13927. }
  13928. // Client certificates are set through constructor for SSLClient
  13929. // NOTE: SSLClient constructor already takes client_cert_path and
  13930. // client_key_path so we need to create it properly if client certs are
  13931. // needed
  13932. // Execute the redirect
  13933. return detail::redirect(redirect_client, req, res, path, location, error);
  13934. #else
  13935. // SSL not supported - set appropriate error
  13936. error = Error::SSLConnection;
  13937. return false;
  13938. #endif
  13939. } else {
  13940. // HTTP redirect
  13941. ClientImpl redirect_client(host, port);
  13942. // Setup client with robust configuration
  13943. setup_redirect_client(redirect_client);
  13944. // Execute the redirect
  13945. return detail::redirect(redirect_client, req, res, path, location, error);
  13946. }
  13947. }
  13948. // New method for robust client setup (based on basic_manual_redirect.cpp
  13949. // logic)
  13950. template <typename ClientType>
  13951. inline void ClientImpl::setup_redirect_client(ClientType &client) {
  13952. // Copy basic settings first
  13953. client.set_connection_timeout(connection_timeout_sec_,
  13954. connection_timeout_usec_);
  13955. client.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  13956. client.set_write_timeout(write_timeout_sec_, write_timeout_usec_);
  13957. client.set_max_timeout(max_timeout_msec_);
  13958. if (has_payload_max_length_) {
  13959. client.set_payload_max_length(payload_max_length_);
  13960. }
  13961. client.set_keep_alive(keep_alive_);
  13962. client.set_follow_location(
  13963. true); // Enable redirects to handle multi-step redirects
  13964. client.set_path_encode(path_encode_);
  13965. client.set_compress(compress_);
  13966. client.set_decompress(decompress_);
  13967. // NOTE: Authentication credentials (basic auth, bearer token, digest auth)
  13968. // are intentionally NOT copied to the redirect client. Per RFC 9110 Section
  13969. // 15.4, credentials must not be forwarded when redirecting to a different
  13970. // host. This function is only called for cross-host redirects; same-host
  13971. // redirects are handled directly in ClientImpl::redirect().
  13972. // Copy the proxy configuration unconditionally; the per-target bypass is
  13973. // re-evaluated at send time, so a later hop to a non-bypassed host can
  13974. // still use the proxy.
  13975. client.no_proxy_entries_ = no_proxy_entries_;
  13976. if (!proxy_host_.empty() && proxy_port_ != -1) {
  13977. client.set_proxy(proxy_host_, proxy_port_);
  13978. if (!proxy_basic_auth_username_.empty() ||
  13979. !proxy_basic_auth_password_.empty()) {
  13980. client.set_proxy_basic_auth(proxy_basic_auth_username_,
  13981. proxy_basic_auth_password_);
  13982. }
  13983. if (!proxy_bearer_token_auth_token_.empty()) {
  13984. client.set_proxy_bearer_token_auth(proxy_bearer_token_auth_token_);
  13985. }
  13986. #ifdef CPPHTTPLIB_SSL_ENABLED
  13987. if (!proxy_digest_auth_username_.empty()) {
  13988. client.set_proxy_digest_auth(proxy_digest_auth_username_,
  13989. proxy_digest_auth_password_);
  13990. }
  13991. #endif
  13992. }
  13993. // Copy network and socket settings
  13994. client.addr_map_ = addr_map_;
  13995. client.set_address_family(address_family_);
  13996. client.set_tcp_nodelay(tcp_nodelay_);
  13997. client.set_ipv6_v6only(ipv6_v6only_);
  13998. if (socket_options_) { client.set_socket_options(socket_options_); }
  13999. if (!interface_.empty()) { client.set_interface(interface_); }
  14000. // Copy logging and headers. Not the error logger: a failure comes back to
  14001. // this client's send(), which reports it with the caller's request.
  14002. if (logger_) { client.set_logger(logger_); }
  14003. // NOTE: DO NOT copy default_headers_ as they may contain stale Host headers
  14004. // Each new client should generate its own headers based on its target host
  14005. }
  14006. inline bool ClientImpl::write_content_with_provider(Stream &strm,
  14007. const Request &req,
  14008. Error &error) const {
  14009. auto is_shutting_down = []() { return false; };
  14010. if (req.is_chunked_content_provider_) {
  14011. auto compressor = compress_ ? detail::create_compressor().first
  14012. : std::unique_ptr<detail::compressor>();
  14013. if (!compressor) {
  14014. compressor = detail::make_unique<detail::nocompressor>();
  14015. }
  14016. return detail::write_content_chunked(strm, req.content_provider_,
  14017. is_shutting_down, *compressor, error);
  14018. } else {
  14019. return detail::write_content_with_progress(
  14020. strm, req.content_provider_, 0, req.content_length_, is_shutting_down,
  14021. req.upload_progress, error);
  14022. }
  14023. }
  14024. // What goes on the request line for req: its path, encoded and without the
  14025. // fragment, with `req.params` as the query when the path has none.
  14026. inline std::string ClientImpl::make_request_target(const Request &req) const {
  14027. auto target = detail::encode_request_target(req.path, path_encode_);
  14028. if (detail::query_of(req.path).empty() && !req.params.empty()) {
  14029. target = append_query_params(target, req.params);
  14030. }
  14031. return target;
  14032. }
  14033. inline void ClientImpl::add_credential_headers(Request &req) {
  14034. // A CONNECT request is read by the proxy; everything sent through the tunnel
  14035. // it opens is read by the origin. Each credential goes only to its own hop.
  14036. auto is_connect = req.method == "CONNECT";
  14037. if (!is_connect) {
  14038. detail::add_authorization_header(req, basic_auth_username_,
  14039. basic_auth_password_,
  14040. bearer_token_auth_token_, false);
  14041. }
  14042. // Proxy-Authorization is only sent when the proxy reads this message —
  14043. // otherwise NO_PROXY-matched requests, and requests inside a TLS tunnel,
  14044. // would leak proxy credentials to the destination server.
  14045. if (is_proxy_enabled_for_host(host_) && (!is_ssl() || is_connect)) {
  14046. detail::add_authorization_header(req, proxy_basic_auth_username_,
  14047. proxy_basic_auth_password_,
  14048. proxy_bearer_token_auth_token_, true);
  14049. }
  14050. }
  14051. inline bool ClientImpl::write_request(Stream &strm, Request &req,
  14052. bool close_connection, Error &error,
  14053. bool skip_body, bool &rejected_locally) {
  14054. rejected_locally = false;
  14055. // Prepare additional headers
  14056. if (close_connection) {
  14057. if (!req.has_header("Connection")) {
  14058. req.set_header("Connection", "close");
  14059. }
  14060. }
  14061. std::string ct_for_defaults;
  14062. if (!req.has_header("Content-Type") && !req.body.empty()) {
  14063. ct_for_defaults = "text/plain";
  14064. }
  14065. prepare_default_headers(req, false, ct_for_defaults);
  14066. if (req.body.empty()) {
  14067. if (req.content_provider_) {
  14068. if (!req.is_chunked_content_provider_) {
  14069. if (!req.has_header("Content-Length")) {
  14070. auto length = std::to_string(req.content_length_);
  14071. req.set_header("Content-Length", length);
  14072. }
  14073. }
  14074. } else {
  14075. if (req.method == "POST" || req.method == "PUT" ||
  14076. req.method == "PATCH") {
  14077. req.set_header("Content-Length", "0");
  14078. }
  14079. }
  14080. }
  14081. add_credential_headers(req);
  14082. // Request line and headers
  14083. {
  14084. detail::BufferStream bstrm;
  14085. auto path_with_query = make_request_target(req);
  14086. // The query already came in through `req.path`; still populate
  14087. // `req.params` for handlers/users who read them.
  14088. auto query_part = detail::query_of(req.path);
  14089. if (!query_part.empty()) {
  14090. detail::parse_query_text(query_part, req.params);
  14091. }
  14092. // Write request line and headers
  14093. if (detail::write_request_line(bstrm, req.method, path_with_query) < 0) {
  14094. // A rejected method (not a token, e.g. carrying CR/LF) or target (e.g.
  14095. // CR/LF in a caller-supplied path under set_path_encode(false)) must
  14096. // fail the request cleanly instead of emitting a request-line-less,
  14097. // header-injecting request.
  14098. error = Error::Write;
  14099. rejected_locally = true;
  14100. return false;
  14101. }
  14102. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  14103. error)) {
  14104. rejected_locally = true;
  14105. return false;
  14106. }
  14107. // Flush buffer
  14108. auto &data = bstrm.get_buffer();
  14109. if (!detail::write_data(strm, data.data(), data.size())) {
  14110. error = Error::Write;
  14111. return false;
  14112. }
  14113. }
  14114. // After sending request line and headers, wait briefly for an early server
  14115. // response (e.g. 4xx) and avoid sending a potentially large request body
  14116. // unnecessarily. This workaround is only enabled on Windows because Unix
  14117. // platforms surface write errors (EPIPE) earlier; on Windows kernel send
  14118. // buffering can accept large writes even when the peer already responded.
  14119. // Check the stream first (which covers SSL via `is_readable()`), then
  14120. // fall back to select on the socket. Only perform the wait for very large
  14121. // request bodies to avoid interfering with normal small requests and
  14122. // reduce side-effects. Poll briefly (up to 50ms as default) for an early
  14123. // response. Skip this check when using Expect: 100-continue, as the protocol
  14124. // handles early responses properly.
  14125. #if defined(_WIN32)
  14126. if (!skip_body &&
  14127. req.body.size() > CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD &&
  14128. req.path.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  14129. auto start = std::chrono::high_resolution_clock::now();
  14130. for (;;) {
  14131. // Prefer socket-level readiness to avoid SSL_pending() false-positives
  14132. // from SSL internals. If the underlying socket is readable, assume an
  14133. // early response may be present.
  14134. auto sock = strm.socket();
  14135. if (sock != INVALID_SOCKET && detail::select_read(sock, 0, 0) > 0) {
  14136. return false;
  14137. }
  14138. // Fallback to stream-level check for non-socket streams or when the
  14139. // socket isn't reporting readable. Avoid using `is_readable()` for
  14140. // SSL, since `SSL_pending()` may report buffered records that do not
  14141. // indicate a complete application-level response yet.
  14142. if (!is_ssl() && strm.is_readable()) { return false; }
  14143. auto now = std::chrono::high_resolution_clock::now();
  14144. auto elapsed =
  14145. std::chrono::duration_cast<std::chrono::milliseconds>(now - start)
  14146. .count();
  14147. if (elapsed >= CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND) {
  14148. break;
  14149. }
  14150. std::this_thread::sleep_for(std::chrono::milliseconds(1));
  14151. }
  14152. }
  14153. #endif
  14154. // Body
  14155. if (skip_body) { return true; }
  14156. return write_request_body(strm, req, error);
  14157. }
  14158. inline bool ClientImpl::write_request_body(Stream &strm, Request &req,
  14159. Error &error) {
  14160. if (req.body.empty()) {
  14161. return write_content_with_provider(strm, req, error);
  14162. }
  14163. if (req.upload_progress) {
  14164. auto body_size = req.body.size();
  14165. size_t written = 0;
  14166. auto data = req.body.data();
  14167. while (written < body_size) {
  14168. size_t to_write = (std::min)(CPPHTTPLIB_SEND_BUFSIZ, body_size - written);
  14169. if (!detail::write_data(strm, data + written, to_write)) {
  14170. error = Error::Write;
  14171. return false;
  14172. }
  14173. written += to_write;
  14174. if (!req.upload_progress(written, body_size)) {
  14175. error = Error::Canceled;
  14176. return false;
  14177. }
  14178. }
  14179. } else {
  14180. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  14181. error = Error::Write;
  14182. return false;
  14183. }
  14184. }
  14185. return true;
  14186. }
  14187. inline std::unique_ptr<Response>
  14188. ClientImpl::send_with_content_provider_and_receiver(
  14189. Request &req, const char *body, size_t content_length,
  14190. ContentProvider content_provider,
  14191. ContentProviderWithoutLength content_provider_without_length,
  14192. const std::string &content_type, ContentReceiver content_receiver,
  14193. Error &error) {
  14194. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14195. auto enc = compress_
  14196. ? detail::create_compressor()
  14197. : std::pair<std::unique_ptr<detail::compressor>, const char *>(
  14198. nullptr, nullptr);
  14199. if (enc.second) { req.set_header("Content-Encoding", enc.second); }
  14200. if (enc.first && !content_provider_without_length) {
  14201. auto &compressor = enc.first;
  14202. if (content_provider) {
  14203. auto ok = true;
  14204. auto finished = false;
  14205. size_t offset = 0;
  14206. DataSink data_sink;
  14207. data_sink.write = [&](const char *data, size_t data_len) -> bool {
  14208. if (ok) {
  14209. auto last = offset + data_len == content_length;
  14210. auto ret = compressor->compress(
  14211. data, data_len, last,
  14212. [&](const char *compressed_data, size_t compressed_data_len) {
  14213. req.body.append(compressed_data, compressed_data_len);
  14214. return true;
  14215. });
  14216. if (ret) {
  14217. offset += data_len;
  14218. } else {
  14219. ok = false;
  14220. }
  14221. }
  14222. return ok;
  14223. };
  14224. // As in detail::write_content_with_progress(): the body is framed by
  14225. // content_length, so a provider that finishes early has truncated it.
  14226. // Stop and report that instead of calling the provider forever.
  14227. data_sink.done = [&]() { finished = true; };
  14228. while (ok && !finished && offset < content_length) {
  14229. if (!content_provider(offset, content_length - offset, data_sink)) {
  14230. error = Error::Canceled;
  14231. output_error_log(error, &req);
  14232. return nullptr;
  14233. }
  14234. }
  14235. // A short body here means either the provider stopped early or the
  14236. // compressor gave up. The branch below reports a failing compressor as
  14237. // Error::Compression, so keep the two distinguishable.
  14238. if (offset < content_length) {
  14239. error = ok ? Error::Write : Error::Compression;
  14240. output_error_log(error, &req);
  14241. return nullptr;
  14242. }
  14243. } else {
  14244. if (!compressor->compress(body, content_length, true,
  14245. [&](const char *data, size_t data_len) {
  14246. req.body.append(data, data_len);
  14247. return true;
  14248. })) {
  14249. error = Error::Compression;
  14250. output_error_log(error, &req);
  14251. return nullptr;
  14252. }
  14253. }
  14254. } else {
  14255. if (content_provider) {
  14256. req.content_length_ = content_length;
  14257. req.content_provider_ = std::move(content_provider);
  14258. req.is_chunked_content_provider_ = false;
  14259. } else if (content_provider_without_length) {
  14260. req.content_length_ = 0;
  14261. req.content_provider_ = detail::ContentProviderAdapter(
  14262. std::move(content_provider_without_length));
  14263. req.is_chunked_content_provider_ = true;
  14264. req.set_header("Transfer-Encoding", "chunked");
  14265. } else {
  14266. req.body.assign(body, content_length);
  14267. }
  14268. }
  14269. if (content_receiver) {
  14270. req.content_receiver =
  14271. [content_receiver](const char *data, size_t data_length,
  14272. size_t /*offset*/, size_t /*total_length*/) {
  14273. return content_receiver(data, data_length);
  14274. };
  14275. }
  14276. auto res = detail::make_unique<Response>();
  14277. return send(req, *res, error) ? std::move(res) : nullptr;
  14278. }
  14279. inline Result ClientImpl::send_with_content_provider_and_receiver(
  14280. const std::string &method, const std::string &path, const Headers &headers,
  14281. const char *body, size_t content_length, ContentProvider content_provider,
  14282. ContentProviderWithoutLength content_provider_without_length,
  14283. const std::string &content_type, ContentReceiver content_receiver,
  14284. UploadProgress progress) {
  14285. Request req;
  14286. req.method = method;
  14287. req.headers = headers;
  14288. req.path = path;
  14289. req.upload_progress = std::move(progress);
  14290. if (max_timeout_msec_ > 0) {
  14291. req.start_time_ = std::chrono::steady_clock::now();
  14292. }
  14293. auto error = Error::Success;
  14294. #ifdef CPPHTTPLIB_SSL_ENABLED
  14295. // Hold the request lock until the Result has read this request's TLS error
  14296. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  14297. #endif
  14298. auto res = send_with_content_provider_and_receiver(
  14299. req, body, content_length, std::move(content_provider),
  14300. std::move(content_provider_without_length), content_type,
  14301. std::move(content_receiver), error);
  14302. #ifdef CPPHTTPLIB_SSL_ENABLED
  14303. return Result{std::move(res), error, std::move(req.headers), last_ssl_error_,
  14304. last_backend_error_};
  14305. #else
  14306. return Result{std::move(res), error, std::move(req.headers)};
  14307. #endif
  14308. }
  14309. inline void ClientImpl::output_log(const Request &req,
  14310. const Response &res) const {
  14311. if (logger_) {
  14312. std::lock_guard<std::mutex> guard(logger_mutex_);
  14313. logger_(req, res);
  14314. }
  14315. }
  14316. inline void ClientImpl::output_error_log(const Error &err,
  14317. const Request *req) const {
  14318. if (error_logger_) {
  14319. std::lock_guard<std::mutex> guard(logger_mutex_);
  14320. error_logger_(err, req);
  14321. }
  14322. }
  14323. inline bool ClientImpl::process_request(Stream &strm, Request &req,
  14324. Response &res, bool close_connection,
  14325. Error &error) {
  14326. // Auto-add Expect: 100-continue for large bodies
  14327. if (CPPHTTPLIB_EXPECT_100_THRESHOLD > 0 && !req.has_header("Expect")) {
  14328. auto body_size = req.body.empty() ? req.content_length_ : req.body.size();
  14329. if (body_size >= CPPHTTPLIB_EXPECT_100_THRESHOLD) {
  14330. req.set_header("Expect", "100-continue");
  14331. }
  14332. }
  14333. // Check for Expect: 100-continue
  14334. auto expect_100_continue =
  14335. detail::has_header_token(req.headers, "Expect", "100-continue");
  14336. // Send request (skip body if using Expect: 100-continue)
  14337. auto rejected_locally = false;
  14338. auto write_request_success =
  14339. write_request(strm, req, close_connection, error, expect_100_continue,
  14340. rejected_locally);
  14341. // A failed write normally still reads the response below, since the server
  14342. // may have answered early (e.g. 413/414) and closed while the body was being
  14343. // sent. A request rejected before any byte reached the socket gets no such
  14344. // response, and waiting for one would block until the read timeout.
  14345. if (rejected_locally) { return false; }
  14346. #ifdef CPPHTTPLIB_SSL_ENABLED
  14347. if (is_ssl() && !expect_100_continue) {
  14348. auto is_proxy_enabled = is_proxy_enabled_for_host(host_);
  14349. if (!is_proxy_enabled) {
  14350. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  14351. error = Error::SSLPeerCouldBeClosed_;
  14352. return false;
  14353. }
  14354. }
  14355. }
  14356. #endif
  14357. // Handle Expect: 100-continue.
  14358. //
  14359. // Wait for an interim/early response by attempting to read the status line
  14360. // under a short timeout, instead of trusting raw socket readability. Over
  14361. // TLS, post-handshake records (e.g. session tickets) make the socket
  14362. // readable without any HTTP response being available; relying on
  14363. // `select_read` there caused the body to be withheld forever and the
  14364. // request to fail with `Read` (#2458). If no status line arrives within the
  14365. // timeout, send the body anyway (matching curl's behavior).
  14366. auto status_line_read = false;
  14367. if (expect_100_continue && write_request_success) {
  14368. if (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND > 0) {
  14369. time_t sec = CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND / 1000;
  14370. time_t usec = (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND % 1000) * 1000;
  14371. strm.set_read_timeout(sec, usec);
  14372. status_line_read = read_response_line(strm, req, res, false);
  14373. strm.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  14374. }
  14375. if (!status_line_read) {
  14376. // No interim response within the timeout: send the body and handle the
  14377. // response as usual.
  14378. if (!write_request_body(strm, req, error)) { return false; }
  14379. expect_100_continue = false; // Switch to normal response handling
  14380. }
  14381. }
  14382. // Receive response and headers
  14383. // When using Expect: 100-continue, don't auto-skip `100 Continue` response
  14384. if ((!status_line_read &&
  14385. !read_response_line(strm, req, res, !expect_100_continue)) ||
  14386. !detail::read_headers(strm, res.headers)) {
  14387. if (write_request_success) { error = Error::Read; }
  14388. return false;
  14389. }
  14390. if (!write_request_success) { return false; }
  14391. // Handle Expect: 100-continue response
  14392. if (expect_100_continue) {
  14393. if (res.status == StatusCode::Continue_100) {
  14394. // Server accepted, send the body
  14395. if (!write_request_body(strm, req, error)) { return false; }
  14396. // Read the actual response
  14397. res.headers.clear();
  14398. res.body.clear();
  14399. if (!read_response_line(strm, req, res) ||
  14400. !detail::read_headers(strm, res.headers)) {
  14401. error = Error::Read;
  14402. return false;
  14403. }
  14404. } else {
  14405. // A final response came first, so the body this request declared was
  14406. // never sent, and the server may still be waiting for it. The
  14407. // connection cannot carry another request.
  14408. std::lock_guard<std::mutex> guard(socket_mutex_);
  14409. socket_should_be_closed_when_request_is_done_ = true;
  14410. }
  14411. }
  14412. // Body
  14413. if ((res.status != StatusCode::NoContent_204) && req.method != "HEAD" &&
  14414. req.method != "CONNECT") {
  14415. // Reject ambiguous framing (RFC 9112 §6.3). Unlike a request, a response
  14416. // whose final transfer coding is not chunked is not ambiguous: its body
  14417. // runs until the server closes the connection, so it is not rejected.
  14418. // HEAD/204 are excluded above and a 304 carries no body.
  14419. if (res.status != StatusCode::NotModified_304) {
  14420. if (detail::has_conflicting_content_length(res.headers)) {
  14421. error = Error::Read;
  14422. return false;
  14423. }
  14424. if (detail::has_faulty_transfer_encoding(res)) {
  14425. std::lock_guard<std::mutex> guard(socket_mutex_);
  14426. socket_should_be_closed_when_request_is_done_ = true;
  14427. }
  14428. }
  14429. auto redirect = follow_location_ && detail::is_redirect(res) &&
  14430. res.status != StatusCode::NotModified_304;
  14431. if (req.response_handler && !redirect) {
  14432. if (!req.response_handler(res)) {
  14433. error = Error::Canceled;
  14434. return false;
  14435. }
  14436. }
  14437. auto out =
  14438. req.content_receiver
  14439. ? static_cast<ContentReceiverWithProgress>(
  14440. [&](const char *buf, size_t n, size_t off, size_t len) {
  14441. if (redirect) { return true; }
  14442. auto ret = req.content_receiver(buf, n, off, len);
  14443. if (!ret) { error = Error::Canceled; }
  14444. return ret;
  14445. })
  14446. : static_cast<ContentReceiverWithProgress>(
  14447. [&](const char *buf, size_t n, size_t /*off*/,
  14448. size_t /*len*/) {
  14449. assert(res.body.size() + n <= res.body.max_size());
  14450. if (payload_max_length_ > 0 &&
  14451. (res.body.size() >= payload_max_length_ ||
  14452. n > payload_max_length_ - res.body.size())) {
  14453. return false;
  14454. }
  14455. res.body.append(buf, n);
  14456. return true;
  14457. });
  14458. auto progress = [&](size_t current, size_t total) {
  14459. if (!req.download_progress || redirect) { return true; }
  14460. auto ret = req.download_progress(current, total);
  14461. if (!ret) { error = Error::Canceled; }
  14462. return ret;
  14463. };
  14464. if (res.has_header("Content-Length")) {
  14465. if (!req.content_receiver) {
  14466. auto len = res.get_header_value_u64("Content-Length");
  14467. if (len > res.body.max_size()) {
  14468. error = Error::Read;
  14469. return false;
  14470. }
  14471. // Content-Length is only the server's claim, so reserve no more than
  14472. // payload_max_length_ allows, nor more than 1 MiB before any of the
  14473. // body has arrived. A longer body grows as it is read.
  14474. auto reserve_len =
  14475. (std::min)(static_cast<size_t>(len), size_t(1024 * 1024));
  14476. if (payload_max_length_ > 0) {
  14477. reserve_len = (std::min)(reserve_len, payload_max_length_);
  14478. }
  14479. res.body.reserve(reserve_len);
  14480. }
  14481. }
  14482. if (res.status != StatusCode::NotModified_304) {
  14483. auto content_status = 0;
  14484. auto max_length = (!has_payload_max_length_ && req.content_receiver)
  14485. ? (std::numeric_limits<size_t>::max)()
  14486. : payload_max_length_;
  14487. if (!detail::read_content(strm, res, max_length, content_status,
  14488. std::move(progress), std::move(out),
  14489. decompress_)) {
  14490. if (error != Error::Canceled) {
  14491. // Tell the caller apart from a plain read failure when the body was
  14492. // over the payload limit or could not be decoded because of its
  14493. // Content-Encoding.
  14494. switch (content_status) {
  14495. case StatusCode::PayloadTooLarge_413:
  14496. error = Error::ExceedMaxPayloadSize;
  14497. break;
  14498. case StatusCode::UnsupportedMediaType_415:
  14499. error = Error::UnsupportedContentEncoding;
  14500. break;
  14501. case StatusCode::InternalServerError_500:
  14502. error = Error::Compression;
  14503. break;
  14504. default: error = Error::Read; break;
  14505. }
  14506. }
  14507. return false;
  14508. }
  14509. }
  14510. }
  14511. // Log
  14512. output_log(req, res);
  14513. return true;
  14514. }
  14515. inline ContentProviderWithoutLength ClientImpl::get_multipart_content_provider(
  14516. const std::string &boundary, const UploadFormDataItems &items,
  14517. const FormDataProviderItems &provider_items) const {
  14518. size_t cur_item = 0;
  14519. size_t cur_start = 0;
  14520. // cur_item and cur_start are copied to within the std::function and
  14521. // maintain state between successive calls
  14522. return [&, cur_item, cur_start](size_t offset,
  14523. DataSink &sink) mutable -> bool {
  14524. if (!offset && !items.empty()) {
  14525. sink.os << detail::serialize_multipart_formdata(items, boundary, false);
  14526. return true;
  14527. } else if (cur_item < provider_items.size()) {
  14528. if (!cur_start) {
  14529. const auto &begin = detail::serialize_multipart_formdata_item_begin(
  14530. provider_items[cur_item], boundary);
  14531. offset += begin.size();
  14532. cur_start = offset;
  14533. sink.os << begin;
  14534. }
  14535. DataSink cur_sink;
  14536. auto has_data = true;
  14537. cur_sink.write = sink.write;
  14538. // Forward is_writable so a provider item asking whether it may keep
  14539. // going gets the outer sink's answer rather than the default `true`.
  14540. cur_sink.is_writable = sink.is_writable;
  14541. cur_sink.done = [&]() { has_data = false; };
  14542. if (!provider_items[cur_item].provider(offset - cur_start, cur_sink)) {
  14543. return false;
  14544. }
  14545. if (!has_data) {
  14546. sink.os << detail::serialize_multipart_formdata_item_end();
  14547. cur_item++;
  14548. cur_start = 0;
  14549. }
  14550. return true;
  14551. } else {
  14552. sink.os << detail::serialize_multipart_formdata_finish(boundary);
  14553. sink.done();
  14554. return true;
  14555. }
  14556. };
  14557. }
  14558. inline bool ClientImpl::process_socket(
  14559. const Socket &socket,
  14560. std::chrono::time_point<std::chrono::steady_clock> start_time,
  14561. std::function<bool(Stream &strm)> callback) {
  14562. return detail::process_client_socket(
  14563. socket.sock, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  14564. write_timeout_usec_, max_timeout_msec_, start_time, std::move(callback));
  14565. }
  14566. inline bool ClientImpl::is_ssl() const { return false; }
  14567. inline Result ClientImpl::Get(const std::string &path,
  14568. DownloadProgress progress) {
  14569. return Get(path, Headers(), std::move(progress));
  14570. }
  14571. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14572. DownloadProgress progress) {
  14573. return Get(path, params, Headers(), std::move(progress));
  14574. }
  14575. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14576. const Headers &headers,
  14577. DownloadProgress progress) {
  14578. if (params.empty()) { return Get(path, headers); }
  14579. std::string path_with_query = append_query_params(path, params);
  14580. return Get(path_with_query, headers, std::move(progress));
  14581. }
  14582. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14583. DownloadProgress progress) {
  14584. Request req;
  14585. req.method = "GET";
  14586. req.path = path;
  14587. req.headers = headers;
  14588. req.download_progress = std::move(progress);
  14589. if (max_timeout_msec_ > 0) {
  14590. req.start_time_ = std::chrono::steady_clock::now();
  14591. }
  14592. return send_(std::move(req));
  14593. }
  14594. inline Result ClientImpl::Get(const std::string &path,
  14595. ContentReceiver content_receiver,
  14596. DownloadProgress progress) {
  14597. return Get(path, Headers(), nullptr, std::move(content_receiver),
  14598. std::move(progress));
  14599. }
  14600. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14601. ContentReceiver content_receiver,
  14602. DownloadProgress progress) {
  14603. return Get(path, headers, nullptr, std::move(content_receiver),
  14604. std::move(progress));
  14605. }
  14606. inline Result ClientImpl::Get(const std::string &path,
  14607. ResponseHandler response_handler,
  14608. ContentReceiver content_receiver,
  14609. DownloadProgress progress) {
  14610. return Get(path, Headers(), std::move(response_handler),
  14611. std::move(content_receiver), std::move(progress));
  14612. }
  14613. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14614. ResponseHandler response_handler,
  14615. ContentReceiver content_receiver,
  14616. DownloadProgress progress) {
  14617. Request req;
  14618. req.method = "GET";
  14619. req.path = path;
  14620. req.headers = headers;
  14621. req.response_handler = std::move(response_handler);
  14622. req.content_receiver =
  14623. [content_receiver](const char *data, size_t data_length,
  14624. size_t /*offset*/, size_t /*total_length*/) {
  14625. return content_receiver(data, data_length);
  14626. };
  14627. req.download_progress = std::move(progress);
  14628. if (max_timeout_msec_ > 0) {
  14629. req.start_time_ = std::chrono::steady_clock::now();
  14630. }
  14631. return send_(std::move(req));
  14632. }
  14633. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14634. const Headers &headers,
  14635. ContentReceiver content_receiver,
  14636. DownloadProgress progress) {
  14637. return Get(path, params, headers, nullptr, std::move(content_receiver),
  14638. std::move(progress));
  14639. }
  14640. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14641. const Headers &headers,
  14642. ResponseHandler response_handler,
  14643. ContentReceiver content_receiver,
  14644. DownloadProgress progress) {
  14645. if (params.empty()) {
  14646. return Get(path, headers, std::move(response_handler),
  14647. std::move(content_receiver), std::move(progress));
  14648. }
  14649. std::string path_with_query = append_query_params(path, params);
  14650. return Get(path_with_query, headers, std::move(response_handler),
  14651. std::move(content_receiver), std::move(progress));
  14652. }
  14653. inline Result ClientImpl::Head(const std::string &path) {
  14654. return Head(path, Headers());
  14655. }
  14656. inline Result ClientImpl::Head(const std::string &path,
  14657. const Headers &headers) {
  14658. Request req;
  14659. req.method = "HEAD";
  14660. req.headers = headers;
  14661. req.path = path;
  14662. if (max_timeout_msec_ > 0) {
  14663. req.start_time_ = std::chrono::steady_clock::now();
  14664. }
  14665. return send_(std::move(req));
  14666. }
  14667. inline Result ClientImpl::Post(const std::string &path) {
  14668. return Post(path, std::string(), std::string());
  14669. }
  14670. inline Result ClientImpl::Post(const std::string &path,
  14671. const Headers &headers) {
  14672. return Post(path, headers, nullptr, 0, std::string());
  14673. }
  14674. inline Result ClientImpl::Post(const std::string &path, const char *body,
  14675. size_t content_length,
  14676. const std::string &content_type,
  14677. UploadProgress progress) {
  14678. return Post(path, Headers(), body, content_length, content_type, progress);
  14679. }
  14680. inline Result ClientImpl::Post(const std::string &path, const std::string &body,
  14681. const std::string &content_type,
  14682. UploadProgress progress) {
  14683. return Post(path, Headers(), body, content_type, progress);
  14684. }
  14685. inline Result ClientImpl::Post(const std::string &path, const Params &params) {
  14686. return Post(path, Headers(), params);
  14687. }
  14688. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14689. ContentProvider content_provider,
  14690. const std::string &content_type,
  14691. UploadProgress progress) {
  14692. return Post(path, Headers(), content_length, std::move(content_provider),
  14693. content_type, progress);
  14694. }
  14695. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14696. ContentProvider content_provider,
  14697. const std::string &content_type,
  14698. ContentReceiver content_receiver,
  14699. UploadProgress progress) {
  14700. return Post(path, Headers(), content_length, std::move(content_provider),
  14701. content_type, std::move(content_receiver), progress);
  14702. }
  14703. inline Result ClientImpl::Post(const std::string &path,
  14704. ContentProviderWithoutLength content_provider,
  14705. const std::string &content_type,
  14706. UploadProgress progress) {
  14707. return Post(path, Headers(), std::move(content_provider), content_type,
  14708. progress);
  14709. }
  14710. inline Result ClientImpl::Post(const std::string &path,
  14711. ContentProviderWithoutLength content_provider,
  14712. const std::string &content_type,
  14713. ContentReceiver content_receiver,
  14714. UploadProgress progress) {
  14715. return Post(path, Headers(), std::move(content_provider), content_type,
  14716. std::move(content_receiver), progress);
  14717. }
  14718. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14719. const Params &params) {
  14720. auto query = detail::params_to_query_str(params);
  14721. return Post(path, headers, query, "application/x-www-form-urlencoded");
  14722. }
  14723. inline Result ClientImpl::Post(const std::string &path,
  14724. const UploadFormDataItems &items,
  14725. UploadProgress progress) {
  14726. return Post(path, Headers(), items, progress);
  14727. }
  14728. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14729. const UploadFormDataItems &items,
  14730. UploadProgress progress) {
  14731. const auto &boundary = detail::make_multipart_data_boundary();
  14732. const auto &content_type =
  14733. detail::serialize_multipart_formdata_get_content_type(boundary);
  14734. auto content_length = detail::get_multipart_content_length(items, boundary);
  14735. return Post(path, headers, content_length,
  14736. detail::make_multipart_content_provider(items, boundary),
  14737. content_type, progress);
  14738. }
  14739. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14740. const UploadFormDataItems &items,
  14741. const std::string &boundary,
  14742. UploadProgress progress) {
  14743. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14744. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14745. }
  14746. const auto &content_type =
  14747. detail::serialize_multipart_formdata_get_content_type(boundary);
  14748. auto content_length = detail::get_multipart_content_length(items, boundary);
  14749. return Post(path, headers, content_length,
  14750. detail::make_multipart_content_provider(items, boundary),
  14751. content_type, progress);
  14752. }
  14753. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14754. const char *body, size_t content_length,
  14755. const std::string &content_type,
  14756. UploadProgress progress) {
  14757. return send_with_content_provider_and_receiver(
  14758. "POST", path, headers, body, content_length, nullptr, nullptr,
  14759. content_type, nullptr, progress);
  14760. }
  14761. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14762. const std::string &body,
  14763. const std::string &content_type,
  14764. UploadProgress progress) {
  14765. return send_with_content_provider_and_receiver(
  14766. "POST", path, headers, body.data(), body.size(), nullptr, nullptr,
  14767. content_type, nullptr, progress);
  14768. }
  14769. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14770. size_t content_length,
  14771. ContentProvider content_provider,
  14772. const std::string &content_type,
  14773. UploadProgress progress) {
  14774. return send_with_content_provider_and_receiver(
  14775. "POST", path, headers, nullptr, content_length,
  14776. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14777. }
  14778. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14779. size_t content_length,
  14780. ContentProvider content_provider,
  14781. const std::string &content_type,
  14782. ContentReceiver content_receiver,
  14783. DownloadProgress progress) {
  14784. return send_with_content_provider_and_receiver(
  14785. "POST", path, headers, nullptr, content_length,
  14786. std::move(content_provider), nullptr, content_type,
  14787. std::move(content_receiver), std::move(progress));
  14788. }
  14789. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14790. ContentProviderWithoutLength content_provider,
  14791. const std::string &content_type,
  14792. UploadProgress progress) {
  14793. return send_with_content_provider_and_receiver(
  14794. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14795. content_type, nullptr, progress);
  14796. }
  14797. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14798. ContentProviderWithoutLength content_provider,
  14799. const std::string &content_type,
  14800. ContentReceiver content_receiver,
  14801. DownloadProgress progress) {
  14802. return send_with_content_provider_and_receiver(
  14803. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14804. content_type, std::move(content_receiver), std::move(progress));
  14805. }
  14806. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14807. const UploadFormDataItems &items,
  14808. const FormDataProviderItems &provider_items,
  14809. UploadProgress progress) {
  14810. const auto &boundary = detail::make_multipart_data_boundary();
  14811. const auto &content_type =
  14812. detail::serialize_multipart_formdata_get_content_type(boundary);
  14813. return send_with_content_provider_and_receiver(
  14814. "POST", path, headers, nullptr, 0, nullptr,
  14815. get_multipart_content_provider(boundary, items, provider_items),
  14816. content_type, nullptr, progress);
  14817. }
  14818. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14819. const std::string &body,
  14820. const std::string &content_type,
  14821. ContentReceiver content_receiver,
  14822. DownloadProgress progress) {
  14823. Request req;
  14824. req.method = "POST";
  14825. req.path = path;
  14826. req.headers = headers;
  14827. req.body = body;
  14828. req.content_receiver =
  14829. [content_receiver](const char *data, size_t data_length,
  14830. size_t /*offset*/, size_t /*total_length*/) {
  14831. return content_receiver(data, data_length);
  14832. };
  14833. req.download_progress = std::move(progress);
  14834. if (max_timeout_msec_ > 0) {
  14835. req.start_time_ = std::chrono::steady_clock::now();
  14836. }
  14837. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14838. return send_(std::move(req));
  14839. }
  14840. inline Result ClientImpl::Put(const std::string &path) {
  14841. return Put(path, std::string(), std::string());
  14842. }
  14843. inline Result ClientImpl::Put(const std::string &path, const Headers &headers) {
  14844. return Put(path, headers, nullptr, 0, std::string());
  14845. }
  14846. inline Result ClientImpl::Put(const std::string &path, const char *body,
  14847. size_t content_length,
  14848. const std::string &content_type,
  14849. UploadProgress progress) {
  14850. return Put(path, Headers(), body, content_length, content_type, progress);
  14851. }
  14852. inline Result ClientImpl::Put(const std::string &path, const std::string &body,
  14853. const std::string &content_type,
  14854. UploadProgress progress) {
  14855. return Put(path, Headers(), body, content_type, progress);
  14856. }
  14857. inline Result ClientImpl::Put(const std::string &path, const Params &params) {
  14858. return Put(path, Headers(), params);
  14859. }
  14860. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14861. ContentProvider content_provider,
  14862. const std::string &content_type,
  14863. UploadProgress progress) {
  14864. return Put(path, Headers(), content_length, std::move(content_provider),
  14865. content_type, progress);
  14866. }
  14867. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14868. ContentProvider content_provider,
  14869. const std::string &content_type,
  14870. ContentReceiver content_receiver,
  14871. UploadProgress progress) {
  14872. return Put(path, Headers(), content_length, std::move(content_provider),
  14873. content_type, std::move(content_receiver), progress);
  14874. }
  14875. inline Result ClientImpl::Put(const std::string &path,
  14876. ContentProviderWithoutLength content_provider,
  14877. const std::string &content_type,
  14878. UploadProgress progress) {
  14879. return Put(path, Headers(), std::move(content_provider), content_type,
  14880. progress);
  14881. }
  14882. inline Result ClientImpl::Put(const std::string &path,
  14883. ContentProviderWithoutLength content_provider,
  14884. const std::string &content_type,
  14885. ContentReceiver content_receiver,
  14886. UploadProgress progress) {
  14887. return Put(path, Headers(), std::move(content_provider), content_type,
  14888. std::move(content_receiver), progress);
  14889. }
  14890. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14891. const Params &params) {
  14892. auto query = detail::params_to_query_str(params);
  14893. return Put(path, headers, query, "application/x-www-form-urlencoded");
  14894. }
  14895. inline Result ClientImpl::Put(const std::string &path,
  14896. const UploadFormDataItems &items,
  14897. UploadProgress progress) {
  14898. return Put(path, Headers(), items, progress);
  14899. }
  14900. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14901. const UploadFormDataItems &items,
  14902. UploadProgress progress) {
  14903. const auto &boundary = detail::make_multipart_data_boundary();
  14904. const auto &content_type =
  14905. detail::serialize_multipart_formdata_get_content_type(boundary);
  14906. auto content_length = detail::get_multipart_content_length(items, boundary);
  14907. return Put(path, headers, content_length,
  14908. detail::make_multipart_content_provider(items, boundary),
  14909. content_type, progress);
  14910. }
  14911. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14912. const UploadFormDataItems &items,
  14913. const std::string &boundary,
  14914. UploadProgress progress) {
  14915. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14916. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14917. }
  14918. const auto &content_type =
  14919. detail::serialize_multipart_formdata_get_content_type(boundary);
  14920. auto content_length = detail::get_multipart_content_length(items, boundary);
  14921. return Put(path, headers, content_length,
  14922. detail::make_multipart_content_provider(items, boundary),
  14923. content_type, progress);
  14924. }
  14925. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14926. const char *body, size_t content_length,
  14927. const std::string &content_type,
  14928. UploadProgress progress) {
  14929. return send_with_content_provider_and_receiver(
  14930. "PUT", path, headers, body, content_length, nullptr, nullptr,
  14931. content_type, nullptr, progress);
  14932. }
  14933. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14934. const std::string &body,
  14935. const std::string &content_type,
  14936. UploadProgress progress) {
  14937. return send_with_content_provider_and_receiver(
  14938. "PUT", path, headers, body.data(), body.size(), nullptr, nullptr,
  14939. content_type, nullptr, progress);
  14940. }
  14941. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14942. size_t content_length,
  14943. ContentProvider content_provider,
  14944. const std::string &content_type,
  14945. UploadProgress progress) {
  14946. return send_with_content_provider_and_receiver(
  14947. "PUT", path, headers, nullptr, content_length,
  14948. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14949. }
  14950. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14951. size_t content_length,
  14952. ContentProvider content_provider,
  14953. const std::string &content_type,
  14954. ContentReceiver content_receiver,
  14955. UploadProgress progress) {
  14956. return send_with_content_provider_and_receiver(
  14957. "PUT", path, headers, nullptr, content_length,
  14958. std::move(content_provider), nullptr, content_type,
  14959. std::move(content_receiver), progress);
  14960. }
  14961. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14962. ContentProviderWithoutLength content_provider,
  14963. const std::string &content_type,
  14964. UploadProgress progress) {
  14965. return send_with_content_provider_and_receiver(
  14966. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14967. content_type, nullptr, progress);
  14968. }
  14969. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14970. ContentProviderWithoutLength content_provider,
  14971. const std::string &content_type,
  14972. ContentReceiver content_receiver,
  14973. UploadProgress progress) {
  14974. return send_with_content_provider_and_receiver(
  14975. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14976. content_type, std::move(content_receiver), progress);
  14977. }
  14978. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14979. const UploadFormDataItems &items,
  14980. const FormDataProviderItems &provider_items,
  14981. UploadProgress progress) {
  14982. const auto &boundary = detail::make_multipart_data_boundary();
  14983. const auto &content_type =
  14984. detail::serialize_multipart_formdata_get_content_type(boundary);
  14985. return send_with_content_provider_and_receiver(
  14986. "PUT", path, headers, nullptr, 0, nullptr,
  14987. get_multipart_content_provider(boundary, items, provider_items),
  14988. content_type, nullptr, progress);
  14989. }
  14990. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14991. const std::string &body,
  14992. const std::string &content_type,
  14993. ContentReceiver content_receiver,
  14994. DownloadProgress progress) {
  14995. Request req;
  14996. req.method = "PUT";
  14997. req.path = path;
  14998. req.headers = headers;
  14999. req.body = body;
  15000. req.content_receiver =
  15001. [content_receiver](const char *data, size_t data_length,
  15002. size_t /*offset*/, size_t /*total_length*/) {
  15003. return content_receiver(data, data_length);
  15004. };
  15005. req.download_progress = std::move(progress);
  15006. if (max_timeout_msec_ > 0) {
  15007. req.start_time_ = std::chrono::steady_clock::now();
  15008. }
  15009. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15010. return send_(std::move(req));
  15011. }
  15012. inline Result ClientImpl::Patch(const std::string &path) {
  15013. return Patch(path, std::string(), std::string());
  15014. }
  15015. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15016. UploadProgress progress) {
  15017. return Patch(path, headers, nullptr, 0, std::string(), progress);
  15018. }
  15019. inline Result ClientImpl::Patch(const std::string &path, const char *body,
  15020. size_t content_length,
  15021. const std::string &content_type,
  15022. UploadProgress progress) {
  15023. return Patch(path, Headers(), body, content_length, content_type, progress);
  15024. }
  15025. inline Result ClientImpl::Patch(const std::string &path,
  15026. const std::string &body,
  15027. const std::string &content_type,
  15028. UploadProgress progress) {
  15029. return Patch(path, Headers(), body, content_type, progress);
  15030. }
  15031. inline Result ClientImpl::Patch(const std::string &path, const Params &params) {
  15032. return Patch(path, Headers(), params);
  15033. }
  15034. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  15035. ContentProvider content_provider,
  15036. const std::string &content_type,
  15037. UploadProgress progress) {
  15038. return Patch(path, Headers(), content_length, std::move(content_provider),
  15039. content_type, progress);
  15040. }
  15041. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  15042. ContentProvider content_provider,
  15043. const std::string &content_type,
  15044. ContentReceiver content_receiver,
  15045. UploadProgress progress) {
  15046. return Patch(path, Headers(), content_length, std::move(content_provider),
  15047. content_type, std::move(content_receiver), progress);
  15048. }
  15049. inline Result ClientImpl::Patch(const std::string &path,
  15050. ContentProviderWithoutLength content_provider,
  15051. const std::string &content_type,
  15052. UploadProgress progress) {
  15053. return Patch(path, Headers(), std::move(content_provider), content_type,
  15054. progress);
  15055. }
  15056. inline Result ClientImpl::Patch(const std::string &path,
  15057. ContentProviderWithoutLength content_provider,
  15058. const std::string &content_type,
  15059. ContentReceiver content_receiver,
  15060. UploadProgress progress) {
  15061. return Patch(path, Headers(), std::move(content_provider), content_type,
  15062. std::move(content_receiver), progress);
  15063. }
  15064. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15065. const Params &params) {
  15066. auto query = detail::params_to_query_str(params);
  15067. return Patch(path, headers, query, "application/x-www-form-urlencoded");
  15068. }
  15069. inline Result ClientImpl::Patch(const std::string &path,
  15070. const UploadFormDataItems &items,
  15071. UploadProgress progress) {
  15072. return Patch(path, Headers(), items, progress);
  15073. }
  15074. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15075. const UploadFormDataItems &items,
  15076. UploadProgress progress) {
  15077. const auto &boundary = detail::make_multipart_data_boundary();
  15078. const auto &content_type =
  15079. detail::serialize_multipart_formdata_get_content_type(boundary);
  15080. auto content_length = detail::get_multipart_content_length(items, boundary);
  15081. return Patch(path, headers, content_length,
  15082. detail::make_multipart_content_provider(items, boundary),
  15083. content_type, progress);
  15084. }
  15085. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15086. const UploadFormDataItems &items,
  15087. const std::string &boundary,
  15088. UploadProgress progress) {
  15089. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  15090. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  15091. }
  15092. const auto &content_type =
  15093. detail::serialize_multipart_formdata_get_content_type(boundary);
  15094. auto content_length = detail::get_multipart_content_length(items, boundary);
  15095. return Patch(path, headers, content_length,
  15096. detail::make_multipart_content_provider(items, boundary),
  15097. content_type, progress);
  15098. }
  15099. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15100. const char *body, size_t content_length,
  15101. const std::string &content_type,
  15102. UploadProgress progress) {
  15103. return send_with_content_provider_and_receiver(
  15104. "PATCH", path, headers, body, content_length, nullptr, nullptr,
  15105. content_type, nullptr, progress);
  15106. }
  15107. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15108. const std::string &body,
  15109. const std::string &content_type,
  15110. UploadProgress progress) {
  15111. return send_with_content_provider_and_receiver(
  15112. "PATCH", path, headers, body.data(), body.size(), nullptr, nullptr,
  15113. content_type, nullptr, progress);
  15114. }
  15115. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15116. size_t content_length,
  15117. ContentProvider content_provider,
  15118. const std::string &content_type,
  15119. UploadProgress progress) {
  15120. return send_with_content_provider_and_receiver(
  15121. "PATCH", path, headers, nullptr, content_length,
  15122. std::move(content_provider), nullptr, content_type, nullptr, progress);
  15123. }
  15124. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15125. size_t content_length,
  15126. ContentProvider content_provider,
  15127. const std::string &content_type,
  15128. ContentReceiver content_receiver,
  15129. UploadProgress progress) {
  15130. return send_with_content_provider_and_receiver(
  15131. "PATCH", path, headers, nullptr, content_length,
  15132. std::move(content_provider), nullptr, content_type,
  15133. std::move(content_receiver), progress);
  15134. }
  15135. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15136. ContentProviderWithoutLength content_provider,
  15137. const std::string &content_type,
  15138. UploadProgress progress) {
  15139. return send_with_content_provider_and_receiver(
  15140. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15141. content_type, nullptr, progress);
  15142. }
  15143. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15144. ContentProviderWithoutLength content_provider,
  15145. const std::string &content_type,
  15146. ContentReceiver content_receiver,
  15147. UploadProgress progress) {
  15148. return send_with_content_provider_and_receiver(
  15149. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15150. content_type, std::move(content_receiver), progress);
  15151. }
  15152. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15153. const UploadFormDataItems &items,
  15154. const FormDataProviderItems &provider_items,
  15155. UploadProgress progress) {
  15156. const auto &boundary = detail::make_multipart_data_boundary();
  15157. const auto &content_type =
  15158. detail::serialize_multipart_formdata_get_content_type(boundary);
  15159. return send_with_content_provider_and_receiver(
  15160. "PATCH", path, headers, nullptr, 0, nullptr,
  15161. get_multipart_content_provider(boundary, items, provider_items),
  15162. content_type, nullptr, progress);
  15163. }
  15164. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15165. const std::string &body,
  15166. const std::string &content_type,
  15167. ContentReceiver content_receiver,
  15168. DownloadProgress progress) {
  15169. Request req;
  15170. req.method = "PATCH";
  15171. req.path = path;
  15172. req.headers = headers;
  15173. req.body = body;
  15174. req.content_receiver =
  15175. [content_receiver](const char *data, size_t data_length,
  15176. size_t /*offset*/, size_t /*total_length*/) {
  15177. return content_receiver(data, data_length);
  15178. };
  15179. req.download_progress = std::move(progress);
  15180. if (max_timeout_msec_ > 0) {
  15181. req.start_time_ = std::chrono::steady_clock::now();
  15182. }
  15183. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15184. return send_(std::move(req));
  15185. }
  15186. inline Result ClientImpl::Delete(const std::string &path,
  15187. DownloadProgress progress) {
  15188. return Delete(path, Headers(), std::string(), std::string(), progress);
  15189. }
  15190. inline Result ClientImpl::Delete(const std::string &path,
  15191. const Headers &headers,
  15192. DownloadProgress progress) {
  15193. return Delete(path, headers, std::string(), std::string(), progress);
  15194. }
  15195. inline Result ClientImpl::Delete(const std::string &path, const char *body,
  15196. size_t content_length,
  15197. const std::string &content_type,
  15198. DownloadProgress progress) {
  15199. return Delete(path, Headers(), body, content_length, content_type, progress);
  15200. }
  15201. inline Result ClientImpl::Delete(const std::string &path,
  15202. const std::string &body,
  15203. const std::string &content_type,
  15204. DownloadProgress progress) {
  15205. return Delete(path, Headers(), body.data(), body.size(), content_type,
  15206. progress);
  15207. }
  15208. inline Result ClientImpl::Delete(const std::string &path,
  15209. const Headers &headers,
  15210. const std::string &body,
  15211. const std::string &content_type,
  15212. DownloadProgress progress) {
  15213. return Delete(path, headers, body.data(), body.size(), content_type,
  15214. progress);
  15215. }
  15216. inline Result ClientImpl::Delete(const std::string &path, const Params &params,
  15217. DownloadProgress progress) {
  15218. return Delete(path, Headers(), params, progress);
  15219. }
  15220. inline Result ClientImpl::Delete(const std::string &path,
  15221. const Headers &headers, const Params &params,
  15222. DownloadProgress progress) {
  15223. auto query = detail::params_to_query_str(params);
  15224. return Delete(path, headers, query, "application/x-www-form-urlencoded",
  15225. progress);
  15226. }
  15227. inline Result ClientImpl::Delete(const std::string &path,
  15228. const Headers &headers, const char *body,
  15229. size_t content_length,
  15230. const std::string &content_type,
  15231. DownloadProgress progress) {
  15232. Request req;
  15233. req.method = "DELETE";
  15234. req.headers = headers;
  15235. req.path = path;
  15236. req.download_progress = std::move(progress);
  15237. if (max_timeout_msec_ > 0) {
  15238. req.start_time_ = std::chrono::steady_clock::now();
  15239. }
  15240. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15241. req.body.assign(body, content_length);
  15242. return send_(std::move(req));
  15243. }
  15244. inline Result ClientImpl::Options(const std::string &path) {
  15245. return Options(path, Headers());
  15246. }
  15247. inline Result ClientImpl::Options(const std::string &path,
  15248. const Headers &headers) {
  15249. Request req;
  15250. req.method = "OPTIONS";
  15251. req.headers = headers;
  15252. req.path = path;
  15253. if (max_timeout_msec_ > 0) {
  15254. req.start_time_ = std::chrono::steady_clock::now();
  15255. }
  15256. return send_(std::move(req));
  15257. }
  15258. inline void ClientImpl::stop() {
  15259. std::lock_guard<std::mutex> guard(socket_mutex_);
  15260. // If there is anything ongoing right now, the ONLY thread-safe thing we can
  15261. // do is to shutdown_socket, so that threads using this socket suddenly
  15262. // discover they can't read/write any more and error out. Everything else
  15263. // (closing the socket, shutting ssl down) is unsafe because these actions
  15264. // are not thread-safe.
  15265. if (socket_requests_in_flight_ > 0) {
  15266. shutdown_socket(socket_);
  15267. // Aside from that, we set a flag for the socket to be closed when we're
  15268. // done.
  15269. socket_should_be_closed_when_request_is_done_ = true;
  15270. return;
  15271. }
  15272. disconnect(/*gracefully=*/true);
  15273. }
  15274. inline std::string ClientImpl::host() const { return host_; }
  15275. inline int ClientImpl::port() const { return port_; }
  15276. inline size_t ClientImpl::is_socket_open() const {
  15277. std::lock_guard<std::mutex> guard(socket_mutex_);
  15278. return socket_.is_open();
  15279. }
  15280. inline socket_t ClientImpl::socket() const { return socket_.sock; }
  15281. inline void ClientImpl::set_connection_timeout(time_t sec, time_t usec) {
  15282. connection_timeout_sec_ = sec;
  15283. connection_timeout_usec_ = usec;
  15284. }
  15285. inline void ClientImpl::set_read_timeout(time_t sec, time_t usec) {
  15286. read_timeout_sec_ = sec;
  15287. read_timeout_usec_ = usec;
  15288. }
  15289. inline void ClientImpl::set_write_timeout(time_t sec, time_t usec) {
  15290. write_timeout_sec_ = sec;
  15291. write_timeout_usec_ = usec;
  15292. }
  15293. inline void ClientImpl::set_max_timeout(time_t msec) {
  15294. max_timeout_msec_ = msec;
  15295. }
  15296. inline void ClientImpl::set_basic_auth(const std::string &username,
  15297. const std::string &password) {
  15298. basic_auth_username_ = username;
  15299. basic_auth_password_ = password;
  15300. }
  15301. inline void ClientImpl::set_bearer_token_auth(const std::string &token) {
  15302. bearer_token_auth_token_ = token;
  15303. }
  15304. inline void ClientImpl::set_keep_alive(bool on) { keep_alive_ = on; }
  15305. inline void ClientImpl::set_follow_location(bool on) { follow_location_ = on; }
  15306. inline void ClientImpl::set_path_encode(bool on) { path_encode_ = on; }
  15307. inline void
  15308. ClientImpl::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15309. addr_map_ = std::move(addr_map);
  15310. }
  15311. inline void ClientImpl::set_default_headers(Headers headers) {
  15312. default_headers_ = std::move(headers);
  15313. }
  15314. inline void ClientImpl::set_header_writer(
  15315. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15316. header_writer_ = writer;
  15317. }
  15318. inline void ClientImpl::set_address_family(int family) {
  15319. address_family_ = family;
  15320. }
  15321. inline void ClientImpl::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  15322. inline void ClientImpl::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  15323. inline void ClientImpl::set_socket_options(SocketOptions socket_options) {
  15324. socket_options_ = std::move(socket_options);
  15325. }
  15326. inline void ClientImpl::set_compress(bool on) { compress_ = on; }
  15327. inline void ClientImpl::set_decompress(bool on) { decompress_ = on; }
  15328. inline void ClientImpl::set_payload_max_length(size_t length) {
  15329. payload_max_length_ = length;
  15330. has_payload_max_length_ = true;
  15331. }
  15332. inline void ClientImpl::set_interface(const std::string &intf) {
  15333. interface_ = intf;
  15334. }
  15335. inline void ClientImpl::set_proxy(const std::string &host, int port) {
  15336. proxy_host_ = host;
  15337. proxy_port_ = port;
  15338. std::lock_guard<std::mutex> guard(socket_mutex_);
  15339. disconnect(/*gracefully=*/true);
  15340. }
  15341. inline void ClientImpl::set_proxy_basic_auth(const std::string &username,
  15342. const std::string &password) {
  15343. proxy_basic_auth_username_ = username;
  15344. proxy_basic_auth_password_ = password;
  15345. }
  15346. inline void ClientImpl::set_proxy_bearer_token_auth(const std::string &token) {
  15347. proxy_bearer_token_auth_token_ = token;
  15348. }
  15349. inline void ClientImpl::set_no_proxy(const std::vector<std::string> &patterns) {
  15350. no_proxy_entries_ = detail::parse_no_proxy_entries(patterns);
  15351. std::lock_guard<std::mutex> guard(socket_mutex_);
  15352. disconnect(/*gracefully=*/true);
  15353. }
  15354. #ifdef CPPHTTPLIB_SSL_ENABLED
  15355. inline void ClientImpl::set_digest_auth(const std::string &username,
  15356. const std::string &password) {
  15357. digest_auth_username_ = username;
  15358. digest_auth_password_ = password;
  15359. }
  15360. inline void ClientImpl::set_ca_cert_path(const std::string &ca_cert_file_path,
  15361. const std::string &ca_cert_dir_path) {
  15362. ca_cert_file_path_ = ca_cert_file_path;
  15363. ca_cert_dir_path_ = ca_cert_dir_path;
  15364. }
  15365. inline void ClientImpl::set_proxy_digest_auth(const std::string &username,
  15366. const std::string &password) {
  15367. proxy_digest_auth_username_ = username;
  15368. proxy_digest_auth_password_ = password;
  15369. }
  15370. inline void ClientImpl::enable_server_certificate_verification(bool enabled) {
  15371. server_certificate_verification_ = enabled;
  15372. }
  15373. inline void ClientImpl::enable_server_hostname_verification(bool enabled) {
  15374. server_hostname_verification_ = enabled;
  15375. }
  15376. inline void ClientImpl::enable_system_ca(bool enabled) {
  15377. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  15378. }
  15379. #endif
  15380. inline void ClientImpl::set_logger(Logger logger) {
  15381. logger_ = std::move(logger);
  15382. }
  15383. inline void ClientImpl::set_error_logger(ErrorLogger error_logger) {
  15384. error_logger_ = std::move(error_logger);
  15385. }
  15386. /*
  15387. * SSL/TLS Common Implementation
  15388. */
  15389. inline ClientConnection::~ClientConnection() {
  15390. #ifdef CPPHTTPLIB_SSL_ENABLED
  15391. if (session) {
  15392. tls::shutdown(session, true);
  15393. tls::free_session(session);
  15394. session = nullptr;
  15395. }
  15396. #endif
  15397. if (sock != INVALID_SOCKET) {
  15398. detail::close_socket(sock);
  15399. sock = INVALID_SOCKET;
  15400. }
  15401. }
  15402. // Universal client implementation
  15403. inline Client::Client(const std::string &scheme_host_port)
  15404. : Client(scheme_host_port, std::string(), std::string()) {}
  15405. inline Client::Client(const std::string &scheme_host_port,
  15406. const std::string &client_cert_path,
  15407. const std::string &client_key_path) {
  15408. detail::UrlComponents uc;
  15409. if (detail::parse_url(scheme_host_port, uc) && !uc.host.empty()) {
  15410. auto &scheme = uc.scheme;
  15411. #ifdef CPPHTTPLIB_SSL_ENABLED
  15412. if (!scheme.empty() && (scheme != "http" && scheme != "https")) {
  15413. #else
  15414. if (!scheme.empty() && scheme != "http") {
  15415. #endif
  15416. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  15417. std::string msg = "'" + scheme + "' scheme is not supported.";
  15418. throw std::invalid_argument(msg);
  15419. #endif
  15420. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15421. return;
  15422. }
  15423. auto is_ssl = scheme == "https";
  15424. auto host = std::move(uc.host);
  15425. auto port = is_ssl ? 443 : 80;
  15426. if (!uc.port.empty() && !detail::parse_port(uc.port, port)) {
  15427. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15428. return;
  15429. }
  15430. if (is_ssl) {
  15431. #ifdef CPPHTTPLIB_SSL_ENABLED
  15432. cli_ = detail::make_unique<SSLClient>(host, port, client_cert_path,
  15433. client_key_path);
  15434. is_ssl_ = is_ssl;
  15435. #endif
  15436. } else {
  15437. cli_ = detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15438. client_key_path);
  15439. }
  15440. } else if (scheme_host_port.compare(0, 2, "//") == 0 ||
  15441. scheme_host_port.find("://") < scheme_host_port.find('/')) {
  15442. // A URL, but not one this client can use, such as one with userinfo. A
  15443. // Unix socket path may have "//" further on.
  15444. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15445. } else {
  15446. // NOTE: Update TEST(UniversalClientImplTest, Ipv6LiteralAddress)
  15447. // if port param below changes.
  15448. cli_ = detail::make_unique<ClientImpl>(scheme_host_port, 80,
  15449. client_cert_path, client_key_path);
  15450. }
  15451. }
  15452. inline Client::Client(const std::string &host, int port)
  15453. : Client(host, port, std::string(), std::string()) {}
  15454. inline Client::Client(const std::string &host, int port,
  15455. const std::string &client_cert_path,
  15456. const std::string &client_key_path)
  15457. : cli_(detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15458. client_key_path)) {}
  15459. inline Client::~Client() = default;
  15460. inline bool Client::is_valid() const {
  15461. return cli_ != nullptr && cli_->is_valid();
  15462. }
  15463. inline Result Client::Get(const std::string &path, DownloadProgress progress) {
  15464. return cli_->Get(path, std::move(progress));
  15465. }
  15466. inline Result Client::Get(const std::string &path, const Headers &headers,
  15467. DownloadProgress progress) {
  15468. return cli_->Get(path, headers, std::move(progress));
  15469. }
  15470. inline Result Client::Get(const std::string &path,
  15471. ContentReceiver content_receiver,
  15472. DownloadProgress progress) {
  15473. return cli_->Get(path, std::move(content_receiver), std::move(progress));
  15474. }
  15475. inline Result Client::Get(const std::string &path, const Headers &headers,
  15476. ContentReceiver content_receiver,
  15477. DownloadProgress progress) {
  15478. return cli_->Get(path, headers, std::move(content_receiver),
  15479. std::move(progress));
  15480. }
  15481. inline Result Client::Get(const std::string &path,
  15482. ResponseHandler response_handler,
  15483. ContentReceiver content_receiver,
  15484. DownloadProgress progress) {
  15485. return cli_->Get(path, std::move(response_handler),
  15486. std::move(content_receiver), std::move(progress));
  15487. }
  15488. inline Result Client::Get(const std::string &path, const Headers &headers,
  15489. ResponseHandler response_handler,
  15490. ContentReceiver content_receiver,
  15491. DownloadProgress progress) {
  15492. return cli_->Get(path, headers, std::move(response_handler),
  15493. std::move(content_receiver), std::move(progress));
  15494. }
  15495. inline Result Client::Get(const std::string &path, const Params &params,
  15496. DownloadProgress progress) {
  15497. return cli_->Get(path, params, std::move(progress));
  15498. }
  15499. inline Result Client::Get(const std::string &path, const Params &params,
  15500. const Headers &headers, DownloadProgress progress) {
  15501. return cli_->Get(path, params, headers, std::move(progress));
  15502. }
  15503. inline Result Client::Get(const std::string &path, const Params &params,
  15504. const Headers &headers,
  15505. ContentReceiver content_receiver,
  15506. DownloadProgress progress) {
  15507. return cli_->Get(path, params, headers, std::move(content_receiver),
  15508. std::move(progress));
  15509. }
  15510. inline Result Client::Get(const std::string &path, const Params &params,
  15511. const Headers &headers,
  15512. ResponseHandler response_handler,
  15513. ContentReceiver content_receiver,
  15514. DownloadProgress progress) {
  15515. return cli_->Get(path, params, headers, std::move(response_handler),
  15516. std::move(content_receiver), std::move(progress));
  15517. }
  15518. inline Result Client::Head(const std::string &path) { return cli_->Head(path); }
  15519. inline Result Client::Head(const std::string &path, const Headers &headers) {
  15520. return cli_->Head(path, headers);
  15521. }
  15522. inline Result Client::Post(const std::string &path) { return cli_->Post(path); }
  15523. inline Result Client::Post(const std::string &path, const Headers &headers) {
  15524. return cli_->Post(path, headers);
  15525. }
  15526. inline Result Client::Post(const std::string &path, const char *body,
  15527. size_t content_length,
  15528. const std::string &content_type,
  15529. UploadProgress progress) {
  15530. return cli_->Post(path, body, content_length, content_type, progress);
  15531. }
  15532. inline Result Client::Post(const std::string &path, const Headers &headers,
  15533. const char *body, size_t content_length,
  15534. const std::string &content_type,
  15535. UploadProgress progress) {
  15536. return cli_->Post(path, headers, body, content_length, content_type,
  15537. progress);
  15538. }
  15539. inline Result Client::Post(const std::string &path, const std::string &body,
  15540. const std::string &content_type,
  15541. UploadProgress progress) {
  15542. return cli_->Post(path, body, content_type, progress);
  15543. }
  15544. inline Result Client::Post(const std::string &path, const Headers &headers,
  15545. const std::string &body,
  15546. const std::string &content_type,
  15547. UploadProgress progress) {
  15548. return cli_->Post(path, headers, body, content_type, progress);
  15549. }
  15550. inline Result Client::Post(const std::string &path, size_t content_length,
  15551. ContentProvider content_provider,
  15552. const std::string &content_type,
  15553. UploadProgress progress) {
  15554. return cli_->Post(path, content_length, std::move(content_provider),
  15555. content_type, progress);
  15556. }
  15557. inline Result Client::Post(const std::string &path, size_t content_length,
  15558. ContentProvider content_provider,
  15559. const std::string &content_type,
  15560. ContentReceiver content_receiver,
  15561. UploadProgress progress) {
  15562. return cli_->Post(path, content_length, std::move(content_provider),
  15563. content_type, std::move(content_receiver), progress);
  15564. }
  15565. inline Result Client::Post(const std::string &path,
  15566. ContentProviderWithoutLength content_provider,
  15567. const std::string &content_type,
  15568. UploadProgress progress) {
  15569. return cli_->Post(path, std::move(content_provider), content_type, progress);
  15570. }
  15571. inline Result Client::Post(const std::string &path,
  15572. ContentProviderWithoutLength content_provider,
  15573. const std::string &content_type,
  15574. ContentReceiver content_receiver,
  15575. UploadProgress progress) {
  15576. return cli_->Post(path, std::move(content_provider), content_type,
  15577. std::move(content_receiver), progress);
  15578. }
  15579. inline Result Client::Post(const std::string &path, const Headers &headers,
  15580. size_t content_length,
  15581. ContentProvider content_provider,
  15582. const std::string &content_type,
  15583. UploadProgress progress) {
  15584. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15585. content_type, progress);
  15586. }
  15587. inline Result Client::Post(const std::string &path, const Headers &headers,
  15588. size_t content_length,
  15589. ContentProvider content_provider,
  15590. const std::string &content_type,
  15591. ContentReceiver content_receiver,
  15592. DownloadProgress progress) {
  15593. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15594. content_type, std::move(content_receiver), progress);
  15595. }
  15596. inline Result Client::Post(const std::string &path, const Headers &headers,
  15597. ContentProviderWithoutLength content_provider,
  15598. const std::string &content_type,
  15599. UploadProgress progress) {
  15600. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15601. progress);
  15602. }
  15603. inline Result Client::Post(const std::string &path, const Headers &headers,
  15604. ContentProviderWithoutLength content_provider,
  15605. const std::string &content_type,
  15606. ContentReceiver content_receiver,
  15607. DownloadProgress progress) {
  15608. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15609. std::move(content_receiver), progress);
  15610. }
  15611. inline Result Client::Post(const std::string &path, const Params &params) {
  15612. return cli_->Post(path, params);
  15613. }
  15614. inline Result Client::Post(const std::string &path, const Headers &headers,
  15615. const Params &params) {
  15616. return cli_->Post(path, headers, params);
  15617. }
  15618. inline Result Client::Post(const std::string &path,
  15619. const UploadFormDataItems &items,
  15620. UploadProgress progress) {
  15621. return cli_->Post(path, items, progress);
  15622. }
  15623. inline Result Client::Post(const std::string &path, const Headers &headers,
  15624. const UploadFormDataItems &items,
  15625. UploadProgress progress) {
  15626. return cli_->Post(path, headers, items, progress);
  15627. }
  15628. inline Result Client::Post(const std::string &path, const Headers &headers,
  15629. const UploadFormDataItems &items,
  15630. const std::string &boundary,
  15631. UploadProgress progress) {
  15632. return cli_->Post(path, headers, items, boundary, progress);
  15633. }
  15634. inline Result Client::Post(const std::string &path, const Headers &headers,
  15635. const UploadFormDataItems &items,
  15636. const FormDataProviderItems &provider_items,
  15637. UploadProgress progress) {
  15638. return cli_->Post(path, headers, items, provider_items, progress);
  15639. }
  15640. inline Result Client::Post(const std::string &path, const Headers &headers,
  15641. const std::string &body,
  15642. const std::string &content_type,
  15643. ContentReceiver content_receiver,
  15644. DownloadProgress progress) {
  15645. return cli_->Post(path, headers, body, content_type,
  15646. std::move(content_receiver), progress);
  15647. }
  15648. inline Result Client::Put(const std::string &path) { return cli_->Put(path); }
  15649. inline Result Client::Put(const std::string &path, const Headers &headers) {
  15650. return cli_->Put(path, headers);
  15651. }
  15652. inline Result Client::Put(const std::string &path, const char *body,
  15653. size_t content_length,
  15654. const std::string &content_type,
  15655. UploadProgress progress) {
  15656. return cli_->Put(path, body, content_length, content_type, progress);
  15657. }
  15658. inline Result Client::Put(const std::string &path, const Headers &headers,
  15659. const char *body, size_t content_length,
  15660. const std::string &content_type,
  15661. UploadProgress progress) {
  15662. return cli_->Put(path, headers, body, content_length, content_type, progress);
  15663. }
  15664. inline Result Client::Put(const std::string &path, const std::string &body,
  15665. const std::string &content_type,
  15666. UploadProgress progress) {
  15667. return cli_->Put(path, body, content_type, progress);
  15668. }
  15669. inline Result Client::Put(const std::string &path, const Headers &headers,
  15670. const std::string &body,
  15671. const std::string &content_type,
  15672. UploadProgress progress) {
  15673. return cli_->Put(path, headers, body, content_type, progress);
  15674. }
  15675. inline Result Client::Put(const std::string &path, size_t content_length,
  15676. ContentProvider content_provider,
  15677. const std::string &content_type,
  15678. UploadProgress progress) {
  15679. return cli_->Put(path, content_length, std::move(content_provider),
  15680. content_type, progress);
  15681. }
  15682. inline Result Client::Put(const std::string &path, size_t content_length,
  15683. ContentProvider content_provider,
  15684. const std::string &content_type,
  15685. ContentReceiver content_receiver,
  15686. UploadProgress progress) {
  15687. return cli_->Put(path, content_length, std::move(content_provider),
  15688. content_type, std::move(content_receiver), progress);
  15689. }
  15690. inline Result Client::Put(const std::string &path,
  15691. ContentProviderWithoutLength content_provider,
  15692. const std::string &content_type,
  15693. UploadProgress progress) {
  15694. return cli_->Put(path, std::move(content_provider), content_type, progress);
  15695. }
  15696. inline Result Client::Put(const std::string &path,
  15697. ContentProviderWithoutLength content_provider,
  15698. const std::string &content_type,
  15699. ContentReceiver content_receiver,
  15700. UploadProgress progress) {
  15701. return cli_->Put(path, std::move(content_provider), content_type,
  15702. std::move(content_receiver), progress);
  15703. }
  15704. inline Result Client::Put(const std::string &path, const Headers &headers,
  15705. size_t content_length,
  15706. ContentProvider content_provider,
  15707. const std::string &content_type,
  15708. UploadProgress progress) {
  15709. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15710. content_type, progress);
  15711. }
  15712. inline Result Client::Put(const std::string &path, const Headers &headers,
  15713. size_t content_length,
  15714. ContentProvider content_provider,
  15715. const std::string &content_type,
  15716. ContentReceiver content_receiver,
  15717. UploadProgress progress) {
  15718. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15719. content_type, std::move(content_receiver), progress);
  15720. }
  15721. inline Result Client::Put(const std::string &path, const Headers &headers,
  15722. ContentProviderWithoutLength content_provider,
  15723. const std::string &content_type,
  15724. UploadProgress progress) {
  15725. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15726. progress);
  15727. }
  15728. inline Result Client::Put(const std::string &path, const Headers &headers,
  15729. ContentProviderWithoutLength content_provider,
  15730. const std::string &content_type,
  15731. ContentReceiver content_receiver,
  15732. UploadProgress progress) {
  15733. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15734. std::move(content_receiver), progress);
  15735. }
  15736. inline Result Client::Put(const std::string &path, const Params &params) {
  15737. return cli_->Put(path, params);
  15738. }
  15739. inline Result Client::Put(const std::string &path, const Headers &headers,
  15740. const Params &params) {
  15741. return cli_->Put(path, headers, params);
  15742. }
  15743. inline Result Client::Put(const std::string &path,
  15744. const UploadFormDataItems &items,
  15745. UploadProgress progress) {
  15746. return cli_->Put(path, items, progress);
  15747. }
  15748. inline Result Client::Put(const std::string &path, const Headers &headers,
  15749. const UploadFormDataItems &items,
  15750. UploadProgress progress) {
  15751. return cli_->Put(path, headers, items, progress);
  15752. }
  15753. inline Result Client::Put(const std::string &path, const Headers &headers,
  15754. const UploadFormDataItems &items,
  15755. const std::string &boundary,
  15756. UploadProgress progress) {
  15757. return cli_->Put(path, headers, items, boundary, progress);
  15758. }
  15759. inline Result Client::Put(const std::string &path, const Headers &headers,
  15760. const UploadFormDataItems &items,
  15761. const FormDataProviderItems &provider_items,
  15762. UploadProgress progress) {
  15763. return cli_->Put(path, headers, items, provider_items, progress);
  15764. }
  15765. inline Result Client::Put(const std::string &path, const Headers &headers,
  15766. const std::string &body,
  15767. const std::string &content_type,
  15768. ContentReceiver content_receiver,
  15769. DownloadProgress progress) {
  15770. return cli_->Put(path, headers, body, content_type, content_receiver,
  15771. progress);
  15772. }
  15773. inline Result Client::Patch(const std::string &path) {
  15774. return cli_->Patch(path);
  15775. }
  15776. inline Result Client::Patch(const std::string &path, const Headers &headers) {
  15777. return cli_->Patch(path, headers);
  15778. }
  15779. inline Result Client::Patch(const std::string &path, const char *body,
  15780. size_t content_length,
  15781. const std::string &content_type,
  15782. UploadProgress progress) {
  15783. return cli_->Patch(path, body, content_length, content_type, progress);
  15784. }
  15785. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15786. const char *body, size_t content_length,
  15787. const std::string &content_type,
  15788. UploadProgress progress) {
  15789. return cli_->Patch(path, headers, body, content_length, content_type,
  15790. progress);
  15791. }
  15792. inline Result Client::Patch(const std::string &path, const std::string &body,
  15793. const std::string &content_type,
  15794. UploadProgress progress) {
  15795. return cli_->Patch(path, body, content_type, progress);
  15796. }
  15797. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15798. const std::string &body,
  15799. const std::string &content_type,
  15800. UploadProgress progress) {
  15801. return cli_->Patch(path, headers, body, content_type, progress);
  15802. }
  15803. inline Result Client::Patch(const std::string &path, size_t content_length,
  15804. ContentProvider content_provider,
  15805. const std::string &content_type,
  15806. UploadProgress progress) {
  15807. return cli_->Patch(path, content_length, std::move(content_provider),
  15808. content_type, progress);
  15809. }
  15810. inline Result Client::Patch(const std::string &path, size_t content_length,
  15811. ContentProvider content_provider,
  15812. const std::string &content_type,
  15813. ContentReceiver content_receiver,
  15814. UploadProgress progress) {
  15815. return cli_->Patch(path, content_length, std::move(content_provider),
  15816. content_type, std::move(content_receiver), progress);
  15817. }
  15818. inline Result Client::Patch(const std::string &path,
  15819. ContentProviderWithoutLength content_provider,
  15820. const std::string &content_type,
  15821. UploadProgress progress) {
  15822. return cli_->Patch(path, std::move(content_provider), content_type, progress);
  15823. }
  15824. inline Result Client::Patch(const std::string &path,
  15825. ContentProviderWithoutLength content_provider,
  15826. const std::string &content_type,
  15827. ContentReceiver content_receiver,
  15828. UploadProgress progress) {
  15829. return cli_->Patch(path, std::move(content_provider), content_type,
  15830. std::move(content_receiver), progress);
  15831. }
  15832. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15833. size_t content_length,
  15834. ContentProvider content_provider,
  15835. const std::string &content_type,
  15836. UploadProgress progress) {
  15837. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15838. content_type, progress);
  15839. }
  15840. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15841. size_t content_length,
  15842. ContentProvider content_provider,
  15843. const std::string &content_type,
  15844. ContentReceiver content_receiver,
  15845. UploadProgress progress) {
  15846. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15847. content_type, std::move(content_receiver), progress);
  15848. }
  15849. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15850. ContentProviderWithoutLength content_provider,
  15851. const std::string &content_type,
  15852. UploadProgress progress) {
  15853. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15854. progress);
  15855. }
  15856. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15857. ContentProviderWithoutLength content_provider,
  15858. const std::string &content_type,
  15859. ContentReceiver content_receiver,
  15860. UploadProgress progress) {
  15861. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15862. std::move(content_receiver), progress);
  15863. }
  15864. inline Result Client::Patch(const std::string &path, const Params &params) {
  15865. return cli_->Patch(path, params);
  15866. }
  15867. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15868. const Params &params) {
  15869. return cli_->Patch(path, headers, params);
  15870. }
  15871. inline Result Client::Patch(const std::string &path,
  15872. const UploadFormDataItems &items,
  15873. UploadProgress progress) {
  15874. return cli_->Patch(path, items, progress);
  15875. }
  15876. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15877. const UploadFormDataItems &items,
  15878. UploadProgress progress) {
  15879. return cli_->Patch(path, headers, items, progress);
  15880. }
  15881. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15882. const UploadFormDataItems &items,
  15883. const std::string &boundary,
  15884. UploadProgress progress) {
  15885. return cli_->Patch(path, headers, items, boundary, progress);
  15886. }
  15887. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15888. const UploadFormDataItems &items,
  15889. const FormDataProviderItems &provider_items,
  15890. UploadProgress progress) {
  15891. return cli_->Patch(path, headers, items, provider_items, progress);
  15892. }
  15893. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15894. const std::string &body,
  15895. const std::string &content_type,
  15896. ContentReceiver content_receiver,
  15897. DownloadProgress progress) {
  15898. return cli_->Patch(path, headers, body, content_type, content_receiver,
  15899. progress);
  15900. }
  15901. inline Result Client::Delete(const std::string &path,
  15902. DownloadProgress progress) {
  15903. return cli_->Delete(path, progress);
  15904. }
  15905. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15906. DownloadProgress progress) {
  15907. return cli_->Delete(path, headers, progress);
  15908. }
  15909. inline Result Client::Delete(const std::string &path, const char *body,
  15910. size_t content_length,
  15911. const std::string &content_type,
  15912. DownloadProgress progress) {
  15913. return cli_->Delete(path, body, content_length, content_type, progress);
  15914. }
  15915. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15916. const char *body, size_t content_length,
  15917. const std::string &content_type,
  15918. DownloadProgress progress) {
  15919. return cli_->Delete(path, headers, body, content_length, content_type,
  15920. progress);
  15921. }
  15922. inline Result Client::Delete(const std::string &path, const std::string &body,
  15923. const std::string &content_type,
  15924. DownloadProgress progress) {
  15925. return cli_->Delete(path, body, content_type, progress);
  15926. }
  15927. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15928. const std::string &body,
  15929. const std::string &content_type,
  15930. DownloadProgress progress) {
  15931. return cli_->Delete(path, headers, body, content_type, progress);
  15932. }
  15933. inline Result Client::Delete(const std::string &path, const Params &params,
  15934. DownloadProgress progress) {
  15935. return cli_->Delete(path, params, progress);
  15936. }
  15937. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15938. const Params &params, DownloadProgress progress) {
  15939. return cli_->Delete(path, headers, params, progress);
  15940. }
  15941. inline Result Client::Options(const std::string &path) {
  15942. return cli_->Options(path);
  15943. }
  15944. inline Result Client::Options(const std::string &path, const Headers &headers) {
  15945. return cli_->Options(path, headers);
  15946. }
  15947. inline ClientImpl::StreamHandle
  15948. Client::open_stream(const std::string &method, const std::string &path,
  15949. const Params &params, const Headers &headers,
  15950. const std::string &body, const std::string &content_type) {
  15951. return cli_->open_stream(method, path, params, headers, body, content_type);
  15952. }
  15953. inline bool Client::send(Request &req, Response &res, Error &error) {
  15954. return cli_->send(req, res, error);
  15955. }
  15956. inline Result Client::send(const Request &req) { return cli_->send(req); }
  15957. inline void Client::stop() { cli_->stop(); }
  15958. inline std::string Client::host() const { return cli_->host(); }
  15959. inline int Client::port() const { return cli_->port(); }
  15960. inline size_t Client::is_socket_open() const { return cli_->is_socket_open(); }
  15961. inline socket_t Client::socket() const { return cli_->socket(); }
  15962. inline void
  15963. Client::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15964. cli_->set_hostname_addr_map(std::move(addr_map));
  15965. }
  15966. inline void Client::set_default_headers(Headers headers) {
  15967. cli_->set_default_headers(std::move(headers));
  15968. }
  15969. inline void Client::set_header_writer(
  15970. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15971. cli_->set_header_writer(writer);
  15972. }
  15973. inline void Client::set_address_family(int family) {
  15974. cli_->set_address_family(family);
  15975. }
  15976. inline void Client::set_tcp_nodelay(bool on) { cli_->set_tcp_nodelay(on); }
  15977. inline void Client::set_socket_options(SocketOptions socket_options) {
  15978. cli_->set_socket_options(std::move(socket_options));
  15979. }
  15980. inline void Client::set_connection_timeout(time_t sec, time_t usec) {
  15981. cli_->set_connection_timeout(sec, usec);
  15982. }
  15983. inline void Client::set_read_timeout(time_t sec, time_t usec) {
  15984. cli_->set_read_timeout(sec, usec);
  15985. }
  15986. inline void Client::set_write_timeout(time_t sec, time_t usec) {
  15987. cli_->set_write_timeout(sec, usec);
  15988. }
  15989. inline void Client::set_basic_auth(const std::string &username,
  15990. const std::string &password) {
  15991. cli_->set_basic_auth(username, password);
  15992. }
  15993. inline void Client::set_bearer_token_auth(const std::string &token) {
  15994. cli_->set_bearer_token_auth(token);
  15995. }
  15996. inline void Client::set_keep_alive(bool on) { cli_->set_keep_alive(on); }
  15997. inline void Client::set_follow_location(bool on) {
  15998. cli_->set_follow_location(on);
  15999. }
  16000. inline void Client::set_path_encode(bool on) { cli_->set_path_encode(on); }
  16001. inline void Client::set_compress(bool on) { cli_->set_compress(on); }
  16002. inline void Client::set_decompress(bool on) { cli_->set_decompress(on); }
  16003. inline void Client::set_payload_max_length(size_t length) {
  16004. cli_->set_payload_max_length(length);
  16005. }
  16006. inline void Client::set_interface(const std::string &intf) {
  16007. cli_->set_interface(intf);
  16008. }
  16009. inline void Client::set_proxy(const std::string &host, int port) {
  16010. cli_->set_proxy(host, port);
  16011. }
  16012. inline void Client::set_proxy_basic_auth(const std::string &username,
  16013. const std::string &password) {
  16014. cli_->set_proxy_basic_auth(username, password);
  16015. }
  16016. inline void Client::set_proxy_bearer_token_auth(const std::string &token) {
  16017. cli_->set_proxy_bearer_token_auth(token);
  16018. }
  16019. inline void Client::set_no_proxy(const std::vector<std::string> &patterns) {
  16020. cli_->set_no_proxy(patterns);
  16021. }
  16022. inline void Client::set_logger(Logger logger) {
  16023. cli_->set_logger(std::move(logger));
  16024. }
  16025. inline void Client::set_error_logger(ErrorLogger error_logger) {
  16026. cli_->set_error_logger(std::move(error_logger));
  16027. }
  16028. /*
  16029. * Group 6: SSL Server and Client implementation
  16030. */
  16031. #ifdef CPPHTTPLIB_SSL_ENABLED
  16032. // SSL HTTP server implementation
  16033. inline SSLServer::SSLServer(const char *cert_path, const char *private_key_path,
  16034. const char *client_ca_cert_file_path,
  16035. const char *client_ca_cert_dir_path,
  16036. const char *private_key_password) {
  16037. using namespace tls;
  16038. ctx_ = create_server_context();
  16039. if (!ctx_) { return; }
  16040. // Load server certificate and private key
  16041. if (!set_server_cert_file(ctx_, cert_path, private_key_path,
  16042. private_key_password)) {
  16043. last_ssl_error_ = static_cast<int>(get_error());
  16044. free_context(ctx_);
  16045. ctx_ = nullptr;
  16046. return;
  16047. }
  16048. // Load client CA certificates for client authentication
  16049. if (client_ca_cert_file_path || client_ca_cert_dir_path) {
  16050. if (!set_client_ca_file(ctx_, client_ca_cert_file_path,
  16051. client_ca_cert_dir_path)) {
  16052. last_ssl_error_ = static_cast<int>(get_error());
  16053. free_context(ctx_);
  16054. ctx_ = nullptr;
  16055. return;
  16056. }
  16057. // Enable client certificate verification
  16058. set_verify_client(ctx_, true);
  16059. }
  16060. }
  16061. inline SSLServer::SSLServer(const PemMemory &pem) {
  16062. using namespace tls;
  16063. ctx_ = create_server_context();
  16064. if (ctx_) {
  16065. std::string cert_buf, key_buf;
  16066. if (!set_server_cert_pem(
  16067. ctx_, detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  16068. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  16069. pem.private_key_password)) {
  16070. last_ssl_error_ = static_cast<int>(get_error());
  16071. free_context(ctx_);
  16072. ctx_ = nullptr;
  16073. } else if (pem.client_ca_pem) {
  16074. auto ca_len = pem.client_ca_pem_len ? pem.client_ca_pem_len
  16075. : strlen(pem.client_ca_pem);
  16076. if (!load_ca_pem(ctx_, pem.client_ca_pem, ca_len)) {
  16077. last_ssl_error_ = static_cast<int>(get_error());
  16078. free_context(ctx_);
  16079. ctx_ = nullptr;
  16080. } else {
  16081. set_verify_client(ctx_, true);
  16082. }
  16083. }
  16084. }
  16085. }
  16086. inline SSLServer::SSLServer(const tls::ContextSetupCallback &setup_callback) {
  16087. using namespace tls;
  16088. ctx_ = create_server_context();
  16089. if (ctx_) {
  16090. if (!setup_callback(ctx_)) {
  16091. free_context(ctx_);
  16092. ctx_ = nullptr;
  16093. }
  16094. }
  16095. }
  16096. inline SSLServer::~SSLServer() {
  16097. if (ctx_) { tls::free_context(ctx_); }
  16098. }
  16099. inline bool SSLServer::is_valid() const {
  16100. return ctx_ != nullptr && Server::is_valid();
  16101. }
  16102. inline bool SSLServer::process_and_close_socket(socket_t sock) {
  16103. using namespace tls;
  16104. session_t session = nullptr;
  16105. {
  16106. std::unique_lock<std::mutex> lock(ctx_mutex_);
  16107. ctx_cv_.wait(lock, [&] { return updates_pending_ == 0; });
  16108. session = create_session(static_cast<ctx_t>(ctx_), sock);
  16109. if (session) { handshakes_in_progress_++; }
  16110. }
  16111. if (!session) {
  16112. last_ssl_error_ = static_cast<int>(get_error());
  16113. detail::shutdown_socket(sock);
  16114. detail::close_socket(sock);
  16115. return false;
  16116. }
  16117. // Use scope_exit to ensure cleanup on all paths (including exceptions)
  16118. bool handshake_done = false;
  16119. bool ret = false;
  16120. bool websocket_upgraded = false;
  16121. auto cleanup = detail::scope_exit([&] {
  16122. if (handshake_done) { shutdown(session, !websocket_upgraded && ret); }
  16123. free_session(session);
  16124. detail::shutdown_socket(sock);
  16125. detail::close_socket(sock);
  16126. });
  16127. // Perform TLS accept handshake with timeout
  16128. TlsError tls_err;
  16129. auto accepted = false;
  16130. {
  16131. auto handshake_left = detail::scope_exit([&] {
  16132. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16133. if (--handshakes_in_progress_ == 0) { ctx_cv_.notify_all(); }
  16134. });
  16135. accepted = accept_nonblocking(session, sock, read_timeout_sec_,
  16136. read_timeout_usec_, &tls_err);
  16137. }
  16138. if (!accepted) {
  16139. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16140. // Map TlsError to legacy ssl_error for backward compatibility
  16141. if (tls_err.code == ErrorCode::WantRead) {
  16142. last_ssl_error_ = SSL_ERROR_WANT_READ;
  16143. } else if (tls_err.code == ErrorCode::WantWrite) {
  16144. last_ssl_error_ = SSL_ERROR_WANT_WRITE;
  16145. } else {
  16146. last_ssl_error_ = SSL_ERROR_SSL;
  16147. }
  16148. #else
  16149. last_ssl_error_ = static_cast<int>(get_error());
  16150. #endif
  16151. return false;
  16152. }
  16153. handshake_done = true;
  16154. std::string remote_addr;
  16155. int remote_port = 0;
  16156. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  16157. std::string local_addr;
  16158. int local_port = 0;
  16159. detail::get_local_ip_and_port(sock, local_addr, local_port);
  16160. ret = serve_guarded([&]() {
  16161. return detail::process_server_socket_ssl(
  16162. svr_sock_, session, sock, keep_alive_max_count_,
  16163. keep_alive_timeout_sec_, read_timeout_sec_, read_timeout_usec_,
  16164. write_timeout_sec_, write_timeout_usec_,
  16165. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  16166. return process_request(
  16167. strm, remote_addr, remote_port, local_addr, local_port,
  16168. close_connection, connection_closed,
  16169. [&](Request &req) { req.ssl = session; }, &websocket_upgraded);
  16170. });
  16171. });
  16172. return ret;
  16173. }
  16174. inline bool SSLServer::update_certs_pem(const char *cert_pem,
  16175. const char *key_pem,
  16176. const char *client_ca_pem,
  16177. const char *password) {
  16178. if (!ctx_) { return false; }
  16179. std::unique_lock<std::mutex> lock(ctx_mutex_);
  16180. updates_pending_++;
  16181. auto se = detail::scope_exit([&] {
  16182. if (--updates_pending_ == 0) { ctx_cv_.notify_all(); }
  16183. });
  16184. ctx_cv_.wait(lock, [&] { return handshakes_in_progress_ == 0; });
  16185. if (!tls::update_server_cert(ctx_, cert_pem, key_pem, password)) {
  16186. return false;
  16187. }
  16188. if (client_ca_pem) {
  16189. if (!tls::update_server_client_ca(ctx_, client_ca_pem)) { return false; }
  16190. // As in the constructors, a client CA makes client certificates required
  16191. tls::set_verify_client(ctx_, true);
  16192. }
  16193. return true;
  16194. }
  16195. // SSL HTTP client implementation
  16196. inline SSLClient::~SSLClient() {
  16197. // Make sure to shut down SSL since shutdown_ssl will resolve to the
  16198. // base function rather than the derived function once we get to the
  16199. // base class destructor, and won't free the SSL (causing a leak).
  16200. // This must happen before the context is freed below: some backends
  16201. // (e.g. mbedTLS) have the SSL session borrow a raw pointer into the
  16202. // context, so freeing the context first leaves close_notify reading
  16203. // freed memory.
  16204. shutdown_ssl_impl(socket_, true);
  16205. if (ctx_) {
  16206. tls::free_context(ctx_);
  16207. ctx_ = nullptr;
  16208. }
  16209. }
  16210. inline bool SSLClient::is_valid() const { return ctx_ != nullptr; }
  16211. inline void SSLClient::shutdown_ssl(Socket &socket, bool shutdown_gracefully) {
  16212. shutdown_ssl_impl(socket, shutdown_gracefully);
  16213. }
  16214. inline void SSLClient::shutdown_ssl_impl(Socket &socket,
  16215. bool shutdown_gracefully) {
  16216. if (socket.sock == INVALID_SOCKET) {
  16217. assert(socket.ssl == nullptr);
  16218. return;
  16219. }
  16220. if (socket.ssl) {
  16221. tls::shutdown(socket.ssl, shutdown_gracefully);
  16222. {
  16223. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16224. tls::free_session(socket.ssl);
  16225. }
  16226. socket.ssl = nullptr;
  16227. }
  16228. assert(socket.ssl == nullptr);
  16229. }
  16230. inline bool SSLClient::process_socket(
  16231. const Socket &socket,
  16232. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16233. std::function<bool(Stream &strm)> callback) {
  16234. assert(socket.ssl);
  16235. return detail::process_client_socket_ssl(
  16236. socket.ssl, socket.sock, read_timeout_sec_, read_timeout_usec_,
  16237. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_, start_time,
  16238. [&](detail::SSLSocketStream &strm) {
  16239. auto ret = callback(strm);
  16240. // A request that failed after the handshake reports Error::Read or
  16241. // Error::Write; keep the TLS error behind it, such as a fatal alert
  16242. // from the server, for Result::ssl_error() and ssl_backend_error()
  16243. const auto &tls_error = strm.tls_error();
  16244. if (!ret && tls_error.code != tls::ErrorCode::Success) {
  16245. last_ssl_error_ = static_cast<int>(tls_error.code);
  16246. last_backend_error_ = tls_error.backend_code;
  16247. }
  16248. return ret;
  16249. });
  16250. }
  16251. inline bool SSLClient::is_ssl() const { return true; }
  16252. inline bool SSLClient::create_and_connect_socket(Socket &socket, Error &error) {
  16253. if (!is_valid()) {
  16254. error = Error::SSLConnection;
  16255. return false;
  16256. }
  16257. return ClientImpl::create_and_connect_socket(socket, error);
  16258. }
  16259. inline bool SSLClient::setup_proxy_connection(
  16260. Socket &socket,
  16261. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16262. Response &res, bool &success, Error &error) {
  16263. if (!is_proxy_enabled_for_host(host_)) { return true; }
  16264. if (!connect_with_proxy(socket, start_time, res, success, error)) {
  16265. return false;
  16266. }
  16267. if (!initialize_ssl(socket, error)) {
  16268. success = false;
  16269. return false;
  16270. }
  16271. return true;
  16272. }
  16273. // Assumes that socket_mutex_ is locked and that there are no requests in
  16274. // flight
  16275. inline bool SSLClient::connect_with_proxy(
  16276. Socket &socket,
  16277. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16278. Response &res, bool &success, Error &error) {
  16279. success = true;
  16280. Response proxy_res;
  16281. if (!detail::process_client_socket(
  16282. socket.sock, read_timeout_sec_, read_timeout_usec_,
  16283. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  16284. start_time, [&](Stream &strm) {
  16285. Request req2;
  16286. req2.method = "CONNECT";
  16287. req2.path =
  16288. detail::make_host_and_port_string_always_port(host_, port_);
  16289. if (max_timeout_msec_ > 0) {
  16290. req2.start_time_ = std::chrono::steady_clock::now();
  16291. }
  16292. return process_request(strm, req2, proxy_res, false, error);
  16293. })) {
  16294. // Thread-safe to close everything because we are assuming there are no
  16295. // requests in flight
  16296. shutdown_ssl(socket, true);
  16297. shutdown_socket(socket);
  16298. close_socket(socket);
  16299. success = false;
  16300. return false;
  16301. }
  16302. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  16303. if (!proxy_digest_auth_username_.empty() &&
  16304. !proxy_digest_auth_password_.empty()) {
  16305. std::map<std::string, std::string> auth;
  16306. if (detail::parse_www_authenticate(proxy_res, auth, true)) {
  16307. // Close the current socket and create a new one for the authenticated
  16308. // request
  16309. shutdown_ssl(socket, true);
  16310. shutdown_socket(socket);
  16311. close_socket(socket);
  16312. // Create a new socket for the authenticated CONNECT request
  16313. if (!ensure_socket_connection(socket, error)) {
  16314. success = false;
  16315. return false;
  16316. }
  16317. proxy_res = Response();
  16318. if (!detail::process_client_socket(
  16319. socket.sock, read_timeout_sec_, read_timeout_usec_,
  16320. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  16321. start_time, [&](Stream &strm) {
  16322. Request req3;
  16323. req3.method = "CONNECT";
  16324. req3.path = detail::make_host_and_port_string_always_port(
  16325. host_, port_);
  16326. req3.headers.insert(detail::make_digest_authentication_header(
  16327. req3, make_request_target(req3), auth, 1,
  16328. detail::random_string(10), proxy_digest_auth_username_,
  16329. proxy_digest_auth_password_, true));
  16330. if (max_timeout_msec_ > 0) {
  16331. req3.start_time_ = std::chrono::steady_clock::now();
  16332. }
  16333. return process_request(strm, req3, proxy_res, false, error);
  16334. })) {
  16335. // Thread-safe to close everything because we are assuming there are
  16336. // no requests in flight
  16337. shutdown_ssl(socket, true);
  16338. shutdown_socket(socket);
  16339. close_socket(socket);
  16340. success = false;
  16341. return false;
  16342. }
  16343. }
  16344. }
  16345. }
  16346. // If status code is not 200, proxy request is failed.
  16347. // Set error to ProxyConnection. A 407 is returned as the response of the
  16348. // request, so the caller sees the proxy asks for credentials; any other
  16349. // status would read as the answer of the origin, which it never reached.
  16350. if (proxy_res.status != StatusCode::OK_200) {
  16351. error = Error::ProxyConnection;
  16352. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  16353. res = std::move(proxy_res);
  16354. } else {
  16355. success = false;
  16356. }
  16357. // Thread-safe to close everything because we are assuming there are
  16358. // no requests in flight
  16359. shutdown_ssl(socket, true);
  16360. shutdown_socket(socket);
  16361. close_socket(socket);
  16362. return false;
  16363. }
  16364. return true;
  16365. }
  16366. inline bool SSLClient::ensure_socket_connection(Socket &socket, Error &error) {
  16367. if (!ClientImpl::ensure_socket_connection(socket, error)) { return false; }
  16368. if (is_proxy_enabled_for_host(host_)) { return true; }
  16369. if (!initialize_ssl(socket, error)) {
  16370. shutdown_socket(socket);
  16371. close_socket(socket);
  16372. return false;
  16373. }
  16374. return true;
  16375. }
  16376. // SSL HTTP client implementation
  16377. inline SSLClient::SSLClient(const std::string &host)
  16378. : SSLClient(host, 443, std::string(), std::string()) {}
  16379. inline SSLClient::SSLClient(const std::string &host, int port)
  16380. : SSLClient(host, port, std::string(), std::string()) {}
  16381. inline void SSLClient::init_ctx() {
  16382. ctx_ = tls::create_client_context();
  16383. if (ctx_) { tls::set_min_version(ctx_, tls::Version::TLS1_2); }
  16384. }
  16385. inline void SSLClient::reset_ctx_on_error() {
  16386. last_backend_error_ = tls::get_error();
  16387. tls::free_context(ctx_);
  16388. ctx_ = nullptr;
  16389. }
  16390. inline SSLClient::SSLClient(const std::string &host, int port,
  16391. const std::string &client_cert_path,
  16392. const std::string &client_key_path,
  16393. const std::string &private_key_password)
  16394. : ClientImpl(host, port, client_cert_path, client_key_path) {
  16395. init_ctx();
  16396. if (!ctx_) { return; }
  16397. if (!client_cert_path.empty() && !client_key_path.empty()) {
  16398. const char *password =
  16399. private_key_password.empty() ? nullptr : private_key_password.c_str();
  16400. if (!tls::set_client_cert_file(ctx_, client_cert_path.c_str(),
  16401. client_key_path.c_str(), password)) {
  16402. reset_ctx_on_error();
  16403. }
  16404. }
  16405. }
  16406. inline SSLClient::SSLClient(const std::string &host, int port,
  16407. const PemMemory &pem)
  16408. : ClientImpl(host, port) {
  16409. init_ctx();
  16410. if (!ctx_) { return; }
  16411. if (pem.cert_pem && pem.key_pem) {
  16412. std::string cert_buf, key_buf;
  16413. if (!tls::set_client_cert_pem(
  16414. ctx_, detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  16415. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  16416. pem.private_key_password)) {
  16417. reset_ctx_on_error();
  16418. }
  16419. }
  16420. }
  16421. inline void SSLClient::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16422. if (ca_cert_store && ctx_) {
  16423. // set_ca_store takes ownership of ca_cert_store
  16424. tls::set_ca_store(ctx_, ca_cert_store);
  16425. ca_cert_store_set_ = true;
  16426. } else if (ca_cert_store) {
  16427. tls::free_ca_store(ca_cert_store);
  16428. }
  16429. custom_ca_loaded_ = true;
  16430. }
  16431. inline void
  16432. SSLClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16433. if (!ctx_) { return; }
  16434. server_certificate_verifier_ = verifier;
  16435. // Under the lock that creating a session from ctx_ takes
  16436. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16437. tls::set_verify_callback(ctx_, std::move(verifier));
  16438. }
  16439. inline void SSLClient::set_session_verifier(
  16440. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16441. session_verifier_ = std::move(verifier);
  16442. }
  16443. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16444. inline void SSLClient::enable_windows_certificate_verification(bool enabled) {
  16445. enable_windows_cert_verification_ = enabled;
  16446. }
  16447. #endif
  16448. inline void SSLClient::load_ca_cert_store(const char *ca_cert,
  16449. std::size_t size) {
  16450. if (ctx_ && ca_cert && size > 0) {
  16451. // Every PEM loaded, for redirect transfer
  16452. if (!ca_cert_pem_.empty() && ca_cert_pem_.back() != '\n') {
  16453. ca_cert_pem_ += '\n';
  16454. }
  16455. ca_cert_pem_.append(ca_cert, size);
  16456. tls::load_ca_pem(ctx_, ca_cert, size);
  16457. }
  16458. custom_ca_loaded_ = true;
  16459. }
  16460. inline bool SSLClient::load_certs() {
  16461. auto ret = true;
  16462. // call_once rather than the plain flag WebSocketClient::create_stream() uses:
  16463. // one client is shared across concurrent requests here.
  16464. std::call_once(initialize_cert_, [&]() {
  16465. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16466. ret = detail::load_client_ca_config(ctx_, ca_cert_file_path_,
  16467. ca_cert_dir_path_, custom_ca_loaded_,
  16468. system_ca_mode_, last_backend_error_);
  16469. });
  16470. return ret;
  16471. }
  16472. inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) {
  16473. // Load CA certificates if server verification is enabled
  16474. if (server_certificate_verification_) {
  16475. if (!load_certs()) {
  16476. error = Error::SSLLoadingCerts;
  16477. return false;
  16478. }
  16479. }
  16480. detail::ClientTlsSessionOptions options;
  16481. options.server_hostname_verification = server_hostname_verification_;
  16482. options.session_verifier = session_verifier_;
  16483. options.ctx_mutex = &ctx_mutex_;
  16484. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16485. // Skip Schannel when a custom CA cert is specified, as the Windows
  16486. // certificate store would not know about user-provided CA certificates.
  16487. // Also skip when system CA trust is explicitly disabled.
  16488. options.windows_cert_verification =
  16489. enable_windows_cert_verification_ &&
  16490. system_ca_mode_ != SystemCAMode::Disabled && ca_cert_file_path_.empty() &&
  16491. ca_cert_dir_path_.empty() && !custom_ca_loaded_;
  16492. // Only a verifier set through set_server_certificate_verifier() is seen
  16493. // here, not one installed with tls::set_verify_callback() directly.
  16494. options.server_certificate_verifier_set =
  16495. static_cast<bool>(server_certificate_verifier_);
  16496. #endif
  16497. tls::session_t session = nullptr;
  16498. // Use scope_exit to ensure session is freed on error paths
  16499. bool success = false;
  16500. auto session_guard = detail::scope_exit([&] {
  16501. if (!success) { tls::free_session(session); }
  16502. });
  16503. detail::ClientTlsSessionError tls_error;
  16504. if (!detail::setup_client_tls_session(
  16505. host_, ctx_, session, socket.sock, server_certificate_verification_,
  16506. connection_timeout_sec_, connection_timeout_usec_, &tls_error,
  16507. options)) {
  16508. error = tls_error.error;
  16509. last_ssl_error_ = tls_error.ssl_error;
  16510. last_backend_error_ = tls_error.backend_error;
  16511. return false;
  16512. }
  16513. success = true;
  16514. socket.ssl = session;
  16515. return true;
  16516. }
  16517. inline void Client::set_digest_auth(const std::string &username,
  16518. const std::string &password) {
  16519. cli_->set_digest_auth(username, password);
  16520. }
  16521. inline void Client::set_proxy_digest_auth(const std::string &username,
  16522. const std::string &password) {
  16523. cli_->set_proxy_digest_auth(username, password);
  16524. }
  16525. inline void Client::enable_server_certificate_verification(bool enabled) {
  16526. cli_->enable_server_certificate_verification(enabled);
  16527. }
  16528. inline void Client::enable_server_hostname_verification(bool enabled) {
  16529. cli_->enable_server_hostname_verification(enabled);
  16530. }
  16531. inline void Client::enable_system_ca(bool enabled) {
  16532. cli_->enable_system_ca(enabled);
  16533. }
  16534. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16535. inline void Client::enable_windows_certificate_verification(bool enabled) {
  16536. if (is_ssl_) {
  16537. static_cast<SSLClient &>(*cli_).enable_windows_certificate_verification(
  16538. enabled);
  16539. }
  16540. }
  16541. #endif
  16542. inline void Client::set_ca_cert_path(const std::string &ca_cert_file_path,
  16543. const std::string &ca_cert_dir_path) {
  16544. cli_->set_ca_cert_path(ca_cert_file_path, ca_cert_dir_path);
  16545. }
  16546. inline void Client::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16547. if (is_ssl_) {
  16548. static_cast<SSLClient &>(*cli_).set_ca_cert_store(ca_cert_store);
  16549. } else if (ca_cert_store) {
  16550. tls::free_ca_store(ca_cert_store);
  16551. }
  16552. }
  16553. inline void Client::load_ca_cert_store(const char *ca_cert, std::size_t size) {
  16554. if (is_ssl_) {
  16555. // Use the PEM-based path so the CA data is retained for redirect transfer
  16556. static_cast<SSLClient &>(*cli_).load_ca_cert_store(ca_cert, size);
  16557. }
  16558. }
  16559. inline void
  16560. Client::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16561. if (is_ssl_) {
  16562. static_cast<SSLClient &>(*cli_).set_server_certificate_verifier(
  16563. std::move(verifier));
  16564. }
  16565. }
  16566. inline void Client::set_session_verifier(
  16567. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16568. if (is_ssl_) {
  16569. static_cast<SSLClient &>(*cli_).set_session_verifier(std::move(verifier));
  16570. }
  16571. }
  16572. inline tls::ctx_t Client::tls_context() const {
  16573. if (is_ssl_) { return static_cast<SSLClient &>(*cli_).tls_context(); }
  16574. return nullptr;
  16575. }
  16576. #endif // CPPHTTPLIB_SSL_ENABLED
  16577. /*
  16578. * Group 7: TLS abstraction layer - Common API
  16579. */
  16580. #ifdef CPPHTTPLIB_SSL_ENABLED
  16581. namespace tls {
  16582. // Helper for PeerCert construction
  16583. inline PeerCert get_peer_cert_from_session(const_session_t session) {
  16584. return PeerCert(get_peer_cert(session));
  16585. }
  16586. namespace impl {
  16587. // set_verify_callback() can replace a callback while handshakes on other
  16588. // threads run it, so they share it, and take their reference under this lock.
  16589. inline std::mutex &verify_callback_mutex() {
  16590. static std::mutex mutex;
  16591. return mutex;
  16592. }
  16593. // The TLS libraries are C, so an exception from a verify callback must not
  16594. // unwind through them. It rejects the certificate instead.
  16595. inline bool run_verify_callback(const VerifyCallback &callback,
  16596. const VerifyContext &ctx) {
  16597. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  16598. return callback(ctx);
  16599. #else
  16600. try {
  16601. return callback(ctx);
  16602. } catch (...) { return false; }
  16603. #endif
  16604. }
  16605. // Check if a string is an IPv4 address
  16606. inline bool is_ipv4_address(const std::string &str) {
  16607. int dots = 0;
  16608. for (char c : str) {
  16609. if (c == '.') {
  16610. dots++;
  16611. } else if (!detail::is_ascii_digit(c)) {
  16612. return false;
  16613. }
  16614. }
  16615. return dots == 3;
  16616. }
  16617. // Parse IPv4 address string to bytes
  16618. inline bool parse_ipv4(const std::string &str, unsigned char *out) {
  16619. const char *p = str.c_str();
  16620. for (int i = 0; i < 4; i++) {
  16621. if (i > 0) {
  16622. if (*p != '.') { return false; }
  16623. p++;
  16624. }
  16625. int val = 0;
  16626. int digits = 0;
  16627. while (detail::is_ascii_digit(*p)) {
  16628. val = val * 10 + (*p - '0');
  16629. if (val > 255) { return false; }
  16630. p++;
  16631. digits++;
  16632. }
  16633. if (digits == 0) { return false; }
  16634. // Reject leading zeros (e.g., "01.002.03.04") to prevent ambiguity
  16635. if (digits > 1 && *(p - digits) == '0') { return false; }
  16636. out[i] = static_cast<unsigned char>(val);
  16637. }
  16638. return *p == '\0';
  16639. }
  16640. // Parse an IP literal (IPv4 or IPv6) into raw network-order bytes.
  16641. // `out` must have room for at least 16 bytes. Returns the address length
  16642. // (4 for IPv4, 16 for IPv6) on success, or 0 if the string is not an IP
  16643. // literal. Used to match a host against iPAddress SANs the same way the
  16644. // OpenSSL backend does via X509_check_ip.
  16645. inline size_t parse_ip_address(const std::string &str, unsigned char *out) {
  16646. if (is_ipv4_address(str)) { return parse_ipv4(str, out) ? 4 : 0; }
  16647. struct in6_addr addr6 = {};
  16648. if (inet_pton(AF_INET6, str.c_str(), &addr6) == 1) {
  16649. memcpy(out, &addr6, 16);
  16650. return 16;
  16651. }
  16652. return 0;
  16653. }
  16654. #ifdef _WIN32
  16655. // Enumerate Windows system certificates and call callback with DER data
  16656. template <typename Callback>
  16657. inline bool enumerate_windows_system_certs(Callback cb) {
  16658. bool loaded = false;
  16659. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16660. for (auto store_name : store_names) {
  16661. HCERTSTORE hStore = CertOpenSystemStoreW(0, store_name);
  16662. if (hStore) {
  16663. PCCERT_CONTEXT pContext = nullptr;
  16664. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16665. nullptr) {
  16666. if (cb(pContext->pbCertEncoded, pContext->cbCertEncoded)) {
  16667. loaded = true;
  16668. }
  16669. }
  16670. CertCloseStore(hStore, 0);
  16671. }
  16672. }
  16673. return loaded;
  16674. }
  16675. #endif
  16676. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16677. // Enumerate macOS Keychain certificates and call callback with DER data
  16678. template <typename Callback>
  16679. inline bool enumerate_macos_keychain_certs(Callback cb) {
  16680. bool loaded = false;
  16681. const SecTrustSettingsDomain domains[] = {
  16682. kSecTrustSettingsDomainSystem,
  16683. kSecTrustSettingsDomainAdmin,
  16684. kSecTrustSettingsDomainUser,
  16685. };
  16686. for (auto domain : domains) {
  16687. CFArrayRef certs = nullptr;
  16688. OSStatus status = SecTrustSettingsCopyCertificates(domain, &certs);
  16689. if (status != errSecSuccess || !certs) {
  16690. if (certs) CFRelease(certs);
  16691. continue;
  16692. }
  16693. CFIndex count = CFArrayGetCount(certs);
  16694. for (CFIndex i = 0; i < count; i++) {
  16695. SecCertificateRef cert =
  16696. (SecCertificateRef)CFArrayGetValueAtIndex(certs, i);
  16697. CFDataRef data = SecCertificateCopyData(cert);
  16698. if (data) {
  16699. if (cb(CFDataGetBytePtr(data),
  16700. static_cast<size_t>(CFDataGetLength(data)))) {
  16701. loaded = true;
  16702. }
  16703. CFRelease(data);
  16704. }
  16705. }
  16706. CFRelease(certs);
  16707. }
  16708. return loaded;
  16709. }
  16710. #endif
  16711. #if !defined(_WIN32) && !(defined(__APPLE__) && \
  16712. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN))
  16713. // Common CA certificate file paths on Linux/Unix
  16714. inline const char **system_ca_paths() {
  16715. static const char *paths[] = {
  16716. "/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu
  16717. "/etc/pki/tls/certs/ca-bundle.crt", // RHEL/CentOS
  16718. "/etc/ssl/ca-bundle.pem", // OpenSUSE
  16719. "/etc/pki/tls/cacert.pem", // OpenELEC
  16720. "/etc/ssl/cert.pem", // Alpine, FreeBSD
  16721. nullptr};
  16722. return paths;
  16723. }
  16724. // Common CA certificate directory paths on Linux/Unix
  16725. inline const char **system_ca_dirs() {
  16726. static const char *dirs[] = {"/etc/ssl/certs", // Debian/Ubuntu
  16727. "/etc/pki/tls/certs", // RHEL/CentOS
  16728. "/usr/share/ca-certificates", // Other
  16729. nullptr};
  16730. return dirs;
  16731. }
  16732. #endif
  16733. } // namespace impl
  16734. inline bool set_client_ca_file(ctx_t ctx, const char *ca_file,
  16735. const char *ca_dir) {
  16736. if (!ctx) { return false; }
  16737. bool success = true;
  16738. if (ca_file && *ca_file) {
  16739. if (!load_ca_file(ctx, ca_file)) { success = false; }
  16740. }
  16741. if (ca_dir && *ca_dir) {
  16742. if (!load_ca_dir(ctx, ca_dir)) { success = false; }
  16743. }
  16744. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16745. // Set CA list for client certificate request (CertificateRequest message)
  16746. if (ca_file && *ca_file) {
  16747. auto list = SSL_load_client_CA_file(ca_file);
  16748. if (list) { SSL_CTX_set_client_CA_list(static_cast<SSL_CTX *>(ctx), list); }
  16749. }
  16750. #endif
  16751. return success;
  16752. }
  16753. inline bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16754. const char *password) {
  16755. return set_client_cert_pem(ctx, cert, key, password);
  16756. }
  16757. inline bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  16758. const char *key_path, const char *password) {
  16759. return set_client_cert_file(ctx, cert_path, key_path, password);
  16760. }
  16761. // PeerCert implementation
  16762. inline PeerCert::PeerCert() = default;
  16763. inline PeerCert::PeerCert(cert_t cert) : cert_(cert) {}
  16764. inline PeerCert::PeerCert(PeerCert &&other) noexcept : cert_(other.cert_) {
  16765. other.cert_ = nullptr;
  16766. }
  16767. inline PeerCert &PeerCert::operator=(PeerCert &&other) noexcept {
  16768. if (this != &other) {
  16769. if (cert_) { free_cert(cert_); }
  16770. cert_ = other.cert_;
  16771. other.cert_ = nullptr;
  16772. }
  16773. return *this;
  16774. }
  16775. inline PeerCert::~PeerCert() {
  16776. if (cert_) { free_cert(cert_); }
  16777. }
  16778. inline PeerCert::operator bool() const { return cert_ != nullptr; }
  16779. inline std::string PeerCert::subject_cn() const {
  16780. return cert_ ? get_cert_subject_cn(cert_) : std::string();
  16781. }
  16782. inline std::string PeerCert::issuer_name() const {
  16783. return cert_ ? get_cert_issuer_name(cert_) : std::string();
  16784. }
  16785. inline bool PeerCert::check_hostname(const char *hostname) const {
  16786. return cert_ ? verify_hostname(cert_, hostname) : false;
  16787. }
  16788. inline std::vector<SanEntry> PeerCert::sans() const {
  16789. std::vector<SanEntry> result;
  16790. if (cert_) { get_cert_sans(cert_, result); }
  16791. return result;
  16792. }
  16793. inline bool PeerCert::validity(time_t &not_before, time_t &not_after) const {
  16794. return cert_ ? get_cert_validity(cert_, not_before, not_after) : false;
  16795. }
  16796. inline std::string PeerCert::serial() const {
  16797. return cert_ ? get_cert_serial(cert_) : std::string();
  16798. }
  16799. // VerifyContext method implementations
  16800. inline std::string VerifyContext::subject_cn() const {
  16801. return cert ? get_cert_subject_cn(cert) : std::string();
  16802. }
  16803. inline std::string VerifyContext::issuer_name() const {
  16804. return cert ? get_cert_issuer_name(cert) : std::string();
  16805. }
  16806. inline bool VerifyContext::check_hostname(const char *hostname) const {
  16807. return cert ? verify_hostname(cert, hostname) : false;
  16808. }
  16809. inline std::vector<SanEntry> VerifyContext::sans() const {
  16810. std::vector<SanEntry> result;
  16811. if (cert) { get_cert_sans(cert, result); }
  16812. return result;
  16813. }
  16814. inline bool VerifyContext::validity(time_t &not_before,
  16815. time_t &not_after) const {
  16816. return cert ? get_cert_validity(cert, not_before, not_after) : false;
  16817. }
  16818. inline std::string VerifyContext::serial() const {
  16819. return cert ? get_cert_serial(cert) : std::string();
  16820. }
  16821. // TlsError static method implementation
  16822. inline std::string TlsError::verify_error_to_string(long error_code) {
  16823. return verify_error_string(error_code);
  16824. }
  16825. } // namespace tls
  16826. // Request::peer_cert() implementation
  16827. inline tls::PeerCert Request::peer_cert() const {
  16828. return tls::get_peer_cert_from_session(ssl);
  16829. }
  16830. // Request::sni() implementation
  16831. inline std::string Request::sni() const {
  16832. if (!ssl) { return std::string(); }
  16833. const char *s = tls::get_sni(ssl);
  16834. return s ? std::string(s) : std::string();
  16835. }
  16836. #endif // CPPHTTPLIB_SSL_ENABLED
  16837. /*
  16838. * Group 8: TLS abstraction layer - OpenSSL backend
  16839. */
  16840. /*
  16841. * OpenSSL Backend Implementation
  16842. */
  16843. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16844. namespace tls {
  16845. namespace impl {
  16846. // Helper to map OpenSSL SSL_get_error to ErrorCode
  16847. inline ErrorCode map_ssl_error(int ssl_error, int &out_errno) {
  16848. switch (ssl_error) {
  16849. case SSL_ERROR_NONE: return ErrorCode::Success;
  16850. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  16851. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  16852. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  16853. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  16854. case SSL_ERROR_SSL:
  16855. default: return ErrorCode::Fatal;
  16856. }
  16857. }
  16858. // Helper: Create client CA list from PEM string
  16859. // Returns a new STACK_OF(X509_NAME)* or nullptr on failure
  16860. // Caller takes ownership of returned list
  16861. inline STACK_OF(X509_NAME) *
  16862. create_client_ca_list_from_pem(const char *ca_pem) {
  16863. if (!ca_pem) { return nullptr; }
  16864. auto ca_list = sk_X509_NAME_new_null();
  16865. if (!ca_list) { return nullptr; }
  16866. BIO *bio = BIO_new_mem_buf(ca_pem, -1);
  16867. if (!bio) {
  16868. sk_X509_NAME_pop_free(ca_list, X509_NAME_free);
  16869. return nullptr;
  16870. }
  16871. X509 *cert = nullptr;
  16872. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16873. nullptr) {
  16874. const X509_NAME *name = X509_get_subject_name(cert);
  16875. if (name) {
  16876. sk_X509_NAME_push(ca_list, X509_NAME_dup(const_cast<X509_NAME *>(name)));
  16877. }
  16878. X509_free(cert);
  16879. }
  16880. BIO_free(bio);
  16881. return ca_list;
  16882. }
  16883. inline void free_verify_callback(void * /*parent*/, void *ptr,
  16884. CRYPTO_EX_DATA * /*ad*/, int /*idx*/,
  16885. long /*argl*/, void * /*argp*/) {
  16886. delete static_cast<std::shared_ptr<VerifyCallback> *>(ptr);
  16887. }
  16888. // The SSL_CTX owns its verify callback, so each client or server sees only
  16889. // its own, on whichever thread runs the handshake.
  16890. inline int verify_callback_index() {
  16891. static const auto index = SSL_CTX_get_ex_new_index(
  16892. 0, nullptr, nullptr, nullptr, free_verify_callback);
  16893. return index;
  16894. }
  16895. // OpenSSL verify callback wrapper
  16896. inline int openssl_verify_callback(int preverify_ok, X509_STORE_CTX *ctx) {
  16897. // Get SSL object from X509_STORE_CTX
  16898. auto ssl = static_cast<SSL *>(
  16899. X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
  16900. if (!ssl) { return preverify_ok; }
  16901. std::shared_ptr<VerifyCallback> callback;
  16902. {
  16903. std::lock_guard<std::mutex> guard(verify_callback_mutex());
  16904. auto stored = static_cast<std::shared_ptr<VerifyCallback> *>(
  16905. SSL_CTX_get_ex_data(SSL_get_SSL_CTX(ssl), verify_callback_index()));
  16906. if (stored) { callback = *stored; }
  16907. }
  16908. if (!callback) { return preverify_ok; }
  16909. // Get current certificate and depth
  16910. auto cert = X509_STORE_CTX_get_current_cert(ctx);
  16911. int depth = X509_STORE_CTX_get_error_depth(ctx);
  16912. int error = X509_STORE_CTX_get_error(ctx);
  16913. // Build context
  16914. VerifyContext verify_ctx;
  16915. verify_ctx.session = static_cast<session_t>(ssl);
  16916. verify_ctx.cert = static_cast<cert_t>(cert);
  16917. verify_ctx.depth = depth;
  16918. verify_ctx.preverify_ok = (preverify_ok != 0);
  16919. verify_ctx.error_code = error;
  16920. verify_ctx.error_string =
  16921. (error != X509_V_OK) ? X509_verify_cert_error_string(error) : nullptr;
  16922. return run_verify_callback(*callback, verify_ctx) ? 1 : 0;
  16923. }
  16924. // Sets the verify mode from whether the peer's certificate is required and
  16925. // whether a verify callback is set.
  16926. inline void apply_verify_mode(SSL_CTX *ssl_ctx, bool require) {
  16927. auto has_callback =
  16928. SSL_CTX_get_ex_data(ssl_ctx, verify_callback_index()) != nullptr;
  16929. auto mode = require ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  16930. : (has_callback ? SSL_VERIFY_PEER : SSL_VERIFY_NONE);
  16931. SSL_CTX_set_verify(ssl_ctx, mode,
  16932. has_callback ? openssl_verify_callback : nullptr);
  16933. }
  16934. // X509_STORE_get0_objects is deprecated since OpenSSL 4.0 because it is not
  16935. // thread-safe; X509_STORE_get1_objects (OpenSSL 3.3+) returns a snapshot
  16936. // that must be released with release_store_objects
  16937. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER) && \
  16938. OPENSSL_VERSION_NUMBER >= 0x30300000L
  16939. #define CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16940. #endif
  16941. inline STACK_OF(X509_OBJECT) * get_store_objects(X509_STORE *store) {
  16942. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16943. return X509_STORE_get1_objects(store);
  16944. #else
  16945. return X509_STORE_get0_objects(store);
  16946. #endif
  16947. }
  16948. inline void release_store_objects(STACK_OF(X509_OBJECT) * objs) {
  16949. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16950. sk_X509_OBJECT_pop_free(objs, X509_OBJECT_free);
  16951. #else
  16952. (void)objs; // get0 variant returns an internal pointer; nothing to free
  16953. #endif
  16954. }
  16955. } // namespace impl
  16956. inline ctx_t create_client_context() {
  16957. SSL_CTX *ctx = SSL_CTX_new(TLS_client_method());
  16958. if (ctx) {
  16959. // Disable auto-retry to properly handle non-blocking I/O
  16960. SSL_CTX_clear_mode(ctx, SSL_MODE_AUTO_RETRY);
  16961. // Set minimum TLS version
  16962. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16963. }
  16964. return static_cast<ctx_t>(ctx);
  16965. }
  16966. inline void free_context(ctx_t ctx) {
  16967. if (ctx) { SSL_CTX_free(static_cast<SSL_CTX *>(ctx)); }
  16968. }
  16969. inline bool set_min_version(ctx_t ctx, Version version) {
  16970. if (!ctx) return false;
  16971. return SSL_CTX_set_min_proto_version(static_cast<SSL_CTX *>(ctx),
  16972. static_cast<uint16_t>(version)) == 1;
  16973. }
  16974. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  16975. if (!ctx || !pem || len == 0) return false;
  16976. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16977. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16978. if (!store) return false;
  16979. auto bio = BIO_new_mem_buf(pem, static_cast<int>(len));
  16980. if (!bio) return false;
  16981. bool ok = true;
  16982. X509 *cert = nullptr;
  16983. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16984. nullptr) {
  16985. if (X509_STORE_add_cert(store, cert) != 1) {
  16986. // Ignore duplicate errors
  16987. auto err = ERR_peek_last_error();
  16988. if (ERR_GET_REASON(err) != X509_R_CERT_ALREADY_IN_HASH_TABLE) {
  16989. ok = false;
  16990. }
  16991. }
  16992. X509_free(cert);
  16993. if (!ok) break;
  16994. }
  16995. BIO_free(bio);
  16996. // Clear any "no more certificates" errors
  16997. ERR_clear_error();
  16998. return ok;
  16999. }
  17000. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  17001. if (!ctx || !file_path) return false;
  17002. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), file_path,
  17003. nullptr) == 1;
  17004. }
  17005. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  17006. if (!ctx || !dir_path) return false;
  17007. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), nullptr,
  17008. dir_path) == 1;
  17009. }
  17010. inline bool load_system_certs(ctx_t ctx) {
  17011. if (!ctx) return false;
  17012. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17013. #ifdef _WIN32
  17014. // Windows: Load from system certificate store (ROOT and CA)
  17015. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17016. if (!store) return false;
  17017. bool loaded_any = false;
  17018. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  17019. for (auto store_name : store_names) {
  17020. auto hStore = CertOpenSystemStoreW(NULL, store_name);
  17021. if (!hStore) continue;
  17022. PCCERT_CONTEXT pContext = nullptr;
  17023. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  17024. nullptr) {
  17025. const unsigned char *data = pContext->pbCertEncoded;
  17026. auto x509 = d2i_X509(nullptr, &data, pContext->cbCertEncoded);
  17027. if (x509) {
  17028. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  17029. X509_free(x509);
  17030. }
  17031. }
  17032. CertCloseStore(hStore, 0);
  17033. }
  17034. return loaded_any;
  17035. #elif defined(__APPLE__)
  17036. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  17037. // macOS: Load from Keychain
  17038. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17039. if (!store) return false;
  17040. bool loaded_any = false;
  17041. const SecTrustSettingsDomain domains[] = {
  17042. kSecTrustSettingsDomainSystem,
  17043. kSecTrustSettingsDomainAdmin,
  17044. kSecTrustSettingsDomainUser,
  17045. };
  17046. for (auto domain : domains) {
  17047. CFArrayRef certs = nullptr;
  17048. if (SecTrustSettingsCopyCertificates(domain, &certs) != errSecSuccess ||
  17049. !certs) {
  17050. if (certs) CFRelease(certs);
  17051. continue;
  17052. }
  17053. auto count = CFArrayGetCount(certs);
  17054. for (CFIndex i = 0; i < count; i++) {
  17055. auto cert = reinterpret_cast<SecCertificateRef>(
  17056. const_cast<void *>(CFArrayGetValueAtIndex(certs, i)));
  17057. CFDataRef der = SecCertificateCopyData(cert);
  17058. if (der) {
  17059. const unsigned char *data = CFDataGetBytePtr(der);
  17060. auto x509 = d2i_X509(nullptr, &data, CFDataGetLength(der));
  17061. if (x509) {
  17062. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  17063. X509_free(x509);
  17064. }
  17065. CFRelease(der);
  17066. }
  17067. }
  17068. CFRelease(certs);
  17069. }
  17070. return loaded_any || SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17071. #else
  17072. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17073. #endif
  17074. #else
  17075. // Other Unix: use default verify paths
  17076. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17077. #endif
  17078. }
  17079. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17080. const char *password) {
  17081. if (!ctx || !cert || !key) return false;
  17082. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17083. // Load certificate
  17084. auto cert_bio = BIO_new_mem_buf(cert, -1);
  17085. if (!cert_bio) return false;
  17086. auto x509 = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  17087. BIO_free(cert_bio);
  17088. if (!x509) return false;
  17089. auto cert_ok = SSL_CTX_use_certificate(ssl_ctx, x509) == 1;
  17090. X509_free(x509);
  17091. if (!cert_ok) return false;
  17092. // Load private key
  17093. auto key_bio = BIO_new_mem_buf(key, -1);
  17094. if (!key_bio) return false;
  17095. auto pkey = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  17096. password ? const_cast<char *>(password)
  17097. : nullptr);
  17098. BIO_free(key_bio);
  17099. if (!pkey) return false;
  17100. auto key_ok = SSL_CTX_use_PrivateKey(ssl_ctx, pkey) == 1;
  17101. EVP_PKEY_free(pkey);
  17102. return key_ok && SSL_CTX_check_private_key(ssl_ctx) == 1;
  17103. }
  17104. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  17105. const char *key_path, const char *password) {
  17106. if (!ctx || !cert_path || !key_path) return false;
  17107. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17108. if (password && password[0] != '\0') {
  17109. SSL_CTX_set_default_passwd_cb_userdata(
  17110. ssl_ctx, reinterpret_cast<void *>(const_cast<char *>(password)));
  17111. }
  17112. return SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_path) == 1 &&
  17113. SSL_CTX_use_PrivateKey_file(ssl_ctx, key_path, SSL_FILETYPE_PEM) == 1;
  17114. }
  17115. inline ctx_t create_server_context() {
  17116. SSL_CTX *ctx = SSL_CTX_new(TLS_server_method());
  17117. if (ctx) {
  17118. // No renegotiation, as on the other backends: it would run a handshake
  17119. // that SSLServer::update_certs_pem() does not wait for
  17120. SSL_CTX_set_options(ctx, SSL_OP_NO_COMPRESSION |
  17121. SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION |
  17122. SSL_OP_NO_RENEGOTIATION);
  17123. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  17124. // Without one, a client resuming its session is sent a fatal alert once
  17125. // client certificates are verified.
  17126. static const unsigned char sid_ctx[] = "cpp-httplib";
  17127. SSL_CTX_set_session_id_context(ctx, sid_ctx, sizeof(sid_ctx) - 1);
  17128. }
  17129. return static_cast<ctx_t>(ctx);
  17130. }
  17131. inline void set_verify_client(ctx_t ctx, bool require) {
  17132. if (!ctx) return;
  17133. impl::apply_verify_mode(static_cast<SSL_CTX *>(ctx), require);
  17134. }
  17135. inline session_t create_session(ctx_t ctx, socket_t sock) {
  17136. if (!ctx || sock == INVALID_SOCKET) return nullptr;
  17137. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17138. SSL *ssl = SSL_new(ssl_ctx);
  17139. if (!ssl) return nullptr;
  17140. // Disable auto-retry for proper non-blocking I/O handling
  17141. SSL_clear_mode(ssl, SSL_MODE_AUTO_RETRY);
  17142. auto bio = BIO_new_socket(static_cast<int>(sock), BIO_NOCLOSE);
  17143. if (!bio) {
  17144. SSL_free(ssl);
  17145. return nullptr;
  17146. }
  17147. SSL_set_bio(ssl, bio, bio);
  17148. return static_cast<session_t>(ssl);
  17149. }
  17150. inline void free_session(session_t session) {
  17151. if (session) { SSL_free(static_cast<SSL *>(session)); }
  17152. }
  17153. inline bool set_sni(session_t session, const char *hostname,
  17154. bool /*verify_hostname*/) {
  17155. if (!session || !hostname) return false;
  17156. auto ssl = static_cast<SSL *>(session);
  17157. // Set SNI (Server Name Indication) only - does not enable verification.
  17158. // OpenSSL never binds identity checking to SNI (that happens post-
  17159. // handshake in setup_client_tls_session()), so verify_hostname is unused.
  17160. #if defined(OPENSSL_IS_BORINGSSL)
  17161. return SSL_set_tlsext_host_name(ssl, hostname) == 1;
  17162. #else
  17163. // Direct call instead of macro to suppress -Wold-style-cast warning
  17164. return SSL_ctrl(ssl, SSL_CTRL_SET_TLSEXT_HOSTNAME, TLSEXT_NAMETYPE_host_name,
  17165. static_cast<void *>(const_cast<char *>(hostname))) == 1;
  17166. #endif
  17167. }
  17168. inline TlsError connect(session_t session) {
  17169. if (!session) { return TlsError(); }
  17170. auto ssl = static_cast<SSL *>(session);
  17171. auto ret = SSL_connect(ssl);
  17172. TlsError err;
  17173. if (ret == 1) {
  17174. err.code = ErrorCode::Success;
  17175. } else {
  17176. auto ssl_err = SSL_get_error(ssl, ret);
  17177. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17178. err.backend_code = ERR_get_error();
  17179. }
  17180. return err;
  17181. }
  17182. inline TlsError accept(session_t session) {
  17183. if (!session) { return TlsError(); }
  17184. auto ssl = static_cast<SSL *>(session);
  17185. auto ret = SSL_accept(ssl);
  17186. TlsError err;
  17187. if (ret == 1) {
  17188. err.code = ErrorCode::Success;
  17189. } else {
  17190. auto ssl_err = SSL_get_error(ssl, ret);
  17191. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17192. err.backend_code = ERR_get_error();
  17193. }
  17194. return err;
  17195. }
  17196. inline bool connect_nonblocking(session_t session, socket_t sock,
  17197. time_t timeout_sec, time_t timeout_usec,
  17198. TlsError *err) {
  17199. if (!session) {
  17200. if (err) { err->code = ErrorCode::Fatal; }
  17201. return false;
  17202. }
  17203. auto ssl = static_cast<SSL *>(session);
  17204. auto bio = SSL_get_rbio(ssl);
  17205. // Set non-blocking mode for handshake
  17206. detail::set_nonblocking(sock, true);
  17207. if (bio) { BIO_set_nbio(bio, 1); }
  17208. auto cleanup = detail::scope_exit([&]() {
  17209. // Restore blocking mode after handshake
  17210. if (bio) { BIO_set_nbio(bio, 0); }
  17211. detail::set_nonblocking(sock, false);
  17212. });
  17213. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  17214. auto res = 0;
  17215. while ((res = SSL_connect(ssl)) != 1) {
  17216. auto ssl_err = SSL_get_error(ssl, res);
  17217. switch (ssl_err) {
  17218. case SSL_ERROR_WANT_READ:
  17219. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  17220. break;
  17221. case SSL_ERROR_WANT_WRITE:
  17222. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  17223. break;
  17224. default: break;
  17225. }
  17226. if (err) {
  17227. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  17228. err->backend_code = ERR_get_error();
  17229. }
  17230. return false;
  17231. }
  17232. if (err) { err->code = ErrorCode::Success; }
  17233. return true;
  17234. }
  17235. inline bool accept_nonblocking(session_t session, socket_t sock,
  17236. time_t timeout_sec, time_t timeout_usec,
  17237. TlsError *err) {
  17238. if (!session) {
  17239. if (err) { err->code = ErrorCode::Fatal; }
  17240. return false;
  17241. }
  17242. auto ssl = static_cast<SSL *>(session);
  17243. auto bio = SSL_get_rbio(ssl);
  17244. // Set non-blocking mode for handshake
  17245. detail::set_nonblocking(sock, true);
  17246. if (bio) { BIO_set_nbio(bio, 1); }
  17247. auto cleanup = detail::scope_exit([&]() {
  17248. // Restore blocking mode after handshake
  17249. if (bio) { BIO_set_nbio(bio, 0); }
  17250. detail::set_nonblocking(sock, false);
  17251. });
  17252. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  17253. auto res = 0;
  17254. while ((res = SSL_accept(ssl)) != 1) {
  17255. auto ssl_err = SSL_get_error(ssl, res);
  17256. switch (ssl_err) {
  17257. case SSL_ERROR_WANT_READ:
  17258. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  17259. break;
  17260. case SSL_ERROR_WANT_WRITE:
  17261. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  17262. break;
  17263. default: break;
  17264. }
  17265. if (err) {
  17266. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  17267. err->backend_code = ERR_get_error();
  17268. }
  17269. return false;
  17270. }
  17271. if (err) { err->code = ErrorCode::Success; }
  17272. return true;
  17273. }
  17274. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  17275. if (!session || !buf) {
  17276. err.code = ErrorCode::Fatal;
  17277. return -1;
  17278. }
  17279. auto ssl = static_cast<SSL *>(session);
  17280. constexpr auto max_len =
  17281. static_cast<size_t>((std::numeric_limits<int>::max)());
  17282. if (len > max_len) { len = max_len; }
  17283. auto ret = SSL_read(ssl, buf, static_cast<int>(len));
  17284. if (ret > 0) {
  17285. err.code = ErrorCode::Success;
  17286. return ret;
  17287. }
  17288. auto ssl_err = SSL_get_error(ssl, ret);
  17289. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17290. if (err.code == ErrorCode::PeerClosed) {
  17291. return 0;
  17292. } // Gracefully handle the peer closed state.
  17293. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  17294. return -1;
  17295. }
  17296. inline ssize_t write(session_t session, const void *buf, size_t len,
  17297. TlsError &err) {
  17298. if (!session || !buf) {
  17299. err.code = ErrorCode::Fatal;
  17300. return -1;
  17301. }
  17302. auto ssl = static_cast<SSL *>(session);
  17303. auto ret = SSL_write(ssl, buf, static_cast<int>(len));
  17304. if (ret > 0) {
  17305. err.code = ErrorCode::Success;
  17306. return ret;
  17307. }
  17308. auto ssl_err = SSL_get_error(ssl, ret);
  17309. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17310. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  17311. return -1;
  17312. }
  17313. inline int pending(const_session_t session) {
  17314. if (!session) return 0;
  17315. return SSL_pending(static_cast<SSL *>(const_cast<void *>(session)));
  17316. }
  17317. inline void shutdown(session_t session, bool graceful) {
  17318. if (!session) return;
  17319. auto ssl = static_cast<SSL *>(session);
  17320. if (graceful) {
  17321. // Send close_notify without waiting for the peer's. The connection is
  17322. // closed right after this, so a unidirectional shutdown is enough, and an
  17323. // idle peer that never answers would otherwise hold this thread until the
  17324. // read timeout. The other backends do not wait either.
  17325. SSL_shutdown(ssl);
  17326. }
  17327. }
  17328. inline bool is_peer_closed(session_t session, socket_t sock) {
  17329. if (!session) return true;
  17330. // Temporarily set socket to non-blocking to avoid blocking on SSL_peek
  17331. detail::set_nonblocking(sock, true);
  17332. auto se = detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17333. auto ssl = static_cast<SSL *>(session);
  17334. char buf;
  17335. auto ret = SSL_peek(ssl, &buf, 1);
  17336. if (ret > 0) return false;
  17337. auto err = SSL_get_error(ssl, ret);
  17338. return err == SSL_ERROR_ZERO_RETURN;
  17339. }
  17340. inline cert_t get_peer_cert(const_session_t session) {
  17341. if (!session) return nullptr;
  17342. return static_cast<cert_t>(SSL_get1_peer_certificate(
  17343. static_cast<SSL *>(const_cast<void *>(session))));
  17344. }
  17345. inline size_t get_peer_certs(const_session_t session,
  17346. std::vector<cert_t> &certs) {
  17347. certs.clear();
  17348. if (!session) { return 0; }
  17349. auto ssl = static_cast<const SSL *>(session);
  17350. // On the server side, the chain leaves out the peer's own certificate
  17351. if (SSL_is_server(ssl)) {
  17352. if (auto leaf = get_peer_cert(session)) { certs.push_back(leaf); }
  17353. }
  17354. if (auto sk = SSL_get_peer_cert_chain(ssl)) {
  17355. auto count = sk_X509_num(sk);
  17356. for (decltype(count) i = 0; i < count; i++) {
  17357. auto x509 = sk_X509_value(sk, i);
  17358. X509_up_ref(x509);
  17359. certs.push_back(static_cast<cert_t>(x509));
  17360. }
  17361. }
  17362. return certs.size();
  17363. }
  17364. inline void free_cert(cert_t cert) {
  17365. if (cert) { X509_free(static_cast<X509 *>(cert)); }
  17366. }
  17367. inline bool verify_hostname(cert_t cert, const char *hostname) {
  17368. if (!cert || !hostname) return false;
  17369. auto x509 = static_cast<X509 *>(cert);
  17370. // Use X509_check_ip_asc for IP addresses, X509_check_host for DNS names
  17371. if (detail::is_ip_address(hostname)) {
  17372. return X509_check_ip_asc(x509, hostname, 0) == 1;
  17373. }
  17374. return X509_check_host(x509, hostname, strlen(hostname), 0, nullptr) == 1;
  17375. }
  17376. inline uint64_t hostname_mismatch_code() {
  17377. return static_cast<uint64_t>(X509_V_ERR_HOSTNAME_MISMATCH);
  17378. }
  17379. inline long get_verify_result(const_session_t session) {
  17380. if (!session) return X509_V_ERR_UNSPECIFIED;
  17381. return SSL_get_verify_result(static_cast<SSL *>(const_cast<void *>(session)));
  17382. }
  17383. inline std::string get_cert_subject_cn(cert_t cert) {
  17384. if (!cert) return "";
  17385. auto x509 = static_cast<X509 *>(cert);
  17386. auto subject_name = X509_get_subject_name(x509);
  17387. if (!subject_name) return "";
  17388. // X509_NAME_get_text_by_NID is deprecated since OpenSSL 4.0
  17389. auto idx = X509_NAME_get_index_by_NID(subject_name, NID_commonName, -1);
  17390. if (idx < 0) return "";
  17391. auto entry = X509_NAME_get_entry(subject_name, idx);
  17392. if (!entry) return "";
  17393. auto data = X509_NAME_ENTRY_get_data(entry);
  17394. if (!data) return "";
  17395. return std::string(
  17396. reinterpret_cast<const char *>(ASN1_STRING_get0_data(data)),
  17397. static_cast<size_t>(ASN1_STRING_length(data)));
  17398. }
  17399. inline std::string get_cert_issuer_name(cert_t cert) {
  17400. if (!cert) return "";
  17401. auto x509 = static_cast<X509 *>(cert);
  17402. auto issuer_name = X509_get_issuer_name(x509);
  17403. if (!issuer_name) return "";
  17404. char buf[256];
  17405. X509_NAME_oneline(issuer_name, buf, sizeof(buf));
  17406. return std::string(buf);
  17407. }
  17408. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  17409. sans.clear();
  17410. if (!cert) return false;
  17411. auto x509 = static_cast<X509 *>(cert);
  17412. auto names = static_cast<GENERAL_NAMES *>(
  17413. X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  17414. if (!names) return true; // No SANs is valid
  17415. auto count = sk_GENERAL_NAME_num(names);
  17416. for (decltype(count) i = 0; i < count; i++) {
  17417. auto gen = sk_GENERAL_NAME_value(names, i);
  17418. if (!gen) continue;
  17419. SanEntry entry;
  17420. switch (gen->type) {
  17421. case GEN_DNS:
  17422. entry.type = SanType::DNS;
  17423. if (gen->d.dNSName) {
  17424. entry.value = std::string(
  17425. reinterpret_cast<const char *>(
  17426. ASN1_STRING_get0_data(gen->d.dNSName)),
  17427. static_cast<size_t>(ASN1_STRING_length(gen->d.dNSName)));
  17428. }
  17429. break;
  17430. case GEN_IPADD:
  17431. entry.type = SanType::IP;
  17432. if (gen->d.iPAddress) {
  17433. auto data = ASN1_STRING_get0_data(gen->d.iPAddress);
  17434. auto len = ASN1_STRING_length(gen->d.iPAddress);
  17435. if (len == 4) {
  17436. // IPv4
  17437. char buf[INET_ADDRSTRLEN];
  17438. inet_ntop(AF_INET, data, buf, sizeof(buf));
  17439. entry.value = buf;
  17440. } else if (len == 16) {
  17441. // IPv6
  17442. char buf[INET6_ADDRSTRLEN];
  17443. inet_ntop(AF_INET6, data, buf, sizeof(buf));
  17444. entry.value = buf;
  17445. }
  17446. }
  17447. break;
  17448. case GEN_EMAIL:
  17449. entry.type = SanType::EMAIL;
  17450. if (gen->d.rfc822Name) {
  17451. entry.value = std::string(
  17452. reinterpret_cast<const char *>(
  17453. ASN1_STRING_get0_data(gen->d.rfc822Name)),
  17454. static_cast<size_t>(ASN1_STRING_length(gen->d.rfc822Name)));
  17455. }
  17456. break;
  17457. case GEN_URI:
  17458. entry.type = SanType::URI;
  17459. if (gen->d.uniformResourceIdentifier) {
  17460. entry.value = std::string(
  17461. reinterpret_cast<const char *>(
  17462. ASN1_STRING_get0_data(gen->d.uniformResourceIdentifier)),
  17463. static_cast<size_t>(
  17464. ASN1_STRING_length(gen->d.uniformResourceIdentifier)));
  17465. }
  17466. break;
  17467. default: entry.type = SanType::OTHER; break;
  17468. }
  17469. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  17470. }
  17471. GENERAL_NAMES_free(names);
  17472. return true;
  17473. }
  17474. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  17475. time_t &not_after) {
  17476. if (!cert) return false;
  17477. auto x509 = static_cast<X509 *>(cert);
  17478. auto nb = X509_get0_notBefore(x509);
  17479. auto na = X509_get0_notAfter(x509);
  17480. if (!nb || !na) return false;
  17481. ASN1_TIME *epoch = ASN1_TIME_new();
  17482. if (!epoch) return false;
  17483. auto se = detail::scope_exit([&] { ASN1_TIME_free(epoch); });
  17484. if (!ASN1_TIME_set(epoch, 0)) return false;
  17485. int pday, psec;
  17486. if (!ASN1_TIME_diff(&pday, &psec, epoch, nb)) return false;
  17487. not_before = 86400 * (time_t)pday + psec;
  17488. if (!ASN1_TIME_diff(&pday, &psec, epoch, na)) return false;
  17489. not_after = 86400 * (time_t)pday + psec;
  17490. return true;
  17491. }
  17492. inline std::string get_cert_serial(cert_t cert) {
  17493. if (!cert) return "";
  17494. auto x509 = static_cast<X509 *>(cert);
  17495. auto serial = X509_get_serialNumber(x509);
  17496. if (!serial) return "";
  17497. auto bn = ASN1_INTEGER_to_BN(serial, nullptr);
  17498. if (!bn) return "";
  17499. auto hex = BN_bn2hex(bn);
  17500. BN_free(bn);
  17501. if (!hex) return "";
  17502. std::string result(hex);
  17503. OPENSSL_free(hex);
  17504. return result;
  17505. }
  17506. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  17507. if (!cert) return false;
  17508. auto x509 = static_cast<X509 *>(cert);
  17509. auto len = i2d_X509(x509, nullptr);
  17510. if (len < 0) return false;
  17511. der.resize(static_cast<size_t>(len));
  17512. auto p = der.data();
  17513. i2d_X509(x509, &p);
  17514. return true;
  17515. }
  17516. inline const char *get_sni(const_session_t session) {
  17517. if (!session) return nullptr;
  17518. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17519. return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
  17520. }
  17521. inline uint64_t peek_error() { return ERR_peek_last_error(); }
  17522. inline uint64_t get_error() { return ERR_get_error(); }
  17523. inline std::string error_string(uint64_t code) {
  17524. char buf[256];
  17525. ERR_error_string_n(static_cast<decltype(ERR_get_error())>(code), buf,
  17526. sizeof(buf));
  17527. return std::string(buf);
  17528. }
  17529. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  17530. auto mem = BIO_new_mem_buf(pem, static_cast<int>(len));
  17531. if (!mem) { return nullptr; }
  17532. auto mem_guard = detail::scope_exit([&] { BIO_free_all(mem); });
  17533. auto inf = PEM_X509_INFO_read_bio(mem, nullptr, nullptr, nullptr);
  17534. if (!inf) { return nullptr; }
  17535. auto store = X509_STORE_new();
  17536. if (store) {
  17537. auto count = sk_X509_INFO_num(inf);
  17538. for (decltype(count) i = 0; i < count; i++) {
  17539. auto itmp = sk_X509_INFO_value(inf, i);
  17540. if (!itmp) { continue; }
  17541. if (itmp->x509) { X509_STORE_add_cert(store, itmp->x509); }
  17542. if (itmp->crl) { X509_STORE_add_crl(store, itmp->crl); }
  17543. }
  17544. }
  17545. sk_X509_INFO_pop_free(inf, X509_INFO_free);
  17546. return static_cast<ca_store_t>(store);
  17547. }
  17548. inline void free_ca_store(ca_store_t store) {
  17549. if (store) { X509_STORE_free(static_cast<X509_STORE *>(store)); }
  17550. }
  17551. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  17552. if (!ctx || !store) { return false; }
  17553. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17554. auto x509_store = static_cast<X509_STORE *>(store);
  17555. // Check if same store is already set
  17556. if (SSL_CTX_get_cert_store(ssl_ctx) == x509_store) { return true; }
  17557. // SSL_CTX_set_cert_store takes ownership and frees the old store
  17558. SSL_CTX_set_cert_store(ssl_ctx, x509_store);
  17559. return true;
  17560. }
  17561. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  17562. certs.clear();
  17563. if (!ctx) { return 0; }
  17564. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17565. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17566. if (!store) { return 0; }
  17567. auto objs = impl::get_store_objects(store);
  17568. if (!objs) { return 0; }
  17569. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  17570. auto count = sk_X509_OBJECT_num(objs);
  17571. for (decltype(count) i = 0; i < count; i++) {
  17572. auto obj = sk_X509_OBJECT_value(objs, i);
  17573. if (!obj) { continue; }
  17574. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  17575. auto x509 = X509_OBJECT_get0_X509(obj);
  17576. if (x509) {
  17577. // Increment reference count so caller can free it
  17578. X509_up_ref(x509);
  17579. certs.push_back(static_cast<cert_t>(x509));
  17580. }
  17581. }
  17582. }
  17583. return certs.size();
  17584. }
  17585. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  17586. std::vector<std::string> names;
  17587. if (!ctx) { return names; }
  17588. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17589. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17590. if (!store) { return names; }
  17591. auto objs = impl::get_store_objects(store);
  17592. if (!objs) { return names; }
  17593. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  17594. auto count = sk_X509_OBJECT_num(objs);
  17595. for (decltype(count) i = 0; i < count; i++) {
  17596. auto obj = sk_X509_OBJECT_value(objs, i);
  17597. if (!obj) { continue; }
  17598. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  17599. auto x509 = X509_OBJECT_get0_X509(obj);
  17600. if (x509) {
  17601. auto subject = X509_get_subject_name(x509);
  17602. if (subject) {
  17603. char buf[512];
  17604. X509_NAME_oneline(subject, buf, sizeof(buf));
  17605. names.push_back(buf);
  17606. }
  17607. }
  17608. }
  17609. }
  17610. return names;
  17611. }
  17612. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  17613. const char *key_pem, const char *password) {
  17614. if (!ctx || !cert_pem || !key_pem) { return false; }
  17615. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17616. // Load certificate from PEM
  17617. auto cert_bio = BIO_new_mem_buf(cert_pem, -1);
  17618. if (!cert_bio) { return false; }
  17619. auto cert = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  17620. BIO_free(cert_bio);
  17621. if (!cert) { return false; }
  17622. // Load private key from PEM
  17623. auto key_bio = BIO_new_mem_buf(key_pem, -1);
  17624. if (!key_bio) {
  17625. X509_free(cert);
  17626. return false;
  17627. }
  17628. auto key = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  17629. password ? const_cast<char *>(password)
  17630. : nullptr);
  17631. BIO_free(key_bio);
  17632. if (!key) {
  17633. X509_free(cert);
  17634. return false;
  17635. }
  17636. // Update certificate and key
  17637. auto ret = SSL_CTX_use_certificate(ssl_ctx, cert) == 1 &&
  17638. SSL_CTX_use_PrivateKey(ssl_ctx, key) == 1;
  17639. X509_free(cert);
  17640. EVP_PKEY_free(key);
  17641. return ret;
  17642. }
  17643. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  17644. if (!ctx || !ca_pem) { return false; }
  17645. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17646. // Create new X509_STORE from PEM
  17647. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  17648. if (!store) { return false; }
  17649. // A resumed session is not verified again, so the ticket keys from before
  17650. // go, or a client verified under the old CAs could go on resuming.
  17651. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  17652. unsigned char ticket_keys[48];
  17653. #else
  17654. unsigned char ticket_keys[80];
  17655. #endif
  17656. if (RAND_bytes(ticket_keys, sizeof(ticket_keys)) != 1 ||
  17657. SSL_CTX_set_tlsext_ticket_keys(ssl_ctx, ticket_keys,
  17658. sizeof(ticket_keys)) != 1) {
  17659. free_ca_store(store);
  17660. return false;
  17661. }
  17662. // SSL_CTX_set_cert_store takes ownership
  17663. SSL_CTX_set_cert_store(ssl_ctx, static_cast<X509_STORE *>(store));
  17664. // Set client CA list for client certificate request
  17665. auto ca_list = impl::create_client_ca_list_from_pem(ca_pem);
  17666. if (ca_list) {
  17667. // SSL_CTX_set_client_CA_list takes ownership of ca_list
  17668. SSL_CTX_set_client_CA_list(ssl_ctx, ca_list);
  17669. }
  17670. // The cached sessions go for the same reason.
  17671. #if OPENSSL_VERSION_NUMBER >= 0x30400000L
  17672. SSL_CTX_flush_sessions_ex(ssl_ctx, (std::numeric_limits<time_t>::max)());
  17673. #else
  17674. SSL_CTX_flush_sessions(ssl_ctx, (std::numeric_limits<long>::max)());
  17675. #endif
  17676. return true;
  17677. }
  17678. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  17679. if (!ctx) { return false; }
  17680. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17681. auto index = impl::verify_callback_index();
  17682. if (index < 0) { return false; }
  17683. std::shared_ptr<VerifyCallback> *stored = nullptr;
  17684. if (callback) {
  17685. stored = new std::shared_ptr<VerifyCallback>(
  17686. std::make_shared<VerifyCallback>(std::move(callback)));
  17687. }
  17688. std::shared_ptr<VerifyCallback> *previous = nullptr;
  17689. {
  17690. std::lock_guard<std::mutex> guard(impl::verify_callback_mutex());
  17691. previous = static_cast<std::shared_ptr<VerifyCallback> *>(
  17692. SSL_CTX_get_ex_data(ssl_ctx, index));
  17693. if (SSL_CTX_set_ex_data(ssl_ctx, index, stored) != 1) {
  17694. delete stored;
  17695. return false;
  17696. }
  17697. }
  17698. // A handshake running the previous callback keeps it until it returns.
  17699. delete previous;
  17700. // A resumed handshake shows no certificate to run the callback on.
  17701. if (stored) {
  17702. SSL_CTX_set_options(ssl_ctx, SSL_OP_NO_TICKET);
  17703. SSL_CTX_set_session_cache_mode(ssl_ctx, SSL_SESS_CACHE_OFF);
  17704. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER)
  17705. // TLS 1.3 tickets, which SSL_OP_NO_TICKET leaves on
  17706. SSL_CTX_set_num_tickets(ssl_ctx, 0);
  17707. #endif
  17708. }
  17709. // Keep requiring the peer's certificate if set_verify_client() asked for it
  17710. auto require =
  17711. (SSL_CTX_get_verify_mode(ssl_ctx) & SSL_VERIFY_FAIL_IF_NO_PEER_CERT) != 0;
  17712. impl::apply_verify_mode(ssl_ctx, require);
  17713. return true;
  17714. }
  17715. inline long get_verify_error(const_session_t session) {
  17716. if (!session) { return -1; }
  17717. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17718. return SSL_get_verify_result(ssl);
  17719. }
  17720. inline std::string verify_error_string(long error_code) {
  17721. if (error_code == X509_V_OK) { return ""; }
  17722. const char *str = X509_verify_cert_error_string(static_cast<int>(error_code));
  17723. return str ? str : "unknown error";
  17724. }
  17725. } // namespace tls
  17726. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  17727. /*
  17728. * Group 9: TLS abstraction layer - Mbed TLS backend
  17729. */
  17730. /*
  17731. * Mbed TLS Backend Implementation
  17732. */
  17733. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  17734. namespace tls {
  17735. namespace impl {
  17736. // Mbed TLS session wrapper
  17737. struct MbedTlsSession {
  17738. mbedtls_ssl_context ssl;
  17739. socket_t sock = INVALID_SOCKET;
  17740. std::string hostname; // For client: set via set_sni
  17741. std::string sni_hostname; // For server: received from client via SNI callback
  17742. // Mbed TLS has no SSL_peek() equivalent, so is_peer_closed() must probe with
  17743. // a real 1-byte mbedtls_ssl_read(). If that probe lands on application data
  17744. // (e.g. a response that arrived while this side was still in its post-write
  17745. // check), the byte is pushed back here and served by the next read().
  17746. unsigned char peeked_byte = 0;
  17747. bool has_peeked_byte = false;
  17748. // Set by set_sni() when the caller disabled hostname verification, so the
  17749. // verify callback can clear the CN/SAN mismatch flag while still enforcing
  17750. // the rest of the chain (Mbed TLS ties SNI and identity checking together;
  17751. // OpenSSL and wolfSSL keep them independent).
  17752. bool suppress_hostname_mismatch = false;
  17753. // Copied from the owning MbedTlsContext at creation, so a handshake only
  17754. // ever runs the callback of its own context.
  17755. VerifyCallback verify_callback;
  17756. bool is_server = false;
  17757. MbedTlsSession() { mbedtls_ssl_init(&ssl); }
  17758. ~MbedTlsSession() { mbedtls_ssl_free(&ssl); }
  17759. MbedTlsSession(const MbedTlsSession &) = delete;
  17760. MbedTlsSession &operator=(const MbedTlsSession &) = delete;
  17761. };
  17762. // Thread-local error code accessor for Mbed TLS (since it doesn't have an error
  17763. // queue)
  17764. inline int &mbedtls_last_error() {
  17765. static thread_local int err = 0;
  17766. return err;
  17767. }
  17768. // Helper to map Mbed TLS error to ErrorCode
  17769. inline ErrorCode map_mbedtls_error(int ret, int &out_errno,
  17770. uint32_t verify_flags) {
  17771. if (ret == 0) { return ErrorCode::Success; }
  17772. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return ErrorCode::WantRead; }
  17773. if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) { return ErrorCode::WantWrite; }
  17774. if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
  17775. return ErrorCode::PeerClosed;
  17776. }
  17777. if (ret == MBEDTLS_ERR_NET_CONN_RESET || ret == MBEDTLS_ERR_NET_SEND_FAILED ||
  17778. ret == MBEDTLS_ERR_NET_RECV_FAILED) {
  17779. out_errno = errno;
  17780. return ErrorCode::SyscallError;
  17781. }
  17782. if (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED) {
  17783. // Unlike OpenSSL/wolfSSL, Mbed TLS folds the CN/SAN identity check into
  17784. // the handshake's chain verification (see set_sni()); a mismatch there
  17785. // is reported the same way as any other verify_flags bit. Report it as
  17786. // HostnameMismatch, matching the other backends and the post-handshake
  17787. // identity check below, but only when naming is the sole problem -
  17788. // if the chain itself is also untrusted/expired/etc., that takes
  17789. // priority over the naming detail.
  17790. if (verify_flags == static_cast<uint32_t>(hostname_mismatch_code())) {
  17791. return ErrorCode::HostnameMismatch;
  17792. }
  17793. return ErrorCode::CertVerifyFailed;
  17794. }
  17795. return ErrorCode::Fatal;
  17796. }
  17797. // Populates a TlsError from a failed (non-zero) mbedtls_ssl_handshake()
  17798. // return value, including the verify-flags-dependent HostnameMismatch
  17799. // mapping; shared by connect() and connect_nonblocking() so the
  17800. // backend_code policy for that mapping only lives in one place.
  17801. inline void fill_mbedtls_tls_error(TlsError &err, mbedtls_ssl_context &ssl,
  17802. int ret) {
  17803. auto verify_flags = mbedtls_ssl_get_verify_result(&ssl);
  17804. err.code = map_mbedtls_error(ret, err.sys_errno, verify_flags);
  17805. err.backend_code = err.code == ErrorCode::HostnameMismatch
  17806. ? static_cast<uint64_t>(verify_flags)
  17807. : static_cast<uint64_t>(-ret);
  17808. }
  17809. // A TLS 1.3 NewSessionTicket (signaled by default on Mbed TLS 4.x) is a
  17810. // non-fatal notification delivered between records, not an error and not
  17811. // application data, so I/O calls that see it should just be retried. Kept in
  17812. // one helper so the retry loops keep an intact "do { } while (...)" instead of
  17813. // splitting the closing brace across an #if.
  17814. inline bool mbedtls_is_session_ticket(int ret) {
  17815. #if defined(MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET)
  17816. return ret == MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
  17817. #else
  17818. (void)ret;
  17819. return false;
  17820. #endif
  17821. }
  17822. // BIO-like send callback for Mbed TLS
  17823. inline int mbedtls_net_send_cb(void *ctx, const unsigned char *buf,
  17824. size_t len) {
  17825. auto sock = *static_cast<socket_t *>(ctx);
  17826. #ifdef _WIN32
  17827. auto ret =
  17828. send(sock, reinterpret_cast<const char *>(buf), static_cast<int>(len), 0);
  17829. if (ret == SOCKET_ERROR) {
  17830. int err = WSAGetLastError();
  17831. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_WRITE; }
  17832. return MBEDTLS_ERR_NET_SEND_FAILED;
  17833. }
  17834. #else
  17835. auto ret = send(sock, buf, len, 0);
  17836. if (ret < 0) {
  17837. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17838. return MBEDTLS_ERR_SSL_WANT_WRITE;
  17839. }
  17840. return MBEDTLS_ERR_NET_SEND_FAILED;
  17841. }
  17842. #endif
  17843. return static_cast<int>(ret);
  17844. }
  17845. // BIO-like recv callback for Mbed TLS
  17846. inline int mbedtls_net_recv_cb(void *ctx, unsigned char *buf, size_t len) {
  17847. auto sock = *static_cast<socket_t *>(ctx);
  17848. #ifdef _WIN32
  17849. auto ret =
  17850. recv(sock, reinterpret_cast<char *>(buf), static_cast<int>(len), 0);
  17851. if (ret == SOCKET_ERROR) {
  17852. int err = WSAGetLastError();
  17853. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_READ; }
  17854. return MBEDTLS_ERR_NET_RECV_FAILED;
  17855. }
  17856. #else
  17857. auto ret = recv(sock, buf, len, 0);
  17858. if (ret < 0) {
  17859. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17860. return MBEDTLS_ERR_SSL_WANT_READ;
  17861. }
  17862. return MBEDTLS_ERR_NET_RECV_FAILED;
  17863. }
  17864. #endif
  17865. if (ret == 0) { return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY; }
  17866. return static_cast<int>(ret);
  17867. }
  17868. // MbedTlsContext constructor/destructor implementations
  17869. inline MbedTlsContext::MbedTlsContext() {
  17870. mbedtls_ssl_config_init(&conf);
  17871. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17872. mbedtls_entropy_init(&entropy);
  17873. mbedtls_ctr_drbg_init(&ctr_drbg);
  17874. #endif
  17875. mbedtls_x509_crt_init(&ca_chain);
  17876. mbedtls_x509_crt_init(&own_cert);
  17877. mbedtls_pk_init(&own_key);
  17878. }
  17879. inline MbedTlsContext::~MbedTlsContext() {
  17880. mbedtls_pk_free(&own_key);
  17881. mbedtls_x509_crt_free(&own_cert);
  17882. mbedtls_x509_crt_free(&ca_chain);
  17883. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17884. mbedtls_ctr_drbg_free(&ctr_drbg);
  17885. mbedtls_entropy_free(&entropy);
  17886. #endif
  17887. mbedtls_ssl_config_free(&conf);
  17888. }
  17889. // Thread-local storage for SNI captured during handshake
  17890. // This is needed because the SNI callback doesn't have a way to pass
  17891. // session-specific data before the session is fully set up
  17892. inline std::string &mbedpending_sni() {
  17893. static thread_local std::string sni;
  17894. return sni;
  17895. }
  17896. // SNI callback for Mbed TLS server to capture client's SNI hostname
  17897. inline int mbedtls_sni_callback(void *p_ctx, mbedtls_ssl_context *ssl,
  17898. const unsigned char *name, size_t name_len) {
  17899. (void)p_ctx;
  17900. (void)ssl;
  17901. // Store SNI name in thread-local storage
  17902. // It will be retrieved and stored in the session after handshake
  17903. if (name && name_len > 0) {
  17904. mbedpending_sni().assign(reinterpret_cast<const char *>(name), name_len);
  17905. } else {
  17906. mbedpending_sni().clear();
  17907. }
  17908. return 0; // Accept any SNI
  17909. }
  17910. inline void mbedtls_clear_cn_mismatch(uint32_t *flags) {
  17911. *flags &= ~static_cast<uint32_t>(hostname_mismatch_code());
  17912. }
  17913. // MbedTLS verify callback wrapper
  17914. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  17915. int cert_depth, uint32_t *flags) {
  17916. // data points to the MbedTlsSession
  17917. auto *session = static_cast<MbedTlsSession *>(data);
  17918. // set_sni() disabled hostname verification for this session: ignore the
  17919. // CN/SAN mismatch flag, as the OpenSSL/wolfSSL backends do. The final
  17920. // pass/fail decision still comes from the remaining flags (and, below, from
  17921. // the user's own verify callback).
  17922. if (session->suppress_hostname_mismatch) { mbedtls_clear_cn_mismatch(flags); }
  17923. const auto &callback = session->verify_callback;
  17924. if (!callback) { return 0; } // Continue with default verification
  17925. // Build context
  17926. VerifyContext verify_ctx;
  17927. verify_ctx.session = static_cast<session_t>(session);
  17928. verify_ctx.cert = static_cast<cert_t>(crt);
  17929. verify_ctx.depth = cert_depth;
  17930. verify_ctx.preverify_ok = (*flags == 0);
  17931. verify_ctx.error_code = static_cast<long>(*flags);
  17932. // Convert Mbed TLS flags to error string
  17933. static thread_local char error_buf[256];
  17934. if (*flags != 0) {
  17935. mbedtls_x509_crt_verify_info(error_buf, sizeof(error_buf), "", *flags);
  17936. verify_ctx.error_string = error_buf;
  17937. } else {
  17938. verify_ctx.error_string = nullptr;
  17939. }
  17940. bool accepted = run_verify_callback(callback, verify_ctx);
  17941. if (accepted) {
  17942. // Overrides the built-in verification only on a server, as on OpenSSL and
  17943. // wolfSSL, whose clients check the verify result after the handshake
  17944. if (session->is_server) { *flags = 0; }
  17945. return 0;
  17946. }
  17947. return MBEDTLS_ERR_X509_CERT_VERIFY_FAILED;
  17948. }
  17949. // Sets the authentication mode from whether the peer's certificate is required
  17950. // and whether a verify callback is set. OPTIONAL lets the callback run even if
  17951. // verification is not required (matching OpenSSL's SSL_VERIFY_PEER).
  17952. inline void apply_verify_mode(MbedTlsContext &mctx) {
  17953. auto mode = MBEDTLS_SSL_VERIFY_NONE;
  17954. if (mctx.verify_client) {
  17955. mode = MBEDTLS_SSL_VERIFY_REQUIRED;
  17956. } else if (mctx.verify_callback) {
  17957. mode = MBEDTLS_SSL_VERIFY_OPTIONAL;
  17958. }
  17959. mbedtls_ssl_conf_authmode(&mctx.conf, mode);
  17960. }
  17961. } // namespace impl
  17962. inline ctx_t create_client_context() {
  17963. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17964. if (!ctx) { return nullptr; }
  17965. ctx->is_server = false;
  17966. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17967. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17968. if (!detail::ensure_mbedtls_psa_crypto()) {
  17969. delete ctx;
  17970. return nullptr;
  17971. }
  17972. int ret;
  17973. #else
  17974. // Seed the random number generator
  17975. const char *pers = "httplib_client";
  17976. int ret = mbedtls_ctr_drbg_seed(
  17977. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  17978. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  17979. if (ret != 0) {
  17980. impl::mbedtls_last_error() = ret;
  17981. delete ctx;
  17982. return nullptr;
  17983. }
  17984. #endif
  17985. // Set up SSL config for client
  17986. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_CLIENT,
  17987. MBEDTLS_SSL_TRANSPORT_STREAM,
  17988. MBEDTLS_SSL_PRESET_DEFAULT);
  17989. if (ret != 0) {
  17990. impl::mbedtls_last_error() = ret;
  17991. delete ctx;
  17992. return nullptr;
  17993. }
  17994. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17995. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17996. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17997. #endif
  17998. // Default: verify peer certificate
  17999. ctx->verify_client = true;
  18000. impl::apply_verify_mode(*ctx);
  18001. // Set minimum TLS version to 1.2
  18002. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18003. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  18004. #else
  18005. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  18006. MBEDTLS_SSL_MINOR_VERSION_3);
  18007. #endif
  18008. return static_cast<ctx_t>(ctx);
  18009. }
  18010. inline ctx_t create_server_context() {
  18011. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  18012. if (!ctx) { return nullptr; }
  18013. ctx->is_server = true;
  18014. #ifdef CPPHTTPLIB_MBEDTLS_V4
  18015. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  18016. if (!detail::ensure_mbedtls_psa_crypto()) {
  18017. delete ctx;
  18018. return nullptr;
  18019. }
  18020. int ret;
  18021. #else
  18022. // Seed the random number generator
  18023. const char *pers = "httplib_server";
  18024. int ret = mbedtls_ctr_drbg_seed(
  18025. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  18026. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  18027. if (ret != 0) {
  18028. impl::mbedtls_last_error() = ret;
  18029. delete ctx;
  18030. return nullptr;
  18031. }
  18032. #endif
  18033. // Set up SSL config for server
  18034. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_SERVER,
  18035. MBEDTLS_SSL_TRANSPORT_STREAM,
  18036. MBEDTLS_SSL_PRESET_DEFAULT);
  18037. if (ret != 0) {
  18038. impl::mbedtls_last_error() = ret;
  18039. delete ctx;
  18040. return nullptr;
  18041. }
  18042. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18043. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  18044. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  18045. #endif
  18046. // Default: don't verify client
  18047. impl::apply_verify_mode(*ctx);
  18048. // Set minimum TLS version to 1.2
  18049. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18050. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  18051. #else
  18052. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  18053. MBEDTLS_SSL_MINOR_VERSION_3);
  18054. #endif
  18055. // Set SNI callback to capture client's SNI hostname
  18056. mbedtls_ssl_conf_sni(&ctx->conf, impl::mbedtls_sni_callback, nullptr);
  18057. return static_cast<ctx_t>(ctx);
  18058. }
  18059. inline void free_context(ctx_t ctx) {
  18060. if (ctx) { delete static_cast<impl::MbedTlsContext *>(ctx); }
  18061. }
  18062. inline bool set_min_version(ctx_t ctx, Version version) {
  18063. if (!ctx) { return false; }
  18064. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18065. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18066. // Mbed TLS 3.x uses mbedtls_ssl_protocol_version enum
  18067. mbedtls_ssl_protocol_version min_ver = MBEDTLS_SSL_VERSION_TLS1_2;
  18068. if (version >= Version::TLS1_3) {
  18069. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  18070. min_ver = MBEDTLS_SSL_VERSION_TLS1_3;
  18071. #endif
  18072. }
  18073. mbedtls_ssl_conf_min_tls_version(&mctx->conf, min_ver);
  18074. #else
  18075. // Mbed TLS 2.x uses major/minor version numbers
  18076. int major = MBEDTLS_SSL_MAJOR_VERSION_3;
  18077. int minor = MBEDTLS_SSL_MINOR_VERSION_3; // TLS 1.2
  18078. if (version >= Version::TLS1_3) {
  18079. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  18080. minor = MBEDTLS_SSL_MINOR_VERSION_4; // TLS 1.3
  18081. #else
  18082. minor = MBEDTLS_SSL_MINOR_VERSION_3; // Fall back to TLS 1.2
  18083. #endif
  18084. }
  18085. mbedtls_ssl_conf_min_version(&mctx->conf, major, minor);
  18086. #endif
  18087. return true;
  18088. }
  18089. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  18090. if (!ctx || !pem) { return false; }
  18091. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18092. // mbedtls_x509_crt_parse expects null-terminated string for PEM
  18093. // Add null terminator if not present
  18094. std::string pem_str(pem, len);
  18095. int ret = mbedtls_x509_crt_parse(
  18096. &mctx->ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  18097. pem_str.size() + 1);
  18098. if (ret != 0) {
  18099. impl::mbedtls_last_error() = ret;
  18100. return false;
  18101. }
  18102. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18103. return true;
  18104. }
  18105. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  18106. if (!ctx || !file_path) { return false; }
  18107. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18108. int ret = mbedtls_x509_crt_parse_file(&mctx->ca_chain, file_path);
  18109. if (ret != 0) {
  18110. impl::mbedtls_last_error() = ret;
  18111. return false;
  18112. }
  18113. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18114. return true;
  18115. }
  18116. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  18117. if (!ctx || !dir_path) { return false; }
  18118. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18119. int ret = mbedtls_x509_crt_parse_path(&mctx->ca_chain, dir_path);
  18120. if (ret < 0) { // Returns number of certs on success, negative on error
  18121. impl::mbedtls_last_error() = ret;
  18122. return false;
  18123. }
  18124. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18125. return true;
  18126. }
  18127. inline bool load_system_certs(ctx_t ctx) {
  18128. if (!ctx) { return false; }
  18129. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18130. bool loaded = false;
  18131. #ifdef _WIN32
  18132. loaded = impl::enumerate_windows_system_certs(
  18133. [&](const unsigned char *data, size_t len) {
  18134. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  18135. });
  18136. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  18137. loaded = impl::enumerate_macos_keychain_certs(
  18138. [&](const unsigned char *data, size_t len) {
  18139. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  18140. });
  18141. #else
  18142. for (auto path = impl::system_ca_paths(); *path; ++path) {
  18143. if (mbedtls_x509_crt_parse_file(&mctx->ca_chain, *path) >= 0) {
  18144. loaded = true;
  18145. break;
  18146. }
  18147. }
  18148. if (!loaded) {
  18149. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  18150. if (mbedtls_x509_crt_parse_path(&mctx->ca_chain, *dir) >= 0) {
  18151. loaded = true;
  18152. break;
  18153. }
  18154. }
  18155. }
  18156. #endif
  18157. if (loaded) {
  18158. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18159. }
  18160. return loaded;
  18161. }
  18162. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  18163. const char *password) {
  18164. if (!ctx || !cert || !key) { return false; }
  18165. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18166. // Parse certificate
  18167. std::string cert_str(cert);
  18168. int ret = mbedtls_x509_crt_parse(
  18169. &mctx->own_cert,
  18170. reinterpret_cast<const unsigned char *>(cert_str.c_str()),
  18171. cert_str.size() + 1);
  18172. if (ret != 0) {
  18173. impl::mbedtls_last_error() = ret;
  18174. return false;
  18175. }
  18176. // Parse private key
  18177. std::string key_str(key);
  18178. const unsigned char *pwd =
  18179. password ? reinterpret_cast<const unsigned char *>(password) : nullptr;
  18180. size_t pwd_len = password ? strlen(password) : 0;
  18181. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18182. ret = mbedtls_pk_parse_key(
  18183. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  18184. key_str.size() + 1, pwd, pwd_len, mbedtls_ctr_drbg_random,
  18185. &mctx->ctr_drbg);
  18186. #else
  18187. ret = mbedtls_pk_parse_key(
  18188. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  18189. key_str.size() + 1, pwd, pwd_len);
  18190. #endif
  18191. if (ret != 0) {
  18192. impl::mbedtls_last_error() = ret;
  18193. return false;
  18194. }
  18195. // Verify that the certificate and private key match.
  18196. // Mbed TLS 4.x: mbedtls_pk_check_pair() reports a spurious mismatch for
  18197. // PSA-backed keys, so skip it and let the handshake surface a real mismatch.
  18198. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18199. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18200. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  18201. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18202. #else
  18203. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  18204. #endif
  18205. if (ret != 0) {
  18206. impl::mbedtls_last_error() = ret;
  18207. return false;
  18208. }
  18209. #endif
  18210. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  18211. if (ret != 0) {
  18212. impl::mbedtls_last_error() = ret;
  18213. return false;
  18214. }
  18215. return true;
  18216. }
  18217. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  18218. const char *key_path, const char *password) {
  18219. if (!ctx || !cert_path || !key_path) { return false; }
  18220. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18221. // Parse certificate file
  18222. int ret = mbedtls_x509_crt_parse_file(&mctx->own_cert, cert_path);
  18223. if (ret != 0) {
  18224. impl::mbedtls_last_error() = ret;
  18225. return false;
  18226. }
  18227. // Parse private key file
  18228. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18229. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password,
  18230. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18231. #else
  18232. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password);
  18233. #endif
  18234. if (ret != 0) {
  18235. impl::mbedtls_last_error() = ret;
  18236. return false;
  18237. }
  18238. // Verify that the certificate and private key match.
  18239. // Mbed TLS 4.x: see set_client_cert() — skip the spurious check_pair.
  18240. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18241. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18242. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  18243. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18244. #else
  18245. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  18246. #endif
  18247. if (ret != 0) {
  18248. impl::mbedtls_last_error() = ret;
  18249. return false;
  18250. }
  18251. #endif
  18252. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  18253. if (ret != 0) {
  18254. impl::mbedtls_last_error() = ret;
  18255. return false;
  18256. }
  18257. return true;
  18258. }
  18259. inline void set_verify_client(ctx_t ctx, bool require) {
  18260. if (!ctx) { return; }
  18261. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18262. mctx->verify_client = require;
  18263. impl::apply_verify_mode(*mctx);
  18264. }
  18265. inline session_t create_session(ctx_t ctx, socket_t sock) {
  18266. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  18267. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18268. auto session = new (std::nothrow) impl::MbedTlsSession();
  18269. if (!session) { return nullptr; }
  18270. session->sock = sock;
  18271. int ret = mbedtls_ssl_setup(&session->ssl, &mctx->conf);
  18272. if (ret != 0) {
  18273. impl::mbedtls_last_error() = ret;
  18274. delete session;
  18275. return nullptr;
  18276. }
  18277. // Explicitly opt out of in-handshake hostname verification by default;
  18278. // since Mbed TLS 3.6.4 a client handshake with certificate verification
  18279. // fails outright when no hostname was set. set_sni() installs the real
  18280. // hostname for DNS hosts; for IP hosts (where SNI must not be set) the
  18281. // caller verifies the certificate identity post-handshake via
  18282. // verify_hostname().
  18283. mbedtls_ssl_set_hostname(&session->ssl, nullptr);
  18284. // Set BIO callbacks
  18285. mbedtls_ssl_set_bio(&session->ssl, &session->sock, impl::mbedtls_net_send_cb,
  18286. impl::mbedtls_net_recv_cb, nullptr);
  18287. // Installed always, as it also masks the hostname mismatch that set_sni()
  18288. // may ask for. The session runs its own copy of the user's callback, which
  18289. // set_verify_callback() cannot replace under a handshake.
  18290. session->verify_callback = mctx->verify_callback;
  18291. session->is_server = mctx->is_server;
  18292. mbedtls_ssl_set_verify(&session->ssl, impl::mbedtls_verify_callback, session);
  18293. return static_cast<session_t>(session);
  18294. }
  18295. inline void free_session(session_t session) {
  18296. if (session) { delete static_cast<impl::MbedTlsSession *>(session); }
  18297. }
  18298. inline bool set_sni(session_t session, const char *hostname,
  18299. bool verify_hostname) {
  18300. if (!session || !hostname) { return false; }
  18301. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18302. // mbedtls_ssl_set_hostname() both sends the SNI extension and binds the
  18303. // handshake-time CN/SAN check to `hostname`; the two can't be requested
  18304. // independently, so a disabled hostname check is handled below by masking
  18305. // the resulting mismatch flag instead of skipping this call.
  18306. int ret = mbedtls_ssl_set_hostname(&msession->ssl, hostname);
  18307. if (ret != 0) {
  18308. impl::mbedtls_last_error() = ret;
  18309. return false;
  18310. }
  18311. msession->hostname = hostname;
  18312. if (!verify_hostname) { msession->suppress_hostname_mismatch = true; }
  18313. return true;
  18314. }
  18315. inline TlsError connect(session_t session) {
  18316. TlsError err;
  18317. if (!session) {
  18318. err.code = ErrorCode::Fatal;
  18319. return err;
  18320. }
  18321. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18322. int ret;
  18323. do {
  18324. ret = mbedtls_ssl_handshake(&msession->ssl);
  18325. } while (impl::mbedtls_is_session_ticket(ret));
  18326. if (ret == 0) {
  18327. err.code = ErrorCode::Success;
  18328. } else {
  18329. impl::fill_mbedtls_tls_error(err, msession->ssl, ret);
  18330. impl::mbedtls_last_error() = ret;
  18331. }
  18332. return err;
  18333. }
  18334. inline TlsError accept(session_t session) {
  18335. // A failed handshake leaves its SNI behind, so start without it
  18336. impl::mbedpending_sni().clear();
  18337. // Same as connect for Mbed TLS - handshake works for both client and server
  18338. auto result = connect(session);
  18339. // After successful handshake, capture SNI from thread-local storage
  18340. if (result.code == ErrorCode::Success && session) {
  18341. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18342. msession->sni_hostname = std::move(impl::mbedpending_sni());
  18343. }
  18344. return result;
  18345. }
  18346. inline bool connect_nonblocking(session_t session, socket_t sock,
  18347. time_t timeout_sec, time_t timeout_usec,
  18348. TlsError *err) {
  18349. if (!session) {
  18350. if (err) { err->code = ErrorCode::Fatal; }
  18351. return false;
  18352. }
  18353. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18354. // Set socket to non-blocking mode
  18355. detail::set_nonblocking(sock, true);
  18356. auto cleanup =
  18357. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18358. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  18359. int ret;
  18360. while ((ret = mbedtls_ssl_handshake(&msession->ssl)) != 0) {
  18361. // Non-fatal TLS 1.3 ticket; retry immediately.
  18362. if (impl::mbedtls_is_session_ticket(ret)) { continue; }
  18363. if (ret == MBEDTLS_ERR_SSL_WANT_READ) {
  18364. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  18365. } else if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) {
  18366. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  18367. }
  18368. // TlsError or timeout
  18369. if (err) { impl::fill_mbedtls_tls_error(*err, msession->ssl, ret); }
  18370. impl::mbedtls_last_error() = ret;
  18371. return false;
  18372. }
  18373. if (err) { err->code = ErrorCode::Success; }
  18374. return true;
  18375. }
  18376. inline bool accept_nonblocking(session_t session, socket_t sock,
  18377. time_t timeout_sec, time_t timeout_usec,
  18378. TlsError *err) {
  18379. // A failed handshake leaves its SNI behind, so start without it
  18380. impl::mbedpending_sni().clear();
  18381. // Same implementation as connect for Mbed TLS
  18382. bool result =
  18383. connect_nonblocking(session, sock, timeout_sec, timeout_usec, err);
  18384. // After successful handshake, capture SNI from thread-local storage
  18385. if (result && session) {
  18386. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18387. msession->sni_hostname = std::move(impl::mbedpending_sni());
  18388. }
  18389. return result;
  18390. }
  18391. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  18392. if (!session || !buf) {
  18393. err.code = ErrorCode::Fatal;
  18394. return -1;
  18395. }
  18396. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18397. // Serve a byte consumed by the is_peer_closed() probe before reading more.
  18398. if (msession->has_peeked_byte) {
  18399. if (len == 0) { return 0; }
  18400. auto p = static_cast<unsigned char *>(buf);
  18401. p[0] = msession->peeked_byte;
  18402. msession->has_peeked_byte = false;
  18403. size_t n = 1;
  18404. // Top up with any already-decrypted bytes without risking a block.
  18405. if (len > 1 && mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  18406. int extra = mbedtls_ssl_read(&msession->ssl, p + 1, len - 1);
  18407. if (extra > 0) { n += static_cast<size_t>(extra); }
  18408. }
  18409. err.code = ErrorCode::Success;
  18410. return static_cast<ssize_t>(n);
  18411. }
  18412. int ret;
  18413. do {
  18414. ret = mbedtls_ssl_read(&msession->ssl, static_cast<unsigned char *>(buf),
  18415. len);
  18416. } while (impl::mbedtls_is_session_ticket(ret));
  18417. if (ret > 0) {
  18418. err.code = ErrorCode::Success;
  18419. return static_cast<ssize_t>(ret);
  18420. }
  18421. if (ret == 0) {
  18422. err.code = ErrorCode::PeerClosed;
  18423. return 0;
  18424. }
  18425. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  18426. err.backend_code = static_cast<uint64_t>(-ret);
  18427. impl::mbedtls_last_error() = ret;
  18428. // mbedTLS signals a clean close_notify via a negative error code rather
  18429. // than 0; surface it as a clean EOF the way OpenSSL/wolfSSL do.
  18430. if (err.code == ErrorCode::PeerClosed) { return 0; }
  18431. return -1;
  18432. }
  18433. inline ssize_t write(session_t session, const void *buf, size_t len,
  18434. TlsError &err) {
  18435. if (!session || !buf) {
  18436. err.code = ErrorCode::Fatal;
  18437. return -1;
  18438. }
  18439. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18440. int ret;
  18441. do {
  18442. ret = mbedtls_ssl_write(&msession->ssl,
  18443. static_cast<const unsigned char *>(buf), len);
  18444. } while (impl::mbedtls_is_session_ticket(ret));
  18445. if (ret > 0) {
  18446. err.code = ErrorCode::Success;
  18447. return static_cast<ssize_t>(ret);
  18448. }
  18449. if (ret == 0) {
  18450. err.code = ErrorCode::PeerClosed;
  18451. return 0;
  18452. }
  18453. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  18454. err.backend_code = static_cast<uint64_t>(-ret);
  18455. impl::mbedtls_last_error() = ret;
  18456. return -1;
  18457. }
  18458. inline int pending(const_session_t session) {
  18459. if (!session) { return 0; }
  18460. auto msession =
  18461. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18462. return static_cast<int>(mbedtls_ssl_get_bytes_avail(&msession->ssl)) +
  18463. (msession->has_peeked_byte ? 1 : 0);
  18464. }
  18465. inline void shutdown(session_t session, bool graceful) {
  18466. if (!session) { return; }
  18467. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18468. if (graceful) {
  18469. // Try to send close_notify, but don't block forever
  18470. int ret;
  18471. int attempts = 0;
  18472. while ((ret = mbedtls_ssl_close_notify(&msession->ssl)) != 0 &&
  18473. attempts < 3) {
  18474. if (ret != MBEDTLS_ERR_SSL_WANT_READ &&
  18475. ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
  18476. break;
  18477. }
  18478. attempts++;
  18479. }
  18480. }
  18481. }
  18482. inline bool is_peer_closed(session_t session, socket_t sock) {
  18483. if (!session || sock == INVALID_SOCKET) { return true; }
  18484. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18485. // Check if there's already decrypted or pushed-back data available.
  18486. // If so, the connection is definitely alive.
  18487. if (msession->has_peeked_byte ||
  18488. mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  18489. return false;
  18490. }
  18491. // Set socket to non-blocking to avoid blocking on read
  18492. detail::set_nonblocking(sock, true);
  18493. auto cleanup =
  18494. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18495. // Probe with a 1-byte read (Mbed TLS has no peek API). If the probe lands
  18496. // on application data — e.g. a response that already arrived — push the
  18497. // byte back so the next read() delivers it instead of losing it.
  18498. unsigned char buf;
  18499. int ret;
  18500. do {
  18501. ret = mbedtls_ssl_read(&msession->ssl, &buf, 1);
  18502. } while (impl::mbedtls_is_session_ticket(ret));
  18503. // If we got data or WANT_READ (would block), connection is alive
  18504. if (ret > 0) {
  18505. msession->peeked_byte = buf;
  18506. msession->has_peeked_byte = true;
  18507. return false;
  18508. }
  18509. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return false; }
  18510. // If we get a peer close notify or a connection reset, the peer is closed
  18511. return ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY ||
  18512. ret == MBEDTLS_ERR_NET_CONN_RESET || ret == 0;
  18513. }
  18514. inline cert_t get_peer_cert(const_session_t session) {
  18515. if (!session) { return nullptr; }
  18516. auto msession =
  18517. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18518. // Mbed TLS returns a pointer to the internal peer cert chain.
  18519. // WARNING: This pointer is only valid while the session is active.
  18520. // Do not use the certificate after calling free_session().
  18521. const mbedtls_x509_crt *cert = mbedtls_ssl_get_peer_cert(&msession->ssl);
  18522. return const_cast<mbedtls_x509_crt *>(cert);
  18523. }
  18524. inline size_t get_peer_certs(const_session_t session,
  18525. std::vector<cert_t> &certs) {
  18526. certs.clear();
  18527. // Mbed TLS parses the whole received chain into a list headed by the peer
  18528. // certificate, owned by the session like get_peer_cert()'s result
  18529. for (auto crt = static_cast<mbedtls_x509_crt *>(get_peer_cert(session));
  18530. crt && crt->raw.len > 0; crt = crt->next) {
  18531. certs.push_back(static_cast<cert_t>(crt));
  18532. }
  18533. return certs.size();
  18534. }
  18535. inline void free_cert(cert_t cert) {
  18536. // Mbed TLS: every cert_t handed out points into a session's or a context's
  18537. // chain, so there is nothing to free. Callers still call this for the other
  18538. // backends.
  18539. (void)cert;
  18540. }
  18541. inline bool verify_hostname(cert_t cert, const char *hostname) {
  18542. if (!cert || !hostname) { return false; }
  18543. auto mcert = static_cast<const mbedtls_x509_crt *>(cert);
  18544. std::string host_str(hostname);
  18545. // Check if hostname is an IP address (IPv4 or IPv6)
  18546. unsigned char ip_bytes[16];
  18547. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  18548. auto is_ip = ip_len > 0;
  18549. // Check Subject Alternative Names (SAN). Mbed TLS keeps the GeneralName type
  18550. // in buf.tag and the raw value in buf.p / buf.len.
  18551. auto has_dns_san = false;
  18552. for (auto san = &mcert->subject_alt_names; san; san = san->next) {
  18553. if (!san->buf.p || san->buf.len == 0) { continue; }
  18554. const unsigned char *p = san->buf.p;
  18555. size_t len = san->buf.len;
  18556. auto san_type = san->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK;
  18557. if (is_ip) {
  18558. // For an IP host, only a matching iPAddress SAN of the same family
  18559. // (4 bytes for IPv4, 16 bytes for IPv6) may authenticate it.
  18560. if (san_type == MBEDTLS_X509_SAN_IP_ADDRESS && len == ip_len &&
  18561. memcmp(p, ip_bytes, ip_len) == 0) {
  18562. return true;
  18563. }
  18564. } else if (san_type == MBEDTLS_X509_SAN_DNS_NAME) {
  18565. has_dns_san = true;
  18566. std::string san_name(reinterpret_cast<const char *>(p), len);
  18567. if (detail::match_hostname(san_name, host_str)) { return true; }
  18568. }
  18569. }
  18570. // Fallback: the Common Names (CN) in the subject, as X509_check_host does it:
  18571. // never for an IP host, which only an iPAddress SAN names, and never next to
  18572. // a DNS SAN (RFC 6125 6.4.4).
  18573. if (is_ip || has_dns_san) { return false; }
  18574. for (auto name = &mcert->subject; name; name = name->next) {
  18575. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  18576. std::string cn(reinterpret_cast<const char *>(name->val.p),
  18577. name->val.len);
  18578. if (detail::match_hostname(cn, host_str)) { return true; }
  18579. }
  18580. }
  18581. return false;
  18582. }
  18583. inline uint64_t hostname_mismatch_code() {
  18584. return static_cast<uint64_t>(MBEDTLS_X509_BADCERT_CN_MISMATCH);
  18585. }
  18586. inline long get_verify_result(const_session_t session) {
  18587. if (!session) { return -1; }
  18588. auto msession =
  18589. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18590. uint32_t flags = mbedtls_ssl_get_verify_result(&msession->ssl);
  18591. // Return 0 (X509_V_OK equivalent) if verification passed
  18592. return flags == 0 ? 0 : static_cast<long>(flags);
  18593. }
  18594. inline std::string get_cert_subject_cn(cert_t cert) {
  18595. if (!cert) return "";
  18596. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18597. // Find the CN in the subject
  18598. const mbedtls_x509_name *name = &x509->subject;
  18599. while (name != nullptr) {
  18600. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  18601. return std::string(reinterpret_cast<const char *>(name->val.p),
  18602. name->val.len);
  18603. }
  18604. name = name->next;
  18605. }
  18606. return "";
  18607. }
  18608. inline std::string get_cert_issuer_name(cert_t cert) {
  18609. if (!cert) return "";
  18610. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18611. // Build a human-readable issuer name string
  18612. char buf[512];
  18613. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &x509->issuer);
  18614. if (ret < 0) return "";
  18615. return std::string(buf);
  18616. }
  18617. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  18618. sans.clear();
  18619. if (!cert) return false;
  18620. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18621. // Parse the Subject Alternative Name extension
  18622. const mbedtls_x509_sequence *cur = &x509->subject_alt_names;
  18623. while (cur != nullptr) {
  18624. if (cur->buf.len > 0) {
  18625. const unsigned char *p = cur->buf.p;
  18626. size_t value_len = cur->buf.len;
  18627. SanEntry entry;
  18628. switch (cur->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK) {
  18629. case MBEDTLS_X509_SAN_DNS_NAME:
  18630. entry.type = SanType::DNS;
  18631. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18632. break;
  18633. case MBEDTLS_X509_SAN_IP_ADDRESS:
  18634. entry.type = SanType::IP;
  18635. if (value_len == 4) {
  18636. // IPv4
  18637. char buf[16];
  18638. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", p[0], p[1], p[2], p[3]);
  18639. entry.value = buf;
  18640. } else if (value_len == 16) {
  18641. // IPv6
  18642. char buf[64];
  18643. snprintf(buf, sizeof(buf),
  18644. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  18645. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  18646. p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8], p[9],
  18647. p[10], p[11], p[12], p[13], p[14], p[15]);
  18648. entry.value = buf;
  18649. }
  18650. break;
  18651. case MBEDTLS_X509_SAN_RFC822_NAME:
  18652. entry.type = SanType::EMAIL;
  18653. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18654. break;
  18655. case MBEDTLS_X509_SAN_UNIFORM_RESOURCE_IDENTIFIER:
  18656. entry.type = SanType::URI;
  18657. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18658. break;
  18659. default: entry.type = SanType::OTHER; break;
  18660. }
  18661. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  18662. }
  18663. cur = cur->next;
  18664. }
  18665. return true;
  18666. }
  18667. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  18668. time_t &not_after) {
  18669. if (!cert) return false;
  18670. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18671. // Convert mbedtls_x509_time to time_t
  18672. auto to_time_t = [](const mbedtls_x509_time &t) -> time_t {
  18673. struct tm tm_time = {};
  18674. tm_time.tm_year = t.year - 1900;
  18675. tm_time.tm_mon = t.mon - 1;
  18676. tm_time.tm_mday = t.day;
  18677. tm_time.tm_hour = t.hour;
  18678. tm_time.tm_min = t.min;
  18679. tm_time.tm_sec = t.sec;
  18680. #ifdef _WIN32
  18681. return _mkgmtime(&tm_time);
  18682. #else
  18683. return timegm(&tm_time);
  18684. #endif
  18685. };
  18686. not_before = to_time_t(x509->valid_from);
  18687. not_after = to_time_t(x509->valid_to);
  18688. return true;
  18689. }
  18690. inline std::string get_cert_serial(cert_t cert) {
  18691. if (!cert) return "";
  18692. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18693. // Convert serial number to hex string
  18694. std::string result;
  18695. result.reserve(x509->serial.len * 2);
  18696. for (size_t i = 0; i < x509->serial.len; i++) {
  18697. char hex[3];
  18698. snprintf(hex, sizeof(hex), "%02X", x509->serial.p[i]);
  18699. result += hex;
  18700. }
  18701. return result;
  18702. }
  18703. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  18704. if (!cert) return false;
  18705. auto crt = static_cast<mbedtls_x509_crt *>(cert);
  18706. if (!crt->raw.p || crt->raw.len == 0) return false;
  18707. der.assign(crt->raw.p, crt->raw.p + crt->raw.len);
  18708. return true;
  18709. }
  18710. inline const char *get_sni(const_session_t session) {
  18711. if (!session) return nullptr;
  18712. auto msession = static_cast<const impl::MbedTlsSession *>(session);
  18713. // For server: return SNI received from client during handshake
  18714. if (!msession->sni_hostname.empty()) {
  18715. return msession->sni_hostname.c_str();
  18716. }
  18717. // For client: return the hostname set via set_sni
  18718. if (!msession->hostname.empty()) { return msession->hostname.c_str(); }
  18719. return nullptr;
  18720. }
  18721. inline uint64_t peek_error() {
  18722. // Mbed TLS doesn't have an error queue, return the last error
  18723. return static_cast<uint64_t>(-impl::mbedtls_last_error());
  18724. }
  18725. inline uint64_t get_error() {
  18726. // Mbed TLS doesn't have an error queue, return and clear the last error
  18727. uint64_t err = static_cast<uint64_t>(-impl::mbedtls_last_error());
  18728. impl::mbedtls_last_error() = 0;
  18729. return err;
  18730. }
  18731. inline std::string error_string(uint64_t code) {
  18732. char buf[256];
  18733. mbedtls_strerror(-static_cast<int>(code), buf, sizeof(buf));
  18734. return std::string(buf);
  18735. }
  18736. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  18737. auto *ca_chain = new (std::nothrow) mbedtls_x509_crt;
  18738. if (!ca_chain) { return nullptr; }
  18739. mbedtls_x509_crt_init(ca_chain);
  18740. // mbedtls_x509_crt_parse expects null-terminated PEM
  18741. int ret = mbedtls_x509_crt_parse(ca_chain,
  18742. reinterpret_cast<const unsigned char *>(pem),
  18743. len + 1); // +1 for null terminator
  18744. if (ret != 0) {
  18745. // Try without +1 in case PEM is already null-terminated
  18746. ret = mbedtls_x509_crt_parse(
  18747. ca_chain, reinterpret_cast<const unsigned char *>(pem), len);
  18748. if (ret != 0) {
  18749. mbedtls_x509_crt_free(ca_chain);
  18750. delete ca_chain;
  18751. return nullptr;
  18752. }
  18753. }
  18754. return static_cast<ca_store_t>(ca_chain);
  18755. }
  18756. inline void free_ca_store(ca_store_t store) {
  18757. if (store) {
  18758. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18759. mbedtls_x509_crt_free(ca_chain);
  18760. delete ca_chain;
  18761. }
  18762. }
  18763. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  18764. if (!ctx || !store) { return false; }
  18765. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18766. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18767. // Free existing CA chain
  18768. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  18769. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  18770. // Copy the CA chain (deep copy)
  18771. // Parse from the raw data of the source cert
  18772. mbedtls_x509_crt *src = ca_chain;
  18773. while (src != nullptr) {
  18774. int ret = mbedtls_x509_crt_parse_der(&mbed_ctx->ca_chain, src->raw.p,
  18775. src->raw.len);
  18776. if (ret != 0) {
  18777. free_ca_store(store);
  18778. return false;
  18779. }
  18780. src = src->next;
  18781. }
  18782. // This function takes ownership of the store; the chain was deep-copied
  18783. // above, so release the source
  18784. free_ca_store(store);
  18785. // Update the SSL config to use the new CA chain
  18786. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18787. return true;
  18788. }
  18789. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  18790. certs.clear();
  18791. if (!ctx) { return 0; }
  18792. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18793. // Owned by the context; see free_cert()
  18794. for (auto cert = &mbed_ctx->ca_chain; cert && cert->raw.len > 0;
  18795. cert = cert->next) {
  18796. certs.push_back(static_cast<cert_t>(cert));
  18797. }
  18798. return certs.size();
  18799. }
  18800. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  18801. std::vector<std::string> names;
  18802. if (!ctx) { return names; }
  18803. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18804. // Iterate through the CA chain
  18805. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  18806. while (cert != nullptr && cert->raw.len > 0) {
  18807. char buf[512];
  18808. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &cert->subject);
  18809. if (ret > 0) { names.push_back(buf); }
  18810. cert = cert->next;
  18811. }
  18812. return names;
  18813. }
  18814. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  18815. const char *key_pem, const char *password) {
  18816. if (!ctx || !cert_pem || !key_pem) { return false; }
  18817. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18818. // Parse into new objects first, so that a bad pair leaves the old one in
  18819. // place, and swap them in after; the old ones are freed on the way out.
  18820. mbedtls_x509_crt cert;
  18821. mbedtls_pk_context key;
  18822. mbedtls_x509_crt_init(&cert);
  18823. mbedtls_pk_init(&key);
  18824. auto se = detail::scope_exit([&] {
  18825. mbedtls_x509_crt_free(&cert);
  18826. mbedtls_pk_free(&key);
  18827. });
  18828. // Parse certificate PEM
  18829. int ret = mbedtls_x509_crt_parse(
  18830. &cert, reinterpret_cast<const unsigned char *>(cert_pem),
  18831. strlen(cert_pem) + 1);
  18832. if (ret != 0) {
  18833. impl::mbedtls_last_error() = ret;
  18834. return false;
  18835. }
  18836. // Parse private key PEM
  18837. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18838. ret = mbedtls_pk_parse_key(
  18839. &key, reinterpret_cast<const unsigned char *>(key_pem),
  18840. strlen(key_pem) + 1,
  18841. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18842. password ? strlen(password) : 0, mbedtls_ctr_drbg_random,
  18843. &mbed_ctx->ctr_drbg);
  18844. #else
  18845. ret = mbedtls_pk_parse_key(
  18846. &key, reinterpret_cast<const unsigned char *>(key_pem),
  18847. strlen(key_pem) + 1,
  18848. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18849. password ? strlen(password) : 0);
  18850. #endif
  18851. if (ret != 0) {
  18852. impl::mbedtls_last_error() = ret;
  18853. return false;
  18854. }
  18855. std::swap(mbed_ctx->own_cert, cert);
  18856. std::swap(mbed_ctx->own_key, key);
  18857. // Configure SSL to use the new certificate and key
  18858. ret = mbedtls_ssl_conf_own_cert(&mbed_ctx->conf, &mbed_ctx->own_cert,
  18859. &mbed_ctx->own_key);
  18860. if (ret != 0) {
  18861. impl::mbedtls_last_error() = ret;
  18862. return false;
  18863. }
  18864. return true;
  18865. }
  18866. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  18867. if (!ctx || !ca_pem) { return false; }
  18868. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18869. // Parse into a new chain first, so that a bad one leaves the old in place
  18870. mbedtls_x509_crt chain;
  18871. mbedtls_x509_crt_init(&chain);
  18872. auto se = detail::scope_exit([&] { mbedtls_x509_crt_free(&chain); });
  18873. // Parse CA PEM
  18874. int ret = mbedtls_x509_crt_parse(
  18875. &chain, reinterpret_cast<const unsigned char *>(ca_pem),
  18876. strlen(ca_pem) + 1);
  18877. if (ret != 0) {
  18878. impl::mbedtls_last_error() = ret;
  18879. return false;
  18880. }
  18881. std::swap(mbed_ctx->ca_chain, chain);
  18882. // Update SSL config to use new CA chain
  18883. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18884. return true;
  18885. }
  18886. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  18887. if (!ctx) { return false; }
  18888. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18889. // create_session() hands each session its own copy to run.
  18890. mbed_ctx->verify_callback = std::move(callback);
  18891. impl::apply_verify_mode(*mbed_ctx);
  18892. return true;
  18893. }
  18894. inline long get_verify_error(const_session_t session) {
  18895. if (!session) { return -1; }
  18896. auto *msession =
  18897. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18898. return static_cast<long>(mbedtls_ssl_get_verify_result(&msession->ssl));
  18899. }
  18900. inline std::string verify_error_string(long error_code) {
  18901. if (error_code == 0) { return ""; }
  18902. char buf[256];
  18903. mbedtls_x509_crt_verify_info(buf, sizeof(buf), "",
  18904. static_cast<uint32_t>(error_code));
  18905. // Remove trailing newline if present
  18906. std::string result(buf);
  18907. while (!result.empty() && (result.back() == '\n' || result.back() == ' ')) {
  18908. result.pop_back();
  18909. }
  18910. return result;
  18911. }
  18912. } // namespace tls
  18913. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  18914. /*
  18915. * Group 10: TLS abstraction layer - wolfSSL backend
  18916. */
  18917. /*
  18918. * wolfSSL Backend Implementation
  18919. */
  18920. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  18921. namespace tls {
  18922. namespace impl {
  18923. // wolfSSL session wrapper
  18924. struct WolfSSLSession {
  18925. WOLFSSL *ssl = nullptr;
  18926. socket_t sock = INVALID_SOCKET;
  18927. std::string hostname; // For client: set via set_sni
  18928. std::string sni_hostname; // For server: received from client via SNI callback
  18929. WolfSSLSession() = default;
  18930. ~WolfSSLSession() {
  18931. if (ssl) { wolfSSL_free(ssl); }
  18932. }
  18933. WolfSSLSession(const WolfSSLSession &) = delete;
  18934. WolfSSLSession &operator=(const WolfSSLSession &) = delete;
  18935. };
  18936. // Thread-local error code accessor for wolfSSL
  18937. inline uint64_t &wolfssl_last_error() {
  18938. static thread_local uint64_t err = 0;
  18939. return err;
  18940. }
  18941. // Helper to map wolfSSL error to ErrorCode.
  18942. // ssl_error is the value from wolfSSL_get_error().
  18943. // raw_ret is the raw return value from the wolfSSL call (for low-level error).
  18944. inline ErrorCode map_wolfssl_error(WOLFSSL *ssl, int ssl_error,
  18945. int &out_errno) {
  18946. switch (ssl_error) {
  18947. case SSL_ERROR_NONE: return ErrorCode::Success;
  18948. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  18949. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  18950. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  18951. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  18952. default:
  18953. if (ssl) {
  18954. // wolfSSL stores the low-level error code as a negative value.
  18955. // DOMAIN_NAME_MISMATCH (-322) indicates hostname verification failure.
  18956. int low_err = ssl_error; // wolfSSL_get_error returns the low-level code
  18957. if (low_err == DOMAIN_NAME_MISMATCH) {
  18958. return ErrorCode::HostnameMismatch;
  18959. }
  18960. // Check verify result to distinguish cert verification from generic SSL
  18961. // errors.
  18962. long vr = wolfSSL_get_verify_result(ssl);
  18963. if (vr != 0) { return ErrorCode::CertVerifyFailed; }
  18964. }
  18965. return ErrorCode::Fatal;
  18966. }
  18967. }
  18968. // WolfSSLContext constructor/destructor implementations
  18969. inline WolfSSLContext::WolfSSLContext() { wolfSSL_Init(); }
  18970. inline WolfSSLContext::~WolfSSLContext() {
  18971. if (ctx) { wolfSSL_CTX_free(ctx); }
  18972. }
  18973. // Thread-local storage for SNI captured during handshake
  18974. inline std::string &wolfssl_pending_sni() {
  18975. static thread_local std::string sni;
  18976. return sni;
  18977. }
  18978. // SNI callback for wolfSSL server to capture client's SNI hostname
  18979. inline int wolfssl_sni_callback(WOLFSSL *ssl, int *ret, void *exArg) {
  18980. (void)ret;
  18981. (void)exArg;
  18982. void *name_data = nullptr;
  18983. unsigned short name_len =
  18984. wolfSSL_SNI_GetRequest(ssl, WOLFSSL_SNI_HOST_NAME, &name_data);
  18985. if (name_data && name_len > 0) {
  18986. wolfssl_pending_sni().assign(static_cast<const char *>(name_data),
  18987. name_len);
  18988. } else {
  18989. wolfssl_pending_sni().clear();
  18990. }
  18991. return 0; // Continue regardless
  18992. }
  18993. // The WOLFSSL_CTX points back to its WolfSSLContext, so a handshake only ever
  18994. // runs the verify callback of its own context.
  18995. inline int context_ex_data_index() {
  18996. static const auto index =
  18997. wolfSSL_CTX_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  18998. return index;
  18999. }
  19000. // Each WOLFSSL points back to its WolfSSLSession, the session_t that every
  19001. // other tls:: function takes.
  19002. inline int session_ex_data_index() {
  19003. static const auto index =
  19004. wolfSSL_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  19005. return index;
  19006. }
  19007. // A resumed session skips the client's certificate, so a server that checks
  19008. // one would let in a certificate checked against another server's CA, as
  19009. // wolfSSL shares its session cache between contexts, or against a CA since
  19010. // replaced by update_server_client_ca().
  19011. inline void disable_server_resumption(WolfSSLContext *wctx) {
  19012. if (!wctx->is_server) { return; }
  19013. wolfSSL_CTX_set_session_cache_mode(wctx->ctx, WOLFSSL_SESS_CACHE_OFF);
  19014. #ifdef HAVE_SESSION_TICKET
  19015. wolfSSL_CTX_NoTicketTLSv12(wctx->ctx);
  19016. #endif
  19017. }
  19018. // wolfSSL verify callback wrapper
  19019. inline int wolfssl_verify_callback(int preverify_ok,
  19020. WOLFSSL_X509_STORE_CTX *x509_ctx) {
  19021. // Get the WOLFSSL object from the X509_STORE_CTX
  19022. WOLFSSL *ssl = static_cast<WOLFSSL *>(wolfSSL_X509_STORE_CTX_get_ex_data(
  19023. x509_ctx, wolfSSL_get_ex_data_X509_STORE_CTX_idx()));
  19024. if (!ssl) { return preverify_ok; }
  19025. auto wctx = static_cast<WolfSSLContext *>(wolfSSL_CTX_get_ex_data(
  19026. wolfSSL_get_SSL_CTX(ssl), context_ex_data_index()));
  19027. if (!wctx) { return preverify_ok; }
  19028. std::shared_ptr<VerifyCallback> callback;
  19029. {
  19030. std::lock_guard<std::mutex> guard(verify_callback_mutex());
  19031. callback = wctx->verify_callback;
  19032. }
  19033. if (!callback) { return preverify_ok; }
  19034. WOLFSSL_X509 *cert = wolfSSL_X509_STORE_CTX_get_current_cert(x509_ctx);
  19035. int depth = wolfSSL_X509_STORE_CTX_get_error_depth(x509_ctx);
  19036. int err = wolfSSL_X509_STORE_CTX_get_error(x509_ctx);
  19037. VerifyContext verify_ctx;
  19038. verify_ctx.session = wolfSSL_get_ex_data(ssl, session_ex_data_index());
  19039. verify_ctx.cert = static_cast<cert_t>(cert);
  19040. verify_ctx.depth = depth;
  19041. verify_ctx.preverify_ok = (preverify_ok != 0);
  19042. verify_ctx.error_code = static_cast<long>(err);
  19043. if (err != 0) {
  19044. verify_ctx.error_string = wolfSSL_X509_verify_cert_error_string(err);
  19045. } else {
  19046. verify_ctx.error_string = nullptr;
  19047. }
  19048. bool accepted = run_verify_callback(*callback, verify_ctx);
  19049. return accepted ? 1 : 0;
  19050. }
  19051. // Sets the verify mode from whether the peer's certificate is required and
  19052. // whether a verify callback is set.
  19053. inline void apply_verify_mode(WolfSSLContext &wctx) {
  19054. auto has_callback = static_cast<bool>(wctx.verify_callback);
  19055. if (wctx.verify_client || has_callback) { disable_server_resumption(&wctx); }
  19056. auto mode = wctx.verify_client
  19057. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  19058. : (has_callback ? SSL_VERIFY_PEER : SSL_VERIFY_NONE);
  19059. wolfSSL_CTX_set_verify(wctx.ctx, mode,
  19060. has_callback ? wolfssl_verify_callback : nullptr);
  19061. }
  19062. inline void set_wolfssl_password_cb(WOLFSSL_CTX *ctx, const char *password) {
  19063. wolfSSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char *>(password));
  19064. wolfSSL_CTX_set_default_passwd_cb(
  19065. ctx, [](char *buf, int size, int /*rwflag*/, void *userdata) -> int {
  19066. auto *pwd = static_cast<const char *>(userdata);
  19067. if (!pwd) return 0;
  19068. auto len = static_cast<int>(strlen(pwd));
  19069. if (len > size) len = size;
  19070. memcpy(buf, pwd, static_cast<size_t>(len));
  19071. return len;
  19072. });
  19073. }
  19074. } // namespace impl
  19075. inline ctx_t create_client_context() {
  19076. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  19077. if (!ctx) { return nullptr; }
  19078. ctx->is_server = false;
  19079. WOLFSSL_METHOD *method = wolfTLSv1_2_client_method();
  19080. if (!method) {
  19081. delete ctx;
  19082. return nullptr;
  19083. }
  19084. ctx->ctx = wolfSSL_CTX_new(method);
  19085. if (!ctx->ctx ||
  19086. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  19087. WOLFSSL_SUCCESS) {
  19088. delete ctx;
  19089. return nullptr;
  19090. }
  19091. // Default: verify peer certificate
  19092. ctx->verify_client = true;
  19093. impl::apply_verify_mode(*ctx);
  19094. return static_cast<ctx_t>(ctx);
  19095. }
  19096. inline ctx_t create_server_context() {
  19097. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  19098. if (!ctx) { return nullptr; }
  19099. ctx->is_server = true;
  19100. WOLFSSL_METHOD *method = wolfTLSv1_2_server_method();
  19101. if (!method) {
  19102. delete ctx;
  19103. return nullptr;
  19104. }
  19105. ctx->ctx = wolfSSL_CTX_new(method);
  19106. if (!ctx->ctx ||
  19107. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  19108. WOLFSSL_SUCCESS) {
  19109. delete ctx;
  19110. return nullptr;
  19111. }
  19112. // Default: don't verify client
  19113. impl::apply_verify_mode(*ctx);
  19114. // Enable SNI on server
  19115. wolfSSL_CTX_SNI_SetOptions(ctx->ctx, WOLFSSL_SNI_HOST_NAME,
  19116. WOLFSSL_SNI_CONTINUE_ON_MISMATCH);
  19117. wolfSSL_CTX_set_servername_callback(ctx->ctx, impl::wolfssl_sni_callback);
  19118. return static_cast<ctx_t>(ctx);
  19119. }
  19120. inline void free_context(ctx_t ctx) {
  19121. if (ctx) { delete static_cast<impl::WolfSSLContext *>(ctx); }
  19122. }
  19123. inline bool set_min_version(ctx_t ctx, Version version) {
  19124. if (!ctx) { return false; }
  19125. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19126. int min_ver = WOLFSSL_TLSV1_2;
  19127. if (version >= Version::TLS1_3) { min_ver = WOLFSSL_TLSV1_3; }
  19128. return wolfSSL_CTX_SetMinVersion(wctx->ctx, min_ver) == WOLFSSL_SUCCESS;
  19129. }
  19130. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  19131. if (!ctx || !pem) { return false; }
  19132. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19133. int ret = wolfSSL_CTX_load_verify_buffer(
  19134. wctx->ctx, reinterpret_cast<const unsigned char *>(pem),
  19135. static_cast<long>(len), SSL_FILETYPE_PEM);
  19136. if (ret != SSL_SUCCESS) {
  19137. impl::wolfssl_last_error() =
  19138. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19139. return false;
  19140. }
  19141. wctx->ca_pem_data_.append(pem, len);
  19142. return true;
  19143. }
  19144. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  19145. if (!ctx || !file_path) { return false; }
  19146. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19147. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, file_path, nullptr);
  19148. if (ret != SSL_SUCCESS) {
  19149. impl::wolfssl_last_error() =
  19150. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19151. return false;
  19152. }
  19153. return true;
  19154. }
  19155. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  19156. if (!ctx || !dir_path) { return false; }
  19157. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19158. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, dir_path);
  19159. // wolfSSL may fail if the directory doesn't contain properly hashed certs.
  19160. // Unlike OpenSSL which lazily loads certs from directories, wolfSSL scans
  19161. // immediately. Return true even on failure since the CA file may have
  19162. // already been loaded, matching OpenSSL's lenient behavior.
  19163. (void)ret;
  19164. return true;
  19165. }
  19166. inline bool load_system_certs(ctx_t ctx) {
  19167. if (!ctx) { return false; }
  19168. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19169. bool loaded = false;
  19170. #ifdef _WIN32
  19171. loaded = impl::enumerate_windows_system_certs(
  19172. [&](const unsigned char *data, size_t len) {
  19173. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  19174. static_cast<long>(len),
  19175. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  19176. });
  19177. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  19178. loaded = impl::enumerate_macos_keychain_certs(
  19179. [&](const unsigned char *data, size_t len) {
  19180. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  19181. static_cast<long>(len),
  19182. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  19183. });
  19184. #else
  19185. for (auto path = impl::system_ca_paths(); *path; ++path) {
  19186. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, *path, nullptr) ==
  19187. SSL_SUCCESS) {
  19188. loaded = true;
  19189. break;
  19190. }
  19191. }
  19192. if (!loaded) {
  19193. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  19194. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, *dir) ==
  19195. SSL_SUCCESS) {
  19196. loaded = true;
  19197. break;
  19198. }
  19199. }
  19200. }
  19201. #endif
  19202. return loaded;
  19203. }
  19204. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  19205. const char *password) {
  19206. if (!ctx || !cert || !key) { return false; }
  19207. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19208. // Load certificate
  19209. int ret = wolfSSL_CTX_use_certificate_buffer(
  19210. wctx->ctx, reinterpret_cast<const unsigned char *>(cert),
  19211. static_cast<long>(strlen(cert)), SSL_FILETYPE_PEM);
  19212. if (ret != SSL_SUCCESS) {
  19213. impl::wolfssl_last_error() =
  19214. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19215. return false;
  19216. }
  19217. // Set password callback if password is provided
  19218. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19219. // Load private key
  19220. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  19221. wctx->ctx, reinterpret_cast<const unsigned char *>(key),
  19222. static_cast<long>(strlen(key)), SSL_FILETYPE_PEM);
  19223. if (ret != SSL_SUCCESS) {
  19224. impl::wolfssl_last_error() =
  19225. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19226. return false;
  19227. }
  19228. // Verify that the certificate and private key match
  19229. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  19230. }
  19231. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  19232. const char *key_path, const char *password) {
  19233. if (!ctx || !cert_path || !key_path) { return false; }
  19234. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19235. // Load certificate file
  19236. int ret =
  19237. wolfSSL_CTX_use_certificate_file(wctx->ctx, cert_path, SSL_FILETYPE_PEM);
  19238. if (ret != SSL_SUCCESS) {
  19239. impl::wolfssl_last_error() =
  19240. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19241. return false;
  19242. }
  19243. // Set password callback if password is provided
  19244. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19245. // Load private key file
  19246. ret = wolfSSL_CTX_use_PrivateKey_file(wctx->ctx, key_path, SSL_FILETYPE_PEM);
  19247. if (ret != SSL_SUCCESS) {
  19248. impl::wolfssl_last_error() =
  19249. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19250. return false;
  19251. }
  19252. // Verify that the certificate and private key match
  19253. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  19254. }
  19255. inline void set_verify_client(ctx_t ctx, bool require) {
  19256. if (!ctx) { return; }
  19257. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19258. wctx->verify_client = require;
  19259. impl::apply_verify_mode(*wctx);
  19260. }
  19261. inline session_t create_session(ctx_t ctx, socket_t sock) {
  19262. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  19263. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19264. auto session = new (std::nothrow) impl::WolfSSLSession();
  19265. if (!session) { return nullptr; }
  19266. session->sock = sock;
  19267. session->ssl = wolfSSL_new(wctx->ctx);
  19268. if (!session->ssl) {
  19269. impl::wolfssl_last_error() =
  19270. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19271. delete session;
  19272. return nullptr;
  19273. }
  19274. if (wolfSSL_set_ex_data(session->ssl, impl::session_ex_data_index(),
  19275. session) != WOLFSSL_SUCCESS) {
  19276. delete session;
  19277. return nullptr;
  19278. }
  19279. wolfSSL_set_fd(session->ssl, static_cast<int>(sock));
  19280. return static_cast<session_t>(session);
  19281. }
  19282. inline void free_session(session_t session) {
  19283. if (session) { delete static_cast<impl::WolfSSLSession *>(session); }
  19284. }
  19285. inline bool set_sni(session_t session, const char *hostname,
  19286. bool verify_hostname) {
  19287. if (!session || !hostname) { return false; }
  19288. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19289. int ret = wolfSSL_UseSNI(wsession->ssl, WOLFSSL_SNI_HOST_NAME, hostname,
  19290. static_cast<word16>(strlen(hostname)));
  19291. if (ret != WOLFSSL_SUCCESS) {
  19292. impl::wolfssl_last_error() =
  19293. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19294. return false;
  19295. }
  19296. // wolfSSL_check_domain_name binds identity checking to the handshake,
  19297. // separately from the SNI extension sent above; skip it when hostname
  19298. // verification is disabled so only the chain is checked, matching OpenSSL.
  19299. if (verify_hostname) { wolfSSL_check_domain_name(wsession->ssl, hostname); }
  19300. wsession->hostname = hostname;
  19301. return true;
  19302. }
  19303. inline TlsError connect(session_t session) {
  19304. TlsError err;
  19305. if (!session) {
  19306. err.code = ErrorCode::Fatal;
  19307. return err;
  19308. }
  19309. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19310. int ret = wolfSSL_connect(wsession->ssl);
  19311. if (ret == SSL_SUCCESS) {
  19312. err.code = ErrorCode::Success;
  19313. } else {
  19314. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19315. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19316. err.backend_code = static_cast<uint64_t>(ssl_error);
  19317. impl::wolfssl_last_error() = err.backend_code;
  19318. }
  19319. return err;
  19320. }
  19321. inline TlsError accept(session_t session) {
  19322. TlsError err;
  19323. if (!session) {
  19324. err.code = ErrorCode::Fatal;
  19325. return err;
  19326. }
  19327. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19328. int ret = wolfSSL_accept(wsession->ssl);
  19329. if (ret == SSL_SUCCESS) {
  19330. err.code = ErrorCode::Success;
  19331. // Capture SNI from thread-local storage after successful handshake
  19332. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  19333. impl::wolfssl_pending_sni().clear();
  19334. } else {
  19335. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19336. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19337. err.backend_code = static_cast<uint64_t>(ssl_error);
  19338. impl::wolfssl_last_error() = err.backend_code;
  19339. }
  19340. return err;
  19341. }
  19342. inline bool connect_nonblocking(session_t session, socket_t sock,
  19343. time_t timeout_sec, time_t timeout_usec,
  19344. TlsError *err) {
  19345. if (!session) {
  19346. if (err) { err->code = ErrorCode::Fatal; }
  19347. return false;
  19348. }
  19349. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19350. // Set socket to non-blocking mode
  19351. detail::set_nonblocking(sock, true);
  19352. auto cleanup =
  19353. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19354. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  19355. int ret;
  19356. while ((ret = wolfSSL_connect(wsession->ssl)) != SSL_SUCCESS) {
  19357. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19358. if (ssl_error == SSL_ERROR_WANT_READ) {
  19359. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  19360. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  19361. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  19362. }
  19363. // Error or timeout
  19364. if (err) {
  19365. err->code =
  19366. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  19367. err->backend_code = static_cast<uint64_t>(ssl_error);
  19368. }
  19369. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  19370. return false;
  19371. }
  19372. if (err) { err->code = ErrorCode::Success; }
  19373. return true;
  19374. }
  19375. inline bool accept_nonblocking(session_t session, socket_t sock,
  19376. time_t timeout_sec, time_t timeout_usec,
  19377. TlsError *err) {
  19378. if (!session) {
  19379. if (err) { err->code = ErrorCode::Fatal; }
  19380. return false;
  19381. }
  19382. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19383. // Set socket to non-blocking mode
  19384. detail::set_nonblocking(sock, true);
  19385. auto cleanup =
  19386. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19387. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  19388. int ret;
  19389. while ((ret = wolfSSL_accept(wsession->ssl)) != SSL_SUCCESS) {
  19390. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19391. if (ssl_error == SSL_ERROR_WANT_READ) {
  19392. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  19393. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  19394. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  19395. }
  19396. // Error or timeout
  19397. if (err) {
  19398. err->code =
  19399. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  19400. err->backend_code = static_cast<uint64_t>(ssl_error);
  19401. }
  19402. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  19403. return false;
  19404. }
  19405. if (err) { err->code = ErrorCode::Success; }
  19406. // Capture SNI from thread-local storage after successful handshake
  19407. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  19408. impl::wolfssl_pending_sni().clear();
  19409. return true;
  19410. }
  19411. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  19412. if (!session || !buf) {
  19413. err.code = ErrorCode::Fatal;
  19414. return -1;
  19415. }
  19416. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19417. int ret = wolfSSL_read(wsession->ssl, buf, static_cast<int>(len));
  19418. if (ret > 0) {
  19419. err.code = ErrorCode::Success;
  19420. return static_cast<ssize_t>(ret);
  19421. }
  19422. if (ret == 0) {
  19423. err.code = ErrorCode::PeerClosed;
  19424. return 0;
  19425. }
  19426. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19427. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19428. err.backend_code = static_cast<uint64_t>(ssl_error);
  19429. impl::wolfssl_last_error() = err.backend_code;
  19430. return -1;
  19431. }
  19432. inline ssize_t write(session_t session, const void *buf, size_t len,
  19433. TlsError &err) {
  19434. if (!session || !buf) {
  19435. err.code = ErrorCode::Fatal;
  19436. return -1;
  19437. }
  19438. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19439. int ret = wolfSSL_write(wsession->ssl, buf, static_cast<int>(len));
  19440. if (ret > 0) {
  19441. err.code = ErrorCode::Success;
  19442. return static_cast<ssize_t>(ret);
  19443. }
  19444. // wolfSSL_write returns 0 when the peer has sent a close_notify.
  19445. // Treat this as an error (return -1) so callers don't spin in a
  19446. // write loop adding zero to the offset.
  19447. if (ret == 0) {
  19448. err.code = ErrorCode::PeerClosed;
  19449. return -1;
  19450. }
  19451. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19452. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19453. err.backend_code = static_cast<uint64_t>(ssl_error);
  19454. impl::wolfssl_last_error() = err.backend_code;
  19455. return -1;
  19456. }
  19457. inline int pending(const_session_t session) {
  19458. if (!session) { return 0; }
  19459. auto wsession =
  19460. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19461. return wolfSSL_pending(wsession->ssl);
  19462. }
  19463. inline void shutdown(session_t session, bool graceful) {
  19464. if (!session) { return; }
  19465. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19466. if (graceful) {
  19467. int ret;
  19468. int attempts = 0;
  19469. while ((ret = wolfSSL_shutdown(wsession->ssl)) != SSL_SUCCESS &&
  19470. attempts < 3) {
  19471. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19472. if (ssl_error != SSL_ERROR_WANT_READ &&
  19473. ssl_error != SSL_ERROR_WANT_WRITE) {
  19474. break;
  19475. }
  19476. attempts++;
  19477. }
  19478. } else {
  19479. wolfSSL_shutdown(wsession->ssl);
  19480. }
  19481. }
  19482. inline bool is_peer_closed(session_t session, socket_t sock) {
  19483. if (!session || sock == INVALID_SOCKET) { return true; }
  19484. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19485. // Check if there's already decrypted data available
  19486. if (wolfSSL_pending(wsession->ssl) > 0) { return false; }
  19487. // Set socket to non-blocking to avoid blocking on read
  19488. detail::set_nonblocking(sock, true);
  19489. auto cleanup =
  19490. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19491. // Peek 1 byte to check connection status without consuming data
  19492. unsigned char buf;
  19493. int ret = wolfSSL_peek(wsession->ssl, &buf, 1);
  19494. // If we got data or WANT_READ (would block), connection is alive
  19495. if (ret > 0) { return false; }
  19496. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19497. if (ssl_error == SSL_ERROR_WANT_READ) { return false; }
  19498. return ssl_error == SSL_ERROR_ZERO_RETURN || ssl_error == SSL_ERROR_SYSCALL ||
  19499. ret == 0;
  19500. }
  19501. inline cert_t get_peer_cert(const_session_t session) {
  19502. if (!session) { return nullptr; }
  19503. auto wsession =
  19504. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19505. WOLFSSL_X509 *cert = wolfSSL_get_peer_certificate(wsession->ssl);
  19506. return static_cast<cert_t>(cert);
  19507. }
  19508. inline size_t get_peer_certs(const_session_t session,
  19509. std::vector<cert_t> &certs) {
  19510. certs.clear();
  19511. if (!session) { return 0; }
  19512. // wolfSSL keeps the received chain only when built with SESSION_CERTS
  19513. #ifdef SESSION_CERTS
  19514. auto wsession =
  19515. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19516. auto chain = wolfSSL_get_peer_chain(wsession->ssl);
  19517. auto count = chain ? wolfSSL_get_chain_count(chain) : 0;
  19518. for (int i = 0; i < count; i++) {
  19519. auto x509 = wolfSSL_get_chain_X509(chain, i);
  19520. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19521. }
  19522. #endif
  19523. return certs.size();
  19524. }
  19525. inline void free_cert(cert_t cert) {
  19526. if (cert) { wolfSSL_X509_free(static_cast<WOLFSSL_X509 *>(cert)); }
  19527. }
  19528. inline bool verify_hostname(cert_t cert, const char *hostname) {
  19529. if (!cert || !hostname) { return false; }
  19530. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19531. std::string host_str(hostname);
  19532. // Check if hostname is an IP address (IPv4 or IPv6)
  19533. unsigned char ip_bytes[16];
  19534. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  19535. auto is_ip = ip_len > 0;
  19536. // Check Subject Alternative Names
  19537. auto has_dns_san = false;
  19538. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  19539. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  19540. if (san_names) {
  19541. int san_count = wolfSSL_sk_num(san_names);
  19542. for (int i = 0; i < san_count; i++) {
  19543. auto *names =
  19544. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  19545. if (!names) continue;
  19546. if (!is_ip && names->type == WOLFSSL_GEN_DNS) {
  19547. // DNS name
  19548. has_dns_san = true;
  19549. unsigned char *dns_name = nullptr;
  19550. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, names->d.dNSName);
  19551. if (dns_name && dns_len > 0) {
  19552. std::string san_name(reinterpret_cast<char *>(dns_name),
  19553. static_cast<size_t>(dns_len));
  19554. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  19555. if (detail::match_hostname(san_name, host_str)) {
  19556. wolfSSL_sk_free(san_names);
  19557. return true;
  19558. }
  19559. }
  19560. } else if (is_ip && names->type == WOLFSSL_GEN_IPADD) {
  19561. // IP address: only an iPAddress SAN of the same family (4 bytes for
  19562. // IPv4, 16 bytes for IPv6) may authenticate the host.
  19563. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(names->d.iPAddress);
  19564. auto san_ip_len = wolfSSL_ASN1_STRING_length(names->d.iPAddress);
  19565. if (ip_data && san_ip_len == static_cast<int>(ip_len) &&
  19566. memcmp(ip_data, ip_bytes, ip_len) == 0) {
  19567. wolfSSL_sk_free(san_names);
  19568. return true;
  19569. }
  19570. }
  19571. }
  19572. wolfSSL_sk_free(san_names);
  19573. }
  19574. // Fallback: the Common Name (CN) in the subject, as X509_check_host does it:
  19575. // never for an IP host, which only an iPAddress SAN names, and never next to
  19576. // a DNS SAN (RFC 6125 6.4.4).
  19577. if (is_ip || has_dns_san) { return false; }
  19578. auto cn = get_cert_subject_cn(cert);
  19579. return !cn.empty() && detail::match_hostname(cn, host_str);
  19580. }
  19581. inline uint64_t hostname_mismatch_code() {
  19582. return static_cast<uint64_t>(DOMAIN_NAME_MISMATCH);
  19583. }
  19584. inline long get_verify_result(const_session_t session) {
  19585. if (!session) { return -1; }
  19586. auto wsession =
  19587. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19588. long result = wolfSSL_get_verify_result(wsession->ssl);
  19589. return result;
  19590. }
  19591. inline std::string get_cert_subject_cn(cert_t cert) {
  19592. if (!cert) return "";
  19593. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19594. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19595. if (!subject) return "";
  19596. char cn[256] = {};
  19597. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  19598. sizeof(cn));
  19599. if (cn_len <= 0) return "";
  19600. return std::string(cn, static_cast<size_t>(cn_len));
  19601. }
  19602. inline std::string get_cert_issuer_name(cert_t cert) {
  19603. if (!cert) return "";
  19604. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19605. WOLFSSL_X509_NAME *issuer = wolfSSL_X509_get_issuer_name(x509);
  19606. if (!issuer) return "";
  19607. char *name_str = wolfSSL_X509_NAME_oneline(issuer, nullptr, 0);
  19608. if (!name_str) return "";
  19609. std::string result(name_str);
  19610. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19611. return result;
  19612. }
  19613. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  19614. sans.clear();
  19615. if (!cert) return false;
  19616. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19617. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  19618. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  19619. if (!san_names) return true; // No SANs is not an error
  19620. int count = wolfSSL_sk_num(san_names);
  19621. for (int i = 0; i < count; i++) {
  19622. auto *name =
  19623. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  19624. if (!name) continue;
  19625. SanEntry entry;
  19626. switch (name->type) {
  19627. case WOLFSSL_GEN_DNS: {
  19628. entry.type = SanType::DNS;
  19629. unsigned char *dns_name = nullptr;
  19630. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, name->d.dNSName);
  19631. if (dns_name && dns_len > 0) {
  19632. entry.value = std::string(reinterpret_cast<char *>(dns_name),
  19633. static_cast<size_t>(dns_len));
  19634. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  19635. }
  19636. break;
  19637. }
  19638. case WOLFSSL_GEN_IPADD: {
  19639. entry.type = SanType::IP;
  19640. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(name->d.iPAddress);
  19641. int ip_len = wolfSSL_ASN1_STRING_length(name->d.iPAddress);
  19642. if (ip_data && ip_len == 4) {
  19643. char buf[16];
  19644. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", ip_data[0], ip_data[1],
  19645. ip_data[2], ip_data[3]);
  19646. entry.value = buf;
  19647. } else if (ip_data && ip_len == 16) {
  19648. char buf[64];
  19649. snprintf(buf, sizeof(buf),
  19650. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  19651. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  19652. ip_data[0], ip_data[1], ip_data[2], ip_data[3], ip_data[4],
  19653. ip_data[5], ip_data[6], ip_data[7], ip_data[8], ip_data[9],
  19654. ip_data[10], ip_data[11], ip_data[12], ip_data[13],
  19655. ip_data[14], ip_data[15]);
  19656. entry.value = buf;
  19657. }
  19658. break;
  19659. }
  19660. case WOLFSSL_GEN_EMAIL:
  19661. entry.type = SanType::EMAIL;
  19662. {
  19663. unsigned char *email = nullptr;
  19664. int email_len = wolfSSL_ASN1_STRING_to_UTF8(&email, name->d.rfc822Name);
  19665. if (email && email_len > 0) {
  19666. entry.value = std::string(reinterpret_cast<char *>(email),
  19667. static_cast<size_t>(email_len));
  19668. XFREE(email, nullptr, DYNAMIC_TYPE_OPENSSL);
  19669. }
  19670. }
  19671. break;
  19672. case WOLFSSL_GEN_URI:
  19673. entry.type = SanType::URI;
  19674. {
  19675. unsigned char *uri = nullptr;
  19676. int uri_len = wolfSSL_ASN1_STRING_to_UTF8(
  19677. &uri, name->d.uniformResourceIdentifier);
  19678. if (uri && uri_len > 0) {
  19679. entry.value = std::string(reinterpret_cast<char *>(uri),
  19680. static_cast<size_t>(uri_len));
  19681. XFREE(uri, nullptr, DYNAMIC_TYPE_OPENSSL);
  19682. }
  19683. }
  19684. break;
  19685. default: entry.type = SanType::OTHER; break;
  19686. }
  19687. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  19688. }
  19689. wolfSSL_sk_free(san_names);
  19690. return true;
  19691. }
  19692. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  19693. time_t &not_after) {
  19694. if (!cert) return false;
  19695. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19696. const WOLFSSL_ASN1_TIME *nb = wolfSSL_X509_get_notBefore(x509);
  19697. const WOLFSSL_ASN1_TIME *na = wolfSSL_X509_get_notAfter(x509);
  19698. if (!nb || !na) return false;
  19699. // wolfSSL_ASN1_TIME_to_tm is available
  19700. struct tm tm_nb = {}, tm_na = {};
  19701. if (wolfSSL_ASN1_TIME_to_tm(nb, &tm_nb) != WOLFSSL_SUCCESS) return false;
  19702. if (wolfSSL_ASN1_TIME_to_tm(na, &tm_na) != WOLFSSL_SUCCESS) return false;
  19703. #ifdef _WIN32
  19704. not_before = _mkgmtime(&tm_nb);
  19705. not_after = _mkgmtime(&tm_na);
  19706. #else
  19707. not_before = timegm(&tm_nb);
  19708. not_after = timegm(&tm_na);
  19709. #endif
  19710. return true;
  19711. }
  19712. inline std::string get_cert_serial(cert_t cert) {
  19713. if (!cert) return "";
  19714. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19715. WOLFSSL_ASN1_INTEGER *serial_asn1 = wolfSSL_X509_get_serialNumber(x509);
  19716. if (!serial_asn1) return "";
  19717. // Get the serial number data
  19718. int len = serial_asn1->length;
  19719. unsigned char *data = serial_asn1->data;
  19720. if (!data || len <= 0) return "";
  19721. std::string result;
  19722. result.reserve(static_cast<size_t>(len) * 2);
  19723. for (int i = 0; i < len; i++) {
  19724. char hex[3];
  19725. snprintf(hex, sizeof(hex), "%02X", data[i]);
  19726. result += hex;
  19727. }
  19728. return result;
  19729. }
  19730. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  19731. if (!cert) return false;
  19732. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19733. int der_len = 0;
  19734. const unsigned char *der_data = wolfSSL_X509_get_der(x509, &der_len);
  19735. if (!der_data || der_len <= 0) return false;
  19736. der.assign(der_data, der_data + der_len);
  19737. return true;
  19738. }
  19739. inline const char *get_sni(const_session_t session) {
  19740. if (!session) return nullptr;
  19741. auto wsession = static_cast<const impl::WolfSSLSession *>(session);
  19742. // For server: return SNI received from client during handshake
  19743. if (!wsession->sni_hostname.empty()) {
  19744. return wsession->sni_hostname.c_str();
  19745. }
  19746. // For client: return the hostname set via set_sni
  19747. if (!wsession->hostname.empty()) { return wsession->hostname.c_str(); }
  19748. return nullptr;
  19749. }
  19750. inline uint64_t peek_error() {
  19751. return static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19752. }
  19753. inline uint64_t get_error() {
  19754. uint64_t err = impl::wolfssl_last_error();
  19755. impl::wolfssl_last_error() = 0;
  19756. return err;
  19757. }
  19758. inline std::string error_string(uint64_t code) {
  19759. char buf[256];
  19760. wolfSSL_ERR_error_string(static_cast<unsigned long>(code), buf);
  19761. return std::string(buf);
  19762. }
  19763. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  19764. if (!pem || len == 0) { return nullptr; }
  19765. // Validate by attempting to load into a temporary ctx
  19766. WOLFSSL_CTX *tmp_ctx = wolfSSL_CTX_new(wolfTLSv1_2_client_method());
  19767. if (!tmp_ctx) { return nullptr; }
  19768. int ret = wolfSSL_CTX_load_verify_buffer(
  19769. tmp_ctx, reinterpret_cast<const unsigned char *>(pem),
  19770. static_cast<long>(len), SSL_FILETYPE_PEM);
  19771. wolfSSL_CTX_free(tmp_ctx);
  19772. if (ret != SSL_SUCCESS) { return nullptr; }
  19773. return static_cast<ca_store_t>(
  19774. new impl::WolfSSLCAStore{std::string(pem, len)});
  19775. }
  19776. inline void free_ca_store(ca_store_t store) {
  19777. delete static_cast<impl::WolfSSLCAStore *>(store);
  19778. }
  19779. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  19780. if (!ctx || !store) { return false; }
  19781. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19782. auto *ca = static_cast<impl::WolfSSLCAStore *>(store);
  19783. int ret = wolfSSL_CTX_load_verify_buffer(
  19784. wctx->ctx, reinterpret_cast<const unsigned char *>(ca->pem_data.data()),
  19785. static_cast<long>(ca->pem_data.size()), SSL_FILETYPE_PEM);
  19786. if (ret == SSL_SUCCESS) { wctx->ca_pem_data_ += ca->pem_data; }
  19787. // This function takes ownership of the store; the PEM data was copied into
  19788. // the context, so release the source
  19789. free_ca_store(store);
  19790. return ret == SSL_SUCCESS;
  19791. }
  19792. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  19793. certs.clear();
  19794. if (!ctx) { return 0; }
  19795. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19796. if (wctx->ca_pem_data_.empty()) { return 0; }
  19797. const std::string &pem = wctx->ca_pem_data_;
  19798. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19799. const std::string end_marker = "-----END CERTIFICATE-----";
  19800. size_t pos = 0;
  19801. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19802. size_t end_pos = pem.find(end_marker, pos);
  19803. if (end_pos == std::string::npos) { break; }
  19804. end_pos += end_marker.size();
  19805. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19806. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19807. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19808. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19809. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19810. pos = end_pos;
  19811. }
  19812. return certs.size();
  19813. }
  19814. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  19815. std::vector<std::string> names;
  19816. if (!ctx) { return names; }
  19817. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19818. if (wctx->ca_pem_data_.empty()) { return names; }
  19819. const std::string &pem = wctx->ca_pem_data_;
  19820. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19821. const std::string end_marker = "-----END CERTIFICATE-----";
  19822. size_t pos = 0;
  19823. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19824. size_t end_pos = pem.find(end_marker, pos);
  19825. if (end_pos == std::string::npos) { break; }
  19826. end_pos += end_marker.size();
  19827. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19828. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19829. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19830. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19831. if (x509) {
  19832. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19833. if (subject) {
  19834. char *name_str = wolfSSL_X509_NAME_oneline(subject, nullptr, 0);
  19835. if (name_str) {
  19836. names.push_back(name_str);
  19837. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19838. }
  19839. }
  19840. wolfSSL_X509_free(x509);
  19841. }
  19842. pos = end_pos;
  19843. }
  19844. return names;
  19845. }
  19846. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  19847. const char *key_pem, const char *password) {
  19848. if (!ctx || !cert_pem || !key_pem) { return false; }
  19849. // Try the pair on a scratch context first, so that a bad one leaves the
  19850. // server's certificate and key as they were
  19851. auto tmp = create_server_context();
  19852. if (!tmp) { return false; }
  19853. auto se = detail::scope_exit([&] { free_context(tmp); });
  19854. if (!set_client_cert_pem(tmp, cert_pem, key_pem, password)) { return false; }
  19855. return set_client_cert_pem(ctx, cert_pem, key_pem, password);
  19856. }
  19857. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  19858. if (!ctx || !ca_pem) { return false; }
  19859. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19860. // Replace the CAs rather than add to them, as the other backends do, once
  19861. // the new ones are known to load
  19862. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  19863. if (!store) { return false; }
  19864. free_ca_store(store);
  19865. wolfSSL_CTX_UnloadCAs(wctx->ctx);
  19866. wctx->ca_pem_data_.clear();
  19867. return load_ca_pem(ctx, ca_pem, strlen(ca_pem));
  19868. }
  19869. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  19870. if (!ctx) { return false; }
  19871. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19872. auto stored = callback ? std::make_shared<VerifyCallback>(std::move(callback))
  19873. : nullptr;
  19874. {
  19875. std::lock_guard<std::mutex> guard(impl::verify_callback_mutex());
  19876. // A handshake running the previous callback keeps it until it returns.
  19877. wctx->verify_callback.swap(stored);
  19878. }
  19879. impl::apply_verify_mode(*wctx);
  19880. return true;
  19881. }
  19882. inline long get_verify_error(const_session_t session) {
  19883. if (!session) { return -1; }
  19884. auto *wsession =
  19885. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19886. return wolfSSL_get_verify_result(wsession->ssl);
  19887. }
  19888. inline std::string verify_error_string(long error_code) {
  19889. if (error_code == 0) { return ""; }
  19890. const char *str =
  19891. wolfSSL_X509_verify_cert_error_string(static_cast<int>(error_code));
  19892. return str ? std::string(str) : std::string();
  19893. }
  19894. } // namespace tls
  19895. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  19896. // WebSocket implementation
  19897. namespace ws {
  19898. inline bool WebSocket::send_frame(Opcode op, const char *data, size_t len,
  19899. bool fin) {
  19900. std::lock_guard<std::mutex> lock(write_mutex_);
  19901. if (closed_) { return false; }
  19902. return detail::write_websocket_frame(strm_, op, data, len, fin, !is_server_);
  19903. }
  19904. inline ReadResult WebSocket::read(std::string &msg) {
  19905. // Answers a control frame; any other opcode here is a protocol error.
  19906. // Returns false when the connection is done.
  19907. auto handle_control = [&](Opcode op, const std::string &payload) -> bool {
  19908. switch (op) {
  19909. case Opcode::Ping: {
  19910. std::lock_guard<std::mutex> lock(write_mutex_);
  19911. detail::write_websocket_frame(strm_, Opcode::Pong, payload.data(),
  19912. payload.size(), true, !is_server_);
  19913. return true;
  19914. }
  19915. case Opcode::Pong: {
  19916. std::lock_guard<std::mutex> lock(ping_mutex_);
  19917. unacked_pings_ = 0;
  19918. return true;
  19919. }
  19920. case Opcode::Close: {
  19921. // RFC 6455 §5.5.1: a Close is echoed back, unless its payload is
  19922. // malformed, which is answered with a protocol error instead.
  19923. if (closed_.exchange(true)) { return false; }
  19924. auto reply = payload;
  19925. if (!impl::is_valid_close_payload(payload)) {
  19926. auto code = static_cast<uint16_t>(CloseStatus::ProtocolError);
  19927. reply = {static_cast<char>(code >> 8), static_cast<char>(code & 0xff)};
  19928. }
  19929. std::lock_guard<std::mutex> lock(write_mutex_);
  19930. detail::write_websocket_frame(strm_, Opcode::Close, reply.data(),
  19931. reply.size(), true, !is_server_);
  19932. return false;
  19933. }
  19934. default: closed_ = true; return false;
  19935. }
  19936. };
  19937. std::unique_lock<std::mutex> read_lock(read_mutex_);
  19938. while (!closed_) {
  19939. Opcode opcode;
  19940. std::string payload;
  19941. bool fin;
  19942. impl::FrameRead r =
  19943. impl::read_websocket_frame(strm_, opcode, payload, fin, is_server_,
  19944. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH);
  19945. // A timeout landed on a frame boundary of an open connection: it is
  19946. // untouched and still usable, so hand control back without closing it.
  19947. // That is only useful to a caller who asked for the timeout; the
  19948. // compile-time default is a backstop against a peer gone quiet, and
  19949. // elapsing it closes the connection so a plain `while (ws.read(msg))` loop
  19950. // ends. A wait that a pong timeout cut short finds the connection closed.
  19951. if (r == impl::FrameRead::Timeout && read_timeout_set_ && !closed_) {
  19952. return Timeout;
  19953. }
  19954. if (r != impl::FrameRead::Ok) {
  19955. closed_ = true;
  19956. return Fail;
  19957. }
  19958. switch (opcode) {
  19959. case Opcode::Text:
  19960. case Opcode::Binary: {
  19961. auto result = opcode == Opcode::Text ? Text : Binary;
  19962. msg = std::move(payload);
  19963. // Handle fragmentation
  19964. if (!fin) {
  19965. while (true) {
  19966. Opcode cont_opcode;
  19967. std::string cont_payload;
  19968. bool cont_fin;
  19969. // Only what is left of the limit, but room for a control frame,
  19970. // which may come between the fragments.
  19971. auto max_len =
  19972. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH == 0
  19973. ? size_t(0)
  19974. : (std::max)(size_t(125),
  19975. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH -
  19976. msg.size());
  19977. // A timeout is not reportable here: half of a fragmented message is
  19978. // already in `msg` and read() has no way to resume it, so it is a
  19979. // failure like any other. Timeouts are only ever seen on a message
  19980. // boundary.
  19981. if (impl::read_websocket_frame(strm_, cont_opcode, cont_payload,
  19982. cont_fin, is_server_,
  19983. max_len) != impl::FrameRead::Ok) {
  19984. closed_ = true;
  19985. return Fail;
  19986. }
  19987. // RFC 6455 5.4: the fragments are continuation frames, with only
  19988. // control frames between them.
  19989. if (cont_opcode != Opcode::Continuation) {
  19990. if (handle_control(cont_opcode, cont_payload)) { continue; }
  19991. return Fail;
  19992. }
  19993. msg += cont_payload;
  19994. if (CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH > 0 &&
  19995. msg.size() > CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) {
  19996. closed_ = true;
  19997. return Fail;
  19998. }
  19999. if (cont_fin) { break; }
  20000. }
  20001. }
  20002. // RFC 6455 Section 5.6: text frames must contain valid UTF-8
  20003. if (result == Text && !impl::is_valid_utf8(msg)) {
  20004. // close() takes the read lock to wait for the peer's Close reply, so
  20005. // it must not run while this thread still holds it.
  20006. read_lock.unlock();
  20007. close(CloseStatus::InvalidPayload, "invalid UTF-8");
  20008. return Fail;
  20009. }
  20010. return result;
  20011. }
  20012. default:
  20013. if (handle_control(opcode, payload)) { continue; }
  20014. return Fail;
  20015. }
  20016. }
  20017. return Fail;
  20018. }
  20019. inline bool WebSocket::send(const std::string &data) {
  20020. return send_frame(Opcode::Text, data.data(), data.size());
  20021. }
  20022. inline bool WebSocket::send(const char *data, size_t len) {
  20023. return send_frame(Opcode::Binary, data, len);
  20024. }
  20025. inline void WebSocket::close(CloseStatus status, const std::string &reason) {
  20026. if (closed_.exchange(true)) { return; }
  20027. ping_cv_.notify_all();
  20028. std::string payload;
  20029. auto code = static_cast<uint16_t>(status);
  20030. payload.push_back(static_cast<char>((code >> 8) & 0xFF));
  20031. payload.push_back(static_cast<char>(code & 0xFF));
  20032. // RFC 6455 Section 5.5: control frame payload must not exceed 125 bytes
  20033. // Close frame has 2-byte status code, so reason is limited to 123 bytes,
  20034. // cut back to a whole UTF-8 character
  20035. auto short_reason = reason.substr(0, 123);
  20036. while (!short_reason.empty() && !impl::is_valid_utf8(short_reason)) {
  20037. short_reason.pop_back();
  20038. }
  20039. payload += short_reason;
  20040. // A code that may not be sent, such as NoStatus, goes without a payload
  20041. if (!impl::is_valid_close_payload(payload)) { payload.clear(); }
  20042. {
  20043. std::lock_guard<std::mutex> lock(write_mutex_);
  20044. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  20045. payload.size(), true, !is_server_);
  20046. }
  20047. // RFC 6455 Section 7.1.1: after sending a Close frame, wait for the peer's
  20048. // Close response before closing the TCP connection.
  20049. //
  20050. // Wait only when no other thread is parsing frames. When one is, it is the
  20051. // thread positioned to see the peer's reply, and reading here would take
  20052. // bytes out of the message it is assembling. Bailing out also leaves the
  20053. // stream, including its read timeout, entirely to that thread.
  20054. std::unique_lock<std::mutex> read_lock(read_mutex_, std::try_to_lock);
  20055. if (!read_lock.owns_lock()) { return; }
  20056. // Use a short timeout to avoid hanging if the peer doesn't respond.
  20057. strm_.set_read_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  20058. Opcode op;
  20059. std::string resp;
  20060. bool fin;
  20061. while (impl::read_websocket_frame(strm_, op, resp, fin, is_server_, 125) ==
  20062. impl::FrameRead::Ok) {
  20063. if (op == Opcode::Close) { break; }
  20064. }
  20065. }
  20066. inline WebSocket::~WebSocket() {
  20067. {
  20068. std::lock_guard<std::mutex> lock(ping_mutex_);
  20069. closed_ = true;
  20070. }
  20071. ping_cv_.notify_all();
  20072. if (ping_thread_.joinable()) { ping_thread_.join(); }
  20073. // A server's stream outlives this object
  20074. strm_.set_read_interrupt(nullptr);
  20075. }
  20076. inline void WebSocket::start_heartbeat() {
  20077. if (ping_interval_sec_ <= 0) { return; }
  20078. // A pong timeout ends a read() blocked on the silent peer
  20079. if (max_missed_pongs_ > 0) {
  20080. strm_.set_read_interrupt([this] { return pong_timed_out_.load(); });
  20081. }
  20082. ping_thread_ = std::thread([this]() {
  20083. std::unique_lock<std::mutex> lock(ping_mutex_);
  20084. // The predicate keeps a spurious wakeup from sending a ping early
  20085. while (!ping_cv_.wait_for(lock, std::chrono::seconds(ping_interval_sec_),
  20086. [this]() { return closed_.load(); })) {
  20087. // If the peer has failed to respond to the previous pings, give up.
  20088. // RFC 6455 does not define a pong-timeout mechanism; this is an
  20089. // opt-in liveness check controlled by max_missed_pongs_.
  20090. if (max_missed_pongs_ > 0 && unacked_pings_ >= max_missed_pongs_) {
  20091. lock.unlock();
  20092. close(CloseStatus::GoingAway, "pong timeout");
  20093. pong_timed_out_ = true;
  20094. return;
  20095. }
  20096. lock.unlock();
  20097. if (!send_frame(Opcode::Ping, nullptr, 0)) {
  20098. lock.lock();
  20099. closed_ = true;
  20100. break;
  20101. }
  20102. lock.lock();
  20103. unacked_pings_++;
  20104. }
  20105. });
  20106. }
  20107. inline const Request &WebSocket::request() const { return req_; }
  20108. inline bool WebSocket::is_open() const { return !closed_; }
  20109. inline void WebSocket::set_read_timeout(time_t sec, time_t usec) {
  20110. // 0 waits forever here, as it does for SO_RCVTIMEO. The stream waits with
  20111. // poll(), where 0 would instead mean "return immediately", so hand it the
  20112. // negative poll uses for an unbounded wait.
  20113. if (sec == 0 && usec == 0) { sec = -1; }
  20114. strm_.set_read_timeout(sec, usec);
  20115. read_timeout_set_ = true;
  20116. }
  20117. // WebSocketClient implementation
  20118. inline WebSocketClient::WebSocketClient(
  20119. const std::string &scheme_host_port_path, const Headers &headers)
  20120. : headers_(headers) {
  20121. detail::UrlComponents uc;
  20122. if (detail::parse_url(scheme_host_port_path, uc) && !uc.scheme.empty() &&
  20123. !uc.host.empty() && !uc.path.empty()) {
  20124. auto &scheme = uc.scheme;
  20125. #ifdef CPPHTTPLIB_SSL_ENABLED
  20126. if (scheme != "ws" && scheme != "wss") {
  20127. #else
  20128. if (scheme != "ws") {
  20129. #endif
  20130. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  20131. std::string msg = "'" + scheme + "' scheme is not supported.";
  20132. throw std::invalid_argument(msg);
  20133. #endif
  20134. return;
  20135. }
  20136. auto is_ssl = scheme == "wss";
  20137. host_ = std::move(uc.host);
  20138. port_ = is_ssl ? 443 : 80;
  20139. if (!uc.port.empty() && !detail::parse_port(uc.port, port_)) { return; }
  20140. path_ = std::move(uc.path);
  20141. if (!uc.query.empty()) { path_ += uc.query; }
  20142. #ifdef CPPHTTPLIB_SSL_ENABLED
  20143. is_ssl_ = is_ssl;
  20144. if (is_ssl_) {
  20145. // The context lives as long as the client so that CA configuration
  20146. // survives reconnects; sessions are created per connection.
  20147. tls_ctx_ = tls::create_client_context();
  20148. if (!tls_ctx_) { return; }
  20149. }
  20150. #else
  20151. if (is_ssl) { return; }
  20152. #endif
  20153. is_valid_ = true;
  20154. }
  20155. }
  20156. #ifdef CPPHTTPLIB_SSL_ENABLED
  20157. inline WebSocketClient::WebSocketClient(
  20158. const std::string &scheme_host_port_path, const PemMemory &pem,
  20159. const Headers &headers)
  20160. : WebSocketClient(scheme_host_port_path, headers) {
  20161. // For ws:// URLs the client certificate is silently ignored, consistent
  20162. // with the TLS-only setters such as set_ca_cert_path().
  20163. if (is_valid_ && is_ssl_ && pem.cert_pem && pem.key_pem) {
  20164. std::string cert_buf, key_buf;
  20165. if (!tls::set_client_cert_pem(
  20166. tls_ctx_,
  20167. detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  20168. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  20169. pem.private_key_password)) {
  20170. tls::free_context(tls_ctx_);
  20171. tls_ctx_ = nullptr;
  20172. is_valid_ = false;
  20173. }
  20174. }
  20175. }
  20176. #endif
  20177. inline WebSocketClient::~WebSocketClient() {
  20178. shutdown_and_close();
  20179. #ifdef CPPHTTPLIB_SSL_ENABLED
  20180. if (tls_ctx_) {
  20181. tls::free_context(tls_ctx_);
  20182. tls_ctx_ = nullptr;
  20183. }
  20184. #endif
  20185. }
  20186. inline bool WebSocketClient::is_valid() const { return is_valid_; }
  20187. inline void WebSocketClient::shutdown_and_close() {
  20188. // Send the close frame while the TLS session is still alive: ws_ holds an
  20189. // SSLSocketStream that keeps a raw pointer to tls_session_, so the session
  20190. // must outlive ws_->close() and ws_.reset() to avoid a use-after-free.
  20191. if (ws_ && ws_->is_open()) { ws_->close(); }
  20192. ws_.reset();
  20193. #ifdef CPPHTTPLIB_SSL_ENABLED
  20194. if (is_ssl_) {
  20195. if (tls_session_) {
  20196. tls::shutdown(tls_session_, true);
  20197. tls::free_session(tls_session_);
  20198. tls_session_ = nullptr;
  20199. }
  20200. }
  20201. #endif
  20202. if (sock_ != INVALID_SOCKET) {
  20203. detail::shutdown_socket(sock_);
  20204. detail::close_socket(sock_);
  20205. sock_ = INVALID_SOCKET;
  20206. }
  20207. }
  20208. // The handshakes belong to establishing the connection, so an unset read
  20209. // timeout leaves them bounded by the connection timeout instead of forever.
  20210. inline std::pair<time_t, time_t> WebSocketClient::handshake_timeout() const {
  20211. if (read_timeout_sec_ == 0 && read_timeout_usec_ == 0) {
  20212. return {connection_timeout_sec_, connection_timeout_usec_};
  20213. }
  20214. return {read_timeout_sec_, read_timeout_usec_};
  20215. }
  20216. inline bool WebSocketClient::create_stream(std::unique_ptr<Stream> &strm,
  20217. Error &error, int &ssl_error,
  20218. uint64_t &ssl_backend_error) {
  20219. // A read timeout of 0 means "wait forever", the way SO_RCVTIMEO reads it.
  20220. // The streams wait with poll(), where 0 instead means "return immediately",
  20221. // so they are given the negative poll uses for an unbounded wait.
  20222. auto unbounded = read_timeout_sec_ == 0 && read_timeout_usec_ == 0;
  20223. time_t strm_read_sec = unbounded ? -1 : read_timeout_sec_;
  20224. time_t strm_read_usec = unbounded ? 0 : read_timeout_usec_;
  20225. #ifdef CPPHTTPLIB_SSL_ENABLED
  20226. if (is_ssl_) {
  20227. // A plain flag rather than SSLClient::load_certs()'s call_once: connect()
  20228. // is not safe to call concurrently on one client to begin with, since
  20229. // nothing else here is guarded either.
  20230. if (server_certificate_verification_ && !certs_loaded_) {
  20231. uint64_t backend_error = 0;
  20232. detail::load_client_ca_config(tls_ctx_, ca_cert_file_path_,
  20233. ca_cert_dir_path_, custom_ca_loaded_,
  20234. system_ca_mode_, backend_error);
  20235. certs_loaded_ = true;
  20236. }
  20237. detail::ClientTlsSessionOptions options;
  20238. options.server_hostname_verification = server_hostname_verification_;
  20239. options.session_verifier = session_verifier_;
  20240. auto timeout = handshake_timeout();
  20241. detail::ClientTlsSessionError tls_error;
  20242. if (!detail::setup_client_tls_session(host_, tls_ctx_, tls_session_, sock_,
  20243. server_certificate_verification_,
  20244. timeout.first, timeout.second,
  20245. &tls_error, options)) {
  20246. error = tls_error.error;
  20247. ssl_error = tls_error.ssl_error;
  20248. ssl_backend_error = tls_error.backend_error;
  20249. return false;
  20250. }
  20251. strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  20252. sock_, tls_session_, strm_read_sec, strm_read_usec, write_timeout_sec_,
  20253. write_timeout_usec_));
  20254. return true;
  20255. }
  20256. #else
  20257. (void)error;
  20258. (void)ssl_error;
  20259. (void)ssl_backend_error;
  20260. #endif
  20261. strm = std::unique_ptr<Stream>(
  20262. new detail::SocketStream(sock_, strm_read_sec, strm_read_usec,
  20263. write_timeout_sec_, write_timeout_usec_));
  20264. return true;
  20265. }
  20266. inline void WebSocketClient::prepare_default_headers(Request &req) {
  20267. #ifdef CPPHTTPLIB_SSL_ENABLED
  20268. auto is_ssl = is_ssl_;
  20269. #else
  20270. auto is_ssl = false;
  20271. #endif
  20272. if (!req.has_header("Host")) {
  20273. req.headers.emplace("Host", detail::make_default_host_header_value(
  20274. host_, port_, is_ssl, address_family_));
  20275. }
  20276. detail::add_default_user_agent_header(req);
  20277. }
  20278. inline Result WebSocketClient::connect() {
  20279. if (!is_valid_) { return Result{Error::Connection, -1, Headers{}}; }
  20280. shutdown_and_close();
  20281. auto error = Error::Success;
  20282. if (!create_and_connect_socket(error)) {
  20283. return Result{error, -1, Headers{}};
  20284. }
  20285. if (is_proxy_enabled()) {
  20286. Response proxy_res;
  20287. if (!connect_with_proxy(proxy_res, error)) {
  20288. shutdown_and_close();
  20289. return Result{error, proxy_res.status, std::move(proxy_res.headers)};
  20290. }
  20291. }
  20292. std::unique_ptr<Stream> strm;
  20293. auto stream_error = Error::SSLConnection;
  20294. int ssl_error = 0;
  20295. uint64_t ssl_backend_error = 0;
  20296. if (!create_stream(strm, stream_error, ssl_error, ssl_backend_error)) {
  20297. shutdown_and_close();
  20298. #ifdef CPPHTTPLIB_SSL_ENABLED
  20299. return Result{stream_error, -1, Headers{}, ssl_error, ssl_backend_error};
  20300. #else
  20301. return Result{stream_error, -1, Headers{}};
  20302. #endif
  20303. }
  20304. Request req;
  20305. req.method = "GET";
  20306. req.path = path_;
  20307. req.headers = headers_;
  20308. prepare_default_headers(req);
  20309. detail::WebSocketUpgradeResponse upgrade;
  20310. if (!detail::perform_websocket_handshake(*strm, req, upgrade)) {
  20311. shutdown_and_close();
  20312. return Result{upgrade.error, upgrade.status, std::move(upgrade.headers)};
  20313. }
  20314. subprotocol_ = std::move(upgrade.selected_subprotocol);
  20315. ws_ = std::unique_ptr<WebSocket>(new WebSocket(std::move(strm), req, false,
  20316. websocket_ping_interval_sec_,
  20317. websocket_max_missed_pongs_));
  20318. // The stream was created with the timeout already; tell the WebSocket
  20319. // whether it came from the caller, so read() knows to report it as Timeout.
  20320. ws_->read_timeout_set_ = read_timeout_set_;
  20321. return Result{Error::Success, upgrade.status, std::move(upgrade.headers)};
  20322. }
  20323. inline ReadResult WebSocketClient::read(std::string &msg) {
  20324. if (!ws_) { return Fail; }
  20325. return ws_->read(msg);
  20326. }
  20327. inline bool WebSocketClient::send(const std::string &data) {
  20328. if (!ws_) { return false; }
  20329. return ws_->send(data);
  20330. }
  20331. inline bool WebSocketClient::send(const char *data, size_t len) {
  20332. if (!ws_) { return false; }
  20333. return ws_->send(data, len);
  20334. }
  20335. inline void WebSocketClient::close(CloseStatus status,
  20336. const std::string &reason) {
  20337. if (ws_) { ws_->close(status, reason); }
  20338. }
  20339. inline bool WebSocketClient::is_open() const { return ws_ && ws_->is_open(); }
  20340. inline const std::string &WebSocketClient::subprotocol() const {
  20341. return subprotocol_;
  20342. }
  20343. inline void WebSocketClient::set_read_timeout(time_t sec, time_t usec) {
  20344. read_timeout_sec_ = sec;
  20345. read_timeout_usec_ = usec;
  20346. read_timeout_set_ = true;
  20347. // The members above only seed the next connect(); read() consults the
  20348. // stream, so an already-open connection has to be told directly.
  20349. if (ws_) { ws_->set_read_timeout(sec, usec); }
  20350. }
  20351. inline void WebSocketClient::set_write_timeout(time_t sec, time_t usec) {
  20352. write_timeout_sec_ = sec;
  20353. write_timeout_usec_ = usec;
  20354. }
  20355. inline void WebSocketClient::set_websocket_ping_interval(time_t sec) {
  20356. websocket_ping_interval_sec_ = sec;
  20357. }
  20358. inline void WebSocketClient::set_websocket_max_missed_pongs(int count) {
  20359. websocket_max_missed_pongs_ = count;
  20360. }
  20361. inline void WebSocketClient::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  20362. inline void WebSocketClient::set_address_family(int family) {
  20363. address_family_ = family;
  20364. }
  20365. inline void WebSocketClient::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  20366. inline void WebSocketClient::set_socket_options(SocketOptions socket_options) {
  20367. socket_options_ = std::move(socket_options);
  20368. }
  20369. inline void WebSocketClient::set_connection_timeout(time_t sec, time_t usec) {
  20370. connection_timeout_sec_ = sec;
  20371. connection_timeout_usec_ = usec;
  20372. }
  20373. inline void WebSocketClient::set_interface(const std::string &intf) {
  20374. interface_ = intf;
  20375. }
  20376. inline void WebSocketClient::set_hostname_addr_map(
  20377. std::map<std::string, std::string> addr_map) {
  20378. addr_map_ = std::move(addr_map);
  20379. }
  20380. inline bool WebSocketClient::is_proxy_enabled() const {
  20381. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  20382. if (no_proxy_entries_.empty()) { return true; }
  20383. return !detail::host_matches_no_proxy(detail::normalize_target(host_),
  20384. no_proxy_entries_);
  20385. }
  20386. inline bool WebSocketClient::create_and_connect_socket(Error &error) {
  20387. std::string connect_host;
  20388. std::string ip;
  20389. auto port = port_;
  20390. if (is_proxy_enabled()) {
  20391. connect_host = proxy_host_;
  20392. port = proxy_port_;
  20393. } else {
  20394. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  20395. }
  20396. sock_ = detail::create_client_socket(
  20397. connect_host, ip, port, address_family_, tcp_nodelay_, ipv6_v6only_,
  20398. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  20399. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  20400. write_timeout_usec_, interface_, error);
  20401. if (sock_ != INVALID_SOCKET) { return true; }
  20402. if (error == Error::Success) { error = Error::Connection; }
  20403. return false;
  20404. }
  20405. inline bool WebSocketClient::send_proxy_connect(Request &req,
  20406. Response &proxy_res,
  20407. Error &error) {
  20408. auto timeout = handshake_timeout();
  20409. detail::SocketStream strm(sock_, timeout.first, timeout.second,
  20410. write_timeout_sec_, write_timeout_usec_);
  20411. if (!detail::write_request_head(strm, req, error)) { return false; }
  20412. if (!detail::read_response_head(strm, proxy_res.status, proxy_res.headers)) {
  20413. error = Error::Read;
  20414. return false;
  20415. }
  20416. return true;
  20417. }
  20418. // RFC 6455 4.1: ws:// is tunnelled with CONNECT as well, since a proxy need not
  20419. // forward an Upgrade request.
  20420. inline bool WebSocketClient::connect_with_proxy(Response &proxy_res,
  20421. Error &error) {
  20422. Request req;
  20423. req.method = "CONNECT";
  20424. req.path = detail::make_host_and_port_string_always_port(host_, port_);
  20425. req.headers.emplace("Host", req.path);
  20426. detail::add_default_user_agent_header(req);
  20427. detail::add_authorization_header(req, proxy_basic_auth_username_,
  20428. proxy_basic_auth_password_,
  20429. proxy_bearer_token_auth_token_, true);
  20430. if (!send_proxy_connect(req, proxy_res, error)) { return false; }
  20431. #ifdef CPPHTTPLIB_SSL_ENABLED
  20432. // A Digest challenge gets one retry on a fresh connection, like SSLClient.
  20433. std::map<std::string, std::string> auth;
  20434. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407 &&
  20435. !proxy_digest_auth_username_.empty() &&
  20436. !proxy_digest_auth_password_.empty() &&
  20437. detail::parse_www_authenticate(proxy_res, auth, true)) {
  20438. proxy_res = Response();
  20439. shutdown_and_close();
  20440. if (!create_and_connect_socket(error)) { return false; }
  20441. req.headers.erase("Proxy-Authorization");
  20442. req.headers.insert(detail::make_digest_authentication_header(
  20443. req, req.path, auth, 1, detail::random_string(10),
  20444. proxy_digest_auth_username_, proxy_digest_auth_password_, true));
  20445. if (!send_proxy_connect(req, proxy_res, error)) { return false; }
  20446. }
  20447. #endif
  20448. if (proxy_res.status != StatusCode::OK_200) {
  20449. error = Error::ProxyConnection;
  20450. return false;
  20451. }
  20452. return true;
  20453. }
  20454. inline void WebSocketClient::set_proxy(const std::string &host, int port) {
  20455. proxy_host_ = host;
  20456. proxy_port_ = port;
  20457. }
  20458. inline void WebSocketClient::set_proxy_basic_auth(const std::string &username,
  20459. const std::string &password) {
  20460. proxy_basic_auth_username_ = username;
  20461. proxy_basic_auth_password_ = password;
  20462. }
  20463. inline void
  20464. WebSocketClient::set_proxy_bearer_token_auth(const std::string &token) {
  20465. proxy_bearer_token_auth_token_ = token;
  20466. }
  20467. inline void
  20468. WebSocketClient::set_no_proxy(const std::vector<std::string> &patterns) {
  20469. no_proxy_entries_ = detail::parse_no_proxy_entries(patterns);
  20470. }
  20471. #ifdef CPPHTTPLIB_SSL_ENABLED
  20472. inline void
  20473. WebSocketClient::set_ca_cert_path(const std::string &ca_cert_file_path,
  20474. const std::string &ca_cert_dir_path) {
  20475. ca_cert_file_path_ = ca_cert_file_path;
  20476. ca_cert_dir_path_ = ca_cert_dir_path;
  20477. }
  20478. inline void
  20479. WebSocketClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  20480. if (tls_ctx_) { tls::set_verify_callback(tls_ctx_, std::move(verifier)); }
  20481. }
  20482. inline void WebSocketClient::set_session_verifier(
  20483. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  20484. session_verifier_ = std::move(verifier);
  20485. }
  20486. inline void WebSocketClient::set_ca_cert_store(tls::ca_store_t store) {
  20487. if (store && tls_ctx_) {
  20488. // set_ca_store takes ownership of store
  20489. tls::set_ca_store(tls_ctx_, store);
  20490. } else if (store) {
  20491. tls::free_ca_store(store);
  20492. }
  20493. custom_ca_loaded_ = true;
  20494. }
  20495. inline void WebSocketClient::load_ca_cert_store(const char *ca_cert,
  20496. std::size_t size) {
  20497. if (tls_ctx_ && ca_cert && size > 0) {
  20498. tls::load_ca_pem(tls_ctx_, ca_cert, size);
  20499. }
  20500. custom_ca_loaded_ = true;
  20501. }
  20502. inline void
  20503. WebSocketClient::enable_server_certificate_verification(bool enabled) {
  20504. server_certificate_verification_ = enabled;
  20505. }
  20506. inline void WebSocketClient::enable_server_hostname_verification(bool enabled) {
  20507. server_hostname_verification_ = enabled;
  20508. }
  20509. inline void WebSocketClient::enable_system_ca(bool enabled) {
  20510. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  20511. }
  20512. inline void
  20513. WebSocketClient::set_proxy_digest_auth(const std::string &username,
  20514. const std::string &password) {
  20515. proxy_digest_auth_username_ = username;
  20516. proxy_digest_auth_password_ = password;
  20517. }
  20518. #endif // CPPHTTPLIB_SSL_ENABLED
  20519. } // namespace ws
  20520. // ----------------------------------------------------------------------------
  20521. } // namespace httplib
  20522. #endif // CPPHTTPLIB_HTTPLIB_H