httplib.h 827 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845128461284712848128491285012851128521285312854128551285612857128581285912860128611286212863128641286512866128671286812869128701287112872128731287412875128761287712878128791288012881128821288312884128851288612887128881288912890128911289212893128941289512896128971289812899129001290112902129031290412905129061290712908129091291012911129121291312914129151291612917129181291912920129211292212923129241292512926129271292812929129301293112932129331293412935129361293712938129391294012941129421294312944129451294612947129481294912950129511295212953129541295512956129571295812959129601296112962129631296412965129661296712968129691297012971129721297312974129751297612977129781297912980129811298212983129841298512986129871298812989129901299112992129931299412995129961299712998129991300013001130021300313004130051300613007130081300913010130111301213013130141301513016130171301813019130201302113022130231302413025130261302713028130291303013031130321303313034130351303613037130381303913040130411304213043130441304513046130471304813049130501305113052130531305413055130561305713058130591306013061130621306313064130651306613067130681306913070130711307213073130741307513076130771307813079130801308113082130831308413085130861308713088130891309013091130921309313094130951309613097130981309913100131011310213103131041310513106131071310813109131101311113112131131311413115131161311713118131191312013121131221312313124131251312613127131281312913130131311313213133131341313513136131371313813139131401314113142131431314413145131461314713148131491315013151131521315313154131551315613157131581315913160131611316213163131641316513166131671316813169131701317113172131731317413175131761317713178131791318013181131821318313184131851318613187131881318913190131911319213193131941319513196131971319813199132001320113202132031320413205132061320713208132091321013211132121321313214132151321613217132181321913220132211322213223132241322513226132271322813229132301323113232132331323413235132361323713238132391324013241132421324313244132451324613247132481324913250132511325213253132541325513256132571325813259132601326113262132631326413265132661326713268132691327013271132721327313274132751327613277132781327913280132811328213283132841328513286132871328813289132901329113292132931329413295132961329713298132991330013301133021330313304133051330613307133081330913310133111331213313133141331513316133171331813319133201332113322133231332413325133261332713328133291333013331133321333313334133351333613337133381333913340133411334213343133441334513346133471334813349133501335113352133531335413355133561335713358133591336013361133621336313364133651336613367133681336913370133711337213373133741337513376133771337813379133801338113382133831338413385133861338713388133891339013391133921339313394133951339613397133981339913400134011340213403134041340513406134071340813409134101341113412134131341413415134161341713418134191342013421134221342313424134251342613427134281342913430134311343213433134341343513436134371343813439134401344113442134431344413445134461344713448134491345013451134521345313454134551345613457134581345913460134611346213463134641346513466134671346813469134701347113472134731347413475134761347713478134791348013481134821348313484134851348613487134881348913490134911349213493134941349513496134971349813499135001350113502135031350413505135061350713508135091351013511135121351313514135151351613517135181351913520135211352213523135241352513526135271352813529135301353113532135331353413535135361353713538135391354013541135421354313544135451354613547135481354913550135511355213553135541355513556135571355813559135601356113562135631356413565135661356713568135691357013571135721357313574135751357613577135781357913580135811358213583135841358513586135871358813589135901359113592135931359413595135961359713598135991360013601136021360313604136051360613607136081360913610136111361213613136141361513616136171361813619136201362113622136231362413625136261362713628136291363013631136321363313634136351363613637136381363913640136411364213643136441364513646136471364813649136501365113652136531365413655136561365713658136591366013661136621366313664136651366613667136681366913670136711367213673136741367513676136771367813679136801368113682136831368413685136861368713688136891369013691136921369313694136951369613697136981369913700137011370213703137041370513706137071370813709137101371113712137131371413715137161371713718137191372013721137221372313724137251372613727137281372913730137311373213733137341373513736137371373813739137401374113742137431374413745137461374713748137491375013751137521375313754137551375613757137581375913760137611376213763137641376513766137671376813769137701377113772137731377413775137761377713778137791378013781137821378313784137851378613787137881378913790137911379213793137941379513796137971379813799138001380113802138031380413805138061380713808138091381013811138121381313814138151381613817138181381913820138211382213823138241382513826138271382813829138301383113832138331383413835138361383713838138391384013841138421384313844138451384613847138481384913850138511385213853138541385513856138571385813859138601386113862138631386413865138661386713868138691387013871138721387313874138751387613877138781387913880138811388213883138841388513886138871388813889138901389113892138931389413895138961389713898138991390013901139021390313904139051390613907139081390913910139111391213913139141391513916139171391813919139201392113922139231392413925139261392713928139291393013931139321393313934139351393613937139381393913940139411394213943139441394513946139471394813949139501395113952139531395413955139561395713958139591396013961139621396313964139651396613967139681396913970139711397213973139741397513976139771397813979139801398113982139831398413985139861398713988139891399013991139921399313994139951399613997139981399914000140011400214003140041400514006140071400814009140101401114012140131401414015140161401714018140191402014021140221402314024140251402614027140281402914030140311403214033140341403514036140371403814039140401404114042140431404414045140461404714048140491405014051140521405314054140551405614057140581405914060140611406214063140641406514066140671406814069140701407114072140731407414075140761407714078140791408014081140821408314084140851408614087140881408914090140911409214093140941409514096140971409814099141001410114102141031410414105141061410714108141091411014111141121411314114141151411614117141181411914120141211412214123141241412514126141271412814129141301413114132141331413414135141361413714138141391414014141141421414314144141451414614147141481414914150141511415214153141541415514156141571415814159141601416114162141631416414165141661416714168141691417014171141721417314174141751417614177141781417914180141811418214183141841418514186141871418814189141901419114192141931419414195141961419714198141991420014201142021420314204142051420614207142081420914210142111421214213142141421514216142171421814219142201422114222142231422414225142261422714228142291423014231142321423314234142351423614237142381423914240142411424214243142441424514246142471424814249142501425114252142531425414255142561425714258142591426014261142621426314264142651426614267142681426914270142711427214273142741427514276142771427814279142801428114282142831428414285142861428714288142891429014291142921429314294142951429614297142981429914300143011430214303143041430514306143071430814309143101431114312143131431414315143161431714318143191432014321143221432314324143251432614327143281432914330143311433214333143341433514336143371433814339143401434114342143431434414345143461434714348143491435014351143521435314354143551435614357143581435914360143611436214363143641436514366143671436814369143701437114372143731437414375143761437714378143791438014381143821438314384143851438614387143881438914390143911439214393143941439514396143971439814399144001440114402144031440414405144061440714408144091441014411144121441314414144151441614417144181441914420144211442214423144241442514426144271442814429144301443114432144331443414435144361443714438144391444014441144421444314444144451444614447144481444914450144511445214453144541445514456144571445814459144601446114462144631446414465144661446714468144691447014471144721447314474144751447614477144781447914480144811448214483144841448514486144871448814489144901449114492144931449414495144961449714498144991450014501145021450314504145051450614507145081450914510145111451214513145141451514516145171451814519145201452114522145231452414525145261452714528145291453014531145321453314534145351453614537145381453914540145411454214543145441454514546145471454814549145501455114552145531455414555145561455714558145591456014561145621456314564145651456614567145681456914570145711457214573145741457514576145771457814579145801458114582145831458414585145861458714588145891459014591145921459314594145951459614597145981459914600146011460214603146041460514606146071460814609146101461114612146131461414615146161461714618146191462014621146221462314624146251462614627146281462914630146311463214633146341463514636146371463814639146401464114642146431464414645146461464714648146491465014651146521465314654146551465614657146581465914660146611466214663146641466514666146671466814669146701467114672146731467414675146761467714678146791468014681146821468314684146851468614687146881468914690146911469214693146941469514696146971469814699147001470114702147031470414705147061470714708147091471014711147121471314714147151471614717147181471914720147211472214723147241472514726147271472814729147301473114732147331473414735147361473714738147391474014741147421474314744147451474614747147481474914750147511475214753147541475514756147571475814759147601476114762147631476414765147661476714768147691477014771147721477314774147751477614777147781477914780147811478214783147841478514786147871478814789147901479114792147931479414795147961479714798147991480014801148021480314804148051480614807148081480914810148111481214813148141481514816148171481814819148201482114822148231482414825148261482714828148291483014831148321483314834148351483614837148381483914840148411484214843148441484514846148471484814849148501485114852148531485414855148561485714858148591486014861148621486314864148651486614867148681486914870148711487214873148741487514876148771487814879148801488114882148831488414885148861488714888148891489014891148921489314894148951489614897148981489914900149011490214903149041490514906149071490814909149101491114912149131491414915149161491714918149191492014921149221492314924149251492614927149281492914930149311493214933149341493514936149371493814939149401494114942149431494414945149461494714948149491495014951149521495314954149551495614957149581495914960149611496214963149641496514966149671496814969149701497114972149731497414975149761497714978149791498014981149821498314984149851498614987149881498914990149911499214993149941499514996149971499814999150001500115002150031500415005150061500715008150091501015011150121501315014150151501615017150181501915020150211502215023150241502515026150271502815029150301503115032150331503415035150361503715038150391504015041150421504315044150451504615047150481504915050150511505215053150541505515056150571505815059150601506115062150631506415065150661506715068150691507015071150721507315074150751507615077150781507915080150811508215083150841508515086150871508815089150901509115092150931509415095150961509715098150991510015101151021510315104151051510615107151081510915110151111511215113151141511515116151171511815119151201512115122151231512415125151261512715128151291513015131151321513315134151351513615137151381513915140151411514215143151441514515146151471514815149151501515115152151531515415155151561515715158151591516015161151621516315164151651516615167151681516915170151711517215173151741517515176151771517815179151801518115182151831518415185151861518715188151891519015191151921519315194151951519615197151981519915200152011520215203152041520515206152071520815209152101521115212152131521415215152161521715218152191522015221152221522315224152251522615227152281522915230152311523215233152341523515236152371523815239152401524115242152431524415245152461524715248152491525015251152521525315254152551525615257152581525915260152611526215263152641526515266152671526815269152701527115272152731527415275152761527715278152791528015281152821528315284152851528615287152881528915290152911529215293152941529515296152971529815299153001530115302153031530415305153061530715308153091531015311153121531315314153151531615317153181531915320153211532215323153241532515326153271532815329153301533115332153331533415335153361533715338153391534015341153421534315344153451534615347153481534915350153511535215353153541535515356153571535815359153601536115362153631536415365153661536715368153691537015371153721537315374153751537615377153781537915380153811538215383153841538515386153871538815389153901539115392153931539415395153961539715398153991540015401154021540315404154051540615407154081540915410154111541215413154141541515416154171541815419154201542115422154231542415425154261542715428154291543015431154321543315434154351543615437154381543915440154411544215443154441544515446154471544815449154501545115452154531545415455154561545715458154591546015461154621546315464154651546615467154681546915470154711547215473154741547515476154771547815479154801548115482154831548415485154861548715488154891549015491154921549315494154951549615497154981549915500155011550215503155041550515506155071550815509155101551115512155131551415515155161551715518155191552015521155221552315524155251552615527155281552915530155311553215533155341553515536155371553815539155401554115542155431554415545155461554715548155491555015551155521555315554155551555615557155581555915560155611556215563155641556515566155671556815569155701557115572155731557415575155761557715578155791558015581155821558315584155851558615587155881558915590155911559215593155941559515596155971559815599156001560115602156031560415605156061560715608156091561015611156121561315614156151561615617156181561915620156211562215623156241562515626156271562815629156301563115632156331563415635156361563715638156391564015641156421564315644156451564615647156481564915650156511565215653156541565515656156571565815659156601566115662156631566415665156661566715668156691567015671156721567315674156751567615677156781567915680156811568215683156841568515686156871568815689156901569115692156931569415695156961569715698156991570015701157021570315704157051570615707157081570915710157111571215713157141571515716157171571815719157201572115722157231572415725157261572715728157291573015731157321573315734157351573615737157381573915740157411574215743157441574515746157471574815749157501575115752157531575415755157561575715758157591576015761157621576315764157651576615767157681576915770157711577215773157741577515776157771577815779157801578115782157831578415785157861578715788157891579015791157921579315794157951579615797157981579915800158011580215803158041580515806158071580815809158101581115812158131581415815158161581715818158191582015821158221582315824158251582615827158281582915830158311583215833158341583515836158371583815839158401584115842158431584415845158461584715848158491585015851158521585315854158551585615857158581585915860158611586215863158641586515866158671586815869158701587115872158731587415875158761587715878158791588015881158821588315884158851588615887158881588915890158911589215893158941589515896158971589815899159001590115902159031590415905159061590715908159091591015911159121591315914159151591615917159181591915920159211592215923159241592515926159271592815929159301593115932159331593415935159361593715938159391594015941159421594315944159451594615947159481594915950159511595215953159541595515956159571595815959159601596115962159631596415965159661596715968159691597015971159721597315974159751597615977159781597915980159811598215983159841598515986159871598815989159901599115992159931599415995159961599715998159991600016001160021600316004160051600616007160081600916010160111601216013160141601516016160171601816019160201602116022160231602416025160261602716028160291603016031160321603316034160351603616037160381603916040160411604216043160441604516046160471604816049160501605116052160531605416055160561605716058160591606016061160621606316064160651606616067160681606916070160711607216073160741607516076160771607816079160801608116082160831608416085160861608716088160891609016091160921609316094160951609616097160981609916100161011610216103161041610516106161071610816109161101611116112161131611416115161161611716118161191612016121161221612316124161251612616127161281612916130161311613216133161341613516136161371613816139161401614116142161431614416145161461614716148161491615016151161521615316154161551615616157161581615916160161611616216163161641616516166161671616816169161701617116172161731617416175161761617716178161791618016181161821618316184161851618616187161881618916190161911619216193161941619516196161971619816199162001620116202162031620416205162061620716208162091621016211162121621316214162151621616217162181621916220162211622216223162241622516226162271622816229162301623116232162331623416235162361623716238162391624016241162421624316244162451624616247162481624916250162511625216253162541625516256162571625816259162601626116262162631626416265162661626716268162691627016271162721627316274162751627616277162781627916280162811628216283162841628516286162871628816289162901629116292162931629416295162961629716298162991630016301163021630316304163051630616307163081630916310163111631216313163141631516316163171631816319163201632116322163231632416325163261632716328163291633016331163321633316334163351633616337163381633916340163411634216343163441634516346163471634816349163501635116352163531635416355163561635716358163591636016361163621636316364163651636616367163681636916370163711637216373163741637516376163771637816379163801638116382163831638416385163861638716388163891639016391163921639316394163951639616397163981639916400164011640216403164041640516406164071640816409164101641116412164131641416415164161641716418164191642016421164221642316424164251642616427164281642916430164311643216433164341643516436164371643816439164401644116442164431644416445164461644716448164491645016451164521645316454164551645616457164581645916460164611646216463164641646516466164671646816469164701647116472164731647416475164761647716478164791648016481164821648316484164851648616487164881648916490164911649216493164941649516496164971649816499165001650116502165031650416505165061650716508165091651016511165121651316514165151651616517165181651916520165211652216523165241652516526165271652816529165301653116532165331653416535165361653716538165391654016541165421654316544165451654616547165481654916550165511655216553165541655516556165571655816559165601656116562165631656416565165661656716568165691657016571165721657316574165751657616577165781657916580165811658216583165841658516586165871658816589165901659116592165931659416595165961659716598165991660016601166021660316604166051660616607166081660916610166111661216613166141661516616166171661816619166201662116622166231662416625166261662716628166291663016631166321663316634166351663616637166381663916640166411664216643166441664516646166471664816649166501665116652166531665416655166561665716658166591666016661166621666316664166651666616667166681666916670166711667216673166741667516676166771667816679166801668116682166831668416685166861668716688166891669016691166921669316694166951669616697166981669916700167011670216703167041670516706167071670816709167101671116712167131671416715167161671716718167191672016721167221672316724167251672616727167281672916730167311673216733167341673516736167371673816739167401674116742167431674416745167461674716748167491675016751167521675316754167551675616757167581675916760167611676216763167641676516766167671676816769167701677116772167731677416775167761677716778167791678016781167821678316784167851678616787167881678916790167911679216793167941679516796167971679816799168001680116802168031680416805168061680716808168091681016811168121681316814168151681616817168181681916820168211682216823168241682516826168271682816829168301683116832168331683416835168361683716838168391684016841168421684316844168451684616847168481684916850168511685216853168541685516856168571685816859168601686116862168631686416865168661686716868168691687016871168721687316874168751687616877168781687916880168811688216883168841688516886168871688816889168901689116892168931689416895168961689716898168991690016901169021690316904169051690616907169081690916910169111691216913169141691516916169171691816919169201692116922169231692416925169261692716928169291693016931169321693316934169351693616937169381693916940169411694216943169441694516946169471694816949169501695116952169531695416955169561695716958169591696016961169621696316964169651696616967169681696916970169711697216973169741697516976169771697816979169801698116982169831698416985169861698716988169891699016991169921699316994169951699616997169981699917000170011700217003170041700517006170071700817009170101701117012170131701417015170161701717018170191702017021170221702317024170251702617027170281702917030170311703217033170341703517036170371703817039170401704117042170431704417045170461704717048170491705017051170521705317054170551705617057170581705917060170611706217063170641706517066170671706817069170701707117072170731707417075170761707717078170791708017081170821708317084170851708617087170881708917090170911709217093170941709517096170971709817099171001710117102171031710417105171061710717108171091711017111171121711317114171151711617117171181711917120171211712217123171241712517126171271712817129171301713117132171331713417135171361713717138171391714017141171421714317144171451714617147171481714917150171511715217153171541715517156171571715817159171601716117162171631716417165171661716717168171691717017171171721717317174171751717617177171781717917180171811718217183171841718517186171871718817189171901719117192171931719417195171961719717198171991720017201172021720317204172051720617207172081720917210172111721217213172141721517216172171721817219172201722117222172231722417225172261722717228172291723017231172321723317234172351723617237172381723917240172411724217243172441724517246172471724817249172501725117252172531725417255172561725717258172591726017261172621726317264172651726617267172681726917270172711727217273172741727517276172771727817279172801728117282172831728417285172861728717288172891729017291172921729317294172951729617297172981729917300173011730217303173041730517306173071730817309173101731117312173131731417315173161731717318173191732017321173221732317324173251732617327173281732917330173311733217333173341733517336173371733817339173401734117342173431734417345173461734717348173491735017351173521735317354173551735617357173581735917360173611736217363173641736517366173671736817369173701737117372173731737417375173761737717378173791738017381173821738317384173851738617387173881738917390173911739217393173941739517396173971739817399174001740117402174031740417405174061740717408174091741017411174121741317414174151741617417174181741917420174211742217423174241742517426174271742817429174301743117432174331743417435174361743717438174391744017441174421744317444174451744617447174481744917450174511745217453174541745517456174571745817459174601746117462174631746417465174661746717468174691747017471174721747317474174751747617477174781747917480174811748217483174841748517486174871748817489174901749117492174931749417495174961749717498174991750017501175021750317504175051750617507175081750917510175111751217513175141751517516175171751817519175201752117522175231752417525175261752717528175291753017531175321753317534175351753617537175381753917540175411754217543175441754517546175471754817549175501755117552175531755417555175561755717558175591756017561175621756317564175651756617567175681756917570175711757217573175741757517576175771757817579175801758117582175831758417585175861758717588175891759017591175921759317594175951759617597175981759917600176011760217603176041760517606176071760817609176101761117612176131761417615176161761717618176191762017621176221762317624176251762617627176281762917630176311763217633176341763517636176371763817639176401764117642176431764417645176461764717648176491765017651176521765317654176551765617657176581765917660176611766217663176641766517666176671766817669176701767117672176731767417675176761767717678176791768017681176821768317684176851768617687176881768917690176911769217693176941769517696176971769817699177001770117702177031770417705177061770717708177091771017711177121771317714177151771617717177181771917720177211772217723177241772517726177271772817729177301773117732177331773417735177361773717738177391774017741177421774317744177451774617747177481774917750177511775217753177541775517756177571775817759177601776117762177631776417765177661776717768177691777017771177721777317774177751777617777177781777917780177811778217783177841778517786177871778817789177901779117792177931779417795177961779717798177991780017801178021780317804178051780617807178081780917810178111781217813178141781517816178171781817819178201782117822178231782417825178261782717828178291783017831178321783317834178351783617837178381783917840178411784217843178441784517846178471784817849178501785117852178531785417855178561785717858178591786017861178621786317864178651786617867178681786917870178711787217873178741787517876178771787817879178801788117882178831788417885178861788717888178891789017891178921789317894178951789617897178981789917900179011790217903179041790517906179071790817909179101791117912179131791417915179161791717918179191792017921179221792317924179251792617927179281792917930179311793217933179341793517936179371793817939179401794117942179431794417945179461794717948179491795017951179521795317954179551795617957179581795917960179611796217963179641796517966179671796817969179701797117972179731797417975179761797717978179791798017981179821798317984179851798617987179881798917990179911799217993179941799517996179971799817999180001800118002180031800418005180061800718008180091801018011180121801318014180151801618017180181801918020180211802218023180241802518026180271802818029180301803118032180331803418035180361803718038180391804018041180421804318044180451804618047180481804918050180511805218053180541805518056180571805818059180601806118062180631806418065180661806718068180691807018071180721807318074180751807618077180781807918080180811808218083180841808518086180871808818089180901809118092180931809418095180961809718098180991810018101181021810318104181051810618107181081810918110181111811218113181141811518116181171811818119181201812118122181231812418125181261812718128181291813018131181321813318134181351813618137181381813918140181411814218143181441814518146181471814818149181501815118152181531815418155181561815718158181591816018161181621816318164181651816618167181681816918170181711817218173181741817518176181771817818179181801818118182181831818418185181861818718188181891819018191181921819318194181951819618197181981819918200182011820218203182041820518206182071820818209182101821118212182131821418215182161821718218182191822018221182221822318224182251822618227182281822918230182311823218233182341823518236182371823818239182401824118242182431824418245182461824718248182491825018251182521825318254182551825618257182581825918260182611826218263182641826518266182671826818269182701827118272182731827418275182761827718278182791828018281182821828318284182851828618287182881828918290182911829218293182941829518296182971829818299183001830118302183031830418305183061830718308183091831018311183121831318314183151831618317183181831918320183211832218323183241832518326183271832818329183301833118332183331833418335183361833718338183391834018341183421834318344183451834618347183481834918350183511835218353183541835518356183571835818359183601836118362183631836418365183661836718368183691837018371183721837318374183751837618377183781837918380183811838218383183841838518386183871838818389183901839118392183931839418395183961839718398183991840018401184021840318404184051840618407184081840918410184111841218413184141841518416184171841818419184201842118422184231842418425184261842718428184291843018431184321843318434184351843618437184381843918440184411844218443184441844518446184471844818449184501845118452184531845418455184561845718458184591846018461184621846318464184651846618467184681846918470184711847218473184741847518476184771847818479184801848118482184831848418485184861848718488184891849018491184921849318494184951849618497184981849918500185011850218503185041850518506185071850818509185101851118512185131851418515185161851718518185191852018521185221852318524185251852618527185281852918530185311853218533185341853518536185371853818539185401854118542185431854418545185461854718548185491855018551185521855318554185551855618557185581855918560185611856218563185641856518566185671856818569185701857118572185731857418575185761857718578185791858018581185821858318584185851858618587185881858918590185911859218593185941859518596185971859818599186001860118602186031860418605186061860718608186091861018611186121861318614186151861618617186181861918620186211862218623186241862518626186271862818629186301863118632186331863418635186361863718638186391864018641186421864318644186451864618647186481864918650186511865218653186541865518656186571865818659186601866118662186631866418665186661866718668186691867018671186721867318674186751867618677186781867918680186811868218683186841868518686186871868818689186901869118692186931869418695186961869718698186991870018701187021870318704187051870618707187081870918710187111871218713187141871518716187171871818719187201872118722187231872418725187261872718728187291873018731187321873318734187351873618737187381873918740187411874218743187441874518746187471874818749187501875118752187531875418755187561875718758187591876018761187621876318764187651876618767187681876918770187711877218773187741877518776187771877818779187801878118782187831878418785187861878718788187891879018791187921879318794187951879618797187981879918800188011880218803188041880518806188071880818809188101881118812188131881418815188161881718818188191882018821188221882318824188251882618827188281882918830188311883218833188341883518836188371883818839188401884118842188431884418845188461884718848188491885018851188521885318854188551885618857188581885918860188611886218863188641886518866188671886818869188701887118872188731887418875188761887718878188791888018881188821888318884188851888618887188881888918890188911889218893188941889518896188971889818899189001890118902189031890418905189061890718908189091891018911189121891318914189151891618917189181891918920189211892218923189241892518926189271892818929189301893118932189331893418935189361893718938189391894018941189421894318944189451894618947189481894918950189511895218953189541895518956189571895818959189601896118962189631896418965189661896718968189691897018971189721897318974189751897618977189781897918980189811898218983189841898518986189871898818989189901899118992189931899418995189961899718998189991900019001190021900319004190051900619007190081900919010190111901219013190141901519016190171901819019190201902119022190231902419025190261902719028190291903019031190321903319034190351903619037190381903919040190411904219043190441904519046190471904819049190501905119052190531905419055190561905719058190591906019061190621906319064190651906619067190681906919070190711907219073190741907519076190771907819079190801908119082190831908419085190861908719088190891909019091190921909319094190951909619097190981909919100191011910219103191041910519106191071910819109191101911119112191131911419115191161911719118191191912019121191221912319124191251912619127191281912919130191311913219133191341913519136191371913819139191401914119142191431914419145191461914719148191491915019151191521915319154191551915619157191581915919160191611916219163191641916519166191671916819169191701917119172191731917419175191761917719178191791918019181191821918319184191851918619187191881918919190191911919219193191941919519196191971919819199192001920119202192031920419205192061920719208192091921019211192121921319214192151921619217192181921919220192211922219223192241922519226192271922819229192301923119232192331923419235192361923719238192391924019241192421924319244192451924619247192481924919250192511925219253192541925519256192571925819259192601926119262192631926419265192661926719268192691927019271192721927319274192751927619277192781927919280192811928219283192841928519286192871928819289192901929119292192931929419295192961929719298192991930019301193021930319304193051930619307193081930919310193111931219313193141931519316193171931819319193201932119322193231932419325193261932719328193291933019331193321933319334193351933619337193381933919340193411934219343193441934519346193471934819349193501935119352193531935419355193561935719358193591936019361193621936319364193651936619367193681936919370193711937219373193741937519376193771937819379193801938119382193831938419385193861938719388193891939019391193921939319394193951939619397193981939919400194011940219403194041940519406194071940819409194101941119412194131941419415194161941719418194191942019421194221942319424194251942619427194281942919430194311943219433194341943519436194371943819439194401944119442194431944419445194461944719448194491945019451194521945319454194551945619457194581945919460194611946219463194641946519466194671946819469194701947119472194731947419475194761947719478194791948019481194821948319484194851948619487194881948919490194911949219493194941949519496194971949819499195001950119502195031950419505195061950719508195091951019511195121951319514195151951619517195181951919520195211952219523195241952519526195271952819529195301953119532195331953419535195361953719538195391954019541195421954319544195451954619547195481954919550195511955219553195541955519556195571955819559195601956119562195631956419565195661956719568195691957019571195721957319574195751957619577195781957919580195811958219583195841958519586195871958819589195901959119592195931959419595195961959719598195991960019601196021960319604196051960619607196081960919610196111961219613196141961519616196171961819619196201962119622196231962419625196261962719628196291963019631196321963319634196351963619637196381963919640196411964219643196441964519646196471964819649196501965119652196531965419655196561965719658196591966019661196621966319664196651966619667196681966919670196711967219673196741967519676196771967819679196801968119682196831968419685196861968719688196891969019691196921969319694196951969619697196981969919700197011970219703197041970519706197071970819709197101971119712197131971419715197161971719718197191972019721197221972319724197251972619727197281972919730197311973219733197341973519736197371973819739197401974119742197431974419745197461974719748197491975019751197521975319754197551975619757197581975919760197611976219763197641976519766197671976819769197701977119772197731977419775197761977719778197791978019781197821978319784197851978619787197881978919790197911979219793197941979519796197971979819799198001980119802198031980419805198061980719808198091981019811198121981319814198151981619817198181981919820198211982219823198241982519826198271982819829198301983119832198331983419835198361983719838198391984019841198421984319844198451984619847198481984919850198511985219853198541985519856198571985819859198601986119862198631986419865198661986719868198691987019871198721987319874198751987619877198781987919880198811988219883198841988519886198871988819889198901989119892198931989419895198961989719898198991990019901199021990319904199051990619907199081990919910199111991219913199141991519916199171991819919199201992119922199231992419925199261992719928199291993019931199321993319934199351993619937199381993919940199411994219943199441994519946199471994819949199501995119952199531995419955199561995719958199591996019961199621996319964199651996619967199681996919970199711997219973199741997519976199771997819979199801998119982199831998419985199861998719988199891999019991199921999319994199951999619997199981999920000200012000220003200042000520006200072000820009200102001120012200132001420015200162001720018200192002020021200222002320024200252002620027200282002920030200312003220033200342003520036200372003820039200402004120042200432004420045200462004720048200492005020051200522005320054200552005620057200582005920060200612006220063200642006520066200672006820069200702007120072200732007420075200762007720078200792008020081200822008320084200852008620087200882008920090200912009220093200942009520096200972009820099201002010120102201032010420105201062010720108201092011020111201122011320114201152011620117201182011920120201212012220123201242012520126201272012820129201302013120132201332013420135201362013720138201392014020141201422014320144201452014620147201482014920150201512015220153201542015520156201572015820159201602016120162201632016420165201662016720168201692017020171201722017320174201752017620177201782017920180201812018220183201842018520186201872018820189201902019120192201932019420195201962019720198201992020020201202022020320204202052020620207202082020920210202112021220213202142021520216202172021820219202202022120222202232022420225202262022720228202292023020231202322023320234202352023620237202382023920240202412024220243202442024520246202472024820249202502025120252202532025420255202562025720258202592026020261202622026320264202652026620267202682026920270202712027220273202742027520276202772027820279202802028120282202832028420285202862028720288202892029020291202922029320294202952029620297202982029920300203012030220303203042030520306203072030820309203102031120312203132031420315203162031720318203192032020321203222032320324203252032620327203282032920330203312033220333203342033520336203372033820339203402034120342203432034420345203462034720348203492035020351203522035320354203552035620357203582035920360203612036220363203642036520366203672036820369203702037120372203732037420375203762037720378203792038020381203822038320384203852038620387203882038920390203912039220393203942039520396203972039820399204002040120402204032040420405204062040720408204092041020411204122041320414204152041620417204182041920420204212042220423204242042520426204272042820429204302043120432204332043420435204362043720438204392044020441204422044320444204452044620447204482044920450204512045220453204542045520456204572045820459204602046120462204632046420465204662046720468204692047020471204722047320474204752047620477204782047920480204812048220483204842048520486204872048820489204902049120492204932049420495204962049720498204992050020501205022050320504205052050620507205082050920510205112051220513205142051520516205172051820519205202052120522205232052420525205262052720528205292053020531205322053320534205352053620537205382053920540205412054220543205442054520546205472054820549205502055120552205532055420555205562055720558205592056020561205622056320564205652056620567205682056920570205712057220573205742057520576205772057820579205802058120582205832058420585205862058720588205892059020591205922059320594205952059620597205982059920600206012060220603206042060520606206072060820609206102061120612206132061420615206162061720618206192062020621206222062320624206252062620627206282062920630206312063220633206342063520636206372063820639206402064120642206432064420645206462064720648206492065020651206522065320654206552065620657206582065920660206612066220663206642066520666206672066820669206702067120672206732067420675206762067720678206792068020681206822068320684206852068620687206882068920690206912069220693206942069520696206972069820699207002070120702207032070420705207062070720708207092071020711207122071320714207152071620717207182071920720207212072220723207242072520726207272072820729207302073120732207332073420735207362073720738207392074020741207422074320744207452074620747207482074920750207512075220753207542075520756207572075820759207602076120762207632076420765207662076720768207692077020771207722077320774207752077620777207782077920780207812078220783207842078520786207872078820789207902079120792207932079420795207962079720798207992080020801208022080320804208052080620807208082080920810208112081220813208142081520816208172081820819208202082120822208232082420825208262082720828208292083020831208322083320834208352083620837208382083920840208412084220843208442084520846208472084820849208502085120852208532085420855208562085720858208592086020861208622086320864208652086620867208682086920870208712087220873208742087520876208772087820879208802088120882208832088420885208862088720888208892089020891208922089320894208952089620897208982089920900209012090220903209042090520906209072090820909209102091120912209132091420915209162091720918209192092020921209222092320924209252092620927209282092920930209312093220933209342093520936209372093820939209402094120942209432094420945209462094720948209492095020951209522095320954209552095620957209582095920960209612096220963209642096520966209672096820969209702097120972209732097420975209762097720978209792098020981209822098320984209852098620987209882098920990209912099220993209942099520996209972099820999210002100121002210032100421005210062100721008210092101021011210122101321014210152101621017210182101921020210212102221023210242102521026210272102821029210302103121032210332103421035210362103721038210392104021041210422104321044210452104621047210482104921050210512105221053210542105521056210572105821059210602106121062210632106421065210662106721068210692107021071210722107321074210752107621077210782107921080210812108221083210842108521086210872108821089210902109121092210932109421095210962109721098210992110021101211022110321104211052110621107211082110921110211112111221113211142111521116211172111821119211202112121122211232112421125211262112721128211292113021131211322113321134211352113621137211382113921140211412114221143211442114521146211472114821149211502115121152211532115421155211562115721158211592116021161211622116321164211652116621167211682116921170211712117221173211742117521176211772117821179211802118121182211832118421185211862118721188211892119021191211922119321194211952119621197211982119921200212012120221203212042120521206212072120821209212102121121212212132121421215212162121721218212192122021221212222122321224212252122621227212282122921230212312123221233212342123521236212372123821239212402124121242212432124421245212462124721248212492125021251212522125321254212552125621257212582125921260212612126221263212642126521266212672126821269212702127121272212732127421275212762127721278212792128021281212822128321284212852128621287212882128921290212912129221293212942129521296212972129821299213002130121302213032130421305213062130721308213092131021311213122131321314213152131621317213182131921320213212132221323213242132521326213272132821329213302133121332213332133421335213362133721338213392134021341213422134321344213452134621347213482134921350213512135221353213542135521356213572135821359213602136121362213632136421365213662136721368213692137021371213722137321374213752137621377213782137921380213812138221383213842138521386213872138821389213902139121392213932139421395213962139721398213992140021401214022140321404214052140621407214082140921410214112141221413214142141521416214172141821419214202142121422214232142421425214262142721428214292143021431214322143321434214352143621437214382143921440214412144221443214442144521446214472144821449214502145121452214532145421455214562145721458214592146021461214622146321464214652146621467214682146921470214712147221473214742147521476214772147821479214802148121482214832148421485214862148721488214892149021491214922149321494214952149621497214982149921500215012150221503215042150521506215072150821509215102151121512215132151421515215162151721518215192152021521215222152321524215252152621527215282152921530215312153221533215342153521536215372153821539215402154121542215432154421545215462154721548215492155021551215522155321554215552155621557215582155921560215612156221563215642156521566215672156821569215702157121572215732157421575215762157721578215792158021581215822158321584215852158621587215882158921590215912159221593215942159521596215972159821599216002160121602216032160421605216062160721608216092161021611216122161321614216152161621617216182161921620216212162221623216242162521626216272162821629216302163121632216332163421635216362163721638216392164021641216422164321644216452164621647216482164921650216512165221653216542165521656216572165821659216602166121662216632166421665216662166721668216692167021671216722167321674216752167621677216782167921680216812168221683216842168521686216872168821689216902169121692216932169421695216962169721698216992170021701217022170321704217052170621707217082170921710217112171221713217142171521716217172171821719217202172121722217232172421725217262172721728217292173021731217322173321734217352173621737217382173921740217412174221743217442174521746217472174821749217502175121752217532175421755217562175721758217592176021761217622176321764217652176621767217682176921770217712177221773217742177521776217772177821779217802178121782217832178421785217862178721788217892179021791217922179321794217952179621797217982179921800218012180221803218042180521806218072180821809218102181121812218132181421815218162181721818218192182021821218222182321824218252182621827218282182921830218312183221833218342183521836218372183821839218402184121842218432184421845218462184721848218492185021851218522185321854218552185621857218582185921860218612186221863218642186521866218672186821869218702187121872218732187421875218762187721878218792188021881218822188321884218852188621887218882188921890218912189221893218942189521896218972189821899219002190121902219032190421905219062190721908219092191021911219122191321914219152191621917219182191921920219212192221923219242192521926219272192821929219302193121932219332193421935219362193721938219392194021941219422194321944219452194621947219482194921950219512195221953219542195521956219572195821959219602196121962219632196421965219662196721968219692197021971219722197321974219752197621977219782197921980219812198221983219842198521986219872198821989219902199121992219932199421995219962199721998219992200022001220022200322004220052200622007220082200922010220112201222013220142201522016220172201822019220202202122022220232202422025220262202722028220292203022031220322203322034220352203622037220382203922040220412204222043220442204522046220472204822049220502205122052220532205422055220562205722058220592206022061220622206322064220652206622067220682206922070220712207222073220742207522076220772207822079220802208122082220832208422085220862208722088220892209022091220922209322094220952209622097220982209922100221012210222103221042210522106221072210822109221102211122112221132211422115221162211722118221192212022121221222212322124221252212622127221282212922130221312213222133221342213522136221372213822139221402214122142221432214422145221462214722148221492215022151221522215322154221552215622157221582215922160221612216222163221642216522166221672216822169221702217122172221732217422175221762217722178221792218022181221822218322184221852218622187221882218922190221912219222193221942219522196221972219822199222002220122202222032220422205222062220722208222092221022211222122221322214222152221622217222182221922220222212222222223222242222522226222272222822229222302223122232222332223422235222362223722238222392224022241222422224322244222452224622247222482224922250222512225222253222542225522256222572225822259222602226122262222632226422265222662226722268222692227022271222722227322274222752227622277222782227922280222812228222283222842228522286222872228822289222902229122292222932229422295222962229722298222992230022301223022230322304223052230622307223082230922310223112231222313223142231522316223172231822319223202232122322223232232422325223262232722328223292233022331223322233322334223352233622337223382233922340223412234222343223442234522346223472234822349223502235122352223532235422355223562235722358223592236022361223622236322364223652236622367223682236922370223712237222373223742237522376223772237822379223802238122382223832238422385223862238722388223892239022391223922239322394223952239622397223982239922400224012240222403224042240522406224072240822409224102241122412224132241422415224162241722418224192242022421224222242322424224252242622427224282242922430224312243222433224342243522436224372243822439224402244122442224432244422445224462244722448224492245022451224522245322454224552245622457224582245922460224612246222463224642246522466224672246822469224702247122472224732247422475224762247722478224792248022481224822248322484224852248622487224882248922490224912249222493224942249522496224972249822499225002250122502225032250422505225062250722508225092251022511225122251322514225152251622517225182251922520225212252222523225242252522526225272252822529225302253122532225332253422535225362253722538225392254022541225422254322544225452254622547225482254922550225512255222553225542255522556225572255822559225602256122562225632256422565225662256722568225692257022571225722257322574225752257622577225782257922580225812258222583225842258522586225872258822589225902259122592225932259422595225962259722598225992260022601226022260322604226052260622607226082260922610226112261222613226142261522616226172261822619226202262122622226232262422625226262262722628226292263022631226322263322634226352263622637226382263922640226412264222643226442264522646226472264822649226502265122652226532265422655226562265722658226592266022661226622266322664226652266622667226682266922670226712267222673226742267522676226772267822679226802268122682226832268422685226862268722688226892269022691226922269322694226952269622697226982269922700227012270222703227042270522706227072270822709227102271122712227132271422715227162271722718227192272022721227222272322724227252272622727227282272922730227312273222733227342273522736227372273822739227402274122742227432274422745227462274722748227492275022751227522275322754227552275622757227582275922760227612276222763227642276522766227672276822769227702277122772227732277422775227762277722778227792278022781227822278322784227852278622787227882278922790227912279222793227942279522796227972279822799228002280122802228032280422805228062280722808228092281022811228122281322814228152281622817228182281922820228212282222823228242282522826228272282822829228302283122832228332283422835228362283722838228392284022841228422284322844228452284622847228482284922850228512285222853228542285522856228572285822859228602286122862228632286422865228662286722868228692287022871228722287322874228752287622877228782287922880228812288222883228842288522886228872288822889228902289122892228932289422895228962289722898228992290022901229022290322904229052290622907229082290922910229112291222913229142291522916229172291822919229202292122922229232292422925229262292722928229292293022931229322293322934229352293622937229382293922940229412294222943229442294522946229472294822949229502295122952229532295422955229562295722958229592296022961229622296322964229652296622967229682296922970229712297222973229742297522976229772297822979229802298122982229832298422985229862298722988229892299022991229922299322994229952299622997229982299923000230012300223003230042300523006230072300823009230102301123012230132301423015230162301723018230192302023021230222302323024230252302623027230282302923030230312303223033230342303523036230372303823039230402304123042230432304423045230462304723048230492305023051230522305323054230552305623057230582305923060230612306223063230642306523066230672306823069230702307123072230732307423075230762307723078230792308023081230822308323084230852308623087230882308923090230912309223093230942309523096230972309823099231002310123102231032310423105231062310723108231092311023111231122311323114231152311623117231182311923120231212312223123231242312523126231272312823129231302313123132231332313423135231362313723138231392314023141231422314323144231452314623147231482314923150231512315223153231542315523156231572315823159231602316123162231632316423165231662316723168231692317023171231722317323174231752317623177231782317923180231812318223183231842318523186231872318823189231902319123192231932319423195231962319723198231992320023201232022320323204232052320623207232082320923210232112321223213232142321523216232172321823219232202322123222232232322423225232262322723228232292323023231232322323323234232352323623237232382323923240232412324223243232442324523246232472324823249232502325123252232532325423255232562325723258232592326023261232622326323264232652326623267232682326923270232712327223273232742327523276232772327823279232802328123282232832328423285232862328723288232892329023291232922329323294232952329623297232982329923300233012330223303233042330523306233072330823309233102331123312233132331423315233162331723318233192332023321233222332323324233252332623327233282332923330233312333223333233342333523336233372333823339233402334123342233432334423345233462334723348233492335023351233522335323354233552335623357233582335923360233612336223363233642336523366233672336823369233702337123372233732337423375233762337723378233792338023381233822338323384233852338623387233882338923390233912339223393233942339523396233972339823399234002340123402234032340423405234062340723408234092341023411234122341323414234152341623417234182341923420234212342223423234242342523426234272342823429234302343123432234332343423435234362343723438234392344023441234422344323444234452344623447234482344923450234512345223453234542345523456234572345823459234602346123462234632346423465234662346723468234692347023471234722347323474234752347623477234782347923480234812348223483234842348523486234872348823489234902349123492234932349423495234962349723498234992350023501235022350323504235052350623507235082350923510235112351223513235142351523516235172351823519235202352123522235232352423525235262352723528235292353023531235322353323534235352353623537235382353923540235412354223543235442354523546235472354823549235502355123552235532355423555235562355723558235592356023561235622356323564235652356623567235682356923570235712357223573235742357523576235772357823579235802358123582235832358423585235862358723588235892359023591235922359323594235952359623597235982359923600236012360223603236042360523606236072360823609236102361123612236132361423615236162361723618236192362023621236222362323624236252362623627236282362923630236312363223633236342363523636236372363823639236402364123642236432364423645236462364723648236492365023651236522365323654236552365623657236582365923660236612366223663236642366523666236672366823669236702367123672236732367423675236762367723678236792368023681236822368323684236852368623687236882368923690236912369223693236942369523696236972369823699237002370123702237032370423705237062370723708237092371023711237122371323714237152371623717237182371923720237212372223723237242372523726237272372823729237302373123732237332373423735237362373723738237392374023741237422374323744237452374623747237482374923750237512375223753237542375523756237572375823759237602376123762237632376423765237662376723768237692377023771237722377323774237752377623777237782377923780237812378223783237842378523786237872378823789237902379123792237932379423795237962379723798237992380023801238022380323804238052380623807238082380923810238112381223813238142381523816238172381823819238202382123822238232382423825238262382723828238292383023831238322383323834238352383623837238382383923840238412384223843238442384523846238472384823849238502385123852238532385423855238562385723858238592386023861238622386323864238652386623867238682386923870238712387223873238742387523876238772387823879238802388123882238832388423885238862388723888238892389023891238922389323894238952389623897238982389923900239012390223903239042390523906239072390823909239102391123912239132391423915239162391723918239192392023921239222392323924239252392623927239282392923930239312393223933239342393523936239372393823939239402394123942239432394423945239462394723948239492395023951239522395323954239552395623957239582395923960239612396223963239642396523966239672396823969239702397123972239732397423975239762397723978239792398023981239822398323984239852398623987239882398923990239912399223993239942399523996239972399823999240002400124002240032400424005
  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. // Used to keep custom CA configuration exclusive with system CA loading.
  2917. bool ca_cert_store_set_ = false;
  2918. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  2919. // Like ca_cert_store_set_, keeps what ctx_ cannot report back: the verifier
  2920. // set_server_certificate_verifier() installed there.
  2921. tls::VerifyCallback server_certificate_verifier_;
  2922. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2923. bool enable_windows_cert_verification_ = true;
  2924. #endif
  2925. friend class ClientImpl;
  2926. };
  2927. #endif // CPPHTTPLIB_SSL_ENABLED
  2928. namespace detail {
  2929. template <typename T, typename U>
  2930. inline void duration_to_sec_and_usec(const T &duration, U callback) {
  2931. auto sec = std::chrono::duration_cast<std::chrono::seconds>(duration).count();
  2932. auto usec = std::chrono::duration_cast<std::chrono::microseconds>(
  2933. duration - std::chrono::seconds(sec))
  2934. .count();
  2935. callback(static_cast<time_t>(sec), static_cast<time_t>(usec));
  2936. }
  2937. template <size_t N> inline constexpr size_t str_len(const char (&)[N]) {
  2938. return N - 1;
  2939. }
  2940. inline bool is_numeric(const std::string &str) {
  2941. return !str.empty() && std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  2942. }
  2943. // std::ranges::next(first, n, last) for C++11
  2944. template <typename It> inline It bounded_next(It first, size_t n, It last) {
  2945. for (; n > 0 && first != last; --n) {
  2946. ++first;
  2947. }
  2948. return first;
  2949. }
  2950. inline size_t get_header_value_u64(const Headers &headers,
  2951. const std::string &key, size_t def,
  2952. size_t id, bool &is_invalid_value) {
  2953. is_invalid_value = false;
  2954. auto rng = headers.equal_range(key);
  2955. auto it = bounded_next(rng.first, id, rng.second);
  2956. if (it != rng.second) {
  2957. if (is_numeric(it->second)) {
  2958. // Parse at size_t width so an out-of-range Content-Length is reported
  2959. // rather than silently saturated/truncated (a value above 2^32 would
  2960. // otherwise wrap to a small framing length on 32-bit builds). Flag it
  2961. // and return SIZE_MAX so the existing oversized-value guards reject it.
  2962. size_t val = 0;
  2963. const auto &s = it->second;
  2964. auto r = from_chars(s.data(), s.data() + s.size(), val);
  2965. if (r.ec == std::errc::result_out_of_range) {
  2966. is_invalid_value = true;
  2967. return (std::numeric_limits<size_t>::max)();
  2968. }
  2969. return val;
  2970. } else {
  2971. is_invalid_value = true;
  2972. }
  2973. }
  2974. return def;
  2975. }
  2976. inline size_t get_header_value_u64(const Headers &headers,
  2977. const std::string &key, size_t def,
  2978. size_t id) {
  2979. auto dummy = false;
  2980. return get_header_value_u64(headers, key, def, id, dummy);
  2981. }
  2982. } // namespace detail
  2983. template <class Rep, class Period>
  2984. inline Server &
  2985. Server::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2986. detail::duration_to_sec_and_usec(
  2987. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  2988. return *this;
  2989. }
  2990. template <class Rep, class Period>
  2991. inline Server &
  2992. Server::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2993. detail::duration_to_sec_and_usec(
  2994. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  2995. return *this;
  2996. }
  2997. template <class Rep, class Period>
  2998. inline Server &
  2999. Server::set_idle_interval(const std::chrono::duration<Rep, Period> &duration) {
  3000. detail::duration_to_sec_and_usec(
  3001. duration, [&](time_t sec, time_t usec) { set_idle_interval(sec, usec); });
  3002. return *this;
  3003. }
  3004. template <class Rep, class Period>
  3005. inline void ClientImpl::set_connection_timeout(
  3006. const std::chrono::duration<Rep, Period> &duration) {
  3007. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  3008. set_connection_timeout(sec, usec);
  3009. });
  3010. }
  3011. template <class Rep, class Period>
  3012. inline void ClientImpl::set_read_timeout(
  3013. const std::chrono::duration<Rep, Period> &duration) {
  3014. detail::duration_to_sec_and_usec(
  3015. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3016. }
  3017. template <class Rep, class Period>
  3018. inline void ClientImpl::set_write_timeout(
  3019. const std::chrono::duration<Rep, Period> &duration) {
  3020. detail::duration_to_sec_and_usec(
  3021. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3022. }
  3023. template <class Rep, class Period>
  3024. inline void ClientImpl::set_max_timeout(
  3025. const std::chrono::duration<Rep, Period> &duration) {
  3026. auto msec =
  3027. std::chrono::duration_cast<std::chrono::milliseconds>(duration).count();
  3028. set_max_timeout(static_cast<time_t>(msec));
  3029. }
  3030. template <class Rep, class Period>
  3031. inline void Client::set_connection_timeout(
  3032. const std::chrono::duration<Rep, Period> &duration) {
  3033. cli_->set_connection_timeout(duration);
  3034. }
  3035. template <class Rep, class Period>
  3036. inline void
  3037. Client::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3038. cli_->set_read_timeout(duration);
  3039. }
  3040. template <class Rep, class Period>
  3041. inline void
  3042. Client::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3043. cli_->set_write_timeout(duration);
  3044. }
  3045. inline void Client::set_max_timeout(time_t msec) {
  3046. cli_->set_max_timeout(msec);
  3047. }
  3048. template <class Rep, class Period>
  3049. inline void
  3050. Client::set_max_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3051. cli_->set_max_timeout(duration);
  3052. }
  3053. /*
  3054. * Forward declarations and types that will be part of the .h file if split into
  3055. * .h + .cc.
  3056. */
  3057. std::string hosted_at(const std::string &hostname);
  3058. void hosted_at(const std::string &hostname, std::vector<std::string> &addrs);
  3059. // JavaScript-style URL encoding/decoding functions
  3060. std::string encode_uri_component(const std::string &value);
  3061. std::string encode_uri(const std::string &value);
  3062. std::string decode_uri_component(const std::string &value);
  3063. std::string decode_uri(const std::string &value);
  3064. // RFC 3986 compliant URL component encoding/decoding functions
  3065. std::string encode_path_component(const std::string &component);
  3066. std::string decode_path_component(const std::string &component);
  3067. std::string encode_query_component(const std::string &component,
  3068. bool space_as_plus = true);
  3069. std::string decode_query_component(const std::string &component,
  3070. bool plus_as_space = true);
  3071. std::string sanitize_filename(const std::string &filename);
  3072. std::string append_query_params(const std::string &path, const Params &params);
  3073. std::pair<std::string, std::string> make_range_header(const Ranges &ranges);
  3074. std::pair<std::string, std::string>
  3075. make_basic_authentication_header(const std::string &username,
  3076. const std::string &password,
  3077. bool is_proxy = false);
  3078. namespace detail {
  3079. #if defined(_WIN32)
  3080. inline std::wstring u8string_to_wstring(const char *s) {
  3081. if (!s) { return std::wstring(); }
  3082. auto len = static_cast<int>(strlen(s));
  3083. if (!len) { return std::wstring(); }
  3084. auto wlen = ::MultiByteToWideChar(CP_UTF8, 0, s, len, nullptr, 0);
  3085. if (!wlen) { return std::wstring(); }
  3086. std::wstring ws;
  3087. ws.resize(wlen);
  3088. wlen = ::MultiByteToWideChar(
  3089. CP_UTF8, 0, s, len,
  3090. const_cast<LPWSTR>(reinterpret_cast<LPCWSTR>(ws.data())), wlen);
  3091. if (wlen != static_cast<int>(ws.size())) { ws.clear(); }
  3092. return ws;
  3093. }
  3094. #endif
  3095. struct FileStat {
  3096. FileStat(const std::string &path);
  3097. bool is_file() const;
  3098. bool is_dir() const;
  3099. time_t mtime() const;
  3100. size_t size() const;
  3101. private:
  3102. #if defined(_WIN32)
  3103. struct _stat st_;
  3104. #else
  3105. struct stat st_;
  3106. #endif
  3107. int ret_ = -1;
  3108. };
  3109. std::string make_host_and_port_string(const std::string &host, int port,
  3110. bool is_ssl);
  3111. template <typename T>
  3112. bool check_and_write_headers(Stream &strm, Headers &headers, T header_writer,
  3113. Error &error);
  3114. std::string trim_copy(const std::string &s);
  3115. void divide(
  3116. const char *data, std::size_t size, char d,
  3117. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3118. fn);
  3119. void divide(
  3120. const std::string &str, char d,
  3121. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3122. fn);
  3123. void split(const char *b, const char *e, char d,
  3124. std::function<void(const char *, const char *)> fn);
  3125. void split(const char *b, const char *e, char d, size_t m,
  3126. std::function<void(const char *, const char *)> fn);
  3127. bool split_find(const char *b, const char *e, char d,
  3128. std::function<bool(const char *, const char *)> fn);
  3129. bool has_header_token(const Headers &headers, const std::string &key,
  3130. const std::string &token);
  3131. std::string websocket_accept_key(const std::string &client_key);
  3132. bool is_websocket_upgrade(const Request &req);
  3133. bool process_client_socket(
  3134. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  3135. time_t write_timeout_sec, time_t write_timeout_usec,
  3136. time_t max_timeout_msec,
  3137. std::chrono::time_point<std::chrono::steady_clock> start_time,
  3138. std::function<bool(Stream &)> callback);
  3139. socket_t create_client_socket(const std::string &host, const std::string &ip,
  3140. int port, int address_family, bool tcp_nodelay,
  3141. bool ipv6_v6only, SocketOptions socket_options,
  3142. time_t connection_timeout_sec,
  3143. time_t connection_timeout_usec,
  3144. time_t read_timeout_sec, time_t read_timeout_usec,
  3145. time_t write_timeout_sec,
  3146. time_t write_timeout_usec,
  3147. const std::string &intf, Error &error);
  3148. const char *get_header_value(const Headers &headers, const std::string &key,
  3149. const char *def, size_t id);
  3150. std::string get_combined_header_value(const Headers &headers,
  3151. const std::string &key);
  3152. std::string params_to_query_str(const Params &params);
  3153. void parse_query_text(const char *data, std::size_t size, Params &params);
  3154. void parse_query_text(const std::string &s, Params &params);
  3155. bool parse_multipart_boundary(const std::string &content_type,
  3156. std::string &boundary);
  3157. bool parse_range_header(const std::string &s, Ranges &ranges);
  3158. bool parse_accept_header(const std::string &s,
  3159. std::vector<std::string> &content_types);
  3160. void parse_disposition_params(const std::string &s, Params &params);
  3161. ssize_t send_socket(socket_t sock, const void *ptr, size_t size, int flags);
  3162. ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags);
  3163. EncodingType encoding_type(const Request &req, const std::string &content_type);
  3164. EncodingType encoding_type(const Request &req, const Response &res,
  3165. const std::string &content_type);
  3166. EncodingType encoding_type(const Request &req, const Response &res);
  3167. class BufferStream final : public Stream {
  3168. public:
  3169. BufferStream() = default;
  3170. ~BufferStream() override = default;
  3171. bool is_readable() const override;
  3172. bool wait_readable() const override;
  3173. bool wait_writable() const override;
  3174. ssize_t read(char *ptr, size_t size) override;
  3175. ssize_t write(const char *ptr, size_t size) override;
  3176. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  3177. void get_local_ip_and_port(std::string &ip, int &port) const override;
  3178. socket_t socket() const override;
  3179. time_t duration() const override;
  3180. const std::string &get_buffer() const;
  3181. private:
  3182. std::string buffer;
  3183. size_t position = 0;
  3184. };
  3185. class compressor {
  3186. public:
  3187. virtual ~compressor() = default;
  3188. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3189. virtual bool compress(const char *data, size_t data_length, bool last,
  3190. Callback callback) = 0;
  3191. };
  3192. class decompressor {
  3193. public:
  3194. virtual ~decompressor() = default;
  3195. virtual bool is_valid() const = 0;
  3196. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3197. virtual bool decompress(const char *data, size_t data_length,
  3198. Callback callback) = 0;
  3199. };
  3200. class nocompressor final : public compressor {
  3201. public:
  3202. ~nocompressor() override = default;
  3203. bool compress(const char *data, size_t data_length, bool /*last*/,
  3204. Callback callback) override;
  3205. };
  3206. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  3207. class gzip_compressor final : public compressor {
  3208. public:
  3209. gzip_compressor();
  3210. ~gzip_compressor() override;
  3211. bool compress(const char *data, size_t data_length, bool last,
  3212. Callback callback) override;
  3213. private:
  3214. bool is_valid_ = false;
  3215. z_stream strm_;
  3216. };
  3217. class gzip_decompressor final : public decompressor {
  3218. public:
  3219. gzip_decompressor();
  3220. ~gzip_decompressor() override;
  3221. bool is_valid() const override;
  3222. bool decompress(const char *data, size_t data_length,
  3223. Callback callback) override;
  3224. private:
  3225. bool is_valid_ = false;
  3226. z_stream strm_;
  3227. };
  3228. #endif
  3229. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  3230. class brotli_compressor final : public compressor {
  3231. public:
  3232. brotli_compressor();
  3233. ~brotli_compressor();
  3234. bool compress(const char *data, size_t data_length, bool last,
  3235. Callback callback) override;
  3236. private:
  3237. BrotliEncoderState *state_ = nullptr;
  3238. };
  3239. class brotli_decompressor final : public decompressor {
  3240. public:
  3241. brotli_decompressor();
  3242. ~brotli_decompressor();
  3243. bool is_valid() const override;
  3244. bool decompress(const char *data, size_t data_length,
  3245. Callback callback) override;
  3246. private:
  3247. BrotliDecoderResult decoder_r;
  3248. BrotliDecoderState *decoder_s = nullptr;
  3249. };
  3250. #endif
  3251. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  3252. class zstd_compressor : public compressor {
  3253. public:
  3254. zstd_compressor();
  3255. ~zstd_compressor();
  3256. bool compress(const char *data, size_t data_length, bool last,
  3257. Callback callback) override;
  3258. private:
  3259. ZSTD_CCtx *ctx_ = nullptr;
  3260. };
  3261. class zstd_decompressor : public decompressor {
  3262. public:
  3263. zstd_decompressor();
  3264. ~zstd_decompressor();
  3265. bool is_valid() const override;
  3266. bool decompress(const char *data, size_t data_length,
  3267. Callback callback) override;
  3268. private:
  3269. ZSTD_DCtx *ctx_ = nullptr;
  3270. };
  3271. #endif
  3272. // NOTE: until the read size reaches `fixed_buffer_size`, use `fixed_buffer`
  3273. // to store data. The call can set memory on stack for performance.
  3274. class stream_line_reader {
  3275. public:
  3276. stream_line_reader(Stream &strm, char *fixed_buffer,
  3277. size_t fixed_buffer_size);
  3278. const char *ptr() const;
  3279. size_t size() const;
  3280. bool end_with_crlf() const;
  3281. bool getline();
  3282. private:
  3283. void append(char c);
  3284. void append(const char *data, size_t size);
  3285. Stream &strm_;
  3286. char *fixed_buffer_;
  3287. const size_t fixed_buffer_size_;
  3288. size_t fixed_buffer_used_size_ = 0;
  3289. std::string growable_buffer_;
  3290. };
  3291. bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  3292. const Headers &src_headers);
  3293. struct ChunkedDecoder {
  3294. Stream &strm;
  3295. size_t chunk_remaining = 0;
  3296. bool finished = false;
  3297. char line_buf[64];
  3298. size_t last_chunk_total = 0;
  3299. size_t last_chunk_offset = 0;
  3300. explicit ChunkedDecoder(Stream &s);
  3301. ssize_t read_payload(char *buf, size_t len, size_t &out_chunk_offset,
  3302. size_t &out_chunk_total);
  3303. bool parse_trailers_into(Headers &dest, const Headers &src_headers);
  3304. };
  3305. // A regular file opened to be served: mapped on Windows, read with pread()
  3306. // elsewhere.
  3307. class mmap {
  3308. public:
  3309. mmap(const char *path);
  3310. ~mmap();
  3311. bool open(const char *path);
  3312. void close();
  3313. bool is_open() const;
  3314. size_t size() const;
  3315. // Copies up to len bytes from offset into buf and returns how many: fewer,
  3316. // down to 0, if the file has shrunk since it was opened.
  3317. size_t read(size_t offset, char *buf, size_t len) const;
  3318. private:
  3319. #if defined(_WIN32)
  3320. HANDLE hFile_ = NULL;
  3321. HANDLE hMapping_ = NULL;
  3322. void *addr_ = nullptr;
  3323. bool is_open_empty_file = false;
  3324. #else
  3325. int fd_ = -1;
  3326. #endif
  3327. size_t size_ = 0;
  3328. };
  3329. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  3330. namespace fields {
  3331. bool is_token_char(char c);
  3332. bool is_token(const std::string &s);
  3333. bool is_field_name(const std::string &s);
  3334. bool is_vchar(char c);
  3335. bool is_obs_text(char c);
  3336. bool is_field_vchar(char c);
  3337. bool is_field_content(const std::string &s);
  3338. bool is_field_value(const std::string &s);
  3339. bool is_field_valid(const std::string &name, const std::string &value);
  3340. bool is_request_target(const std::string &s);
  3341. bool is_host(const std::string &s);
  3342. } // namespace fields
  3343. } // namespace detail
  3344. /*
  3345. * TLS Abstraction Layer Declarations
  3346. */
  3347. #ifdef CPPHTTPLIB_SSL_ENABLED
  3348. // TLS abstraction layer - backend-specific type declarations
  3349. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  3350. namespace tls {
  3351. namespace impl {
  3352. // Mbed TLS context wrapper (holds config, entropy, DRBG, CA chain, own
  3353. // cert/key). This struct is accessible via tls::impl for use in SSL context
  3354. // setup callbacks (cast ctx_t to tls::impl::MbedTlsContext*).
  3355. struct MbedTlsContext {
  3356. mbedtls_ssl_config conf;
  3357. #ifndef CPPHTTPLIB_MBEDTLS_V4
  3358. // Mbed TLS 4.x uses PSA Crypto's internal RNG; no explicit entropy/DRBG.
  3359. mbedtls_entropy_context entropy;
  3360. mbedtls_ctr_drbg_context ctr_drbg;
  3361. #endif
  3362. mbedtls_x509_crt ca_chain;
  3363. mbedtls_x509_crt own_cert;
  3364. mbedtls_pk_context own_key;
  3365. bool is_server = false;
  3366. // Peer certificate required (set_verify_client()); a client defaults to true
  3367. bool verify_client = false;
  3368. // Set by tls::set_verify_callback().
  3369. VerifyCallback verify_callback;
  3370. MbedTlsContext();
  3371. ~MbedTlsContext();
  3372. MbedTlsContext(const MbedTlsContext &) = delete;
  3373. MbedTlsContext &operator=(const MbedTlsContext &) = delete;
  3374. };
  3375. } // namespace impl
  3376. } // namespace tls
  3377. #endif
  3378. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  3379. namespace tls {
  3380. namespace impl {
  3381. // wolfSSL context wrapper (holds WOLFSSL_CTX and related state).
  3382. // This struct is accessible via tls::impl for use in SSL context
  3383. // setup callbacks (cast ctx_t to tls::impl::WolfSSLContext*).
  3384. struct WolfSSLContext {
  3385. WOLFSSL_CTX *ctx = nullptr;
  3386. bool is_server = false;
  3387. // Peer certificate required (set_verify_client()); a client defaults to true
  3388. bool verify_client = false;
  3389. // Replaced under verify_callback_mutex()
  3390. std::shared_ptr<VerifyCallback> verify_callback;
  3391. std::string ca_pem_data_; // accumulated PEM for get_ca_names/get_ca_certs
  3392. WolfSSLContext();
  3393. ~WolfSSLContext();
  3394. WolfSSLContext(const WolfSSLContext &) = delete;
  3395. WolfSSLContext &operator=(const WolfSSLContext &) = delete;
  3396. };
  3397. // CA store for wolfSSL: holds raw PEM bytes to allow reloading into any ctx
  3398. struct WolfSSLCAStore {
  3399. std::string pem_data;
  3400. };
  3401. } // namespace impl
  3402. } // namespace tls
  3403. #endif
  3404. #endif // CPPHTTPLIB_SSL_ENABLED
  3405. namespace stream {
  3406. class Result {
  3407. public:
  3408. Result();
  3409. explicit Result(ClientImpl::StreamHandle &&handle, size_t chunk_size = 8192);
  3410. Result(Result &&other) noexcept;
  3411. Result &operator=(Result &&other) noexcept;
  3412. Result(const Result &) = delete;
  3413. Result &operator=(const Result &) = delete;
  3414. // Response info
  3415. bool is_valid() const;
  3416. explicit operator bool() const;
  3417. int status() const;
  3418. const Headers &headers() const;
  3419. std::string get_header_value(const std::string &key,
  3420. const char *def = "") const;
  3421. bool has_header(const std::string &key) const;
  3422. Error error() const;
  3423. Error read_error() const;
  3424. bool has_read_error() const;
  3425. // Stream reading
  3426. bool next();
  3427. const char *data() const;
  3428. size_t size() const;
  3429. std::string read_all();
  3430. private:
  3431. ClientImpl::StreamHandle handle_;
  3432. std::string buffer_;
  3433. size_t current_size_ = 0;
  3434. size_t chunk_size_;
  3435. bool finished_ = false;
  3436. };
  3437. // GET
  3438. template <typename ClientType>
  3439. inline Result Get(ClientType &cli, const std::string &path,
  3440. size_t chunk_size = 8192) {
  3441. return Result{cli.open_stream("GET", path), chunk_size};
  3442. }
  3443. template <typename ClientType>
  3444. inline Result Get(ClientType &cli, const std::string &path,
  3445. const Headers &headers, size_t chunk_size = 8192) {
  3446. return Result{cli.open_stream("GET", path, {}, headers), chunk_size};
  3447. }
  3448. template <typename ClientType>
  3449. inline Result Get(ClientType &cli, const std::string &path,
  3450. const Params &params, size_t chunk_size = 8192) {
  3451. return Result{cli.open_stream("GET", path, params), chunk_size};
  3452. }
  3453. template <typename ClientType>
  3454. inline Result Get(ClientType &cli, const std::string &path,
  3455. const Params &params, const Headers &headers,
  3456. size_t chunk_size = 8192) {
  3457. return Result{cli.open_stream("GET", path, params, headers), chunk_size};
  3458. }
  3459. // POST
  3460. template <typename ClientType>
  3461. inline Result Post(ClientType &cli, const std::string &path,
  3462. const std::string &body, const std::string &content_type,
  3463. size_t chunk_size = 8192) {
  3464. return Result{cli.open_stream("POST", path, {}, {}, body, content_type),
  3465. chunk_size};
  3466. }
  3467. template <typename ClientType>
  3468. inline Result Post(ClientType &cli, const std::string &path,
  3469. const Headers &headers, const std::string &body,
  3470. const std::string &content_type, size_t chunk_size = 8192) {
  3471. return Result{cli.open_stream("POST", path, {}, headers, body, content_type),
  3472. chunk_size};
  3473. }
  3474. template <typename ClientType>
  3475. inline Result Post(ClientType &cli, const std::string &path,
  3476. const Params &params, const std::string &body,
  3477. const std::string &content_type, size_t chunk_size = 8192) {
  3478. return Result{cli.open_stream("POST", path, params, {}, body, content_type),
  3479. chunk_size};
  3480. }
  3481. template <typename ClientType>
  3482. inline Result Post(ClientType &cli, const std::string &path,
  3483. const Params &params, const Headers &headers,
  3484. const std::string &body, const std::string &content_type,
  3485. size_t chunk_size = 8192) {
  3486. return Result{
  3487. cli.open_stream("POST", path, params, headers, body, content_type),
  3488. chunk_size};
  3489. }
  3490. // PUT
  3491. template <typename ClientType>
  3492. inline Result Put(ClientType &cli, const std::string &path,
  3493. const std::string &body, const std::string &content_type,
  3494. size_t chunk_size = 8192) {
  3495. return Result{cli.open_stream("PUT", path, {}, {}, body, content_type),
  3496. chunk_size};
  3497. }
  3498. template <typename ClientType>
  3499. inline Result Put(ClientType &cli, const std::string &path,
  3500. const Headers &headers, const std::string &body,
  3501. const std::string &content_type, size_t chunk_size = 8192) {
  3502. return Result{cli.open_stream("PUT", path, {}, headers, body, content_type),
  3503. chunk_size};
  3504. }
  3505. template <typename ClientType>
  3506. inline Result Put(ClientType &cli, const std::string &path,
  3507. const Params &params, const std::string &body,
  3508. const std::string &content_type, size_t chunk_size = 8192) {
  3509. return Result{cli.open_stream("PUT", path, params, {}, body, content_type),
  3510. chunk_size};
  3511. }
  3512. template <typename ClientType>
  3513. inline Result Put(ClientType &cli, const std::string &path,
  3514. const Params &params, const Headers &headers,
  3515. const std::string &body, const std::string &content_type,
  3516. size_t chunk_size = 8192) {
  3517. return Result{
  3518. cli.open_stream("PUT", path, params, headers, body, content_type),
  3519. chunk_size};
  3520. }
  3521. // PATCH
  3522. template <typename ClientType>
  3523. inline Result Patch(ClientType &cli, const std::string &path,
  3524. const std::string &body, const std::string &content_type,
  3525. size_t chunk_size = 8192) {
  3526. return Result{cli.open_stream("PATCH", path, {}, {}, body, content_type),
  3527. chunk_size};
  3528. }
  3529. template <typename ClientType>
  3530. inline Result Patch(ClientType &cli, const std::string &path,
  3531. const Headers &headers, const std::string &body,
  3532. const std::string &content_type, size_t chunk_size = 8192) {
  3533. return Result{cli.open_stream("PATCH", path, {}, headers, body, content_type),
  3534. chunk_size};
  3535. }
  3536. template <typename ClientType>
  3537. inline Result Patch(ClientType &cli, const std::string &path,
  3538. const Params &params, const std::string &body,
  3539. const std::string &content_type, size_t chunk_size = 8192) {
  3540. return Result{cli.open_stream("PATCH", path, params, {}, body, content_type),
  3541. chunk_size};
  3542. }
  3543. template <typename ClientType>
  3544. inline Result Patch(ClientType &cli, const std::string &path,
  3545. const Params &params, const Headers &headers,
  3546. const std::string &body, const std::string &content_type,
  3547. size_t chunk_size = 8192) {
  3548. return Result{
  3549. cli.open_stream("PATCH", path, params, headers, body, content_type),
  3550. chunk_size};
  3551. }
  3552. // DELETE
  3553. template <typename ClientType>
  3554. inline Result Delete(ClientType &cli, const std::string &path,
  3555. size_t chunk_size = 8192) {
  3556. return Result{cli.open_stream("DELETE", path), chunk_size};
  3557. }
  3558. template <typename ClientType>
  3559. inline Result Delete(ClientType &cli, const std::string &path,
  3560. const Headers &headers, size_t chunk_size = 8192) {
  3561. return Result{cli.open_stream("DELETE", path, {}, headers), chunk_size};
  3562. }
  3563. template <typename ClientType>
  3564. inline Result Delete(ClientType &cli, const std::string &path,
  3565. const std::string &body, const std::string &content_type,
  3566. size_t chunk_size = 8192) {
  3567. return Result{cli.open_stream("DELETE", path, {}, {}, body, content_type),
  3568. chunk_size};
  3569. }
  3570. template <typename ClientType>
  3571. inline Result Delete(ClientType &cli, const std::string &path,
  3572. const Headers &headers, const std::string &body,
  3573. const std::string &content_type,
  3574. size_t chunk_size = 8192) {
  3575. return Result{
  3576. cli.open_stream("DELETE", path, {}, headers, body, content_type),
  3577. chunk_size};
  3578. }
  3579. template <typename ClientType>
  3580. inline Result Delete(ClientType &cli, const std::string &path,
  3581. const Params &params, size_t chunk_size = 8192) {
  3582. return Result{cli.open_stream("DELETE", path, params), chunk_size};
  3583. }
  3584. template <typename ClientType>
  3585. inline Result Delete(ClientType &cli, const std::string &path,
  3586. const Params &params, const Headers &headers,
  3587. size_t chunk_size = 8192) {
  3588. return Result{cli.open_stream("DELETE", path, params, headers), chunk_size};
  3589. }
  3590. template <typename ClientType>
  3591. inline Result Delete(ClientType &cli, const std::string &path,
  3592. const Params &params, const std::string &body,
  3593. const std::string &content_type,
  3594. size_t chunk_size = 8192) {
  3595. return Result{cli.open_stream("DELETE", path, params, {}, body, content_type),
  3596. chunk_size};
  3597. }
  3598. template <typename ClientType>
  3599. inline Result Delete(ClientType &cli, const std::string &path,
  3600. const Params &params, const Headers &headers,
  3601. const std::string &body, const std::string &content_type,
  3602. size_t chunk_size = 8192) {
  3603. return Result{
  3604. cli.open_stream("DELETE", path, params, headers, body, content_type),
  3605. chunk_size};
  3606. }
  3607. // HEAD
  3608. template <typename ClientType>
  3609. inline Result Head(ClientType &cli, const std::string &path,
  3610. size_t chunk_size = 8192) {
  3611. return Result{cli.open_stream("HEAD", path), chunk_size};
  3612. }
  3613. template <typename ClientType>
  3614. inline Result Head(ClientType &cli, const std::string &path,
  3615. const Headers &headers, size_t chunk_size = 8192) {
  3616. return Result{cli.open_stream("HEAD", path, {}, headers), chunk_size};
  3617. }
  3618. template <typename ClientType>
  3619. inline Result Head(ClientType &cli, const std::string &path,
  3620. const Params &params, size_t chunk_size = 8192) {
  3621. return Result{cli.open_stream("HEAD", path, params), chunk_size};
  3622. }
  3623. template <typename ClientType>
  3624. inline Result Head(ClientType &cli, const std::string &path,
  3625. const Params &params, const Headers &headers,
  3626. size_t chunk_size = 8192) {
  3627. return Result{cli.open_stream("HEAD", path, params, headers), chunk_size};
  3628. }
  3629. // OPTIONS
  3630. template <typename ClientType>
  3631. inline Result Options(ClientType &cli, const std::string &path,
  3632. size_t chunk_size = 8192) {
  3633. return Result{cli.open_stream("OPTIONS", path), chunk_size};
  3634. }
  3635. template <typename ClientType>
  3636. inline Result Options(ClientType &cli, const std::string &path,
  3637. const Headers &headers, size_t chunk_size = 8192) {
  3638. return Result{cli.open_stream("OPTIONS", path, {}, headers), chunk_size};
  3639. }
  3640. template <typename ClientType>
  3641. inline Result Options(ClientType &cli, const std::string &path,
  3642. const Params &params, size_t chunk_size = 8192) {
  3643. return Result{cli.open_stream("OPTIONS", path, params), chunk_size};
  3644. }
  3645. template <typename ClientType>
  3646. inline Result Options(ClientType &cli, const std::string &path,
  3647. const Params &params, const Headers &headers,
  3648. size_t chunk_size = 8192) {
  3649. return Result{cli.open_stream("OPTIONS", path, params, headers), chunk_size};
  3650. }
  3651. } // namespace stream
  3652. namespace sse {
  3653. struct SSEMessage {
  3654. std::string event; // Event type (default: "message")
  3655. std::string data; // Event payload
  3656. std::string id; // Event ID for Last-Event-ID header
  3657. SSEMessage();
  3658. void clear();
  3659. };
  3660. class SSEClient {
  3661. public:
  3662. using MessageHandler = std::function<void(const SSEMessage &)>;
  3663. using ErrorHandler = std::function<void(Error)>;
  3664. using OpenHandler = std::function<void()>;
  3665. SSEClient(Client &client, const std::string &path);
  3666. SSEClient(Client &client, const std::string &path, const Headers &headers);
  3667. ~SSEClient();
  3668. SSEClient(const SSEClient &) = delete;
  3669. SSEClient &operator=(const SSEClient &) = delete;
  3670. // Event handlers
  3671. SSEClient &on_message(MessageHandler handler);
  3672. SSEClient &on_event(const std::string &type, MessageHandler handler);
  3673. SSEClient &on_open(OpenHandler handler);
  3674. SSEClient &on_error(ErrorHandler handler);
  3675. SSEClient &set_reconnect_interval(int ms);
  3676. SSEClient &set_max_reconnect_attempts(int n);
  3677. // Update headers (thread-safe)
  3678. SSEClient &set_headers(const Headers &headers);
  3679. // State accessors
  3680. bool is_connected() const;
  3681. const std::string &last_event_id() const;
  3682. // Blocking start - runs event loop with auto-reconnect
  3683. void start();
  3684. // Non-blocking start - runs in background thread
  3685. void start_async();
  3686. // Stop the client (thread-safe)
  3687. void stop();
  3688. private:
  3689. bool parse_sse_line(const std::string &line, SSEMessage &msg, int &retry_ms,
  3690. bool &has_data, bool &has_id);
  3691. void run_event_loop();
  3692. void dispatch_event(const SSEMessage &msg);
  3693. bool should_reconnect(int count) const;
  3694. void wait_for_reconnect();
  3695. // Client and path
  3696. Client &client_;
  3697. std::string path_;
  3698. Headers headers_;
  3699. mutable std::mutex headers_mutex_;
  3700. // Callbacks
  3701. MessageHandler on_message_;
  3702. std::map<std::string, MessageHandler> event_handlers_;
  3703. OpenHandler on_open_;
  3704. ErrorHandler on_error_;
  3705. // Configuration
  3706. int reconnect_interval_ms_ = 3000;
  3707. int max_reconnect_attempts_ = 0; // 0 = unlimited
  3708. // State
  3709. std::atomic<bool> running_{false};
  3710. std::atomic<bool> connected_{false};
  3711. std::string last_event_id_;
  3712. // Async support
  3713. std::thread async_thread_;
  3714. };
  3715. } // namespace sse
  3716. namespace ws {
  3717. class WebSocketClient;
  3718. enum class Opcode : uint8_t {
  3719. Continuation = 0x0,
  3720. Text = 0x1,
  3721. Binary = 0x2,
  3722. Close = 0x8,
  3723. Ping = 0x9,
  3724. Pong = 0xA,
  3725. };
  3726. enum class CloseStatus : uint16_t {
  3727. Normal = 1000,
  3728. GoingAway = 1001,
  3729. ProtocolError = 1002,
  3730. UnsupportedData = 1003,
  3731. NoStatus = 1005,
  3732. Abnormal = 1006,
  3733. InvalidPayload = 1007,
  3734. PolicyViolation = 1008,
  3735. MessageTooBig = 1009,
  3736. MandatoryExtension = 1010,
  3737. InternalError = 1011,
  3738. };
  3739. // Timeout is returned only when a read timeout was set and it elapsed before
  3740. // any byte of a frame arrived: nothing was consumed and the connection is
  3741. // still open, so the caller can send on it and read again. `msg` is left
  3742. // untouched, so a `while (ws.read(msg))` loop must not treat it as a message.
  3743. enum ReadResult : int { Fail = 0, Text = 1, Binary = 2, Timeout = 3 };
  3744. // Result of WebSocketClient::connect(). Truthy only when the WebSocket
  3745. // upgrade handshake fully succeeded. On failure error() identifies the
  3746. // failing layer; status()/headers() expose the server's upgrade response
  3747. // when one was received (status() is -1 otherwise), or the proxy's reply to
  3748. // CONNECT when error() is ProxyConnection.
  3749. class Result {
  3750. public:
  3751. Result() = default;
  3752. Result(Error err, int status, Headers &&headers)
  3753. : err_(err), status_(status), headers_(std::move(headers)) {}
  3754. explicit operator bool() const { return err_ == Error::Success; }
  3755. Error error() const { return err_; }
  3756. // Upgrade response info
  3757. int status() const { return status_; }
  3758. const Headers &headers() const { return headers_; }
  3759. std::string get_header_value(const std::string &key,
  3760. const char *def = "") const {
  3761. return detail::get_header_value(headers_, key, def, 0);
  3762. }
  3763. bool has_header(const std::string &key) const {
  3764. return headers_.find(key) != headers_.end();
  3765. }
  3766. #ifdef CPPHTTPLIB_SSL_ENABLED
  3767. Result(Error err, int status, Headers &&headers, int ssl_error,
  3768. uint64_t ssl_backend_error)
  3769. : err_(err), status_(status), headers_(std::move(headers)),
  3770. ssl_error_(ssl_error), ssl_backend_error_(ssl_backend_error) {}
  3771. int ssl_error() const { return ssl_error_; }
  3772. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  3773. #endif
  3774. private:
  3775. Error err_ = Error::Unknown; // a default-constructed Result is falsy
  3776. int status_ = -1;
  3777. Headers headers_;
  3778. #ifdef CPPHTTPLIB_SSL_ENABLED
  3779. int ssl_error_ = 0;
  3780. uint64_t ssl_backend_error_ = 0;
  3781. #endif
  3782. };
  3783. class WebSocket {
  3784. public:
  3785. WebSocket(const WebSocket &) = delete;
  3786. WebSocket &operator=(const WebSocket &) = delete;
  3787. ~WebSocket();
  3788. ReadResult read(std::string &msg);
  3789. bool send(const std::string &data);
  3790. bool send(const char *data, size_t len);
  3791. void close(CloseStatus status = CloseStatus::Normal,
  3792. const std::string &reason = "");
  3793. const Request &request() const;
  3794. bool is_open() const;
  3795. // Bound how long read() waits before returning Timeout. 0 waits forever.
  3796. // A server handler owns its connection's timeout this way; a client sets it
  3797. // through WebSocketClient. Safe to call while another thread is in read().
  3798. //
  3799. // Only a timeout set here is reported as Timeout. The compile-time default
  3800. // (CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND) is a backstop rather
  3801. // than a request for control, so when it elapses read() returns Fail and
  3802. // closes the connection, and `while (ws.read(msg))` ends as it always has.
  3803. void set_read_timeout(time_t sec, time_t usec = 0);
  3804. template <class Rep, class Period>
  3805. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3806. private:
  3807. friend class httplib::Server;
  3808. friend class httplib::ws::WebSocketClient;
  3809. WebSocket(
  3810. Stream &strm, const Request &req, bool is_server,
  3811. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3812. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3813. : strm_(strm), req_(req), is_server_(is_server),
  3814. ping_interval_sec_(ping_interval_sec),
  3815. max_missed_pongs_(max_missed_pongs) {
  3816. start_heartbeat();
  3817. }
  3818. WebSocket(
  3819. std::unique_ptr<Stream> &&owned_strm, const Request &req, bool is_server,
  3820. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3821. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3822. : strm_(*owned_strm), owned_strm_(std::move(owned_strm)), req_(req),
  3823. is_server_(is_server), ping_interval_sec_(ping_interval_sec),
  3824. max_missed_pongs_(max_missed_pongs) {
  3825. start_heartbeat();
  3826. }
  3827. void start_heartbeat();
  3828. bool send_frame(Opcode op, const char *data, size_t len, bool fin = true);
  3829. Stream &strm_;
  3830. std::unique_ptr<Stream> owned_strm_;
  3831. Request req_;
  3832. bool is_server_;
  3833. time_t ping_interval_sec_;
  3834. int max_missed_pongs_;
  3835. int unacked_pings_ = 0;
  3836. std::atomic<bool> closed_{false};
  3837. // Set when the peer stopped answering pings, to end a read() waiting on it
  3838. std::atomic<bool> pong_timed_out_{false};
  3839. // Set once the caller has bounded read() through set_read_timeout(). Until
  3840. // then the timeout in effect is the compile-time default, and elapsing it
  3841. // is a failure that closes the connection, not a Timeout.
  3842. std::atomic<bool> read_timeout_set_{false};
  3843. std::mutex write_mutex_;
  3844. // Owned by whichever thread is parsing frames off strm_. Only one thread
  3845. // may do so: read_websocket_frame() reads a payload until it has the whole
  3846. // declared length, so a second parser stealing bytes silently corrupts the
  3847. // message the first one is assembling.
  3848. std::mutex read_mutex_;
  3849. std::thread ping_thread_;
  3850. std::mutex ping_mutex_;
  3851. std::condition_variable ping_cv_;
  3852. };
  3853. class WebSocketClient {
  3854. public:
  3855. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3856. const Headers &headers = {});
  3857. ~WebSocketClient();
  3858. WebSocketClient(const WebSocketClient &) = delete;
  3859. WebSocketClient &operator=(const WebSocketClient &) = delete;
  3860. bool is_valid() const;
  3861. Result connect();
  3862. ReadResult read(std::string &msg);
  3863. bool send(const std::string &data);
  3864. bool send(const char *data, size_t len);
  3865. void close(CloseStatus status = CloseStatus::Normal,
  3866. const std::string &reason = "");
  3867. bool is_open() const;
  3868. const std::string &subprotocol() const;
  3869. void set_read_timeout(time_t sec, time_t usec = 0);
  3870. template <class Rep, class Period>
  3871. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3872. void set_write_timeout(time_t sec, time_t usec = 0);
  3873. template <class Rep, class Period>
  3874. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  3875. void set_websocket_ping_interval(time_t sec);
  3876. void set_websocket_max_missed_pongs(int count);
  3877. void set_tcp_nodelay(bool on);
  3878. void set_address_family(int family);
  3879. void set_ipv6_v6only(bool on);
  3880. void set_socket_options(SocketOptions socket_options);
  3881. void set_connection_timeout(time_t sec, time_t usec = 0);
  3882. template <class Rep, class Period>
  3883. void
  3884. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  3885. void set_interface(const std::string &intf);
  3886. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  3887. void set_proxy(const std::string &host, int port);
  3888. void set_proxy_basic_auth(const std::string &username,
  3889. const std::string &password);
  3890. void set_proxy_bearer_token_auth(const std::string &token);
  3891. void set_no_proxy(const std::vector<std::string> &patterns);
  3892. #ifdef CPPHTTPLIB_SSL_ENABLED
  3893. struct PemMemory {
  3894. const char *cert_pem;
  3895. size_t cert_pem_len;
  3896. const char *key_pem;
  3897. size_t key_pem_len;
  3898. const char *private_key_password;
  3899. };
  3900. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3901. const PemMemory &pem, const Headers &headers = {});
  3902. void set_ca_cert_path(const std::string &ca_cert_file_path,
  3903. const std::string &ca_cert_dir_path = std::string());
  3904. void set_ca_cert_store(tls::ca_store_t store);
  3905. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  3906. void enable_server_certificate_verification(bool enabled);
  3907. void enable_server_hostname_verification(bool enabled);
  3908. void enable_system_ca(bool enabled);
  3909. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  3910. void set_session_verifier(
  3911. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  3912. void set_proxy_digest_auth(const std::string &username,
  3913. const std::string &password);
  3914. #endif
  3915. private:
  3916. void shutdown_and_close();
  3917. std::pair<time_t, time_t> handshake_timeout() const;
  3918. bool create_stream(std::unique_ptr<Stream> &strm, Error &error,
  3919. int &ssl_error, uint64_t &ssl_backend_error);
  3920. void prepare_default_headers(Request &req);
  3921. bool is_proxy_enabled() const;
  3922. bool create_and_connect_socket(Error &error);
  3923. bool send_proxy_connect(Request &req, Response &proxy_res, Error &error);
  3924. bool connect_with_proxy(Response &proxy_res, Error &error);
  3925. std::string host_;
  3926. int port_;
  3927. std::string path_;
  3928. Headers headers_;
  3929. std::string subprotocol_;
  3930. bool is_valid_ = false;
  3931. socket_t sock_ = INVALID_SOCKET;
  3932. std::unique_ptr<WebSocket> ws_;
  3933. time_t read_timeout_sec_ = CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND;
  3934. time_t read_timeout_usec_ = 0;
  3935. bool read_timeout_set_ = false; // see WebSocket::read_timeout_set_
  3936. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  3937. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  3938. time_t websocket_ping_interval_sec_ =
  3939. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  3940. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  3941. int address_family_ = AF_UNSPEC;
  3942. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  3943. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  3944. SocketOptions socket_options_ = nullptr;
  3945. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  3946. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  3947. std::string interface_;
  3948. // Hostname to connection target map. The value is an IP literal or another
  3949. // hostname; only the connection target changes, never the identity.
  3950. std::map<std::string, std::string> addr_map_;
  3951. std::string proxy_host_;
  3952. int proxy_port_ = -1;
  3953. std::string proxy_basic_auth_username_;
  3954. std::string proxy_basic_auth_password_;
  3955. std::string proxy_bearer_token_auth_token_;
  3956. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  3957. #ifdef CPPHTTPLIB_SSL_ENABLED
  3958. bool is_ssl_ = false;
  3959. tls::ctx_t tls_ctx_ = nullptr;
  3960. tls::session_t tls_session_ = nullptr;
  3961. std::string ca_cert_file_path_;
  3962. std::string ca_cert_dir_path_;
  3963. bool custom_ca_loaded_ = false;
  3964. bool certs_loaded_ = false;
  3965. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  3966. bool server_certificate_verification_ = true;
  3967. bool server_hostname_verification_ = true;
  3968. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  3969. std::string proxy_digest_auth_username_;
  3970. std::string proxy_digest_auth_password_;
  3971. #endif
  3972. };
  3973. template <class Rep, class Period>
  3974. inline void WebSocket::set_read_timeout(
  3975. const std::chrono::duration<Rep, Period> &duration) {
  3976. detail::duration_to_sec_and_usec(
  3977. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3978. }
  3979. template <class Rep, class Period>
  3980. inline void WebSocketClient::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_write_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_write_timeout(sec, usec); });
  3990. }
  3991. template <class Rep, class Period>
  3992. inline void WebSocketClient::set_connection_timeout(
  3993. const std::chrono::duration<Rep, Period> &duration) {
  3994. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  3995. set_connection_timeout(sec, usec);
  3996. });
  3997. }
  3998. namespace impl {
  3999. bool is_valid_utf8(const std::string &s);
  4000. // Three states, because a failure that consumed bytes and one that consumed
  4001. // none are not the same thing: the first has left the stream in the middle of
  4002. // a frame and the connection cannot be reused, the second can just be retried.
  4003. enum class FrameRead { Ok, Fail, Timeout };
  4004. FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  4005. std::string &payload, bool &fin,
  4006. bool expect_masked, size_t max_len);
  4007. } // namespace impl
  4008. } // namespace ws
  4009. // ----------------------------------------------------------------------------
  4010. /*
  4011. * Implementation that will be part of the .cc file if split into .h + .cc.
  4012. */
  4013. namespace stream {
  4014. // stream::Result implementations
  4015. inline Result::Result() : chunk_size_(8192) {}
  4016. inline Result::Result(ClientImpl::StreamHandle &&handle, size_t chunk_size)
  4017. : handle_(std::move(handle)), chunk_size_(chunk_size) {}
  4018. inline Result::Result(Result &&other) noexcept
  4019. : handle_(std::move(other.handle_)), buffer_(std::move(other.buffer_)),
  4020. current_size_(other.current_size_), chunk_size_(other.chunk_size_),
  4021. finished_(other.finished_) {
  4022. other.current_size_ = 0;
  4023. other.finished_ = true;
  4024. }
  4025. inline Result &Result::operator=(Result &&other) noexcept {
  4026. if (this != &other) {
  4027. handle_ = std::move(other.handle_);
  4028. buffer_ = std::move(other.buffer_);
  4029. current_size_ = other.current_size_;
  4030. chunk_size_ = other.chunk_size_;
  4031. finished_ = other.finished_;
  4032. other.current_size_ = 0;
  4033. other.finished_ = true;
  4034. }
  4035. return *this;
  4036. }
  4037. inline bool Result::is_valid() const { return handle_.is_valid(); }
  4038. inline Result::operator bool() const { return is_valid(); }
  4039. inline int Result::status() const {
  4040. return handle_.response ? handle_.response->status : -1;
  4041. }
  4042. inline const Headers &Result::headers() const {
  4043. static const Headers empty_headers;
  4044. return handle_.response ? handle_.response->headers : empty_headers;
  4045. }
  4046. inline std::string Result::get_header_value(const std::string &key,
  4047. const char *def) const {
  4048. return handle_.response ? handle_.response->get_header_value(key, def) : def;
  4049. }
  4050. inline bool Result::has_header(const std::string &key) const {
  4051. return handle_.response ? handle_.response->has_header(key) : false;
  4052. }
  4053. inline Error Result::error() const { return handle_.error; }
  4054. inline Error Result::read_error() const { return handle_.get_read_error(); }
  4055. inline bool Result::has_read_error() const { return handle_.has_read_error(); }
  4056. inline bool Result::next() {
  4057. if (!handle_.is_valid() || finished_) { return false; }
  4058. if (buffer_.size() < chunk_size_) { buffer_.resize(chunk_size_); }
  4059. ssize_t n = handle_.read(&buffer_[0], chunk_size_);
  4060. if (n > 0) {
  4061. current_size_ = static_cast<size_t>(n);
  4062. return true;
  4063. }
  4064. current_size_ = 0;
  4065. finished_ = true;
  4066. return false;
  4067. }
  4068. inline const char *Result::data() const { return buffer_.data(); }
  4069. inline size_t Result::size() const { return current_size_; }
  4070. inline std::string Result::read_all() {
  4071. std::string result;
  4072. while (next()) {
  4073. result.append(data(), size());
  4074. }
  4075. return result;
  4076. }
  4077. } // namespace stream
  4078. namespace sse {
  4079. // SSEMessage implementations
  4080. inline SSEMessage::SSEMessage() : event("message") {}
  4081. inline void SSEMessage::clear() {
  4082. event = "message";
  4083. data.clear();
  4084. id.clear();
  4085. }
  4086. // SSEClient implementations
  4087. inline SSEClient::SSEClient(Client &client, const std::string &path)
  4088. : client_(client), path_(path) {}
  4089. inline SSEClient::SSEClient(Client &client, const std::string &path,
  4090. const Headers &headers)
  4091. : client_(client), path_(path), headers_(headers) {}
  4092. inline SSEClient::~SSEClient() { stop(); }
  4093. inline SSEClient &SSEClient::on_message(MessageHandler handler) {
  4094. on_message_ = std::move(handler);
  4095. return *this;
  4096. }
  4097. inline SSEClient &SSEClient::on_event(const std::string &type,
  4098. MessageHandler handler) {
  4099. event_handlers_[type] = std::move(handler);
  4100. return *this;
  4101. }
  4102. inline SSEClient &SSEClient::on_open(OpenHandler handler) {
  4103. on_open_ = std::move(handler);
  4104. return *this;
  4105. }
  4106. inline SSEClient &SSEClient::on_error(ErrorHandler handler) {
  4107. on_error_ = std::move(handler);
  4108. return *this;
  4109. }
  4110. inline SSEClient &SSEClient::set_reconnect_interval(int ms) {
  4111. reconnect_interval_ms_ = ms;
  4112. return *this;
  4113. }
  4114. inline SSEClient &SSEClient::set_max_reconnect_attempts(int n) {
  4115. max_reconnect_attempts_ = n;
  4116. return *this;
  4117. }
  4118. inline SSEClient &SSEClient::set_headers(const Headers &headers) {
  4119. std::lock_guard<std::mutex> lock(headers_mutex_);
  4120. headers_ = headers;
  4121. return *this;
  4122. }
  4123. inline bool SSEClient::is_connected() const { return connected_.load(); }
  4124. inline const std::string &SSEClient::last_event_id() const {
  4125. return last_event_id_;
  4126. }
  4127. inline void SSEClient::start() {
  4128. running_.store(true);
  4129. run_event_loop();
  4130. }
  4131. inline void SSEClient::start_async() {
  4132. running_.store(true);
  4133. async_thread_ = std::thread([this]() { run_event_loop(); });
  4134. }
  4135. inline void SSEClient::stop() {
  4136. running_.store(false);
  4137. client_.stop(); // Cancel any pending operations
  4138. if (async_thread_.joinable()) { async_thread_.join(); }
  4139. }
  4140. inline bool SSEClient::parse_sse_line(const std::string &line, SSEMessage &msg,
  4141. int &retry_ms, bool &has_data,
  4142. bool &has_id) {
  4143. // Blank line signals end of event
  4144. if (line.empty()) { return true; }
  4145. // Lines starting with ':' are comments (ignored)
  4146. if (line[0] == ':') { return false; }
  4147. // Find the colon separator
  4148. auto colon_pos = line.find(':');
  4149. auto field = line.substr(0, colon_pos);
  4150. std::string value;
  4151. // Value starts after colon, skip optional single space
  4152. if (colon_pos != std::string::npos && colon_pos + 1 < line.size()) {
  4153. auto value_start = colon_pos + 1;
  4154. if (line[value_start] == ' ') { value_start++; }
  4155. value = line.substr(value_start);
  4156. }
  4157. // Handle known fields
  4158. if (field == "event") {
  4159. // An empty event type is dispatched as "message" per the SSE spec
  4160. msg.event = value.empty() ? std::string("message") : std::move(value);
  4161. } else if (field == "data") {
  4162. // Multiple data lines are concatenated with newlines
  4163. if (has_data) { msg.data += "\n"; }
  4164. msg.data += value;
  4165. has_data = true;
  4166. } else if (field == "id") {
  4167. // An id that cannot be sent back as Last-Event-ID is ignored. Empty id is
  4168. // valid (clears the last event ID)
  4169. if (detail::fields::is_field_value(value)) {
  4170. msg.id = value;
  4171. has_id = true;
  4172. }
  4173. } else if (field == "retry") {
  4174. // Parse retry interval in milliseconds
  4175. // Per the SSE spec, a value that is not all ASCII digits is ignored.
  4176. if (detail::is_numeric(value)) {
  4177. int v = 0;
  4178. auto res =
  4179. detail::from_chars(value.data(), value.data() + value.size(), v);
  4180. if (res.ec == std::errc{}) { retry_ms = v; }
  4181. }
  4182. }
  4183. // Unknown fields are ignored per SSE spec
  4184. return false;
  4185. }
  4186. inline void SSEClient::run_event_loop() {
  4187. auto reconnect_count = 0;
  4188. while (running_.load()) {
  4189. // Build headers, including Last-Event-ID if we have one
  4190. Headers request_headers;
  4191. {
  4192. std::lock_guard<std::mutex> lock(headers_mutex_);
  4193. request_headers = headers_;
  4194. }
  4195. if (!last_event_id_.empty()) {
  4196. request_headers.emplace("Last-Event-ID", last_event_id_);
  4197. }
  4198. // Open streaming connection. An event stream has no end, so each event is
  4199. // bounded instead of the whole body.
  4200. auto handle = client_.open_stream("GET", path_, {}, request_headers);
  4201. handle.body_reader_.payload_max_length = 0;
  4202. // stop() ends a read that is waiting for the next event
  4203. if (handle.stream_) {
  4204. handle.stream_->set_read_interrupt([this] { return !running_.load(); });
  4205. }
  4206. stream::Result result{std::move(handle)};
  4207. // Connection error handling
  4208. if (!result) {
  4209. connected_.store(false);
  4210. if (on_error_) { on_error_(result.error()); }
  4211. if (!should_reconnect(reconnect_count)) { break; }
  4212. wait_for_reconnect();
  4213. reconnect_count++;
  4214. continue;
  4215. }
  4216. if (result.status() != StatusCode::OK_200) {
  4217. connected_.store(false);
  4218. if (on_error_) { on_error_(Error::Connection); }
  4219. // For certain errors, don't reconnect.
  4220. // Note: 401 is intentionally absent so that handlers can refresh
  4221. // credentials via set_headers() and let the client reconnect.
  4222. if (result.status() == StatusCode::NoContent_204 ||
  4223. result.status() == StatusCode::NotFound_404 ||
  4224. result.status() == StatusCode::Forbidden_403) {
  4225. break;
  4226. }
  4227. if (!should_reconnect(reconnect_count)) { break; }
  4228. wait_for_reconnect();
  4229. reconnect_count++;
  4230. continue;
  4231. }
  4232. // Connection successful
  4233. connected_.store(true);
  4234. reconnect_count = 0;
  4235. if (on_open_) { on_open_(); }
  4236. // Event receiving loop
  4237. std::string buffer;
  4238. SSEMessage current_msg;
  4239. auto has_data = false;
  4240. auto has_id = false;
  4241. auto first_line = true;
  4242. auto after_cr = false;
  4243. auto event_too_long = false;
  4244. while (running_.load() && result.next()) {
  4245. // What is left in the buffer has no line ending
  4246. auto search_pos = buffer.size();
  4247. buffer.append(result.data(), result.size());
  4248. // Process complete lines in the buffer. A line ends with \r\n, \n or \r
  4249. // per the SSE spec
  4250. size_t line_start = 0;
  4251. size_t eol_pos;
  4252. while ((eol_pos = buffer.find_first_of("\r\n", search_pos)) !=
  4253. std::string::npos) {
  4254. auto line = buffer.substr(line_start, eol_pos - line_start);
  4255. line_start = eol_pos + 1;
  4256. search_pos = line_start;
  4257. // The \n of a \r\n may arrive in a later chunk than its \r
  4258. auto is_lf_of_crlf =
  4259. after_cr && line.empty() && buffer[eol_pos] == '\n';
  4260. after_cr = buffer[eol_pos] == '\r';
  4261. if (is_lf_of_crlf) { continue; }
  4262. // A UTF-8 BOM at the start of the stream is ignored per the SSE spec
  4263. if (first_line) {
  4264. first_line = false;
  4265. if (line.compare(0, 3, "\xEF\xBB\xBF") == 0) { line.erase(0, 3); }
  4266. }
  4267. // Parse the line and check if event is complete
  4268. auto event_complete = parse_sse_line(
  4269. line, current_msg, reconnect_interval_ms_, has_data, has_id);
  4270. if (event_complete) {
  4271. // Update last_event_id for reconnection, even for an event that
  4272. // has no data. An empty id clears it.
  4273. if (has_id) { last_event_id_ = current_msg.id; }
  4274. // An event without a data field is not dispatched
  4275. if (has_data) { dispatch_event(current_msg); }
  4276. // Reset the message for the next event either way
  4277. current_msg.clear();
  4278. has_data = false;
  4279. has_id = false;
  4280. }
  4281. }
  4282. // Keep unprocessed data in buffer
  4283. buffer.erase(0, line_start);
  4284. // Neither an event nor a line still waiting for its end may grow
  4285. // without bound. 0 means no limit.
  4286. if (CPPHTTPLIB_SSE_MAX_EVENT_LENGTH > 0 &&
  4287. buffer.size() + current_msg.data.size() >
  4288. CPPHTTPLIB_SSE_MAX_EVENT_LENGTH) {
  4289. if (on_error_) { on_error_(Error::ExceedMaxPayloadSize); }
  4290. event_too_long = true;
  4291. break;
  4292. }
  4293. }
  4294. // Connection ended
  4295. connected_.store(false);
  4296. // Reconnecting would only get the same event again
  4297. if (!running_.load() || event_too_long) { break; }
  4298. // Check for read errors
  4299. if (result.has_read_error()) {
  4300. if (on_error_) { on_error_(result.read_error()); }
  4301. }
  4302. if (!should_reconnect(reconnect_count)) { break; }
  4303. wait_for_reconnect();
  4304. reconnect_count++;
  4305. }
  4306. connected_.store(false);
  4307. }
  4308. inline void SSEClient::dispatch_event(const SSEMessage &msg) {
  4309. // Check for specific event type handler first
  4310. auto it = event_handlers_.find(msg.event);
  4311. if (it != event_handlers_.end()) {
  4312. it->second(msg);
  4313. return;
  4314. }
  4315. // Fall back to generic message handler
  4316. if (on_message_) { on_message_(msg); }
  4317. }
  4318. inline bool SSEClient::should_reconnect(int count) const {
  4319. if (!running_.load()) { return false; }
  4320. if (max_reconnect_attempts_ == 0) { return true; } // unlimited
  4321. return count < max_reconnect_attempts_;
  4322. }
  4323. inline void SSEClient::wait_for_reconnect() {
  4324. // Use small increments to check running_ flag frequently.
  4325. // Always wait at least one increment, so that a zero interval (e.g.
  4326. // "retry: 0" from the server) cannot cause a busy reconnect loop.
  4327. const auto step_ms = 100;
  4328. auto interval_ms = (std::max)(reconnect_interval_ms_, step_ms);
  4329. auto waited = 0;
  4330. while (running_.load() && waited < interval_ms) {
  4331. std::this_thread::sleep_for(std::chrono::milliseconds(step_ms));
  4332. waited += step_ms;
  4333. }
  4334. }
  4335. } // namespace sse
  4336. #ifdef CPPHTTPLIB_SSL_ENABLED
  4337. /*
  4338. * TLS abstraction layer - internal function declarations
  4339. * These are implementation details and not part of the public API.
  4340. */
  4341. namespace tls {
  4342. // Client context
  4343. ctx_t create_client_context();
  4344. void free_context(ctx_t ctx);
  4345. bool set_min_version(ctx_t ctx, Version version);
  4346. bool load_ca_pem(ctx_t ctx, const char *pem, size_t len);
  4347. bool load_ca_file(ctx_t ctx, const char *file_path);
  4348. bool load_ca_dir(ctx_t ctx, const char *dir_path);
  4349. bool load_system_certs(ctx_t ctx);
  4350. bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4351. const char *password);
  4352. bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  4353. const char *key_path, const char *password);
  4354. // Server context
  4355. ctx_t create_server_context();
  4356. bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4357. const char *password);
  4358. bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  4359. const char *key_path, const char *password);
  4360. bool set_client_ca_file(ctx_t ctx, const char *ca_file, const char *ca_dir);
  4361. void set_verify_client(ctx_t ctx, bool require);
  4362. // Session management
  4363. session_t create_session(ctx_t ctx, socket_t sock);
  4364. void free_session(session_t session);
  4365. bool set_sni(session_t session, const char *hostname, bool verify_hostname);
  4366. // Handshake (non-blocking capable)
  4367. TlsError connect(session_t session);
  4368. TlsError accept(session_t session);
  4369. // Handshake with timeout (blocking until timeout)
  4370. bool connect_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4371. time_t timeout_usec, TlsError *err);
  4372. bool accept_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4373. time_t timeout_usec, TlsError *err);
  4374. // I/O (non-blocking capable)
  4375. ssize_t read(session_t session, void *buf, size_t len, TlsError &err);
  4376. ssize_t write(session_t session, const void *buf, size_t len, TlsError &err);
  4377. int pending(const_session_t session);
  4378. void shutdown(session_t session, bool graceful);
  4379. // Connection state
  4380. bool is_peer_closed(session_t session, socket_t sock);
  4381. // Certificate verification
  4382. cert_t get_peer_cert(const_session_t session);
  4383. // The certificates the peer sent, leaf first. Free each with free_cert(), and
  4384. // do not use them after free_session(), as with get_peer_cert().
  4385. size_t get_peer_certs(const_session_t session, std::vector<cert_t> &certs);
  4386. void free_cert(cert_t cert);
  4387. bool verify_hostname(cert_t cert, const char *hostname);
  4388. uint64_t hostname_mismatch_code();
  4389. long get_verify_result(const_session_t session);
  4390. // Certificate introspection
  4391. std::string get_cert_subject_cn(cert_t cert);
  4392. std::string get_cert_issuer_name(cert_t cert);
  4393. bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans);
  4394. bool get_cert_validity(cert_t cert, time_t &not_before, time_t &not_after);
  4395. std::string get_cert_serial(cert_t cert);
  4396. bool get_cert_der(cert_t cert, std::vector<unsigned char> &der);
  4397. const char *get_sni(const_session_t session);
  4398. // CA store management
  4399. ca_store_t create_ca_store(const char *pem, size_t len);
  4400. void free_ca_store(ca_store_t store);
  4401. bool set_ca_store(ctx_t ctx, ca_store_t store);
  4402. // Free each with free_cert(), and do not use them once the context's CA
  4403. // certificates change.
  4404. size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs);
  4405. std::vector<std::string> get_ca_names(ctx_t ctx);
  4406. // Dynamic certificate update (for servers)
  4407. bool update_server_cert(ctx_t ctx, const char *cert_pem, const char *key_pem,
  4408. const char *password);
  4409. bool update_server_client_ca(ctx_t ctx, const char *ca_pem);
  4410. // Certificate verification callback
  4411. bool set_verify_callback(ctx_t ctx, VerifyCallback callback);
  4412. long get_verify_error(const_session_t session);
  4413. std::string verify_error_string(long error_code);
  4414. // TlsError information
  4415. uint64_t peek_error();
  4416. uint64_t get_error();
  4417. std::string error_string(uint64_t code);
  4418. } // namespace tls
  4419. #endif // CPPHTTPLIB_SSL_ENABLED
  4420. /*
  4421. * Group 1: detail namespace - Non-SSL utilities
  4422. */
  4423. namespace detail {
  4424. inline bool set_socket_opt_impl(socket_t sock, int level, int optname,
  4425. const void *optval, socklen_t optlen) {
  4426. return setsockopt(sock, level, optname,
  4427. #ifdef _WIN32
  4428. reinterpret_cast<const char *>(optval),
  4429. #else
  4430. optval,
  4431. #endif
  4432. optlen) == 0;
  4433. }
  4434. inline bool set_socket_opt_time(socket_t sock, int level, int optname,
  4435. time_t sec, time_t usec) {
  4436. #ifdef _WIN32
  4437. auto timeout = static_cast<uint32_t>(sec * 1000 + usec / 1000);
  4438. #else
  4439. timeval timeout;
  4440. timeout.tv_sec = static_cast<long>(sec);
  4441. timeout.tv_usec = static_cast<decltype(timeout.tv_usec)>(usec);
  4442. #endif
  4443. return set_socket_opt_impl(sock, level, optname, &timeout, sizeof(timeout));
  4444. }
  4445. inline bool is_hex(char c, int &v) {
  4446. if (is_ascii_digit(c)) {
  4447. v = c - '0';
  4448. return true;
  4449. } else if ('A' <= c && c <= 'F') {
  4450. v = c - 'A' + 10;
  4451. return true;
  4452. } else if ('a' <= c && c <= 'f') {
  4453. v = c - 'a' + 10;
  4454. return true;
  4455. }
  4456. return false;
  4457. }
  4458. inline bool from_hex_to_i(const std::string &s, size_t i, size_t cnt,
  4459. int &val) {
  4460. if (i >= s.size()) { return false; }
  4461. val = 0;
  4462. for (; cnt; i++, cnt--) {
  4463. if (!s[i]) { return false; }
  4464. auto v = 0;
  4465. if (is_hex(s[i], v)) {
  4466. val = val * 16 + v;
  4467. } else {
  4468. return false;
  4469. }
  4470. }
  4471. return true;
  4472. }
  4473. inline std::string from_i_to_hex(size_t n) {
  4474. static const auto charset = "0123456789abcdef";
  4475. std::string ret;
  4476. do {
  4477. ret = charset[n & 15] + ret;
  4478. n >>= 4;
  4479. } while (n > 0);
  4480. return ret;
  4481. }
  4482. // A round trip rather than `n <= SIZE_MAX`, which is always true on 64-bit
  4483. // builds and trips -Wtautological-type-limit-compare.
  4484. inline bool fits_in_size_t(uint64_t n) {
  4485. return static_cast<uint64_t>(static_cast<size_t>(n)) == n;
  4486. }
  4487. inline std::string compute_etag(const FileStat &fs,
  4488. const std::string &suffix = std::string()) {
  4489. if (!fs.is_file()) { return std::string(); }
  4490. // If mtime cannot be determined (negative value indicates an error
  4491. // or sentinel), do not generate an ETag. Returning a neutral / fixed
  4492. // value like 0 could collide with a real file that legitimately has
  4493. // mtime == 0 (epoch) and lead to misleading validators.
  4494. auto mtime_raw = fs.mtime();
  4495. if (mtime_raw < 0) { return std::string(); }
  4496. auto mtime = static_cast<size_t>(mtime_raw);
  4497. auto size = fs.size();
  4498. return std::string("W/\"") + from_i_to_hex(mtime) + "-" +
  4499. from_i_to_hex(size) + suffix + "\"";
  4500. }
  4501. // Format time_t as HTTP-date (RFC 9110 Section 5.6.7): "Sun, 06 Nov 1994
  4502. // 08:49:37 GMT" This implementation is defensive: it validates `mtime`, checks
  4503. // return values from `gmtime_r`/`gmtime_s`, and ensures `strftime` succeeds.
  4504. inline std::string file_mtime_to_http_date(time_t mtime) {
  4505. if (mtime < 0) { return std::string(); }
  4506. struct tm tm_buf;
  4507. #ifdef _WIN32
  4508. if (gmtime_s(&tm_buf, &mtime) != 0) { return std::string(); }
  4509. #else
  4510. if (gmtime_r(&mtime, &tm_buf) == nullptr) { return std::string(); }
  4511. #endif
  4512. char buf[64];
  4513. if (strftime(buf, sizeof(buf), "%a, %d %b %Y %H:%M:%S GMT", &tm_buf) == 0) {
  4514. return std::string();
  4515. }
  4516. return std::string(buf);
  4517. }
  4518. // Parse HTTP-date (RFC 9110 Section 5.6.7) to time_t. Returns -1 on failure.
  4519. inline time_t parse_http_date(const std::string &date_str) {
  4520. struct tm tm_buf;
  4521. // Create a classic locale object once for all parsing attempts
  4522. const std::locale classic_locale = std::locale::classic();
  4523. // Try to parse using std::get_time (C++11, cross-platform)
  4524. auto try_parse = [&](const char *fmt) -> bool {
  4525. std::istringstream ss(date_str);
  4526. ss.imbue(classic_locale);
  4527. memset(&tm_buf, 0, sizeof(tm_buf));
  4528. ss >> std::get_time(&tm_buf, fmt);
  4529. return !ss.fail();
  4530. };
  4531. // RFC 9110 preferred format (HTTP-date): "Sun, 06 Nov 1994 08:49:37 GMT"
  4532. if (!try_parse("%a, %d %b %Y %H:%M:%S")) {
  4533. // RFC 850 format: "Sunday, 06-Nov-94 08:49:37 GMT"
  4534. if (!try_parse("%A, %d-%b-%y %H:%M:%S")) {
  4535. // asctime format: "Sun Nov 6 08:49:37 1994"
  4536. if (!try_parse("%a %b %d %H:%M:%S %Y")) {
  4537. return static_cast<time_t>(-1);
  4538. }
  4539. }
  4540. }
  4541. #ifdef _WIN32
  4542. return _mkgmtime(&tm_buf);
  4543. #elif defined _AIX
  4544. return mktime(&tm_buf);
  4545. #else
  4546. return timegm(&tm_buf);
  4547. #endif
  4548. }
  4549. inline bool is_weak_etag(const std::string &s) {
  4550. // Check if the string is a weak ETag (starts with 'W/"')
  4551. return s.size() > 3 && s[0] == 'W' && s[1] == '/' && s[2] == '"';
  4552. }
  4553. inline bool is_strong_etag(const std::string &s) {
  4554. // Check if the string is a strong ETag (starts and ends with '"', at least 2
  4555. // chars)
  4556. return s.size() >= 2 && s[0] == '"' && s.back() == '"';
  4557. }
  4558. inline size_t to_utf8(int code, char *buff) {
  4559. if (code < 0x0080) {
  4560. buff[0] = static_cast<char>(code & 0x7F);
  4561. return 1;
  4562. } else if (code < 0x0800) {
  4563. buff[0] = static_cast<char>(0xC0 | ((code >> 6) & 0x1F));
  4564. buff[1] = static_cast<char>(0x80 | (code & 0x3F));
  4565. return 2;
  4566. } else if (code < 0xD800) {
  4567. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4568. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4569. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4570. return 3;
  4571. } else if (code < 0xE000) { // D800 - DFFF is invalid...
  4572. return 0;
  4573. } else if (code < 0x10000) {
  4574. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4575. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4576. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4577. return 3;
  4578. } else if (code < 0x110000) {
  4579. buff[0] = static_cast<char>(0xF0 | ((code >> 18) & 0x7));
  4580. buff[1] = static_cast<char>(0x80 | ((code >> 12) & 0x3F));
  4581. buff[2] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4582. buff[3] = static_cast<char>(0x80 | (code & 0x3F));
  4583. return 4;
  4584. }
  4585. // NOTREACHED
  4586. return 0;
  4587. }
  4588. } // namespace detail
  4589. namespace ws {
  4590. namespace impl {
  4591. inline bool is_valid_utf8(const std::string &s) {
  4592. size_t i = 0;
  4593. auto n = s.size();
  4594. while (i < n) {
  4595. auto c = static_cast<unsigned char>(s[i]);
  4596. size_t len;
  4597. uint32_t cp;
  4598. if (c < 0x80) {
  4599. i++;
  4600. continue;
  4601. } else if ((c & 0xE0) == 0xC0) {
  4602. len = 2;
  4603. cp = c & 0x1F;
  4604. } else if ((c & 0xF0) == 0xE0) {
  4605. len = 3;
  4606. cp = c & 0x0F;
  4607. } else if ((c & 0xF8) == 0xF0) {
  4608. len = 4;
  4609. cp = c & 0x07;
  4610. } else {
  4611. return false;
  4612. }
  4613. if (i + len > n) { return false; }
  4614. for (size_t j = 1; j < len; j++) {
  4615. auto b = static_cast<unsigned char>(s[i + j]);
  4616. if ((b & 0xC0) != 0x80) { return false; }
  4617. cp = (cp << 6) | (b & 0x3F);
  4618. }
  4619. // Overlong encoding check
  4620. if (len == 2 && cp < 0x80) { return false; }
  4621. if (len == 3 && cp < 0x800) { return false; }
  4622. if (len == 4 && cp < 0x10000) { return false; }
  4623. // Surrogate halves (U+D800..U+DFFF) and beyond U+10FFFF are invalid
  4624. if (cp >= 0xD800 && cp <= 0xDFFF) { return false; }
  4625. if (cp > 0x10FFFF) { return false; }
  4626. i += len;
  4627. }
  4628. return true;
  4629. }
  4630. } // namespace impl
  4631. } // namespace ws
  4632. namespace detail {
  4633. // NOTE: This code came up with the following stackoverflow post:
  4634. // https://stackoverflow.com/questions/180947/base64-decode-snippet-in-c
  4635. inline std::string base64_encode(const std::string &in) {
  4636. static const auto lookup =
  4637. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4638. std::string out;
  4639. out.reserve(in.size());
  4640. // Unsigned: the accumulator is never masked, so with a signed int the
  4641. // `val << 8` below overflows once enough bytes are folded in (undefined
  4642. // behaviour before C++20). Only the low bits are ever emitted, so the
  4643. // wrap-around of an unsigned accumulator does not affect the output.
  4644. uint32_t val = 0;
  4645. auto valb = -6;
  4646. for (auto c : in) {
  4647. val = (val << 8) + static_cast<uint8_t>(c);
  4648. valb += 8;
  4649. while (valb >= 0) {
  4650. out.push_back(lookup[(val >> valb) & 0x3F]);
  4651. valb -= 6;
  4652. }
  4653. }
  4654. if (valb > -6) { out.push_back(lookup[((val << 8) >> (valb + 8)) & 0x3F]); }
  4655. while (out.size() % 4) {
  4656. out.push_back('=');
  4657. }
  4658. return out;
  4659. }
  4660. inline std::string sha1(const std::string &input) {
  4661. // RFC 3174 SHA-1 implementation
  4662. auto left_rotate = [](uint32_t x, uint32_t n) -> uint32_t {
  4663. return (x << n) | (x >> (32 - n));
  4664. };
  4665. uint32_t h0 = 0x67452301;
  4666. uint32_t h1 = 0xEFCDAB89;
  4667. uint32_t h2 = 0x98BADCFE;
  4668. uint32_t h3 = 0x10325476;
  4669. uint32_t h4 = 0xC3D2E1F0;
  4670. // Pre-processing: adding padding bits
  4671. std::string msg = input;
  4672. uint64_t original_bit_len = static_cast<uint64_t>(msg.size()) * 8;
  4673. msg.push_back(static_cast<char>(0x80u));
  4674. while (msg.size() % 64 != 56) {
  4675. msg.push_back(0);
  4676. }
  4677. // Append original length in bits as 64-bit big-endian
  4678. for (int i = 56; i >= 0; i -= 8) {
  4679. msg.push_back(static_cast<char>((original_bit_len >> i) & 0xFF));
  4680. }
  4681. // Process each 512-bit chunk
  4682. for (size_t offset = 0; offset < msg.size(); offset += 64) {
  4683. uint32_t w[80];
  4684. for (size_t i = 0; i < 16; i++) {
  4685. w[i] =
  4686. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4]))
  4687. << 24) |
  4688. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 1]))
  4689. << 16) |
  4690. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 2]))
  4691. << 8) |
  4692. (static_cast<uint32_t>(
  4693. static_cast<uint8_t>(msg[offset + i * 4 + 3])));
  4694. }
  4695. for (int i = 16; i < 80; i++) {
  4696. w[i] = left_rotate(w[i - 3] ^ w[i - 8] ^ w[i - 14] ^ w[i - 16], 1);
  4697. }
  4698. uint32_t a = h0, b = h1, c = h2, d = h3, e = h4;
  4699. for (int i = 0; i < 80; i++) {
  4700. uint32_t f, k;
  4701. if (i < 20) {
  4702. f = (b & c) | ((~b) & d);
  4703. k = 0x5A827999;
  4704. } else if (i < 40) {
  4705. f = b ^ c ^ d;
  4706. k = 0x6ED9EBA1;
  4707. } else if (i < 60) {
  4708. f = (b & c) | (b & d) | (c & d);
  4709. k = 0x8F1BBCDC;
  4710. } else {
  4711. f = b ^ c ^ d;
  4712. k = 0xCA62C1D6;
  4713. }
  4714. uint32_t temp = left_rotate(a, 5) + f + e + k + w[i];
  4715. e = d;
  4716. d = c;
  4717. c = left_rotate(b, 30);
  4718. b = a;
  4719. a = temp;
  4720. }
  4721. h0 += a;
  4722. h1 += b;
  4723. h2 += c;
  4724. h3 += d;
  4725. h4 += e;
  4726. }
  4727. // Produce the final hash as a 20-byte binary string
  4728. std::string hash(20, '\0');
  4729. for (size_t i = 0; i < 4; i++) {
  4730. hash[i] = static_cast<char>((h0 >> (24 - i * 8)) & 0xFF);
  4731. hash[4 + i] = static_cast<char>((h1 >> (24 - i * 8)) & 0xFF);
  4732. hash[8 + i] = static_cast<char>((h2 >> (24 - i * 8)) & 0xFF);
  4733. hash[12 + i] = static_cast<char>((h3 >> (24 - i * 8)) & 0xFF);
  4734. hash[16 + i] = static_cast<char>((h4 >> (24 - i * 8)) & 0xFF);
  4735. }
  4736. return hash;
  4737. }
  4738. inline std::string websocket_accept_key(const std::string &client_key) {
  4739. const std::string magic = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
  4740. return base64_encode(sha1(client_key + magic));
  4741. }
  4742. inline bool is_websocket_upgrade(const Request &req) {
  4743. if (req.method != "GET") { return false; }
  4744. // Check Upgrade: websocket. RFC 9110 7.8 defines Upgrade as a comma-separated
  4745. // list of protocols and asks recipients to match each name
  4746. // case-insensitively, so look for the token rather than compare the whole
  4747. // field value.
  4748. if (!has_header_token(req.headers, "Upgrade", "websocket")) { return false; }
  4749. // Check Connection: Upgrade
  4750. if (!has_header_token(req.headers, "Connection", "upgrade")) { return false; }
  4751. // Check Sec-WebSocket-Key is a valid base64-encoded 16-byte value (24 chars)
  4752. // RFC 6455 Section 4.2.1
  4753. auto ws_key = req.get_header_value("Sec-WebSocket-Key");
  4754. if (ws_key.size() != 24 || ws_key[22] != '=' || ws_key[23] != '=') {
  4755. return false;
  4756. }
  4757. static const std::string b64chars =
  4758. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4759. for (size_t i = 0; i < 22; i++) {
  4760. if (b64chars.find(ws_key[i]) == std::string::npos) { return false; }
  4761. }
  4762. // Check Sec-WebSocket-Version: 13
  4763. auto version = req.get_header_value("Sec-WebSocket-Version");
  4764. if (version != "13") { return false; }
  4765. return true;
  4766. }
  4767. // Unpredictable bytes for masking keys (RFC 6455 Section 5.3) and nonces
  4768. inline void fill_random_bytes(unsigned char *out, size_t n) {
  4769. thread_local std::random_device rd;
  4770. size_t filled = 0;
  4771. while (filled < n) {
  4772. auto v = rd();
  4773. for (size_t b = 0; b < sizeof(v) && filled < n; ++b, ++filled) {
  4774. out[filled] = static_cast<unsigned char>((v >> (b * 8)) & 0xFFu);
  4775. }
  4776. }
  4777. }
  4778. inline bool write_websocket_frame(Stream &strm, ws::Opcode opcode,
  4779. const char *data, size_t len, bool fin,
  4780. bool mask) {
  4781. // First byte: FIN + opcode
  4782. uint8_t header[2];
  4783. header[0] = static_cast<uint8_t>((fin ? 0x80 : 0x00) |
  4784. (static_cast<uint8_t>(opcode) & 0x0F));
  4785. // Second byte: MASK + payload length
  4786. if (len < 126) {
  4787. header[1] = static_cast<uint8_t>(len);
  4788. if (mask) { header[1] |= 0x80; }
  4789. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4790. } else if (len <= 0xFFFF) {
  4791. header[1] = 126;
  4792. if (mask) { header[1] |= 0x80; }
  4793. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4794. uint8_t ext[2];
  4795. ext[0] = static_cast<uint8_t>((len >> 8) & 0xFF);
  4796. ext[1] = static_cast<uint8_t>(len & 0xFF);
  4797. if (strm.write(reinterpret_cast<char *>(ext), 2) < 0) { return false; }
  4798. } else {
  4799. header[1] = 127;
  4800. if (mask) { header[1] |= 0x80; }
  4801. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4802. uint8_t ext[8];
  4803. for (int i = 7; i >= 0; i--) {
  4804. ext[7 - i] =
  4805. static_cast<uint8_t>((static_cast<uint64_t>(len) >> (i * 8)) & 0xFF);
  4806. }
  4807. if (strm.write(reinterpret_cast<char *>(ext), 8) < 0) { return false; }
  4808. }
  4809. if (mask) {
  4810. // Generate random mask key
  4811. uint8_t mask_key[4];
  4812. fill_random_bytes(mask_key, sizeof(mask_key));
  4813. if (strm.write(reinterpret_cast<char *>(mask_key), 4) < 0) { return false; }
  4814. // Write masked payload in chunks
  4815. const size_t chunk_size = 4096;
  4816. std::vector<char> buf((std::min)(len, chunk_size));
  4817. for (size_t offset = 0; offset < len; offset += chunk_size) {
  4818. size_t n = (std::min)(chunk_size, len - offset);
  4819. for (size_t i = 0; i < n; i++) {
  4820. buf[i] =
  4821. data[offset + i] ^ static_cast<char>(mask_key[(offset + i) % 4]);
  4822. }
  4823. if (strm.write(buf.data(), n) < 0) { return false; }
  4824. }
  4825. } else {
  4826. if (len > 0) {
  4827. if (strm.write(data, len) < 0) { return false; }
  4828. }
  4829. }
  4830. return true;
  4831. }
  4832. } // namespace detail
  4833. namespace ws {
  4834. namespace impl {
  4835. // Read exactly `size` bytes. Stream::read may return less than asked for -- it
  4836. // hands back whatever its buffer already holds -- so every multi-byte field has
  4837. // to loop. Reading a 2-byte header with a single read() fails whenever the
  4838. // header straddles the read buffer's boundary.
  4839. //
  4840. // Timeout is reported only when nothing at all was consumed. Once a byte has
  4841. // been taken the stream sits mid-field and cannot be resumed, so a timeout
  4842. // there is a failure like any other. (When read() fails it always records why,
  4843. // so the error belongs to this call and not to an earlier one.)
  4844. inline FrameRead read_exact(Stream &strm, void *buf, size_t size) {
  4845. auto p = static_cast<char *>(buf);
  4846. size_t total = 0;
  4847. while (total < size) {
  4848. auto n = strm.read(p + total, size - total);
  4849. if (n <= 0) {
  4850. auto timed_out = total == 0 && strm.get_error() == Error::Timeout;
  4851. return timed_out ? FrameRead::Timeout : FrameRead::Fail;
  4852. }
  4853. total += static_cast<size_t>(n);
  4854. }
  4855. return FrameRead::Ok;
  4856. }
  4857. inline FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  4858. std::string &payload, bool &fin,
  4859. bool expect_masked, size_t max_len) {
  4860. // Read first 2 bytes. This is the only read that may report a timeout: it
  4861. // sits on a frame boundary, where nothing has been consumed yet.
  4862. uint8_t header[2];
  4863. FrameRead first = read_exact(strm, header, 2);
  4864. if (first != FrameRead::Ok) { return first; }
  4865. fin = (header[0] & 0x80) != 0;
  4866. // RSV1, RSV2, RSV3 must be 0 when no extension is negotiated
  4867. if (header[0] & 0x70) { return FrameRead::Fail; }
  4868. opcode = static_cast<Opcode>(header[0] & 0x0F);
  4869. bool masked = (header[1] & 0x80) != 0;
  4870. uint64_t payload_len = header[1] & 0x7F;
  4871. // RFC 6455 Section 5.5: control frames MUST NOT be fragmented and
  4872. // MUST have a payload length of 125 bytes or less
  4873. bool is_control = (static_cast<uint8_t>(opcode) & 0x08) != 0;
  4874. if (is_control) {
  4875. if (!fin) { return FrameRead::Fail; }
  4876. if (payload_len > 125) { return FrameRead::Fail; }
  4877. }
  4878. if (masked != expect_masked) { return FrameRead::Fail; }
  4879. // Extended payload length
  4880. if (payload_len == 126) {
  4881. uint8_t ext[2];
  4882. if (read_exact(strm, ext, 2) != FrameRead::Ok) { return FrameRead::Fail; }
  4883. payload_len = (static_cast<uint64_t>(ext[0]) << 8) | ext[1];
  4884. } else if (payload_len == 127) {
  4885. uint8_t ext[8];
  4886. if (read_exact(strm, ext, 8) != FrameRead::Ok) { return FrameRead::Fail; }
  4887. // RFC 6455 Section 5.2: the most significant bit MUST be 0
  4888. if (ext[0] & 0x80) { return FrameRead::Fail; }
  4889. payload_len = 0;
  4890. for (int i = 0; i < 8; i++) {
  4891. payload_len = (payload_len << 8) | ext[i];
  4892. }
  4893. }
  4894. // A max_len of 0 means no limit, as payload_max_length does, and a length
  4895. // size_t cannot hold (32-bit builds) is refused either way.
  4896. if ((max_len > 0 && payload_len > max_len) ||
  4897. !detail::fits_in_size_t(payload_len)) {
  4898. return FrameRead::Fail;
  4899. }
  4900. // Read mask key if present
  4901. uint8_t mask_key[4] = {0};
  4902. if (masked) {
  4903. if (read_exact(strm, mask_key, 4) != FrameRead::Ok) {
  4904. return FrameRead::Fail;
  4905. }
  4906. }
  4907. // Grow the payload only as it arrives, since a header alone can announce
  4908. // max_len bytes that never come.
  4909. payload.clear();
  4910. auto len = static_cast<size_t>(payload_len);
  4911. while (payload.size() < len) {
  4912. auto offset = payload.size();
  4913. auto n = (std::min)(len - offset, CPPHTTPLIB_RECV_BUFSIZ);
  4914. payload.resize(offset + n);
  4915. if (read_exact(strm, &payload[offset], n) != FrameRead::Ok) {
  4916. return FrameRead::Fail;
  4917. }
  4918. }
  4919. // Unmask if needed
  4920. if (masked) {
  4921. for (size_t i = 0; i < payload.size(); i++) {
  4922. payload[i] ^= static_cast<char>(mask_key[i % 4]);
  4923. }
  4924. }
  4925. return FrameRead::Ok;
  4926. }
  4927. // RFC 6455 §5.5.1, §7.4: a Close payload is empty, or a status code that may
  4928. // be sent followed by a UTF-8 reason.
  4929. inline bool is_valid_close_payload(const std::string &payload) {
  4930. if (payload.empty()) { return true; }
  4931. if (payload.size() < 2) { return false; }
  4932. auto code = (static_cast<uint8_t>(payload[0]) << 8) |
  4933. static_cast<uint8_t>(payload[1]);
  4934. auto may_be_sent = (1000 <= code && code <= 1003) ||
  4935. (1007 <= code && code <= 1014) ||
  4936. (3000 <= code && code <= 4999);
  4937. return may_be_sent && is_valid_utf8(payload.substr(2));
  4938. }
  4939. } // namespace impl
  4940. } // namespace ws
  4941. namespace detail {
  4942. // A path a mount point serves: absolute, with no ".", ".." or empty segment
  4943. // except a trailing '/', so the file served is the one that req.path names to
  4944. // the handlers that ran before it.
  4945. inline bool is_valid_path(const std::string &path) {
  4946. if (path.empty() || path[0] != '/') { return false; }
  4947. auto beg = size_t{1};
  4948. for (auto i = beg; i <= path.size(); i++) {
  4949. if (i < path.size() && path[i] != '/') {
  4950. if (path[i] == '\0' || path[i] == '\\') { return false; }
  4951. continue;
  4952. }
  4953. auto len = i - beg;
  4954. if ((len == 0 && i < path.size()) || (len == 1 && path[beg] == '.') ||
  4955. (len == 2 && path[beg] == '.' && path[beg + 1] == '.')) {
  4956. return false;
  4957. }
  4958. beg = i + 1;
  4959. }
  4960. return true;
  4961. }
  4962. inline bool canonicalize_path(const char *path, std::string &resolved) {
  4963. #if defined(_WIN32)
  4964. char buf[_MAX_PATH];
  4965. if (_fullpath(buf, path, _MAX_PATH) == nullptr) { return false; }
  4966. resolved = buf;
  4967. #elif defined(PATH_MAX)
  4968. char buf[PATH_MAX];
  4969. if (realpath(path, buf) == nullptr) { return false; }
  4970. resolved = buf;
  4971. #else
  4972. auto buf = realpath(path, nullptr);
  4973. auto guard = scope_exit([&]() { std::free(buf); });
  4974. if (buf == nullptr) { return false; }
  4975. resolved = buf;
  4976. #endif
  4977. return true;
  4978. }
  4979. inline bool is_path_within_base(const std::string &resolved_path,
  4980. const std::string &resolved_base) {
  4981. #if defined(_WIN32)
  4982. return _strnicmp(resolved_path.c_str(), resolved_base.c_str(),
  4983. resolved_base.size()) == 0;
  4984. #else
  4985. return strncmp(resolved_path.c_str(), resolved_base.c_str(),
  4986. resolved_base.size()) == 0;
  4987. #endif
  4988. }
  4989. inline FileStat::FileStat(const std::string &path) {
  4990. #if defined(_WIN32)
  4991. auto wpath = u8string_to_wstring(path.c_str());
  4992. ret_ = _wstat(wpath.c_str(), &st_);
  4993. #else
  4994. ret_ = stat(path.c_str(), &st_);
  4995. #endif
  4996. }
  4997. inline bool FileStat::is_file() const {
  4998. return ret_ >= 0 && S_ISREG(st_.st_mode);
  4999. }
  5000. inline bool FileStat::is_dir() const {
  5001. return ret_ >= 0 && S_ISDIR(st_.st_mode);
  5002. }
  5003. inline time_t FileStat::mtime() const {
  5004. return ret_ >= 0 ? static_cast<time_t>(st_.st_mtime)
  5005. : static_cast<time_t>(-1);
  5006. }
  5007. inline size_t FileStat::size() const {
  5008. return ret_ >= 0 ? static_cast<size_t>(st_.st_size) : 0;
  5009. }
  5010. inline std::string encode_path(const std::string &s) {
  5011. std::string result;
  5012. result.reserve(s.size());
  5013. for (size_t i = 0; s[i]; i++) {
  5014. switch (s[i]) {
  5015. case ' ': result += "%20"; break;
  5016. case '+': result += "%2B"; break;
  5017. case '\'': result += "%27"; break;
  5018. case ',': result += "%2C"; break;
  5019. // case ':': result += "%3A"; break; // ok? probably...
  5020. case ';': result += "%3B"; break;
  5021. default:
  5022. auto c = static_cast<uint8_t>(s[i]);
  5023. // Control characters (incl. CR/LF) and non-ASCII bytes are not allowed
  5024. // in a request-target as-is.
  5025. if (c < 0x20 || c == 0x7f || c >= 0x80) {
  5026. result += '%';
  5027. char hex[4];
  5028. auto len = snprintf(hex, sizeof(hex) - 1, "%02X", c);
  5029. assert(len == 2);
  5030. result.append(hex, static_cast<size_t>(len));
  5031. } else {
  5032. result += s[i];
  5033. }
  5034. break;
  5035. }
  5036. }
  5037. return result;
  5038. }
  5039. inline std::string file_extension(const std::string &path) {
  5040. auto i = path.size();
  5041. while (i > 0 && is_ascii_alnum(path[i - 1])) {
  5042. i--;
  5043. }
  5044. if (i == path.size() || i == 0 || path[i - 1] != '.') {
  5045. return std::string();
  5046. }
  5047. return path.substr(i);
  5048. }
  5049. inline bool is_space_or_tab(char c) { return c == ' ' || c == '\t'; }
  5050. template <typename T>
  5051. inline bool parse_header(const char *beg, const char *end, T fn);
  5052. template <typename T>
  5053. inline bool parse_header(const char *beg, const char *end, T fn) {
  5054. // Skip trailing spaces and tabs.
  5055. while (beg < end && is_space_or_tab(end[-1])) {
  5056. end--;
  5057. }
  5058. auto p = beg;
  5059. while (p < end && *p != ':') {
  5060. p++;
  5061. }
  5062. auto name = std::string(beg, p);
  5063. if (!detail::fields::is_field_name(name)) { return false; }
  5064. if (p == end) { return false; }
  5065. auto key_end = p;
  5066. if (*p++ != ':') { return false; }
  5067. while (p < end && is_space_or_tab(*p)) {
  5068. p++;
  5069. }
  5070. if (p <= end) {
  5071. auto key_len = key_end - beg;
  5072. if (!key_len) { return false; }
  5073. auto key = std::string(beg, key_end);
  5074. auto val = std::string(p, end);
  5075. if (!detail::fields::is_field_value(val)) { return false; }
  5076. // RFC 9110 §5.5: header field values are opaque octets and MUST NOT be
  5077. // percent-decoded by the recipient. Applications that need to interpret a
  5078. // value as a URI component should call httplib::decode_uri_component()
  5079. // (or decode_path_component()) explicitly.
  5080. fn(key, val);
  5081. return true;
  5082. }
  5083. return false;
  5084. }
  5085. inline bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  5086. const Headers &src_headers) {
  5087. // NOTE: In RFC 9112, '7.1 Chunked Transfer Coding' mentions "The chunked
  5088. // transfer coding is complete when a chunk with a chunk-size of zero is
  5089. // received, possibly followed by a trailer section, and finally terminated by
  5090. // an empty line". https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1
  5091. //
  5092. // In '7.1.3. Decoding Chunked', however, the pseudo-code in the section
  5093. // doesn't care for the existence of the final CRLF. In other words, it seems
  5094. // to be ok whether the final CRLF exists or not in the chunked data.
  5095. // https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1.3
  5096. //
  5097. // According to the reference code in RFC 9112, cpp-httplib now allows
  5098. // chunked transfer coding data without the final CRLF.
  5099. // RFC 7230 Section 4.1.2 - Headers prohibited in trailers
  5100. thread_local case_ignore::unordered_set<std::string> prohibited_trailers = {
  5101. "transfer-encoding",
  5102. "content-length",
  5103. "host",
  5104. "authorization",
  5105. "www-authenticate",
  5106. "proxy-authenticate",
  5107. "proxy-authorization",
  5108. "cookie",
  5109. "set-cookie",
  5110. "cache-control",
  5111. "expect",
  5112. "max-forwards",
  5113. "pragma",
  5114. "range",
  5115. "te",
  5116. "age",
  5117. "expires",
  5118. "date",
  5119. "location",
  5120. "retry-after",
  5121. "vary",
  5122. "warning",
  5123. "content-encoding",
  5124. "content-type",
  5125. "content-range",
  5126. "trailer"};
  5127. case_ignore::unordered_set<std::string> declared_trailers;
  5128. auto trailer_header = get_combined_header_value(src_headers, "Trailer");
  5129. if (!trailer_header.empty()) {
  5130. // split() trims each token and skips empty ones, so the name arrives ready
  5131. // to look up.
  5132. split(trailer_header.data(), trailer_header.data() + trailer_header.size(),
  5133. ',', [&](const char *b, const char *e) {
  5134. // A legitimate message declares only a handful of trailers. Cap the
  5135. // set so a peer cannot grow it without bound: an oversized set only
  5136. // arises from an attempt to force many colliding names into
  5137. // quadratic lookups (case_ignore::hash is unkeyed).
  5138. if (declared_trailers.size() >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  5139. return;
  5140. }
  5141. std::string key(b, e);
  5142. if (prohibited_trailers.find(key) == prohibited_trailers.end()) {
  5143. declared_trailers.insert(key);
  5144. }
  5145. });
  5146. }
  5147. size_t trailer_header_count = 0;
  5148. while (strcmp(line_reader.ptr(), "\r\n") != 0) {
  5149. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  5150. // Count every received trailer field, not only the declared ones stored in
  5151. // dest, so undeclared fields cannot keep this loop running past the limit.
  5152. if (trailer_header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  5153. constexpr auto line_terminator_len = 2;
  5154. auto line_beg = line_reader.ptr();
  5155. auto line_end =
  5156. line_reader.ptr() + line_reader.size() - line_terminator_len;
  5157. if (!parse_header(line_beg, line_end,
  5158. [&](const std::string &key, const std::string &val) {
  5159. if (declared_trailers.find(key) !=
  5160. declared_trailers.end()) {
  5161. dest.emplace(key, val);
  5162. }
  5163. })) {
  5164. return false;
  5165. }
  5166. trailer_header_count++;
  5167. if (!line_reader.getline()) { return false; }
  5168. }
  5169. return true;
  5170. }
  5171. inline std::pair<size_t, size_t> trim(const char *b, const char *e, size_t left,
  5172. size_t right) {
  5173. while (b + left < e && is_space_or_tab(b[left])) {
  5174. left++;
  5175. }
  5176. while (right > 0 && is_space_or_tab(b[right - 1])) {
  5177. right--;
  5178. }
  5179. return std::make_pair(left, right);
  5180. }
  5181. inline std::string trim_copy(const std::string &s) {
  5182. auto r = trim(s.data(), s.data() + s.size(), 0, s.size());
  5183. return s.substr(r.first, r.second - r.first);
  5184. }
  5185. inline std::string trim_double_quotes_copy(const std::string &s) {
  5186. if (s.length() >= 2 && s.front() == '"' && s.back() == '"') {
  5187. return s.substr(1, s.size() - 2);
  5188. }
  5189. return s;
  5190. }
  5191. // Takes the quotes off a parameter value. Only \" and \\ are quoted-pairs
  5192. // here, as browsers send any other backslash, such as one in a Windows path,
  5193. // as it is.
  5194. inline std::string unquote_param(const std::string &s) {
  5195. if (s.size() < 2 || s.front() != '"' || s.back() != '"') { return s; }
  5196. std::string out;
  5197. for (size_t i = 1; i + 1 < s.size(); i++) {
  5198. if (s[i] == '\\' && i + 2 < s.size() &&
  5199. (s[i + 1] == '"' || s[i + 1] == '\\')) {
  5200. i++;
  5201. }
  5202. out += s[i];
  5203. }
  5204. return out;
  5205. }
  5206. inline void
  5207. divide(const char *data, std::size_t size, char d,
  5208. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5209. fn) {
  5210. const auto it = std::find(data, data + size, d);
  5211. const auto found = static_cast<std::size_t>(it != data + size);
  5212. const auto lhs_data = data;
  5213. const auto lhs_size = static_cast<std::size_t>(it - data);
  5214. const auto rhs_data = it + found;
  5215. const auto rhs_size = size - lhs_size - found;
  5216. fn(lhs_data, lhs_size, rhs_data, rhs_size);
  5217. }
  5218. inline void
  5219. divide(const std::string &str, char d,
  5220. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5221. fn) {
  5222. divide(str.data(), str.size(), d, std::move(fn));
  5223. }
  5224. inline void split(const char *b, const char *e, char d,
  5225. std::function<void(const char *, const char *)> fn) {
  5226. return split(b, e, d, (std::numeric_limits<size_t>::max)(), std::move(fn));
  5227. }
  5228. inline void split(const char *b, const char *e, char d, size_t m,
  5229. std::function<void(const char *, const char *)> fn) {
  5230. size_t i = 0;
  5231. size_t beg = 0;
  5232. size_t count = 1;
  5233. while (e ? (b + i < e) : (b[i] != '\0')) {
  5234. if (b[i] == d && count < m) {
  5235. auto r = trim(b, e, beg, i);
  5236. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5237. beg = i + 1;
  5238. count++;
  5239. }
  5240. i++;
  5241. }
  5242. if (i) {
  5243. auto r = trim(b, e, beg, i);
  5244. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5245. }
  5246. }
  5247. // Same contract as split(), except that a delimiter inside a quoted-string is
  5248. // not a delimiter. RFC 9110 Section 5.6.6 lets a parameter value be a
  5249. // quoted-string, and ';' and '=' are legal characters inside one.
  5250. inline void split_unquoted(const char *b, const char *e, char d, size_t m,
  5251. std::function<void(const char *, const char *)> fn) {
  5252. size_t i = 0;
  5253. size_t beg = 0;
  5254. size_t count = 1;
  5255. auto in_quotes = false;
  5256. auto has = [&](size_t j) { return e ? (b + j < e) : (b[j] != '\0'); };
  5257. while (has(i)) {
  5258. if (in_quotes && b[i] == '\\' && has(i + 1)) {
  5259. // A quoted-pair, whose second character does not end the string.
  5260. i++;
  5261. } else if (b[i] == '"') {
  5262. in_quotes = !in_quotes;
  5263. } else if (b[i] == d && !in_quotes && count < m) {
  5264. auto r = trim(b, e, beg, i);
  5265. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5266. beg = i + 1;
  5267. count++;
  5268. }
  5269. i++;
  5270. }
  5271. if (i) {
  5272. auto r = trim(b, e, beg, i);
  5273. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5274. }
  5275. }
  5276. inline void split_unquoted(const char *b, const char *e, char d,
  5277. std::function<void(const char *, const char *)> fn) {
  5278. return split_unquoted(b, e, d, (std::numeric_limits<size_t>::max)(),
  5279. std::move(fn));
  5280. }
  5281. // Divide a header parameter at its first '='. RFC 9110 Section 5.6.6 makes the
  5282. // key a token, so the first '=' is the separator even when the value is a
  5283. // quoted-string carrying more of them.
  5284. inline void divide_param_pair(const char *b, const char *e, std::string &key,
  5285. std::string &val) {
  5286. divide(
  5287. b, static_cast<std::size_t>(e - b), '=',
  5288. [&](const char *kb, std::size_t klen, const char *vb, std::size_t vlen) {
  5289. const auto kr = trim(kb, kb + klen, 0, klen);
  5290. key.assign(kb + kr.first, kb + kr.second);
  5291. const auto vr = trim(vb, vb + vlen, 0, vlen);
  5292. val.assign(vb + vr.first, vb + vr.second);
  5293. });
  5294. }
  5295. inline bool split_find(const char *b, const char *e, char d, size_t m,
  5296. std::function<bool(const char *, const char *)> fn) {
  5297. size_t i = 0;
  5298. size_t beg = 0;
  5299. size_t count = 1;
  5300. while (e ? (b + i < e) : (b[i] != '\0')) {
  5301. if (b[i] == d && count < m) {
  5302. auto r = trim(b, e, beg, i);
  5303. if (r.first < r.second) {
  5304. auto found = fn(&b[r.first], &b[r.second]);
  5305. if (found) { return true; }
  5306. }
  5307. beg = i + 1;
  5308. count++;
  5309. }
  5310. i++;
  5311. }
  5312. if (i) {
  5313. auto r = trim(b, e, beg, i);
  5314. if (r.first < r.second) {
  5315. auto found = fn(&b[r.first], &b[r.second]);
  5316. if (found) { return true; }
  5317. }
  5318. }
  5319. return false;
  5320. }
  5321. inline bool split_find(const char *b, const char *e, char d,
  5322. std::function<bool(const char *, const char *)> fn) {
  5323. return split_find(b, e, d, (std::numeric_limits<size_t>::max)(),
  5324. std::move(fn));
  5325. }
  5326. inline stream_line_reader::stream_line_reader(Stream &strm, char *fixed_buffer,
  5327. size_t fixed_buffer_size)
  5328. : strm_(strm), fixed_buffer_(fixed_buffer),
  5329. fixed_buffer_size_(fixed_buffer_size) {}
  5330. inline const char *stream_line_reader::ptr() const {
  5331. if (growable_buffer_.empty()) {
  5332. return fixed_buffer_;
  5333. } else {
  5334. return growable_buffer_.data();
  5335. }
  5336. }
  5337. inline size_t stream_line_reader::size() const {
  5338. if (growable_buffer_.empty()) {
  5339. return fixed_buffer_used_size_;
  5340. } else {
  5341. return growable_buffer_.size();
  5342. }
  5343. }
  5344. inline bool stream_line_reader::end_with_crlf() const {
  5345. auto end = ptr() + size();
  5346. return size() >= 2 && end[-2] == '\r' && end[-1] == '\n';
  5347. }
  5348. inline bool stream_line_reader::getline() {
  5349. fixed_buffer_used_size_ = 0;
  5350. growable_buffer_.clear();
  5351. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5352. char prev_byte = 0;
  5353. #endif
  5354. for (size_t i = 0;; i++) {
  5355. // Fast path: whatever the stream has already buffered can be scanned for
  5356. // the terminator in one pass. Asking for a byte at a time costs a virtual
  5357. // call, a bounds check and a one-byte copy per character of the request.
  5358. size_t buffered_size = 0;
  5359. if (auto buffered = strm_.buffered_data(buffered_size)) {
  5360. auto take = buffered_size;
  5361. auto terminated = false;
  5362. for (size_t at = 0; at < buffered_size;) {
  5363. auto nl = static_cast<const char *>(
  5364. memchr(buffered + at, '\n', buffered_size - at));
  5365. if (!nl) { break; }
  5366. auto pos = static_cast<size_t>(nl - buffered);
  5367. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5368. take = pos + 1;
  5369. terminated = true;
  5370. break;
  5371. #else
  5372. // A bare LF does not end the line; keep looking for CRLF. The CR may
  5373. // be the last byte of an earlier chunk, hence prev_byte.
  5374. if ((pos > 0 ? buffered[pos - 1] : prev_byte) == '\r') {
  5375. take = pos + 1;
  5376. terminated = true;
  5377. break;
  5378. }
  5379. at = pos + 1;
  5380. #endif
  5381. }
  5382. if (size() + take > CPPHTTPLIB_MAX_LINE_LENGTH) { return false; }
  5383. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5384. prev_byte = buffered[take - 1];
  5385. #endif
  5386. append(buffered, take);
  5387. strm_.consume_buffered(take);
  5388. i += take;
  5389. if (terminated) { return true; }
  5390. continue;
  5391. }
  5392. if (size() >= CPPHTTPLIB_MAX_LINE_LENGTH) {
  5393. // Treat exceptionally long lines as an error to
  5394. // prevent infinite loops/memory exhaustion
  5395. return false;
  5396. }
  5397. char byte;
  5398. auto n = strm_.read(&byte, 1);
  5399. if (n < 0) {
  5400. return false;
  5401. } else if (n == 0) {
  5402. if (i == 0) {
  5403. return false;
  5404. } else {
  5405. break;
  5406. }
  5407. }
  5408. append(byte);
  5409. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5410. if (byte == '\n') { break; }
  5411. #else
  5412. if (prev_byte == '\r' && byte == '\n') { break; }
  5413. prev_byte = byte;
  5414. #endif
  5415. }
  5416. return true;
  5417. }
  5418. inline void stream_line_reader::append(char c) { append(&c, 1); }
  5419. inline void stream_line_reader::append(const char *data, size_t size) {
  5420. // Once the line has outgrown the fixed buffer everything must keep going to
  5421. // the growable one, even if a later chunk would have fit. Without the
  5422. // emptiness check a short append after a long one would land in the fixed
  5423. // buffer, which ptr() and size() no longer look at, and be lost.
  5424. if (growable_buffer_.empty() &&
  5425. fixed_buffer_used_size_ + size < fixed_buffer_size_) {
  5426. memcpy(fixed_buffer_ + fixed_buffer_used_size_, data, size);
  5427. fixed_buffer_used_size_ += size;
  5428. fixed_buffer_[fixed_buffer_used_size_] = '\0';
  5429. } else {
  5430. // Unlike the per-character overload, this can be the very first append of
  5431. // the line, so the fixed buffer may hold nothing and carry no terminator
  5432. // yet. assign() takes an explicit length and does not need one.
  5433. if (growable_buffer_.empty()) {
  5434. growable_buffer_.assign(fixed_buffer_, fixed_buffer_used_size_);
  5435. }
  5436. growable_buffer_.append(data, size);
  5437. }
  5438. }
  5439. inline mmap::mmap(const char *path) { open(path); }
  5440. inline mmap::~mmap() { close(); }
  5441. inline bool mmap::open(const char *path) {
  5442. close();
  5443. #if defined(_WIN32)
  5444. auto wpath = u8string_to_wstring(path);
  5445. if (wpath.empty()) { return false; }
  5446. hFile_ =
  5447. ::CreateFile2(wpath.c_str(), GENERIC_READ,
  5448. FILE_SHARE_READ | FILE_SHARE_WRITE, OPEN_EXISTING, NULL);
  5449. if (hFile_ == INVALID_HANDLE_VALUE) { return false; }
  5450. LARGE_INTEGER size{};
  5451. if (!::GetFileSizeEx(hFile_, &size)) { return false; }
  5452. // If the following line doesn't compile due to QuadPart, update Windows SDK.
  5453. // See:
  5454. // https://github.com/yhirose/cpp-httplib/issues/1903#issuecomment-2316520721
  5455. if (!fits_in_size_t(static_cast<uint64_t>(size.QuadPart))) { return false; }
  5456. size_ = static_cast<size_t>(size.QuadPart);
  5457. hMapping_ =
  5458. ::CreateFileMappingFromApp(hFile_, NULL, PAGE_READONLY, size_, NULL);
  5459. // Special treatment for an empty file...
  5460. if (hMapping_ == NULL && size_ == 0) {
  5461. close();
  5462. is_open_empty_file = true;
  5463. return true;
  5464. }
  5465. if (hMapping_ == NULL) {
  5466. close();
  5467. return false;
  5468. }
  5469. addr_ = ::MapViewOfFileFromApp(hMapping_, FILE_MAP_READ, 0, 0);
  5470. if (addr_ == nullptr) {
  5471. close();
  5472. return false;
  5473. }
  5474. #else
  5475. // O_NONBLOCK so that opening a FIFO does not wait for a writer.
  5476. fd_ = ::open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC);
  5477. if (fd_ == -1) { return false; }
  5478. // Only a regular file has a size to serve, unlike a directory or a device.
  5479. struct stat sb;
  5480. if (fstat(fd_, &sb) == -1 || !S_ISREG(sb.st_mode) ||
  5481. !fits_in_size_t(static_cast<uint64_t>(sb.st_size))) {
  5482. close();
  5483. return false;
  5484. }
  5485. size_ = static_cast<size_t>(sb.st_size);
  5486. #endif
  5487. return true;
  5488. }
  5489. inline bool mmap::is_open() const {
  5490. #if defined(_WIN32)
  5491. return is_open_empty_file ? true : addr_ != nullptr;
  5492. #else
  5493. return fd_ != -1;
  5494. #endif
  5495. }
  5496. inline size_t mmap::size() const { return size_; }
  5497. inline void mmap::close() {
  5498. #if defined(_WIN32)
  5499. if (addr_) {
  5500. ::UnmapViewOfFile(addr_);
  5501. addr_ = nullptr;
  5502. }
  5503. if (hMapping_) {
  5504. ::CloseHandle(hMapping_);
  5505. hMapping_ = NULL;
  5506. }
  5507. if (hFile_ != INVALID_HANDLE_VALUE) {
  5508. ::CloseHandle(hFile_);
  5509. hFile_ = INVALID_HANDLE_VALUE;
  5510. }
  5511. is_open_empty_file = false;
  5512. #else
  5513. if (fd_ != -1) {
  5514. ::close(fd_);
  5515. fd_ = -1;
  5516. }
  5517. #endif
  5518. size_ = 0;
  5519. }
  5520. inline int close_socket(socket_t sock) noexcept {
  5521. #ifdef _WIN32
  5522. return closesocket(sock);
  5523. #else
  5524. return close(sock);
  5525. #endif
  5526. }
  5527. template <typename T> inline ssize_t handle_EINTR(T fn) {
  5528. ssize_t res = 0;
  5529. while (true) {
  5530. res = fn();
  5531. if (res < 0 && errno == EINTR) {
  5532. std::this_thread::sleep_for(std::chrono::microseconds{1});
  5533. continue;
  5534. }
  5535. break;
  5536. }
  5537. return res;
  5538. }
  5539. inline size_t mmap::read(size_t offset, char *buf, size_t len) const {
  5540. if (offset >= size_) { return 0; }
  5541. len = (std::min)(len, size_ - offset);
  5542. #if defined(_WIN32)
  5543. // Windows does not let a mapped file be truncated.
  5544. std::memcpy(buf, static_cast<const char *>(addr_) + offset, len);
  5545. return len;
  5546. #else
  5547. auto n = handle_EINTR(
  5548. [&]() { return ::pread(fd_, buf, len, static_cast<off_t>(offset)); });
  5549. return n > 0 ? static_cast<size_t>(n) : 0;
  5550. #endif
  5551. }
  5552. inline ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags) {
  5553. return handle_EINTR([&]() {
  5554. return recv(sock,
  5555. #ifdef _WIN32
  5556. static_cast<char *>(ptr), static_cast<int>(size),
  5557. #else
  5558. ptr, size,
  5559. #endif
  5560. flags);
  5561. });
  5562. }
  5563. inline ssize_t send_socket(socket_t sock, const void *ptr, size_t size,
  5564. int flags) {
  5565. return handle_EINTR([&]() {
  5566. return send(sock,
  5567. #ifdef _WIN32
  5568. static_cast<const char *>(ptr), static_cast<int>(size),
  5569. #else
  5570. ptr, size,
  5571. #endif
  5572. flags);
  5573. });
  5574. }
  5575. inline int poll_wrapper(struct pollfd *fds, nfds_t nfds, int timeout) {
  5576. #ifdef _WIN32
  5577. return ::WSAPoll(fds, nfds, timeout);
  5578. #else
  5579. return ::poll(fds, nfds, timeout);
  5580. #endif
  5581. }
  5582. inline ssize_t select_impl(socket_t sock, short events, time_t sec,
  5583. time_t usec) {
  5584. struct pollfd pfd;
  5585. pfd.fd = sock;
  5586. pfd.events = events;
  5587. pfd.revents = 0;
  5588. // A negative timeout waits forever, poll's own convention. 0 keeps meaning
  5589. // "return immediately", which callers here rely on to probe a socket.
  5590. auto timeout = sec < 0 ? -1 : static_cast<int>(sec * 1000 + usec / 1000);
  5591. return handle_EINTR([&]() { return poll_wrapper(&pfd, 1, timeout); });
  5592. }
  5593. inline ssize_t select_read(socket_t sock, time_t sec, time_t usec) {
  5594. return select_impl(sock, POLLIN, sec, usec);
  5595. }
  5596. inline ssize_t select_write(socket_t sock, time_t sec, time_t usec) {
  5597. return select_impl(sock, POLLOUT, sec, usec);
  5598. }
  5599. // The point sec and usec from now, for select_until(). A negative sec never
  5600. // comes, as a negative timeout waits forever in select_impl().
  5601. inline std::chrono::steady_clock::time_point deadline_after(time_t sec,
  5602. time_t usec) {
  5603. if (sec < 0) { return (std::chrono::steady_clock::time_point::max)(); }
  5604. return std::chrono::steady_clock::now() + std::chrono::seconds(sec) +
  5605. std::chrono::microseconds(usec);
  5606. }
  5607. // Waits only for the time left until deadline, so that all the waits of one
  5608. // TLS handshake come out of a single timeout.
  5609. inline ssize_t select_until(socket_t sock, short events,
  5610. std::chrono::steady_clock::time_point deadline) {
  5611. if (deadline == (std::chrono::steady_clock::time_point::max)()) {
  5612. return select_impl(sock, events, -1, 0);
  5613. }
  5614. auto left = std::chrono::duration_cast<std::chrono::microseconds>(
  5615. deadline - std::chrono::steady_clock::now())
  5616. .count();
  5617. if (left <= 0) { return 0; }
  5618. return select_impl(sock, events, static_cast<time_t>(left / 1000000),
  5619. static_cast<time_t>(left % 1000000));
  5620. }
  5621. // select_read(), but waits in slices and gives up once interrupted() returns
  5622. // true. A local shutdown() would not wake the wait on Windows.
  5623. inline ssize_t
  5624. select_read_interruptible(socket_t sock, time_t sec, time_t usec,
  5625. const std::function<bool()> &interrupted) {
  5626. if (!interrupted) { return select_read(sock, sec, usec); }
  5627. const auto slice = std::chrono::microseconds(100000);
  5628. auto deadline = deadline_after(sec, usec);
  5629. while (!interrupted()) {
  5630. auto left = std::chrono::duration_cast<std::chrono::microseconds>(
  5631. deadline - std::chrono::steady_clock::now());
  5632. auto wait =
  5633. (std::max)((std::min)(left, slice), std::chrono::microseconds(0));
  5634. auto ret = select_impl(sock, POLLIN, 0, static_cast<time_t>(wait.count()));
  5635. if (ret != 0 || wait < slice) { return ret; }
  5636. }
  5637. return 0;
  5638. }
  5639. inline Error wait_until_socket_is_ready(socket_t sock, time_t sec,
  5640. time_t usec) {
  5641. struct pollfd pfd_read;
  5642. pfd_read.fd = sock;
  5643. pfd_read.events = POLLIN | POLLOUT;
  5644. pfd_read.revents = 0;
  5645. auto timeout = static_cast<int>(sec * 1000 + usec / 1000);
  5646. auto poll_res =
  5647. handle_EINTR([&]() { return poll_wrapper(&pfd_read, 1, timeout); });
  5648. if (poll_res == 0) { return Error::ConnectionTimeout; }
  5649. if (poll_res > 0 && pfd_read.revents & (POLLIN | POLLOUT)) {
  5650. auto error = 0;
  5651. socklen_t len = sizeof(error);
  5652. auto res = getsockopt(sock, SOL_SOCKET, SO_ERROR,
  5653. reinterpret_cast<char *>(&error), &len);
  5654. auto successful = res >= 0 && !error;
  5655. return successful ? Error::Success : Error::Connection;
  5656. }
  5657. return Error::Connection;
  5658. }
  5659. inline bool is_socket_alive(socket_t sock) {
  5660. const auto val = detail::select_read(sock, 0, 0);
  5661. if (val == 0) {
  5662. return true;
  5663. } else if (val < 0 && errno == EBADF) {
  5664. return false;
  5665. }
  5666. char buf[1];
  5667. return detail::read_socket(sock, &buf[0], sizeof(buf), MSG_PEEK) > 0;
  5668. }
  5669. class SocketStream final : public Stream {
  5670. public:
  5671. SocketStream(socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5672. time_t write_timeout_sec, time_t write_timeout_usec,
  5673. time_t max_timeout_msec = 0,
  5674. std::chrono::time_point<std::chrono::steady_clock> start_time =
  5675. (std::chrono::steady_clock::time_point::min)());
  5676. ~SocketStream() override;
  5677. bool is_readable() const override;
  5678. bool wait_readable() const override;
  5679. bool wait_writable() const override;
  5680. bool is_peer_alive() const override;
  5681. ssize_t read(char *ptr, size_t size) override;
  5682. ssize_t write(const char *ptr, size_t size) override;
  5683. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  5684. void get_local_ip_and_port(std::string &ip, int &port) const override;
  5685. socket_t socket() const override;
  5686. time_t duration() const override;
  5687. void set_read_timeout(time_t sec, time_t usec = 0) override;
  5688. void set_max_timeout(time_t msec) override;
  5689. void set_read_interrupt(std::function<bool()> interrupted) override;
  5690. const char *buffered_data(size_t &size) const override;
  5691. void consume_buffered(size_t size) override;
  5692. // The caller has just seen this socket become readable. Lets the next read
  5693. // skip its own readiness wait, which would otherwise ask the kernel a
  5694. // question that was answered a moment ago. Consumed by that read.
  5695. void set_readable_hint() { readable_hint_ = true; }
  5696. private:
  5697. bool ensure_readable();
  5698. socket_t sock_;
  5699. // Atomic because ws::WebSocket::set_read_timeout() reaches this from another
  5700. // thread while a read is in flight -- that is the point of it, for a caller
  5701. // holding one connection and wanting control back to send on it.
  5702. std::atomic<time_t> read_timeout_sec_;
  5703. std::atomic<time_t> read_timeout_usec_;
  5704. time_t write_timeout_sec_;
  5705. time_t write_timeout_usec_;
  5706. time_t max_timeout_msec_;
  5707. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  5708. std::function<bool()> read_interrupted_;
  5709. std::vector<char> read_buff_;
  5710. size_t read_buff_off_ = 0;
  5711. size_t read_buff_content_size_ = 0;
  5712. bool readable_hint_ = false;
  5713. static const size_t read_buff_size_ = 1024l * 4;
  5714. };
  5715. inline bool keep_alive(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5716. time_t keep_alive_timeout_sec) {
  5717. using namespace std::chrono;
  5718. const auto interval_usec =
  5719. CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND;
  5720. // Avoid expensive `steady_clock::now()` call for the first time
  5721. if (select_read(sock, 0, interval_usec) > 0) { return true; }
  5722. const auto start = steady_clock::now() - microseconds{interval_usec};
  5723. const auto timeout = seconds{keep_alive_timeout_sec};
  5724. while (true) {
  5725. if (svr_sock == INVALID_SOCKET) {
  5726. break; // Server socket is closed
  5727. }
  5728. auto val = select_read(sock, 0, interval_usec);
  5729. if (val < 0) {
  5730. break; // Ssocket error
  5731. } else if (val == 0) {
  5732. if (steady_clock::now() - start > timeout) {
  5733. break; // Timeout
  5734. }
  5735. } else {
  5736. return true; // Ready for read
  5737. }
  5738. }
  5739. return false;
  5740. }
  5741. // `has_buffered_request` reports whether the connection's stream already holds
  5742. // bytes of the next request. A client may pipeline its requests (RFC 9112
  5743. // 9.3.2), so reading one request can pull the start of the next one into the
  5744. // stream's buffer; that request must be served without waiting for the socket
  5745. // to become readable again, since its bytes are no longer on the socket.
  5746. // `callback` is told whether keep_alive() has just seen the socket go readable.
  5747. template <typename P, typename T>
  5748. inline bool process_server_socket_core(const std::atomic<socket_t> &svr_sock,
  5749. socket_t sock,
  5750. size_t keep_alive_max_count,
  5751. time_t keep_alive_timeout_sec,
  5752. P has_buffered_request, T callback) {
  5753. auto ret = false;
  5754. // A keep_alive_max_count of 0 sets no limit.
  5755. for (size_t served = 0;
  5756. keep_alive_max_count == 0 || served < keep_alive_max_count; served++) {
  5757. auto socket_readable = false;
  5758. if (!has_buffered_request()) {
  5759. if (!keep_alive(svr_sock, sock, keep_alive_timeout_sec)) { break; }
  5760. socket_readable = true;
  5761. }
  5762. auto close_connection = served + 1 == keep_alive_max_count;
  5763. auto connection_closed = false;
  5764. ret = callback(socket_readable, close_connection, connection_closed);
  5765. if (!ret || connection_closed) { break; }
  5766. }
  5767. return ret;
  5768. }
  5769. template <typename T>
  5770. inline bool
  5771. process_server_socket(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5772. size_t keep_alive_max_count,
  5773. time_t keep_alive_timeout_sec, time_t read_timeout_sec,
  5774. time_t read_timeout_usec, time_t write_timeout_sec,
  5775. time_t write_timeout_usec, T callback) {
  5776. // One stream per connection: its read buffer can already hold the start of
  5777. // the next, pipelined request.
  5778. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5779. write_timeout_sec, write_timeout_usec);
  5780. return process_server_socket_core(
  5781. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  5782. [&]() { return strm.is_readable(); },
  5783. [&](bool socket_readable, bool close_connection,
  5784. bool &connection_closed) {
  5785. if (socket_readable) { strm.set_readable_hint(); }
  5786. return callback(strm, close_connection, connection_closed);
  5787. });
  5788. }
  5789. inline bool process_client_socket(
  5790. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5791. time_t write_timeout_sec, time_t write_timeout_usec,
  5792. time_t max_timeout_msec,
  5793. std::chrono::time_point<std::chrono::steady_clock> start_time,
  5794. std::function<bool(Stream &)> callback) {
  5795. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5796. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  5797. start_time);
  5798. return callback(strm);
  5799. }
  5800. inline int shutdown_socket(socket_t sock) noexcept {
  5801. #ifdef _WIN32
  5802. return shutdown(sock, SD_BOTH);
  5803. #else
  5804. return shutdown(sock, SHUT_RDWR);
  5805. #endif
  5806. }
  5807. // Half-closes the write side and drains any in-flight/queued bytes before
  5808. // the final shutdown+close. Closing with unread data in the receive queue
  5809. // (or bytes arriving after the receive side is closed) makes the stack send
  5810. // an abortive RST instead of a graceful FIN, which can make the peer see the
  5811. // response as a failed read even though it was fully written.
  5812. inline void drain_and_close_socket(socket_t sock) noexcept {
  5813. #ifdef _WIN32
  5814. shutdown(sock, SD_SEND);
  5815. #else
  5816. shutdown(sock, SHUT_WR);
  5817. #endif
  5818. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  5819. size_t total = 0;
  5820. const auto deadline = std::chrono::steady_clock::now() +
  5821. std::chrono::milliseconds(100); // bound #1
  5822. while (total < size_t(1024u * 1024u)) { // bound #2
  5823. const auto remaining =
  5824. std::chrono::duration_cast<std::chrono::microseconds>(
  5825. deadline - std::chrono::steady_clock::now())
  5826. .count();
  5827. if (remaining <= 0) { break; }
  5828. if (select_read(sock, 0, static_cast<time_t>(remaining)) <= 0) { break; }
  5829. const auto n = read_socket(sock, buf, sizeof(buf), CPPHTTPLIB_RECV_FLAGS);
  5830. if (n <= 0) { break; }
  5831. total += static_cast<size_t>(n);
  5832. }
  5833. shutdown_socket(sock);
  5834. close_socket(sock);
  5835. }
  5836. inline std::string escape_abstract_namespace_unix_domain(const std::string &s) {
  5837. if (s.size() > 1 && s[0] == '\0') {
  5838. auto ret = s;
  5839. ret[0] = '@';
  5840. return ret;
  5841. }
  5842. return s;
  5843. }
  5844. inline std::string
  5845. unescape_abstract_namespace_unix_domain(const std::string &s) {
  5846. if (s.size() > 1 && s[0] == '@') {
  5847. auto ret = s;
  5848. ret[0] = '\0';
  5849. return ret;
  5850. }
  5851. return s;
  5852. }
  5853. inline int getaddrinfo_with_timeout(const char *node, const char *service,
  5854. const struct addrinfo *hints,
  5855. struct addrinfo **res, time_t timeout_sec) {
  5856. #ifdef CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO
  5857. if (timeout_sec <= 0) {
  5858. // No timeout specified, use standard getaddrinfo
  5859. return getaddrinfo(node, service, hints, res);
  5860. }
  5861. #ifdef _WIN32
  5862. // Windows-specific implementation using GetAddrInfoEx with overlapped I/O
  5863. OVERLAPPED overlapped = {};
  5864. HANDLE event = CreateEventW(nullptr, TRUE, FALSE, nullptr);
  5865. if (!event) { return EAI_FAIL; }
  5866. overlapped.hEvent = event;
  5867. PADDRINFOEXW result_addrinfo = nullptr;
  5868. HANDLE cancel_handle = nullptr;
  5869. ADDRINFOEXW hints_ex = {};
  5870. if (hints) {
  5871. hints_ex.ai_flags = hints->ai_flags;
  5872. hints_ex.ai_family = hints->ai_family;
  5873. hints_ex.ai_socktype = hints->ai_socktype;
  5874. hints_ex.ai_protocol = hints->ai_protocol;
  5875. }
  5876. auto wnode = u8string_to_wstring(node);
  5877. auto wservice = u8string_to_wstring(service);
  5878. auto ret = ::GetAddrInfoExW(wnode.data(), wservice.data(), NS_DNS, nullptr,
  5879. hints ? &hints_ex : nullptr, &result_addrinfo,
  5880. nullptr, &overlapped, nullptr, &cancel_handle);
  5881. if (ret == WSA_IO_PENDING) {
  5882. auto wait_result =
  5883. ::WaitForSingleObject(event, static_cast<DWORD>(timeout_sec * 1000));
  5884. if (wait_result == WAIT_TIMEOUT) {
  5885. if (cancel_handle) { ::GetAddrInfoExCancel(&cancel_handle); }
  5886. ::CloseHandle(event);
  5887. return EAI_AGAIN;
  5888. }
  5889. DWORD bytes_returned;
  5890. if (!::GetOverlappedResult((HANDLE)INVALID_SOCKET, &overlapped,
  5891. &bytes_returned, FALSE)) {
  5892. ::CloseHandle(event);
  5893. return ::WSAGetLastError();
  5894. }
  5895. }
  5896. ::CloseHandle(event);
  5897. if (ret == NO_ERROR || ret == WSA_IO_PENDING) {
  5898. *res = reinterpret_cast<struct addrinfo *>(result_addrinfo);
  5899. return 0;
  5900. }
  5901. return ret;
  5902. #elif TARGET_OS_MAC && defined(__clang__)
  5903. if (!node) { return EAI_NONAME; }
  5904. // macOS implementation using CFHost API for asynchronous DNS resolution
  5905. CFStringRef hostname_ref = CFStringCreateWithCString(
  5906. kCFAllocatorDefault, node, kCFStringEncodingUTF8);
  5907. if (!hostname_ref) { return EAI_MEMORY; }
  5908. CFHostRef host_ref = CFHostCreateWithName(kCFAllocatorDefault, hostname_ref);
  5909. CFRelease(hostname_ref);
  5910. if (!host_ref) { return EAI_MEMORY; }
  5911. // Set up context for callback
  5912. struct CFHostContext {
  5913. bool completed = false;
  5914. bool success = false;
  5915. CFArrayRef addresses = nullptr;
  5916. std::mutex mutex;
  5917. std::condition_variable cv;
  5918. } context;
  5919. CFHostClientContext client_context;
  5920. memset(&client_context, 0, sizeof(client_context));
  5921. client_context.info = &context;
  5922. // Set callback
  5923. auto callback = [](CFHostRef theHost, CFHostInfoType /*typeInfo*/,
  5924. const CFStreamError *error, void *info) {
  5925. auto ctx = static_cast<CFHostContext *>(info);
  5926. std::lock_guard<std::mutex> lock(ctx->mutex);
  5927. if (error && error->error != 0) {
  5928. ctx->success = false;
  5929. } else {
  5930. Boolean hasBeenResolved;
  5931. ctx->addresses = CFHostGetAddressing(theHost, &hasBeenResolved);
  5932. if (ctx->addresses && hasBeenResolved) {
  5933. CFRetain(ctx->addresses);
  5934. ctx->success = true;
  5935. } else {
  5936. ctx->success = false;
  5937. }
  5938. }
  5939. ctx->completed = true;
  5940. ctx->cv.notify_one();
  5941. };
  5942. if (!CFHostSetClient(host_ref, callback, &client_context)) {
  5943. CFRelease(host_ref);
  5944. return EAI_SYSTEM;
  5945. }
  5946. // Schedule on run loop
  5947. CFRunLoopRef run_loop = CFRunLoopGetCurrent();
  5948. CFHostScheduleWithRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5949. // Start resolution
  5950. CFStreamError stream_error;
  5951. if (!CFHostStartInfoResolution(host_ref, kCFHostAddresses, &stream_error)) {
  5952. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5953. CFRelease(host_ref);
  5954. return EAI_FAIL;
  5955. }
  5956. // Wait for completion with timeout
  5957. auto timeout_time =
  5958. std::chrono::steady_clock::now() + std::chrono::seconds(timeout_sec);
  5959. bool timed_out = false;
  5960. {
  5961. std::unique_lock<std::mutex> lock(context.mutex);
  5962. while (!context.completed) {
  5963. auto now = std::chrono::steady_clock::now();
  5964. if (now >= timeout_time) {
  5965. timed_out = true;
  5966. break;
  5967. }
  5968. // Run the runloop for a short time
  5969. lock.unlock();
  5970. CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.1, true);
  5971. lock.lock();
  5972. }
  5973. }
  5974. // Clean up
  5975. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5976. CFHostSetClient(host_ref, nullptr, nullptr);
  5977. if (timed_out || !context.completed) {
  5978. CFHostCancelInfoResolution(host_ref, kCFHostAddresses);
  5979. CFRelease(host_ref);
  5980. return EAI_AGAIN;
  5981. }
  5982. if (!context.success || !context.addresses) {
  5983. CFRelease(host_ref);
  5984. return EAI_NODATA;
  5985. }
  5986. // Convert CFArray to addrinfo
  5987. CFIndex count = CFArrayGetCount(context.addresses);
  5988. if (count == 0) {
  5989. CFRelease(context.addresses);
  5990. CFRelease(host_ref);
  5991. return EAI_NODATA;
  5992. }
  5993. struct addrinfo *result_addrinfo = nullptr;
  5994. struct addrinfo **current = &result_addrinfo;
  5995. for (CFIndex i = 0; i < count; i++) {
  5996. CFDataRef addr_data =
  5997. static_cast<CFDataRef>(CFArrayGetValueAtIndex(context.addresses, i));
  5998. if (!addr_data) continue;
  5999. const struct sockaddr *sockaddr_ptr =
  6000. reinterpret_cast<const struct sockaddr *>(CFDataGetBytePtr(addr_data));
  6001. socklen_t sockaddr_len = static_cast<socklen_t>(CFDataGetLength(addr_data));
  6002. // Allocate addrinfo structure
  6003. *current = static_cast<struct addrinfo *>(malloc(sizeof(struct addrinfo)));
  6004. if (!*current) {
  6005. freeaddrinfo(result_addrinfo);
  6006. CFRelease(context.addresses);
  6007. CFRelease(host_ref);
  6008. return EAI_MEMORY;
  6009. }
  6010. memset(*current, 0, sizeof(struct addrinfo));
  6011. // Set up addrinfo fields
  6012. (*current)->ai_family = sockaddr_ptr->sa_family;
  6013. (*current)->ai_socktype = hints ? hints->ai_socktype : SOCK_STREAM;
  6014. (*current)->ai_protocol = hints ? hints->ai_protocol : IPPROTO_TCP;
  6015. (*current)->ai_addrlen = sockaddr_len;
  6016. // Copy sockaddr
  6017. (*current)->ai_addr = static_cast<struct sockaddr *>(malloc(sockaddr_len));
  6018. if (!(*current)->ai_addr) {
  6019. freeaddrinfo(result_addrinfo);
  6020. CFRelease(context.addresses);
  6021. CFRelease(host_ref);
  6022. return EAI_MEMORY;
  6023. }
  6024. memcpy((*current)->ai_addr, sockaddr_ptr, sockaddr_len);
  6025. // Set port if service is specified
  6026. if (service && *service) {
  6027. int port = 0;
  6028. if (parse_port(service, strlen(service), port)) {
  6029. if (sockaddr_ptr->sa_family == AF_INET) {
  6030. reinterpret_cast<struct sockaddr_in *>((*current)->ai_addr)
  6031. ->sin_port = htons(static_cast<uint16_t>(port));
  6032. } else if (sockaddr_ptr->sa_family == AF_INET6) {
  6033. reinterpret_cast<struct sockaddr_in6 *>((*current)->ai_addr)
  6034. ->sin6_port = htons(static_cast<uint16_t>(port));
  6035. }
  6036. }
  6037. }
  6038. current = &((*current)->ai_next);
  6039. }
  6040. CFRelease(context.addresses);
  6041. CFRelease(host_ref);
  6042. *res = result_addrinfo;
  6043. return 0;
  6044. #elif defined(_GNU_SOURCE) && defined(__GLIBC__) && \
  6045. (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 2)) && \
  6046. !defined(CPPHTTPLIB_THREAD_SANITIZER)
  6047. // Skipped under TSan: glibc's internal resolver thread is invisible to it.
  6048. // #2431: gai_cancel() is non-blocking and may return EAI_NOTCANCELED while
  6049. // the resolver worker still references the stack-local gaicb. The cancel
  6050. // path therefore waits (gai_suspend with no timeout) for the worker to
  6051. // actually finish before letting the stack frame go. The trade-off is that
  6052. // a wedged DNS server can hold this thread for the system resolver timeout
  6053. // (~30s by default) past the caller's connection timeout.
  6054. struct gaicb request{};
  6055. struct gaicb *requests[1] = {&request};
  6056. struct sigevent sevp{};
  6057. struct timespec timeout{timeout_sec, 0};
  6058. request.ar_name = node;
  6059. request.ar_service = service;
  6060. request.ar_request = hints;
  6061. sevp.sigev_notify = SIGEV_NONE;
  6062. int rc = getaddrinfo_a(GAI_NOWAIT, requests, 1, &sevp);
  6063. if (rc != 0) { return rc; }
  6064. auto cleanup = scope_exit([&] {
  6065. if (request.ar_result) { freeaddrinfo(request.ar_result); }
  6066. });
  6067. int wait_result = gai_suspend(requests, 1, &timeout);
  6068. if (wait_result == 0 || wait_result == EAI_ALLDONE) {
  6069. int gai_result = gai_error(&request);
  6070. if (gai_result == 0) {
  6071. *res = request.ar_result;
  6072. request.ar_result = nullptr;
  6073. return 0;
  6074. }
  6075. return gai_result;
  6076. }
  6077. gai_cancel(&request);
  6078. while (gai_error(&request) == EAI_INPROGRESS) {
  6079. gai_suspend(requests, 1, nullptr);
  6080. }
  6081. return wait_result;
  6082. #else
  6083. // Fallback implementation using thread-based timeout for other Unix systems.
  6084. struct GetAddrInfoState {
  6085. ~GetAddrInfoState() {
  6086. if (info) { freeaddrinfo(info); }
  6087. }
  6088. std::mutex mutex;
  6089. std::condition_variable result_cv;
  6090. bool completed = false;
  6091. int result = EAI_SYSTEM;
  6092. std::string node;
  6093. std::string service;
  6094. struct addrinfo hints;
  6095. struct addrinfo *info = nullptr;
  6096. };
  6097. // Allocate on the heap, so the resolver thread can keep using the data.
  6098. auto state = std::make_shared<GetAddrInfoState>();
  6099. if (node) { state->node = node; }
  6100. state->service = service;
  6101. state->hints = *hints;
  6102. std::thread resolve_thread([state]() {
  6103. auto thread_result =
  6104. getaddrinfo(state->node.c_str(), state->service.c_str(), &state->hints,
  6105. &state->info);
  6106. std::lock_guard<std::mutex> lock(state->mutex);
  6107. state->result = thread_result;
  6108. state->completed = true;
  6109. state->result_cv.notify_one();
  6110. });
  6111. // Wait for completion or timeout
  6112. std::unique_lock<std::mutex> lock(state->mutex);
  6113. auto finished =
  6114. state->result_cv.wait_for(lock, std::chrono::seconds(timeout_sec),
  6115. [&] { return state->completed; });
  6116. if (finished) {
  6117. // Operation completed within timeout
  6118. resolve_thread.join();
  6119. *res = state->info;
  6120. state->info = nullptr; // Pass ownership to caller
  6121. return state->result;
  6122. } else {
  6123. // Timeout occurred
  6124. resolve_thread.detach(); // Let the thread finish in background
  6125. return EAI_AGAIN; // Return timeout error
  6126. }
  6127. #endif
  6128. #else
  6129. (void)(timeout_sec); // Unused parameter for non-blocking getaddrinfo
  6130. return getaddrinfo(node, service, hints, res);
  6131. #endif
  6132. }
  6133. template <typename BindOrConnect>
  6134. socket_t create_socket(const std::string &host, const std::string &ip, int port,
  6135. int address_family, int socket_flags, bool tcp_nodelay,
  6136. bool ipv6_v6only, SocketOptions socket_options,
  6137. BindOrConnect bind_or_connect, time_t timeout_sec = 0) {
  6138. // Get address info
  6139. const char *node = nullptr;
  6140. struct addrinfo hints;
  6141. struct addrinfo *result;
  6142. memset(&hints, 0, sizeof(struct addrinfo));
  6143. hints.ai_socktype = SOCK_STREAM;
  6144. hints.ai_protocol = IPPROTO_IP;
  6145. if (!ip.empty()) {
  6146. node = ip.c_str();
  6147. // Ask getaddrinfo to convert IP in c-string to address
  6148. hints.ai_family = AF_UNSPEC;
  6149. hints.ai_flags = AI_NUMERICHOST;
  6150. } else {
  6151. if (!host.empty()) { node = host.c_str(); }
  6152. hints.ai_family = address_family;
  6153. hints.ai_flags = socket_flags;
  6154. }
  6155. #if !defined(_WIN32) || defined(CPPHTTPLIB_HAVE_AFUNIX_H)
  6156. if (hints.ai_family == AF_UNIX) {
  6157. const auto addrlen = host.length();
  6158. if (addrlen > sizeof(sockaddr_un::sun_path)) { return INVALID_SOCKET; }
  6159. #ifdef SOCK_CLOEXEC
  6160. auto sock = socket(hints.ai_family, hints.ai_socktype | SOCK_CLOEXEC,
  6161. hints.ai_protocol);
  6162. #else
  6163. auto sock = socket(hints.ai_family, hints.ai_socktype, hints.ai_protocol);
  6164. #endif
  6165. if (sock != INVALID_SOCKET) {
  6166. sockaddr_un addr{};
  6167. addr.sun_family = AF_UNIX;
  6168. auto unescaped_host = unescape_abstract_namespace_unix_domain(host);
  6169. std::copy(unescaped_host.begin(), unescaped_host.end(), addr.sun_path);
  6170. hints.ai_addr = reinterpret_cast<sockaddr *>(&addr);
  6171. hints.ai_addrlen = static_cast<socklen_t>(
  6172. sizeof(addr) - sizeof(addr.sun_path) + addrlen);
  6173. #ifndef SOCK_CLOEXEC
  6174. #ifndef _WIN32
  6175. fcntl(sock, F_SETFD, FD_CLOEXEC);
  6176. #endif
  6177. #endif
  6178. if (socket_options) { socket_options(sock); }
  6179. #ifdef _WIN32
  6180. // Setting SO_REUSEADDR seems not to work well with AF_UNIX on windows, so
  6181. // remove the option.
  6182. set_socket_opt(sock, SOL_SOCKET, SO_REUSEADDR, 0);
  6183. #endif
  6184. bool dummy;
  6185. if (!bind_or_connect(sock, hints, dummy)) {
  6186. close_socket(sock);
  6187. sock = INVALID_SOCKET;
  6188. }
  6189. }
  6190. return sock;
  6191. }
  6192. #endif
  6193. auto service = std::to_string(port);
  6194. if (getaddrinfo_with_timeout(node, service.c_str(), &hints, &result,
  6195. timeout_sec)) {
  6196. #if defined __linux__ && !defined __ANDROID__
  6197. res_init();
  6198. #endif
  6199. return INVALID_SOCKET;
  6200. }
  6201. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6202. for (auto rp = result; rp; rp = rp->ai_next) {
  6203. // Create a socket
  6204. #ifdef _WIN32
  6205. auto sock =
  6206. WSASocketW(rp->ai_family, rp->ai_socktype, rp->ai_protocol, nullptr, 0,
  6207. WSA_FLAG_NO_HANDLE_INHERIT | WSA_FLAG_OVERLAPPED);
  6208. /**
  6209. * Since the WSA_FLAG_NO_HANDLE_INHERIT is only supported on Windows 7 SP1
  6210. * and above the socket creation fails on older Windows Systems.
  6211. *
  6212. * Let's try to create a socket the old way in this case.
  6213. *
  6214. * Reference:
  6215. * https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketa
  6216. *
  6217. * WSA_FLAG_NO_HANDLE_INHERIT:
  6218. * This flag is supported on Windows 7 with SP1, Windows Server 2008 R2 with
  6219. * SP1, and later
  6220. *
  6221. */
  6222. if (sock == INVALID_SOCKET) {
  6223. sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6224. }
  6225. #else
  6226. #ifdef SOCK_CLOEXEC
  6227. auto sock =
  6228. socket(rp->ai_family, rp->ai_socktype | SOCK_CLOEXEC, rp->ai_protocol);
  6229. #else
  6230. auto sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6231. #endif
  6232. #endif
  6233. if (sock == INVALID_SOCKET) { continue; }
  6234. #if !defined _WIN32 && !defined SOCK_CLOEXEC
  6235. if (fcntl(sock, F_SETFD, FD_CLOEXEC) == -1) {
  6236. close_socket(sock);
  6237. continue;
  6238. }
  6239. #endif
  6240. if (tcp_nodelay) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  6241. if (rp->ai_family == AF_INET6) {
  6242. set_socket_opt(sock, IPPROTO_IPV6, IPV6_V6ONLY, ipv6_v6only ? 1 : 0);
  6243. }
  6244. if (socket_options) { socket_options(sock); }
  6245. // bind or connect
  6246. auto quit = false;
  6247. if (bind_or_connect(sock, *rp, quit)) { return sock; }
  6248. close_socket(sock);
  6249. if (quit) { break; }
  6250. }
  6251. return INVALID_SOCKET;
  6252. }
  6253. inline void set_nonblocking(socket_t sock, bool nonblocking) {
  6254. #ifdef _WIN32
  6255. auto flags = nonblocking ? 1UL : 0UL;
  6256. ioctlsocket(sock, FIONBIO, &flags);
  6257. #else
  6258. auto flags = fcntl(sock, F_GETFL, 0);
  6259. fcntl(sock, F_SETFL,
  6260. nonblocking ? (flags | O_NONBLOCK) : (flags & (~O_NONBLOCK)));
  6261. #endif
  6262. }
  6263. inline bool is_connection_error() {
  6264. #ifdef _WIN32
  6265. return WSAGetLastError() != WSAEWOULDBLOCK;
  6266. #else
  6267. return errno != EINPROGRESS;
  6268. #endif
  6269. }
  6270. // accept() failed because the process or the network stack is temporarily out
  6271. // of resources. The listening socket is still usable, so back off briefly and
  6272. // try again.
  6273. inline bool is_accept_resource_error() {
  6274. #ifdef _WIN32
  6275. auto err = WSAGetLastError();
  6276. return err == WSAEMFILE || err == WSAENOBUFS;
  6277. #else
  6278. auto err = errno;
  6279. return err == EMFILE || err == ENFILE || err == ENOBUFS || err == ENOMEM;
  6280. #endif
  6281. }
  6282. // accept() failed for a reason that says nothing about the listening socket:
  6283. // the pending connection went away before it could be accepted, or the call
  6284. // was interrupted. Retry immediately. WSAAccept()'s own documentation omits
  6285. // WSAECONNRESET, but the accept() it wraps reports an aborted pending
  6286. // connection that way.
  6287. inline bool is_accept_transient_error() {
  6288. #ifdef _WIN32
  6289. auto err = WSAGetLastError();
  6290. return err == WSAEINTR || err == WSAEWOULDBLOCK || err == WSAECONNRESET ||
  6291. err == WSAECONNABORTED;
  6292. #else
  6293. auto err = errno;
  6294. return err == EINTR || err == EAGAIN || err == EWOULDBLOCK ||
  6295. err == ECONNABORTED;
  6296. #endif
  6297. }
  6298. inline bool bind_ip_address(socket_t sock, const std::string &host) {
  6299. struct addrinfo hints;
  6300. struct addrinfo *result;
  6301. memset(&hints, 0, sizeof(struct addrinfo));
  6302. hints.ai_family = AF_UNSPEC;
  6303. hints.ai_socktype = SOCK_STREAM;
  6304. hints.ai_protocol = 0;
  6305. if (getaddrinfo_with_timeout(host.c_str(), "0", &hints, &result, 0)) {
  6306. return false;
  6307. }
  6308. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6309. auto ret = false;
  6310. for (auto rp = result; rp; rp = rp->ai_next) {
  6311. const auto &ai = *rp;
  6312. if (!::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  6313. ret = true;
  6314. break;
  6315. }
  6316. }
  6317. return ret;
  6318. }
  6319. #if !defined _WIN32 && !defined ANDROID && !defined _AIX && !defined __MVS__
  6320. #define USE_IF2IP
  6321. #endif
  6322. #ifdef USE_IF2IP
  6323. inline std::string if2ip(int address_family, const std::string &ifn) {
  6324. struct ifaddrs *ifap;
  6325. getifaddrs(&ifap);
  6326. auto se = detail::scope_exit([&] { freeifaddrs(ifap); });
  6327. std::string addr_candidate;
  6328. for (auto ifa = ifap; ifa; ifa = ifa->ifa_next) {
  6329. if (ifa->ifa_addr && ifn == ifa->ifa_name &&
  6330. (AF_UNSPEC == address_family ||
  6331. ifa->ifa_addr->sa_family == address_family)) {
  6332. if (ifa->ifa_addr->sa_family == AF_INET) {
  6333. auto sa = reinterpret_cast<struct sockaddr_in *>(ifa->ifa_addr);
  6334. char buf[INET_ADDRSTRLEN];
  6335. if (inet_ntop(AF_INET, &sa->sin_addr, buf, INET_ADDRSTRLEN)) {
  6336. return std::string(buf, INET_ADDRSTRLEN);
  6337. }
  6338. } else if (ifa->ifa_addr->sa_family == AF_INET6) {
  6339. auto sa = reinterpret_cast<struct sockaddr_in6 *>(ifa->ifa_addr);
  6340. if (!IN6_IS_ADDR_LINKLOCAL(&sa->sin6_addr)) {
  6341. char buf[INET6_ADDRSTRLEN] = {};
  6342. if (inet_ntop(AF_INET6, &sa->sin6_addr, buf, INET6_ADDRSTRLEN)) {
  6343. // equivalent to mac's IN6_IS_ADDR_UNIQUE_LOCAL
  6344. auto s6_addr_head = sa->sin6_addr.s6_addr[0];
  6345. if (s6_addr_head == 0xfc || s6_addr_head == 0xfd) {
  6346. addr_candidate = std::string(buf, INET6_ADDRSTRLEN);
  6347. } else {
  6348. return std::string(buf, INET6_ADDRSTRLEN);
  6349. }
  6350. }
  6351. }
  6352. }
  6353. }
  6354. }
  6355. return addr_candidate;
  6356. }
  6357. #endif
  6358. inline socket_t create_client_socket(
  6359. const std::string &host, const std::string &ip, int port,
  6360. int address_family, bool tcp_nodelay, bool ipv6_v6only,
  6361. SocketOptions socket_options, time_t connection_timeout_sec,
  6362. time_t connection_timeout_usec, time_t read_timeout_sec,
  6363. time_t read_timeout_usec, time_t write_timeout_sec,
  6364. time_t write_timeout_usec, const std::string &intf, Error &error) {
  6365. auto sock = create_socket(
  6366. host, ip, port, address_family, 0, tcp_nodelay, ipv6_v6only,
  6367. std::move(socket_options),
  6368. [&](socket_t sock2, struct addrinfo &ai, bool &quit) -> bool {
  6369. if (!intf.empty()) {
  6370. #ifdef USE_IF2IP
  6371. auto ip_from_if = if2ip(address_family, intf);
  6372. if (ip_from_if.empty()) { ip_from_if = intf; }
  6373. if (!bind_ip_address(sock2, ip_from_if)) {
  6374. error = Error::BindIPAddress;
  6375. return false;
  6376. }
  6377. #endif
  6378. }
  6379. set_nonblocking(sock2, true);
  6380. auto ret =
  6381. ::connect(sock2, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen));
  6382. if (ret < 0) {
  6383. if (is_connection_error()) {
  6384. error = Error::Connection;
  6385. return false;
  6386. }
  6387. error = wait_until_socket_is_ready(sock2, connection_timeout_sec,
  6388. connection_timeout_usec);
  6389. if (error != Error::Success) {
  6390. if (error == Error::ConnectionTimeout) { quit = true; }
  6391. return false;
  6392. }
  6393. }
  6394. set_nonblocking(sock2, false);
  6395. set_socket_opt_time(sock2, SOL_SOCKET, SO_RCVTIMEO, read_timeout_sec,
  6396. read_timeout_usec);
  6397. set_socket_opt_time(sock2, SOL_SOCKET, SO_SNDTIMEO, write_timeout_sec,
  6398. write_timeout_usec);
  6399. error = Error::Success;
  6400. return true;
  6401. },
  6402. connection_timeout_sec); // Pass DNS timeout
  6403. if (sock != INVALID_SOCKET) {
  6404. error = Error::Success;
  6405. } else {
  6406. if (error == Error::Success) { error = Error::Connection; }
  6407. }
  6408. return sock;
  6409. }
  6410. inline bool get_ip_and_port(const struct sockaddr_storage &addr,
  6411. socklen_t addr_len, std::string &ip, int &port) {
  6412. if (addr.ss_family == AF_INET) {
  6413. port = ntohs(reinterpret_cast<const struct sockaddr_in *>(&addr)->sin_port);
  6414. } else if (addr.ss_family == AF_INET6) {
  6415. port =
  6416. ntohs(reinterpret_cast<const struct sockaddr_in6 *>(&addr)->sin6_port);
  6417. } else {
  6418. return false;
  6419. }
  6420. std::array<char, NI_MAXHOST> ipstr{};
  6421. if (getnameinfo(reinterpret_cast<const struct sockaddr *>(&addr), addr_len,
  6422. ipstr.data(), static_cast<socklen_t>(ipstr.size()), nullptr,
  6423. 0, NI_NUMERICHOST)) {
  6424. return false;
  6425. }
  6426. ip = ipstr.data();
  6427. return true;
  6428. }
  6429. inline void get_local_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6430. struct sockaddr_storage addr;
  6431. socklen_t addr_len = sizeof(addr);
  6432. if (!getsockname(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6433. &addr_len)) {
  6434. get_ip_and_port(addr, addr_len, ip, port);
  6435. }
  6436. }
  6437. inline void get_remote_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6438. struct sockaddr_storage addr;
  6439. socklen_t addr_len = sizeof(addr);
  6440. if (!getpeername(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6441. &addr_len)) {
  6442. #ifndef _WIN32
  6443. if (addr.ss_family == AF_UNIX) {
  6444. #if defined(__linux__)
  6445. struct ucred ucred;
  6446. socklen_t len = sizeof(ucred);
  6447. if (getsockopt(sock, SOL_SOCKET, SO_PEERCRED, &ucred, &len) == 0) {
  6448. port = ucred.pid;
  6449. }
  6450. #elif defined(SOL_LOCAL) && defined(SO_PEERPID)
  6451. pid_t pid;
  6452. socklen_t len = sizeof(pid);
  6453. if (getsockopt(sock, SOL_LOCAL, SO_PEERPID, &pid, &len) == 0) {
  6454. port = pid;
  6455. }
  6456. #endif
  6457. return;
  6458. }
  6459. #endif
  6460. get_ip_and_port(addr, addr_len, ip, port);
  6461. }
  6462. }
  6463. inline std::string
  6464. find_content_type(const std::string &path,
  6465. const std::map<std::string, std::string> &user_data,
  6466. const std::string &default_content_type) {
  6467. auto ext = file_extension(path);
  6468. // Extensions are matched regardless of case, as web servers do, with an
  6469. // exact match to a user mapping first
  6470. auto lower_ext = case_ignore::to_lower(ext);
  6471. auto it = user_data.find(ext);
  6472. if (it == user_data.end()) { it = user_data.find(lower_ext); }
  6473. if (it != user_data.end()) { return it->second; }
  6474. static const struct {
  6475. const char *ext;
  6476. const char *type;
  6477. } types[] = {
  6478. {"css", "text/css"},
  6479. {"csv", "text/csv"},
  6480. {"htm", "text/html"},
  6481. {"html", "text/html"},
  6482. {"js", "text/javascript"},
  6483. {"mjs", "text/javascript"},
  6484. {"txt", "text/plain"},
  6485. {"vtt", "text/vtt"},
  6486. {"apng", "image/apng"},
  6487. {"avif", "image/avif"},
  6488. {"bmp", "image/bmp"},
  6489. {"gif", "image/gif"},
  6490. {"png", "image/png"},
  6491. {"svg", "image/svg+xml"},
  6492. {"webp", "image/webp"},
  6493. {"ico", "image/x-icon"},
  6494. {"tif", "image/tiff"},
  6495. {"tiff", "image/tiff"},
  6496. {"jpg", "image/jpeg"},
  6497. {"jpeg", "image/jpeg"},
  6498. {"mp4", "video/mp4"},
  6499. {"mpeg", "video/mpeg"},
  6500. {"webm", "video/webm"},
  6501. {"mp3", "audio/mp3"},
  6502. {"mpga", "audio/mpeg"},
  6503. {"weba", "audio/webm"},
  6504. {"wav", "audio/wave"},
  6505. {"otf", "font/otf"},
  6506. {"ttf", "font/ttf"},
  6507. {"woff", "font/woff"},
  6508. {"woff2", "font/woff2"},
  6509. {"7z", "application/x-7z-compressed"},
  6510. {"atom", "application/atom+xml"},
  6511. {"pdf", "application/pdf"},
  6512. {"json", "application/json"},
  6513. {"rss", "application/rss+xml"},
  6514. {"tar", "application/x-tar"},
  6515. {"xht", "application/xhtml+xml"},
  6516. {"xhtml", "application/xhtml+xml"},
  6517. {"xslt", "application/xslt+xml"},
  6518. {"xml", "application/xml"},
  6519. {"gz", "application/gzip"},
  6520. {"zip", "application/zip"},
  6521. {"wasm", "application/wasm"},
  6522. };
  6523. for (const auto &t : types) {
  6524. if (lower_ext == t.ext) { return t.type; }
  6525. }
  6526. return default_content_type;
  6527. }
  6528. inline std::string
  6529. extract_media_type(const std::string &content_type,
  6530. std::map<std::string, std::string> *params = nullptr) {
  6531. // Extract type/subtype from Content-Type value (RFC 2045)
  6532. // e.g. "application/json; charset=utf-8" -> "application/json"
  6533. auto media_type = content_type;
  6534. auto semicolon_pos = media_type.find(';');
  6535. if (semicolon_pos != std::string::npos) {
  6536. auto param_str = media_type.substr(semicolon_pos + 1);
  6537. media_type = media_type.substr(0, semicolon_pos);
  6538. if (params) {
  6539. // Parse parameters: key=value pairs separated by ';'
  6540. split_unquoted(param_str.data(), param_str.data() + param_str.size(), ';',
  6541. [&](const char *b, const char *e) {
  6542. std::string key;
  6543. std::string val;
  6544. divide_param_pair(b, e, key, val);
  6545. // Parameter names are case-insensitive (RFC 9110
  6546. // §5.6.6)
  6547. if (!key.empty()) {
  6548. params->emplace(case_ignore::to_lower(trim_copy(key)),
  6549. unquote_param(val));
  6550. }
  6551. });
  6552. }
  6553. }
  6554. // Trim whitespace from media type
  6555. return trim_copy(media_type);
  6556. }
  6557. inline bool can_compress_content_type(const std::string &content_type) {
  6558. // Media types are case-insensitive (RFC 9110 §8.3.1)
  6559. auto mime_type = case_ignore::to_lower(extract_media_type(content_type));
  6560. static const char *const compressible[] = {
  6561. "image/svg+xml",
  6562. "application/javascript",
  6563. "application/x-javascript",
  6564. "application/json",
  6565. "application/ld+json",
  6566. "application/xml",
  6567. "application/xhtml+xml",
  6568. "application/rss+xml",
  6569. "application/atom+xml",
  6570. "application/xslt+xml",
  6571. "application/protobuf",
  6572. };
  6573. for (auto type : compressible) {
  6574. if (mime_type == type) { return true; }
  6575. }
  6576. return mime_type != "text/event-stream" && !mime_type.rfind("text/", 0);
  6577. }
  6578. inline bool parse_quality(const char *b, const char *e, std::string &token,
  6579. double &quality) {
  6580. quality = 1.0;
  6581. token.clear();
  6582. // Split on first ';': left = token name, right = parameters
  6583. const char *params_b = nullptr;
  6584. std::size_t params_len = 0;
  6585. divide(
  6586. b, static_cast<std::size_t>(e - b), ';',
  6587. [&](const char *lb, std::size_t llen, const char *rb, std::size_t rlen) {
  6588. auto r = trim(lb, lb + llen, 0, llen);
  6589. if (r.first < r.second) { token.assign(lb + r.first, lb + r.second); }
  6590. params_b = rb;
  6591. params_len = rlen;
  6592. });
  6593. if (token.empty()) { return false; }
  6594. if (params_len == 0) { return true; }
  6595. // Scan parameters for q= (stops on first match)
  6596. bool invalid = false;
  6597. split_find(params_b, params_b + params_len, ';',
  6598. (std::numeric_limits<size_t>::max)(),
  6599. [&](const char *pb, const char *pe) -> bool {
  6600. // Match exactly "q=" or "Q=" (not "query=" etc.)
  6601. auto len = static_cast<size_t>(pe - pb);
  6602. if (len < 2) { return false; }
  6603. if ((pb[0] != 'q' && pb[0] != 'Q') || pb[1] != '=') {
  6604. return false;
  6605. }
  6606. // Trim the value portion
  6607. auto r = trim(pb, pe, 2, len);
  6608. if (r.first >= r.second) {
  6609. invalid = true;
  6610. return true;
  6611. }
  6612. double v = 0.0;
  6613. auto res = from_chars(pb + r.first, pb + r.second, v);
  6614. if (res.ec != std::errc{} || res.ptr != pb + r.second ||
  6615. v < 0.0 || v > 1.0) {
  6616. invalid = true;
  6617. return true;
  6618. }
  6619. quality = v;
  6620. return true;
  6621. });
  6622. return !invalid;
  6623. }
  6624. inline EncodingType encoding_type(const Request &req,
  6625. const std::string &content_type) {
  6626. if (!can_compress_content_type(content_type)) { return EncodingType::None; }
  6627. auto s = get_combined_header_value(req.headers, "Accept-Encoding");
  6628. if (s.empty()) { return EncodingType::None; }
  6629. // Single-pass: iterate tokens and track the best supported encoding.
  6630. // Server preference breaks ties (br > gzip > zstd).
  6631. EncodingType best = EncodingType::None;
  6632. double best_q = 0.0; // q=0 means "not acceptable"
  6633. // Server preference: Brotli > Gzip > Zstd (lower = more preferred)
  6634. auto priority = [](EncodingType t) -> int {
  6635. switch (t) {
  6636. case EncodingType::Brotli: return 0;
  6637. case EncodingType::Gzip: return 1;
  6638. case EncodingType::Zstd: return 2;
  6639. default: return 3;
  6640. }
  6641. };
  6642. std::string name;
  6643. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  6644. double quality = 1.0;
  6645. if (!parse_quality(b, e, name, quality)) { return; }
  6646. if (quality <= 0.0) { return; }
  6647. EncodingType type = EncodingType::None;
  6648. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6649. if (case_ignore::equal(name, "br")) { type = EncodingType::Brotli; }
  6650. #endif
  6651. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6652. if (type == EncodingType::None && case_ignore::equal(name, "gzip")) {
  6653. type = EncodingType::Gzip;
  6654. }
  6655. #endif
  6656. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6657. if (type == EncodingType::None && case_ignore::equal(name, "zstd")) {
  6658. type = EncodingType::Zstd;
  6659. }
  6660. #endif
  6661. if (type == EncodingType::None) { return; }
  6662. // Higher q-value wins; for equal q, server preference breaks ties
  6663. if (quality > best_q ||
  6664. (quality == best_q && priority(type) < priority(best))) {
  6665. best_q = quality;
  6666. best = type;
  6667. }
  6668. });
  6669. return best;
  6670. }
  6671. // `content_type` is taken separately because a file-backed response has not
  6672. // been given one yet when its coding has to be decided.
  6673. inline EncodingType encoding_type(const Request &req, const Response &res,
  6674. const std::string &content_type) {
  6675. // The response already names a content coding of its own: a handler serving
  6676. // a body it encoded itself (pre-compressed static assets, say), or a mount
  6677. // point whose headers name the coding its files are stored in. Applying one
  6678. // on top of that would double-encode the body and append a second
  6679. // `Content-Encoding` field line.
  6680. if (res.has_header("Content-Encoding")) { return EncodingType::None; }
  6681. return encoding_type(req, content_type);
  6682. }
  6683. inline EncodingType encoding_type(const Request &req, const Response &res) {
  6684. return encoding_type(req, res, res.get_header_value("Content-Type"));
  6685. }
  6686. inline std::unique_ptr<compressor> make_compressor(EncodingType type) {
  6687. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6688. if (type == EncodingType::Gzip) {
  6689. return detail::make_unique<gzip_compressor>();
  6690. }
  6691. #endif
  6692. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6693. if (type == EncodingType::Brotli) {
  6694. return detail::make_unique<brotli_compressor>();
  6695. }
  6696. #endif
  6697. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6698. if (type == EncodingType::Zstd) {
  6699. return detail::make_unique<zstd_compressor>();
  6700. }
  6701. #endif
  6702. (void)type;
  6703. return nullptr;
  6704. }
  6705. inline const char *encoding_name(EncodingType type) {
  6706. switch (type) {
  6707. case EncodingType::Gzip: return "gzip";
  6708. case EncodingType::Brotli: return "br";
  6709. case EncodingType::Zstd: return "zstd";
  6710. default: return "";
  6711. }
  6712. }
  6713. inline bool nocompressor::compress(const char *data, size_t data_length,
  6714. bool /*last*/, Callback callback) {
  6715. if (!data_length) { return true; }
  6716. return callback(data, data_length);
  6717. }
  6718. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6719. inline gzip_compressor::gzip_compressor() {
  6720. std::memset(&strm_, 0, sizeof(strm_));
  6721. strm_.zalloc = Z_NULL;
  6722. strm_.zfree = Z_NULL;
  6723. strm_.opaque = Z_NULL;
  6724. is_valid_ = deflateInit2(&strm_, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 31, 8,
  6725. Z_DEFAULT_STRATEGY) == Z_OK;
  6726. }
  6727. inline gzip_compressor::~gzip_compressor() { deflateEnd(&strm_); }
  6728. inline bool gzip_compressor::compress(const char *data, size_t data_length,
  6729. bool last, Callback callback) {
  6730. assert(is_valid_);
  6731. do {
  6732. constexpr size_t max_avail_in =
  6733. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6734. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6735. (std::min)(data_length, max_avail_in));
  6736. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6737. data_length -= strm_.avail_in;
  6738. data += strm_.avail_in;
  6739. auto flush = (last && data_length == 0) ? Z_FINISH : Z_NO_FLUSH;
  6740. auto ret = Z_OK;
  6741. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6742. do {
  6743. strm_.avail_out = static_cast<uInt>(buff.size());
  6744. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6745. ret = deflate(&strm_, flush);
  6746. if (ret == Z_STREAM_ERROR) { return false; }
  6747. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6748. return false;
  6749. }
  6750. } while (strm_.avail_out == 0);
  6751. assert((flush == Z_FINISH && ret == Z_STREAM_END) ||
  6752. (flush == Z_NO_FLUSH && ret == Z_OK));
  6753. assert(strm_.avail_in == 0);
  6754. } while (data_length > 0);
  6755. return true;
  6756. }
  6757. inline gzip_decompressor::gzip_decompressor() {
  6758. std::memset(&strm_, 0, sizeof(strm_));
  6759. strm_.zalloc = Z_NULL;
  6760. strm_.zfree = Z_NULL;
  6761. strm_.opaque = Z_NULL;
  6762. // 15 is the value of wbits, which should be at the maximum possible value
  6763. // to ensure that any gzip stream can be decoded. The offset of 32 specifies
  6764. // that the stream type should be automatically detected either gzip or
  6765. // deflate.
  6766. is_valid_ = inflateInit2(&strm_, 32 + 15) == Z_OK;
  6767. }
  6768. inline gzip_decompressor::~gzip_decompressor() { inflateEnd(&strm_); }
  6769. inline bool gzip_decompressor::is_valid() const { return is_valid_; }
  6770. inline bool gzip_decompressor::decompress(const char *data, size_t data_length,
  6771. Callback callback) {
  6772. assert(is_valid_);
  6773. auto ret = Z_OK;
  6774. do {
  6775. constexpr size_t max_avail_in =
  6776. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6777. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6778. (std::min)(data_length, max_avail_in));
  6779. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6780. data_length -= strm_.avail_in;
  6781. data += strm_.avail_in;
  6782. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6783. while (strm_.avail_in > 0 && ret == Z_OK) {
  6784. strm_.avail_out = static_cast<uInt>(buff.size());
  6785. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6786. ret = inflate(&strm_, Z_NO_FLUSH);
  6787. assert(ret != Z_STREAM_ERROR);
  6788. switch (ret) {
  6789. case Z_NEED_DICT:
  6790. case Z_DATA_ERROR:
  6791. case Z_MEM_ERROR: inflateEnd(&strm_); return false;
  6792. }
  6793. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6794. return false;
  6795. }
  6796. }
  6797. if (ret != Z_OK && ret != Z_STREAM_END) { return false; }
  6798. } while (data_length > 0);
  6799. return true;
  6800. }
  6801. #endif
  6802. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6803. inline brotli_compressor::brotli_compressor() {
  6804. state_ = BrotliEncoderCreateInstance(nullptr, nullptr, nullptr);
  6805. }
  6806. inline brotli_compressor::~brotli_compressor() {
  6807. BrotliEncoderDestroyInstance(state_);
  6808. }
  6809. inline bool brotli_compressor::compress(const char *data, size_t data_length,
  6810. bool last, Callback callback) {
  6811. std::array<uint8_t, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6812. auto operation = last ? BROTLI_OPERATION_FINISH : BROTLI_OPERATION_PROCESS;
  6813. auto available_in = data_length;
  6814. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6815. for (;;) {
  6816. if (last) {
  6817. if (BrotliEncoderIsFinished(state_)) { break; }
  6818. } else {
  6819. if (!available_in) { break; }
  6820. }
  6821. auto available_out = buff.size();
  6822. auto next_out = buff.data();
  6823. if (!BrotliEncoderCompressStream(state_, operation, &available_in, &next_in,
  6824. &available_out, &next_out, nullptr)) {
  6825. return false;
  6826. }
  6827. auto output_bytes = buff.size() - available_out;
  6828. if (output_bytes) {
  6829. callback(reinterpret_cast<const char *>(buff.data()), output_bytes);
  6830. }
  6831. }
  6832. return true;
  6833. }
  6834. inline brotli_decompressor::brotli_decompressor() {
  6835. decoder_s = BrotliDecoderCreateInstance(0, 0, 0);
  6836. decoder_r = decoder_s ? BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT
  6837. : BROTLI_DECODER_RESULT_ERROR;
  6838. }
  6839. inline brotli_decompressor::~brotli_decompressor() {
  6840. if (decoder_s) { BrotliDecoderDestroyInstance(decoder_s); }
  6841. }
  6842. inline bool brotli_decompressor::is_valid() const { return decoder_s; }
  6843. inline bool brotli_decompressor::decompress(const char *data,
  6844. size_t data_length,
  6845. Callback callback) {
  6846. if (decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6847. decoder_r == BROTLI_DECODER_RESULT_ERROR) {
  6848. return 0;
  6849. }
  6850. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6851. size_t avail_in = data_length;
  6852. size_t total_out;
  6853. decoder_r = BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT;
  6854. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6855. while (decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT) {
  6856. char *next_out = buff.data();
  6857. size_t avail_out = buff.size();
  6858. decoder_r = BrotliDecoderDecompressStream(
  6859. decoder_s, &avail_in, &next_in, &avail_out,
  6860. reinterpret_cast<uint8_t **>(&next_out), &total_out);
  6861. if (decoder_r == BROTLI_DECODER_RESULT_ERROR) { return false; }
  6862. if (!callback(buff.data(), buff.size() - avail_out)) { return false; }
  6863. }
  6864. return decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6865. decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT;
  6866. }
  6867. #endif
  6868. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6869. inline zstd_compressor::zstd_compressor() {
  6870. ctx_ = ZSTD_createCCtx();
  6871. ZSTD_CCtx_setParameter(ctx_, ZSTD_c_compressionLevel, ZSTD_fast);
  6872. }
  6873. inline zstd_compressor::~zstd_compressor() { ZSTD_freeCCtx(ctx_); }
  6874. inline bool zstd_compressor::compress(const char *data, size_t data_length,
  6875. bool last, Callback callback) {
  6876. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6877. ZSTD_EndDirective mode = last ? ZSTD_e_end : ZSTD_e_continue;
  6878. ZSTD_inBuffer input = {data, data_length, 0};
  6879. bool finished;
  6880. do {
  6881. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6882. size_t const remaining = ZSTD_compressStream2(ctx_, &output, &input, mode);
  6883. if (ZSTD_isError(remaining)) { return false; }
  6884. if (!callback(buff.data(), output.pos)) { return false; }
  6885. finished = last ? (remaining == 0) : (input.pos == input.size);
  6886. } while (!finished);
  6887. return true;
  6888. }
  6889. inline zstd_decompressor::zstd_decompressor() { ctx_ = ZSTD_createDCtx(); }
  6890. inline zstd_decompressor::~zstd_decompressor() { ZSTD_freeDCtx(ctx_); }
  6891. inline bool zstd_decompressor::is_valid() const { return ctx_ != nullptr; }
  6892. inline bool zstd_decompressor::decompress(const char *data, size_t data_length,
  6893. Callback callback) {
  6894. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6895. ZSTD_inBuffer input = {data, data_length, 0};
  6896. while (input.pos < input.size) {
  6897. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6898. size_t const remaining = ZSTD_decompressStream(ctx_, &output, &input);
  6899. if (ZSTD_isError(remaining)) { return false; }
  6900. if (!callback(buff.data(), output.pos)) { return false; }
  6901. }
  6902. return true;
  6903. }
  6904. #endif
  6905. // Content codings are case-insensitive (RFC 9110 8.4.1). Matching them
  6906. // case-sensitively would make a response labeled e.g. "GZIP" look like an
  6907. // unknown coding, and its payload would be handed back still compressed.
  6908. inline bool is_zlib_encoding(const std::string &encoding) {
  6909. return case_ignore::equal(encoding, "gzip") ||
  6910. case_ignore::equal(encoding, "deflate");
  6911. }
  6912. inline bool is_brotli_encoding(const std::string &encoding) {
  6913. return case_ignore::equal(encoding, "br");
  6914. }
  6915. inline bool is_zstd_encoding(const std::string &encoding) {
  6916. return case_ignore::equal(encoding, "zstd");
  6917. }
  6918. // Returns true if the content coding is one cpp-httplib is able to decompress
  6919. // when the corresponding support is compiled in.
  6920. inline bool is_known_content_encoding(const std::string &encoding) {
  6921. return is_zlib_encoding(encoding) || is_brotli_encoding(encoding) ||
  6922. is_zstd_encoding(encoding);
  6923. }
  6924. inline std::unique_ptr<decompressor>
  6925. create_decompressor(const std::string &encoding) {
  6926. std::unique_ptr<decompressor> decompressor;
  6927. if (is_zlib_encoding(encoding)) {
  6928. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6929. decompressor = detail::make_unique<gzip_decompressor>();
  6930. #endif
  6931. } else if (is_brotli_encoding(encoding)) {
  6932. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6933. decompressor = detail::make_unique<brotli_decompressor>();
  6934. #endif
  6935. } else if (is_zstd_encoding(encoding)) {
  6936. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6937. decompressor = detail::make_unique<zstd_decompressor>();
  6938. #endif
  6939. }
  6940. return decompressor;
  6941. }
  6942. // Returns the best available compressor and its Content-Encoding name.
  6943. // Priority: Brotli > Gzip > Zstd (matches server-side preference).
  6944. inline std::pair<std::unique_ptr<compressor>, const char *>
  6945. create_compressor() {
  6946. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6947. return {detail::make_unique<brotli_compressor>(), "br"};
  6948. #elif defined(CPPHTTPLIB_ZLIB_SUPPORT)
  6949. return {detail::make_unique<gzip_compressor>(), "gzip"};
  6950. #elif defined(CPPHTTPLIB_ZSTD_SUPPORT)
  6951. return {detail::make_unique<zstd_compressor>(), "zstd"};
  6952. #else
  6953. return {nullptr, nullptr};
  6954. #endif
  6955. }
  6956. inline bool is_prohibited_header_name(const std::string &name) {
  6957. // Field names are case-insensitive (RFC 9110 §5.1)
  6958. return case_ignore::equal(name, "REMOTE_ADDR") ||
  6959. case_ignore::equal(name, "REMOTE_PORT") ||
  6960. case_ignore::equal(name, "LOCAL_ADDR") ||
  6961. case_ignore::equal(name, "LOCAL_PORT");
  6962. }
  6963. inline bool has_header(const Headers &headers, const std::string &key) {
  6964. if (is_prohibited_header_name(key)) { return false; }
  6965. return headers.find(key) != headers.end();
  6966. }
  6967. inline const char *get_header_value(const Headers &headers,
  6968. const std::string &key, const char *def,
  6969. size_t id) {
  6970. if (is_prohibited_header_name(key)) {
  6971. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  6972. std::string msg = "Prohibited header name '" + key + "' is specified.";
  6973. throw std::invalid_argument(msg);
  6974. #else
  6975. return "";
  6976. #endif
  6977. }
  6978. auto rng = headers.equal_range(key);
  6979. auto it = bounded_next(rng.first, id, rng.second);
  6980. if (it != rng.second) { return it->second.c_str(); }
  6981. return def;
  6982. }
  6983. inline size_t get_header_value_count(const Headers &headers,
  6984. const std::string &key) {
  6985. return headers.count(key);
  6986. }
  6987. // RFC 9110 Section 5.2 and 5.3: a field that is defined as a comma-separated
  6988. // list may be sent as several field lines, and the combined field value is
  6989. // those values joined by commas in the order they were received. Callers that
  6990. // parse such a list must work on the combined value; reading only the first
  6991. // occurrence silently drops whatever the later field lines carry.
  6992. inline std::string get_combined_header_value(const Headers &headers,
  6993. const std::string &key) {
  6994. std::string combined;
  6995. auto rng = headers.equal_range(key);
  6996. for (auto it = rng.first; it != rng.second; ++it) {
  6997. // RFC 9110 Section 5.6.1.2: a recipient has to parse and ignore empty list
  6998. // elements, so an empty field line must not contribute a bare comma to the
  6999. // combined value.
  7000. if (it->second.empty()) { continue; }
  7001. if (!combined.empty()) { combined += ", "; }
  7002. combined += it->second;
  7003. }
  7004. return combined;
  7005. }
  7006. inline bool has_header_token(const Headers &headers, const std::string &key,
  7007. const std::string &token) {
  7008. // RFC 9110 7.6.1: a comma-separated token list field such as Connection may
  7009. // carry several tokens, and RFC 9110 5.3 lets that list be split across
  7010. // several lines. Match complete tokens rather than searching the raw value,
  7011. // so that a value such as "notupgrade" is not read as the token "upgrade".
  7012. auto rng = headers.equal_range(key);
  7013. for (auto it = rng.first; it != rng.second; ++it) {
  7014. const auto &value = it->second;
  7015. if (split_find(value.data(), value.data() + value.size(), ',',
  7016. [&](const char *b, const char *e) {
  7017. return case_ignore::equal(std::string(b, e), token);
  7018. })) {
  7019. return true;
  7020. }
  7021. }
  7022. return false;
  7023. }
  7024. template <typename Map>
  7025. inline typename Map::mapped_type
  7026. get_multimap_value(const Map &m, const std::string &key, size_t id) {
  7027. auto rng = m.equal_range(key);
  7028. auto it = bounded_next(rng.first, id, rng.second);
  7029. if (it != rng.second) { return it->second; }
  7030. return typename Map::mapped_type();
  7031. }
  7032. inline void set_header(Headers &headers, const std::string &key,
  7033. const std::string &val) {
  7034. if (fields::is_field_valid(key, val)) { headers.emplace(key, val); }
  7035. }
  7036. inline bool read_headers(Stream &strm, Headers &headers) {
  7037. const auto bufsiz = 2048;
  7038. char buf[bufsiz];
  7039. stream_line_reader line_reader(strm, buf, bufsiz);
  7040. size_t header_count = 0;
  7041. for (;;) {
  7042. if (!line_reader.getline()) { return false; }
  7043. // Check if the line ends with CRLF.
  7044. auto line_terminator_len = 2;
  7045. if (line_reader.end_with_crlf()) {
  7046. // Blank line indicates end of headers.
  7047. if (line_reader.size() == 2) { break; }
  7048. } else {
  7049. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  7050. // Blank line indicates end of headers.
  7051. if (line_reader.size() == 1) { break; }
  7052. line_terminator_len = 1;
  7053. #else
  7054. continue; // Skip invalid line.
  7055. #endif
  7056. }
  7057. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  7058. // Check header count limit
  7059. if (header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  7060. // Exclude line terminator
  7061. auto end = line_reader.ptr() + line_reader.size() - line_terminator_len;
  7062. if (!parse_header(line_reader.ptr(), end,
  7063. [&](const std::string &key, const std::string &val) {
  7064. headers.emplace(key, val);
  7065. })) {
  7066. return false;
  7067. }
  7068. header_count++;
  7069. }
  7070. // RFC 9110 Section 8.6: Reject requests with multiple Content-Length
  7071. // headers that have different values to prevent request smuggling.
  7072. auto cl_range = headers.equal_range("Content-Length");
  7073. if (cl_range.first != cl_range.second) {
  7074. const auto &first_val = cl_range.first->second;
  7075. for (auto it = std::next(cl_range.first); it != cl_range.second; ++it) {
  7076. if (it->second != first_val) { return false; }
  7077. }
  7078. }
  7079. return true;
  7080. }
  7081. // Parsed by hand: std::regex_match recurses once per character of the reason
  7082. // phrase, which a server can make as long as a whole line.
  7083. inline bool parse_status_line(const char *line, std::string &version,
  7084. int &status, std::string &reason) {
  7085. if (std::strncmp(line, "HTTP/1.", 7) != 0 ||
  7086. (line[7] != '0' && line[7] != '1') || line[8] != ' ' ||
  7087. !is_ascii_digit(line[9]) || !is_ascii_digit(line[10]) ||
  7088. !is_ascii_digit(line[11])) {
  7089. return false;
  7090. }
  7091. auto p = line + 12;
  7092. auto reason_begin = p;
  7093. if (*p == ' ') {
  7094. reason_begin = ++p;
  7095. p += std::strcspn(p, "\r\n");
  7096. }
  7097. auto reason_end = p;
  7098. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  7099. if (*p == '\r') { p++; }
  7100. #else
  7101. if (*p++ != '\r') { return false; }
  7102. #endif
  7103. if (*p++ != '\n' || *p != '\0') { return false; }
  7104. version.assign(line, 8);
  7105. status = (line[9] - '0') * 100 + (line[10] - '0') * 10 + (line[11] - '0');
  7106. reason.assign(reason_begin, reason_end);
  7107. return true;
  7108. }
  7109. // Everything WebSocketClient::connect() reports about the upgrade exchange.
  7110. // status stays -1 until a status line is parsed, mirroring stream::Result.
  7111. struct WebSocketUpgradeResponse {
  7112. Error error = Error::Success;
  7113. int status = -1;
  7114. Headers headers;
  7115. std::string selected_subprotocol;
  7116. };
  7117. // Reads a response's status line and headers, leaving any body unread. An
  7118. // unparsable status line is no stream error; it just leaves `status` as is.
  7119. inline bool read_response_head(Stream &strm, int &status, Headers &headers) {
  7120. const auto bufsiz = 2048;
  7121. char buf[bufsiz];
  7122. stream_line_reader line_reader(strm, buf, bufsiz);
  7123. if (!line_reader.getline()) { return false; }
  7124. std::string version;
  7125. std::string reason;
  7126. if (!parse_status_line(line_reader.ptr(), version, status, reason)) {
  7127. return true;
  7128. }
  7129. return read_headers(strm, headers);
  7130. }
  7131. inline bool
  7132. read_websocket_upgrade_response(Stream &strm,
  7133. const std::string &expected_accept,
  7134. const std::string &offered_subprotocols,
  7135. WebSocketUpgradeResponse &upgrade) {
  7136. // The headers of a rejection are kept so the caller can see why the server
  7137. // refused the upgrade.
  7138. if (!read_response_head(strm, upgrade.status, upgrade.headers)) {
  7139. upgrade.error = Error::Read;
  7140. return false;
  7141. }
  7142. const auto &headers = upgrade.headers;
  7143. if (upgrade.status != StatusCode::SwitchingProtocol_101) {
  7144. upgrade.error = Error::WebSocketHandshake;
  7145. return false;
  7146. }
  7147. // Verify Upgrade: websocket (a comma-separated list, matched per token)
  7148. if (!has_header_token(headers, "Upgrade", "websocket")) {
  7149. upgrade.error = Error::WebSocketHandshake;
  7150. return false;
  7151. }
  7152. // Verify Connection: Upgrade
  7153. if (!has_header_token(headers, "Connection", "upgrade")) {
  7154. upgrade.error = Error::WebSocketHandshake;
  7155. return false;
  7156. }
  7157. // Verify Sec-WebSocket-Accept header value
  7158. auto it = headers.find("Sec-WebSocket-Accept");
  7159. if (it == headers.end() || it->second != expected_accept) {
  7160. upgrade.error = Error::WebSocketHandshake;
  7161. return false;
  7162. }
  7163. // Extract negotiated subprotocol
  7164. auto proto_it = headers.find("Sec-WebSocket-Protocol");
  7165. if (proto_it != headers.end()) {
  7166. upgrade.selected_subprotocol = proto_it->second;
  7167. }
  7168. // Verify the subprotocol is one the client offered (RFC 6455 4.1)
  7169. if (!upgrade.selected_subprotocol.empty()) {
  7170. auto was_offered = false;
  7171. split(offered_subprotocols.data(),
  7172. offered_subprotocols.data() + offered_subprotocols.size(), ',',
  7173. [&](const char *b, const char *e) {
  7174. if (std::string(b, e) == upgrade.selected_subprotocol) {
  7175. was_offered = true;
  7176. }
  7177. });
  7178. if (!was_offered) {
  7179. upgrade.error = Error::WebSocketHandshake;
  7180. return false;
  7181. }
  7182. }
  7183. return true;
  7184. }
  7185. enum class ReadContentResult {
  7186. Success, // Successfully read the content
  7187. PayloadTooLarge, // The content exceeds the specified payload limit
  7188. Error // An error occurred while reading the content
  7189. };
  7190. inline ReadContentResult read_content_with_length(
  7191. Stream &strm, size_t len, DownloadProgress progress,
  7192. ContentReceiverWithProgress out,
  7193. size_t payload_max_length = (std::numeric_limits<size_t>::max)()) {
  7194. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7195. detail::BodyReader br;
  7196. br.stream = &strm;
  7197. br.has_content_length = true;
  7198. br.content_length = len;
  7199. br.payload_max_length = payload_max_length;
  7200. br.chunked = false;
  7201. br.bytes_read = 0;
  7202. br.last_error = Error::Success;
  7203. size_t r = 0;
  7204. while (r < len) {
  7205. auto read_len = static_cast<size_t>(len - r);
  7206. auto to_read = (std::min)(read_len, CPPHTTPLIB_RECV_BUFSIZ);
  7207. auto n = detail::read_body_content(&strm, br, buf, to_read);
  7208. if (n <= 0) {
  7209. // Check if it was a payload size error
  7210. if (br.last_error == Error::ExceedMaxPayloadSize) {
  7211. return ReadContentResult::PayloadTooLarge;
  7212. }
  7213. return ReadContentResult::Error;
  7214. }
  7215. if (!out(buf, static_cast<size_t>(n), r, len)) {
  7216. return ReadContentResult::Error;
  7217. }
  7218. r += static_cast<size_t>(n);
  7219. if (progress) {
  7220. if (!progress(r, len)) { return ReadContentResult::Error; }
  7221. }
  7222. }
  7223. return ReadContentResult::Success;
  7224. }
  7225. inline ReadContentResult
  7226. read_content_without_length(Stream &strm, size_t payload_max_length,
  7227. ContentReceiverWithProgress out) {
  7228. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7229. size_t r = 0;
  7230. for (;;) {
  7231. auto n = strm.read(buf, CPPHTTPLIB_RECV_BUFSIZ);
  7232. if (n == 0) { return ReadContentResult::Success; }
  7233. if (n < 0) { return ReadContentResult::Error; }
  7234. // Check if adding this data would exceed the payload limit
  7235. if (payload_max_length > 0 &&
  7236. (r > payload_max_length ||
  7237. payload_max_length - r < static_cast<size_t>(n))) {
  7238. return ReadContentResult::PayloadTooLarge;
  7239. }
  7240. if (!out(buf, static_cast<size_t>(n), r, 0)) {
  7241. return ReadContentResult::Error;
  7242. }
  7243. r += static_cast<size_t>(n);
  7244. }
  7245. return ReadContentResult::Success;
  7246. }
  7247. template <typename T>
  7248. inline ReadContentResult read_content_chunked(Stream &strm, T &x,
  7249. size_t payload_max_length,
  7250. ContentReceiverWithProgress out) {
  7251. detail::ChunkedDecoder dec(strm);
  7252. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7253. size_t total_len = 0;
  7254. for (;;) {
  7255. size_t chunk_offset = 0;
  7256. size_t chunk_total = 0;
  7257. auto n = dec.read_payload(buf, sizeof(buf), chunk_offset, chunk_total);
  7258. if (n < 0) { return ReadContentResult::Error; }
  7259. if (n == 0) {
  7260. if (!dec.parse_trailers_into(x.trailers, x.headers)) {
  7261. return ReadContentResult::Error;
  7262. }
  7263. return ReadContentResult::Success;
  7264. }
  7265. if (payload_max_length > 0 &&
  7266. (total_len > payload_max_length ||
  7267. payload_max_length - total_len < static_cast<size_t>(n))) {
  7268. return ReadContentResult::PayloadTooLarge;
  7269. }
  7270. if (!out(buf, static_cast<size_t>(n), chunk_offset, chunk_total)) {
  7271. return ReadContentResult::Error;
  7272. }
  7273. total_len += static_cast<size_t>(n);
  7274. }
  7275. }
  7276. inline bool is_chunked_transfer_encoding(const Headers &headers) {
  7277. // RFC 9112 6.1: a message is framed with the chunked coding when "chunked"
  7278. // is the final transfer coding. A single field value may list several
  7279. // codings ("gzip, chunked"), and RFC 9110 5.3 lets that list be split across
  7280. // several Transfer-Encoding lines, which combine into one comma-separated
  7281. // list in the order the lines were received. Headers preserves that order,
  7282. // so the final coding is the last token of the last line. Match it
  7283. // case-insensitively rather than comparing the whole value against
  7284. // "chunked".
  7285. //
  7286. // Security: reading a chunked message as unframed leaves its body in the
  7287. // socket, where a keep-alive connection parses it as a smuggled request.
  7288. // Server::process_request() answers 400 and closes when the final coding is
  7289. // not chunked, so a request whose framing cannot be determined never
  7290. // reaches the "no body" path.
  7291. auto rng = headers.equal_range("Transfer-Encoding");
  7292. if (rng.first == rng.second) { return false; }
  7293. // Cleared per line, so a trailing line carrying no coding at all leaves the
  7294. // combined list ending in nothing rather than inheriting the line before it.
  7295. std::string last_coding;
  7296. for (auto it = rng.first; it != rng.second; ++it) {
  7297. const auto &value = it->second;
  7298. last_coding.clear();
  7299. split(value.data(), value.data() + value.size(), ',',
  7300. [&](const char *b, const char *e) { last_coding.assign(b, e); });
  7301. }
  7302. return case_ignore::equal(last_coding, "chunked");
  7303. }
  7304. // RFC 9112 6.1: a message framed by Transfer-Encoding next to a Content-Length,
  7305. // or in HTTP/1.0, leaves the connection unfit to carry another one.
  7306. template <typename T> inline bool has_faulty_transfer_encoding(const T &msg) {
  7307. return msg.has_header("Transfer-Encoding") &&
  7308. (msg.has_header("Content-Length") || msg.version == "HTTP/1.0");
  7309. }
  7310. inline bool has_conflicting_content_length(const Headers &headers) {
  7311. // RFC 9112 §6.3: a message carrying both Transfer-Encoding and a non-zero
  7312. // Content-Length is framed ambiguously. The body readers here delimit it by
  7313. // the transfer coding and drop Content-Length, while an intermediary may do
  7314. // the reverse, so the two disagree on where the body ends and a reused
  7315. // connection is desynchronised (request/response smuggling). Content-Length:
  7316. // 0 is tolerated for compatibility with existing peers.
  7317. return has_header(headers, "Transfer-Encoding") &&
  7318. get_header_value_u64(headers, "Content-Length", 0, 0) > 0;
  7319. }
  7320. template <typename T, typename U>
  7321. bool prepare_content_receiver(T &x, int &status,
  7322. ContentReceiverWithProgress receiver,
  7323. bool decompress, size_t payload_max_length,
  7324. bool &exceed_payload_max_length, U callback) {
  7325. if (decompress) {
  7326. auto encoding = get_combined_header_value(x.headers, "Content-Encoding");
  7327. std::unique_ptr<decompressor> decompressor;
  7328. if (!encoding.empty()) {
  7329. // A coding we know about but were not built with is an error. An
  7330. // unrecognized coding (including "identity") is left alone and the
  7331. // payload is passed through as-is, since some servers misuse the header,
  7332. // e.g. by sending a character set such as "Content-Encoding: UTF-8".
  7333. decompressor = detail::create_decompressor(encoding);
  7334. if (!decompressor && detail::is_known_content_encoding(encoding)) {
  7335. status = StatusCode::UnsupportedMediaType_415;
  7336. return false;
  7337. }
  7338. }
  7339. if (decompressor) {
  7340. if (decompressor->is_valid()) {
  7341. size_t decompressed_size = 0;
  7342. ContentReceiverWithProgress out = [&](const char *buf, size_t n,
  7343. size_t off, size_t len) {
  7344. return decompressor->decompress(
  7345. buf, n, [&](const char *buf2, size_t n2) {
  7346. // Guard against zip-bomb: check
  7347. // decompressed size against limit.
  7348. if (payload_max_length > 0 &&
  7349. (decompressed_size >= payload_max_length ||
  7350. n2 > payload_max_length - decompressed_size)) {
  7351. exceed_payload_max_length = true;
  7352. return false;
  7353. }
  7354. decompressed_size += n2;
  7355. return receiver(buf2, n2, off, len);
  7356. });
  7357. };
  7358. return callback(std::move(out));
  7359. } else {
  7360. status = StatusCode::InternalServerError_500;
  7361. return false;
  7362. }
  7363. }
  7364. }
  7365. ContentReceiverWithProgress out = [&](const char *buf, size_t n, size_t off,
  7366. size_t len) {
  7367. return receiver(buf, n, off, len);
  7368. };
  7369. return callback(std::move(out));
  7370. }
  7371. template <typename T>
  7372. bool read_content(Stream &strm, T &x, size_t payload_max_length, int &status,
  7373. DownloadProgress progress,
  7374. ContentReceiverWithProgress receiver, bool decompress) {
  7375. bool exceed_payload_max_length = false;
  7376. return prepare_content_receiver(
  7377. x, status, std::move(receiver), decompress, payload_max_length,
  7378. exceed_payload_max_length, [&](const ContentReceiverWithProgress &out) {
  7379. auto ret = true;
  7380. // Note: exceed_payload_max_length may also be set by the decompressor
  7381. // wrapper in prepare_content_receiver when the decompressed payload
  7382. // size exceeds the limit.
  7383. if (is_chunked_transfer_encoding(x.headers)) {
  7384. auto result = read_content_chunked(strm, x, payload_max_length, out);
  7385. if (result == ReadContentResult::Success) {
  7386. ret = true;
  7387. } else if (result == ReadContentResult::PayloadTooLarge) {
  7388. exceed_payload_max_length = true;
  7389. ret = false;
  7390. } else {
  7391. ret = false;
  7392. }
  7393. } else if (!has_header(x.headers, "Content-Length")) {
  7394. auto result =
  7395. read_content_without_length(strm, payload_max_length, out);
  7396. if (result == ReadContentResult::Success) {
  7397. ret = true;
  7398. } else if (result == ReadContentResult::PayloadTooLarge) {
  7399. exceed_payload_max_length = true;
  7400. ret = false;
  7401. } else {
  7402. ret = false;
  7403. }
  7404. } else {
  7405. auto is_invalid_value = false;
  7406. auto len = get_header_value_u64(x.headers, "Content-Length",
  7407. (std::numeric_limits<size_t>::max)(),
  7408. 0, is_invalid_value);
  7409. if (is_invalid_value) {
  7410. ret = false;
  7411. } else if (len > 0) {
  7412. auto result = read_content_with_length(
  7413. strm, len, std::move(progress), out, payload_max_length);
  7414. ret = (result == ReadContentResult::Success);
  7415. if (result == ReadContentResult::PayloadTooLarge) {
  7416. exceed_payload_max_length = true;
  7417. }
  7418. }
  7419. }
  7420. if (!ret) {
  7421. status = exceed_payload_max_length ? StatusCode::PayloadTooLarge_413
  7422. : StatusCode::BadRequest_400;
  7423. }
  7424. return ret;
  7425. });
  7426. }
  7427. inline ssize_t write_request_line(Stream &strm, const std::string &method,
  7428. const std::string &path) {
  7429. // Neither the method nor the request target may carry CR/LF, SP or other
  7430. // control octets; otherwise a value smuggled into either splits the request
  7431. // line and injects headers or a whole request.
  7432. if (!fields::is_token(method)) { return -1; }
  7433. if (!fields::is_request_target(path)) { return -1; }
  7434. std::string s = method;
  7435. s += ' ';
  7436. s += path;
  7437. s += " HTTP/1.1\r\n";
  7438. return strm.write(s.data(), s.size());
  7439. }
  7440. inline ssize_t write_response_line(Stream &strm, int status) {
  7441. std::string s = "HTTP/1.1 ";
  7442. s += std::to_string(status);
  7443. s += ' ';
  7444. s += httplib::status_message(status);
  7445. s += "\r\n";
  7446. return strm.write(s.data(), s.size());
  7447. }
  7448. inline ssize_t write_headers(Stream &strm, const Headers &headers) {
  7449. ssize_t write_len = 0;
  7450. for (const auto &x : headers) {
  7451. // Skip fields with invalid names or values to prevent response splitting
  7452. // via CR/LF injection, matching set_header(). The client validates request
  7453. // headers up front in check_and_write_headers, but the server passes
  7454. // res.headers straight to this writer, and res.headers is a public field
  7455. // an application can populate directly with request-derived values.
  7456. if (!fields::is_field_valid(x.first, x.second)) { continue; }
  7457. std::string s;
  7458. s = x.first;
  7459. s += ": ";
  7460. s += x.second;
  7461. s += "\r\n";
  7462. auto len = strm.write(s.data(), s.size());
  7463. if (len < 0) { return len; }
  7464. write_len += len;
  7465. }
  7466. auto len = strm.write("\r\n");
  7467. if (len < 0) { return len; }
  7468. write_len += len;
  7469. return write_len;
  7470. }
  7471. inline bool write_data(Stream &strm, const char *d, size_t l) {
  7472. size_t offset = 0;
  7473. while (offset < l) {
  7474. auto length = strm.write(d + offset, l - offset);
  7475. if (length < 0) { return false; }
  7476. offset += static_cast<size_t>(length);
  7477. }
  7478. return true;
  7479. }
  7480. template <typename T>
  7481. inline bool write_content_with_progress(Stream &strm,
  7482. const ContentProvider &content_provider,
  7483. size_t offset, size_t length,
  7484. T is_shutting_down,
  7485. const UploadProgress &upload_progress,
  7486. Error &error) {
  7487. size_t end_offset = offset + length;
  7488. size_t start_offset = offset;
  7489. auto ok = true;
  7490. auto finished = false;
  7491. DataSink data_sink;
  7492. data_sink.write = [&](const char *d, size_t l) -> bool {
  7493. if (ok) {
  7494. // Bytes past `length` would follow the framed body, where the peer reads
  7495. // them as the next message. Write only what fits and fail the rest.
  7496. if (l > end_offset - offset) {
  7497. l = end_offset - offset;
  7498. ok = false;
  7499. }
  7500. if (write_data(strm, d, l)) {
  7501. offset += l;
  7502. if (upload_progress && length > 0) {
  7503. size_t current_written = offset - start_offset;
  7504. if (!upload_progress(current_written, length)) {
  7505. ok = false;
  7506. return false;
  7507. }
  7508. }
  7509. } else {
  7510. ok = false;
  7511. }
  7512. }
  7513. return ok;
  7514. };
  7515. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7516. // The body is framed by `length`, so a provider that reports itself done
  7517. // early has truncated it. Record that and let the short-body check below
  7518. // fail the write, rather than calling the provider again forever.
  7519. data_sink.done = [&]() { finished = true; };
  7520. while (offset < end_offset && !finished && !is_shutting_down()) {
  7521. auto last_offset = offset;
  7522. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7523. error = Error::Write;
  7524. return false;
  7525. } else if (!content_provider(offset, end_offset - offset, data_sink)) {
  7526. error = Error::Canceled;
  7527. return false;
  7528. } else if (!ok) {
  7529. error = Error::Write;
  7530. return false;
  7531. }
  7532. // A provider that reports success without writing anything and without
  7533. // reporting itself done gets handed the same offset and length again on
  7534. // the next pass, so it would spin here for as long as the peer stays
  7535. // connected. Treat making no progress as a short body, like done() early.
  7536. if (!finished && offset == last_offset) {
  7537. error = Error::Write;
  7538. return false;
  7539. }
  7540. }
  7541. if (offset < end_offset) { // done() called early, or is_shutting_down()
  7542. error = Error::Write;
  7543. return false;
  7544. }
  7545. error = Error::Success;
  7546. return true;
  7547. }
  7548. template <typename T>
  7549. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7550. size_t offset, size_t length, T is_shutting_down,
  7551. Error &error) {
  7552. return write_content_with_progress<T>(strm, content_provider, offset, length,
  7553. is_shutting_down, nullptr, error);
  7554. }
  7555. template <typename T>
  7556. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7557. size_t offset, size_t length,
  7558. const T &is_shutting_down) {
  7559. auto error = Error::Success;
  7560. return write_content(strm, content_provider, offset, length, is_shutting_down,
  7561. error);
  7562. }
  7563. template <typename T>
  7564. inline bool
  7565. write_content_without_length(Stream &strm,
  7566. const ContentProvider &content_provider,
  7567. const T &is_shutting_down) {
  7568. size_t offset = 0;
  7569. auto data_available = true;
  7570. auto ok = true;
  7571. DataSink data_sink;
  7572. data_sink.write = [&](const char *d, size_t l) -> bool {
  7573. if (ok) {
  7574. offset += l;
  7575. if (!write_data(strm, d, l)) { ok = false; }
  7576. }
  7577. return ok;
  7578. };
  7579. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7580. data_sink.done = [&](void) { data_available = false; };
  7581. while (data_available && !is_shutting_down()) {
  7582. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7583. return false;
  7584. } else if (!content_provider(offset, 0, data_sink)) {
  7585. return false;
  7586. } else if (!ok) {
  7587. return false;
  7588. }
  7589. }
  7590. return !data_available; // true only if done() was called, false if shutting
  7591. // down
  7592. }
  7593. // Runs a known-length content provider to completion and compresses what it
  7594. // writes into `out`, chunk by chunk, without holding the identity form.
  7595. inline bool compress_content_provider(const ContentProvider &content_provider,
  7596. size_t length, compressor &cmp,
  7597. std::string &out) {
  7598. size_t offset = 0;
  7599. auto ok = true;
  7600. auto finished = false;
  7601. DataSink data_sink;
  7602. auto append = [&](const char *data, size_t data_len) {
  7603. out.append(data, data_len);
  7604. return true;
  7605. };
  7606. data_sink.write = [&](const char *d, size_t l) -> bool {
  7607. if (!ok) { return false; }
  7608. offset += l;
  7609. if (l > 0 && !cmp.compress(d, l, false, append)) { ok = false; }
  7610. return ok;
  7611. };
  7612. // The body is framed by `length`, so a provider that reports itself done
  7613. // early has truncated it; the short-body check below turns that into a
  7614. // failure rather than calling the provider again forever.
  7615. data_sink.done = [&]() { finished = true; };
  7616. while (offset < length && !finished) {
  7617. auto prev_offset = offset;
  7618. if (!content_provider(offset, length - offset, data_sink) || !ok) {
  7619. return false;
  7620. }
  7621. // No Stream to block on here, so a provider that keeps returning true
  7622. // without writing would spin. Treat a pass that made no progress as a
  7623. // failure.
  7624. if (offset == prev_offset) { return false; }
  7625. }
  7626. if (offset != length) { return false; }
  7627. return cmp.compress(nullptr, 0, true, append);
  7628. }
  7629. // Serves `m` as the response body. `set_content_provider()` clears the coding
  7630. // and the file flag, so recording them has to come after; keeping all of it
  7631. // here means a third file-serving path cannot get that order wrong.
  7632. inline void set_file_content_provider(Response &res,
  7633. const std::shared_ptr<mmap> &m,
  7634. const std::string &content_type,
  7635. EncodingType encoding) {
  7636. // One read and one write move up to this much of the file at a time.
  7637. auto buf = std::make_shared<std::vector<char>>(
  7638. (std::min)(m->size(), size_t(256 * 1024)));
  7639. res.set_content_provider(
  7640. m->size(), content_type,
  7641. [m, buf](size_t offset, size_t length, DataSink &sink) -> bool {
  7642. // Never read past the file, which ends the response early if it has
  7643. // shrunk since it was opened.
  7644. auto n = m->read(offset, buf->data(), (std::min)(length, buf->size()));
  7645. if (n == 0) { return false; }
  7646. sink.write(buf->data(), n);
  7647. return true;
  7648. });
  7649. res.is_file_content_provider_ = true;
  7650. res.content_coding_ = encoding;
  7651. }
  7652. template <typename T, typename U>
  7653. inline bool
  7654. write_content_chunked(Stream &strm, const ContentProvider &content_provider,
  7655. const T &is_shutting_down, U &compressor, Error &error) {
  7656. size_t offset = 0;
  7657. auto data_available = true;
  7658. auto ok = true;
  7659. DataSink data_sink;
  7660. data_sink.write = [&](const char *d, size_t l) -> bool {
  7661. // Only done()/done_with_trailer() end a chunked body. A pass with nothing
  7662. // to hand over is ordinary (an empty buffer popped off a queue), and a
  7663. // zero-length chunk is the terminator, so it must not be emitted here.
  7664. if (ok && l > 0) {
  7665. offset += l;
  7666. std::string payload;
  7667. if (compressor.compress(d, l, false,
  7668. [&](const char *data, size_t data_len) {
  7669. payload.append(data, data_len);
  7670. return true;
  7671. })) {
  7672. if (!payload.empty()) {
  7673. // Emit chunked response header and footer for each chunk
  7674. auto chunk =
  7675. from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7676. if (!write_data(strm, chunk.data(), chunk.size())) { ok = false; }
  7677. }
  7678. } else {
  7679. ok = false;
  7680. }
  7681. }
  7682. return ok;
  7683. };
  7684. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7685. auto done_with_trailer = [&](const Headers *trailer) {
  7686. if (!ok) { return; }
  7687. data_available = false;
  7688. std::string payload;
  7689. if (!compressor.compress(nullptr, 0, true,
  7690. [&](const char *data, size_t data_len) {
  7691. payload.append(data, data_len);
  7692. return true;
  7693. })) {
  7694. ok = false;
  7695. return;
  7696. }
  7697. if (!payload.empty()) {
  7698. // Emit chunked response header and footer for each chunk
  7699. auto chunk = from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7700. if (!write_data(strm, chunk.data(), chunk.size())) {
  7701. ok = false;
  7702. return;
  7703. }
  7704. }
  7705. constexpr const char done_marker[] = "0\r\n";
  7706. if (!write_data(strm, done_marker, str_len(done_marker))) { ok = false; }
  7707. // Trailer
  7708. if (trailer) {
  7709. for (const auto &kv : *trailer) {
  7710. // Skip fields with invalid names or values to prevent response
  7711. // splitting via CR/LF injection, matching set_header().
  7712. if (!fields::is_field_valid(kv.first, kv.second)) { continue; }
  7713. std::string field_line = kv.first + ": " + kv.second + "\r\n";
  7714. if (!write_data(strm, field_line.data(), field_line.size())) {
  7715. ok = false;
  7716. }
  7717. }
  7718. }
  7719. constexpr const char crlf[] = "\r\n";
  7720. if (!write_data(strm, crlf, str_len(crlf))) { ok = false; }
  7721. };
  7722. data_sink.done = [&](void) { done_with_trailer(nullptr); };
  7723. data_sink.done_with_trailer = [&](const Headers &trailer) {
  7724. done_with_trailer(&trailer);
  7725. };
  7726. while (data_available && !is_shutting_down()) {
  7727. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7728. error = Error::Write;
  7729. return false;
  7730. } else if (!content_provider(offset, 0, data_sink)) {
  7731. error = Error::Canceled;
  7732. return false;
  7733. } else if (!ok) {
  7734. error = Error::Write;
  7735. return false;
  7736. }
  7737. }
  7738. if (data_available) { // exited due to is_shutting_down(), not done()
  7739. error = Error::Write;
  7740. return false;
  7741. }
  7742. error = Error::Success;
  7743. return true;
  7744. }
  7745. template <typename T, typename U>
  7746. inline bool write_content_chunked(Stream &strm,
  7747. const ContentProvider &content_provider,
  7748. const T &is_shutting_down, U &compressor) {
  7749. auto error = Error::Success;
  7750. return write_content_chunked(strm, content_provider, is_shutting_down,
  7751. compressor, error);
  7752. }
  7753. template <typename T>
  7754. inline bool redirect(T &cli, Request &req, Response &res,
  7755. const std::string &path, const std::string &location,
  7756. Error &error) {
  7757. Request new_req = req;
  7758. new_req.path = path;
  7759. new_req.redirect_count_ -= 1;
  7760. if (res.status == StatusCode::SeeOther_303 &&
  7761. (req.method != "GET" && req.method != "HEAD")) {
  7762. new_req.method = "GET";
  7763. new_req.body.clear();
  7764. new_req.headers.clear();
  7765. new_req.content_length_ = 0;
  7766. new_req.content_provider_ = nullptr;
  7767. new_req.is_chunked_content_provider_ = false;
  7768. }
  7769. Response new_res;
  7770. auto ret = cli.send(new_req, new_res, error);
  7771. if (ret) {
  7772. req = std::move(new_req);
  7773. res = std::move(new_res);
  7774. if (res.location.empty()) { res.location = location; }
  7775. }
  7776. return ret;
  7777. }
  7778. inline std::string params_to_query_str(const Params &params) {
  7779. std::string query;
  7780. for (auto it = params.begin(); it != params.end(); ++it) {
  7781. if (it != params.begin()) { query += '&'; }
  7782. query += encode_query_component(it->first);
  7783. query += '=';
  7784. query += encode_query_component(it->second);
  7785. }
  7786. return query;
  7787. }
  7788. // Splits one "key=value" span of a query string at its first '='. A span with
  7789. // no '=' at all lands entirely in key, leaving val empty, which is how a bare
  7790. // "?flag" keeps its name.
  7791. inline void divide_query_pair(const char *b, const char *e, std::string &key,
  7792. std::string &val) {
  7793. divide(b, static_cast<std::size_t>(e - b), '=',
  7794. [&](const char *lhs_data, std::size_t lhs_size, const char *rhs_data,
  7795. std::size_t rhs_size) {
  7796. key.assign(lhs_data, lhs_size);
  7797. val.assign(rhs_data, rhs_size);
  7798. });
  7799. }
  7800. inline void parse_query_text(const char *data, std::size_t size,
  7801. Params &params) {
  7802. std::set<std::string> cache;
  7803. split(data, data + size, '&', [&](const char *b, const char *e) {
  7804. std::string kv(b, e);
  7805. if (cache.find(kv) != cache.end()) { return; }
  7806. cache.insert(std::move(kv));
  7807. std::string key;
  7808. std::string val;
  7809. divide_query_pair(b, e, key, val);
  7810. if (!key.empty()) {
  7811. params.emplace(decode_query_component(key), decode_query_component(val));
  7812. }
  7813. });
  7814. }
  7815. inline void parse_query_text(const std::string &s, Params &params) {
  7816. parse_query_text(s.data(), s.size(), params);
  7817. }
  7818. // Normalize a query string by decoding and re-encoding each key/value pair
  7819. // while preserving the original parameter order. This avoids double-encoding
  7820. // and ensures consistent encoding. It works on the raw string rather than
  7821. // parsing into Params and re-serializing, because that round trip cannot
  7822. // reproduce the input: params_to_query_str() always emits '=', so a bare
  7823. // "flag" would come back as "flag=", and parse_query_text() drops exactly
  7824. // duplicated pairs.
  7825. inline std::string normalize_query_string(const std::string &query) {
  7826. std::string result;
  7827. split(query.data(), query.data() + query.size(), '&',
  7828. [&](const char *b, const char *e) {
  7829. std::string key;
  7830. std::string val;
  7831. divide_query_pair(b, e, key, val);
  7832. if (!key.empty()) {
  7833. auto dec_key = decode_query_component(key);
  7834. auto dec_val = decode_query_component(val);
  7835. if (!result.empty()) { result += '&'; }
  7836. result += encode_query_component(dec_key);
  7837. if (!val.empty() || std::find(b, e, '=') != e) {
  7838. result += '=';
  7839. result += encode_query_component(dec_val);
  7840. }
  7841. }
  7842. });
  7843. return result;
  7844. }
  7845. // The query of a client's path: what follows '?', up to the fragment.
  7846. inline std::string query_of(const std::string &path) {
  7847. auto fragment_pos = path.find('#');
  7848. auto query_pos = path.find('?');
  7849. return query_pos < fragment_pos
  7850. ? path.substr(query_pos + 1, fragment_pos - query_pos - 1)
  7851. : std::string();
  7852. }
  7853. // Build the request target that goes on the wire from a caller-supplied path.
  7854. // Shared by the buffered send path and the streaming API so that both put the
  7855. // same bytes in the request line for the same input.
  7856. inline std::string encode_request_target(const std::string &uri,
  7857. bool path_encode) {
  7858. // The fragment stays with the client (RFC 9110 §7.1).
  7859. auto target = uri.substr(0, uri.find('#'));
  7860. // `substr(0, npos)` yields the whole string, which is what the no-query
  7861. // case needs.
  7862. auto query_pos = target.find('?');
  7863. auto path_part = target.substr(0, query_pos);
  7864. std::string query_part;
  7865. if (query_pos != std::string::npos) {
  7866. query_part = target.substr(query_pos + 1);
  7867. }
  7868. auto result = path_encode ? encode_path(path_part) : std::move(path_part);
  7869. if (!query_part.empty()) {
  7870. // When path encoding is disabled the caller has supplied an already-encoded
  7871. // target and expects the exact bytes to be sent on the wire, so skip
  7872. // normalization for the query too. Normalizing would decode-then-re-encode
  7873. // it and corrupt pre-encoded binary payloads (e.g. turning `%20` into `+`,
  7874. // which a strict RFC 3986 server decodes back as `+`, not a space).
  7875. if (path_encode) {
  7876. auto normalized = normalize_query_string(query_part);
  7877. if (!normalized.empty()) {
  7878. result += '?';
  7879. result += normalized;
  7880. }
  7881. } else {
  7882. result += '?';
  7883. result += query_part;
  7884. }
  7885. }
  7886. return result;
  7887. }
  7888. inline bool parse_multipart_boundary(const std::string &content_type,
  7889. std::string &boundary) {
  7890. std::map<std::string, std::string> params;
  7891. extract_media_type(content_type, &params);
  7892. auto it = params.find("boundary");
  7893. if (it == params.end()) { return false; }
  7894. boundary = it->second;
  7895. // RFC 2046 5.1.1 caps a boundary at 70 characters. The parser scans the body
  7896. // for "--" + boundary, so a body crafted to repeat that delimiter's leading
  7897. // bytes costs a nearly full comparison at nearly every position: the
  7898. // boundary's length multiplies the worst-case cost of scanning a body.
  7899. return !boundary.empty() && boundary.size() <= 70;
  7900. }
  7901. inline void parse_disposition_params(const std::string &s, Params &params) {
  7902. std::set<std::string> cache;
  7903. split_unquoted(
  7904. s.data(), s.data() + s.size(), ';', [&](const char *b, const char *e) {
  7905. std::string kv(b, e);
  7906. if (cache.find(kv) != cache.end()) { return; }
  7907. cache.insert(kv);
  7908. std::string key;
  7909. std::string val;
  7910. divide_param_pair(b, e, key, val);
  7911. if (!key.empty()) {
  7912. params.emplace(trim_double_quotes_copy(key), unquote_param(val));
  7913. }
  7914. });
  7915. }
  7916. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7917. inline bool parse_range_header(const std::string &s, Ranges &ranges) {
  7918. #else
  7919. inline bool parse_range_header(const std::string &s, Ranges &ranges) try {
  7920. #endif
  7921. auto is_valid = [](const std::string &str) {
  7922. return std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  7923. };
  7924. if (s.size() > 7 && case_ignore::equal(s.substr(0, 6), "bytes=")) {
  7925. const auto pos = static_cast<size_t>(6);
  7926. const auto len = static_cast<size_t>(s.size() - 6);
  7927. auto all_valid_ranges = true;
  7928. split(&s[pos], &s[pos + len], ',', [&](const char *b, const char *e) {
  7929. if (!all_valid_ranges) { return; }
  7930. const auto it = std::find(b, e, '-');
  7931. if (it == e) {
  7932. all_valid_ranges = false;
  7933. return;
  7934. }
  7935. const auto lhs = std::string(b, it);
  7936. const auto rhs = std::string(it + 1, e);
  7937. if (!is_valid(lhs) || !is_valid(rhs)) {
  7938. all_valid_ranges = false;
  7939. return;
  7940. }
  7941. ssize_t first = -1;
  7942. if (!lhs.empty()) {
  7943. // Reject an overflowing first-byte-pos; treating it as absent (-1)
  7944. // would turn the range into a suffix range.
  7945. auto res =
  7946. detail::from_chars(lhs.data(), lhs.data() + lhs.size(), first);
  7947. if (res.ec != std::errc{}) {
  7948. all_valid_ranges = false;
  7949. return;
  7950. }
  7951. }
  7952. ssize_t last = -1;
  7953. if (!rhs.empty()) {
  7954. // An overflowing last-byte-pos is past any content length, so keeping
  7955. // -1 ("remainder", RFC 9110 14.1.2) is correct here.
  7956. ssize_t v;
  7957. auto res = detail::from_chars(rhs.data(), rhs.data() + rhs.size(), v);
  7958. if (res.ec == std::errc{}) { last = v; }
  7959. }
  7960. if ((first == -1 && last == -1) ||
  7961. (first != -1 && last != -1 && first > last)) {
  7962. all_valid_ranges = false;
  7963. return;
  7964. }
  7965. ranges.emplace_back(first, last);
  7966. });
  7967. return all_valid_ranges && !ranges.empty();
  7968. }
  7969. return false;
  7970. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7971. }
  7972. #else
  7973. } catch (...) { return false; }
  7974. #endif
  7975. // Removes each quoted-string, honoring a quoted-pair (RFC 9110 Section 5.6.4)
  7976. inline std::string remove_quoted_strings(const std::string &s) {
  7977. std::string out;
  7978. auto in_quotes = false;
  7979. for (size_t i = 0; i < s.size(); i++) {
  7980. if (s[i] == '"') {
  7981. in_quotes = !in_quotes;
  7982. } else if (!in_quotes) {
  7983. out += s[i];
  7984. } else if (s[i] == '\\') {
  7985. i++;
  7986. }
  7987. }
  7988. return out;
  7989. }
  7990. inline bool parse_accept_header(const std::string &s,
  7991. std::vector<std::string> &content_types) {
  7992. // Parameter values are not used here, so a quoted-string is dropped rather
  7993. // than parsed: a ',' or ';' inside one must not be read as a delimiter.
  7994. if (s.find('"') != std::string::npos) {
  7995. return parse_accept_header(remove_quoted_strings(s), content_types);
  7996. }
  7997. content_types.clear();
  7998. // Empty string is considered valid (no preference)
  7999. if (s.empty()) { return true; }
  8000. struct AcceptEntry {
  8001. std::string media_type;
  8002. double quality;
  8003. int order;
  8004. };
  8005. std::vector<AcceptEntry> entries;
  8006. int order = 0;
  8007. bool has_invalid_entry = false;
  8008. // Split by comma and parse each entry. RFC 9110 Section 5.6.1.2: a recipient
  8009. // has to parse and ignore empty list elements, so a leading, trailing or
  8010. // doubled comma must not turn a legal Accept value into 400 Bad Request.
  8011. // split() skips them, and the header length limit bounds how many a sender
  8012. // can send, so ignoring all of them cannot be used as a denial-of-service
  8013. // vector.
  8014. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  8015. std::string entry(b, e);
  8016. entry = trim_copy(entry);
  8017. AcceptEntry accept_entry;
  8018. accept_entry.order = order++;
  8019. if (!parse_quality(entry.data(), entry.data() + entry.size(),
  8020. accept_entry.media_type, accept_entry.quality)) {
  8021. has_invalid_entry = true;
  8022. return;
  8023. }
  8024. // Remove additional parameters from media type
  8025. accept_entry.media_type = extract_media_type(accept_entry.media_type);
  8026. // Basic validation of media type format
  8027. if (accept_entry.media_type.empty()) {
  8028. has_invalid_entry = true;
  8029. return;
  8030. }
  8031. // Check for basic media type format (should contain '/' or be '*')
  8032. if (accept_entry.media_type != "*" &&
  8033. accept_entry.media_type.find('/') == std::string::npos) {
  8034. has_invalid_entry = true;
  8035. return;
  8036. }
  8037. entries.push_back(std::move(accept_entry));
  8038. });
  8039. // Return false if any invalid entry was found
  8040. if (has_invalid_entry) { return false; }
  8041. // Sort by quality (descending), then by original order (ascending)
  8042. std::sort(entries.begin(), entries.end(),
  8043. [](const AcceptEntry &a, const AcceptEntry &b) {
  8044. if (a.quality != b.quality) {
  8045. return a.quality > b.quality; // Higher quality first
  8046. }
  8047. return a.order < b.order; // Earlier order first for same quality
  8048. });
  8049. // Extract sorted media types
  8050. content_types.reserve(entries.size());
  8051. for (auto &entry : entries) {
  8052. content_types.push_back(std::move(entry.media_type));
  8053. }
  8054. return true;
  8055. }
  8056. class FormDataParser {
  8057. public:
  8058. FormDataParser() = default;
  8059. void set_boundary(std::string &&boundary) {
  8060. boundary_ = std::move(boundary);
  8061. dash_boundary_crlf_ = dash_ + boundary_ + crlf_;
  8062. crlf_dash_boundary_ = crlf_ + dash_ + boundary_;
  8063. }
  8064. bool is_valid() const { return is_valid_; }
  8065. bool parse(const char *buf, size_t n, const FormDataHeader &header_callback,
  8066. const ContentReceiver &content_callback) {
  8067. // Once the close delimiter has been seen the rest of the body is epilogue
  8068. // to be discarded (RFC 2046). Drop it without buffering so a large epilogue
  8069. // spread across reads is not copied in only to be erased right away.
  8070. if (state_ == 5) { return true; }
  8071. buf_append(buf, n);
  8072. while (buf_size() > 0) {
  8073. switch (state_) {
  8074. case 0: { // Initial boundary
  8075. auto pos = buf_find(dash_boundary_crlf_);
  8076. if (pos == buf_size()) {
  8077. // Not found yet: keep only a possible partial boundary at the tail so
  8078. // that a body which never contains the boundary cannot grow the
  8079. // buffer (and get rescanned from the start) without bound.
  8080. auto keep = dash_boundary_crlf_.size() - 1;
  8081. if (buf_size() > keep) { buf_erase(buf_size() - keep); }
  8082. return true;
  8083. }
  8084. buf_erase(pos + dash_boundary_crlf_.size());
  8085. state_ = 1;
  8086. break;
  8087. }
  8088. case 1: { // New entry
  8089. clear_file_info();
  8090. header_searched_ = 0;
  8091. state_ = 2;
  8092. break;
  8093. }
  8094. case 2: { // Headers
  8095. // Resume where the last call stopped looking, so that a line arriving
  8096. // a few bytes at a time is not searched from its start each time.
  8097. auto pos = buf_find(crlf_, header_searched_);
  8098. if (pos > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  8099. while (pos < buf_size()) {
  8100. // Empty line
  8101. if (pos == 0) {
  8102. if (!header_callback(file_)) {
  8103. is_valid_ = false;
  8104. return false;
  8105. }
  8106. buf_erase(crlf_.size());
  8107. state_ = 3;
  8108. break;
  8109. }
  8110. // Check header count limit
  8111. if (header_count_ >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  8112. is_valid_ = false;
  8113. return false;
  8114. }
  8115. header_count_++;
  8116. const auto header = buf_head(pos);
  8117. if (!parse_header(header.data(), header.data() + header.size(),
  8118. [&](const std::string &, const std::string &) {})) {
  8119. is_valid_ = false;
  8120. return false;
  8121. }
  8122. // Parse and emplace space trimmed headers into a map
  8123. if (!parse_header(
  8124. header.data(), header.data() + header.size(),
  8125. [&](const std::string &key, const std::string &val) {
  8126. file_.headers.emplace(key, val);
  8127. })) {
  8128. is_valid_ = false;
  8129. return false;
  8130. }
  8131. constexpr const char header_content_type[] = "Content-Type:";
  8132. if (start_with_case_ignore(header, header_content_type)) {
  8133. file_.content_type =
  8134. trim_copy(header.substr(str_len(header_content_type)));
  8135. } else {
  8136. std::string disposition_params;
  8137. if (parse_content_disposition(header, disposition_params)) {
  8138. Params params;
  8139. parse_disposition_params(disposition_params, params);
  8140. auto it = params.find("name");
  8141. if (it != params.end()) {
  8142. file_.name = it->second;
  8143. } else {
  8144. is_valid_ = false;
  8145. return false;
  8146. }
  8147. it = params.find("filename");
  8148. if (it != params.end()) { file_.filename = it->second; }
  8149. it = params.find("filename*");
  8150. if (it != params.end()) {
  8151. // RFC 5987: only UTF-8 encoding is allowed
  8152. const auto &val = it->second;
  8153. constexpr const char utf8_prefix[] = "UTF-8''";
  8154. constexpr size_t prefix_len = str_len(utf8_prefix);
  8155. if (val.size() > prefix_len &&
  8156. start_with_case_ignore(val, utf8_prefix)) {
  8157. file_.filename = decode_path_component(
  8158. val.substr(prefix_len)); // override...
  8159. } else {
  8160. is_valid_ = false;
  8161. return false;
  8162. }
  8163. }
  8164. }
  8165. }
  8166. buf_erase(pos + crlf_.size());
  8167. pos = buf_find(crlf_);
  8168. }
  8169. if (state_ != 3) {
  8170. // The CR of the CRLF may be the last byte so far.
  8171. header_searched_ = buf_size() > 0 ? buf_size() - 1 : 0;
  8172. return true;
  8173. }
  8174. break;
  8175. }
  8176. case 3: { // Body
  8177. if (crlf_dash_boundary_.size() > buf_size()) { return true; }
  8178. auto pos = buf_find(crlf_dash_boundary_);
  8179. if (pos < buf_size()) {
  8180. if (!content_callback(buf_data(), pos)) {
  8181. is_valid_ = false;
  8182. return false;
  8183. }
  8184. buf_erase(pos + crlf_dash_boundary_.size());
  8185. state_ = 4;
  8186. } else {
  8187. auto len = buf_size() - crlf_dash_boundary_.size();
  8188. if (len > 0) {
  8189. if (!content_callback(buf_data(), len)) {
  8190. is_valid_ = false;
  8191. return false;
  8192. }
  8193. buf_erase(len);
  8194. }
  8195. return true;
  8196. }
  8197. break;
  8198. }
  8199. case 4: { // Boundary
  8200. if (crlf_.size() > buf_size()) { return true; }
  8201. if (buf_start_with(crlf_)) {
  8202. buf_erase(crlf_.size());
  8203. state_ = 1;
  8204. } else if (buf_start_with(dash_)) {
  8205. buf_erase(dash_.size());
  8206. is_valid_ = true;
  8207. state_ = 5;
  8208. } else {
  8209. // Only CRLF (another part follows) and "--" (close-delimiter) are
  8210. // accepted after a boundary; RFC 2046 allows transport-padding in
  8211. // between, but this parser has never supported it. Either way the
  8212. // body is already destined to be rejected, so fail now instead of
  8213. // buffering the rest of it. Both are two bytes, so the check above
  8214. // already guarantees enough buffered data to decide.
  8215. is_valid_ = false;
  8216. return false;
  8217. }
  8218. break;
  8219. }
  8220. case 5: { // Epilogue
  8221. buf_erase(buf_size());
  8222. break;
  8223. }
  8224. }
  8225. }
  8226. return true;
  8227. }
  8228. private:
  8229. void clear_file_info() {
  8230. file_.name.clear();
  8231. file_.filename.clear();
  8232. file_.content_type.clear();
  8233. file_.headers.clear();
  8234. header_count_ = 0;
  8235. }
  8236. bool start_with_case_ignore(const std::string &a, const char *b,
  8237. size_t offset = 0) const {
  8238. const auto b_len = strlen(b);
  8239. if (a.size() < offset + b_len) { return false; }
  8240. for (size_t i = 0; i < b_len; i++) {
  8241. if (case_ignore::to_lower(a[offset + i]) != case_ignore::to_lower(b[i])) {
  8242. return false;
  8243. }
  8244. }
  8245. return true;
  8246. }
  8247. // Parses "Content-Disposition: form-data; <params>" without std::regex.
  8248. // Returns true if header matches, with the params portion in `params_out`.
  8249. bool parse_content_disposition(const std::string &header,
  8250. std::string &params_out) const {
  8251. constexpr const char prefix[] = "Content-Disposition:";
  8252. constexpr size_t prefix_len = str_len(prefix);
  8253. if (!start_with_case_ignore(header, prefix)) { return false; }
  8254. // Skip whitespace after "Content-Disposition:"
  8255. auto pos = prefix_len;
  8256. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8257. pos++;
  8258. }
  8259. // Match "form-data;" (case-insensitive)
  8260. constexpr const char form_data[] = "form-data;";
  8261. constexpr size_t form_data_len = str_len(form_data);
  8262. if (!start_with_case_ignore(header, form_data, pos)) { return false; }
  8263. pos += form_data_len;
  8264. // Skip whitespace after "form-data;"
  8265. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8266. pos++;
  8267. }
  8268. params_out = header.substr(pos);
  8269. return true;
  8270. }
  8271. const std::string dash_ = "--";
  8272. const std::string crlf_ = "\r\n";
  8273. std::string boundary_;
  8274. std::string dash_boundary_crlf_;
  8275. std::string crlf_dash_boundary_;
  8276. size_t state_ = 0;
  8277. bool is_valid_ = false;
  8278. FormData file_;
  8279. size_t header_count_ = 0;
  8280. size_t header_searched_ = 0;
  8281. // Buffer
  8282. bool start_with(const std::string &a, size_t spos, size_t epos,
  8283. const std::string &b) const {
  8284. if (epos - spos < b.size()) { return false; }
  8285. for (size_t i = 0; i < b.size(); i++) {
  8286. if (a[i + spos] != b[i]) { return false; }
  8287. }
  8288. return true;
  8289. }
  8290. size_t buf_size() const { return buf_epos_ - buf_spos_; }
  8291. const char *buf_data() const { return &buf_[buf_spos_]; }
  8292. std::string buf_head(size_t l) const { return buf_.substr(buf_spos_, l); }
  8293. bool buf_start_with(const std::string &s) const {
  8294. return start_with(buf_, buf_spos_, buf_epos_, s);
  8295. }
  8296. size_t buf_find(const std::string &s, size_t from = 0) const {
  8297. auto c = s.front();
  8298. size_t off = buf_spos_ + from;
  8299. while (off < buf_epos_) {
  8300. auto pos = off;
  8301. while (true) {
  8302. if (pos == buf_epos_) { return buf_size(); }
  8303. if (buf_[pos] == c) { break; }
  8304. pos++;
  8305. }
  8306. auto remaining_size = buf_epos_ - pos;
  8307. if (s.size() > remaining_size) { return buf_size(); }
  8308. if (start_with(buf_, pos, buf_epos_, s)) { return pos - buf_spos_; }
  8309. off = pos + 1;
  8310. }
  8311. return buf_size();
  8312. }
  8313. void buf_append(const char *data, size_t n) {
  8314. auto remaining_size = buf_size();
  8315. if (remaining_size > 0 && buf_spos_ > 0) {
  8316. for (size_t i = 0; i < remaining_size; i++) {
  8317. buf_[i] = buf_[buf_spos_ + i];
  8318. }
  8319. }
  8320. buf_spos_ = 0;
  8321. buf_epos_ = remaining_size;
  8322. if (remaining_size + n > buf_.size()) { buf_.resize(remaining_size + n); }
  8323. for (size_t i = 0; i < n; i++) {
  8324. buf_[buf_epos_ + i] = data[i];
  8325. }
  8326. buf_epos_ += n;
  8327. }
  8328. void buf_erase(size_t size) { buf_spos_ += size; }
  8329. std::string buf_;
  8330. size_t buf_spos_ = 0;
  8331. size_t buf_epos_ = 0;
  8332. };
  8333. inline std::string random_string(size_t length) {
  8334. constexpr const char data[] =
  8335. "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
  8336. std::string result(length, '\0');
  8337. fill_random_bytes(reinterpret_cast<unsigned char *>(&result[0]), length);
  8338. for (auto &c : result) {
  8339. c = data[static_cast<unsigned char>(c) % (sizeof(data) - 1)];
  8340. }
  8341. return result;
  8342. }
  8343. inline std::string make_multipart_data_boundary() {
  8344. return "--cpp-httplib-multipart-data-" + detail::random_string(16);
  8345. }
  8346. inline bool is_multipart_boundary_chars_valid(const std::string &boundary) {
  8347. auto valid = true;
  8348. for (size_t i = 0; i < boundary.size(); i++) {
  8349. auto c = boundary[i];
  8350. if (!is_ascii_alnum(c) && c != '-' && c != '_') {
  8351. valid = false;
  8352. break;
  8353. }
  8354. }
  8355. return valid;
  8356. }
  8357. // Escape a multipart field name/filename following the WHATWG HTML standard
  8358. // ("escape a multipart form-data name"): '"' -> %22, CR -> %0D, LF -> %0A.
  8359. // As the value is a quoted-string, '\' -> '\\' too, which browsers leave out.
  8360. // With quoted = false, only CR and LF are escaped; this is for header values
  8361. // outside a quoted-string (e.g. Content-Type), where '"' and '\' are legal.
  8362. inline std::string escape_multipart_field(const std::string &s,
  8363. bool quoted = true) {
  8364. std::string result;
  8365. result.reserve(s.size());
  8366. for (auto c : s) {
  8367. switch (c) {
  8368. case '"':
  8369. if (quoted) {
  8370. result += "%22";
  8371. } else {
  8372. result += c;
  8373. }
  8374. break;
  8375. case '\\':
  8376. // A lone backslash would escape the character after it (RFC 9110
  8377. // 5.6.4).
  8378. if (quoted) { result += '\\'; }
  8379. result += c;
  8380. break;
  8381. case '\r': result += "%0D"; break;
  8382. case '\n': result += "%0A"; break;
  8383. default: result += c; break;
  8384. }
  8385. }
  8386. return result;
  8387. }
  8388. template <typename T>
  8389. inline std::string
  8390. serialize_multipart_formdata_item_begin(const T &item,
  8391. const std::string &boundary) {
  8392. std::string body = "--" + boundary + "\r\n";
  8393. body += "Content-Disposition: form-data; name=\"" +
  8394. escape_multipart_field(item.name) + "\"";
  8395. if (!item.filename.empty()) {
  8396. body += "; filename=\"" + escape_multipart_field(item.filename) + "\"";
  8397. }
  8398. body += "\r\n";
  8399. if (!item.content_type.empty()) {
  8400. body +=
  8401. "Content-Type: " + escape_multipart_field(item.content_type, false) +
  8402. "\r\n";
  8403. }
  8404. body += "\r\n";
  8405. return body;
  8406. }
  8407. inline std::string serialize_multipart_formdata_item_end() { return "\r\n"; }
  8408. inline std::string
  8409. serialize_multipart_formdata_finish(const std::string &boundary) {
  8410. return "--" + boundary + "--\r\n";
  8411. }
  8412. inline std::string
  8413. serialize_multipart_formdata_get_content_type(const std::string &boundary) {
  8414. return "multipart/form-data; boundary=" + boundary;
  8415. }
  8416. inline std::string
  8417. serialize_multipart_formdata(const UploadFormDataItems &items,
  8418. const std::string &boundary, bool finish = true) {
  8419. std::string body;
  8420. for (const auto &item : items) {
  8421. body += serialize_multipart_formdata_item_begin(item, boundary);
  8422. body += item.content + serialize_multipart_formdata_item_end();
  8423. }
  8424. if (finish) { body += serialize_multipart_formdata_finish(boundary); }
  8425. return body;
  8426. }
  8427. inline size_t get_multipart_content_length(const UploadFormDataItems &items,
  8428. const std::string &boundary) {
  8429. size_t total = 0;
  8430. for (const auto &item : items) {
  8431. total += serialize_multipart_formdata_item_begin(item, boundary).size();
  8432. total += item.content.size();
  8433. total += serialize_multipart_formdata_item_end().size();
  8434. }
  8435. total += serialize_multipart_formdata_finish(boundary).size();
  8436. return total;
  8437. }
  8438. struct MultipartSegment {
  8439. const char *data;
  8440. size_t size;
  8441. };
  8442. // NOTE: items must outlive the returned ContentProvider
  8443. // (safe for synchronous use inside Post/Put/Patch)
  8444. inline ContentProvider
  8445. make_multipart_content_provider(const UploadFormDataItems &items,
  8446. const std::string &boundary) {
  8447. // Own the per-item header strings and the finish string
  8448. std::vector<std::string> owned;
  8449. owned.reserve(items.size() + 1);
  8450. for (const auto &item : items)
  8451. owned.push_back(serialize_multipart_formdata_item_begin(item, boundary));
  8452. owned.push_back(serialize_multipart_formdata_finish(boundary));
  8453. // Flat segment list: [header, content, "\r\n"] * N + [finish]
  8454. std::vector<MultipartSegment> segs;
  8455. segs.reserve(items.size() * 3 + 1);
  8456. static const char crlf[] = "\r\n";
  8457. for (size_t i = 0; i < items.size(); i++) {
  8458. segs.push_back({owned[i].data(), owned[i].size()});
  8459. segs.push_back({items[i].content.data(), items[i].content.size()});
  8460. segs.push_back({crlf, 2});
  8461. }
  8462. segs.push_back({owned.back().data(), owned.back().size()});
  8463. struct MultipartState {
  8464. std::vector<std::string> owned;
  8465. std::vector<MultipartSegment> segs;
  8466. std::vector<char> buf = std::vector<char>(CPPHTTPLIB_SEND_BUFSIZ);
  8467. };
  8468. auto state = std::make_shared<MultipartState>();
  8469. state->owned = std::move(owned);
  8470. // `segs` holds raw pointers into owned strings; std::string move preserves
  8471. // the data pointer, so these pointers remain valid after the move above.
  8472. state->segs = std::move(segs);
  8473. return [state](size_t offset, size_t length, DataSink &sink) -> bool {
  8474. // Buffer multiple small segments into fewer, larger writes to avoid
  8475. // excessive TCP packets when there are many form data items (#2410)
  8476. auto &buf = state->buf;
  8477. auto buf_size = buf.size();
  8478. size_t buf_len = 0;
  8479. size_t remaining = length;
  8480. // Find the first segment containing 'offset'
  8481. size_t pos = 0;
  8482. size_t seg_idx = 0;
  8483. for (; seg_idx < state->segs.size(); seg_idx++) {
  8484. const auto &seg = state->segs[seg_idx];
  8485. if (seg.size > 0 && offset - pos < seg.size) { break; }
  8486. pos += seg.size;
  8487. }
  8488. size_t seg_offset = (seg_idx < state->segs.size()) ? offset - pos : 0;
  8489. for (; seg_idx < state->segs.size() && remaining > 0; seg_idx++) {
  8490. const auto &seg = state->segs[seg_idx];
  8491. size_t available = seg.size - seg_offset;
  8492. size_t to_copy = (std::min)(available, remaining);
  8493. const char *src = seg.data + seg_offset;
  8494. seg_offset = 0; // only the first segment has a non-zero offset
  8495. while (to_copy > 0) {
  8496. size_t space = buf_size - buf_len;
  8497. size_t chunk = (std::min)(to_copy, space);
  8498. std::memcpy(buf.data() + buf_len, src, chunk);
  8499. buf_len += chunk;
  8500. src += chunk;
  8501. to_copy -= chunk;
  8502. remaining -= chunk;
  8503. if (buf_len == buf_size) {
  8504. if (!sink.write(buf.data(), buf_len)) { return false; }
  8505. buf_len = 0;
  8506. }
  8507. }
  8508. }
  8509. if (buf_len > 0) { return sink.write(buf.data(), buf_len); }
  8510. return true;
  8511. };
  8512. }
  8513. inline void coalesce_ranges(Ranges &ranges, size_t content_length) {
  8514. if (ranges.size() <= 1) return;
  8515. // Sort ranges by start position
  8516. std::sort(ranges.begin(), ranges.end(),
  8517. [](const Range &a, const Range &b) { return a.first < b.first; });
  8518. Ranges coalesced;
  8519. coalesced.reserve(ranges.size());
  8520. for (auto &r : ranges) {
  8521. auto first_pos = r.first;
  8522. auto last_pos = r.second;
  8523. // Handle special cases like in range_error
  8524. if (first_pos == -1 && last_pos == -1) {
  8525. first_pos = 0;
  8526. last_pos = static_cast<ssize_t>(content_length);
  8527. }
  8528. if (first_pos == -1) {
  8529. first_pos = static_cast<ssize_t>(content_length) - last_pos;
  8530. last_pos = static_cast<ssize_t>(content_length) - 1;
  8531. }
  8532. if (last_pos == -1 || last_pos >= static_cast<ssize_t>(content_length)) {
  8533. last_pos = static_cast<ssize_t>(content_length) - 1;
  8534. }
  8535. // Skip invalid ranges
  8536. if (!(0 <= first_pos && first_pos <= last_pos &&
  8537. last_pos < static_cast<ssize_t>(content_length))) {
  8538. continue;
  8539. }
  8540. // Coalesce with previous range if overlapping or adjacent (but not
  8541. // identical)
  8542. if (!coalesced.empty()) {
  8543. auto &prev = coalesced.back();
  8544. // Check if current range overlaps or is adjacent to previous range
  8545. // but don't coalesce identical ranges (allow duplicates)
  8546. if (first_pos <= prev.second + 1 &&
  8547. !(first_pos == prev.first && last_pos == prev.second)) {
  8548. // Extend the previous range
  8549. prev.second = (std::max)(prev.second, last_pos);
  8550. continue;
  8551. }
  8552. }
  8553. // Add new range
  8554. coalesced.emplace_back(first_pos, last_pos);
  8555. }
  8556. ranges = std::move(coalesced);
  8557. }
  8558. inline bool range_error(Request &req, Response &res) {
  8559. if (!req.ranges.empty() && 200 <= res.status && res.status < 300) {
  8560. if (res.body.empty() && res.content_provider_ && res.content_length_ == 0) {
  8561. req.ranges.clear();
  8562. if (res.status == StatusCode::PartialContent_206) {
  8563. res.status = StatusCode::OK_200;
  8564. }
  8565. return false;
  8566. }
  8567. ssize_t content_len = static_cast<ssize_t>(
  8568. res.content_length_ ? res.content_length_ : res.body.size());
  8569. std::vector<std::pair<ssize_t, ssize_t>> processed_ranges;
  8570. size_t overwrapping_count = 0;
  8571. // NOTE: The following Range check is based on '14.2. Range' in RFC 9110
  8572. // 'HTTP Semantics' to avoid potential denial-of-service attacks.
  8573. // https://www.rfc-editor.org/rfc/rfc9110#section-14.2
  8574. // Too many ranges
  8575. if (CPPHTTPLIB_RANGE_MAX_COUNT > 0 &&
  8576. req.ranges.size() > CPPHTTPLIB_RANGE_MAX_COUNT) {
  8577. return true;
  8578. }
  8579. for (auto &r : req.ranges) {
  8580. auto &first_pos = r.first;
  8581. auto &last_pos = r.second;
  8582. if (first_pos == -1 && last_pos == -1) {
  8583. first_pos = 0;
  8584. last_pos = content_len;
  8585. }
  8586. // RFC 9110 14.1.2: a suffix-length longer than the representation
  8587. // selects the entire representation.
  8588. if (first_pos == -1) {
  8589. first_pos = (std::max)(static_cast<ssize_t>(0), content_len - last_pos);
  8590. last_pos = content_len - 1;
  8591. }
  8592. // NOTE: RFC-9110 '14.1.2. Byte Ranges':
  8593. // A client can limit the number of bytes requested without knowing the
  8594. // size of the selected representation. If the last-pos value is absent,
  8595. // or if the value is greater than or equal to the current length of the
  8596. // representation data, the byte range is interpreted as the remainder of
  8597. // the representation (i.e., the server replaces the value of last-pos
  8598. // with a value that is one less than the current length of the selected
  8599. // representation).
  8600. // https://www.rfc-editor.org/rfc/rfc9110.html#section-14.1.2-6
  8601. if (last_pos == -1 || last_pos >= content_len) {
  8602. last_pos = content_len - 1;
  8603. }
  8604. // Range must be within content length
  8605. if (!(0 <= first_pos && first_pos <= last_pos &&
  8606. last_pos <= content_len - 1)) {
  8607. return true;
  8608. }
  8609. // Request must not have more than two overlapping ranges
  8610. for (const auto &processed_range : processed_ranges) {
  8611. if (!(last_pos < processed_range.first ||
  8612. first_pos > processed_range.second)) {
  8613. overwrapping_count++;
  8614. if (overwrapping_count > 2) { return true; }
  8615. break; // Only count once per range
  8616. }
  8617. }
  8618. processed_ranges.emplace_back(first_pos, last_pos);
  8619. }
  8620. // After validation, coalesce overlapping ranges as per RFC 9110
  8621. coalesce_ranges(req.ranges, static_cast<size_t>(content_len));
  8622. }
  8623. return false;
  8624. }
  8625. inline std::pair<size_t, size_t>
  8626. get_range_offset_and_length(Range r, size_t content_length) {
  8627. assert(r.first != -1 && r.second != -1);
  8628. assert(0 <= r.first && r.first < static_cast<ssize_t>(content_length));
  8629. assert(r.first <= r.second &&
  8630. r.second < static_cast<ssize_t>(content_length));
  8631. (void)(content_length);
  8632. return std::make_pair(static_cast<size_t>(r.first),
  8633. static_cast<size_t>(r.second - r.first) + 1);
  8634. }
  8635. inline std::string make_content_range_header_field(
  8636. const std::pair<size_t, size_t> &offset_and_length, size_t content_length) {
  8637. auto st = offset_and_length.first;
  8638. auto ed = st + offset_and_length.second - 1;
  8639. std::string field = "bytes ";
  8640. field += std::to_string(st);
  8641. field += '-';
  8642. field += std::to_string(ed);
  8643. field += '/';
  8644. field += std::to_string(content_length);
  8645. return field;
  8646. }
  8647. template <typename SToken, typename CToken, typename Content>
  8648. bool process_multipart_ranges_data(const Request &req,
  8649. const std::string &boundary,
  8650. const std::string &content_type,
  8651. size_t content_length, SToken stoken,
  8652. CToken ctoken, Content content) {
  8653. for (size_t i = 0; i < req.ranges.size(); i++) {
  8654. ctoken("--");
  8655. stoken(boundary);
  8656. ctoken("\r\n");
  8657. if (!content_type.empty()) {
  8658. ctoken("Content-Type: ");
  8659. stoken(content_type);
  8660. ctoken("\r\n");
  8661. }
  8662. auto offset_and_length =
  8663. get_range_offset_and_length(req.ranges[i], content_length);
  8664. ctoken("Content-Range: ");
  8665. stoken(make_content_range_header_field(offset_and_length, content_length));
  8666. ctoken("\r\n");
  8667. ctoken("\r\n");
  8668. if (!content(offset_and_length.first, offset_and_length.second)) {
  8669. return false;
  8670. }
  8671. ctoken("\r\n");
  8672. }
  8673. ctoken("--");
  8674. stoken(boundary);
  8675. ctoken("--");
  8676. return true;
  8677. }
  8678. inline void make_multipart_ranges_data(const Request &req, Response &res,
  8679. const std::string &boundary,
  8680. const std::string &content_type,
  8681. size_t content_length,
  8682. std::string &data) {
  8683. process_multipart_ranges_data(
  8684. req, boundary, content_type, content_length,
  8685. [&](const std::string &token) { data += token; },
  8686. [&](const std::string &token) { data += token; },
  8687. [&](size_t offset, size_t length) {
  8688. assert(offset + length <= content_length);
  8689. data += res.body.substr(offset, length);
  8690. return true;
  8691. });
  8692. }
  8693. inline size_t get_multipart_ranges_data_length(const Request &req,
  8694. const std::string &boundary,
  8695. const std::string &content_type,
  8696. size_t content_length) {
  8697. size_t data_length = 0;
  8698. process_multipart_ranges_data(
  8699. req, boundary, content_type, content_length,
  8700. [&](const std::string &token) { data_length += token.size(); },
  8701. [&](const std::string &token) { data_length += token.size(); },
  8702. [&](size_t /*offset*/, size_t length) {
  8703. data_length += length;
  8704. return true;
  8705. });
  8706. return data_length;
  8707. }
  8708. template <typename T>
  8709. inline bool
  8710. write_multipart_ranges_data(Stream &strm, const Request &req, Response &res,
  8711. const std::string &boundary,
  8712. const std::string &content_type,
  8713. size_t content_length, const T &is_shutting_down) {
  8714. return process_multipart_ranges_data(
  8715. req, boundary, content_type, content_length,
  8716. [&](const std::string &token) { strm.write(token); },
  8717. [&](const std::string &token) { strm.write(token); },
  8718. [&](size_t offset, size_t length) {
  8719. return write_content(strm, res.content_provider_, offset, length,
  8720. is_shutting_down);
  8721. });
  8722. }
  8723. inline bool has_framed_body(const Request &req) {
  8724. return is_chunked_transfer_encoding(req.headers) ||
  8725. req.get_header_value_u64("Content-Length") > 0;
  8726. }
  8727. inline bool is_connection_persistent(const Request &req) {
  8728. if (has_header_token(req.headers, "Connection", "close")) { return false; }
  8729. if (req.version == "HTTP/1.0" &&
  8730. !has_header_token(req.headers, "Connection", "keep-alive")) {
  8731. return false;
  8732. }
  8733. return true;
  8734. }
  8735. inline bool expect_content(const Request &req) {
  8736. if (req.method == "POST" || req.method == "PUT" || req.method == "PATCH" ||
  8737. req.method == "DELETE") {
  8738. return true;
  8739. }
  8740. return has_framed_body(req);
  8741. }
  8742. #ifdef _WIN32
  8743. class WSInit {
  8744. public:
  8745. WSInit() {
  8746. WSADATA wsaData;
  8747. if (WSAStartup(0x0002, &wsaData) == 0) is_valid_ = true;
  8748. }
  8749. ~WSInit() {
  8750. if (is_valid_) WSACleanup();
  8751. }
  8752. bool is_valid_ = false;
  8753. };
  8754. static WSInit wsinit_;
  8755. #endif
  8756. inline std::string unescape_quoted_pairs(const std::string &s) {
  8757. std::string out;
  8758. out.reserve(s.size());
  8759. for (size_t i = 0; i < s.size(); i++) {
  8760. if (s[i] == '\\' && i + 1 < s.size()) {
  8761. out += s[++i];
  8762. } else {
  8763. out += s[i];
  8764. }
  8765. }
  8766. return out;
  8767. }
  8768. // Inverse of unescape_quoted_pairs: prepares a value to sit inside a
  8769. // quoted-string. RFC 9110 §5.6.4 requires a literal '\' or '"' to be sent as a
  8770. // quoted-pair, so the recipient recovers the original value.
  8771. inline std::string escape_quoted_pairs(const std::string &s) {
  8772. std::string out;
  8773. out.reserve(s.size());
  8774. for (auto c : s) {
  8775. if (c == '\\' || c == '"') { out += '\\'; }
  8776. out += c;
  8777. }
  8778. return out;
  8779. }
  8780. // RFC 9110 Section 11.6.1 defines a challenge list as
  8781. // WWW-Authenticate = #challenge
  8782. // challenge = auth-scheme [ 1*SP ( token68 / [ #auth-param ] ) ]
  8783. // auth-param = token BWS "=" BWS ( token / quoted-string )
  8784. // so a server may offer several schemes, each with its own comma-separated
  8785. // auth-param list, in either order and either as separate field lines or
  8786. // packed into one. Splitting on every comma would break apart a challenge's
  8787. // own param list; splitting only on the first space would miss a Digest
  8788. // challenge that isn't first. Split on commas that aren't inside a
  8789. // quoted-string instead (split_unquoted), then track which scheme each
  8790. // resulting segment belongs to: a segment whose text before "=" contains
  8791. // whitespace (or that has no "=" at all) starts a new challenge named by its
  8792. // leading token.
  8793. inline bool parse_www_authenticate(const Response &res,
  8794. std::map<std::string, std::string> &auth,
  8795. bool is_proxy) {
  8796. auto auth_key = is_proxy ? "Proxy-Authenticate" : "WWW-Authenticate";
  8797. auto combined = get_combined_header_value(res.headers, auth_key);
  8798. if (combined.empty()) { return false; }
  8799. auto found_digest = false;
  8800. auto in_digest_challenge = false;
  8801. split_unquoted(
  8802. combined.data(), combined.data() + combined.size(), ',',
  8803. [&](const char *b, const char *e) {
  8804. std::string segment(b, e);
  8805. auto eq_pos = segment.find('=');
  8806. // BWS is allowed on both sides of "=", so the text naming the key (or,
  8807. // for the first segment of a challenge, "<scheme> <key>") must be
  8808. // trimmed before its boundaries are inspected.
  8809. auto key_part = trim_copy(
  8810. eq_pos == std::string::npos ? segment : segment.substr(0, eq_pos));
  8811. auto space_pos = key_part.find_last_of(" \t");
  8812. if (space_pos != std::string::npos || eq_pos == std::string::npos) {
  8813. // "<scheme>[ <key>]" starts a new challenge.
  8814. auto scheme_end =
  8815. space_pos == std::string::npos ? key_part.size() : space_pos;
  8816. // RFC 7616 Section 3.7: a server may offer more than one Digest
  8817. // challenge (e.g. SHA-256 and MD5); keep only the first so a nonce
  8818. // from one challenge is never paired with another's algorithm.
  8819. in_digest_challenge =
  8820. !found_digest &&
  8821. case_ignore::equal(key_part.substr(0, scheme_end), "Digest");
  8822. if (in_digest_challenge) { found_digest = true; }
  8823. if (space_pos == std::string::npos) {
  8824. // Bare scheme (or a token68), no auth-param on this segment.
  8825. return;
  8826. }
  8827. key_part = key_part.substr(space_pos + 1);
  8828. }
  8829. if (!in_digest_challenge) { return; }
  8830. auto val = trim_copy(segment.substr(eq_pos + 1));
  8831. auto unquoted = trim_double_quotes_copy(val);
  8832. if (unquoted.size() != val.size()) {
  8833. unquoted = unescape_quoted_pairs(unquoted);
  8834. }
  8835. auth[std::move(key_part)] = std::move(unquoted);
  8836. });
  8837. // RFC 7616 Section 3.3 requires realm and nonce on every Digest challenge;
  8838. // make_digest_authentication_header() dereferences both unconditionally, so
  8839. // a challenge missing either can't produce a usable Authorization header.
  8840. // Treat it the same as no Digest challenge at all.
  8841. return found_digest && auth.find("realm") != auth.end() &&
  8842. auth.find("nonce") != auth.end();
  8843. }
  8844. class ContentProviderAdapter {
  8845. public:
  8846. explicit ContentProviderAdapter(
  8847. ContentProviderWithoutLength &&content_provider)
  8848. : content_provider_(std::move(content_provider)) {}
  8849. bool operator()(size_t offset, size_t, DataSink &sink) {
  8850. return content_provider_(offset, sink);
  8851. }
  8852. private:
  8853. ContentProviderWithoutLength content_provider_;
  8854. };
  8855. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  8856. namespace fields {
  8857. inline bool is_token_char(char c) {
  8858. return is_ascii_alnum(c) || c == '!' || c == '#' || c == '$' || c == '%' ||
  8859. c == '&' || c == '\'' || c == '*' || c == '+' || c == '-' ||
  8860. c == '.' || c == '^' || c == '_' || c == '`' || c == '|' || c == '~';
  8861. }
  8862. inline bool is_token(const std::string &s) {
  8863. if (s.empty()) { return false; }
  8864. for (auto c : s) {
  8865. if (!is_token_char(c)) { return false; }
  8866. }
  8867. return true;
  8868. }
  8869. inline bool is_field_name(const std::string &s) { return is_token(s); }
  8870. inline bool is_vchar(char c) { return c >= 33 && c <= 126; }
  8871. inline bool is_obs_text(char c) { return 128 <= static_cast<unsigned char>(c); }
  8872. inline bool is_field_vchar(char c) { return is_vchar(c) || is_obs_text(c); }
  8873. inline bool is_field_content(const std::string &s) {
  8874. if (s.empty()) { return true; }
  8875. if (s.size() == 1) {
  8876. return is_field_vchar(s[0]);
  8877. } else if (s.size() == 2) {
  8878. return is_field_vchar(s[0]) && is_field_vchar(s[1]);
  8879. } else {
  8880. size_t i = 0;
  8881. if (!is_field_vchar(s[i])) { return false; }
  8882. i++;
  8883. while (i < s.size() - 1) {
  8884. auto c = s[i++];
  8885. if (c == ' ' || c == '\t' || is_field_vchar(c)) {
  8886. } else {
  8887. return false;
  8888. }
  8889. }
  8890. return is_field_vchar(s[i]);
  8891. }
  8892. }
  8893. inline bool is_field_value(const std::string &s) { return is_field_content(s); }
  8894. inline bool is_field_valid(const std::string &name, const std::string &value) {
  8895. return is_field_name(name) && is_field_value(value);
  8896. }
  8897. // RFC 9112 §2.2/§3.2: the request-target has no SP, HTAB or other control
  8898. // characters (incl. bare CR). obs-text (raw UTF-8) is allowed.
  8899. inline bool is_request_target(const std::string &s) {
  8900. return std::all_of(s.begin(), s.end(), is_field_vchar);
  8901. }
  8902. // RFC 9110 §7.2: the bytes of uri-host [ ":" port ], i.e. unreserved,
  8903. // sub-delims, "%", ":" and the IP-literal brackets. An empty value is valid.
  8904. inline bool is_host(const std::string &s) {
  8905. return std::all_of(s.begin(), s.end(), [](char c) {
  8906. return is_ascii_alnum(c) || c == '-' || c == '.' || c == '_' || c == '~' ||
  8907. c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  8908. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  8909. c == '=' || c == '%' || c == ':' || c == '[' || c == ']';
  8910. });
  8911. }
  8912. } // namespace fields
  8913. // Built in memory first, like ClientImpl::write_request, so a rejected header
  8914. // never leaves a partial request on the wire.
  8915. inline bool write_request_head(Stream &strm, Request &req, Error &error) {
  8916. BufferStream bstrm;
  8917. if (write_request_line(bstrm, req.method, req.path) < 0) {
  8918. error = Error::Write;
  8919. return false;
  8920. }
  8921. if (!check_and_write_headers(bstrm, req.headers, write_headers, error)) {
  8922. return false;
  8923. }
  8924. const auto &data = bstrm.get_buffer();
  8925. if (!write_data(strm, data.data(), data.size())) {
  8926. error = Error::Write;
  8927. return false;
  8928. }
  8929. return true;
  8930. }
  8931. inline bool perform_websocket_handshake(Stream &strm, Request &req,
  8932. WebSocketUpgradeResponse &upgrade) {
  8933. // Generate a random 16-byte Sec-WebSocket-Key (RFC 6455 Section 4.1)
  8934. std::string key_bytes(16, '\0');
  8935. fill_random_bytes(reinterpret_cast<unsigned char *>(&key_bytes[0]),
  8936. key_bytes.size());
  8937. auto client_key = base64_encode(key_bytes);
  8938. req.headers.erase("Upgrade");
  8939. req.headers.erase("Connection");
  8940. req.headers.erase("Sec-WebSocket-Key");
  8941. req.headers.erase("Sec-WebSocket-Version");
  8942. req.headers.emplace("Upgrade", "websocket");
  8943. req.headers.emplace("Connection", "Upgrade");
  8944. req.headers.emplace("Sec-WebSocket-Key", client_key);
  8945. req.headers.emplace("Sec-WebSocket-Version", "13");
  8946. if (!write_request_head(strm, req, upgrade.error)) { return false; }
  8947. // Verify 101 response and Sec-WebSocket-Accept header
  8948. auto expected_accept = websocket_accept_key(client_key);
  8949. auto offered_subprotocols =
  8950. get_combined_header_value(req.headers, "Sec-WebSocket-Protocol");
  8951. return read_websocket_upgrade_response(strm, expected_accept,
  8952. offered_subprotocols, upgrade);
  8953. }
  8954. inline bool is_ip_address(const std::string &host) {
  8955. struct in_addr addr4;
  8956. struct in6_addr addr6;
  8957. return inet_pton(AF_INET, host.c_str(), &addr4) == 1 ||
  8958. inet_pton(AF_INET6, host.c_str(), &addr6) == 1;
  8959. }
  8960. // Resolve where a client should connect for `host`, honoring a user-supplied
  8961. // hostname-to-address map. `host` itself is never rewritten, so it keeps
  8962. // supplying the Host header and SNI; only the connection target changes.
  8963. //
  8964. // A mapped IP literal goes to `ip`, which keeps create_socket's AI_NUMERICHOST
  8965. // path. Anything else goes to `connect_host`, which create_socket resolves as
  8966. // a name, or uses as the socket path when the address family is AF_UNIX. An
  8967. // absent or empty mapping leaves `host` as the connection target; without the
  8968. // empty check the value would reach getaddrinfo as a null node and silently
  8969. // resolve to loopback.
  8970. inline void apply_addr_map(const std::map<std::string, std::string> &addr_map,
  8971. const std::string &host, std::string &connect_host,
  8972. std::string &ip) {
  8973. connect_host = host;
  8974. ip.clear();
  8975. auto it = addr_map.find(host);
  8976. if (it == addr_map.end() || it->second.empty()) { return; }
  8977. if (is_ip_address(it->second)) {
  8978. ip = it->second;
  8979. } else {
  8980. connect_host = it->second;
  8981. }
  8982. }
  8983. } // namespace detail
  8984. /*
  8985. * Group 2: detail namespace - SSL common utilities
  8986. */
  8987. #ifdef CPPHTTPLIB_SSL_ENABLED
  8988. namespace detail {
  8989. class SSLSocketStream final : public Stream {
  8990. public:
  8991. SSLSocketStream(
  8992. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  8993. time_t read_timeout_usec, time_t write_timeout_sec,
  8994. time_t write_timeout_usec, time_t max_timeout_msec = 0,
  8995. std::chrono::time_point<std::chrono::steady_clock> start_time =
  8996. (std::chrono::steady_clock::time_point::min)());
  8997. ~SSLSocketStream() override;
  8998. bool is_readable() const override;
  8999. bool wait_readable() const override;
  9000. bool wait_writable() const override;
  9001. bool is_peer_alive() const override;
  9002. ssize_t read(char *ptr, size_t size) override;
  9003. ssize_t write(const char *ptr, size_t size) override;
  9004. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  9005. void get_local_ip_and_port(std::string &ip, int &port) const override;
  9006. socket_t socket() const override;
  9007. time_t duration() const override;
  9008. void set_read_timeout(time_t sec, time_t usec = 0) override;
  9009. void set_max_timeout(time_t msec) override;
  9010. void set_read_interrupt(std::function<bool()> interrupted) override;
  9011. // See SocketStream::set_readable_hint().
  9012. void set_readable_hint() { readable_hint_ = true; }
  9013. // The error from the last read() or write() that failed in the TLS layer,
  9014. // with code Success if none did
  9015. const tls::TlsError &tls_error() const { return tls_error_; }
  9016. private:
  9017. bool ensure_readable();
  9018. socket_t sock_;
  9019. tls::session_t session_;
  9020. time_t read_timeout_sec_;
  9021. time_t read_timeout_usec_;
  9022. time_t write_timeout_sec_;
  9023. time_t write_timeout_usec_;
  9024. time_t max_timeout_msec_;
  9025. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  9026. std::function<bool()> read_interrupted_;
  9027. bool readable_hint_ = false;
  9028. tls::TlsError tls_error_;
  9029. };
  9030. // A TLS stream for WebSocket connections, where the receive path and the
  9031. // send path (application send() plus the heartbeat ping thread) run on
  9032. // different threads. A single TLS session must never be entered
  9033. // concurrently, so every call into the session is serialized by one mutex.
  9034. //
  9035. // Unlike SSLSocketStream, the socket is kept non-blocking for the stream's
  9036. // whole lifetime and each read()/write() performs a single non-blocking TLS
  9037. // call under the lock, then waits for readiness with select() outside the
  9038. // lock. The lock is therefore held only for CPU-bound work, so a reader
  9039. // blocked waiting for data never stalls a concurrent sender.
  9040. //
  9041. // This stream is used only for wss:// connections. Plain ws:// and ordinary
  9042. // HTTP/HTTPS keep using SocketStream/SSLSocketStream unchanged.
  9043. class WebSocketSSLStream final : public Stream {
  9044. public:
  9045. WebSocketSSLStream(socket_t sock, tls::session_t session,
  9046. time_t read_timeout_sec, time_t read_timeout_usec,
  9047. time_t write_timeout_sec, time_t write_timeout_usec);
  9048. ~WebSocketSSLStream() override;
  9049. bool is_readable() const override;
  9050. bool wait_readable() const override;
  9051. bool wait_writable() const override;
  9052. ssize_t read(char *ptr, size_t size) override;
  9053. ssize_t write(const char *ptr, size_t size) override;
  9054. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  9055. void get_local_ip_and_port(std::string &ip, int &port) const override;
  9056. socket_t socket() const override;
  9057. time_t duration() const override;
  9058. void set_read_timeout(time_t sec, time_t usec = 0) override;
  9059. void set_read_interrupt(std::function<bool()> interrupted) override;
  9060. private:
  9061. mutable std::mutex session_mutex_;
  9062. socket_t sock_;
  9063. tls::session_t session_;
  9064. // WebSocket::close() shortens the read timeout from the closing thread
  9065. // while the receive thread is inside wait_readable(), so these two are read
  9066. // and written concurrently. The write timeouts are never mutated.
  9067. std::atomic<time_t> read_timeout_sec_;
  9068. std::atomic<time_t> read_timeout_usec_;
  9069. time_t write_timeout_sec_;
  9070. time_t write_timeout_usec_;
  9071. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  9072. std::function<bool()> read_interrupted_;
  9073. };
  9074. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  9075. inline std::string message_digest(const std::string &s, const EVP_MD *algo) {
  9076. auto context = std::unique_ptr<EVP_MD_CTX, decltype(&EVP_MD_CTX_free)>(
  9077. EVP_MD_CTX_new(), EVP_MD_CTX_free);
  9078. unsigned int hash_length = 0;
  9079. unsigned char hash[EVP_MAX_MD_SIZE];
  9080. EVP_DigestInit_ex(context.get(), algo, nullptr);
  9081. EVP_DigestUpdate(context.get(), s.c_str(), s.size());
  9082. EVP_DigestFinal_ex(context.get(), hash, &hash_length);
  9083. std::stringstream ss;
  9084. for (auto i = 0u; i < hash_length; ++i) {
  9085. ss << std::hex << std::setw(2) << std::setfill('0')
  9086. << static_cast<unsigned int>(hash[i]);
  9087. }
  9088. return ss.str();
  9089. }
  9090. inline std::string MD5(const std::string &s) {
  9091. return message_digest(s, EVP_md5());
  9092. }
  9093. inline std::string SHA_256(const std::string &s) {
  9094. return message_digest(s, EVP_sha256());
  9095. }
  9096. inline std::string SHA_512(const std::string &s) {
  9097. return message_digest(s, EVP_sha512());
  9098. }
  9099. #elif defined(CPPHTTPLIB_MBEDTLS_SUPPORT)
  9100. namespace {
  9101. template <size_t N>
  9102. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  9103. std::stringstream ss;
  9104. for (size_t i = 0; i < N; ++i) {
  9105. ss << std::hex << std::setw(2) << std::setfill('0')
  9106. << static_cast<unsigned int>(hash[i]);
  9107. }
  9108. return ss.str();
  9109. }
  9110. } // namespace
  9111. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9112. // Mbed TLS 4.x provides hashing (and TLS RNG) via PSA Crypto, which must be
  9113. // initialized once. PSA state is process-global; do not free it.
  9114. inline bool ensure_mbedtls_psa_crypto() {
  9115. static std::once_flag once;
  9116. static bool ok = false;
  9117. std::call_once(once, []() { ok = (psa_crypto_init() == PSA_SUCCESS); });
  9118. return ok;
  9119. }
  9120. inline bool psa_hash(psa_algorithm_t alg, const std::string &s,
  9121. unsigned char *out, size_t out_size) {
  9122. if (!ensure_mbedtls_psa_crypto()) { return false; }
  9123. size_t olen = 0;
  9124. return psa_hash_compute(alg, reinterpret_cast<const uint8_t *>(s.data()),
  9125. s.size(), out, out_size, &olen) == PSA_SUCCESS &&
  9126. olen == out_size;
  9127. }
  9128. #endif
  9129. inline std::string MD5(const std::string &s) {
  9130. unsigned char hash[16];
  9131. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9132. if (!psa_hash(PSA_ALG_MD5, s, hash, sizeof(hash))) { return {}; }
  9133. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9134. mbedtls_md5(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9135. hash);
  9136. #else
  9137. mbedtls_md5_ret(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9138. hash);
  9139. #endif
  9140. return hash_to_hex(hash);
  9141. }
  9142. inline std::string SHA_256(const std::string &s) {
  9143. unsigned char hash[32];
  9144. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9145. if (!psa_hash(PSA_ALG_SHA_256, s, hash, sizeof(hash))) { return {}; }
  9146. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9147. mbedtls_sha256(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9148. hash, 0);
  9149. #else
  9150. mbedtls_sha256_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9151. s.size(), hash, 0);
  9152. #endif
  9153. return hash_to_hex(hash);
  9154. }
  9155. inline std::string SHA_512(const std::string &s) {
  9156. unsigned char hash[64];
  9157. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9158. if (!psa_hash(PSA_ALG_SHA_512, s, hash, sizeof(hash))) { return {}; }
  9159. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9160. mbedtls_sha512(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9161. hash, 0);
  9162. #else
  9163. mbedtls_sha512_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9164. s.size(), hash, 0);
  9165. #endif
  9166. return hash_to_hex(hash);
  9167. }
  9168. #elif defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9169. namespace {
  9170. template <size_t N>
  9171. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  9172. std::stringstream ss;
  9173. for (size_t i = 0; i < N; ++i) {
  9174. ss << std::hex << std::setw(2) << std::setfill('0')
  9175. << static_cast<unsigned int>(hash[i]);
  9176. }
  9177. return ss.str();
  9178. }
  9179. } // namespace
  9180. inline std::string MD5(const std::string &s) {
  9181. unsigned char hash[WC_MD5_DIGEST_SIZE];
  9182. wc_Md5Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9183. static_cast<word32>(s.size()), hash);
  9184. return hash_to_hex(hash);
  9185. }
  9186. inline std::string SHA_256(const std::string &s) {
  9187. unsigned char hash[WC_SHA256_DIGEST_SIZE];
  9188. wc_Sha256Hash(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_512(const std::string &s) {
  9193. unsigned char hash[WC_SHA512_DIGEST_SIZE];
  9194. wc_Sha512Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9195. static_cast<word32>(s.size()), hash);
  9196. return hash_to_hex(hash);
  9197. }
  9198. #endif
  9199. template <typename T>
  9200. inline bool process_server_socket_ssl(
  9201. const std::atomic<socket_t> &svr_sock, tls::session_t session,
  9202. socket_t sock, size_t keep_alive_max_count, time_t keep_alive_timeout_sec,
  9203. time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec,
  9204. time_t write_timeout_usec, T callback) {
  9205. // See process_server_socket(). The TLS library keeps already decrypted bytes
  9206. // of a pipelined request, which keep_alive() cannot see on the socket.
  9207. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9208. write_timeout_sec, write_timeout_usec);
  9209. return process_server_socket_core(
  9210. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  9211. [&]() { return strm.is_readable(); },
  9212. [&](bool socket_readable, bool close_connection,
  9213. bool &connection_closed) {
  9214. if (socket_readable) { strm.set_readable_hint(); }
  9215. return callback(strm, close_connection, connection_closed);
  9216. });
  9217. }
  9218. template <typename T>
  9219. inline bool process_client_socket_ssl(
  9220. tls::session_t session, socket_t sock, time_t read_timeout_sec,
  9221. time_t read_timeout_usec, time_t write_timeout_sec,
  9222. time_t write_timeout_usec, time_t max_timeout_msec,
  9223. std::chrono::time_point<std::chrono::steady_clock> start_time, T callback) {
  9224. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9225. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  9226. start_time);
  9227. return callback(strm);
  9228. }
  9229. // `uri` is req's request-target in origin form, as curl sends it, also when
  9230. // the request line carries the absolute form for a proxy.
  9231. inline std::pair<std::string, std::string> make_digest_authentication_header(
  9232. const Request &req, const std::string &uri,
  9233. const std::map<std::string, std::string> &auth, size_t cnonce_count,
  9234. const std::string &cnonce, const std::string &username,
  9235. const std::string &password, bool is_proxy = false) {
  9236. std::string nc;
  9237. {
  9238. std::stringstream ss;
  9239. ss << std::setfill('0') << std::setw(8) << std::hex << cnonce_count;
  9240. nc = ss.str();
  9241. }
  9242. std::string qop;
  9243. if (auth.find("qop") != auth.end()) {
  9244. qop = auth.at("qop");
  9245. if (qop.find("auth-int") != std::string::npos) {
  9246. qop = "auth-int";
  9247. } else if (qop.find("auth") != std::string::npos) {
  9248. qop = "auth";
  9249. } else {
  9250. qop.clear();
  9251. }
  9252. }
  9253. std::string algo = "MD5";
  9254. if (auth.find("algorithm") != auth.end()) {
  9255. // algorithm is an unquoted token (RFC 7616 §3.4). A server value that is
  9256. // not a token would otherwise be emitted verbatim and could carry commas
  9257. // or quotes that inject further auth-params into the header below.
  9258. const auto &a = auth.at("algorithm");
  9259. if (fields::is_token(a)) { algo = a; }
  9260. }
  9261. std::string response;
  9262. {
  9263. auto H = algo == "SHA-256" ? detail::SHA_256
  9264. : algo == "SHA-512" ? detail::SHA_512
  9265. : detail::MD5;
  9266. auto A1 = username + ":" + auth.at("realm") + ":" + password;
  9267. auto A2 = req.method + ":" + uri;
  9268. if (qop == "auth-int") { A2 += ":" + H(req.body); }
  9269. if (qop.empty()) {
  9270. response = H(H(A1) + ":" + auth.at("nonce") + ":" + H(A2));
  9271. } else {
  9272. response = H(H(A1) + ":" + auth.at("nonce") + ":" + nc + ":" + cnonce +
  9273. ":" + qop + ":" + H(A2));
  9274. }
  9275. }
  9276. auto opaque = (auth.find("opaque") != auth.end()) ? auth.at("opaque") : "";
  9277. // Every value placed inside a quoted-string is escaped so a '"' in it cannot
  9278. // close the string early. realm, nonce and opaque come straight from the
  9279. // server's challenge (parse_www_authenticate() already de-escaped them), so
  9280. // without this a crafted challenge injects extra auth-params into the header.
  9281. auto field =
  9282. "Digest username=\"" + detail::escape_quoted_pairs(username) +
  9283. "\", realm=\"" + detail::escape_quoted_pairs(auth.at("realm")) +
  9284. "\", nonce=\"" + detail::escape_quoted_pairs(auth.at("nonce")) +
  9285. "\", uri=\"" + detail::escape_quoted_pairs(uri) +
  9286. "\", algorithm=" + algo +
  9287. (qop.empty() ? ", response=\""
  9288. : ", qop=" + qop + ", nc=" + nc + ", cnonce=\"" + cnonce +
  9289. "\", response=\"") +
  9290. response + "\"" +
  9291. (opaque.empty()
  9292. ? ""
  9293. : ", opaque=\"" + detail::escape_quoted_pairs(opaque) + "\"");
  9294. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9295. return std::make_pair(key, field);
  9296. }
  9297. // Follows X509_check_host, which the OpenSSL backend uses, so that every
  9298. // backend accepts the same names.
  9299. inline bool match_hostname(const std::string &pattern,
  9300. const std::string &hostname) {
  9301. // A trailing dot on the host is ignored
  9302. auto host = hostname;
  9303. if (host.size() > 1 && host.back() == '.') { host.pop_back(); }
  9304. // Exact match (case-insensitive)
  9305. if (detail::case_ignore::equal(host, pattern)) { return true; }
  9306. // Split both pattern and hostname into components by '.', keeping any empty
  9307. // one, which no name may have
  9308. auto labels = [](const std::string &s) {
  9309. std::vector<std::string> v;
  9310. size_t b = 0;
  9311. while (true) {
  9312. auto e = s.find('.', b);
  9313. v.push_back(s.substr(b, e - b));
  9314. if (e == std::string::npos) { return v; }
  9315. b = e + 1;
  9316. }
  9317. };
  9318. auto pattern_components = labels(pattern);
  9319. auto host_components = labels(host);
  9320. auto has_empty_label = [](const std::vector<std::string> &v) {
  9321. return std::any_of(v.begin(), v.end(),
  9322. [](const std::string &l) { return l.empty(); });
  9323. };
  9324. if (has_empty_label(pattern_components) || has_empty_label(host_components)) {
  9325. return false;
  9326. }
  9327. // Component count must match
  9328. if (host_components.size() != pattern_components.size()) { return false; }
  9329. // A wildcard needs two labels after it, so that "*.com" matches nothing,
  9330. // and an IDNA label may not have one
  9331. const auto &leftmost = pattern_components.front();
  9332. if (leftmost.find('*') != std::string::npos &&
  9333. (pattern_components.size() < 3 ||
  9334. case_ignore::equal(leftmost.substr(0, 4), "xn--"))) {
  9335. return false;
  9336. }
  9337. // Compare each component with wildcard support
  9338. // Supports: "*" (full wildcard), "prefix*" (partial wildcard)
  9339. // https://bugs.launchpad.net/ubuntu/+source/firefox-3.0/+bug/376484
  9340. // Only the leftmost label may carry a wildcard (RFC 6125 6.4.3)
  9341. auto itr = pattern_components.begin();
  9342. for (const auto &h : host_components) {
  9343. auto &p = *itr;
  9344. auto is_leftmost = itr == pattern_components.begin();
  9345. if (!detail::case_ignore::equal(p, h) && !(is_leftmost && p == "*")) {
  9346. bool partial_match = false;
  9347. if (is_leftmost && !p.empty() && p[p.size() - 1] == '*') {
  9348. const auto prefix_length = p.size() - 1;
  9349. if (prefix_length == 0) {
  9350. partial_match = true;
  9351. } else if (h.size() >= prefix_length) {
  9352. partial_match =
  9353. std::equal(p.begin(),
  9354. p.begin() + static_cast<std::string::difference_type>(
  9355. prefix_length),
  9356. h.begin(), [](const char ca, const char cb) {
  9357. return detail::case_ignore::to_lower(ca) ==
  9358. detail::case_ignore::to_lower(cb);
  9359. });
  9360. }
  9361. }
  9362. if (!partial_match) { return false; }
  9363. }
  9364. ++itr;
  9365. }
  9366. return true;
  9367. }
  9368. #ifdef _WIN32
  9369. // Verify certificate using Windows CertGetCertificateChain API.
  9370. // This provides real-time certificate validation with Windows Update
  9371. // integration, independent of the TLS backend.
  9372. inline bool verify_cert_with_windows_schannel(
  9373. const std::vector<unsigned char> &der_cert, const std::string &hostname,
  9374. bool verify_hostname, uint64_t &out_error, tls::const_session_t session) {
  9375. if (der_cert.empty()) { return false; }
  9376. out_error = 0;
  9377. // Create Windows certificate context from DER data
  9378. auto cert_context = CertCreateCertificateContext(
  9379. X509_ASN_ENCODING | PKCS_7_ASN_ENCODING, der_cert.data(),
  9380. static_cast<DWORD>(der_cert.size()));
  9381. if (!cert_context) {
  9382. out_error = GetLastError();
  9383. return false;
  9384. }
  9385. auto cert_guard =
  9386. scope_exit([&] { CertFreeCertificateContext(cert_context); });
  9387. // Give CryptoAPI the certificates the server sent. Without them it follows
  9388. // the leaf's AIA URL, which may lead to an issuer under an untrusted root.
  9389. std::vector<tls::cert_t> peer_certs;
  9390. tls::get_peer_certs(session, peer_certs);
  9391. auto store = CertOpenStore(CERT_STORE_PROV_MEMORY, 0, 0, 0, nullptr);
  9392. auto store_guard = scope_exit([&] {
  9393. for (auto cert : peer_certs) {
  9394. tls::free_cert(cert);
  9395. }
  9396. if (store) { CertCloseStore(store, 0); }
  9397. });
  9398. for (auto cert : peer_certs) {
  9399. std::vector<unsigned char> der;
  9400. if (store && tls::get_cert_der(cert, der)) {
  9401. CertAddEncodedCertificateToStore(store, X509_ASN_ENCODING, der.data(),
  9402. static_cast<DWORD>(der.size()),
  9403. CERT_STORE_ADD_USE_EXISTING, nullptr);
  9404. }
  9405. }
  9406. // Setup chain parameters
  9407. CERT_CHAIN_PARA chain_para = {};
  9408. chain_para.cbSize = sizeof(chain_para);
  9409. // Require the server authentication usage along the chain, which also
  9410. // rejects roots that Windows trusts only for other purposes.
  9411. LPSTR server_auth = const_cast<LPSTR>(szOID_PKIX_KP_SERVER_AUTH);
  9412. chain_para.RequestedUsage.dwType = USAGE_MATCH_TYPE_AND;
  9413. chain_para.RequestedUsage.Usage.cUsageIdentifier = 1;
  9414. chain_para.RequestedUsage.Usage.rgpszUsageIdentifier = &server_auth;
  9415. // Build certificate chain with revocation checking
  9416. PCCERT_CHAIN_CONTEXT chain_context = nullptr;
  9417. auto chain_result = CertGetCertificateChain(
  9418. nullptr, cert_context, nullptr, store, &chain_para,
  9419. CERT_CHAIN_CACHE_END_CERT | CERT_CHAIN_REVOCATION_CHECK_END_CERT |
  9420. CERT_CHAIN_REVOCATION_ACCUMULATIVE_TIMEOUT,
  9421. nullptr, &chain_context);
  9422. if (!chain_result || !chain_context) {
  9423. out_error = GetLastError();
  9424. return false;
  9425. }
  9426. auto chain_guard =
  9427. scope_exit([&] { CertFreeCertificateChain(chain_context); });
  9428. // Verify SSL policy
  9429. SSL_EXTRA_CERT_CHAIN_POLICY_PARA extra_policy_para = {};
  9430. extra_policy_para.cbSize = sizeof(extra_policy_para);
  9431. #ifdef AUTHTYPE_SERVER
  9432. extra_policy_para.dwAuthType = AUTHTYPE_SERVER;
  9433. #endif
  9434. std::wstring whost;
  9435. if (verify_hostname) {
  9436. whost = u8string_to_wstring(hostname.c_str());
  9437. extra_policy_para.pwszServerName = const_cast<wchar_t *>(whost.c_str());
  9438. }
  9439. CERT_CHAIN_POLICY_PARA policy_para = {};
  9440. policy_para.cbSize = sizeof(policy_para);
  9441. #ifdef CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS
  9442. policy_para.dwFlags = CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS;
  9443. #else
  9444. policy_para.dwFlags = 0;
  9445. #endif
  9446. policy_para.pvExtraPolicyPara = &extra_policy_para;
  9447. CERT_CHAIN_POLICY_STATUS policy_status = {};
  9448. policy_status.cbSize = sizeof(policy_status);
  9449. if (!CertVerifyCertificateChainPolicy(CERT_CHAIN_POLICY_SSL, chain_context,
  9450. &policy_para, &policy_status)) {
  9451. out_error = GetLastError();
  9452. return false;
  9453. }
  9454. if (policy_status.dwError != 0) {
  9455. out_error = policy_status.dwError;
  9456. return false;
  9457. }
  9458. return true;
  9459. }
  9460. #endif // _WIN32
  9461. // Loads CA file/dir configuration and applies the system CA policy to a
  9462. // client TLS context. PEM data and native stores are applied to the context
  9463. // directly at set time; has_custom_store reflects them for the Auto policy
  9464. // decision.
  9465. inline bool load_client_ca_config(tls::ctx_t ctx,
  9466. const std::string &ca_cert_file_path,
  9467. const std::string &ca_cert_dir_path,
  9468. bool has_custom_store, SystemCAMode mode,
  9469. uint64_t &backend_error) {
  9470. auto ret = true;
  9471. if (!ca_cert_file_path.empty()) {
  9472. if (!tls::load_ca_file(ctx, ca_cert_file_path.c_str())) {
  9473. backend_error = tls::get_error();
  9474. ret = false;
  9475. }
  9476. } else if (!ca_cert_dir_path.empty()) {
  9477. if (!tls::load_ca_dir(ctx, ca_cert_dir_path.c_str())) {
  9478. backend_error = tls::get_error();
  9479. ret = false;
  9480. }
  9481. }
  9482. auto has_custom_ca = !ca_cert_file_path.empty() ||
  9483. !ca_cert_dir_path.empty() || has_custom_store;
  9484. if (mode == SystemCAMode::Enabled ||
  9485. (mode == SystemCAMode::Auto && !has_custom_ca)) {
  9486. if (!tls::load_system_certs(ctx)) { backend_error = tls::get_error(); }
  9487. }
  9488. return ret;
  9489. }
  9490. // Serializes the CA certificates installed in ctx as PEM, so they can be
  9491. // loaded into another context.
  9492. inline std::string ca_certs_to_pem(tls::ctx_t ctx) {
  9493. std::string pem;
  9494. std::vector<tls::cert_t> certs;
  9495. tls::get_ca_certs(ctx, certs);
  9496. for (auto cert : certs) {
  9497. std::vector<unsigned char> der;
  9498. if (tls::get_cert_der(cert, der)) {
  9499. auto b64 = base64_encode(std::string(der.begin(), der.end()));
  9500. pem += "-----BEGIN CERTIFICATE-----\n";
  9501. for (size_t i = 0; i < b64.size(); i += 64) {
  9502. pem += b64.substr(i, 64);
  9503. pem += '\n';
  9504. }
  9505. pem += "-----END CERTIFICATE-----\n";
  9506. }
  9507. tls::free_cert(cert);
  9508. }
  9509. return pem;
  9510. }
  9511. // Returns a PemMemory field as a NUL-terminated string: its first len bytes,
  9512. // copied to buf, or pem itself when len is 0.
  9513. inline const char *pem_c_str(const char *pem, size_t len, std::string &buf) {
  9514. if (!pem || len == 0) { return pem; }
  9515. buf.assign(pem, len);
  9516. return buf.c_str();
  9517. }
  9518. // The parts of session setup that only SSLClient needs, plus the handful
  9519. // WebSocketClient also exposes; everything else takes the defaults, which is
  9520. // what keeps the two clients on one implementation.
  9521. struct ClientTlsSessionOptions {
  9522. // Both SSLClient and WebSocketClient expose this independently of
  9523. // certificate verification.
  9524. bool server_hostname_verification = true;
  9525. std::function<SSLVerifierResponse(tls::session_t)> session_verifier;
  9526. // When non-null, guards session creation against concurrent use of the
  9527. // context. A WebSocketClient is not safe to use from several threads to
  9528. // begin with, so it passes nothing.
  9529. std::mutex *ctx_mutex = nullptr;
  9530. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9531. // The caller decides whether Schannel has anything to say about this
  9532. // connection; see SSLClient::initialize_ssl().
  9533. bool windows_cert_verification = false;
  9534. // A server certificate verifier works on the backend's chain verification,
  9535. // so the backend keeps deciding and Schannel only adds its own check.
  9536. bool server_certificate_verifier_set = false;
  9537. #endif
  9538. };
  9539. // Filled in on failure for callers that report error details.
  9540. struct ClientTlsSessionError {
  9541. Error error = Error::Success;
  9542. int ssl_error = 0;
  9543. uint64_t backend_error = 0;
  9544. };
  9545. // Establishes a client TLS session on an already connected socket. On failure
  9546. // the session is left for the caller to free: SSLClient frees it right away,
  9547. // WebSocketClient keeps it in a member that shutdown_and_close() cleans up.
  9548. inline bool setup_client_tls_session(
  9549. const std::string &host, tls::ctx_t ctx, tls::session_t &session,
  9550. socket_t sock, bool server_certificate_verification, time_t timeout_sec,
  9551. time_t timeout_usec, ClientTlsSessionError *out_error = nullptr,
  9552. const ClientTlsSessionOptions &options = ClientTlsSessionOptions()) {
  9553. using namespace tls;
  9554. auto fail = [&](Error error, int ssl_error, uint64_t backend_error) {
  9555. if (out_error) {
  9556. out_error->error = error;
  9557. out_error->ssl_error = ssl_error;
  9558. out_error->backend_error = backend_error;
  9559. }
  9560. return false;
  9561. };
  9562. if (!ctx) {
  9563. session = nullptr;
  9564. return fail(Error::SSLConnection, 0, 0);
  9565. }
  9566. // With Windows verification on and no server certificate verifier set,
  9567. // Schannel is the only chain verifier. The backend's trust store is a
  9568. // snapshot of the Windows stores that lacks the roots Windows fetches on
  9569. // demand, so the backend's verdict is not used.
  9570. auto windows_verifies_chain = false;
  9571. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9572. windows_verifies_chain = options.windows_cert_verification &&
  9573. !options.server_certificate_verifier_set;
  9574. #endif
  9575. {
  9576. std::unique_lock<std::mutex> guard;
  9577. if (options.ctx_mutex) {
  9578. guard = std::unique_lock<std::mutex>(*options.ctx_mutex);
  9579. }
  9580. #if defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9581. // Mbed TLS and wolfSSL need the verification mode set explicitly, on the
  9582. // context, so under the same lock; OpenSSL uses SSL_VERIFY_NONE and does
  9583. // all verification post-handshake. Unless Schannel verifies the chain
  9584. // instead, chain verification happens during the handshake even for IP
  9585. // hosts; the certificate identity is verified post-handshake via
  9586. // verify_hostname().
  9587. set_verify_client(ctx, server_certificate_verification &&
  9588. !windows_verifies_chain);
  9589. #endif
  9590. session = create_session(ctx, sock);
  9591. }
  9592. if (!session) { return fail(Error::SSLConnection, 0, get_error()); }
  9593. // RFC 6066: SNI must not be set for IP addresses; skip it for IP hosts, so
  9594. // their identity is checked post-handshake below instead. On Mbed TLS and
  9595. // wolfSSL, set_sni also drives handshake-time hostname verification, so
  9596. // options.server_hostname_verification is threaded through here.
  9597. if (!is_ip_address(host)) {
  9598. if (!set_sni(session, host.c_str(), options.server_hostname_verification)) {
  9599. return fail(Error::SSLConnection, 0, get_error());
  9600. }
  9601. }
  9602. TlsError tls_err;
  9603. if (!connect_nonblocking(session, sock, timeout_sec, timeout_usec,
  9604. &tls_err)) {
  9605. auto error = Error::SSLConnection;
  9606. if (tls_err.code == ErrorCode::CertVerifyFailed) {
  9607. error = Error::SSLServerVerification;
  9608. } else if (tls_err.code == ErrorCode::HostnameMismatch) {
  9609. error = Error::SSLServerHostnameVerification;
  9610. }
  9611. return fail(error, static_cast<int>(tls_err.code), tls_err.backend_code);
  9612. }
  9613. auto verification_status = SSLVerifierResponse::NoDecisionMade;
  9614. if (options.session_verifier) {
  9615. verification_status = options.session_verifier(session);
  9616. }
  9617. if (verification_status == SSLVerifierResponse::CertificateRejected) {
  9618. return fail(Error::SSLServerVerification, 0, get_error());
  9619. }
  9620. if (verification_status == SSLVerifierResponse::NoDecisionMade &&
  9621. server_certificate_verification) {
  9622. if (!windows_verifies_chain) {
  9623. auto verify_result = get_verify_result(session);
  9624. if (verify_result != 0) {
  9625. return fail(Error::SSLServerVerification, 0,
  9626. static_cast<uint64_t>(verify_result));
  9627. }
  9628. }
  9629. auto server_cert = get_peer_cert(session);
  9630. if (!server_cert) {
  9631. return fail(Error::SSLServerVerification, 0, get_error());
  9632. }
  9633. auto cert_guard = detail::scope_exit([&] { free_cert(server_cert); });
  9634. // Identity check against the peer certificate, post-handshake for all
  9635. // backends. For IP hosts this is the only identity verification, since no
  9636. // hostname is bound during the handshake.
  9637. if (options.server_hostname_verification) {
  9638. if (!verify_hostname(server_cert, host.c_str())) {
  9639. return fail(Error::SSLServerHostnameVerification, 0,
  9640. hostname_mismatch_code());
  9641. }
  9642. }
  9643. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9644. // Windows Schannel verification, which lets Windows fetch missing roots
  9645. // and intermediates on demand. It must not be skipped: unless a server
  9646. // certificate verifier is set, it is the only chain check.
  9647. if (options.windows_cert_verification) {
  9648. std::vector<unsigned char> der;
  9649. uint64_t wincrypt_error = 0;
  9650. if (!get_cert_der(server_cert, der) ||
  9651. !verify_cert_with_windows_schannel(
  9652. der, host, options.server_hostname_verification, wincrypt_error,
  9653. session)) {
  9654. return fail(Error::SSLServerVerification, 0, wincrypt_error);
  9655. }
  9656. }
  9657. #endif
  9658. }
  9659. return true;
  9660. }
  9661. } // namespace detail
  9662. #endif // CPPHTTPLIB_SSL_ENABLED
  9663. /*
  9664. * Group 3: httplib namespace - Non-SSL public API implementations
  9665. */
  9666. inline void default_socket_options(socket_t sock) {
  9667. set_socket_opt(sock, SOL_SOCKET,
  9668. #ifdef SO_REUSEPORT
  9669. SO_REUSEPORT,
  9670. #else
  9671. SO_REUSEADDR,
  9672. #endif
  9673. 1);
  9674. }
  9675. inline bool set_socket_opt(socket_t sock, int level, int optname, int optval) {
  9676. return detail::set_socket_opt_impl(sock, level, optname, &optval,
  9677. sizeof(optval));
  9678. }
  9679. inline std::string get_bearer_token_auth(const Request &req) {
  9680. // The auth scheme is case-insensitive (RFC 9110 11.1), and a value shorter
  9681. // than the prefix carries no token.
  9682. constexpr const char bearer_prefix[] = "Bearer ";
  9683. constexpr auto bearer_prefix_len = detail::str_len(bearer_prefix);
  9684. auto value = req.get_header_value("Authorization");
  9685. if (value.size() >= bearer_prefix_len &&
  9686. detail::case_ignore::equal(value.substr(0, bearer_prefix_len),
  9687. bearer_prefix)) {
  9688. return value.substr(bearer_prefix_len);
  9689. }
  9690. return "";
  9691. }
  9692. inline const char *status_message(int status) {
  9693. switch (status) {
  9694. case StatusCode::Continue_100: return "Continue";
  9695. case StatusCode::SwitchingProtocol_101: return "Switching Protocol";
  9696. case StatusCode::Processing_102: return "Processing";
  9697. case StatusCode::EarlyHints_103: return "Early Hints";
  9698. case StatusCode::OK_200: return "OK";
  9699. case StatusCode::Created_201: return "Created";
  9700. case StatusCode::Accepted_202: return "Accepted";
  9701. case StatusCode::NonAuthoritativeInformation_203:
  9702. return "Non-Authoritative Information";
  9703. case StatusCode::NoContent_204: return "No Content";
  9704. case StatusCode::ResetContent_205: return "Reset Content";
  9705. case StatusCode::PartialContent_206: return "Partial Content";
  9706. case StatusCode::MultiStatus_207: return "Multi-Status";
  9707. case StatusCode::AlreadyReported_208: return "Already Reported";
  9708. case StatusCode::IMUsed_226: return "IM Used";
  9709. case StatusCode::MultipleChoices_300: return "Multiple Choices";
  9710. case StatusCode::MovedPermanently_301: return "Moved Permanently";
  9711. case StatusCode::Found_302: return "Found";
  9712. case StatusCode::SeeOther_303: return "See Other";
  9713. case StatusCode::NotModified_304: return "Not Modified";
  9714. case StatusCode::UseProxy_305: return "Use Proxy";
  9715. case StatusCode::unused_306: return "unused";
  9716. case StatusCode::TemporaryRedirect_307: return "Temporary Redirect";
  9717. case StatusCode::PermanentRedirect_308: return "Permanent Redirect";
  9718. case StatusCode::BadRequest_400: return "Bad Request";
  9719. case StatusCode::Unauthorized_401: return "Unauthorized";
  9720. case StatusCode::PaymentRequired_402: return "Payment Required";
  9721. case StatusCode::Forbidden_403: return "Forbidden";
  9722. case StatusCode::NotFound_404: return "Not Found";
  9723. case StatusCode::MethodNotAllowed_405: return "Method Not Allowed";
  9724. case StatusCode::NotAcceptable_406: return "Not Acceptable";
  9725. case StatusCode::ProxyAuthenticationRequired_407:
  9726. return "Proxy Authentication Required";
  9727. case StatusCode::RequestTimeout_408: return "Request Timeout";
  9728. case StatusCode::Conflict_409: return "Conflict";
  9729. case StatusCode::Gone_410: return "Gone";
  9730. case StatusCode::LengthRequired_411: return "Length Required";
  9731. case StatusCode::PreconditionFailed_412: return "Precondition Failed";
  9732. case StatusCode::PayloadTooLarge_413: return "Payload Too Large";
  9733. case StatusCode::UriTooLong_414: return "URI Too Long";
  9734. case StatusCode::UnsupportedMediaType_415: return "Unsupported Media Type";
  9735. case StatusCode::RangeNotSatisfiable_416: return "Range Not Satisfiable";
  9736. case StatusCode::ExpectationFailed_417: return "Expectation Failed";
  9737. case StatusCode::ImATeapot_418: return "I'm a teapot";
  9738. case StatusCode::MisdirectedRequest_421: return "Misdirected Request";
  9739. case StatusCode::UnprocessableContent_422: return "Unprocessable Content";
  9740. case StatusCode::Locked_423: return "Locked";
  9741. case StatusCode::FailedDependency_424: return "Failed Dependency";
  9742. case StatusCode::TooEarly_425: return "Too Early";
  9743. case StatusCode::UpgradeRequired_426: return "Upgrade Required";
  9744. case StatusCode::PreconditionRequired_428: return "Precondition Required";
  9745. case StatusCode::TooManyRequests_429: return "Too Many Requests";
  9746. case StatusCode::RequestHeaderFieldsTooLarge_431:
  9747. return "Request Header Fields Too Large";
  9748. case StatusCode::UnavailableForLegalReasons_451:
  9749. return "Unavailable For Legal Reasons";
  9750. case StatusCode::NotImplemented_501: return "Not Implemented";
  9751. case StatusCode::BadGateway_502: return "Bad Gateway";
  9752. case StatusCode::ServiceUnavailable_503: return "Service Unavailable";
  9753. case StatusCode::GatewayTimeout_504: return "Gateway Timeout";
  9754. case StatusCode::HttpVersionNotSupported_505:
  9755. return "HTTP Version Not Supported";
  9756. case StatusCode::VariantAlsoNegotiates_506: return "Variant Also Negotiates";
  9757. case StatusCode::InsufficientStorage_507: return "Insufficient Storage";
  9758. case StatusCode::LoopDetected_508: return "Loop Detected";
  9759. case StatusCode::NotExtended_510: return "Not Extended";
  9760. case StatusCode::NetworkAuthenticationRequired_511:
  9761. return "Network Authentication Required";
  9762. default:
  9763. case StatusCode::InternalServerError_500: return "Internal Server Error";
  9764. }
  9765. }
  9766. inline std::string to_string(const Error error) {
  9767. switch (error) {
  9768. case Error::Success: return "Success (no error)";
  9769. case Error::Unknown: return "Unknown";
  9770. case Error::Connection: return "Could not establish connection";
  9771. case Error::BindIPAddress: return "Failed to bind IP address";
  9772. case Error::Read: return "Failed to read connection";
  9773. case Error::Write: return "Failed to write connection";
  9774. case Error::ExceedRedirectCount: return "Maximum redirect count exceeded";
  9775. case Error::Canceled: return "Connection handling canceled";
  9776. case Error::SSLConnection: return "SSL connection failed";
  9777. case Error::SSLLoadingCerts: return "SSL certificate loading failed";
  9778. case Error::SSLServerVerification: return "SSL server verification failed";
  9779. case Error::SSLServerHostnameVerification:
  9780. return "SSL server hostname verification failed";
  9781. case Error::UnsupportedMultipartBoundaryChars:
  9782. return "Unsupported HTTP multipart boundary characters";
  9783. case Error::Compression: return "Compression failed";
  9784. case Error::ConnectionTimeout: return "Connection timed out";
  9785. case Error::ProxyConnection: return "Proxy connection failed";
  9786. case Error::ConnectionClosed: return "Connection closed by server";
  9787. case Error::Timeout: return "Read timeout";
  9788. case Error::ResourceExhaustion: return "Resource exhaustion";
  9789. case Error::TooManyFormDataFiles: return "Too many form data files";
  9790. case Error::ExceedMaxPayloadSize: return "Exceeded maximum payload size";
  9791. case Error::ExceedUriMaxLength: return "Exceeded maximum URI length";
  9792. case Error::ExceedMaxSocketDescriptorCount:
  9793. return "Exceeded maximum socket descriptor count";
  9794. case Error::InvalidRequestLine: return "Invalid request line";
  9795. case Error::InvalidHTTPMethod: return "Invalid HTTP method";
  9796. case Error::InvalidHTTPVersion: return "Invalid HTTP version";
  9797. case Error::InvalidHeaders: return "Invalid headers";
  9798. case Error::MultipartParsing: return "Multipart parsing failed";
  9799. case Error::OpenFile: return "Failed to open file";
  9800. case Error::Listen: return "Failed to listen on socket";
  9801. case Error::GetSockName: return "Failed to get socket name";
  9802. case Error::UnsupportedAddressFamily: return "Unsupported address family";
  9803. case Error::HTTPParsing: return "HTTP parsing failed";
  9804. case Error::InvalidRangeHeader: return "Invalid Range header";
  9805. case Error::UnsupportedContentEncoding: return "Unsupported Content-Encoding";
  9806. case Error::WebSocketHandshake: return "WebSocket handshake failed";
  9807. case Error::UserCallbackException: return "User callback threw an exception";
  9808. default: break;
  9809. }
  9810. return "Invalid";
  9811. }
  9812. inline std::ostream &operator<<(std::ostream &os, const Error &obj) {
  9813. os << to_string(obj);
  9814. os << " (" << static_cast<std::underlying_type<Error>::type>(obj) << ')';
  9815. return os;
  9816. }
  9817. inline std::string hosted_at(const std::string &hostname) {
  9818. std::vector<std::string> addrs;
  9819. hosted_at(hostname, addrs);
  9820. if (addrs.empty()) { return std::string(); }
  9821. return addrs[0];
  9822. }
  9823. inline void hosted_at(const std::string &hostname,
  9824. std::vector<std::string> &addrs) {
  9825. struct addrinfo hints;
  9826. struct addrinfo *result;
  9827. memset(&hints, 0, sizeof(struct addrinfo));
  9828. hints.ai_family = AF_UNSPEC;
  9829. hints.ai_socktype = SOCK_STREAM;
  9830. hints.ai_protocol = 0;
  9831. if (detail::getaddrinfo_with_timeout(hostname.c_str(), nullptr, &hints,
  9832. &result, 0)) {
  9833. #if defined __linux__ && !defined __ANDROID__
  9834. res_init();
  9835. #endif
  9836. return;
  9837. }
  9838. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  9839. for (auto rp = result; rp; rp = rp->ai_next) {
  9840. const auto &addr =
  9841. *reinterpret_cast<struct sockaddr_storage *>(rp->ai_addr);
  9842. std::string ip;
  9843. auto dummy = -1;
  9844. if (detail::get_ip_and_port(addr, sizeof(struct sockaddr_storage), ip,
  9845. dummy)) {
  9846. addrs.emplace_back(std::move(ip));
  9847. }
  9848. }
  9849. }
  9850. inline std::string encode_uri_component(const std::string &value) {
  9851. std::ostringstream escaped;
  9852. escaped.fill('0');
  9853. escaped << std::hex;
  9854. for (auto c : value) {
  9855. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9856. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')') {
  9857. escaped << c;
  9858. } else {
  9859. escaped << std::uppercase;
  9860. escaped << '%' << std::setw(2)
  9861. << static_cast<int>(static_cast<unsigned char>(c));
  9862. escaped << std::nouppercase;
  9863. }
  9864. }
  9865. return escaped.str();
  9866. }
  9867. inline std::string encode_uri(const std::string &value) {
  9868. std::ostringstream escaped;
  9869. escaped.fill('0');
  9870. escaped << std::hex;
  9871. for (auto c : value) {
  9872. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9873. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')' ||
  9874. c == ';' || c == '/' || c == '?' || c == ':' || c == '@' || c == '&' ||
  9875. c == '=' || c == '+' || c == '$' || c == ',' || c == '#') {
  9876. escaped << c;
  9877. } else {
  9878. escaped << std::uppercase;
  9879. escaped << '%' << std::setw(2)
  9880. << static_cast<int>(static_cast<unsigned char>(c));
  9881. escaped << std::nouppercase;
  9882. }
  9883. }
  9884. return escaped.str();
  9885. }
  9886. inline std::string decode_uri_component(const std::string &value) {
  9887. std::string result;
  9888. for (size_t i = 0; i < value.size(); i++) {
  9889. if (value[i] == '%' && i + 2 < value.size()) {
  9890. auto val = 0;
  9891. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9892. result += static_cast<char>(val);
  9893. i += 2;
  9894. } else {
  9895. result += value[i];
  9896. }
  9897. } else {
  9898. result += value[i];
  9899. }
  9900. }
  9901. return result;
  9902. }
  9903. inline std::string decode_uri(const std::string &value) {
  9904. std::string result;
  9905. for (size_t i = 0; i < value.size(); i++) {
  9906. if (value[i] == '%' && i + 2 < value.size()) {
  9907. auto val = 0;
  9908. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9909. auto c = static_cast<char>(val);
  9910. // Keep escapes of the reserved characters that encode_uri leaves
  9911. // literal, so decode_uri is the inverse of encode_uri and an escaped
  9912. // delimiter is not promoted into a real one (as with JS decodeURI).
  9913. if (c == ';' || c == '/' || c == '?' || c == ':' || c == '@' ||
  9914. c == '&' || c == '=' || c == '+' || c == '$' || c == ',' ||
  9915. c == '#') {
  9916. result += value[i];
  9917. result += value[i + 1];
  9918. result += value[i + 2];
  9919. } else {
  9920. result += c;
  9921. }
  9922. i += 2;
  9923. } else {
  9924. result += value[i];
  9925. }
  9926. } else {
  9927. result += value[i];
  9928. }
  9929. }
  9930. return result;
  9931. }
  9932. inline std::string encode_path_component(const std::string &component) {
  9933. std::string result;
  9934. result.reserve(component.size() * 3);
  9935. for (size_t i = 0; i < component.size(); i++) {
  9936. auto c = static_cast<unsigned char>(component[i]);
  9937. // Unreserved characters per RFC 3986: ALPHA / DIGIT / "-" / "." / "_" / "~"
  9938. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9939. c == '_' || c == '~') {
  9940. result += static_cast<char>(c);
  9941. }
  9942. // Path-safe sub-delimiters: "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" /
  9943. // "," / ";" / "="
  9944. else if (c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  9945. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  9946. c == '=') {
  9947. result += static_cast<char>(c);
  9948. }
  9949. // Colon is allowed in path segments except first segment
  9950. else if (c == ':') {
  9951. result += static_cast<char>(c);
  9952. }
  9953. // @ is allowed in path
  9954. else if (c == '@') {
  9955. result += static_cast<char>(c);
  9956. } else {
  9957. result += '%';
  9958. char hex[3];
  9959. snprintf(hex, sizeof(hex), "%02X", c);
  9960. result.append(hex, 2);
  9961. }
  9962. }
  9963. return result;
  9964. }
  9965. inline std::string decode_path_component(const std::string &component) {
  9966. std::string result;
  9967. result.reserve(component.size());
  9968. for (size_t i = 0; i < component.size(); i++) {
  9969. if (component[i] == '%' && i + 1 < component.size()) {
  9970. if (component[i + 1] == 'u') {
  9971. // Unicode %uXXXX encoding
  9972. auto val = 0;
  9973. // 4 digits Unicode codes: val is 0x0000-0xFFFF (from 4 hex digits),
  9974. // so to_utf8 writes at most 3 bytes. buff[4] is safe.
  9975. char buff[4];
  9976. size_t len = 0;
  9977. if (detail::from_hex_to_i(component, i + 2, 4, val) &&
  9978. (len = detail::to_utf8(val, buff)) > 0) {
  9979. result.append(buff, len);
  9980. i += 5; // 'u0000'
  9981. } else {
  9982. // Not 4 hex digits, or a surrogate, which is no character: the
  9983. // escape is kept as it is rather than joining its neighbours
  9984. result += component[i];
  9985. }
  9986. } else {
  9987. // Standard %XX encoding
  9988. auto val = 0;
  9989. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9990. // 2 digits hex codes
  9991. result += static_cast<char>(val);
  9992. i += 2; // 'XX'
  9993. } else {
  9994. result += component[i];
  9995. }
  9996. }
  9997. } else {
  9998. result += component[i];
  9999. }
  10000. }
  10001. return result;
  10002. }
  10003. inline std::string encode_query_component(const std::string &component,
  10004. bool space_as_plus) {
  10005. std::string result;
  10006. result.reserve(component.size() * 3);
  10007. for (size_t i = 0; i < component.size(); i++) {
  10008. auto c = static_cast<unsigned char>(component[i]);
  10009. // Unreserved characters per RFC 3986
  10010. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  10011. c == '_' || c == '~') {
  10012. result += static_cast<char>(c);
  10013. }
  10014. // Space handling
  10015. else if (c == ' ') {
  10016. if (space_as_plus) {
  10017. result += '+';
  10018. } else {
  10019. result += "%20";
  10020. }
  10021. }
  10022. // Plus sign handling
  10023. else if (c == '+') {
  10024. if (space_as_plus) {
  10025. result += "%2B";
  10026. } else {
  10027. result += static_cast<char>(c);
  10028. }
  10029. }
  10030. // Query-safe sub-delimiters (excluding & and = which are query delimiters)
  10031. else if (c == '!' || c == '$' || c == '\'' || c == '(' || c == ')' ||
  10032. c == '*' || c == ',' || c == ';') {
  10033. result += static_cast<char>(c);
  10034. }
  10035. // Colon and @ are allowed in query
  10036. else if (c == ':' || c == '@') {
  10037. result += static_cast<char>(c);
  10038. }
  10039. // Forward slash is allowed in query values
  10040. else if (c == '/') {
  10041. result += static_cast<char>(c);
  10042. }
  10043. // Question mark is allowed in query values (after first ?)
  10044. else if (c == '?') {
  10045. result += static_cast<char>(c);
  10046. } else {
  10047. result += '%';
  10048. char hex[3];
  10049. snprintf(hex, sizeof(hex), "%02X", c);
  10050. result.append(hex, 2);
  10051. }
  10052. }
  10053. return result;
  10054. }
  10055. inline std::string decode_query_component(const std::string &component,
  10056. bool plus_as_space) {
  10057. std::string result;
  10058. result.reserve(component.size());
  10059. for (size_t i = 0; i < component.size(); i++) {
  10060. if (component[i] == '%' && i + 2 < component.size()) {
  10061. auto val = 0;
  10062. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  10063. result += static_cast<char>(val);
  10064. i += 2;
  10065. } else {
  10066. result += component[i];
  10067. }
  10068. } else if (component[i] == '+' && plus_as_space) {
  10069. result += ' '; // + becomes space in form-urlencoded
  10070. } else {
  10071. result += component[i];
  10072. }
  10073. }
  10074. return result;
  10075. }
  10076. inline std::string sanitize_filename(const std::string &filename) {
  10077. // Extract basename: find the last path separator (/ or \)
  10078. auto pos = filename.find_last_of("/\\");
  10079. auto result =
  10080. (pos != std::string::npos) ? filename.substr(pos + 1) : filename;
  10081. // Strip null bytes
  10082. result.erase(std::remove(result.begin(), result.end(), '\0'), result.end());
  10083. // Trim whitespace
  10084. {
  10085. auto start = result.find_first_not_of(" \t");
  10086. auto end = result.find_last_not_of(" \t");
  10087. result = (start == std::string::npos)
  10088. ? ""
  10089. : result.substr(start, end - start + 1);
  10090. }
  10091. // Reject . and ..
  10092. if (result == "." || result == "..") { return ""; }
  10093. return result;
  10094. }
  10095. inline std::string append_query_params(const std::string &path,
  10096. const Params &params) {
  10097. // The query ends at the fragment (RFC 3986 3.5), so the params go before it.
  10098. auto fragment_pos = path.find('#');
  10099. auto path_with_query = path.substr(0, fragment_pos);
  10100. path_with_query += path_with_query.find('?') == std::string::npos ? '?' : '&';
  10101. path_with_query += detail::params_to_query_str(params);
  10102. if (fragment_pos != std::string::npos) {
  10103. path_with_query.append(path, fragment_pos, std::string::npos);
  10104. }
  10105. return path_with_query;
  10106. }
  10107. // Header utilities
  10108. inline std::pair<std::string, std::string>
  10109. make_range_header(const Ranges &ranges) {
  10110. std::string field = "bytes=";
  10111. auto i = 0;
  10112. for (const auto &r : ranges) {
  10113. if (i != 0) { field += ", "; }
  10114. if (r.first != -1) { field += std::to_string(r.first); }
  10115. field += '-';
  10116. if (r.second != -1) { field += std::to_string(r.second); }
  10117. i++;
  10118. }
  10119. return std::make_pair("Range", std::move(field));
  10120. }
  10121. inline std::pair<std::string, std::string>
  10122. make_basic_authentication_header(const std::string &username,
  10123. const std::string &password, bool is_proxy) {
  10124. auto field = "Basic " + detail::base64_encode(username + ":" + password);
  10125. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  10126. return std::make_pair(key, std::move(field));
  10127. }
  10128. inline std::pair<std::string, std::string>
  10129. make_bearer_token_authentication_header(const std::string &token,
  10130. bool is_proxy = false) {
  10131. auto field = "Bearer " + token;
  10132. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  10133. return std::make_pair(key, std::move(field));
  10134. }
  10135. namespace detail {
  10136. // Basic auth when a username or password is set, otherwise a bearer token,
  10137. // unless the request already carries the header.
  10138. inline void add_authorization_header(Request &req, const std::string &username,
  10139. const std::string &password,
  10140. const std::string &token, bool is_proxy) {
  10141. if (req.has_header(is_proxy ? "Proxy-Authorization" : "Authorization")) {
  10142. return;
  10143. }
  10144. if (!username.empty() || !password.empty()) {
  10145. req.headers.insert(
  10146. make_basic_authentication_header(username, password, is_proxy));
  10147. } else if (!token.empty()) {
  10148. req.headers.insert(
  10149. make_bearer_token_authentication_header(token, is_proxy));
  10150. }
  10151. }
  10152. } // namespace detail
  10153. // Request implementation
  10154. inline size_t Request::get_header_value_u64(const std::string &key, size_t def,
  10155. size_t id) const {
  10156. return detail::get_header_value_u64(headers, key, def, id);
  10157. }
  10158. inline bool Request::has_header(const std::string &key) const {
  10159. return detail::has_header(headers, key);
  10160. }
  10161. inline std::string Request::get_header_value(const std::string &key,
  10162. const char *def, size_t id) const {
  10163. return detail::get_header_value(headers, key, def, id);
  10164. }
  10165. inline size_t Request::get_header_value_count(const std::string &key) const {
  10166. return detail::get_header_value_count(headers, key);
  10167. }
  10168. inline void Request::set_header(const std::string &key,
  10169. const std::string &val) {
  10170. detail::set_header(headers, key, val);
  10171. }
  10172. inline bool Request::has_trailer(const std::string &key) const {
  10173. return trailers.find(key) != trailers.end();
  10174. }
  10175. inline std::string Request::get_trailer_value(const std::string &key,
  10176. size_t id) const {
  10177. return detail::get_multimap_value(trailers, key, id);
  10178. }
  10179. inline size_t Request::get_trailer_value_count(const std::string &key) const {
  10180. return trailers.count(key);
  10181. }
  10182. inline bool Request::has_param(const std::string &key) const {
  10183. return params.find(key) != params.end();
  10184. }
  10185. inline std::string Request::get_param_value(const std::string &key,
  10186. size_t id) const {
  10187. return detail::get_multimap_value(params, key, id);
  10188. }
  10189. inline std::vector<std::string>
  10190. Request::get_param_values(const std::string &key) const {
  10191. auto rng = params.equal_range(key);
  10192. std::vector<std::string> values;
  10193. values.reserve(static_cast<size_t>(std::distance(rng.first, rng.second)));
  10194. for (auto it = rng.first; it != rng.second; ++it) {
  10195. values.push_back(it->second);
  10196. }
  10197. return values;
  10198. }
  10199. inline size_t Request::get_param_value_count(const std::string &key) const {
  10200. return params.count(key);
  10201. }
  10202. inline bool Request::is_multipart_form_data() const {
  10203. const auto &content_type = get_header_value("Content-Type");
  10204. return detail::case_ignore::equal(detail::extract_media_type(content_type),
  10205. "multipart/form-data");
  10206. }
  10207. // Multipart FormData implementation
  10208. inline std::string MultipartFormData::get_field(const std::string &key,
  10209. size_t id) const {
  10210. auto rng = fields.equal_range(key);
  10211. auto it = detail::bounded_next(rng.first, id, rng.second);
  10212. if (it != rng.second) { return it->second.content; }
  10213. return std::string();
  10214. }
  10215. inline std::vector<std::string>
  10216. MultipartFormData::get_fields(const std::string &key) const {
  10217. std::vector<std::string> values;
  10218. auto rng = fields.equal_range(key);
  10219. for (auto it = rng.first; it != rng.second; it++) {
  10220. values.push_back(it->second.content);
  10221. }
  10222. return values;
  10223. }
  10224. inline bool MultipartFormData::has_field(const std::string &key) const {
  10225. return fields.find(key) != fields.end();
  10226. }
  10227. inline size_t MultipartFormData::get_field_count(const std::string &key) const {
  10228. return fields.count(key);
  10229. }
  10230. inline FormData MultipartFormData::get_file(const std::string &key,
  10231. size_t id) const {
  10232. return detail::get_multimap_value(files, key, id);
  10233. }
  10234. inline std::vector<FormData>
  10235. MultipartFormData::get_files(const std::string &key) const {
  10236. std::vector<FormData> values;
  10237. auto rng = files.equal_range(key);
  10238. for (auto it = rng.first; it != rng.second; it++) {
  10239. values.push_back(it->second);
  10240. }
  10241. return values;
  10242. }
  10243. inline bool MultipartFormData::has_file(const std::string &key) const {
  10244. return files.find(key) != files.end();
  10245. }
  10246. inline size_t MultipartFormData::get_file_count(const std::string &key) const {
  10247. return files.count(key);
  10248. }
  10249. // Multipart FormData writer implementation
  10250. inline bool is_valid_multipart_boundary(const std::string &boundary) {
  10251. return detail::is_multipart_boundary_chars_valid(boundary);
  10252. }
  10253. inline MultipartFormDataWriter::MultipartFormDataWriter()
  10254. : boundary_(detail::make_multipart_data_boundary()) {}
  10255. inline MultipartFormDataWriter::MultipartFormDataWriter(std::string boundary)
  10256. : boundary_(std::move(boundary)) {}
  10257. inline const std::string &MultipartFormDataWriter::boundary() const {
  10258. return boundary_;
  10259. }
  10260. inline std::string MultipartFormDataWriter::content_type() const {
  10261. return detail::serialize_multipart_formdata_get_content_type(boundary_);
  10262. }
  10263. inline std::string
  10264. MultipartFormDataWriter::serialize(const UploadFormDataItems &items) const {
  10265. return detail::serialize_multipart_formdata(items, boundary_);
  10266. }
  10267. inline size_t MultipartFormDataWriter::content_length(
  10268. const UploadFormDataItems &items) const {
  10269. return detail::get_multipart_content_length(items, boundary_);
  10270. }
  10271. inline std::string
  10272. MultipartFormDataWriter::item_begin(const UploadFormData &item) const {
  10273. return detail::serialize_multipart_formdata_item_begin(item, boundary_);
  10274. }
  10275. inline std::string MultipartFormDataWriter::item_end() {
  10276. return detail::serialize_multipart_formdata_item_end();
  10277. }
  10278. inline std::string MultipartFormDataWriter::finish() const {
  10279. return detail::serialize_multipart_formdata_finish(boundary_);
  10280. }
  10281. // Response implementation
  10282. namespace detail {
  10283. // A response has one content source: `body`, a content provider, or a file.
  10284. // Each content setter calls this so that the one called last wins.
  10285. inline void clear_content_provider(Response &res) {
  10286. auto releaser = std::move(res.content_provider_resource_releaser_);
  10287. auto success = res.content_provider_success_;
  10288. res.content_length_ = 0;
  10289. res.content_provider_ = nullptr;
  10290. res.content_provider_resource_releaser_ = nullptr;
  10291. res.is_chunked_content_provider_ = false;
  10292. res.is_file_content_provider_ = false;
  10293. res.content_provider_success_ = false;
  10294. res.content_coding_ = EncodingType::None;
  10295. res.file_content_path_.clear();
  10296. res.file_content_content_type_.clear();
  10297. if (releaser) { releaser(success); }
  10298. }
  10299. inline void clear_content(Response &res) {
  10300. res.body.clear();
  10301. clear_content_provider(res);
  10302. }
  10303. // The Content-Type of the old content goes with it.
  10304. inline void set_content_type(Response &res, const std::string &content_type) {
  10305. res.headers.erase("Content-Type");
  10306. res.set_header("Content-Type", content_type);
  10307. }
  10308. // `body` is public, so it can be assigned directly after a provider or a file
  10309. // was set. It came last, so it wins.
  10310. inline void prefer_assigned_body(Response &res) {
  10311. if (!res.body.empty() &&
  10312. (res.content_provider_ || !res.file_content_path_.empty())) {
  10313. clear_content_provider(res);
  10314. }
  10315. }
  10316. // RFC 9112 6.3: a 1xx, 204 or 304 response ends with its header section.
  10317. inline bool body_allowed_for_status(int status) {
  10318. return status >= 200 && status != StatusCode::NoContent_204 &&
  10319. status != StatusCode::NotModified_304;
  10320. }
  10321. // Only a 206 response is served as a partial representation. range_error()
  10322. // validates `req.ranges` only for a 2xx status, so slicing under any other
  10323. // status would start from an unchecked offset.
  10324. inline bool is_partial_content(const Request &req, const Response &res) {
  10325. return !req.ranges.empty() && res.status == StatusCode::PartialContent_206;
  10326. }
  10327. // Sets the Content-Length or Transfer-Encoding framing the body that
  10328. // Server::write_response_core() writes, or closes the connection after a body
  10329. // that has neither. Only the library sets them: one from a handler would go
  10330. // out next to it, or describe some other body.
  10331. inline void set_framing_headers(const Request &req, Response &res,
  10332. const std::string &boundary,
  10333. const std::string &content_type) {
  10334. // A HEAD response may give the length a GET would have had (RFC 9110 9.3.2).
  10335. auto head_length = req.method == "HEAD"
  10336. ? res.get_header_value("Content-Length")
  10337. : std::string();
  10338. res.headers.erase("Content-Length");
  10339. res.headers.erase("Transfer-Encoding");
  10340. if (!body_allowed_for_status(res.status)) { return; }
  10341. if (res.content_provider_) {
  10342. if (res.content_length_ == 0) {
  10343. if (res.is_chunked_content_provider_) {
  10344. res.set_header("Transfer-Encoding", "chunked");
  10345. } else if (req.method != "HEAD") {
  10346. // RFC 9112 6.3: a body with neither ends where the connection does.
  10347. res.headers.erase("Keep-Alive");
  10348. if (!has_header_token(res.headers, "Connection", "close")) {
  10349. res.set_header("Connection", "close");
  10350. }
  10351. }
  10352. return;
  10353. }
  10354. // The part Server::write_content_with_provider() writes.
  10355. auto length = res.content_length_;
  10356. if (is_partial_content(req, res)) {
  10357. length = req.ranges.size() == 1
  10358. ? get_range_offset_and_length(req.ranges[0], length).second
  10359. : get_multipart_ranges_data_length(req, boundary,
  10360. content_type, length);
  10361. }
  10362. res.set_header("Content-Length", std::to_string(length));
  10363. } else if (!res.body.empty()) {
  10364. res.set_header("Content-Length", std::to_string(res.body.size()));
  10365. } else {
  10366. res.set_header("Content-Length", head_length.empty() ? "0" : head_length);
  10367. }
  10368. }
  10369. } // namespace detail
  10370. inline size_t Response::get_header_value_u64(const std::string &key, size_t def,
  10371. size_t id) const {
  10372. return detail::get_header_value_u64(headers, key, def, id);
  10373. }
  10374. inline bool Response::has_header(const std::string &key) const {
  10375. return headers.find(key) != headers.end();
  10376. }
  10377. inline std::string Response::get_header_value(const std::string &key,
  10378. const char *def,
  10379. size_t id) const {
  10380. return detail::get_header_value(headers, key, def, id);
  10381. }
  10382. inline size_t Response::get_header_value_count(const std::string &key) const {
  10383. return detail::get_header_value_count(headers, key);
  10384. }
  10385. inline void Response::set_header(const std::string &key,
  10386. const std::string &val) {
  10387. detail::set_header(headers, key, val);
  10388. }
  10389. inline bool Response::has_trailer(const std::string &key) const {
  10390. return trailers.find(key) != trailers.end();
  10391. }
  10392. inline std::string Response::get_trailer_value(const std::string &key,
  10393. size_t id) const {
  10394. return detail::get_multimap_value(trailers, key, id);
  10395. }
  10396. inline size_t Response::get_trailer_value_count(const std::string &key) const {
  10397. return trailers.count(key);
  10398. }
  10399. inline void Response::set_redirect(const std::string &url, int stat) {
  10400. if (detail::fields::is_field_value(url)) {
  10401. set_header("Location", url);
  10402. if (300 <= stat && stat < 400) {
  10403. this->status = stat;
  10404. } else {
  10405. this->status = StatusCode::Found_302;
  10406. }
  10407. }
  10408. }
  10409. inline void Response::set_content(const char *s, size_t n,
  10410. const std::string &content_type) {
  10411. body.assign(s, n); // Before the releaser runs; it may own `s`.
  10412. detail::clear_content_provider(*this);
  10413. detail::set_content_type(*this, content_type);
  10414. }
  10415. inline void Response::set_content(const std::string &s,
  10416. const std::string &content_type) {
  10417. set_content(s.data(), s.size(), content_type);
  10418. }
  10419. inline void Response::set_content(std::string &&s,
  10420. const std::string &content_type) {
  10421. body = std::move(s);
  10422. detail::clear_content_provider(*this);
  10423. detail::set_content_type(*this, content_type);
  10424. }
  10425. inline void Response::set_content_provider(
  10426. size_t in_length, const std::string &content_type, ContentProvider provider,
  10427. ContentProviderResourceReleaser resource_releaser) {
  10428. detail::clear_content(*this);
  10429. detail::set_content_type(*this, content_type);
  10430. content_length_ = in_length;
  10431. if (in_length > 0) { content_provider_ = std::move(provider); }
  10432. content_provider_resource_releaser_ = std::move(resource_releaser);
  10433. }
  10434. inline void Response::set_content_provider(
  10435. const std::string &content_type, ContentProviderWithoutLength provider,
  10436. ContentProviderResourceReleaser resource_releaser) {
  10437. detail::clear_content(*this);
  10438. detail::set_content_type(*this, content_type);
  10439. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  10440. content_provider_resource_releaser_ = std::move(resource_releaser);
  10441. }
  10442. inline void Response::set_chunked_content_provider(
  10443. const std::string &content_type, ContentProviderWithoutLength provider,
  10444. ContentProviderResourceReleaser resource_releaser) {
  10445. set_content_provider(content_type, std::move(provider),
  10446. std::move(resource_releaser));
  10447. is_chunked_content_provider_ = true;
  10448. }
  10449. inline void Response::set_file_content(const std::string &path,
  10450. const std::string &content_type) {
  10451. detail::clear_content(*this);
  10452. headers.erase("Content-Type");
  10453. file_content_path_ = path;
  10454. file_content_content_type_ = content_type;
  10455. }
  10456. inline void Response::set_file_content(const std::string &path) {
  10457. set_file_content(path, std::string());
  10458. }
  10459. // Result implementation
  10460. inline size_t Result::get_request_header_value_u64(const std::string &key,
  10461. size_t def,
  10462. size_t id) const {
  10463. return detail::get_header_value_u64(request_headers_, key, def, id);
  10464. }
  10465. inline bool Result::has_request_header(const std::string &key) const {
  10466. return request_headers_.find(key) != request_headers_.end();
  10467. }
  10468. inline std::string Result::get_request_header_value(const std::string &key,
  10469. const char *def,
  10470. size_t id) const {
  10471. return detail::get_header_value(request_headers_, key, def, id);
  10472. }
  10473. inline size_t
  10474. Result::get_request_header_value_count(const std::string &key) const {
  10475. return request_headers_.count(key);
  10476. }
  10477. // Stream implementation
  10478. inline ssize_t Stream::write(const char *ptr) {
  10479. return write(ptr, strlen(ptr));
  10480. }
  10481. inline ssize_t Stream::write(const std::string &s) {
  10482. return write(s.data(), s.size());
  10483. }
  10484. // BodyReader implementation
  10485. inline ssize_t detail::BodyReader::read(char *buf, size_t len) {
  10486. if (!stream) {
  10487. last_error = Error::Connection;
  10488. return -1;
  10489. }
  10490. if (eof) { return 0; }
  10491. if (!chunked) {
  10492. // Content-Length based reading
  10493. if (has_content_length && bytes_read >= content_length) {
  10494. eof = true;
  10495. return 0;
  10496. }
  10497. auto to_read = len;
  10498. if (has_content_length) {
  10499. auto remaining = content_length - bytes_read;
  10500. to_read = (std::min)(len, remaining);
  10501. }
  10502. auto n = stream->read(buf, to_read);
  10503. // Without Content-Length the body ends when the connection closes
  10504. // (RFC 9112 §6.3); with one, an EOF here came too early
  10505. if (n < 0 || (n == 0 && has_content_length)) {
  10506. last_error = stream->get_error();
  10507. if (last_error == Error::Success) { last_error = Error::Read; }
  10508. }
  10509. if (n <= 0) {
  10510. eof = true;
  10511. return n;
  10512. }
  10513. bytes_read += static_cast<size_t>(n);
  10514. if (has_content_length && bytes_read >= content_length) { eof = true; }
  10515. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10516. last_error = Error::ExceedMaxPayloadSize;
  10517. eof = true;
  10518. return -1;
  10519. }
  10520. return n;
  10521. }
  10522. // Chunked transfer encoding: delegate to shared decoder instance.
  10523. if (!chunked_decoder) { chunked_decoder.reset(new ChunkedDecoder(*stream)); }
  10524. size_t chunk_offset = 0;
  10525. size_t chunk_total = 0;
  10526. auto n = chunked_decoder->read_payload(buf, len, chunk_offset, chunk_total);
  10527. if (n < 0) {
  10528. last_error = stream->get_error();
  10529. if (last_error == Error::Success) { last_error = Error::Read; }
  10530. eof = true;
  10531. return n;
  10532. }
  10533. if (n == 0) {
  10534. // Final chunk observed. Leave trailer parsing to the caller (StreamHandle).
  10535. eof = true;
  10536. return 0;
  10537. }
  10538. bytes_read += static_cast<size_t>(n);
  10539. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10540. last_error = Error::ExceedMaxPayloadSize;
  10541. eof = true;
  10542. return -1;
  10543. }
  10544. return n;
  10545. }
  10546. // ThreadPool implementation
  10547. inline ThreadPool::ThreadPool(size_t n, size_t max_n, size_t mqr,
  10548. time_t idle_timeout_sec)
  10549. : base_thread_count_(n), max_queued_requests_(mqr),
  10550. idle_timeout_sec_(idle_timeout_sec), idle_thread_count_(0),
  10551. shutdown_(false) {
  10552. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10553. if (max_n != 0 && max_n < n) {
  10554. std::string msg = "max_threads must be >= base_threads";
  10555. throw std::invalid_argument(msg);
  10556. }
  10557. #endif
  10558. max_thread_count_ = max_n == 0 ? n : max_n;
  10559. threads_.reserve(base_thread_count_);
  10560. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10561. try {
  10562. #endif
  10563. for (size_t i = 0; i < base_thread_count_; i++) {
  10564. threads_.emplace_back(std::thread([this]() { worker(false); }));
  10565. }
  10566. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10567. } catch (...) {
  10568. // If thread creation fails partway (e.g., pthread_create returns EAGAIN),
  10569. // signal the workers we already spawned to exit and join them so the
  10570. // vector destructor does not see joinable threads (which would call
  10571. // std::terminate). Then rethrow so the caller learns of the failure.
  10572. {
  10573. std::unique_lock<std::mutex> lock(mutex_);
  10574. shutdown_ = true;
  10575. }
  10576. cond_.notify_all();
  10577. for (auto &t : threads_) {
  10578. if (t.joinable()) { t.join(); }
  10579. }
  10580. throw;
  10581. }
  10582. #endif
  10583. }
  10584. inline bool ThreadPool::enqueue(std::function<void()> fn) {
  10585. {
  10586. std::unique_lock<std::mutex> lock(mutex_);
  10587. if (shutdown_) { return false; }
  10588. if (max_queued_requests_ > 0 && jobs_.size() >= max_queued_requests_) {
  10589. return false;
  10590. }
  10591. jobs_.push_back(std::move(fn));
  10592. // Spawn a dynamic thread if jobs outnumber idle threads and under max
  10593. if (jobs_.size() > idle_thread_count_ &&
  10594. threads_.size() + dynamic_threads_.size() < max_thread_count_) {
  10595. cleanup_finished_threads();
  10596. dynamic_threads_.emplace_back(std::thread([this]() { worker(true); }));
  10597. }
  10598. }
  10599. cond_.notify_one();
  10600. return true;
  10601. }
  10602. inline void ThreadPool::shutdown() {
  10603. {
  10604. std::unique_lock<std::mutex> lock(mutex_);
  10605. shutdown_ = true;
  10606. }
  10607. cond_.notify_all();
  10608. for (auto &t : threads_) {
  10609. if (t.joinable()) { t.join(); }
  10610. }
  10611. // Move dynamic_threads_ to a local list under the lock to avoid racing
  10612. // with worker threads that call move_to_finished() concurrently.
  10613. std::list<std::thread> remaining_dynamic;
  10614. {
  10615. std::unique_lock<std::mutex> lock(mutex_);
  10616. remaining_dynamic = std::move(dynamic_threads_);
  10617. }
  10618. for (auto &t : remaining_dynamic) {
  10619. if (t.joinable()) { t.join(); }
  10620. }
  10621. std::unique_lock<std::mutex> lock(mutex_);
  10622. cleanup_finished_threads();
  10623. }
  10624. inline void ThreadPool::move_to_finished(std::thread::id id) {
  10625. // Must be called with mutex_ held
  10626. for (auto it = dynamic_threads_.begin(); it != dynamic_threads_.end(); ++it) {
  10627. if (it->get_id() == id) {
  10628. finished_threads_.push_back(std::move(*it));
  10629. dynamic_threads_.erase(it);
  10630. return;
  10631. }
  10632. }
  10633. }
  10634. inline void ThreadPool::cleanup_finished_threads() {
  10635. // Must be called with mutex_ held
  10636. for (auto &t : finished_threads_) {
  10637. if (t.joinable()) { t.join(); }
  10638. }
  10639. finished_threads_.clear();
  10640. }
  10641. inline void ThreadPool::worker(bool is_dynamic) {
  10642. for (;;) {
  10643. std::function<void()> fn;
  10644. {
  10645. std::unique_lock<std::mutex> lock(mutex_);
  10646. idle_thread_count_++;
  10647. if (is_dynamic) {
  10648. auto has_work =
  10649. cond_.wait_for(lock, std::chrono::seconds(idle_timeout_sec_),
  10650. [&] { return !jobs_.empty() || shutdown_; });
  10651. if (!has_work) {
  10652. // Timed out with no work - exit this dynamic thread
  10653. idle_thread_count_--;
  10654. move_to_finished(std::this_thread::get_id());
  10655. break;
  10656. }
  10657. } else {
  10658. cond_.wait(lock, [&] { return !jobs_.empty() || shutdown_; });
  10659. }
  10660. idle_thread_count_--;
  10661. if (shutdown_ && jobs_.empty()) { break; }
  10662. fn = std::move(jobs_.front());
  10663. jobs_.pop_front();
  10664. }
  10665. assert(true == static_cast<bool>(fn));
  10666. fn();
  10667. }
  10668. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(OPENSSL_IS_BORINGSSL) && \
  10669. !defined(LIBRESSL_VERSION_NUMBER)
  10670. OPENSSL_thread_stop();
  10671. #endif
  10672. }
  10673. /*
  10674. * Group 1 (continued): detail namespace - Stream implementations
  10675. */
  10676. namespace detail {
  10677. inline void calc_actual_timeout(time_t max_timeout_msec, time_t duration_msec,
  10678. time_t timeout_sec, time_t timeout_usec,
  10679. time_t &actual_timeout_sec,
  10680. time_t &actual_timeout_usec) {
  10681. auto timeout_msec = (timeout_sec * 1000) + (timeout_usec / 1000);
  10682. auto actual_timeout_msec =
  10683. (std::min)(max_timeout_msec - duration_msec, timeout_msec);
  10684. if (actual_timeout_msec < 0) { actual_timeout_msec = 0; }
  10685. actual_timeout_sec = actual_timeout_msec / 1000;
  10686. actual_timeout_usec = (actual_timeout_msec % 1000) * 1000;
  10687. }
  10688. // Socket stream implementation
  10689. inline SocketStream::SocketStream(
  10690. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  10691. time_t write_timeout_sec, time_t write_timeout_usec,
  10692. time_t max_timeout_msec,
  10693. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10694. : sock_(sock), read_timeout_sec_(read_timeout_sec),
  10695. read_timeout_usec_(read_timeout_usec),
  10696. write_timeout_sec_(write_timeout_sec),
  10697. write_timeout_usec_(write_timeout_usec),
  10698. max_timeout_msec_(max_timeout_msec), start_time_(start_time),
  10699. read_buff_(read_buff_size_, 0) {}
  10700. inline SocketStream::~SocketStream() = default;
  10701. inline bool SocketStream::is_readable() const {
  10702. return read_buff_off_ < read_buff_content_size_;
  10703. }
  10704. inline bool SocketStream::wait_readable() const {
  10705. if (max_timeout_msec_ <= 0) {
  10706. return select_read_interruptible(sock_, read_timeout_sec_,
  10707. read_timeout_usec_, read_interrupted_) > 0;
  10708. }
  10709. time_t read_timeout_sec;
  10710. time_t read_timeout_usec;
  10711. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10712. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10713. return select_read_interruptible(sock_, read_timeout_sec, read_timeout_usec,
  10714. read_interrupted_) > 0;
  10715. }
  10716. inline bool SocketStream::wait_writable() const {
  10717. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10718. }
  10719. inline bool SocketStream::ensure_readable() {
  10720. if (readable_hint_) {
  10721. readable_hint_ = false;
  10722. return true;
  10723. }
  10724. return wait_readable();
  10725. }
  10726. inline const char *SocketStream::buffered_data(size_t &size) const {
  10727. size = read_buff_content_size_ - read_buff_off_;
  10728. return size ? read_buff_.data() + read_buff_off_ : nullptr;
  10729. }
  10730. inline void SocketStream::consume_buffered(size_t size) {
  10731. assert(size <= read_buff_content_size_ - read_buff_off_);
  10732. read_buff_off_ += size;
  10733. }
  10734. inline bool SocketStream::is_peer_alive() const {
  10735. return detail::is_socket_alive(sock_);
  10736. }
  10737. inline ssize_t SocketStream::read(char *ptr, size_t size) {
  10738. #ifdef _WIN32
  10739. size =
  10740. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10741. #else
  10742. size = (std::min)(size,
  10743. static_cast<size_t>((std::numeric_limits<ssize_t>::max)()));
  10744. #endif
  10745. if (read_buff_off_ < read_buff_content_size_) {
  10746. auto remaining_size = read_buff_content_size_ - read_buff_off_;
  10747. if (size <= remaining_size) {
  10748. memcpy(ptr, read_buff_.data() + read_buff_off_, size);
  10749. read_buff_off_ += size;
  10750. return static_cast<ssize_t>(size);
  10751. } else {
  10752. memcpy(ptr, read_buff_.data() + read_buff_off_, remaining_size);
  10753. read_buff_off_ += remaining_size;
  10754. return static_cast<ssize_t>(remaining_size);
  10755. }
  10756. }
  10757. if (!ensure_readable()) {
  10758. error_ = Error::Timeout;
  10759. return -1;
  10760. }
  10761. read_buff_off_ = 0;
  10762. read_buff_content_size_ = 0;
  10763. if (size < read_buff_size_) {
  10764. auto n = read_socket(sock_, read_buff_.data(), read_buff_size_,
  10765. CPPHTTPLIB_RECV_FLAGS);
  10766. if (n <= 0) {
  10767. if (n == 0) {
  10768. error_ = Error::ConnectionClosed;
  10769. } else {
  10770. error_ = Error::Read;
  10771. }
  10772. return n;
  10773. } else if (n <= static_cast<ssize_t>(size)) {
  10774. memcpy(ptr, read_buff_.data(), static_cast<size_t>(n));
  10775. return n;
  10776. } else {
  10777. memcpy(ptr, read_buff_.data(), size);
  10778. read_buff_off_ = size;
  10779. read_buff_content_size_ = static_cast<size_t>(n);
  10780. return static_cast<ssize_t>(size);
  10781. }
  10782. } else {
  10783. auto n = read_socket(sock_, ptr, size, CPPHTTPLIB_RECV_FLAGS);
  10784. if (n <= 0) {
  10785. if (n == 0) {
  10786. error_ = Error::ConnectionClosed;
  10787. } else {
  10788. error_ = Error::Read;
  10789. }
  10790. }
  10791. return n;
  10792. }
  10793. }
  10794. inline ssize_t SocketStream::write(const char *ptr, size_t size) {
  10795. if (!wait_writable()) { return -1; }
  10796. #if defined(_WIN32) && !defined(_WIN64)
  10797. size =
  10798. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10799. #endif
  10800. return send_socket(sock_, ptr, size, CPPHTTPLIB_SEND_FLAGS);
  10801. }
  10802. inline void SocketStream::get_remote_ip_and_port(std::string &ip,
  10803. int &port) const {
  10804. return detail::get_remote_ip_and_port(sock_, ip, port);
  10805. }
  10806. inline void SocketStream::get_local_ip_and_port(std::string &ip,
  10807. int &port) const {
  10808. return detail::get_local_ip_and_port(sock_, ip, port);
  10809. }
  10810. inline socket_t SocketStream::socket() const { return sock_; }
  10811. inline time_t SocketStream::duration() const {
  10812. return static_cast<time_t>(
  10813. std::chrono::duration_cast<std::chrono::milliseconds>(
  10814. std::chrono::steady_clock::now() - start_time_)
  10815. .count());
  10816. }
  10817. inline void SocketStream::set_read_timeout(time_t sec, time_t usec) {
  10818. read_timeout_sec_ = sec;
  10819. read_timeout_usec_ = usec;
  10820. }
  10821. inline void SocketStream::set_max_timeout(time_t msec) {
  10822. max_timeout_msec_ = msec;
  10823. start_time_ = std::chrono::steady_clock::now();
  10824. }
  10825. inline void
  10826. SocketStream::set_read_interrupt(std::function<bool()> interrupted) {
  10827. read_interrupted_ = std::move(interrupted);
  10828. }
  10829. // Buffer stream implementation
  10830. inline bool BufferStream::is_readable() const { return true; }
  10831. inline bool BufferStream::wait_readable() const { return true; }
  10832. inline bool BufferStream::wait_writable() const { return true; }
  10833. inline ssize_t BufferStream::read(char *ptr, size_t size) {
  10834. #if defined(_MSC_VER) && _MSC_VER < 1910
  10835. auto len_read = buffer._Copy_s(ptr, size, size, position);
  10836. #else
  10837. auto len_read = buffer.copy(ptr, size, position);
  10838. #endif
  10839. position += static_cast<size_t>(len_read);
  10840. return static_cast<ssize_t>(len_read);
  10841. }
  10842. inline ssize_t BufferStream::write(const char *ptr, size_t size) {
  10843. buffer.append(ptr, size);
  10844. return static_cast<ssize_t>(size);
  10845. }
  10846. inline void BufferStream::get_remote_ip_and_port(std::string & /*ip*/,
  10847. int & /*port*/) const {}
  10848. inline void BufferStream::get_local_ip_and_port(std::string & /*ip*/,
  10849. int & /*port*/) const {}
  10850. inline socket_t BufferStream::socket() const { return 0; }
  10851. inline time_t BufferStream::duration() const { return 0; }
  10852. inline const std::string &BufferStream::get_buffer() const { return buffer; }
  10853. inline PathParamsMatcher::PathParamsMatcher(const std::string &pattern)
  10854. : MatcherBase(pattern) {
  10855. constexpr const char marker[] = "/:";
  10856. // One past the last ending position of a path param substring
  10857. std::size_t last_param_end = 0;
  10858. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10859. // Needed to ensure that parameter names are unique during matcher
  10860. // construction
  10861. // If exceptions are disabled, only last duplicate path
  10862. // parameter will be set
  10863. std::unordered_set<std::string> param_name_set;
  10864. #endif
  10865. while (true) {
  10866. const auto marker_pos = pattern.find(
  10867. marker, last_param_end == 0 ? last_param_end : last_param_end - 1);
  10868. if (marker_pos == std::string::npos) { break; }
  10869. static_fragments_.push_back(
  10870. pattern.substr(last_param_end, marker_pos - last_param_end + 1));
  10871. const auto param_name_start = marker_pos + str_len(marker);
  10872. auto sep_pos = pattern.find(separator, param_name_start);
  10873. if (sep_pos == std::string::npos) { sep_pos = pattern.length(); }
  10874. auto param_name =
  10875. pattern.substr(param_name_start, sep_pos - param_name_start);
  10876. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10877. if (param_name_set.find(param_name) != param_name_set.cend()) {
  10878. std::string msg = "Encountered path parameter '" + param_name +
  10879. "' multiple times in route pattern '" + pattern + "'.";
  10880. throw std::invalid_argument(msg);
  10881. }
  10882. #endif
  10883. param_names_.push_back(std::move(param_name));
  10884. last_param_end = sep_pos + 1;
  10885. }
  10886. if (last_param_end < pattern.length()) {
  10887. static_fragments_.push_back(pattern.substr(last_param_end));
  10888. }
  10889. }
  10890. inline bool PathParamsMatcher::match(Request &request) const {
  10891. request.matches = std::smatch();
  10892. request.path_params.clear();
  10893. // A pattern without parameters is just a literal path to compare against
  10894. if (param_names_.empty()) { return request.path == pattern(); }
  10895. request.path_params.reserve(param_names_.size());
  10896. // One past the position at which the path matched the pattern last time
  10897. std::size_t starting_pos = 0;
  10898. for (size_t i = 0; i < static_fragments_.size(); ++i) {
  10899. const auto &fragment = static_fragments_[i];
  10900. if (starting_pos + fragment.length() > request.path.length()) {
  10901. return false;
  10902. }
  10903. // Avoid unnecessary allocation by using strncmp instead of substr +
  10904. // comparison
  10905. if (std::strncmp(request.path.c_str() + starting_pos, fragment.c_str(),
  10906. fragment.length()) != 0) {
  10907. return false;
  10908. }
  10909. starting_pos += fragment.length();
  10910. // Should only happen when we have a static fragment after a param
  10911. // Example: '/users/:id/subscriptions'
  10912. // The 'subscriptions' fragment here does not have a corresponding param
  10913. if (i >= param_names_.size()) { continue; }
  10914. auto sep_pos = request.path.find(separator, starting_pos);
  10915. if (sep_pos == std::string::npos) { sep_pos = request.path.length(); }
  10916. const auto &param_name = param_names_[i];
  10917. request.path_params.emplace(
  10918. param_name, request.path.substr(starting_pos, sep_pos - starting_pos));
  10919. // Mark everything up to '/' as matched
  10920. starting_pos = sep_pos + 1;
  10921. }
  10922. // Returns false if the path is longer than the pattern
  10923. return starting_pos >= request.path.length();
  10924. }
  10925. inline bool RegexMatcher::match(Request &request) const {
  10926. request.path_params.clear();
  10927. // See CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH: an overlong path is treated as
  10928. // a non-match rather than risking a stack overflow in std::regex_match.
  10929. if (request.path.length() > CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH) {
  10930. return false;
  10931. }
  10932. return std::regex_match(request.path, request.matches, regex_);
  10933. }
  10934. // Enclose IPv6 address in brackets if needed
  10935. inline std::string prepare_host_string(const std::string &host) {
  10936. // Enclose IPv6 address in brackets (but not if already enclosed)
  10937. if (host.find(':') == std::string::npos ||
  10938. (!host.empty() && host[0] == '[')) {
  10939. // IPv4, hostname, or already bracketed IPv6
  10940. return host;
  10941. } else {
  10942. // IPv6 address without brackets
  10943. return "[" + host + "]";
  10944. }
  10945. }
  10946. inline std::string make_host_and_port_string(const std::string &host, int port,
  10947. bool is_ssl) {
  10948. auto result = prepare_host_string(host);
  10949. // Append port if not default
  10950. if ((!is_ssl && port == 80) || (is_ssl && port == 443)) {
  10951. ; // do nothing
  10952. } else {
  10953. result += ":" + std::to_string(port);
  10954. }
  10955. return result;
  10956. }
  10957. // Create "host:port" string always including port number (for CONNECT method)
  10958. inline std::string
  10959. make_host_and_port_string_always_port(const std::string &host, int port) {
  10960. return prepare_host_string(host) + ":" + std::to_string(port);
  10961. }
  10962. // Value for the Host header a client sends when the caller supplied none.
  10963. // Only the value: callers decide where in their header list it goes.
  10964. inline std::string make_default_host_header_value(const std::string &host,
  10965. int port, bool is_ssl,
  10966. int address_family) {
  10967. if (address_family == AF_UNIX) { return "localhost"; }
  10968. return make_host_and_port_string(host, port, is_ssl);
  10969. }
  10970. inline void add_default_user_agent_header(Request &req) {
  10971. #ifndef CPPHTTPLIB_NO_DEFAULT_USER_AGENT
  10972. if (!req.has_header("User-Agent")) {
  10973. req.set_header("User-Agent",
  10974. std::string("cpp-httplib/") + CPPHTTPLIB_VERSION);
  10975. }
  10976. #else
  10977. (void)req;
  10978. #endif
  10979. }
  10980. bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out);
  10981. NormalizedTarget normalize_target(const std::string &host);
  10982. bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits);
  10983. bool host_matches_no_proxy(const NormalizedTarget &target,
  10984. const std::vector<NoProxyEntry> &entries);
  10985. inline bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits) {
  10986. if (prefix_bits < 0 || prefix_bits > 128) { return false; }
  10987. if (prefix_bits == 0) { return true; }
  10988. int full_bytes = prefix_bits / 8;
  10989. int rem_bits = prefix_bits % 8;
  10990. if (full_bytes > 0 && std::memcmp(ip.data(), net.data(),
  10991. static_cast<size_t>(full_bytes)) != 0) {
  10992. return false;
  10993. }
  10994. if (rem_bits == 0) { return true; }
  10995. auto i = static_cast<size_t>(full_bytes);
  10996. auto mask = static_cast<uint8_t>(0xFFu << (8 - rem_bits));
  10997. return (ip[i] & mask) == (net[i] & mask);
  10998. }
  10999. inline bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out) {
  11000. if (token.empty()) { return false; }
  11001. if (token == "*") {
  11002. out.kind = NoProxyKind::Wildcard;
  11003. return true;
  11004. }
  11005. auto slash = token.find('/');
  11006. std::string addr_part =
  11007. (slash == std::string::npos) ? token : token.substr(0, slash);
  11008. std::string prefix_part =
  11009. (slash == std::string::npos) ? std::string() : token.substr(slash + 1);
  11010. // A bare slash or trailing-slash CIDR like "10.0.0.0/" is malformed;
  11011. // don't silently treat it as a /32 (or /128).
  11012. if (slash != std::string::npos && prefix_part.empty()) { return false; }
  11013. // Accept the bracketed IPv6 form ("[::1]", "[fe80::]/10") as well as the
  11014. // bare form. Brackets have no meaning for IPv4, so skip the IPv4 attempt
  11015. // when brackets are present.
  11016. bool bracketed = addr_part.size() >= 2 && addr_part.front() == '[' &&
  11017. addr_part.back() == ']';
  11018. if (bracketed) { addr_part = addr_part.substr(1, addr_part.size() - 2); }
  11019. if (!bracketed) {
  11020. struct in_addr v4;
  11021. if (inet_pton(AF_INET, addr_part.c_str(), &v4) == 1) {
  11022. int prefix = 32;
  11023. if (!prefix_part.empty() &&
  11024. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 32,
  11025. prefix)) {
  11026. return false;
  11027. }
  11028. out.kind = NoProxyKind::IPv4Cidr;
  11029. std::memcpy(out.net.data(), &v4, sizeof(v4));
  11030. out.prefix_bits = prefix;
  11031. return true;
  11032. }
  11033. }
  11034. struct in6_addr v6;
  11035. if (inet_pton(AF_INET6, addr_part.c_str(), &v6) == 1) {
  11036. int prefix = 128;
  11037. if (!prefix_part.empty() &&
  11038. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 128,
  11039. prefix)) {
  11040. return false;
  11041. }
  11042. out.kind = NoProxyKind::IPv6Cidr;
  11043. std::memcpy(out.net.data(), &v6, sizeof(v6));
  11044. out.prefix_bits = prefix;
  11045. return true;
  11046. }
  11047. // Bracketed entries can only be IPv6. If the IPv6 parse above failed,
  11048. // the entry is malformed — don't fall through to the hostname branch.
  11049. if (bracketed) { return false; }
  11050. // A '/' on a non-IP token means a CIDR prefix without an address. Reject.
  11051. if (slash != std::string::npos) { return false; }
  11052. // Port-specific entries (host:port) are not supported.
  11053. if (token.find(':') != std::string::npos) { return false; }
  11054. std::string hostname = case_ignore::to_lower(token);
  11055. while (!hostname.empty() && hostname.front() == '.') {
  11056. hostname.erase(hostname.begin());
  11057. }
  11058. while (!hostname.empty() && hostname.back() == '.') {
  11059. hostname.pop_back();
  11060. }
  11061. if (hostname.empty()) { return false; }
  11062. out.kind = NoProxyKind::HostnameSuffix;
  11063. out.hostname_pattern = std::move(hostname);
  11064. return true;
  11065. }
  11066. inline std::vector<NoProxyEntry>
  11067. parse_no_proxy_entries(const std::vector<std::string> &patterns) {
  11068. std::vector<NoProxyEntry> entries;
  11069. entries.reserve(patterns.size());
  11070. for (const auto &p : patterns) {
  11071. auto trimmed = trim_copy(p);
  11072. if (trimmed.empty()) { continue; }
  11073. NoProxyEntry entry;
  11074. if (parse_no_proxy_entry(trimmed, entry)) {
  11075. entries.push_back(std::move(entry));
  11076. }
  11077. }
  11078. return entries;
  11079. }
  11080. inline NormalizedTarget normalize_target(const std::string &host) {
  11081. NormalizedTarget t;
  11082. std::string h = host;
  11083. if (h.size() >= 2 && h.front() == '[' && h.back() == ']') {
  11084. h = h.substr(1, h.size() - 2);
  11085. }
  11086. // Strip a single trailing dot so "example.com." canonicalizes to
  11087. // "example.com".
  11088. if (!h.empty() && h.back() == '.') { h.pop_back(); }
  11089. t.hostname = case_ignore::to_lower(h);
  11090. if (!t.hostname.empty()) {
  11091. struct in_addr v4;
  11092. struct in6_addr v6;
  11093. if (inet_pton(AF_INET, t.hostname.c_str(), &v4) == 1) {
  11094. t.is_ipv4 = true;
  11095. std::memcpy(t.ip.data(), &v4, sizeof(v4));
  11096. } else if (inet_pton(AF_INET6, t.hostname.c_str(), &v6) == 1) {
  11097. t.is_ipv6 = true;
  11098. std::memcpy(t.ip.data(), &v6, sizeof(v6));
  11099. }
  11100. }
  11101. return t;
  11102. }
  11103. inline bool host_matches_no_proxy(const NormalizedTarget &target,
  11104. const std::vector<NoProxyEntry> &entries) {
  11105. if (target.hostname.empty()) { return false; }
  11106. for (const auto &e : entries) {
  11107. switch (e.kind) {
  11108. case NoProxyKind::Wildcard: return true;
  11109. case NoProxyKind::IPv4Cidr:
  11110. if (target.is_ipv4 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  11111. return true;
  11112. }
  11113. break;
  11114. case NoProxyKind::IPv6Cidr:
  11115. if (target.is_ipv6 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  11116. return true;
  11117. }
  11118. break;
  11119. case NoProxyKind::HostnameSuffix:
  11120. if (target.is_ipv4 || target.is_ipv6) { break; }
  11121. if (target.hostname == e.hostname_pattern) { return true; }
  11122. // Dot-boundary suffix match: prevents "evilexample.com" from matching
  11123. // an entry of "example.com".
  11124. if (target.hostname.size() > e.hostname_pattern.size() + 1) {
  11125. auto offset = target.hostname.size() - e.hostname_pattern.size();
  11126. if (target.hostname[offset - 1] == '.' &&
  11127. target.hostname.compare(offset, e.hostname_pattern.size(),
  11128. e.hostname_pattern) == 0) {
  11129. return true;
  11130. }
  11131. }
  11132. break;
  11133. }
  11134. }
  11135. return false;
  11136. }
  11137. template <typename T>
  11138. inline bool check_and_write_headers(Stream &strm, Headers &headers,
  11139. T header_writer, Error &error) {
  11140. for (const auto &h : headers) {
  11141. if (!detail::fields::is_field_valid(h.first, h.second)) {
  11142. error = Error::InvalidHeaders;
  11143. return false;
  11144. }
  11145. }
  11146. if (header_writer(strm, headers) <= 0) {
  11147. error = Error::Write;
  11148. return false;
  11149. }
  11150. return true;
  11151. }
  11152. } // namespace detail
  11153. /*
  11154. * Group 2 (continued): detail namespace - SSLSocketStream implementation
  11155. */
  11156. #ifdef CPPHTTPLIB_SSL_ENABLED
  11157. namespace detail {
  11158. // SSL socket stream implementation
  11159. inline SSLSocketStream::SSLSocketStream(
  11160. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  11161. time_t read_timeout_usec, time_t write_timeout_sec,
  11162. time_t write_timeout_usec, time_t max_timeout_msec,
  11163. std::chrono::time_point<std::chrono::steady_clock> start_time)
  11164. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  11165. read_timeout_usec_(read_timeout_usec),
  11166. write_timeout_sec_(write_timeout_sec),
  11167. write_timeout_usec_(write_timeout_usec),
  11168. max_timeout_msec_(max_timeout_msec), start_time_(start_time) {
  11169. tls_error_.code = tls::ErrorCode::Success;
  11170. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  11171. // Clear AUTO_RETRY for proper non-blocking I/O timeout handling
  11172. // Note: create_session() also clears this, but SSLClient currently
  11173. // uses ssl_new() which does not. Until full TLS API migration is complete,
  11174. // we need to ensure AUTO_RETRY is cleared here regardless of how the
  11175. // SSL session was created.
  11176. SSL_clear_mode(static_cast<SSL *>(session), SSL_MODE_AUTO_RETRY);
  11177. #endif
  11178. }
  11179. inline SSLSocketStream::~SSLSocketStream() = default;
  11180. inline bool SSLSocketStream::is_readable() const {
  11181. return tls::pending(session_) > 0;
  11182. }
  11183. inline bool SSLSocketStream::wait_readable() const {
  11184. if (max_timeout_msec_ <= 0) {
  11185. return select_read_interruptible(sock_, read_timeout_sec_,
  11186. read_timeout_usec_, read_interrupted_) > 0;
  11187. }
  11188. time_t read_timeout_sec;
  11189. time_t read_timeout_usec;
  11190. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  11191. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  11192. return select_read_interruptible(sock_, read_timeout_sec, read_timeout_usec,
  11193. read_interrupted_) > 0;
  11194. }
  11195. inline bool SSLSocketStream::wait_writable() const {
  11196. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0 &&
  11197. !tls::is_peer_closed(session_, sock_);
  11198. }
  11199. inline bool SSLSocketStream::ensure_readable() {
  11200. if (readable_hint_) {
  11201. readable_hint_ = false;
  11202. return true;
  11203. }
  11204. return wait_readable();
  11205. }
  11206. inline bool SSLSocketStream::is_peer_alive() const {
  11207. return !tls::is_peer_closed(session_, sock_);
  11208. }
  11209. inline ssize_t SSLSocketStream::read(char *ptr, size_t size) {
  11210. if (tls::pending(session_) > 0) {
  11211. tls::TlsError err;
  11212. auto ret = tls::read(session_, ptr, size, err);
  11213. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11214. error_ = Error::ConnectionClosed;
  11215. } else if (ret < 0) {
  11216. tls_error_ = err;
  11217. }
  11218. return ret;
  11219. } else if (ensure_readable()) {
  11220. tls::TlsError err;
  11221. auto ret = tls::read(session_, ptr, size, err);
  11222. if (ret < 0) {
  11223. auto n = 1000;
  11224. #ifdef _WIN32
  11225. while (--n >= 0 && (err.code == tls::ErrorCode::WantRead ||
  11226. (err.code == tls::ErrorCode::SyscallError &&
  11227. WSAGetLastError() == WSAETIMEDOUT))) {
  11228. #else
  11229. while (--n >= 0 && err.code == tls::ErrorCode::WantRead) {
  11230. #endif
  11231. if (tls::pending(session_) > 0) {
  11232. ret = tls::read(session_, ptr, size, err);
  11233. if (ret >= 0) { return ret; }
  11234. break;
  11235. } else if (wait_readable()) {
  11236. std::this_thread::sleep_for(std::chrono::microseconds{10});
  11237. ret = tls::read(session_, ptr, size, err);
  11238. if (ret >= 0) { return ret; }
  11239. } else {
  11240. break;
  11241. }
  11242. }
  11243. assert(ret < 0);
  11244. tls_error_ = err;
  11245. } else if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11246. error_ = Error::ConnectionClosed;
  11247. }
  11248. return ret;
  11249. } else {
  11250. error_ = Error::Timeout;
  11251. return -1;
  11252. }
  11253. }
  11254. inline ssize_t SSLSocketStream::write(const char *ptr, size_t size) {
  11255. if (wait_writable()) {
  11256. auto handle_size =
  11257. std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11258. tls::TlsError err;
  11259. auto ret = tls::write(session_, ptr, handle_size, err);
  11260. if (ret < 0) {
  11261. auto n = 1000;
  11262. #ifdef _WIN32
  11263. while (--n >= 0 && (err.code == tls::ErrorCode::WantWrite ||
  11264. (err.code == tls::ErrorCode::SyscallError &&
  11265. WSAGetLastError() == WSAETIMEDOUT))) {
  11266. #else
  11267. while (--n >= 0 && err.code == tls::ErrorCode::WantWrite) {
  11268. #endif
  11269. if (wait_writable()) {
  11270. std::this_thread::sleep_for(std::chrono::microseconds{10});
  11271. ret = tls::write(session_, ptr, handle_size, err);
  11272. if (ret >= 0) { return ret; }
  11273. } else {
  11274. break;
  11275. }
  11276. }
  11277. assert(ret < 0);
  11278. tls_error_ = err;
  11279. }
  11280. return ret;
  11281. }
  11282. return -1;
  11283. }
  11284. inline void SSLSocketStream::get_remote_ip_and_port(std::string &ip,
  11285. int &port) const {
  11286. detail::get_remote_ip_and_port(sock_, ip, port);
  11287. }
  11288. inline void SSLSocketStream::get_local_ip_and_port(std::string &ip,
  11289. int &port) const {
  11290. detail::get_local_ip_and_port(sock_, ip, port);
  11291. }
  11292. inline socket_t SSLSocketStream::socket() const { return sock_; }
  11293. inline time_t SSLSocketStream::duration() const {
  11294. return static_cast<time_t>(
  11295. std::chrono::duration_cast<std::chrono::milliseconds>(
  11296. std::chrono::steady_clock::now() - start_time_)
  11297. .count());
  11298. }
  11299. inline void SSLSocketStream::set_read_timeout(time_t sec, time_t usec) {
  11300. read_timeout_sec_ = sec;
  11301. read_timeout_usec_ = usec;
  11302. }
  11303. inline void SSLSocketStream::set_max_timeout(time_t msec) {
  11304. max_timeout_msec_ = msec;
  11305. start_time_ = std::chrono::steady_clock::now();
  11306. }
  11307. inline void
  11308. SSLSocketStream::set_read_interrupt(std::function<bool()> interrupted) {
  11309. read_interrupted_ = std::move(interrupted);
  11310. }
  11311. inline WebSocketSSLStream::WebSocketSSLStream(socket_t sock,
  11312. tls::session_t session,
  11313. time_t read_timeout_sec,
  11314. time_t read_timeout_usec,
  11315. time_t write_timeout_sec,
  11316. time_t write_timeout_usec)
  11317. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  11318. read_timeout_usec_(read_timeout_usec),
  11319. write_timeout_sec_(write_timeout_sec),
  11320. write_timeout_usec_(write_timeout_usec),
  11321. start_time_(std::chrono::steady_clock::now()) {
  11322. // The receive and send paths run on different threads, so each TLS call is
  11323. // driven in non-blocking mode and readiness is awaited with select()
  11324. // outside the session lock. Set the socket non-blocking once here; it is
  11325. // never flipped back, so no thread races on the flag.
  11326. detail::set_nonblocking(sock_, true);
  11327. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  11328. SSL_clear_mode(static_cast<SSL *>(session_), SSL_MODE_AUTO_RETRY);
  11329. #endif
  11330. }
  11331. inline WebSocketSSLStream::~WebSocketSSLStream() = default;
  11332. inline bool WebSocketSSLStream::is_readable() const {
  11333. std::lock_guard<std::mutex> guard(session_mutex_);
  11334. return tls::pending(session_) > 0;
  11335. }
  11336. inline bool WebSocketSSLStream::wait_readable() const {
  11337. return select_read_interruptible(sock_, read_timeout_sec_, read_timeout_usec_,
  11338. read_interrupted_) > 0;
  11339. }
  11340. inline bool WebSocketSSLStream::wait_writable() const {
  11341. // Unlike SSLSocketStream, this deliberately does not call is_peer_closed():
  11342. // that probe toggles the socket's blocking flag, which would race with the
  11343. // concurrent reader on a permanently non-blocking socket.
  11344. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  11345. }
  11346. inline ssize_t WebSocketSSLStream::read(char *ptr, size_t size) {
  11347. tls::TlsError err;
  11348. auto n = 1000;
  11349. while (--n >= 0) {
  11350. {
  11351. std::lock_guard<std::mutex> guard(session_mutex_);
  11352. auto ret = tls::read(session_, ptr, size, err);
  11353. if (ret > 0) { return ret; }
  11354. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11355. error_ = Error::ConnectionClosed;
  11356. return ret;
  11357. }
  11358. }
  11359. // ret < 0. On a non-blocking socket a TLS read can stop needing either
  11360. // direction: the send path shares this session, so output it left pending
  11361. // has to be flushed before more input can be decrypted. Anything else is
  11362. // a hard error.
  11363. auto needs_readable = err.code == tls::ErrorCode::WantRead;
  11364. #ifdef _WIN32
  11365. // On Windows a socket timeout surfaces as a syscall error, not WantRead.
  11366. needs_readable =
  11367. needs_readable || (err.code == tls::ErrorCode::SyscallError &&
  11368. WSAGetLastError() == WSAETIMEDOUT);
  11369. #endif
  11370. if (!needs_readable && err.code != tls::ErrorCode::WantWrite) {
  11371. error_ = Error::Read;
  11372. return -1;
  11373. }
  11374. if (!(needs_readable ? wait_readable() : wait_writable())) {
  11375. error_ = Error::Timeout;
  11376. return -1;
  11377. }
  11378. }
  11379. // Out of retries. Recording a reason matters: a caller that reads get_error()
  11380. // to tell a timeout from a close would otherwise see whatever the previous
  11381. // failure left behind (error_ is never cleared on success).
  11382. error_ = Error::Read;
  11383. return -1;
  11384. }
  11385. inline ssize_t WebSocketSSLStream::write(const char *ptr, size_t size) {
  11386. auto handle_size = std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11387. tls::TlsError err;
  11388. auto n = 1000;
  11389. while (--n >= 0) {
  11390. {
  11391. std::lock_guard<std::mutex> guard(session_mutex_);
  11392. auto ret = tls::write(session_, ptr, handle_size, err);
  11393. if (ret >= 0) { return ret; }
  11394. }
  11395. // ret < 0. As in read(), either direction can be needed: a renegotiation
  11396. // or a post-handshake message must be consumed before the record goes
  11397. // out. Anything else is a hard error.
  11398. auto needs_writable = err.code == tls::ErrorCode::WantWrite;
  11399. #ifdef _WIN32
  11400. // On Windows a socket timeout surfaces as a syscall error, not WantWrite.
  11401. needs_writable =
  11402. needs_writable || (err.code == tls::ErrorCode::SyscallError &&
  11403. WSAGetLastError() == WSAETIMEDOUT);
  11404. #endif
  11405. if (!needs_writable && err.code != tls::ErrorCode::WantRead) { return -1; }
  11406. if (!(needs_writable ? wait_writable() : wait_readable())) { return -1; }
  11407. }
  11408. return -1;
  11409. }
  11410. inline void WebSocketSSLStream::get_remote_ip_and_port(std::string &ip,
  11411. int &port) const {
  11412. detail::get_remote_ip_and_port(sock_, ip, port);
  11413. }
  11414. inline void WebSocketSSLStream::get_local_ip_and_port(std::string &ip,
  11415. int &port) const {
  11416. detail::get_local_ip_and_port(sock_, ip, port);
  11417. }
  11418. inline socket_t WebSocketSSLStream::socket() const { return sock_; }
  11419. inline time_t WebSocketSSLStream::duration() const {
  11420. return static_cast<time_t>(
  11421. std::chrono::duration_cast<std::chrono::milliseconds>(
  11422. std::chrono::steady_clock::now() - start_time_)
  11423. .count());
  11424. }
  11425. inline void WebSocketSSLStream::set_read_timeout(time_t sec, time_t usec) {
  11426. read_timeout_sec_ = sec;
  11427. read_timeout_usec_ = usec;
  11428. }
  11429. inline void
  11430. WebSocketSSLStream::set_read_interrupt(std::function<bool()> interrupted) {
  11431. read_interrupted_ = std::move(interrupted);
  11432. }
  11433. } // namespace detail
  11434. #endif // CPPHTTPLIB_SSL_ENABLED
  11435. /*
  11436. * Group 4: Server implementation
  11437. */
  11438. // HTTP server implementation
  11439. inline Server::Server()
  11440. : new_task_queue([] {
  11441. return new ThreadPool(CPPHTTPLIB_THREAD_POOL_COUNT,
  11442. CPPHTTPLIB_THREAD_POOL_MAX_COUNT);
  11443. }) {
  11444. #ifndef _WIN32
  11445. signal(SIGPIPE, SIG_IGN);
  11446. #endif
  11447. }
  11448. inline Server::~Server() = default;
  11449. inline std::unique_ptr<detail::MatcherBase>
  11450. Server::make_matcher(const std::string &pattern) {
  11451. // Path params take precedence, so "/users/:id/(.*)" keeps being matched as
  11452. // a path params pattern
  11453. if (pattern.find("/:") != std::string::npos) {
  11454. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11455. }
  11456. // A pattern with no regex metacharacter only has to be compared literally,
  11457. // which is what PathParamsMatcher already does when it captures no
  11458. // parameter, so std::regex is only worth building for the patterns that
  11459. // actually need it
  11460. if (pattern.find_first_of(".^$|()[]{}*+?\\") == std::string::npos) {
  11461. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11462. }
  11463. return detail::make_unique<detail::RegexMatcher>(pattern);
  11464. }
  11465. inline Server &Server::Get(const std::string &pattern, Handler handler) {
  11466. return add_handler(get_handlers_, pattern, std::move(handler));
  11467. }
  11468. inline Server &Server::Post(const std::string &pattern, Handler handler) {
  11469. return add_handler(post_handlers_, pattern, std::move(handler));
  11470. }
  11471. inline Server &Server::Post(const std::string &pattern,
  11472. HandlerWithContentReader handler) {
  11473. return add_handler(post_handlers_for_content_reader_, pattern,
  11474. std::move(handler));
  11475. }
  11476. inline Server &Server::Put(const std::string &pattern, Handler handler) {
  11477. return add_handler(put_handlers_, pattern, std::move(handler));
  11478. }
  11479. inline Server &Server::Put(const std::string &pattern,
  11480. HandlerWithContentReader handler) {
  11481. return add_handler(put_handlers_for_content_reader_, pattern,
  11482. std::move(handler));
  11483. }
  11484. inline Server &Server::Patch(const std::string &pattern, Handler handler) {
  11485. return add_handler(patch_handlers_, pattern, std::move(handler));
  11486. }
  11487. inline Server &Server::Patch(const std::string &pattern,
  11488. HandlerWithContentReader handler) {
  11489. return add_handler(patch_handlers_for_content_reader_, pattern,
  11490. std::move(handler));
  11491. }
  11492. inline Server &Server::Delete(const std::string &pattern, Handler handler) {
  11493. return add_handler(delete_handlers_, pattern, std::move(handler));
  11494. }
  11495. inline Server &Server::Delete(const std::string &pattern,
  11496. HandlerWithContentReader handler) {
  11497. return add_handler(delete_handlers_for_content_reader_, pattern,
  11498. std::move(handler));
  11499. }
  11500. inline Server &Server::Options(const std::string &pattern, Handler handler) {
  11501. return add_handler(options_handlers_, pattern, std::move(handler));
  11502. }
  11503. inline const std::set<std::string> &Server::builtin_methods() {
  11504. thread_local const std::set<std::string> methods{
  11505. "GET", "HEAD", "POST", "PUT", "DELETE",
  11506. "CONNECT", "OPTIONS", "TRACE", "PATCH", "PRI"};
  11507. return methods;
  11508. }
  11509. inline Server::CustomHandlerEntry *
  11510. Server::custom_entry_for_registration(const std::string &method) {
  11511. // Built-in methods are refused for two different reasons. GET, HEAD, POST,
  11512. // PUT, DELETE, OPTIONS and PATCH are dispatched by the if/else chain in
  11513. // routing() before the custom tables are consulted, so a route registered
  11514. // for one of them could never fire. CONNECT, TRACE and PRI have no branch
  11515. // there and would be reachable, but they carry protocol-level meaning
  11516. // (tunnel setup, request echo, the HTTP/2 connection preface) that this
  11517. // library does not route.
  11518. if (!detail::fields::is_token(method) || builtin_methods().count(method)) {
  11519. output_error_log(Error::InvalidHTTPMethod, nullptr);
  11520. has_invalid_registration_ = true;
  11521. return nullptr;
  11522. }
  11523. return &custom_handlers_[method];
  11524. }
  11525. inline Server &Server::CustomRoute(const std::string &method,
  11526. const std::string &pattern,
  11527. Handler handler) {
  11528. auto *entry = custom_entry_for_registration(method);
  11529. if (!entry) { return *this; }
  11530. return add_handler(entry->handlers, pattern, std::move(handler));
  11531. }
  11532. inline Server &Server::CustomRoute(const std::string &method,
  11533. const std::string &pattern,
  11534. HandlerWithContentReader handler) {
  11535. auto *entry = custom_entry_for_registration(method);
  11536. if (!entry) { return *this; }
  11537. return add_handler(entry->handlers_for_content_reader, pattern,
  11538. std::move(handler));
  11539. }
  11540. inline const Server::CustomHandlerEntry *
  11541. Server::find_custom_entry(const std::string &method) const {
  11542. // find() alone would be correct here. The empty() check is what keeps the
  11543. // per-request cost off servers that never call CustomRoute(), which is the
  11544. // overwhelmingly common case; keep it rather than walking into the tree.
  11545. if (custom_handlers_.empty()) { return nullptr; }
  11546. auto it = custom_handlers_.find(method);
  11547. return it == custom_handlers_.end() ? nullptr : &it->second;
  11548. }
  11549. inline Server &Server::WebSocket(const std::string &pattern,
  11550. WebSocketHandler handler) {
  11551. websocket_handlers_.push_back(
  11552. {make_matcher(pattern), std::move(handler), nullptr});
  11553. return *this;
  11554. }
  11555. inline Server &Server::WebSocket(const std::string &pattern,
  11556. WebSocketHandler handler,
  11557. SubProtocolSelector sub_protocol_selector) {
  11558. websocket_handlers_.push_back({make_matcher(pattern), std::move(handler),
  11559. std::move(sub_protocol_selector)});
  11560. return *this;
  11561. }
  11562. inline bool Server::set_base_dir(const std::string &dir,
  11563. const std::string &mount_point) {
  11564. return set_mount_point(mount_point, dir);
  11565. }
  11566. inline bool Server::set_mount_point(const std::string &mount_point,
  11567. const std::string &dir, Headers headers) {
  11568. detail::FileStat stat(dir);
  11569. if (stat.is_dir()) {
  11570. std::string mnt = !mount_point.empty() ? mount_point : "/";
  11571. if (!mnt.empty() && mnt[0] == '/') {
  11572. // Without the resolved directory, a file could not be checked to be
  11573. // inside it.
  11574. std::string resolved_base;
  11575. if (!detail::canonicalize_path(dir.c_str(), resolved_base)) {
  11576. return false;
  11577. }
  11578. #if defined(_WIN32)
  11579. if (resolved_base.back() != '\\' && resolved_base.back() != '/') {
  11580. resolved_base += '\\';
  11581. }
  11582. #else
  11583. if (resolved_base.back() != '/') { resolved_base += '/'; }
  11584. #endif
  11585. base_dirs_.push_back(
  11586. {std::move(mnt), dir, std::move(resolved_base), std::move(headers)});
  11587. return true;
  11588. }
  11589. }
  11590. return false;
  11591. }
  11592. inline bool Server::remove_mount_point(const std::string &mount_point) {
  11593. for (auto it = base_dirs_.begin(); it != base_dirs_.end(); ++it) {
  11594. if (it->mount_point == mount_point) {
  11595. base_dirs_.erase(it);
  11596. return true;
  11597. }
  11598. }
  11599. return false;
  11600. }
  11601. inline Server &
  11602. Server::set_file_extension_and_mimetype_mapping(const std::string &ext,
  11603. const std::string &mime) {
  11604. file_extension_and_mimetype_map_[ext] = mime;
  11605. return *this;
  11606. }
  11607. inline Server &Server::set_default_file_mimetype(const std::string &mime) {
  11608. default_file_mimetype_ = mime;
  11609. return *this;
  11610. }
  11611. inline Server &Server::set_file_request_handler(Handler handler) {
  11612. file_request_handler_ = std::move(handler);
  11613. return *this;
  11614. }
  11615. inline Server &Server::set_error_handler_core(HandlerWithResponse handler,
  11616. std::true_type) {
  11617. error_handler_ = std::move(handler);
  11618. return *this;
  11619. }
  11620. inline Server &Server::set_error_handler_core(Handler handler,
  11621. std::false_type) {
  11622. error_handler_ = [handler](const Request &req, Response &res) {
  11623. handler(req, res);
  11624. return HandlerResponse::Handled;
  11625. };
  11626. return *this;
  11627. }
  11628. inline Server &Server::set_exception_handler(ExceptionHandler handler) {
  11629. exception_handler_ = std::move(handler);
  11630. return *this;
  11631. }
  11632. inline Server &Server::set_pre_routing_handler(HandlerWithResponse handler) {
  11633. pre_routing_handler_ = std::move(handler);
  11634. return *this;
  11635. }
  11636. inline Server &Server::set_post_routing_handler(Handler handler) {
  11637. post_routing_handler_ = std::move(handler);
  11638. return *this;
  11639. }
  11640. inline Server &Server::set_pre_request_handler(HandlerWithResponse handler) {
  11641. pre_request_handler_ = std::move(handler);
  11642. return *this;
  11643. }
  11644. inline Server &Server::set_logger(Logger logger) {
  11645. logger_ = std::move(logger);
  11646. return *this;
  11647. }
  11648. inline Server &Server::set_error_logger(ErrorLogger error_logger) {
  11649. error_logger_ = std::move(error_logger);
  11650. return *this;
  11651. }
  11652. inline Server &Server::set_pre_compression_logger(Logger logger) {
  11653. pre_compression_logger_ = std::move(logger);
  11654. return *this;
  11655. }
  11656. inline Server &
  11657. Server::set_expect_100_continue_handler(Expect100ContinueHandler handler) {
  11658. expect_100_continue_handler_ = std::move(handler);
  11659. return *this;
  11660. }
  11661. inline Server &Server::set_start_handler(StartHandler handler) {
  11662. start_handler_ = std::move(handler);
  11663. return *this;
  11664. }
  11665. inline Server &Server::set_address_family(int family) {
  11666. address_family_ = family;
  11667. return *this;
  11668. }
  11669. inline Server &Server::set_tcp_nodelay(bool on) {
  11670. tcp_nodelay_ = on;
  11671. return *this;
  11672. }
  11673. inline Server &Server::set_ipv6_v6only(bool on) {
  11674. ipv6_v6only_ = on;
  11675. return *this;
  11676. }
  11677. inline Server &Server::set_socket_options(SocketOptions socket_options) {
  11678. socket_options_ = std::move(socket_options);
  11679. return *this;
  11680. }
  11681. inline Server &Server::set_default_headers(Headers headers) {
  11682. default_headers_ = std::move(headers);
  11683. return *this;
  11684. }
  11685. inline Server &Server::set_header_writer(
  11686. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  11687. header_writer_ = writer;
  11688. return *this;
  11689. }
  11690. inline Server &
  11691. Server::set_trusted_proxies(const std::vector<std::string> &proxies) {
  11692. trusted_proxies_ = proxies;
  11693. return *this;
  11694. }
  11695. inline Server &Server::set_keep_alive_max_count(size_t count) {
  11696. keep_alive_max_count_ = count;
  11697. return *this;
  11698. }
  11699. inline Server &Server::set_keep_alive_timeout(time_t sec) {
  11700. keep_alive_timeout_sec_ = sec;
  11701. return *this;
  11702. }
  11703. template <class Rep, class Period>
  11704. inline Server &Server::set_keep_alive_timeout(
  11705. const std::chrono::duration<Rep, Period> &duration) {
  11706. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11707. set_keep_alive_timeout(sec);
  11708. });
  11709. return *this;
  11710. }
  11711. inline Server &Server::set_read_timeout(time_t sec, time_t usec) {
  11712. read_timeout_sec_ = sec;
  11713. read_timeout_usec_ = usec;
  11714. return *this;
  11715. }
  11716. inline Server &Server::set_write_timeout(time_t sec, time_t usec) {
  11717. write_timeout_sec_ = sec;
  11718. write_timeout_usec_ = usec;
  11719. return *this;
  11720. }
  11721. inline Server &Server::set_idle_interval(time_t sec, time_t usec) {
  11722. idle_interval_sec_ = sec;
  11723. idle_interval_usec_ = usec;
  11724. return *this;
  11725. }
  11726. inline Server &Server::set_payload_max_length(size_t length) {
  11727. payload_max_length_ = length;
  11728. return *this;
  11729. }
  11730. inline Server &Server::set_static_file_compression(bool on) {
  11731. static_file_compression_ = on;
  11732. return *this;
  11733. }
  11734. inline Server &Server::set_static_file_compression_min_length(size_t length) {
  11735. static_file_compression_min_length_ = length;
  11736. return *this;
  11737. }
  11738. inline Server &Server::set_static_file_compression_max_length(size_t length) {
  11739. static_file_compression_max_length_ = length;
  11740. return *this;
  11741. }
  11742. inline Server &Server::set_websocket_max_missed_pongs(int count) {
  11743. websocket_max_missed_pongs_ = count;
  11744. return *this;
  11745. }
  11746. inline Server &Server::set_websocket_ping_interval(time_t sec) {
  11747. websocket_ping_interval_sec_ = sec;
  11748. return *this;
  11749. }
  11750. template <class Rep, class Period>
  11751. inline Server &Server::set_websocket_ping_interval(
  11752. const std::chrono::duration<Rep, Period> &duration) {
  11753. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11754. set_websocket_ping_interval(sec);
  11755. });
  11756. return *this;
  11757. }
  11758. inline bool Server::bind_to_port(const std::string &host, int port,
  11759. int socket_flags) {
  11760. auto ret = bind_internal(host, port, socket_flags);
  11761. if (ret == -1) { is_decommissioned = true; }
  11762. return ret >= 0;
  11763. }
  11764. inline int Server::bind_to_any_port(const std::string &host, int socket_flags) {
  11765. auto ret = bind_internal(host, 0, socket_flags);
  11766. if (ret == -1) { is_decommissioned = true; }
  11767. return ret;
  11768. }
  11769. inline bool Server::listen_after_bind() { return listen_internal(); }
  11770. inline bool Server::listen(const std::string &host, int port,
  11771. int socket_flags) {
  11772. return bind_to_port(host, port, socket_flags) && listen_internal();
  11773. }
  11774. inline bool Server::is_running() const { return is_running_; }
  11775. inline void Server::wait_until_ready() const {
  11776. while (!is_running_ && !is_decommissioned) {
  11777. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  11778. }
  11779. }
  11780. inline void Server::stop() noexcept {
  11781. // Release the listening socket whether or not the accept loop is running:
  11782. // bind_to_port() without listen_after_bind() still owns the descriptor. The
  11783. // exchange is what makes this safe to call concurrently with the accept loop.
  11784. socket_t sock = svr_sock_.exchange(INVALID_SOCKET);
  11785. if (sock != INVALID_SOCKET) {
  11786. detail::shutdown_socket(sock);
  11787. detail::close_socket(sock);
  11788. }
  11789. is_decommissioned = false;
  11790. }
  11791. inline void Server::decommission() { is_decommissioned = true; }
  11792. inline bool Server::parse_request_line(const char *s, Request &req) const {
  11793. auto len = strlen(s);
  11794. if (len < 2 || s[len - 2] != '\r' || s[len - 1] != '\n') { return false; }
  11795. len -= 2;
  11796. {
  11797. // RFC 9112 §3: exactly one SP between the method, the target and the
  11798. // version. Taking other whitespace as a separator too lets recipients
  11799. // that parse more strictly see a different request.
  11800. auto end = s + len;
  11801. if (std::count(s, end, ' ') != 2) { return false; }
  11802. auto sp1 = std::find(s, end, ' ');
  11803. auto sp2 = std::find(sp1 + 1, end, ' ');
  11804. if (sp1 == s || sp2 == sp1 + 1 || sp2 + 1 == end) { return false; }
  11805. req.method.assign(s, sp1);
  11806. req.target.assign(sp1 + 1, sp2);
  11807. req.version.assign(sp2 + 1, end);
  11808. }
  11809. // A method outside the built-in set is accepted only when a handler has been
  11810. // registered for it with CustomRoute().
  11811. const auto &methods = builtin_methods();
  11812. if (methods.find(req.method) == methods.end() &&
  11813. !find_custom_entry(req.method)) {
  11814. output_error_log(Error::InvalidHTTPMethod, &req);
  11815. return false;
  11816. }
  11817. if (req.version != "HTTP/1.1" && req.version != "HTTP/1.0") {
  11818. output_error_log(Error::InvalidHTTPVersion, &req);
  11819. return false;
  11820. }
  11821. // A request-target has no fragment (RFC 9112 §3.2), and one stripped here
  11822. // would leave this server routing a different path than a cache or a
  11823. // filter in front of it sees.
  11824. if (!detail::fields::is_request_target(req.target) ||
  11825. req.target.find('#') != std::string::npos) {
  11826. return false;
  11827. }
  11828. {
  11829. detail::divide(req.target, '?',
  11830. [&](const char *lhs_data, std::size_t lhs_size,
  11831. const char *rhs_data, std::size_t rhs_size) {
  11832. req.path =
  11833. decode_path_component(std::string(lhs_data, lhs_size));
  11834. detail::parse_query_text(rhs_data, rhs_size, req.params);
  11835. });
  11836. }
  11837. return true;
  11838. }
  11839. inline bool Server::write_response(Stream &strm, bool close_connection,
  11840. Request &req, Response &res) {
  11841. // NOTE: `req.ranges` should be empty, otherwise it will be applied
  11842. // incorrectly to the error content.
  11843. req.ranges.clear();
  11844. return write_response_core(strm, close_connection, req, res, false);
  11845. }
  11846. inline bool Server::write_response_with_content(Stream &strm,
  11847. bool close_connection,
  11848. const Request &req,
  11849. Response &res) {
  11850. return write_response_core(strm, close_connection, req, res, true);
  11851. }
  11852. inline bool Server::write_response_core(Stream &strm, bool close_connection,
  11853. const Request &req, Response &res,
  11854. bool need_apply_ranges) {
  11855. assert(res.status != -1);
  11856. if (400 <= res.status && error_handler_ &&
  11857. error_handler_(req, res) == HandlerResponse::Handled) {
  11858. need_apply_ranges = true;
  11859. }
  11860. if (!detail::body_allowed_for_status(res.status)) {
  11861. detail::clear_content(res);
  11862. }
  11863. detail::prefer_assigned_body(res);
  11864. std::string content_type;
  11865. std::string boundary;
  11866. if (need_apply_ranges) { apply_ranges(req, res, content_type, boundary); }
  11867. // Prepare additional headers
  11868. if (close_connection ||
  11869. detail::has_header_token(req.headers, "Connection", "close") ||
  11870. 400 <= res.status || // Don't leave connections open after errors
  11871. // The client withholds the body until `100 Continue`, which was never
  11872. // sent, so whether and when the body follows is unknown.
  11873. (req.expect_100_continue_pending_ && detail::has_framed_body(req)) ||
  11874. // The body was left partway, e.g. by a content receiver that returned
  11875. // false, so the rest of it cannot be told from the next request.
  11876. (req.body_read_started_ && !req.body_consumed_)) {
  11877. res.set_header("Connection", "close");
  11878. } else {
  11879. std::string s = "timeout=";
  11880. s += std::to_string(keep_alive_timeout_sec_);
  11881. if (keep_alive_max_count_ > 0) {
  11882. s += ", max=";
  11883. s += std::to_string(keep_alive_max_count_);
  11884. }
  11885. res.set_header("Keep-Alive", s);
  11886. }
  11887. if ((!res.body.empty() || res.content_length_ > 0 || res.content_provider_) &&
  11888. !res.has_header("Content-Type")) {
  11889. res.set_header("Content-Type", "text/plain");
  11890. }
  11891. detail::set_framing_headers(req, res, boundary, content_type);
  11892. if (req.method == "HEAD" && !res.has_header("Accept-Ranges")) {
  11893. res.set_header("Accept-Ranges", "bytes");
  11894. }
  11895. if (post_routing_handler_) {
  11896. post_routing_handler_(req, res);
  11897. // Again, for a body or framing headers the handler changed.
  11898. detail::set_framing_headers(req, res, boundary, content_type);
  11899. }
  11900. // Response line and headers
  11901. detail::BufferStream bstrm;
  11902. if (!detail::write_response_line(bstrm, res.status)) { return false; }
  11903. if (header_writer_(bstrm, res.headers) <= 0) { return false; }
  11904. // Combine a small body with the headers so the whole response leaves in a
  11905. // single write. A large body is written on its own instead: a copy of it
  11906. // costs more than the extra write saves.
  11907. auto send_body =
  11908. req.method != "HEAD" && detail::body_allowed_for_status(res.status);
  11909. auto body_is_separate = false;
  11910. auto provider_done = false;
  11911. if (send_body && !res.body.empty() && !res.content_provider_) {
  11912. if (res.body.size() < CPPHTTPLIB_SEND_BUFSIZ) {
  11913. bstrm.write(res.body.data(), res.body.size());
  11914. } else {
  11915. body_is_separate = true;
  11916. }
  11917. } else if (send_body && res.content_provider_ &&
  11918. res.is_file_content_provider_ &&
  11919. res.content_length_ < CPPHTTPLIB_SEND_BUFSIZ) {
  11920. // A small file is read into the same buffer. Other providers may produce
  11921. // their data over time, so they are never held back.
  11922. if (!write_content_with_provider(bstrm, req, res, boundary, content_type)) {
  11923. return false;
  11924. }
  11925. provider_done = true;
  11926. }
  11927. // Log before writing to avoid race condition with client-side code that
  11928. // accesses logger-captured data immediately after receiving the response.
  11929. output_log(req, res);
  11930. // Flush buffer
  11931. auto &data = bstrm.get_buffer();
  11932. if (!detail::write_data(strm, data.data(), data.size())) { return false; }
  11933. if (body_is_separate) {
  11934. return detail::write_data(strm, res.body.data(), res.body.size());
  11935. }
  11936. // Streaming body
  11937. if (send_body && res.content_provider_) {
  11938. if (!provider_done &&
  11939. !write_content_with_provider(strm, req, res, boundary, content_type)) {
  11940. return false;
  11941. }
  11942. res.content_provider_success_ = true;
  11943. }
  11944. return true;
  11945. }
  11946. inline bool
  11947. Server::write_content_with_provider(Stream &strm, const Request &req,
  11948. Response &res, const std::string &boundary,
  11949. const std::string &content_type) {
  11950. auto is_shutting_down = [this]() {
  11951. return this->svr_sock_ == INVALID_SOCKET;
  11952. };
  11953. if (res.content_length_ > 0) {
  11954. if (!detail::is_partial_content(req, res)) {
  11955. return detail::write_content(strm, res.content_provider_, 0,
  11956. res.content_length_, is_shutting_down);
  11957. } else if (req.ranges.size() == 1) {
  11958. auto offset_and_length = detail::get_range_offset_and_length(
  11959. req.ranges[0], res.content_length_);
  11960. return detail::write_content(strm, res.content_provider_,
  11961. offset_and_length.first,
  11962. offset_and_length.second, is_shutting_down);
  11963. } else {
  11964. return detail::write_multipart_ranges_data(
  11965. strm, req, res, boundary, content_type, res.content_length_,
  11966. is_shutting_down);
  11967. }
  11968. } else {
  11969. if (res.is_chunked_content_provider_) {
  11970. // Use the coding `apply_ranges()` chose when it wrote the headers;
  11971. // re-negotiating here would disagree with them, e.g. once a handler's
  11972. // own Content-Encoding header suppresses the negotiation.
  11973. auto compressor = detail::make_compressor(res.content_coding_);
  11974. if (!compressor) {
  11975. compressor = detail::make_unique<detail::nocompressor>();
  11976. }
  11977. return detail::write_content_chunked(strm, res.content_provider_,
  11978. is_shutting_down, *compressor);
  11979. } else {
  11980. return detail::write_content_without_length(strm, res.content_provider_,
  11981. is_shutting_down);
  11982. }
  11983. }
  11984. }
  11985. inline bool Server::read_content(Stream &strm, Request &req, Response &res) {
  11986. FormFields::iterator cur_field;
  11987. FormFiles::iterator cur_file;
  11988. auto is_text_field = false;
  11989. size_t count = 0;
  11990. if (read_content_core(
  11991. strm, req, res,
  11992. // Regular
  11993. [&](const char *buf, size_t n) {
  11994. // Prevent arithmetic overflow when checking sizes.
  11995. // Avoid computing (req.body.size() + n) directly because
  11996. // adding two unsigned `size_t` values can wrap around and
  11997. // produce a small result instead of indicating overflow.
  11998. // Instead, check using subtraction: ensure `n` does not
  11999. // exceed the remaining capacity `max_size() - size()`.
  12000. if (req.body.size() >= req.body.max_size() ||
  12001. n > req.body.max_size() - req.body.size()) {
  12002. return false;
  12003. }
  12004. // Limit decompressed body size to payload_max_length_ to protect
  12005. // against "zip bomb" attacks where a small compressed payload
  12006. // decompresses to a massive size.
  12007. if (payload_max_length_ > 0 &&
  12008. (req.body.size() >= payload_max_length_ ||
  12009. n > payload_max_length_ - req.body.size())) {
  12010. return false;
  12011. }
  12012. req.body.append(buf, n);
  12013. return true;
  12014. },
  12015. // Multipart FormData
  12016. [&](const FormData &file) {
  12017. if (CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT > 0 &&
  12018. count++ == CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT) {
  12019. output_error_log(Error::TooManyFormDataFiles, &req);
  12020. return false;
  12021. }
  12022. if (file.filename.empty()) {
  12023. cur_field = req.form.fields.emplace(
  12024. file.name, FormField{file.name, file.content, file.headers});
  12025. is_text_field = true;
  12026. } else {
  12027. cur_file = req.form.files.emplace(file.name, file);
  12028. is_text_field = false;
  12029. }
  12030. return true;
  12031. },
  12032. [&](const char *buf, size_t n) {
  12033. if (is_text_field) {
  12034. auto &content = cur_field->second.content;
  12035. if (content.size() + n > content.max_size()) { return false; }
  12036. content.append(buf, n);
  12037. } else {
  12038. auto &content = cur_file->second.content;
  12039. if (content.size() + n > content.max_size()) { return false; }
  12040. content.append(buf, n);
  12041. }
  12042. return true;
  12043. })) {
  12044. const auto &content_type = req.get_header_value("Content-Type");
  12045. if (detail::case_ignore::equal(detail::extract_media_type(content_type),
  12046. "application/x-www-form-urlencoded")) {
  12047. if (CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH > 0 &&
  12048. req.body.size() > CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH) {
  12049. res.status = StatusCode::PayloadTooLarge_413; // NOTE: should be 414?
  12050. output_error_log(Error::ExceedMaxPayloadSize, &req);
  12051. return false;
  12052. }
  12053. detail::parse_query_text(req.body, req.params);
  12054. }
  12055. return true;
  12056. }
  12057. return false;
  12058. }
  12059. inline bool Server::read_content_with_content_receiver(
  12060. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  12061. FormDataHeader multipart_header, ContentReceiver multipart_receiver) {
  12062. return read_content_core(strm, req, res, std::move(receiver),
  12063. std::move(multipart_header),
  12064. std::move(multipart_receiver));
  12065. }
  12066. inline bool Server::read_content_core(
  12067. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  12068. FormDataHeader multipart_header, ContentReceiver multipart_receiver) const {
  12069. detail::FormDataParser multipart_form_data_parser;
  12070. ContentReceiverWithProgress out;
  12071. if (req.is_multipart_form_data()) {
  12072. const auto &content_type = req.get_header_value("Content-Type");
  12073. std::string boundary;
  12074. if (!detail::parse_multipart_boundary(content_type, boundary)) {
  12075. res.status = StatusCode::BadRequest_400;
  12076. output_error_log(Error::MultipartParsing, &req);
  12077. return false;
  12078. }
  12079. multipart_form_data_parser.set_boundary(std::move(boundary));
  12080. out = [&](const char *buf, size_t n, size_t /*off*/, size_t /*len*/) {
  12081. return multipart_form_data_parser.parse(buf, n, multipart_header,
  12082. multipart_receiver);
  12083. };
  12084. } else {
  12085. out = [receiver](const char *buf, size_t n, size_t /*off*/,
  12086. size_t /*len*/) { return receiver(buf, n); };
  12087. }
  12088. // RFC 9112 §6: no Transfer-Encoding and no Content-Length means no body.
  12089. // For non-SSL builds we still scan non-persistent connections for stray
  12090. // body bytes so the payload limit is enforced (413). On keep-alive,
  12091. // pending bytes may be the next request (issue #2450), so skip.
  12092. #if !defined(CPPHTTPLIB_SSL_ENABLED)
  12093. if (!req.has_header("Content-Length") &&
  12094. !detail::is_chunked_transfer_encoding(req.headers)) {
  12095. if (!detail::is_connection_persistent(req) && payload_max_length_ > 0 &&
  12096. payload_max_length_ < (std::numeric_limits<size_t>::max)()) {
  12097. auto has_data = strm.is_readable();
  12098. if (!has_data) {
  12099. auto s = strm.socket();
  12100. if (s != INVALID_SOCKET) {
  12101. has_data = detail::select_read(s, 0, 0) > 0;
  12102. }
  12103. }
  12104. if (has_data) {
  12105. // Route through the same decompressing reader used by the
  12106. // length-framed and chunked paths below, so payload_max_length_ is
  12107. // enforced on the decompressed size here too instead of only on the
  12108. // compressed wire bytes.
  12109. return detail::read_content(strm, req, payload_max_length_, res.status,
  12110. nullptr, out, true);
  12111. }
  12112. }
  12113. return true;
  12114. }
  12115. #else
  12116. if (!req.has_header("Content-Length") &&
  12117. !detail::is_chunked_transfer_encoding(req.headers)) {
  12118. return true;
  12119. }
  12120. #endif
  12121. // A second read would start where the first one stopped, or in the next
  12122. // request.
  12123. if (req.body_read_started_) { return false; }
  12124. // The client is waiting for this before it sends the body.
  12125. if (req.expect_100_continue_pending_) {
  12126. req.expect_100_continue_pending_ = false;
  12127. detail::write_response_line(strm, StatusCode::Continue_100);
  12128. strm.write("\r\n");
  12129. }
  12130. // Set before reading, since a receiver may also stop by throwing.
  12131. req.body_read_started_ = true;
  12132. if (!detail::read_content(strm, req, payload_max_length_, res.status, nullptr,
  12133. out, true)) {
  12134. return false;
  12135. }
  12136. req.body_consumed_ = true;
  12137. if (req.is_multipart_form_data()) {
  12138. if (!multipart_form_data_parser.is_valid()) {
  12139. res.status = StatusCode::BadRequest_400;
  12140. output_error_log(Error::MultipartParsing, &req);
  12141. return false;
  12142. }
  12143. }
  12144. return true;
  12145. }
  12146. inline bool Server::handle_file_request(Request &req, Response &res) {
  12147. if (!detail::is_valid_path(req.path)) { return false; }
  12148. for (const auto &entry : base_dirs_) {
  12149. // Prefix match, on a path segment boundary. A mount point of "/mount"
  12150. // covers "/mount" and "/mount/...", but must not swallow "/mountdir/...".
  12151. // One that already ends in '/' (the root mount among them) carries its own
  12152. // boundary; set_mount_point() guarantees the mount point is not empty.
  12153. if (!req.path.compare(0, entry.mount_point.size(), entry.mount_point) &&
  12154. (entry.mount_point.back() == '/' ||
  12155. req.path.size() == entry.mount_point.size() ||
  12156. req.path[entry.mount_point.size()] == '/')) {
  12157. std::string sub_path = "/" + req.path.substr(entry.mount_point.size());
  12158. auto path = entry.base_dir + sub_path;
  12159. if (path.back() == '/') { path += "index.html"; }
  12160. // Defense-in-depth: is_valid_path blocks ".." traversal in the URL,
  12161. // but symlinks/junctions can still escape the base directory. A path
  12162. // that cannot be resolved, which includes one that does not exist, is
  12163. // not served from here.
  12164. std::string resolved_path;
  12165. if (!detail::canonicalize_path(path.c_str(), resolved_path)) { continue; }
  12166. if (!detail::is_path_within_base(resolved_path,
  12167. entry.resolved_base_dir)) {
  12168. res.status = StatusCode::Forbidden_403;
  12169. return true;
  12170. }
  12171. detail::FileStat stat(path);
  12172. if (stat.is_dir()) {
  12173. // Relative, so "//dir" cannot name another host; "./" keeps a ':'
  12174. // in the name from reading as a scheme.
  12175. auto name = req.path.substr(req.path.rfind('/') + 1);
  12176. res.set_redirect("./" + encode_path_component(name) + "/",
  12177. StatusCode::MovedPermanently_301);
  12178. return true;
  12179. }
  12180. if (stat.is_file()) {
  12181. for (const auto &kv : entry.headers) {
  12182. res.set_header(kv.first, kv.second);
  12183. }
  12184. auto content_type = detail::find_content_type(
  12185. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  12186. auto encoding = detail::EncodingType::None;
  12187. if (static_file_compression_) {
  12188. encoding = static_file_encoding(req, res, content_type, stat.size());
  12189. }
  12190. // The ETag names the representation actually sent, so a client that
  12191. // cached the compressed form revalidates against the compressed ETag
  12192. // and still gets a 304, while one that took identity keeps the plain
  12193. // ETag.
  12194. auto etag = detail::compute_etag(
  12195. stat, encoding == detail::EncodingType::None
  12196. ? std::string()
  12197. : std::string("-") + detail::encoding_name(encoding));
  12198. if (!etag.empty()) { res.set_header("ETag", etag); }
  12199. auto mtime = stat.mtime();
  12200. auto last_modified = detail::file_mtime_to_http_date(mtime);
  12201. if (!last_modified.empty()) {
  12202. res.set_header("Last-Modified", last_modified);
  12203. }
  12204. if (check_if_not_modified(req, res, etag, mtime)) { return true; }
  12205. check_if_range(req, etag, mtime);
  12206. auto mm = std::make_shared<detail::mmap>(path.c_str());
  12207. if (!mm->is_open()) {
  12208. output_error_log(Error::OpenFile, &req);
  12209. return false;
  12210. }
  12211. detail::set_file_content_provider(res, mm, content_type, encoding);
  12212. if (req.method != "HEAD" && file_request_handler_) {
  12213. file_request_handler_(req, res);
  12214. }
  12215. return true;
  12216. } else {
  12217. output_error_log(Error::OpenFile, &req);
  12218. }
  12219. }
  12220. }
  12221. return false;
  12222. }
  12223. inline bool Server::check_if_not_modified(const Request &req, Response &res,
  12224. const std::string &etag,
  12225. time_t mtime) const {
  12226. // Handle conditional GET:
  12227. // 1. If-None-Match takes precedence (RFC 9110 Section 13.1.2)
  12228. // 2. If-Modified-Since is checked only when If-None-Match is absent
  12229. if (req.has_header("If-None-Match")) {
  12230. if (!etag.empty()) {
  12231. auto val =
  12232. detail::get_combined_header_value(req.headers, "If-None-Match");
  12233. // NOTE: We use exact string matching here. This works correctly
  12234. // because our server always generates weak ETags (W/"..."), and
  12235. // clients typically send back the same ETag they received.
  12236. // RFC 9110 Section 8.8.3.2 allows weak comparison for
  12237. // If-None-Match, where W/"x" and "x" would match, but this
  12238. // simplified implementation requires exact matches.
  12239. auto ret = detail::split_find(val.data(), val.data() + val.size(), ',',
  12240. [&](const char *b, const char *e) {
  12241. auto seg_len = static_cast<size_t>(e - b);
  12242. return (seg_len == 1 && *b == '*') ||
  12243. (seg_len == etag.size() &&
  12244. std::equal(b, e, etag.begin()));
  12245. });
  12246. if (ret) {
  12247. res.status = StatusCode::NotModified_304;
  12248. return true;
  12249. }
  12250. }
  12251. } else if (req.has_header("If-Modified-Since")) {
  12252. auto val = req.get_header_value("If-Modified-Since");
  12253. auto t = detail::parse_http_date(val);
  12254. if (t != static_cast<time_t>(-1) && mtime <= t) {
  12255. res.status = StatusCode::NotModified_304;
  12256. return true;
  12257. }
  12258. }
  12259. return false;
  12260. }
  12261. inline bool Server::check_if_range(Request &req, const std::string &etag,
  12262. time_t mtime) const {
  12263. // Handle If-Range for partial content requests (RFC 9110
  12264. // Section 13.1.5). If-Range is only evaluated when Range header is
  12265. // present. If the validator matches, serve partial content; otherwise
  12266. // serve full content.
  12267. if (!req.ranges.empty() && req.has_header("If-Range")) {
  12268. auto val = req.get_header_value("If-Range");
  12269. auto is_valid_range = [&]() {
  12270. if (detail::is_strong_etag(val)) {
  12271. // RFC 9110 Section 13.1.5: If-Range requires strong ETag
  12272. // comparison.
  12273. return (!etag.empty() && val == etag);
  12274. } else if (detail::is_weak_etag(val)) {
  12275. // Weak ETags are not valid for If-Range (RFC 9110 Section 13.1.5)
  12276. return false;
  12277. } else {
  12278. // HTTP-date comparison
  12279. auto t = detail::parse_http_date(val);
  12280. return (t != static_cast<time_t>(-1) && mtime <= t);
  12281. }
  12282. };
  12283. if (!is_valid_range()) {
  12284. // Validator doesn't match: ignore Range and serve full content
  12285. req.ranges.clear();
  12286. return false;
  12287. }
  12288. }
  12289. return true;
  12290. }
  12291. inline socket_t
  12292. Server::create_server_socket(const std::string &host, int port,
  12293. int socket_flags,
  12294. SocketOptions socket_options) const {
  12295. return detail::create_socket(
  12296. host, std::string(), port, address_family_, socket_flags, tcp_nodelay_,
  12297. ipv6_v6only_, std::move(socket_options),
  12298. [&](socket_t sock, struct addrinfo &ai, bool & /*quit*/) -> bool {
  12299. if (::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  12300. output_error_log(Error::BindIPAddress, nullptr);
  12301. return false;
  12302. }
  12303. if (::listen(sock, CPPHTTPLIB_LISTEN_BACKLOG)) {
  12304. output_error_log(Error::Listen, nullptr);
  12305. return false;
  12306. }
  12307. return true;
  12308. });
  12309. }
  12310. inline int Server::bind_internal(const std::string &host, int port,
  12311. int socket_flags) {
  12312. if (is_decommissioned) { return -1; }
  12313. if (!is_valid()) { return -1; }
  12314. svr_sock_ = create_server_socket(host, port, socket_flags, socket_options_);
  12315. if (svr_sock_ == INVALID_SOCKET) { return -1; }
  12316. if (port == 0) {
  12317. struct sockaddr_storage addr;
  12318. socklen_t addr_len = sizeof(addr);
  12319. if (getsockname(svr_sock_, reinterpret_cast<struct sockaddr *>(&addr),
  12320. &addr_len) == -1) {
  12321. output_error_log(Error::GetSockName, nullptr);
  12322. return -1;
  12323. }
  12324. if (addr.ss_family == AF_INET) {
  12325. return ntohs(reinterpret_cast<struct sockaddr_in *>(&addr)->sin_port);
  12326. } else if (addr.ss_family == AF_INET6) {
  12327. return ntohs(reinterpret_cast<struct sockaddr_in6 *>(&addr)->sin6_port);
  12328. } else {
  12329. output_error_log(Error::UnsupportedAddressFamily, nullptr);
  12330. return -1;
  12331. }
  12332. } else {
  12333. return port;
  12334. }
  12335. }
  12336. inline bool Server::listen_internal() {
  12337. // A stop() between bind and listen leaves nothing to accept on. Report
  12338. // failure instead of returning success without ever serving, and mark the
  12339. // server decommissioned the way any failed listen does so that a concurrent
  12340. // wait_until_ready() wakes up instead of spinning forever.
  12341. if (is_decommissioned || svr_sock_ == INVALID_SOCKET) {
  12342. is_decommissioned = true;
  12343. return false;
  12344. }
  12345. auto ret = true;
  12346. is_running_ = true;
  12347. auto se = detail::scope_exit([&]() { is_running_ = false; });
  12348. if (start_handler_) { start_handler_(); }
  12349. {
  12350. std::unique_ptr<TaskQueue> task_queue(new_task_queue());
  12351. while (svr_sock_ != INVALID_SOCKET) {
  12352. #ifndef _WIN32
  12353. if (idle_interval_sec_ > 0 || idle_interval_usec_ > 0) {
  12354. #endif
  12355. auto val = detail::select_read(svr_sock_, idle_interval_sec_,
  12356. idle_interval_usec_);
  12357. if (val == 0) { // Timeout
  12358. task_queue->on_idle();
  12359. continue;
  12360. }
  12361. #ifndef _WIN32
  12362. }
  12363. #endif
  12364. #if defined _WIN32
  12365. // sockets connected via WASAccept inherit flags NO_HANDLE_INHERIT,
  12366. // OVERLAPPED
  12367. socket_t sock = WSAAccept(svr_sock_, nullptr, nullptr, nullptr, 0);
  12368. #elif defined SOCK_CLOEXEC
  12369. socket_t sock = accept4(svr_sock_, nullptr, nullptr, SOCK_CLOEXEC);
  12370. #else
  12371. socket_t sock = accept(svr_sock_, nullptr, nullptr);
  12372. #endif
  12373. if (sock == INVALID_SOCKET) {
  12374. // NOTE: Winsock reports failures through WSAGetLastError() and never
  12375. // touches the CRT errno, so the two have to be asked platform by
  12376. // platform rather than by testing errno here.
  12377. if (detail::is_accept_resource_error()) {
  12378. // The per-process descriptor limit or the network stack's buffer
  12379. // space has been reached. Try to accept new connections after a
  12380. // short sleep.
  12381. std::this_thread::sleep_for(std::chrono::microseconds{1});
  12382. continue;
  12383. } else if (detail::is_accept_transient_error()) {
  12384. continue;
  12385. }
  12386. // Take the descriptor out of svr_sock_ before closing it: a later
  12387. // stop() would otherwise shutdown()/close() a value the OS may have
  12388. // reused, and keep_alive() watches svr_sock_ to notice the server is
  12389. // gone. The exchange also settles the race with a concurrent stop(),
  12390. // since whichever side takes the descriptor closes it exactly once.
  12391. auto listen_sock = svr_sock_.exchange(INVALID_SOCKET);
  12392. if (listen_sock != INVALID_SOCKET) {
  12393. detail::close_socket(listen_sock);
  12394. ret = false;
  12395. output_error_log(Error::Connection, nullptr);
  12396. } else {
  12397. ; // The server socket was closed by user.
  12398. }
  12399. break;
  12400. }
  12401. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO,
  12402. read_timeout_sec_, read_timeout_usec_);
  12403. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_SNDTIMEO,
  12404. write_timeout_sec_, write_timeout_usec_);
  12405. if (tcp_nodelay_) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  12406. if (!task_queue->enqueue(
  12407. [this, sock]() { process_and_close_socket(sock); })) {
  12408. output_error_log(Error::ResourceExhaustion, nullptr);
  12409. detail::shutdown_socket(sock);
  12410. detail::close_socket(sock);
  12411. }
  12412. }
  12413. task_queue->shutdown();
  12414. }
  12415. is_decommissioned = !ret;
  12416. return ret;
  12417. }
  12418. inline bool Server::routing(Request &req, Response &res, Stream &strm,
  12419. bool skip_pre_routing) {
  12420. if (!skip_pre_routing && pre_routing_handler_ &&
  12421. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12422. return true;
  12423. }
  12424. // File handler
  12425. if ((req.method == "GET" || req.method == "HEAD") &&
  12426. handle_file_request(req, res)) {
  12427. return true;
  12428. }
  12429. const auto *custom = find_custom_entry(req.method);
  12430. // The second clause mirrors what expect_content() does unconditionally for
  12431. // POST/PUT/PATCH/DELETE: a content reader route fires even when the request
  12432. // carries no body. Without it a body-less PROPFIND (RFC 4918 treats one as
  12433. // `allprop`) would skip its handler and fall through to 404.
  12434. if (detail::expect_content(req) ||
  12435. (custom && !custom->handlers_for_content_reader.empty())) {
  12436. // Content reader handler
  12437. {
  12438. // Track whether the ContentReader was aborted due to the decompressed
  12439. // payload exceeding `payload_max_length_`.
  12440. // The user handler runs after the lambda returns, so we must restore the
  12441. // 413 status if the handler overwrites it.
  12442. bool content_reader_payload_too_large = false;
  12443. ContentReader reader(
  12444. [&](ContentReceiver receiver) {
  12445. auto result = read_content_with_content_receiver(
  12446. strm, req, res, std::move(receiver), nullptr, nullptr);
  12447. if (!result) {
  12448. output_error_log(Error::Read, &req);
  12449. if (res.status == StatusCode::PayloadTooLarge_413) {
  12450. content_reader_payload_too_large = true;
  12451. }
  12452. }
  12453. return result;
  12454. },
  12455. [&](FormDataHeader header, ContentReceiver receiver) {
  12456. auto result = read_content_with_content_receiver(
  12457. strm, req, res, nullptr, std::move(header),
  12458. std::move(receiver));
  12459. if (!result) {
  12460. output_error_log(Error::Read, &req);
  12461. if (res.status == StatusCode::PayloadTooLarge_413) {
  12462. content_reader_payload_too_large = true;
  12463. }
  12464. }
  12465. return result;
  12466. });
  12467. bool dispatched = false;
  12468. if (req.method == "POST") {
  12469. dispatched = dispatch_request_for_content_reader(
  12470. req, res, std::move(reader), post_handlers_for_content_reader_);
  12471. } else if (req.method == "PUT") {
  12472. dispatched = dispatch_request_for_content_reader(
  12473. req, res, std::move(reader), put_handlers_for_content_reader_);
  12474. } else if (req.method == "PATCH") {
  12475. dispatched = dispatch_request_for_content_reader(
  12476. req, res, std::move(reader), patch_handlers_for_content_reader_);
  12477. } else if (req.method == "DELETE") {
  12478. dispatched = dispatch_request_for_content_reader(
  12479. req, res, std::move(reader), delete_handlers_for_content_reader_);
  12480. } else if (custom) {
  12481. dispatched = dispatch_request_for_content_reader(
  12482. req, res, std::move(reader), custom->handlers_for_content_reader);
  12483. }
  12484. if (dispatched) {
  12485. if (content_reader_payload_too_large) {
  12486. // Enforce the limit: override any status the handler may have set
  12487. // and return false so the error path sends a plain 413 response.
  12488. res.status = StatusCode::PayloadTooLarge_413;
  12489. detail::clear_content(res);
  12490. return false;
  12491. }
  12492. return true;
  12493. }
  12494. }
  12495. // NOTE: `req.body` is not read here. For a regular handler the body is
  12496. // read inside dispatch_request(), after the route has matched and the
  12497. // pre-request handler has approved the request, so that a rejected
  12498. // request (e.g. failed authentication) never forces us to buffer a
  12499. // potentially large body.
  12500. }
  12501. // Regular handler
  12502. if (req.method == "GET" || req.method == "HEAD") {
  12503. return dispatch_request(req, res, get_handlers_, strm);
  12504. } else if (req.method == "POST") {
  12505. return dispatch_request(req, res, post_handlers_, strm);
  12506. } else if (req.method == "PUT") {
  12507. return dispatch_request(req, res, put_handlers_, strm);
  12508. } else if (req.method == "DELETE") {
  12509. return dispatch_request(req, res, delete_handlers_, strm);
  12510. } else if (req.method == "OPTIONS") {
  12511. return dispatch_request(req, res, options_handlers_, strm);
  12512. } else if (req.method == "PATCH") {
  12513. return dispatch_request(req, res, patch_handlers_, strm);
  12514. } else if (custom) {
  12515. return dispatch_request(req, res, custom->handlers, strm);
  12516. }
  12517. res.status = StatusCode::BadRequest_400;
  12518. return false;
  12519. }
  12520. inline bool Server::dispatch_request(Request &req, Response &res,
  12521. const Handlers &handlers, Stream &strm) {
  12522. for (const auto &x : handlers) {
  12523. const auto &matcher = x.first;
  12524. const auto &handler = x.second;
  12525. if (matcher->match(req)) {
  12526. req.matched_route = matcher->pattern();
  12527. // Run the pre-request handler before reading the body so a rejected
  12528. // request (e.g. failed authentication) never forces us to buffer a
  12529. // potentially large body. `req.matched_route` is available here.
  12530. if (pre_request_handler_ &&
  12531. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12532. return true;
  12533. }
  12534. // The route matched and the request was approved; read the body now.
  12535. if (detail::expect_content(req) && !read_content(strm, req, res)) {
  12536. output_error_log(Error::Read, &req);
  12537. return false;
  12538. }
  12539. handler(req, res);
  12540. return true;
  12541. }
  12542. }
  12543. return false;
  12544. }
  12545. // Decides the content coding for a response served straight from a file. Both
  12546. // the ETag, which has to name the representation actually sent, and
  12547. // `apply_static_file_compression()` go through this, so the two cannot drift
  12548. // apart.
  12549. inline detail::EncodingType
  12550. Server::static_file_encoding(const Request &req, const Response &res,
  12551. const std::string &content_type,
  12552. size_t length) const {
  12553. if (!static_file_compression_) { return detail::EncodingType::None; }
  12554. // Nothing to compress, and an empty file already answers with
  12555. // `Content-Length: 0`. Checked on its own so that a zero floor still cannot
  12556. // turn an empty body into a 20-byte gzip stream.
  12557. if (length == 0) { return detail::EncodingType::None; }
  12558. // A file that already fits in a single packet gains nothing from being made
  12559. // smaller, since it still travels in that one segment, and a file of a few
  12560. // bytes comes out larger than it went in.
  12561. if (length < static_file_compression_min_length_) {
  12562. return detail::EncodingType::None;
  12563. }
  12564. // RFC 9110 applies Range to the representation after content coding, so a
  12565. // compressed 206 would mean compressing the whole file and then slicing it.
  12566. // Serve ranges from the identity representation instead.
  12567. if (!req.ranges.empty()) { return detail::EncodingType::None; }
  12568. if (static_file_compression_max_length_ > 0 &&
  12569. length > static_file_compression_max_length_) {
  12570. return detail::EncodingType::None;
  12571. }
  12572. return detail::encoding_type(req, res, content_type);
  12573. }
  12574. // Compresses a file-backed content provider into `res.body`. Returns false when
  12575. // the response is left untouched.
  12576. inline bool Server::apply_static_file_compression(const Request &req,
  12577. Response &res) const {
  12578. auto type = res.content_coding_;
  12579. if (type == detail::EncodingType::None || !res.content_provider_) {
  12580. return false;
  12581. }
  12582. auto compressor = detail::make_compressor(type);
  12583. if (!compressor) { return false; }
  12584. output_pre_compression_log(req, res);
  12585. std::string compressed;
  12586. if (!detail::compress_content_provider(res.content_provider_,
  12587. res.content_length_, *compressor,
  12588. compressed)) {
  12589. return false;
  12590. }
  12591. res.body.swap(compressed);
  12592. // The provider was consumed in full, so its releaser hears about a success.
  12593. res.content_provider_success_ = true;
  12594. detail::clear_content_provider(res);
  12595. res.set_header("Content-Encoding", detail::encoding_name(type));
  12596. res.set_header("Vary", "Accept-Encoding");
  12597. return true;
  12598. }
  12599. inline void Server::apply_ranges(const Request &req, Response &res,
  12600. std::string &content_type,
  12601. std::string &boundary) const {
  12602. // A known-length content provider leaves `res.body` empty, so the compressor
  12603. // at the end of this function never runs for one (issue #2545). A file-backed
  12604. // provider is fully readable right here, so compress it and answer with an
  12605. // ordinary body: `Content-Length` and HEAD keep working, and the response
  12606. // takes the same path as `set_content()` from here on. Range requests never
  12607. // get a content coding, so `Content-Range` still names identity bytes and
  12608. // none of the range handling below applies.
  12609. if (apply_static_file_compression(req, res)) { return; }
  12610. if (req.ranges.size() > 1 && res.status == StatusCode::PartialContent_206) {
  12611. auto it = res.headers.find("Content-Type");
  12612. if (it != res.headers.end()) {
  12613. content_type = it->second;
  12614. res.headers.erase(it);
  12615. }
  12616. boundary = detail::make_multipart_data_boundary();
  12617. res.set_header("Content-Type",
  12618. "multipart/byteranges; boundary=" + boundary);
  12619. }
  12620. auto type = detail::encoding_type(req, res);
  12621. if (res.body.empty()) {
  12622. if (res.content_length_ > 0 && req.ranges.size() == 1 &&
  12623. res.status == StatusCode::PartialContent_206) {
  12624. auto offset_and_length = detail::get_range_offset_and_length(
  12625. req.ranges[0], res.content_length_);
  12626. auto content_range = detail::make_content_range_header_field(
  12627. offset_and_length, res.content_length_);
  12628. res.set_header("Content-Range", content_range);
  12629. } else if (res.is_chunked_content_provider_) {
  12630. res.content_coding_ = type;
  12631. if (type != detail::EncodingType::None) {
  12632. res.set_header("Content-Encoding", detail::encoding_name(type));
  12633. res.set_header("Vary", "Accept-Encoding");
  12634. }
  12635. }
  12636. } else {
  12637. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12638. ;
  12639. } else if (req.ranges.size() == 1) {
  12640. auto offset_and_length =
  12641. detail::get_range_offset_and_length(req.ranges[0], res.body.size());
  12642. auto offset = offset_and_length.first;
  12643. auto length = offset_and_length.second;
  12644. auto content_range = detail::make_content_range_header_field(
  12645. offset_and_length, res.body.size());
  12646. res.set_header("Content-Range", content_range);
  12647. assert(offset + length <= res.body.size());
  12648. res.body = res.body.substr(offset, length);
  12649. } else {
  12650. std::string data;
  12651. detail::make_multipart_ranges_data(req, res, boundary, content_type,
  12652. res.body.size(), data);
  12653. res.body.swap(data);
  12654. }
  12655. if (type != detail::EncodingType::None) {
  12656. output_pre_compression_log(req, res);
  12657. if (auto compressor = detail::make_compressor(type)) {
  12658. std::string compressed;
  12659. if (compressor->compress(res.body.data(), res.body.size(), true,
  12660. [&](const char *data, size_t data_len) {
  12661. compressed.append(data, data_len);
  12662. return true;
  12663. })) {
  12664. res.body.swap(compressed);
  12665. res.set_header("Content-Encoding", detail::encoding_name(type));
  12666. res.set_header("Vary", "Accept-Encoding");
  12667. }
  12668. }
  12669. }
  12670. res.content_length_ = res.body.size();
  12671. }
  12672. }
  12673. inline bool Server::dispatch_request_for_content_reader(
  12674. Request &req, Response &res, ContentReader content_reader,
  12675. const HandlersForContentReader &handlers) const {
  12676. for (const auto &x : handlers) {
  12677. const auto &matcher = x.first;
  12678. const auto &handler = x.second;
  12679. if (matcher->match(req)) {
  12680. req.matched_route = matcher->pattern();
  12681. if (!pre_request_handler_ ||
  12682. pre_request_handler_(req, res) != HandlerResponse::Handled) {
  12683. handler(req, res, content_reader);
  12684. }
  12685. return true;
  12686. }
  12687. }
  12688. return false;
  12689. }
  12690. inline std::string
  12691. get_client_ip(const std::string &x_forwarded_for,
  12692. const std::vector<std::string> &trusted_proxies) {
  12693. // X-Forwarded-For is a comma-separated list per RFC 7239
  12694. std::vector<std::string> ip_list;
  12695. detail::split(x_forwarded_for.data(),
  12696. x_forwarded_for.data() + x_forwarded_for.size(), ',',
  12697. [&](const char *b, const char *e) {
  12698. auto r = detail::trim(b, e, 0, static_cast<size_t>(e - b));
  12699. ip_list.emplace_back(std::string(b + r.first, b + r.second));
  12700. });
  12701. // A malformed X-Forwarded-For (empty, comma-only, whitespace-only) yields
  12702. // no segments. Signal "no client IP derived" with an empty string so the
  12703. // caller can fall back to the connection-level remote address.
  12704. if (ip_list.empty()) { return std::string(); }
  12705. // Each hop appends the address it received the request from, so the rightmost
  12706. // entries are the ones written by our own infrastructure while the leftmost
  12707. // are whatever the original client chose to send. Walk from the right and
  12708. // skip trusted proxies; the first address that is not a trusted proxy is the
  12709. // furthest point still attributable to a real hop, i.e. the client. Scanning
  12710. // from the left instead lets a client forge an arbitrary address by following
  12711. // it with a trusted proxy's address, which the left-to-right scan then
  12712. // returned as the client.
  12713. for (size_t i = ip_list.size(); i-- > 0;) {
  12714. const auto &ip = ip_list[i];
  12715. auto is_trusted_proxy =
  12716. std::any_of(trusted_proxies.begin(), trusted_proxies.end(),
  12717. [&](const std::string &proxy) { return ip == proxy; });
  12718. if (!is_trusted_proxy) { return ip; }
  12719. }
  12720. // Every hop was a trusted proxy; fall back to the first entry.
  12721. return ip_list.front();
  12722. }
  12723. inline bool
  12724. Server::process_request(Stream &strm, const std::string &remote_addr,
  12725. int remote_port, const std::string &local_addr,
  12726. int local_port, bool close_connection,
  12727. bool &connection_closed,
  12728. const std::function<void(Request &)> &setup_request,
  12729. bool *websocket_upgraded) {
  12730. std::array<char, 2048> buf{};
  12731. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12732. // The read timeout bounds the request line and headers as a whole, so a
  12733. // client sending them a byte at a time cannot hold the worker any longer.
  12734. strm.set_max_timeout(read_timeout_sec_ * 1000 + read_timeout_usec_ / 1000);
  12735. // Connection has been closed on client
  12736. if (!line_reader.getline()) { return false; }
  12737. // RFC 9112 2.2: ignore an empty line received before the request-line. Some
  12738. // clients send an extra CRLF after a request body, which would otherwise be
  12739. // parsed as the next request on a persistent connection.
  12740. if (strcmp(line_reader.ptr(), "\r\n") == 0 && !line_reader.getline()) {
  12741. return false;
  12742. }
  12743. Request req;
  12744. req.start_time_ = std::chrono::steady_clock::now();
  12745. req.remote_addr = remote_addr;
  12746. req.remote_port = remote_port;
  12747. req.local_addr = local_addr;
  12748. req.local_port = local_port;
  12749. Response res;
  12750. res.version = "HTTP/1.1";
  12751. res.headers = default_headers_;
  12752. // RFC 9112 §9.6: a server that sends the "close" connection option must
  12753. // close the connection after that response, whichever path wrote it (an
  12754. // error status, a handler, or a rejected request). Reading on would also
  12755. // parse whatever the client sent next on a connection it considers done.
  12756. auto honor_connection_close = detail::scope_exit([&] {
  12757. if (detail::has_header_token(res.headers, "Connection", "close")) {
  12758. connection_closed = true;
  12759. }
  12760. });
  12761. // Request line and headers. A rejected message leaves the rest of it (and
  12762. // any body) unread, so the connection cannot be reused: the leftover bytes
  12763. // would be parsed as the next request.
  12764. if (!parse_request_line(line_reader.ptr(), req)) {
  12765. connection_closed = true;
  12766. res.status = StatusCode::BadRequest_400;
  12767. output_error_log(Error::InvalidRequestLine, &req);
  12768. return write_response(strm, close_connection, req, res);
  12769. }
  12770. // Request headers
  12771. if (!detail::read_headers(strm, req.headers)) {
  12772. connection_closed = true;
  12773. res.status = StatusCode::BadRequest_400;
  12774. output_error_log(Error::InvalidHeaders, &req);
  12775. return write_response(strm, close_connection, req, res);
  12776. }
  12777. strm.set_max_timeout(0);
  12778. // RFC 9112 §6.3: Reject requests whose framing is invalid or ambiguous,
  12779. // which would otherwise let an intermediary and this parser disagree on
  12780. // where the body ends and enable request smuggling. Three cases: a
  12781. // Content-Length that is not a valid decimal length (e.g. "42, 42", "+42"
  12782. // or empty), which would otherwise be read as "no body"; a non-zero
  12783. // Content-Length alongside any Transfer-Encoding (Content-Length: 0 is
  12784. // tolerated for compatibility with existing clients); and a
  12785. // Transfer-Encoding whose final coding is not chunked, which leaves the body
  12786. // length undeterminable. None of them may fall through to the "no body"
  12787. // path, or the body bytes are parsed as the next request on a persistent
  12788. // connection.
  12789. auto is_invalid_content_length = false;
  12790. detail::get_header_value_u64(req.headers, "Content-Length", 0, 0,
  12791. is_invalid_content_length);
  12792. if (is_invalid_content_length ||
  12793. detail::has_conflicting_content_length(req.headers) ||
  12794. (req.has_header("Transfer-Encoding") &&
  12795. !detail::is_chunked_transfer_encoding(req.headers))) {
  12796. connection_closed = true;
  12797. res.status = StatusCode::BadRequest_400;
  12798. return write_response(strm, close_connection, req, res);
  12799. }
  12800. // RFC 9112 §6.1: a Transfer-Encoding alongside a Content-Length, or in an
  12801. // HTTP/1.0 request, is honoured, but the connection closes after the
  12802. // response.
  12803. if (detail::has_faulty_transfer_encoding(req)) { connection_closed = true; }
  12804. // RFC 9112 §3.2: Reject more than one Host field line, an invalid Host
  12805. // value, or none in HTTP/1.1, so that every recipient of the request sees
  12806. // the same authority.
  12807. auto host_count = req.get_header_value_count("Host");
  12808. if (host_count > 1 || (host_count == 0 && req.version == "HTTP/1.1") ||
  12809. !detail::fields::is_host(req.get_header_value("Host"))) {
  12810. connection_closed = true;
  12811. res.status = StatusCode::BadRequest_400;
  12812. output_error_log(Error::InvalidHeaders, &req);
  12813. return write_response(strm, close_connection, req, res);
  12814. }
  12815. // Check if the request URI doesn't exceed the limit
  12816. if (req.target.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  12817. connection_closed = true;
  12818. res.status = StatusCode::UriTooLong_414;
  12819. output_error_log(Error::ExceedUriMaxLength, &req);
  12820. return write_response(strm, close_connection, req, res);
  12821. }
  12822. if (detail::has_header_token(req.headers, "Connection", "close")) {
  12823. connection_closed = true;
  12824. }
  12825. if (req.version == "HTTP/1.0" &&
  12826. !detail::has_header_token(req.headers, "Connection", "keep-alive")) {
  12827. connection_closed = true;
  12828. }
  12829. // Only honor X-Forwarded-For if the peer on the actual TCP connection is
  12830. // itself a trusted proxy. Otherwise any direct client could spoof
  12831. // remote_addr simply by sending an arbitrary X-Forwarded-For header.
  12832. auto is_trusted_peer = std::any_of(
  12833. trusted_proxies_.begin(), trusted_proxies_.end(),
  12834. [&](const std::string &proxy) { return proxy == remote_addr; });
  12835. if (is_trusted_peer && req.has_header("X-Forwarded-For")) {
  12836. // Some proxies append the address they observed as a separate
  12837. // X-Forwarded-For field line instead of extending the one the client sent
  12838. // (e.g. HAProxy's "option forwardfor"), so the whole combined value has to
  12839. // be scanned. Reading only the first occurrence would hand back the
  12840. // client-supplied, and therefore forgeable, value.
  12841. auto x_forwarded_for =
  12842. detail::get_combined_header_value(req.headers, "X-Forwarded-For");
  12843. auto derived = get_client_ip(x_forwarded_for, trusted_proxies_);
  12844. req.remote_addr = derived.empty() ? remote_addr : derived;
  12845. } else {
  12846. req.remote_addr = remote_addr;
  12847. }
  12848. req.remote_port = remote_port;
  12849. req.local_addr = local_addr;
  12850. req.local_port = local_port;
  12851. if (req.has_header("Accept")) {
  12852. auto accept_header =
  12853. detail::get_combined_header_value(req.headers, "Accept");
  12854. if (!detail::parse_accept_header(accept_header, req.accept_content_types)) {
  12855. connection_closed = true;
  12856. res.status = StatusCode::BadRequest_400;
  12857. output_error_log(Error::HTTPParsing, &req);
  12858. return write_response(strm, close_connection, req, res);
  12859. }
  12860. }
  12861. if (req.has_header("Range")) {
  12862. const auto &range_header_value = req.get_header_value("Range");
  12863. if (!detail::parse_range_header(range_header_value, req.ranges)) {
  12864. connection_closed = true;
  12865. res.status = StatusCode::RangeNotSatisfiable_416;
  12866. output_error_log(Error::InvalidRangeHeader, &req);
  12867. return write_response(strm, close_connection, req, res);
  12868. }
  12869. }
  12870. if (setup_request) { setup_request(req); }
  12871. // RFC 9110 10.1.1: Expect is a comma-separated list whose value is
  12872. // case-insensitive, and a 100-continue expectation in an HTTP/1.0 request
  12873. // must be ignored. An expectation we do not recognize is left alone; the
  12874. // 417 the section allows for one is a MAY, not a requirement.
  12875. //
  12876. // `100 Continue` itself is deferred until the body is actually read (see
  12877. // read_content_core), so a request rejected by a later handler never
  12878. // invites the client to send a body nobody will read.
  12879. if (req.version != "HTTP/1.0" &&
  12880. detail::has_header_token(req.headers, "Expect", "100-continue")) {
  12881. int status = StatusCode::Continue_100;
  12882. if (expect_100_continue_handler_) {
  12883. status = expect_100_continue_handler_(req, res);
  12884. }
  12885. if (status == StatusCode::Continue_100) {
  12886. req.expect_100_continue_pending_ = true;
  12887. } else {
  12888. if (res.status == -1) { res.status = status; }
  12889. connection_closed = true;
  12890. return write_response(strm, true, req, res);
  12891. }
  12892. }
  12893. // Setup `is_connection_closed` method
  12894. auto sock = strm.socket();
  12895. req.is_connection_closed = [sock]() {
  12896. return !detail::is_socket_alive(sock);
  12897. };
  12898. // WebSocket upgrade
  12899. // Run pre_routing_handler_ and pre_request_handler_ before upgrading so
  12900. // that authentication and other middleware can reject the request with an
  12901. // HTTP response (e.g., 401) before the protocol switches.
  12902. // The response says so when this connection closes after it.
  12903. auto close_after_response = close_connection || connection_closed;
  12904. // An upgrade request has been through pre-routing before it reaches routing()
  12905. auto is_upgrade = detail::is_websocket_upgrade(req);
  12906. if (is_upgrade) {
  12907. // A response given here leaves the body unread, and it would be parsed as
  12908. // the next request.
  12909. auto close_if_answered =
  12910. close_after_response || detail::has_framed_body(req);
  12911. if (pre_routing_handler_ &&
  12912. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12913. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12914. return write_response_with_content(strm, close_if_answered, req, res);
  12915. }
  12916. // Find matching WebSocket handler
  12917. for (const auto &entry : websocket_handlers_) {
  12918. if (entry.matcher->match(req)) {
  12919. req.matched_route = entry.matcher->pattern();
  12920. if (pre_request_handler_ &&
  12921. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12922. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12923. return write_response_with_content(strm, close_if_answered, req, res);
  12924. }
  12925. // Compute accept key
  12926. auto client_key = req.get_header_value("Sec-WebSocket-Key");
  12927. auto accept_key = detail::websocket_accept_key(client_key);
  12928. // Negotiate subprotocol
  12929. std::string selected_subprotocol;
  12930. if (entry.sub_protocol_selector) {
  12931. auto protocol_header = detail::get_combined_header_value(
  12932. req.headers, "Sec-WebSocket-Protocol");
  12933. if (!protocol_header.empty()) {
  12934. std::vector<std::string> protocols;
  12935. detail::split(protocol_header.data(),
  12936. protocol_header.data() + protocol_header.size(), ',',
  12937. [&](const char *b, const char *e) {
  12938. protocols.emplace_back(b, e);
  12939. });
  12940. selected_subprotocol = entry.sub_protocol_selector(protocols);
  12941. // Ignore a selection the client did not offer (RFC 6455 4.2.2)
  12942. if (std::find(protocols.begin(), protocols.end(),
  12943. selected_subprotocol) == protocols.end()) {
  12944. selected_subprotocol.clear();
  12945. }
  12946. }
  12947. }
  12948. // Send 101 Switching Protocols
  12949. std::string handshake_response = "HTTP/1.1 101 Switching Protocols\r\n"
  12950. "Upgrade: websocket\r\n"
  12951. "Connection: Upgrade\r\n"
  12952. "Sec-WebSocket-Accept: " +
  12953. accept_key + "\r\n";
  12954. if (!selected_subprotocol.empty()) {
  12955. if (!detail::fields::is_field_value(selected_subprotocol)) {
  12956. return false;
  12957. }
  12958. handshake_response +=
  12959. "Sec-WebSocket-Protocol: " + selected_subprotocol + "\r\n";
  12960. }
  12961. handshake_response += "\r\n";
  12962. if (strm.write(handshake_response.data(), handshake_response.size()) <
  12963. 0) {
  12964. return false;
  12965. }
  12966. connection_closed = true;
  12967. if (websocket_upgraded) { *websocket_upgraded = true; }
  12968. {
  12969. #ifdef CPPHTTPLIB_SSL_ENABLED
  12970. if (req.ssl) {
  12971. // wss: the heartbeat ping thread and the read path enter the same
  12972. // TLS session from different threads. Hand the WebSocket a stream
  12973. // that serializes every TLS call, so the shared SSLSocketStream on
  12974. // the plain HTTP/HTTPS paths stays untouched.
  12975. auto ws_strm =
  12976. std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  12977. strm.socket(), const_cast<tls::session_t>(req.ssl),
  12978. CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0,
  12979. write_timeout_sec_, write_timeout_usec_));
  12980. ws::WebSocket ws(std::move(ws_strm), req, true,
  12981. websocket_ping_interval_sec_,
  12982. websocket_max_missed_pongs_);
  12983. entry.handler(req, ws);
  12984. return true;
  12985. }
  12986. #endif
  12987. // Use WebSocket-specific read timeout instead of HTTP timeout
  12988. strm.set_read_timeout(CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND,
  12989. 0);
  12990. ws::WebSocket ws(strm, req, true, websocket_ping_interval_sec_,
  12991. websocket_max_missed_pongs_);
  12992. entry.handler(req, ws);
  12993. }
  12994. return true;
  12995. }
  12996. }
  12997. // No WebSocket route: route it as a plain HTTP request
  12998. }
  12999. // Routing
  13000. auto routed = false;
  13001. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  13002. routed = routing(req, res, strm, is_upgrade);
  13003. #else
  13004. try {
  13005. routed = routing(req, res, strm, is_upgrade);
  13006. } catch (std::exception &) {
  13007. if (exception_handler_) {
  13008. auto ep = std::current_exception();
  13009. exception_handler_(req, res, ep);
  13010. routed = true;
  13011. } else {
  13012. res.status = StatusCode::InternalServerError_500;
  13013. }
  13014. } catch (...) {
  13015. if (exception_handler_) {
  13016. auto ep = std::current_exception();
  13017. exception_handler_(req, res, ep);
  13018. routed = true;
  13019. } else {
  13020. res.status = StatusCode::InternalServerError_500;
  13021. }
  13022. }
  13023. #endif
  13024. auto ret = false;
  13025. if (routed) {
  13026. if (res.status == -1) {
  13027. res.status = req.ranges.empty() ? StatusCode::OK_200
  13028. : StatusCode::PartialContent_206;
  13029. }
  13030. // Before the Range checks below, so they see the body's own length.
  13031. detail::prefer_assigned_body(res);
  13032. // Serve file content by using a content provider
  13033. auto file_open_error = false;
  13034. if (!res.file_content_path_.empty()) {
  13035. const auto &path = res.file_content_path_;
  13036. auto mm = std::make_shared<detail::mmap>(path.c_str());
  13037. if (!mm->is_open()) {
  13038. res.status = StatusCode::NotFound_404;
  13039. output_error_log(Error::OpenFile, &req);
  13040. file_open_error = true;
  13041. } else {
  13042. auto content_type = res.file_content_content_type_;
  13043. if (content_type.empty()) {
  13044. // One the handler set after set_file_content()
  13045. content_type = res.get_header_value("Content-Type");
  13046. }
  13047. if (content_type.empty()) {
  13048. content_type = detail::find_content_type(
  13049. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  13050. }
  13051. detail::set_file_content_provider(
  13052. res, mm, content_type,
  13053. static_file_encoding(req, res, content_type, mm->size()));
  13054. }
  13055. }
  13056. if (file_open_error) {
  13057. ret = write_response(strm, close_after_response, req, res);
  13058. } else if (detail::range_error(req, res)) {
  13059. detail::clear_content(res);
  13060. res.status = StatusCode::RangeNotSatisfiable_416;
  13061. ret = write_response(strm, close_after_response, req, res);
  13062. } else {
  13063. ret = write_response_with_content(strm, close_after_response, req, res);
  13064. }
  13065. } else {
  13066. if (res.status == -1) { res.status = StatusCode::NotFound_404; }
  13067. ret = write_response(strm, close_after_response, req, res);
  13068. }
  13069. // Drain any unconsumed framed body to prevent request smuggling on
  13070. // keep-alive. Without framing there is no body to drain — reading would
  13071. // consume the next request (issue #2450). If the response has committed the
  13072. // connection to close, there is no next request to protect. A body read in
  13073. // part cannot be drained from where it stopped, so the connection closes.
  13074. if (!req.body_consumed_ && detail::has_framed_body(req) &&
  13075. !detail::has_header_token(res.headers, "Connection", "close")) {
  13076. int dummy_status;
  13077. if (req.body_read_started_ ||
  13078. !detail::read_content(
  13079. strm, req, payload_max_length_, dummy_status, nullptr,
  13080. [](const char *, size_t, size_t, size_t) { return true; }, false)) {
  13081. connection_closed = true;
  13082. }
  13083. }
  13084. return ret;
  13085. }
  13086. inline bool Server::is_valid() const { return !has_invalid_registration_; }
  13087. inline bool Server::process_and_close_socket(socket_t sock) {
  13088. std::string remote_addr;
  13089. int remote_port = 0;
  13090. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  13091. std::string local_addr;
  13092. int local_port = 0;
  13093. detail::get_local_ip_and_port(sock, local_addr, local_port);
  13094. bool websocket_upgraded = false;
  13095. auto ret = serve_guarded([&]() {
  13096. return detail::process_server_socket(
  13097. svr_sock_, sock, keep_alive_max_count_, keep_alive_timeout_sec_,
  13098. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13099. write_timeout_usec_,
  13100. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  13101. return process_request(strm, remote_addr, remote_port, local_addr,
  13102. local_port, close_connection,
  13103. connection_closed, nullptr,
  13104. &websocket_upgraded);
  13105. });
  13106. });
  13107. detail::drain_and_close_socket(sock);
  13108. return ret;
  13109. }
  13110. inline void Server::output_log(const Request &req, const Response &res) const {
  13111. if (logger_) {
  13112. std::lock_guard<std::mutex> guard(logger_mutex_);
  13113. logger_(req, res);
  13114. }
  13115. }
  13116. inline void Server::output_pre_compression_log(const Request &req,
  13117. const Response &res) const {
  13118. if (pre_compression_logger_) {
  13119. std::lock_guard<std::mutex> guard(logger_mutex_);
  13120. pre_compression_logger_(req, res);
  13121. }
  13122. }
  13123. inline void Server::output_error_log(const Error &err,
  13124. const Request *req) const {
  13125. if (error_logger_) {
  13126. std::lock_guard<std::mutex> guard(logger_mutex_);
  13127. error_logger_(err, req);
  13128. }
  13129. }
  13130. /*
  13131. * Group 5: ClientImpl and Client (Universal) implementation
  13132. */
  13133. // HTTP client implementation
  13134. inline ClientImpl::ClientImpl(const std::string &host)
  13135. : ClientImpl(host, 80, std::string(), std::string()) {}
  13136. inline ClientImpl::ClientImpl(const std::string &host, int port)
  13137. : ClientImpl(host, port, std::string(), std::string()) {}
  13138. inline ClientImpl::ClientImpl(const std::string &host, int port,
  13139. const std::string &client_cert_path,
  13140. const std::string &client_key_path)
  13141. : host_(detail::escape_abstract_namespace_unix_domain(host)), port_(port),
  13142. client_cert_path_(client_cert_path), client_key_path_(client_key_path) {}
  13143. inline ClientImpl::~ClientImpl() {
  13144. // Wait until all the requests in flight are handled.
  13145. size_t retry_count = 10;
  13146. while (retry_count-- > 0) {
  13147. {
  13148. std::lock_guard<std::mutex> guard(socket_mutex_);
  13149. if (socket_requests_in_flight_ == 0) { break; }
  13150. }
  13151. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  13152. }
  13153. std::lock_guard<std::mutex> guard(socket_mutex_);
  13154. shutdown_socket(socket_);
  13155. close_socket(socket_);
  13156. }
  13157. inline bool ClientImpl::is_valid() const { return true; }
  13158. inline bool
  13159. ClientImpl::is_proxy_enabled_for_host(const std::string &host) const {
  13160. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  13161. if (no_proxy_entries_.empty()) { return true; }
  13162. // host_ is const so its normalized form is invariant; cache it. The
  13163. // cross-host path (setup_redirect_client passing next_host) re-normalizes.
  13164. if (host == host_) {
  13165. if (!host_normalized_valid_) {
  13166. host_normalized_ = detail::normalize_target(host_);
  13167. host_normalized_valid_ = true;
  13168. }
  13169. return !detail::host_matches_no_proxy(host_normalized_, no_proxy_entries_);
  13170. }
  13171. auto target = detail::normalize_target(host);
  13172. return !detail::host_matches_no_proxy(target, no_proxy_entries_);
  13173. }
  13174. inline socket_t ClientImpl::create_client_socket(Error &error) const {
  13175. if (is_proxy_enabled_for_host(host_)) {
  13176. return detail::create_client_socket(
  13177. proxy_host_, std::string(), proxy_port_, address_family_, tcp_nodelay_,
  13178. ipv6_v6only_, socket_options_, connection_timeout_sec_,
  13179. connection_timeout_usec_, read_timeout_sec_, read_timeout_usec_,
  13180. write_timeout_sec_, write_timeout_usec_, interface_, error);
  13181. }
  13182. // Check is custom IP or hostname specified for host_
  13183. std::string connect_host;
  13184. std::string ip;
  13185. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  13186. return detail::create_client_socket(
  13187. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  13188. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  13189. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13190. write_timeout_usec_, interface_, error);
  13191. }
  13192. inline bool ClientImpl::create_and_connect_socket(Socket &socket,
  13193. Error &error) {
  13194. auto sock = create_client_socket(error);
  13195. if (sock == INVALID_SOCKET) { return false; }
  13196. socket.sock = sock;
  13197. return true;
  13198. }
  13199. inline bool ClientImpl::ensure_socket_connection(Socket &socket, Error &error) {
  13200. return create_and_connect_socket(socket, error);
  13201. }
  13202. inline bool ClientImpl::setup_proxy_connection(
  13203. Socket & /*socket*/,
  13204. std::chrono::time_point<std::chrono::steady_clock> /*start_time*/,
  13205. Response & /*res*/, bool & /*success*/, Error & /*error*/) {
  13206. return true;
  13207. }
  13208. inline void ClientImpl::shutdown_ssl(Socket & /*socket*/,
  13209. bool /*shutdown_gracefully*/) {
  13210. // If there are any requests in flight from threads other than us, then it's
  13211. // a thread-unsafe race because individual ssl* objects are not thread-safe.
  13212. assert(socket_requests_in_flight_ == 0 ||
  13213. socket_requests_are_from_thread_ == std::this_thread::get_id());
  13214. }
  13215. inline void ClientImpl::shutdown_socket(Socket &socket) const {
  13216. if (socket.sock == INVALID_SOCKET) { return; }
  13217. detail::shutdown_socket(socket.sock);
  13218. }
  13219. inline void ClientImpl::close_socket(Socket &socket) {
  13220. // If there are requests in flight in another thread, usually closing
  13221. // the socket will be fine and they will simply receive an error when
  13222. // using the closed socket, but it is still a bug since rarely the OS
  13223. // may reassign the socket id to be used for a new socket, and then
  13224. // suddenly they will be operating on a live socket that is different
  13225. // than the one they intended!
  13226. assert(socket_requests_in_flight_ == 0 ||
  13227. socket_requests_are_from_thread_ == std::this_thread::get_id());
  13228. // It is also a bug if this happens while SSL is still active
  13229. #ifdef CPPHTTPLIB_SSL_ENABLED
  13230. assert(socket.ssl == nullptr);
  13231. #endif
  13232. if (socket.sock == INVALID_SOCKET) { return; }
  13233. detail::close_socket(socket.sock);
  13234. socket.sock = INVALID_SOCKET;
  13235. }
  13236. inline void ClientImpl::disconnect(bool gracefully) {
  13237. shutdown_ssl(socket_, gracefully);
  13238. shutdown_socket(socket_);
  13239. close_socket(socket_);
  13240. }
  13241. inline bool ClientImpl::read_response_line(Stream &strm, const Request &req,
  13242. Response &res,
  13243. bool skip_100_continue) const {
  13244. std::array<char, 2048> buf{};
  13245. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  13246. if (!line_reader.getline()) { return false; }
  13247. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  13248. res.reason)) {
  13249. return req.method == "CONNECT";
  13250. }
  13251. // Skip interim (1xx) responses along with their header fields, except a 100
  13252. // Continue the caller handles itself for Expect: 100-continue. 101 ends
  13253. // HTTP on the connection, so it is final. A server sending them without end
  13254. // would hold the client, so there may be only so many.
  13255. size_t interim_count = 0;
  13256. while (100 <= res.status && res.status < 200 &&
  13257. res.status != StatusCode::SwitchingProtocol_101 &&
  13258. (skip_100_continue || res.status != StatusCode::Continue_100)) {
  13259. if (++interim_count > CPPHTTPLIB_INTERIM_RESPONSE_MAX_COUNT) {
  13260. return false;
  13261. }
  13262. Headers interim_headers;
  13263. if (!detail::read_headers(strm, interim_headers)) { return false; }
  13264. if (!line_reader.getline()) { return false; } // next response line
  13265. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  13266. res.reason)) {
  13267. return false;
  13268. }
  13269. }
  13270. return true;
  13271. }
  13272. inline bool ClientImpl::send(Request &req, Response &res, Error &error) {
  13273. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  13274. // A same-origin redirect and a digest retry send through here again. Only
  13275. // the call the caller made reports a failure, once, with its request.
  13276. auto outermost = send_depth_++ == 0;
  13277. auto se = detail::scope_exit([&] { send_depth_--; });
  13278. if (outermost) { error = Error::Success; }
  13279. auto ret = send_(req, res, error);
  13280. if (error == Error::SSLPeerCouldBeClosed_) {
  13281. assert(!ret);
  13282. ret = send_(req, res, error);
  13283. // If still failing with SSLPeerCouldBeClosed_, convert to Read error
  13284. if (error == Error::SSLPeerCouldBeClosed_) { error = Error::Read; }
  13285. }
  13286. // Also an answer that carries an error, such as a proxy's 407
  13287. if (outermost && error != Error::Success) { output_error_log(error, &req); }
  13288. return ret;
  13289. }
  13290. inline bool ClientImpl::send_(Request &req, Response &res, Error &error) {
  13291. #ifdef CPPHTTPLIB_SSL_ENABLED
  13292. // Don't let an earlier attempt's TLS error show up in this one's Result. A
  13293. // client that failed to set up its TLS context keeps reporting why.
  13294. if (is_valid()) {
  13295. last_ssl_error_ = 0;
  13296. last_backend_error_ = 0;
  13297. }
  13298. #endif
  13299. {
  13300. std::lock_guard<std::mutex> guard(socket_mutex_);
  13301. // Set this to false immediately - if it ever gets set to true by the end
  13302. // of the request, we know another thread instructed us to close the
  13303. // socket.
  13304. socket_should_be_closed_when_request_is_done_ = false;
  13305. auto is_alive = false;
  13306. if (socket_.is_open()) {
  13307. is_alive = detail::is_socket_alive(socket_.sock);
  13308. #ifdef CPPHTTPLIB_SSL_ENABLED
  13309. if (is_alive && is_ssl()) {
  13310. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13311. is_alive = false;
  13312. }
  13313. }
  13314. #endif
  13315. if (!is_alive) {
  13316. // Peer seems gone — non-graceful shutdown to avoid SIGPIPE.
  13317. disconnect(/*gracefully=*/false);
  13318. }
  13319. }
  13320. if (!is_alive) {
  13321. if (!ensure_socket_connection(socket_, error)) { return false; }
  13322. {
  13323. auto success = true;
  13324. if (!setup_proxy_connection(socket_, req.start_time_, res, success,
  13325. error)) {
  13326. return success;
  13327. }
  13328. }
  13329. }
  13330. // Mark the current socket as being in use so that it cannot be closed by
  13331. // anyone else while this request is ongoing, even though we will be
  13332. // releasing the mutex.
  13333. if (socket_requests_in_flight_ > 1) {
  13334. assert(socket_requests_are_from_thread_ == std::this_thread::get_id());
  13335. }
  13336. socket_requests_in_flight_ += 1;
  13337. socket_requests_are_from_thread_ = std::this_thread::get_id();
  13338. }
  13339. for (const auto &header : default_headers_) {
  13340. if (req.headers.find(header.first) == req.headers.end()) {
  13341. req.headers.insert(header);
  13342. }
  13343. }
  13344. auto ret = false;
  13345. auto close_connection = !keep_alive_;
  13346. auto se = detail::scope_exit([&]() {
  13347. // Briefly lock mutex in order to mark that a request is no longer ongoing
  13348. std::lock_guard<std::mutex> guard(socket_mutex_);
  13349. socket_requests_in_flight_ -= 1;
  13350. if (socket_requests_in_flight_ <= 0) {
  13351. assert(socket_requests_in_flight_ == 0);
  13352. socket_requests_are_from_thread_ = std::thread::id();
  13353. }
  13354. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  13355. !ret) {
  13356. disconnect(/*gracefully=*/true);
  13357. }
  13358. });
  13359. ret = process_socket(socket_, req.start_time_, [&](Stream &strm) {
  13360. return handle_request(strm, req, res, close_connection, error);
  13361. });
  13362. if (!ret) {
  13363. if (error == Error::Success) { error = Error::Unknown; }
  13364. }
  13365. return ret;
  13366. }
  13367. inline Result ClientImpl::send(const Request &req) {
  13368. auto req2 = req;
  13369. return send_(std::move(req2));
  13370. }
  13371. inline Result ClientImpl::send_(Request &&req) {
  13372. auto res = detail::make_unique<Response>();
  13373. auto error = Error::Success;
  13374. #ifdef CPPHTTPLIB_SSL_ENABLED
  13375. // Hold the request lock until the Result has read this request's TLS error
  13376. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  13377. #endif
  13378. auto ret = send(req, *res, error);
  13379. #ifdef CPPHTTPLIB_SSL_ENABLED
  13380. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers),
  13381. last_ssl_error_, last_backend_error_};
  13382. #else
  13383. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers)};
  13384. #endif
  13385. }
  13386. inline void ClientImpl::prepare_default_headers(Request &r, bool for_stream,
  13387. const std::string &ct) {
  13388. (void)for_stream;
  13389. // Default headers are meant for the origin and may carry its credentials, so
  13390. // keep them off the CONNECT request the proxy reads.
  13391. if (r.method != "CONNECT") {
  13392. for (const auto &header : default_headers_) {
  13393. if (!r.has_header(header.first)) { r.headers.insert(header); }
  13394. }
  13395. }
  13396. // RFC 9110 5.3 recommends sending control data such as Host first, so
  13397. // prepend it rather than appending it after the caller's own fields.
  13398. if (!r.has_header("Host")) {
  13399. r.headers.emplace_front(
  13400. "Host", detail::make_default_host_header_value(host_, port_, is_ssl(),
  13401. address_family_));
  13402. }
  13403. if (!r.has_header("Accept")) { r.headers.emplace("Accept", "*/*"); }
  13404. if (!r.content_receiver) {
  13405. if (!r.has_header("Accept-Encoding")) {
  13406. std::string accept_encoding;
  13407. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  13408. accept_encoding = "br";
  13409. #endif
  13410. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  13411. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13412. accept_encoding += "gzip, deflate";
  13413. #endif
  13414. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  13415. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13416. accept_encoding += "zstd";
  13417. #endif
  13418. r.set_header("Accept-Encoding", accept_encoding);
  13419. }
  13420. detail::add_default_user_agent_header(r);
  13421. }
  13422. if (!r.body.empty()) {
  13423. if (!ct.empty() && !r.has_header("Content-Type")) {
  13424. r.headers.emplace("Content-Type", ct);
  13425. }
  13426. if (!r.has_header("Content-Length")) {
  13427. r.headers.emplace("Content-Length", std::to_string(r.body.size()));
  13428. }
  13429. }
  13430. }
  13431. inline ClientImpl::StreamHandle
  13432. ClientImpl::open_stream(const std::string &method, const std::string &path,
  13433. const Params &params, const Headers &headers,
  13434. const std::string &body,
  13435. const std::string &content_type) {
  13436. // Encode the target exactly like the buffered send path does, so that the
  13437. // same `path` produces the same request line through either API.
  13438. auto raw_query_path =
  13439. params.empty() ? path : append_query_params(path, params);
  13440. Request req;
  13441. req.method = method;
  13442. req.path = detail::encode_request_target(raw_query_path, path_encode_);
  13443. req.headers = headers;
  13444. req.body = body;
  13445. prepare_default_headers(req, true, content_type);
  13446. auto handle = open_stream_(req);
  13447. // Like a buffered request, a stream that fails to open is reported once
  13448. if (handle.error != Error::Success) { output_error_log(handle.error, &req); }
  13449. return handle;
  13450. }
  13451. inline ClientImpl::StreamHandle ClientImpl::open_stream_(Request &req) {
  13452. StreamHandle handle;
  13453. handle.response = detail::make_unique<Response>();
  13454. handle.error = Error::Success;
  13455. handle.connection_ = detail::make_unique<ClientConnection>();
  13456. {
  13457. std::lock_guard<std::mutex> guard(socket_mutex_);
  13458. auto is_alive = false;
  13459. if (socket_.is_open()) {
  13460. is_alive = detail::is_socket_alive(socket_.sock);
  13461. #ifdef CPPHTTPLIB_SSL_ENABLED
  13462. if (is_alive && is_ssl()) {
  13463. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13464. is_alive = false;
  13465. }
  13466. }
  13467. #endif
  13468. if (!is_alive) { disconnect(/*gracefully=*/false); }
  13469. }
  13470. if (!is_alive) {
  13471. if (!ensure_socket_connection(socket_, handle.error)) {
  13472. handle.response.reset();
  13473. return handle;
  13474. }
  13475. {
  13476. auto success = true;
  13477. auto start_time = std::chrono::steady_clock::now();
  13478. if (!setup_proxy_connection(socket_, start_time, *handle.response,
  13479. success, handle.error)) {
  13480. if (!success) { handle.response.reset(); }
  13481. return handle;
  13482. }
  13483. }
  13484. }
  13485. transfer_socket_ownership_to_handle(handle);
  13486. }
  13487. #ifdef CPPHTTPLIB_SSL_ENABLED
  13488. if (is_ssl() && handle.connection_->session) {
  13489. handle.socket_stream_ = detail::make_unique<detail::SSLSocketStream>(
  13490. handle.connection_->sock, handle.connection_->session,
  13491. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13492. write_timeout_usec_);
  13493. } else {
  13494. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13495. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13496. write_timeout_sec_, write_timeout_usec_);
  13497. }
  13498. #else
  13499. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13500. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13501. write_timeout_sec_, write_timeout_usec_);
  13502. #endif
  13503. handle.stream_ = handle.socket_stream_.get();
  13504. auto &strm = *handle.stream_;
  13505. // After connecting, as for a buffered request
  13506. add_credential_headers(req);
  13507. // Build the request line and headers in memory first, like write_request()
  13508. // does, so that a rejected header leaves nothing on the wire.
  13509. {
  13510. detail::BufferStream bstrm;
  13511. if (detail::write_request_line(bstrm, req.method,
  13512. proxy_target_prefix() + req.path) < 0) {
  13513. handle.error = Error::Write;
  13514. handle.response.reset();
  13515. return handle;
  13516. }
  13517. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13518. handle.error)) {
  13519. handle.response.reset();
  13520. return handle;
  13521. }
  13522. const auto &data = bstrm.get_buffer();
  13523. if (!detail::write_data(strm, data.data(), data.size())) {
  13524. handle.error = Error::Write;
  13525. handle.response.reset();
  13526. return handle;
  13527. }
  13528. }
  13529. if (!req.body.empty()) {
  13530. if (strm.write(req.body.data(), req.body.size()) < 0) {
  13531. handle.error = Error::Write;
  13532. handle.response.reset();
  13533. return handle;
  13534. }
  13535. }
  13536. if (!read_response_line(strm, req, *handle.response) ||
  13537. !detail::read_headers(strm, handle.response->headers)) {
  13538. handle.error = Error::Read;
  13539. handle.response.reset();
  13540. return handle;
  13541. }
  13542. handle.body_reader_.stream = handle.stream_;
  13543. handle.body_reader_.payload_max_length = payload_max_length_;
  13544. // RFC 9112 6.3: a response to HEAD, and a 204 or 304 response, ends with its
  13545. // header section, so none of its framing or coding headers apply.
  13546. if (req.method == "HEAD" ||
  13547. handle.response->status == StatusCode::NoContent_204 ||
  13548. handle.response->status == StatusCode::NotModified_304) {
  13549. handle.body_reader_.eof = true;
  13550. return handle;
  13551. }
  13552. // Same framing check as ClientImpl::process_request()
  13553. if (detail::has_conflicting_content_length(handle.response->headers)) {
  13554. handle.error = Error::Read;
  13555. handle.response.reset();
  13556. return handle;
  13557. }
  13558. if (handle.response->has_header("Content-Length")) {
  13559. bool is_invalid = false;
  13560. auto content_length = detail::get_header_value_u64(
  13561. handle.response->headers, "Content-Length", 0, 0, is_invalid);
  13562. if (is_invalid) {
  13563. handle.error = Error::Read;
  13564. handle.response.reset();
  13565. return handle;
  13566. }
  13567. handle.body_reader_.has_content_length = true;
  13568. handle.body_reader_.content_length = content_length;
  13569. }
  13570. handle.body_reader_.chunked =
  13571. detail::is_chunked_transfer_encoding(handle.response->headers);
  13572. auto content_encoding = detail::get_combined_header_value(
  13573. handle.response->headers, "Content-Encoding");
  13574. if (!content_encoding.empty()) {
  13575. // Same policy as prepare_content_receiver(): reject a coding we know about
  13576. // but were not built with, pass an unrecognized one through as-is.
  13577. handle.decompressor_ = detail::create_decompressor(content_encoding);
  13578. if (!handle.decompressor_) {
  13579. if (detail::is_known_content_encoding(content_encoding)) {
  13580. handle.error = Error::UnsupportedContentEncoding;
  13581. handle.response.reset();
  13582. return handle;
  13583. }
  13584. } else if (!handle.decompressor_->is_valid()) {
  13585. handle.error = Error::Compression;
  13586. handle.response.reset();
  13587. return handle;
  13588. }
  13589. }
  13590. return handle;
  13591. }
  13592. inline ssize_t ClientImpl::StreamHandle::read(char *buf, size_t len) {
  13593. if (!is_valid() || !response) { return -1; }
  13594. auto n = decompressor_
  13595. ? read_with_decompression(buf, len)
  13596. : detail::read_body_content(stream_, body_reader_, buf, len);
  13597. if (n == 0) { parse_trailers_if_needed(); }
  13598. return n;
  13599. }
  13600. inline ssize_t ClientImpl::StreamHandle::read_with_decompression(char *buf,
  13601. size_t len) {
  13602. if (decompress_offset_ < decompress_buffer_.size()) {
  13603. auto available = decompress_buffer_.size() - decompress_offset_;
  13604. auto to_copy = (std::min)(len, available);
  13605. std::memcpy(buf, decompress_buffer_.data() + decompress_offset_, to_copy);
  13606. decompress_offset_ += to_copy;
  13607. decompressed_bytes_read_ += to_copy;
  13608. return static_cast<ssize_t>(to_copy);
  13609. }
  13610. decompress_buffer_.clear();
  13611. decompress_offset_ = 0;
  13612. constexpr size_t kDecompressionBufferSize = 8192;
  13613. char compressed_buf[kDecompressionBufferSize];
  13614. while (true) {
  13615. auto n = detail::read_body_content(stream_, body_reader_, compressed_buf,
  13616. sizeof(compressed_buf));
  13617. if (n <= 0) { return n; }
  13618. auto exceeded = false;
  13619. bool decompress_ok = decompressor_->decompress(
  13620. compressed_buf, static_cast<size_t>(n),
  13621. [&](const char *data, size_t data_len) {
  13622. decompress_buffer_.append(data, data_len);
  13623. auto limit = body_reader_.payload_max_length;
  13624. exceeded =
  13625. limit > 0 &&
  13626. decompressed_bytes_read_ + decompress_buffer_.size() > limit;
  13627. return !exceeded;
  13628. });
  13629. if (!decompress_ok) {
  13630. body_reader_.last_error =
  13631. exceeded ? Error::ExceedMaxPayloadSize : Error::Read;
  13632. return -1;
  13633. }
  13634. if (!decompress_buffer_.empty()) { break; }
  13635. }
  13636. auto to_copy = (std::min)(len, decompress_buffer_.size());
  13637. std::memcpy(buf, decompress_buffer_.data(), to_copy);
  13638. decompress_offset_ = to_copy;
  13639. decompressed_bytes_read_ += to_copy;
  13640. return static_cast<ssize_t>(to_copy);
  13641. }
  13642. inline void ClientImpl::StreamHandle::parse_trailers_if_needed() {
  13643. // The trailers follow the last chunk, so there are none before it
  13644. auto &decoder = body_reader_.chunked_decoder;
  13645. if (!response || trailers_parsed_ || !decoder || !decoder->finished) {
  13646. return;
  13647. }
  13648. trailers_parsed_ = true;
  13649. decoder->parse_trailers_into(response->trailers, response->headers);
  13650. }
  13651. namespace detail {
  13652. inline ChunkedDecoder::ChunkedDecoder(Stream &s) : strm(s) {}
  13653. inline ssize_t ChunkedDecoder::read_payload(char *buf, size_t len,
  13654. size_t &out_chunk_offset,
  13655. size_t &out_chunk_total) {
  13656. if (finished) { return 0; }
  13657. if (chunk_remaining == 0) {
  13658. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13659. if (!lr.getline()) { return -1; }
  13660. // Everything below is bounded by eol rather than by the buffer's NUL, so
  13661. // the line terminator is never mistaken for line content.
  13662. const char *eol = lr.ptr() + lr.size();
  13663. if (lr.end_with_crlf()) {
  13664. eol -= 2;
  13665. } else if (eol != lr.ptr() && eol[-1] == '\n') {
  13666. // Only reachable under CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR, where
  13667. // getline() ends the line on a bare LF. That LF is the terminator, so it
  13668. // has to come off here or the check below would reject the line.
  13669. eol -= 1;
  13670. }
  13671. // RFC 9112 §7.1: chunk-size = 1*HEXDIG
  13672. const char *p = lr.ptr();
  13673. int v = 0;
  13674. if (p == eol || !is_hex(*p, v)) { return -1; }
  13675. size_t chunk_len = 0;
  13676. constexpr size_t chunk_len_max = (std::numeric_limits<size_t>::max)();
  13677. for (; p < eol && is_hex(*p, v); ++p) {
  13678. if (chunk_len > (chunk_len_max >> 4)) { return -1; }
  13679. chunk_len = (chunk_len << 4) | static_cast<size_t>(v);
  13680. }
  13681. while (p < eol && is_space_or_tab(*p)) {
  13682. ++p;
  13683. }
  13684. // RFC 9112 §7.1.1: only a chunk-ext may sit between the size and the line
  13685. // terminator, and it is built from tokens and quoted-strings, so it never
  13686. // holds a CR, LF or any other control character. getline() reads up to the
  13687. // CRLF, so a bare LF left in here would be swallowed as extension text
  13688. // while an intermediary that ends the line on it delimits the chunks
  13689. // differently, and the two disagree on where the body ends (request
  13690. // smuggling).
  13691. if (p < eol && *p != ';') { return -1; }
  13692. for (; p < eol; ++p) {
  13693. if (!is_space_or_tab(*p) && !fields::is_field_vchar(*p)) { return -1; }
  13694. }
  13695. if (chunk_len == 0) {
  13696. chunk_remaining = 0;
  13697. finished = true;
  13698. out_chunk_offset = 0;
  13699. out_chunk_total = 0;
  13700. return 0;
  13701. }
  13702. chunk_remaining = chunk_len;
  13703. last_chunk_total = chunk_remaining;
  13704. last_chunk_offset = 0;
  13705. }
  13706. auto to_read = (std::min)(chunk_remaining, len);
  13707. auto n = strm.read(buf, to_read);
  13708. if (n <= 0) { return -1; }
  13709. auto offset_before = last_chunk_offset;
  13710. last_chunk_offset += static_cast<size_t>(n);
  13711. chunk_remaining -= static_cast<size_t>(n);
  13712. out_chunk_offset = offset_before;
  13713. out_chunk_total = last_chunk_total;
  13714. if (chunk_remaining == 0) {
  13715. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13716. if (!lr.getline()) { return -1; }
  13717. if (std::strcmp(lr.ptr(), "\r\n") != 0) { return -1; }
  13718. }
  13719. return n;
  13720. }
  13721. inline bool ChunkedDecoder::parse_trailers_into(Headers &dest,
  13722. const Headers &src_headers) {
  13723. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13724. if (!lr.getline()) { return false; }
  13725. return parse_trailers(lr, dest, src_headers);
  13726. }
  13727. // A 3xx without a Location, such as a 304, is a final response
  13728. inline bool is_redirect(const Response &res) {
  13729. return 300 < res.status && res.status < 400 &&
  13730. !res.get_header_value("Location").empty();
  13731. }
  13732. } // namespace detail
  13733. inline void
  13734. ClientImpl::transfer_socket_ownership_to_handle(StreamHandle &handle) {
  13735. handle.connection_->sock = socket_.sock;
  13736. #ifdef CPPHTTPLIB_SSL_ENABLED
  13737. handle.connection_->session = socket_.ssl;
  13738. socket_.ssl = nullptr;
  13739. #endif
  13740. socket_.sock = INVALID_SOCKET;
  13741. }
  13742. // A plain HTTP proxy reads the target in absolute-form (RFC 9112 3.2.2)
  13743. inline std::string ClientImpl::proxy_target_prefix() const {
  13744. if (is_ssl() || !is_proxy_enabled_for_host(host_)) { return std::string(); }
  13745. return "http://" + detail::make_host_and_port_string(host_, port_, false);
  13746. }
  13747. inline bool ClientImpl::handle_request(Stream &strm, Request &req,
  13748. Response &res, bool close_connection,
  13749. Error &error) {
  13750. if (req.path.empty()) {
  13751. error = Error::Connection;
  13752. return false;
  13753. }
  13754. auto req_save = req;
  13755. bool ret;
  13756. auto prefix = proxy_target_prefix();
  13757. if (!prefix.empty()) {
  13758. auto req2 = req;
  13759. req2.path = prefix + req.path;
  13760. ret = process_request(strm, req2, res, close_connection, error);
  13761. req = std::move(req2);
  13762. req.path = req_save.path;
  13763. } else {
  13764. ret = process_request(strm, req, res, close_connection, error);
  13765. }
  13766. if (!ret) { return false; }
  13767. {
  13768. // NOTE: this requires a not-entirely-obvious chain of calls to be correct
  13769. // for this to be safe.
  13770. // This is safe to call because handle_request is only called by send_
  13771. // which locks the request mutex during the process. It would be a bug
  13772. // to call it from a different thread since it's a thread-safety issue
  13773. // to do these things to the socket if another thread is using the socket.
  13774. std::lock_guard<std::mutex> guard(socket_mutex_);
  13775. // Also when the request asked for it (e.g. a body that was never sent),
  13776. // so that a redirect or an auth retry below does not reuse the socket.
  13777. if (socket_should_be_closed_when_request_is_done_ ||
  13778. detail::has_header_token(res.headers, "Connection", "close") ||
  13779. (res.version == "HTTP/1.0" && res.reason != "Connection established")) {
  13780. disconnect(/*gracefully=*/true);
  13781. }
  13782. }
  13783. if (follow_location_ && detail::is_redirect(res)) {
  13784. req = std::move(req_save);
  13785. // The client that followed the redirect has answered any challenge it
  13786. // could. Retrying below would sign another host's challenge and send it
  13787. // here.
  13788. return redirect(req, res, error);
  13789. }
  13790. #ifdef CPPHTTPLIB_SSL_ENABLED
  13791. if ((res.status == StatusCode::Unauthorized_401 ||
  13792. res.status == StatusCode::ProxyAuthenticationRequired_407) &&
  13793. req.authorization_count_ < 5) {
  13794. auto is_proxy = res.status == StatusCode::ProxyAuthenticationRequired_407;
  13795. // Only retry when the 407 actually came from a proxy hop: plain HTTP
  13796. // through an enabled proxy. HTTPS via CONNECT tunnels the 407 from the
  13797. // origin (#2457); direct/bypassed origins have no proxy hop at all.
  13798. if (is_proxy && !(!is_ssl() && is_proxy_enabled_for_host(host_))) {
  13799. return ret;
  13800. }
  13801. const auto &username =
  13802. is_proxy ? proxy_digest_auth_username_ : digest_auth_username_;
  13803. const auto &password =
  13804. is_proxy ? proxy_digest_auth_password_ : digest_auth_password_;
  13805. if (!username.empty() && !password.empty()) {
  13806. std::map<std::string, std::string> auth;
  13807. if (detail::parse_www_authenticate(res, auth, is_proxy)) {
  13808. Request new_req = req;
  13809. new_req.authorization_count_ += 1;
  13810. new_req.headers.erase(is_proxy ? "Proxy-Authorization"
  13811. : "Authorization");
  13812. new_req.headers.insert(detail::make_digest_authentication_header(
  13813. req, make_request_target(req), auth, new_req.authorization_count_,
  13814. detail::random_string(10), username, password, is_proxy));
  13815. Response new_res;
  13816. ret = send(new_req, new_res, error);
  13817. if (ret) { res = std::move(new_res); }
  13818. }
  13819. }
  13820. }
  13821. #endif
  13822. return ret;
  13823. }
  13824. inline bool ClientImpl::redirect(Request &req, Response &res, Error &error) {
  13825. if (req.redirect_count_ == 0) {
  13826. error = Error::ExceedRedirectCount;
  13827. return false;
  13828. }
  13829. auto location = res.get_header_value("location");
  13830. if (location.empty()) { return false; }
  13831. detail::UrlComponents uc;
  13832. if (!detail::parse_url(detail::resolve_relative_location(location, req.path),
  13833. uc)) {
  13834. return false;
  13835. }
  13836. // Only follow http/https redirects
  13837. if (!uc.scheme.empty() && uc.scheme != "http" && uc.scheme != "https") {
  13838. return false;
  13839. }
  13840. auto scheme = is_ssl() ? "https" : "http";
  13841. auto next_scheme = std::move(uc.scheme);
  13842. auto next_host = std::move(uc.host);
  13843. auto port_str = std::move(uc.port);
  13844. auto next_path = std::move(uc.path);
  13845. auto next_query = std::move(uc.query);
  13846. auto next_port = port_;
  13847. if (!port_str.empty()) {
  13848. if (!detail::parse_port(port_str, next_port)) { return false; }
  13849. } else if (!next_scheme.empty()) {
  13850. next_port = next_scheme == "https" ? 443 : 80;
  13851. }
  13852. if (next_scheme.empty()) { next_scheme = scheme; }
  13853. if (next_host.empty()) { next_host = host_; }
  13854. if (next_path.empty()) { next_path = "/"; }
  13855. auto path = std::move(next_path) + next_query;
  13856. // Same host redirect - use current client
  13857. if (next_scheme == scheme && next_host == host_ && next_port == port_) {
  13858. return detail::redirect(*this, req, res, path, location, error);
  13859. }
  13860. // Cross-host/scheme redirect - create new client with robust setup
  13861. return create_redirect_client(next_scheme, next_host, next_port, req, res,
  13862. path, location, error);
  13863. }
  13864. // New method for robust redirect client creation
  13865. inline bool ClientImpl::create_redirect_client(
  13866. const std::string &scheme, const std::string &host, int port, Request &req,
  13867. Response &res, const std::string &path, const std::string &location,
  13868. Error &error) {
  13869. // Determine if we need SSL
  13870. auto need_ssl = (scheme == "https");
  13871. // Clean up request headers that are host/client specific
  13872. // Remove headers that should not be carried over to new host
  13873. auto headers_to_remove = std::vector<std::string>{
  13874. "Host", "Proxy-Authorization", "Authorization", "Cookie", "Cookie2"};
  13875. for (const auto &header_name : headers_to_remove) {
  13876. auto it = req.headers.find(header_name);
  13877. while (it != req.headers.end()) {
  13878. it = req.headers.erase(it);
  13879. it = req.headers.find(header_name);
  13880. }
  13881. }
  13882. // Create appropriate client type and handle redirect
  13883. if (need_ssl) {
  13884. #ifdef CPPHTTPLIB_SSL_ENABLED
  13885. // Create SSL client for HTTPS redirect
  13886. SSLClient redirect_client(host, port);
  13887. // Setup basic client configuration first
  13888. setup_redirect_client(redirect_client);
  13889. redirect_client.enable_server_certificate_verification(
  13890. server_certificate_verification_);
  13891. redirect_client.enable_server_hostname_verification(
  13892. server_hostname_verification_);
  13893. redirect_client.system_ca_mode_ = system_ca_mode_;
  13894. // Transfer CA certificate to redirect client
  13895. redirect_client.set_ca_cert_path(ca_cert_file_path_, ca_cert_dir_path_);
  13896. if (is_ssl()) {
  13897. auto &self = static_cast<SSLClient &>(*this);
  13898. // A store given to set_ca_cert_store() lives only in this client's
  13899. // context, which then holds all that is trusted.
  13900. if (self.ca_cert_store_set_) {
  13901. std::string pem;
  13902. {
  13903. std::lock_guard<std::mutex> guard(self.ctx_mutex_);
  13904. pem = detail::ca_certs_to_pem(self.ctx_);
  13905. }
  13906. redirect_client.load_ca_cert_store(pem.data(), pem.size());
  13907. redirect_client.ca_cert_store_set_ = true;
  13908. } else {
  13909. redirect_client.load_ca_cert_store(ca_cert_pem_.c_str(),
  13910. ca_cert_pem_.size());
  13911. }
  13912. redirect_client.set_session_verifier(self.session_verifier_);
  13913. if (self.server_certificate_verifier_) {
  13914. redirect_client.set_server_certificate_verifier(
  13915. self.server_certificate_verifier_);
  13916. }
  13917. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  13918. redirect_client.enable_windows_cert_verification_ =
  13919. self.enable_windows_cert_verification_;
  13920. #endif
  13921. }
  13922. // Client certificates are set through constructor for SSLClient
  13923. // NOTE: SSLClient constructor already takes client_cert_path and
  13924. // client_key_path so we need to create it properly if client certs are
  13925. // needed
  13926. // Execute the redirect
  13927. return detail::redirect(redirect_client, req, res, path, location, error);
  13928. #else
  13929. // SSL not supported - set appropriate error
  13930. error = Error::SSLConnection;
  13931. return false;
  13932. #endif
  13933. } else {
  13934. // HTTP redirect
  13935. ClientImpl redirect_client(host, port);
  13936. // Setup client with robust configuration
  13937. setup_redirect_client(redirect_client);
  13938. // Execute the redirect
  13939. return detail::redirect(redirect_client, req, res, path, location, error);
  13940. }
  13941. }
  13942. // New method for robust client setup (based on basic_manual_redirect.cpp
  13943. // logic)
  13944. template <typename ClientType>
  13945. inline void ClientImpl::setup_redirect_client(ClientType &client) {
  13946. // Copy basic settings first
  13947. client.set_connection_timeout(connection_timeout_sec_,
  13948. connection_timeout_usec_);
  13949. client.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  13950. client.set_write_timeout(write_timeout_sec_, write_timeout_usec_);
  13951. client.set_max_timeout(max_timeout_msec_);
  13952. if (has_payload_max_length_) {
  13953. client.set_payload_max_length(payload_max_length_);
  13954. }
  13955. client.set_keep_alive(keep_alive_);
  13956. client.set_follow_location(
  13957. true); // Enable redirects to handle multi-step redirects
  13958. client.set_path_encode(path_encode_);
  13959. client.set_compress(compress_);
  13960. client.set_decompress(decompress_);
  13961. // NOTE: Authentication credentials (basic auth, bearer token, digest auth)
  13962. // are intentionally NOT copied to the redirect client. Per RFC 9110 Section
  13963. // 15.4, credentials must not be forwarded when redirecting to a different
  13964. // host. This function is only called for cross-host redirects; same-host
  13965. // redirects are handled directly in ClientImpl::redirect().
  13966. // Copy the proxy configuration unconditionally; the per-target bypass is
  13967. // re-evaluated at send time, so a later hop to a non-bypassed host can
  13968. // still use the proxy.
  13969. client.no_proxy_entries_ = no_proxy_entries_;
  13970. if (!proxy_host_.empty() && proxy_port_ != -1) {
  13971. client.set_proxy(proxy_host_, proxy_port_);
  13972. if (!proxy_basic_auth_username_.empty() ||
  13973. !proxy_basic_auth_password_.empty()) {
  13974. client.set_proxy_basic_auth(proxy_basic_auth_username_,
  13975. proxy_basic_auth_password_);
  13976. }
  13977. if (!proxy_bearer_token_auth_token_.empty()) {
  13978. client.set_proxy_bearer_token_auth(proxy_bearer_token_auth_token_);
  13979. }
  13980. #ifdef CPPHTTPLIB_SSL_ENABLED
  13981. if (!proxy_digest_auth_username_.empty()) {
  13982. client.set_proxy_digest_auth(proxy_digest_auth_username_,
  13983. proxy_digest_auth_password_);
  13984. }
  13985. #endif
  13986. }
  13987. // Copy network and socket settings
  13988. client.addr_map_ = addr_map_;
  13989. client.set_address_family(address_family_);
  13990. client.set_tcp_nodelay(tcp_nodelay_);
  13991. client.set_ipv6_v6only(ipv6_v6only_);
  13992. if (socket_options_) { client.set_socket_options(socket_options_); }
  13993. if (!interface_.empty()) { client.set_interface(interface_); }
  13994. // Copy logging and headers. Not the error logger: a failure comes back to
  13995. // this client's send(), which reports it with the caller's request.
  13996. if (logger_) { client.set_logger(logger_); }
  13997. // NOTE: DO NOT copy default_headers_ as they may contain stale Host headers
  13998. // Each new client should generate its own headers based on its target host
  13999. }
  14000. inline bool ClientImpl::write_content_with_provider(Stream &strm,
  14001. const Request &req,
  14002. Error &error) const {
  14003. auto is_shutting_down = []() { return false; };
  14004. if (req.is_chunked_content_provider_) {
  14005. auto compressor = compress_ ? detail::create_compressor().first
  14006. : std::unique_ptr<detail::compressor>();
  14007. if (!compressor) {
  14008. compressor = detail::make_unique<detail::nocompressor>();
  14009. }
  14010. return detail::write_content_chunked(strm, req.content_provider_,
  14011. is_shutting_down, *compressor, error);
  14012. } else {
  14013. return detail::write_content_with_progress(
  14014. strm, req.content_provider_, 0, req.content_length_, is_shutting_down,
  14015. req.upload_progress, error);
  14016. }
  14017. }
  14018. // What goes on the request line for req: its path, encoded and without the
  14019. // fragment, with `req.params` as the query when the path has none.
  14020. inline std::string ClientImpl::make_request_target(const Request &req) const {
  14021. auto target = detail::encode_request_target(req.path, path_encode_);
  14022. if (detail::query_of(req.path).empty() && !req.params.empty()) {
  14023. target = append_query_params(target, req.params);
  14024. }
  14025. return target;
  14026. }
  14027. inline void ClientImpl::add_credential_headers(Request &req) {
  14028. // A CONNECT request is read by the proxy; everything sent through the tunnel
  14029. // it opens is read by the origin. Each credential goes only to its own hop.
  14030. auto is_connect = req.method == "CONNECT";
  14031. if (!is_connect) {
  14032. detail::add_authorization_header(req, basic_auth_username_,
  14033. basic_auth_password_,
  14034. bearer_token_auth_token_, false);
  14035. }
  14036. // Proxy-Authorization is only sent when the proxy reads this message —
  14037. // otherwise NO_PROXY-matched requests, and requests inside a TLS tunnel,
  14038. // would leak proxy credentials to the destination server.
  14039. if (is_proxy_enabled_for_host(host_) && (!is_ssl() || is_connect)) {
  14040. detail::add_authorization_header(req, proxy_basic_auth_username_,
  14041. proxy_basic_auth_password_,
  14042. proxy_bearer_token_auth_token_, true);
  14043. }
  14044. }
  14045. inline bool ClientImpl::write_request(Stream &strm, Request &req,
  14046. bool close_connection, Error &error,
  14047. bool skip_body, bool &rejected_locally) {
  14048. rejected_locally = false;
  14049. // Prepare additional headers
  14050. if (close_connection) {
  14051. if (!req.has_header("Connection")) {
  14052. req.set_header("Connection", "close");
  14053. }
  14054. }
  14055. std::string ct_for_defaults;
  14056. if (!req.has_header("Content-Type") && !req.body.empty()) {
  14057. ct_for_defaults = "text/plain";
  14058. }
  14059. prepare_default_headers(req, false, ct_for_defaults);
  14060. if (req.body.empty()) {
  14061. if (req.content_provider_) {
  14062. if (!req.is_chunked_content_provider_) {
  14063. if (!req.has_header("Content-Length")) {
  14064. auto length = std::to_string(req.content_length_);
  14065. req.set_header("Content-Length", length);
  14066. }
  14067. }
  14068. } else {
  14069. if (req.method == "POST" || req.method == "PUT" ||
  14070. req.method == "PATCH") {
  14071. req.set_header("Content-Length", "0");
  14072. }
  14073. }
  14074. }
  14075. add_credential_headers(req);
  14076. // Request line and headers
  14077. {
  14078. detail::BufferStream bstrm;
  14079. auto path_with_query = make_request_target(req);
  14080. // The query already came in through `req.path`; still populate
  14081. // `req.params` for handlers/users who read them.
  14082. auto query_part = detail::query_of(req.path);
  14083. if (!query_part.empty()) {
  14084. detail::parse_query_text(query_part, req.params);
  14085. }
  14086. // Write request line and headers
  14087. if (detail::write_request_line(bstrm, req.method, path_with_query) < 0) {
  14088. // A rejected method (not a token, e.g. carrying CR/LF) or target (e.g.
  14089. // CR/LF in a caller-supplied path under set_path_encode(false)) must
  14090. // fail the request cleanly instead of emitting a request-line-less,
  14091. // header-injecting request.
  14092. error = Error::Write;
  14093. rejected_locally = true;
  14094. return false;
  14095. }
  14096. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  14097. error)) {
  14098. rejected_locally = true;
  14099. return false;
  14100. }
  14101. // Flush buffer
  14102. auto &data = bstrm.get_buffer();
  14103. if (!detail::write_data(strm, data.data(), data.size())) {
  14104. error = Error::Write;
  14105. return false;
  14106. }
  14107. }
  14108. // After sending request line and headers, wait briefly for an early server
  14109. // response (e.g. 4xx) and avoid sending a potentially large request body
  14110. // unnecessarily. This workaround is only enabled on Windows because Unix
  14111. // platforms surface write errors (EPIPE) earlier; on Windows kernel send
  14112. // buffering can accept large writes even when the peer already responded.
  14113. // Check the stream first (which covers SSL via `is_readable()`), then
  14114. // fall back to select on the socket. Only perform the wait for very large
  14115. // request bodies to avoid interfering with normal small requests and
  14116. // reduce side-effects. Poll briefly (up to 50ms as default) for an early
  14117. // response. Skip this check when using Expect: 100-continue, as the protocol
  14118. // handles early responses properly.
  14119. #if defined(_WIN32)
  14120. if (!skip_body &&
  14121. req.body.size() > CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD &&
  14122. req.path.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  14123. auto start = std::chrono::high_resolution_clock::now();
  14124. for (;;) {
  14125. // Prefer socket-level readiness to avoid SSL_pending() false-positives
  14126. // from SSL internals. If the underlying socket is readable, assume an
  14127. // early response may be present.
  14128. auto sock = strm.socket();
  14129. if (sock != INVALID_SOCKET && detail::select_read(sock, 0, 0) > 0) {
  14130. return false;
  14131. }
  14132. // Fallback to stream-level check for non-socket streams or when the
  14133. // socket isn't reporting readable. Avoid using `is_readable()` for
  14134. // SSL, since `SSL_pending()` may report buffered records that do not
  14135. // indicate a complete application-level response yet.
  14136. if (!is_ssl() && strm.is_readable()) { return false; }
  14137. auto now = std::chrono::high_resolution_clock::now();
  14138. auto elapsed =
  14139. std::chrono::duration_cast<std::chrono::milliseconds>(now - start)
  14140. .count();
  14141. if (elapsed >= CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND) {
  14142. break;
  14143. }
  14144. std::this_thread::sleep_for(std::chrono::milliseconds(1));
  14145. }
  14146. }
  14147. #endif
  14148. // Body
  14149. if (skip_body) { return true; }
  14150. return write_request_body(strm, req, error);
  14151. }
  14152. inline bool ClientImpl::write_request_body(Stream &strm, Request &req,
  14153. Error &error) {
  14154. if (req.body.empty()) {
  14155. return write_content_with_provider(strm, req, error);
  14156. }
  14157. if (req.upload_progress) {
  14158. auto body_size = req.body.size();
  14159. size_t written = 0;
  14160. auto data = req.body.data();
  14161. while (written < body_size) {
  14162. size_t to_write = (std::min)(CPPHTTPLIB_SEND_BUFSIZ, body_size - written);
  14163. if (!detail::write_data(strm, data + written, to_write)) {
  14164. error = Error::Write;
  14165. return false;
  14166. }
  14167. written += to_write;
  14168. if (!req.upload_progress(written, body_size)) {
  14169. error = Error::Canceled;
  14170. return false;
  14171. }
  14172. }
  14173. } else {
  14174. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  14175. error = Error::Write;
  14176. return false;
  14177. }
  14178. }
  14179. return true;
  14180. }
  14181. inline std::unique_ptr<Response>
  14182. ClientImpl::send_with_content_provider_and_receiver(
  14183. Request &req, const char *body, size_t content_length,
  14184. ContentProvider content_provider,
  14185. ContentProviderWithoutLength content_provider_without_length,
  14186. const std::string &content_type, ContentReceiver content_receiver,
  14187. Error &error) {
  14188. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14189. auto enc = compress_
  14190. ? detail::create_compressor()
  14191. : std::pair<std::unique_ptr<detail::compressor>, const char *>(
  14192. nullptr, nullptr);
  14193. if (enc.second) { req.set_header("Content-Encoding", enc.second); }
  14194. if (enc.first && !content_provider_without_length) {
  14195. auto &compressor = enc.first;
  14196. if (content_provider) {
  14197. auto ok = true;
  14198. auto finished = false;
  14199. size_t offset = 0;
  14200. DataSink data_sink;
  14201. data_sink.write = [&](const char *data, size_t data_len) -> bool {
  14202. if (ok) {
  14203. auto last = offset + data_len == content_length;
  14204. auto ret = compressor->compress(
  14205. data, data_len, last,
  14206. [&](const char *compressed_data, size_t compressed_data_len) {
  14207. req.body.append(compressed_data, compressed_data_len);
  14208. return true;
  14209. });
  14210. if (ret) {
  14211. offset += data_len;
  14212. } else {
  14213. ok = false;
  14214. }
  14215. }
  14216. return ok;
  14217. };
  14218. // As in detail::write_content_with_progress(): the body is framed by
  14219. // content_length, so a provider that finishes early has truncated it.
  14220. // Stop and report that instead of calling the provider forever.
  14221. data_sink.done = [&]() { finished = true; };
  14222. while (ok && !finished && offset < content_length) {
  14223. if (!content_provider(offset, content_length - offset, data_sink)) {
  14224. error = Error::Canceled;
  14225. output_error_log(error, &req);
  14226. return nullptr;
  14227. }
  14228. }
  14229. // A short body here means either the provider stopped early or the
  14230. // compressor gave up. The branch below reports a failing compressor as
  14231. // Error::Compression, so keep the two distinguishable.
  14232. if (offset < content_length) {
  14233. error = ok ? Error::Write : Error::Compression;
  14234. output_error_log(error, &req);
  14235. return nullptr;
  14236. }
  14237. } else {
  14238. if (!compressor->compress(body, content_length, true,
  14239. [&](const char *data, size_t data_len) {
  14240. req.body.append(data, data_len);
  14241. return true;
  14242. })) {
  14243. error = Error::Compression;
  14244. output_error_log(error, &req);
  14245. return nullptr;
  14246. }
  14247. }
  14248. } else {
  14249. if (content_provider) {
  14250. req.content_length_ = content_length;
  14251. req.content_provider_ = std::move(content_provider);
  14252. req.is_chunked_content_provider_ = false;
  14253. } else if (content_provider_without_length) {
  14254. req.content_length_ = 0;
  14255. req.content_provider_ = detail::ContentProviderAdapter(
  14256. std::move(content_provider_without_length));
  14257. req.is_chunked_content_provider_ = true;
  14258. req.set_header("Transfer-Encoding", "chunked");
  14259. } else {
  14260. req.body.assign(body, content_length);
  14261. }
  14262. }
  14263. if (content_receiver) {
  14264. req.content_receiver =
  14265. [content_receiver](const char *data, size_t data_length,
  14266. size_t /*offset*/, size_t /*total_length*/) {
  14267. return content_receiver(data, data_length);
  14268. };
  14269. }
  14270. auto res = detail::make_unique<Response>();
  14271. return send(req, *res, error) ? std::move(res) : nullptr;
  14272. }
  14273. inline Result ClientImpl::send_with_content_provider_and_receiver(
  14274. const std::string &method, const std::string &path, const Headers &headers,
  14275. const char *body, size_t content_length, ContentProvider content_provider,
  14276. ContentProviderWithoutLength content_provider_without_length,
  14277. const std::string &content_type, ContentReceiver content_receiver,
  14278. UploadProgress progress) {
  14279. Request req;
  14280. req.method = method;
  14281. req.headers = headers;
  14282. req.path = path;
  14283. req.upload_progress = std::move(progress);
  14284. if (max_timeout_msec_ > 0) {
  14285. req.start_time_ = std::chrono::steady_clock::now();
  14286. }
  14287. auto error = Error::Success;
  14288. #ifdef CPPHTTPLIB_SSL_ENABLED
  14289. // Hold the request lock until the Result has read this request's TLS error
  14290. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  14291. #endif
  14292. auto res = send_with_content_provider_and_receiver(
  14293. req, body, content_length, std::move(content_provider),
  14294. std::move(content_provider_without_length), content_type,
  14295. std::move(content_receiver), error);
  14296. #ifdef CPPHTTPLIB_SSL_ENABLED
  14297. return Result{std::move(res), error, std::move(req.headers), last_ssl_error_,
  14298. last_backend_error_};
  14299. #else
  14300. return Result{std::move(res), error, std::move(req.headers)};
  14301. #endif
  14302. }
  14303. inline void ClientImpl::output_log(const Request &req,
  14304. const Response &res) const {
  14305. if (logger_) {
  14306. std::lock_guard<std::mutex> guard(logger_mutex_);
  14307. logger_(req, res);
  14308. }
  14309. }
  14310. inline void ClientImpl::output_error_log(const Error &err,
  14311. const Request *req) const {
  14312. if (error_logger_) {
  14313. std::lock_guard<std::mutex> guard(logger_mutex_);
  14314. error_logger_(err, req);
  14315. }
  14316. }
  14317. inline bool ClientImpl::process_request(Stream &strm, Request &req,
  14318. Response &res, bool close_connection,
  14319. Error &error) {
  14320. // Auto-add Expect: 100-continue for large bodies
  14321. if (CPPHTTPLIB_EXPECT_100_THRESHOLD > 0 && !req.has_header("Expect")) {
  14322. auto body_size = req.body.empty() ? req.content_length_ : req.body.size();
  14323. if (body_size >= CPPHTTPLIB_EXPECT_100_THRESHOLD) {
  14324. req.set_header("Expect", "100-continue");
  14325. }
  14326. }
  14327. // Check for Expect: 100-continue
  14328. auto expect_100_continue =
  14329. detail::has_header_token(req.headers, "Expect", "100-continue");
  14330. // Send request (skip body if using Expect: 100-continue)
  14331. auto rejected_locally = false;
  14332. auto write_request_success =
  14333. write_request(strm, req, close_connection, error, expect_100_continue,
  14334. rejected_locally);
  14335. // A failed write normally still reads the response below, since the server
  14336. // may have answered early (e.g. 413/414) and closed while the body was being
  14337. // sent. A request rejected before any byte reached the socket gets no such
  14338. // response, and waiting for one would block until the read timeout.
  14339. if (rejected_locally) { return false; }
  14340. #ifdef CPPHTTPLIB_SSL_ENABLED
  14341. if (is_ssl() && !expect_100_continue) {
  14342. auto is_proxy_enabled = is_proxy_enabled_for_host(host_);
  14343. if (!is_proxy_enabled) {
  14344. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  14345. error = Error::SSLPeerCouldBeClosed_;
  14346. return false;
  14347. }
  14348. }
  14349. }
  14350. #endif
  14351. // Handle Expect: 100-continue.
  14352. //
  14353. // Wait for an interim/early response by attempting to read the status line
  14354. // under a short timeout, instead of trusting raw socket readability. Over
  14355. // TLS, post-handshake records (e.g. session tickets) make the socket
  14356. // readable without any HTTP response being available; relying on
  14357. // `select_read` there caused the body to be withheld forever and the
  14358. // request to fail with `Read` (#2458). If no status line arrives within the
  14359. // timeout, send the body anyway (matching curl's behavior).
  14360. auto status_line_read = false;
  14361. if (expect_100_continue && write_request_success) {
  14362. if (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND > 0) {
  14363. time_t sec = CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND / 1000;
  14364. time_t usec = (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND % 1000) * 1000;
  14365. strm.set_read_timeout(sec, usec);
  14366. status_line_read = read_response_line(strm, req, res, false);
  14367. strm.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  14368. }
  14369. if (!status_line_read) {
  14370. // No interim response within the timeout: send the body and handle the
  14371. // response as usual.
  14372. if (!write_request_body(strm, req, error)) { return false; }
  14373. expect_100_continue = false; // Switch to normal response handling
  14374. }
  14375. }
  14376. // Receive response and headers
  14377. // When using Expect: 100-continue, don't auto-skip `100 Continue` response
  14378. if ((!status_line_read &&
  14379. !read_response_line(strm, req, res, !expect_100_continue)) ||
  14380. !detail::read_headers(strm, res.headers)) {
  14381. if (write_request_success) { error = Error::Read; }
  14382. return false;
  14383. }
  14384. if (!write_request_success) { return false; }
  14385. // Handle Expect: 100-continue response
  14386. if (expect_100_continue) {
  14387. if (res.status == StatusCode::Continue_100) {
  14388. // Server accepted, send the body
  14389. if (!write_request_body(strm, req, error)) { return false; }
  14390. // Read the actual response
  14391. res.headers.clear();
  14392. res.body.clear();
  14393. if (!read_response_line(strm, req, res) ||
  14394. !detail::read_headers(strm, res.headers)) {
  14395. error = Error::Read;
  14396. return false;
  14397. }
  14398. } else {
  14399. // A final response came first, so the body this request declared was
  14400. // never sent, and the server may still be waiting for it. The
  14401. // connection cannot carry another request.
  14402. std::lock_guard<std::mutex> guard(socket_mutex_);
  14403. socket_should_be_closed_when_request_is_done_ = true;
  14404. }
  14405. }
  14406. // Body
  14407. if ((res.status != StatusCode::NoContent_204) && req.method != "HEAD" &&
  14408. req.method != "CONNECT") {
  14409. // Reject ambiguous framing (RFC 9112 §6.3). Unlike a request, a response
  14410. // whose final transfer coding is not chunked is not ambiguous: its body
  14411. // runs until the server closes the connection, so it is not rejected.
  14412. // HEAD/204 are excluded above and a 304 carries no body.
  14413. if (res.status != StatusCode::NotModified_304) {
  14414. if (detail::has_conflicting_content_length(res.headers)) {
  14415. error = Error::Read;
  14416. return false;
  14417. }
  14418. if (detail::has_faulty_transfer_encoding(res)) {
  14419. std::lock_guard<std::mutex> guard(socket_mutex_);
  14420. socket_should_be_closed_when_request_is_done_ = true;
  14421. }
  14422. }
  14423. auto redirect = follow_location_ && detail::is_redirect(res) &&
  14424. res.status != StatusCode::NotModified_304;
  14425. if (req.response_handler && !redirect) {
  14426. if (!req.response_handler(res)) {
  14427. error = Error::Canceled;
  14428. return false;
  14429. }
  14430. }
  14431. auto out =
  14432. req.content_receiver
  14433. ? static_cast<ContentReceiverWithProgress>(
  14434. [&](const char *buf, size_t n, size_t off, size_t len) {
  14435. if (redirect) { return true; }
  14436. auto ret = req.content_receiver(buf, n, off, len);
  14437. if (!ret) { error = Error::Canceled; }
  14438. return ret;
  14439. })
  14440. : static_cast<ContentReceiverWithProgress>(
  14441. [&](const char *buf, size_t n, size_t /*off*/,
  14442. size_t /*len*/) {
  14443. assert(res.body.size() + n <= res.body.max_size());
  14444. if (payload_max_length_ > 0 &&
  14445. (res.body.size() >= payload_max_length_ ||
  14446. n > payload_max_length_ - res.body.size())) {
  14447. return false;
  14448. }
  14449. res.body.append(buf, n);
  14450. return true;
  14451. });
  14452. auto progress = [&](size_t current, size_t total) {
  14453. if (!req.download_progress || redirect) { return true; }
  14454. auto ret = req.download_progress(current, total);
  14455. if (!ret) { error = Error::Canceled; }
  14456. return ret;
  14457. };
  14458. if (res.has_header("Content-Length")) {
  14459. if (!req.content_receiver) {
  14460. auto len = res.get_header_value_u64("Content-Length");
  14461. if (len > res.body.max_size()) {
  14462. error = Error::Read;
  14463. return false;
  14464. }
  14465. // Content-Length is only the server's claim, so reserve no more than
  14466. // payload_max_length_ allows, nor more than 1 MiB before any of the
  14467. // body has arrived. A longer body grows as it is read.
  14468. auto reserve_len =
  14469. (std::min)(static_cast<size_t>(len), size_t(1024 * 1024));
  14470. if (payload_max_length_ > 0) {
  14471. reserve_len = (std::min)(reserve_len, payload_max_length_);
  14472. }
  14473. res.body.reserve(reserve_len);
  14474. }
  14475. }
  14476. if (res.status != StatusCode::NotModified_304) {
  14477. auto content_status = 0;
  14478. auto max_length = (!has_payload_max_length_ && req.content_receiver)
  14479. ? (std::numeric_limits<size_t>::max)()
  14480. : payload_max_length_;
  14481. if (!detail::read_content(strm, res, max_length, content_status,
  14482. std::move(progress), std::move(out),
  14483. decompress_)) {
  14484. if (error != Error::Canceled) {
  14485. // Tell the caller apart from a plain read failure when the body was
  14486. // over the payload limit or could not be decoded because of its
  14487. // Content-Encoding.
  14488. switch (content_status) {
  14489. case StatusCode::PayloadTooLarge_413:
  14490. error = Error::ExceedMaxPayloadSize;
  14491. break;
  14492. case StatusCode::UnsupportedMediaType_415:
  14493. error = Error::UnsupportedContentEncoding;
  14494. break;
  14495. case StatusCode::InternalServerError_500:
  14496. error = Error::Compression;
  14497. break;
  14498. default: error = Error::Read; break;
  14499. }
  14500. }
  14501. return false;
  14502. }
  14503. }
  14504. }
  14505. // Log
  14506. output_log(req, res);
  14507. return true;
  14508. }
  14509. inline ContentProviderWithoutLength ClientImpl::get_multipart_content_provider(
  14510. const std::string &boundary, const UploadFormDataItems &items,
  14511. const FormDataProviderItems &provider_items) const {
  14512. size_t cur_item = 0;
  14513. size_t cur_start = 0;
  14514. // cur_item and cur_start are copied to within the std::function and
  14515. // maintain state between successive calls
  14516. return [&, cur_item, cur_start](size_t offset,
  14517. DataSink &sink) mutable -> bool {
  14518. if (!offset && !items.empty()) {
  14519. sink.os << detail::serialize_multipart_formdata(items, boundary, false);
  14520. return true;
  14521. } else if (cur_item < provider_items.size()) {
  14522. if (!cur_start) {
  14523. const auto &begin = detail::serialize_multipart_formdata_item_begin(
  14524. provider_items[cur_item], boundary);
  14525. offset += begin.size();
  14526. cur_start = offset;
  14527. sink.os << begin;
  14528. }
  14529. DataSink cur_sink;
  14530. auto has_data = true;
  14531. cur_sink.write = sink.write;
  14532. // Forward is_writable so a provider item asking whether it may keep
  14533. // going gets the outer sink's answer rather than the default `true`.
  14534. cur_sink.is_writable = sink.is_writable;
  14535. cur_sink.done = [&]() { has_data = false; };
  14536. if (!provider_items[cur_item].provider(offset - cur_start, cur_sink)) {
  14537. return false;
  14538. }
  14539. if (!has_data) {
  14540. sink.os << detail::serialize_multipart_formdata_item_end();
  14541. cur_item++;
  14542. cur_start = 0;
  14543. }
  14544. return true;
  14545. } else {
  14546. sink.os << detail::serialize_multipart_formdata_finish(boundary);
  14547. sink.done();
  14548. return true;
  14549. }
  14550. };
  14551. }
  14552. inline bool ClientImpl::process_socket(
  14553. const Socket &socket,
  14554. std::chrono::time_point<std::chrono::steady_clock> start_time,
  14555. std::function<bool(Stream &strm)> callback) {
  14556. return detail::process_client_socket(
  14557. socket.sock, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  14558. write_timeout_usec_, max_timeout_msec_, start_time, std::move(callback));
  14559. }
  14560. inline bool ClientImpl::is_ssl() const { return false; }
  14561. inline Result ClientImpl::Get(const std::string &path,
  14562. DownloadProgress progress) {
  14563. return Get(path, Headers(), std::move(progress));
  14564. }
  14565. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14566. DownloadProgress progress) {
  14567. return Get(path, params, Headers(), std::move(progress));
  14568. }
  14569. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14570. const Headers &headers,
  14571. DownloadProgress progress) {
  14572. if (params.empty()) { return Get(path, headers); }
  14573. std::string path_with_query = append_query_params(path, params);
  14574. return Get(path_with_query, headers, std::move(progress));
  14575. }
  14576. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14577. DownloadProgress progress) {
  14578. Request req;
  14579. req.method = "GET";
  14580. req.path = path;
  14581. req.headers = headers;
  14582. req.download_progress = std::move(progress);
  14583. if (max_timeout_msec_ > 0) {
  14584. req.start_time_ = std::chrono::steady_clock::now();
  14585. }
  14586. return send_(std::move(req));
  14587. }
  14588. inline Result ClientImpl::Get(const std::string &path,
  14589. ContentReceiver content_receiver,
  14590. DownloadProgress progress) {
  14591. return Get(path, Headers(), nullptr, std::move(content_receiver),
  14592. std::move(progress));
  14593. }
  14594. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  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,
  14601. ResponseHandler response_handler,
  14602. ContentReceiver content_receiver,
  14603. DownloadProgress progress) {
  14604. return Get(path, Headers(), std::move(response_handler),
  14605. std::move(content_receiver), std::move(progress));
  14606. }
  14607. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14608. ResponseHandler response_handler,
  14609. ContentReceiver content_receiver,
  14610. DownloadProgress progress) {
  14611. Request req;
  14612. req.method = "GET";
  14613. req.path = path;
  14614. req.headers = headers;
  14615. req.response_handler = std::move(response_handler);
  14616. req.content_receiver =
  14617. [content_receiver](const char *data, size_t data_length,
  14618. size_t /*offset*/, size_t /*total_length*/) {
  14619. return content_receiver(data, data_length);
  14620. };
  14621. req.download_progress = std::move(progress);
  14622. if (max_timeout_msec_ > 0) {
  14623. req.start_time_ = std::chrono::steady_clock::now();
  14624. }
  14625. return send_(std::move(req));
  14626. }
  14627. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14628. const Headers &headers,
  14629. ContentReceiver content_receiver,
  14630. DownloadProgress progress) {
  14631. return Get(path, params, headers, nullptr, std::move(content_receiver),
  14632. std::move(progress));
  14633. }
  14634. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14635. const Headers &headers,
  14636. ResponseHandler response_handler,
  14637. ContentReceiver content_receiver,
  14638. DownloadProgress progress) {
  14639. if (params.empty()) {
  14640. return Get(path, headers, std::move(response_handler),
  14641. std::move(content_receiver), std::move(progress));
  14642. }
  14643. std::string path_with_query = append_query_params(path, params);
  14644. return Get(path_with_query, headers, std::move(response_handler),
  14645. std::move(content_receiver), std::move(progress));
  14646. }
  14647. inline Result ClientImpl::Head(const std::string &path) {
  14648. return Head(path, Headers());
  14649. }
  14650. inline Result ClientImpl::Head(const std::string &path,
  14651. const Headers &headers) {
  14652. Request req;
  14653. req.method = "HEAD";
  14654. req.headers = headers;
  14655. req.path = path;
  14656. if (max_timeout_msec_ > 0) {
  14657. req.start_time_ = std::chrono::steady_clock::now();
  14658. }
  14659. return send_(std::move(req));
  14660. }
  14661. inline Result ClientImpl::Post(const std::string &path) {
  14662. return Post(path, std::string(), std::string());
  14663. }
  14664. inline Result ClientImpl::Post(const std::string &path,
  14665. const Headers &headers) {
  14666. return Post(path, headers, nullptr, 0, std::string());
  14667. }
  14668. inline Result ClientImpl::Post(const std::string &path, const char *body,
  14669. size_t content_length,
  14670. const std::string &content_type,
  14671. UploadProgress progress) {
  14672. return Post(path, Headers(), body, content_length, content_type, progress);
  14673. }
  14674. inline Result ClientImpl::Post(const std::string &path, const std::string &body,
  14675. const std::string &content_type,
  14676. UploadProgress progress) {
  14677. return Post(path, Headers(), body, content_type, progress);
  14678. }
  14679. inline Result ClientImpl::Post(const std::string &path, const Params &params) {
  14680. return Post(path, Headers(), params);
  14681. }
  14682. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14683. ContentProvider content_provider,
  14684. const std::string &content_type,
  14685. UploadProgress progress) {
  14686. return Post(path, Headers(), content_length, std::move(content_provider),
  14687. content_type, progress);
  14688. }
  14689. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14690. ContentProvider content_provider,
  14691. const std::string &content_type,
  14692. ContentReceiver content_receiver,
  14693. UploadProgress progress) {
  14694. return Post(path, Headers(), content_length, std::move(content_provider),
  14695. content_type, std::move(content_receiver), progress);
  14696. }
  14697. inline Result ClientImpl::Post(const std::string &path,
  14698. ContentProviderWithoutLength content_provider,
  14699. const std::string &content_type,
  14700. UploadProgress progress) {
  14701. return Post(path, Headers(), std::move(content_provider), content_type,
  14702. progress);
  14703. }
  14704. inline Result ClientImpl::Post(const std::string &path,
  14705. ContentProviderWithoutLength content_provider,
  14706. const std::string &content_type,
  14707. ContentReceiver content_receiver,
  14708. UploadProgress progress) {
  14709. return Post(path, Headers(), std::move(content_provider), content_type,
  14710. std::move(content_receiver), progress);
  14711. }
  14712. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14713. const Params &params) {
  14714. auto query = detail::params_to_query_str(params);
  14715. return Post(path, headers, query, "application/x-www-form-urlencoded");
  14716. }
  14717. inline Result ClientImpl::Post(const std::string &path,
  14718. const UploadFormDataItems &items,
  14719. UploadProgress progress) {
  14720. return Post(path, Headers(), items, progress);
  14721. }
  14722. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14723. const UploadFormDataItems &items,
  14724. UploadProgress progress) {
  14725. const auto &boundary = detail::make_multipart_data_boundary();
  14726. const auto &content_type =
  14727. detail::serialize_multipart_formdata_get_content_type(boundary);
  14728. auto content_length = detail::get_multipart_content_length(items, boundary);
  14729. return Post(path, headers, content_length,
  14730. detail::make_multipart_content_provider(items, boundary),
  14731. content_type, progress);
  14732. }
  14733. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14734. const UploadFormDataItems &items,
  14735. const std::string &boundary,
  14736. UploadProgress progress) {
  14737. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14738. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14739. }
  14740. const auto &content_type =
  14741. detail::serialize_multipart_formdata_get_content_type(boundary);
  14742. auto content_length = detail::get_multipart_content_length(items, boundary);
  14743. return Post(path, headers, content_length,
  14744. detail::make_multipart_content_provider(items, boundary),
  14745. content_type, progress);
  14746. }
  14747. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14748. const char *body, size_t content_length,
  14749. const std::string &content_type,
  14750. UploadProgress progress) {
  14751. return send_with_content_provider_and_receiver(
  14752. "POST", path, headers, body, content_length, nullptr, nullptr,
  14753. content_type, nullptr, progress);
  14754. }
  14755. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14756. const std::string &body,
  14757. const std::string &content_type,
  14758. UploadProgress progress) {
  14759. return send_with_content_provider_and_receiver(
  14760. "POST", path, headers, body.data(), body.size(), nullptr, nullptr,
  14761. content_type, nullptr, progress);
  14762. }
  14763. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14764. size_t content_length,
  14765. ContentProvider content_provider,
  14766. const std::string &content_type,
  14767. UploadProgress progress) {
  14768. return send_with_content_provider_and_receiver(
  14769. "POST", path, headers, nullptr, content_length,
  14770. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14771. }
  14772. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14773. size_t content_length,
  14774. ContentProvider content_provider,
  14775. const std::string &content_type,
  14776. ContentReceiver content_receiver,
  14777. DownloadProgress progress) {
  14778. return send_with_content_provider_and_receiver(
  14779. "POST", path, headers, nullptr, content_length,
  14780. std::move(content_provider), nullptr, content_type,
  14781. std::move(content_receiver), std::move(progress));
  14782. }
  14783. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14784. ContentProviderWithoutLength content_provider,
  14785. const std::string &content_type,
  14786. UploadProgress progress) {
  14787. return send_with_content_provider_and_receiver(
  14788. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14789. content_type, nullptr, progress);
  14790. }
  14791. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14792. ContentProviderWithoutLength content_provider,
  14793. const std::string &content_type,
  14794. ContentReceiver content_receiver,
  14795. DownloadProgress progress) {
  14796. return send_with_content_provider_and_receiver(
  14797. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14798. content_type, std::move(content_receiver), std::move(progress));
  14799. }
  14800. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14801. const UploadFormDataItems &items,
  14802. const FormDataProviderItems &provider_items,
  14803. UploadProgress progress) {
  14804. const auto &boundary = detail::make_multipart_data_boundary();
  14805. const auto &content_type =
  14806. detail::serialize_multipart_formdata_get_content_type(boundary);
  14807. return send_with_content_provider_and_receiver(
  14808. "POST", path, headers, nullptr, 0, nullptr,
  14809. get_multipart_content_provider(boundary, items, provider_items),
  14810. content_type, nullptr, progress);
  14811. }
  14812. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14813. const std::string &body,
  14814. const std::string &content_type,
  14815. ContentReceiver content_receiver,
  14816. DownloadProgress progress) {
  14817. Request req;
  14818. req.method = "POST";
  14819. req.path = path;
  14820. req.headers = headers;
  14821. req.body = body;
  14822. req.content_receiver =
  14823. [content_receiver](const char *data, size_t data_length,
  14824. size_t /*offset*/, size_t /*total_length*/) {
  14825. return content_receiver(data, data_length);
  14826. };
  14827. req.download_progress = std::move(progress);
  14828. if (max_timeout_msec_ > 0) {
  14829. req.start_time_ = std::chrono::steady_clock::now();
  14830. }
  14831. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14832. return send_(std::move(req));
  14833. }
  14834. inline Result ClientImpl::Put(const std::string &path) {
  14835. return Put(path, std::string(), std::string());
  14836. }
  14837. inline Result ClientImpl::Put(const std::string &path, const Headers &headers) {
  14838. return Put(path, headers, nullptr, 0, std::string());
  14839. }
  14840. inline Result ClientImpl::Put(const std::string &path, const char *body,
  14841. size_t content_length,
  14842. const std::string &content_type,
  14843. UploadProgress progress) {
  14844. return Put(path, Headers(), body, content_length, content_type, progress);
  14845. }
  14846. inline Result ClientImpl::Put(const std::string &path, const std::string &body,
  14847. const std::string &content_type,
  14848. UploadProgress progress) {
  14849. return Put(path, Headers(), body, content_type, progress);
  14850. }
  14851. inline Result ClientImpl::Put(const std::string &path, const Params &params) {
  14852. return Put(path, Headers(), params);
  14853. }
  14854. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14855. ContentProvider content_provider,
  14856. const std::string &content_type,
  14857. UploadProgress progress) {
  14858. return Put(path, Headers(), content_length, std::move(content_provider),
  14859. content_type, progress);
  14860. }
  14861. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14862. ContentProvider content_provider,
  14863. const std::string &content_type,
  14864. ContentReceiver content_receiver,
  14865. UploadProgress progress) {
  14866. return Put(path, Headers(), content_length, std::move(content_provider),
  14867. content_type, std::move(content_receiver), progress);
  14868. }
  14869. inline Result ClientImpl::Put(const std::string &path,
  14870. ContentProviderWithoutLength content_provider,
  14871. const std::string &content_type,
  14872. UploadProgress progress) {
  14873. return Put(path, Headers(), std::move(content_provider), content_type,
  14874. progress);
  14875. }
  14876. inline Result ClientImpl::Put(const std::string &path,
  14877. ContentProviderWithoutLength content_provider,
  14878. const std::string &content_type,
  14879. ContentReceiver content_receiver,
  14880. UploadProgress progress) {
  14881. return Put(path, Headers(), std::move(content_provider), content_type,
  14882. std::move(content_receiver), progress);
  14883. }
  14884. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14885. const Params &params) {
  14886. auto query = detail::params_to_query_str(params);
  14887. return Put(path, headers, query, "application/x-www-form-urlencoded");
  14888. }
  14889. inline Result ClientImpl::Put(const std::string &path,
  14890. const UploadFormDataItems &items,
  14891. UploadProgress progress) {
  14892. return Put(path, Headers(), items, progress);
  14893. }
  14894. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14895. const UploadFormDataItems &items,
  14896. UploadProgress progress) {
  14897. const auto &boundary = detail::make_multipart_data_boundary();
  14898. const auto &content_type =
  14899. detail::serialize_multipart_formdata_get_content_type(boundary);
  14900. auto content_length = detail::get_multipart_content_length(items, boundary);
  14901. return Put(path, headers, content_length,
  14902. detail::make_multipart_content_provider(items, boundary),
  14903. content_type, progress);
  14904. }
  14905. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14906. const UploadFormDataItems &items,
  14907. const std::string &boundary,
  14908. UploadProgress progress) {
  14909. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14910. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14911. }
  14912. const auto &content_type =
  14913. detail::serialize_multipart_formdata_get_content_type(boundary);
  14914. auto content_length = detail::get_multipart_content_length(items, boundary);
  14915. return Put(path, headers, content_length,
  14916. detail::make_multipart_content_provider(items, boundary),
  14917. content_type, progress);
  14918. }
  14919. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14920. const char *body, size_t content_length,
  14921. const std::string &content_type,
  14922. UploadProgress progress) {
  14923. return send_with_content_provider_and_receiver(
  14924. "PUT", path, headers, body, content_length, nullptr, nullptr,
  14925. content_type, nullptr, progress);
  14926. }
  14927. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14928. const std::string &body,
  14929. const std::string &content_type,
  14930. UploadProgress progress) {
  14931. return send_with_content_provider_and_receiver(
  14932. "PUT", path, headers, body.data(), body.size(), nullptr, nullptr,
  14933. content_type, nullptr, progress);
  14934. }
  14935. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14936. size_t content_length,
  14937. ContentProvider content_provider,
  14938. const std::string &content_type,
  14939. UploadProgress progress) {
  14940. return send_with_content_provider_and_receiver(
  14941. "PUT", path, headers, nullptr, content_length,
  14942. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14943. }
  14944. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14945. size_t content_length,
  14946. ContentProvider content_provider,
  14947. const std::string &content_type,
  14948. ContentReceiver content_receiver,
  14949. UploadProgress progress) {
  14950. return send_with_content_provider_and_receiver(
  14951. "PUT", path, headers, nullptr, content_length,
  14952. std::move(content_provider), nullptr, content_type,
  14953. std::move(content_receiver), progress);
  14954. }
  14955. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14956. ContentProviderWithoutLength content_provider,
  14957. const std::string &content_type,
  14958. UploadProgress progress) {
  14959. return send_with_content_provider_and_receiver(
  14960. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14961. content_type, nullptr, progress);
  14962. }
  14963. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14964. ContentProviderWithoutLength content_provider,
  14965. const std::string &content_type,
  14966. ContentReceiver content_receiver,
  14967. UploadProgress progress) {
  14968. return send_with_content_provider_and_receiver(
  14969. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14970. content_type, std::move(content_receiver), progress);
  14971. }
  14972. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14973. const UploadFormDataItems &items,
  14974. const FormDataProviderItems &provider_items,
  14975. UploadProgress progress) {
  14976. const auto &boundary = detail::make_multipart_data_boundary();
  14977. const auto &content_type =
  14978. detail::serialize_multipart_formdata_get_content_type(boundary);
  14979. return send_with_content_provider_and_receiver(
  14980. "PUT", path, headers, nullptr, 0, nullptr,
  14981. get_multipart_content_provider(boundary, items, provider_items),
  14982. content_type, nullptr, progress);
  14983. }
  14984. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14985. const std::string &body,
  14986. const std::string &content_type,
  14987. ContentReceiver content_receiver,
  14988. DownloadProgress progress) {
  14989. Request req;
  14990. req.method = "PUT";
  14991. req.path = path;
  14992. req.headers = headers;
  14993. req.body = body;
  14994. req.content_receiver =
  14995. [content_receiver](const char *data, size_t data_length,
  14996. size_t /*offset*/, size_t /*total_length*/) {
  14997. return content_receiver(data, data_length);
  14998. };
  14999. req.download_progress = std::move(progress);
  15000. if (max_timeout_msec_ > 0) {
  15001. req.start_time_ = std::chrono::steady_clock::now();
  15002. }
  15003. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15004. return send_(std::move(req));
  15005. }
  15006. inline Result ClientImpl::Patch(const std::string &path) {
  15007. return Patch(path, std::string(), std::string());
  15008. }
  15009. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15010. UploadProgress progress) {
  15011. return Patch(path, headers, nullptr, 0, std::string(), progress);
  15012. }
  15013. inline Result ClientImpl::Patch(const std::string &path, const char *body,
  15014. size_t content_length,
  15015. const std::string &content_type,
  15016. UploadProgress progress) {
  15017. return Patch(path, Headers(), body, content_length, content_type, progress);
  15018. }
  15019. inline Result ClientImpl::Patch(const std::string &path,
  15020. const std::string &body,
  15021. const std::string &content_type,
  15022. UploadProgress progress) {
  15023. return Patch(path, Headers(), body, content_type, progress);
  15024. }
  15025. inline Result ClientImpl::Patch(const std::string &path, const Params &params) {
  15026. return Patch(path, Headers(), params);
  15027. }
  15028. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  15029. ContentProvider content_provider,
  15030. const std::string &content_type,
  15031. UploadProgress progress) {
  15032. return Patch(path, Headers(), content_length, std::move(content_provider),
  15033. content_type, progress);
  15034. }
  15035. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  15036. ContentProvider content_provider,
  15037. const std::string &content_type,
  15038. ContentReceiver content_receiver,
  15039. UploadProgress progress) {
  15040. return Patch(path, Headers(), content_length, std::move(content_provider),
  15041. content_type, std::move(content_receiver), progress);
  15042. }
  15043. inline Result ClientImpl::Patch(const std::string &path,
  15044. ContentProviderWithoutLength content_provider,
  15045. const std::string &content_type,
  15046. UploadProgress progress) {
  15047. return Patch(path, Headers(), std::move(content_provider), content_type,
  15048. progress);
  15049. }
  15050. inline Result ClientImpl::Patch(const std::string &path,
  15051. ContentProviderWithoutLength content_provider,
  15052. const std::string &content_type,
  15053. ContentReceiver content_receiver,
  15054. UploadProgress progress) {
  15055. return Patch(path, Headers(), std::move(content_provider), content_type,
  15056. std::move(content_receiver), progress);
  15057. }
  15058. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15059. const Params &params) {
  15060. auto query = detail::params_to_query_str(params);
  15061. return Patch(path, headers, query, "application/x-www-form-urlencoded");
  15062. }
  15063. inline Result ClientImpl::Patch(const std::string &path,
  15064. const UploadFormDataItems &items,
  15065. UploadProgress progress) {
  15066. return Patch(path, Headers(), items, progress);
  15067. }
  15068. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15069. const UploadFormDataItems &items,
  15070. UploadProgress progress) {
  15071. const auto &boundary = detail::make_multipart_data_boundary();
  15072. const auto &content_type =
  15073. detail::serialize_multipart_formdata_get_content_type(boundary);
  15074. auto content_length = detail::get_multipart_content_length(items, boundary);
  15075. return Patch(path, headers, content_length,
  15076. detail::make_multipart_content_provider(items, boundary),
  15077. content_type, progress);
  15078. }
  15079. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15080. const UploadFormDataItems &items,
  15081. const std::string &boundary,
  15082. UploadProgress progress) {
  15083. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  15084. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  15085. }
  15086. const auto &content_type =
  15087. detail::serialize_multipart_formdata_get_content_type(boundary);
  15088. auto content_length = detail::get_multipart_content_length(items, boundary);
  15089. return Patch(path, headers, content_length,
  15090. detail::make_multipart_content_provider(items, boundary),
  15091. content_type, progress);
  15092. }
  15093. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15094. const char *body, size_t content_length,
  15095. const std::string &content_type,
  15096. UploadProgress progress) {
  15097. return send_with_content_provider_and_receiver(
  15098. "PATCH", path, headers, body, content_length, nullptr, nullptr,
  15099. content_type, nullptr, progress);
  15100. }
  15101. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15102. const std::string &body,
  15103. const std::string &content_type,
  15104. UploadProgress progress) {
  15105. return send_with_content_provider_and_receiver(
  15106. "PATCH", path, headers, body.data(), body.size(), nullptr, nullptr,
  15107. content_type, nullptr, progress);
  15108. }
  15109. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15110. size_t content_length,
  15111. ContentProvider content_provider,
  15112. const std::string &content_type,
  15113. UploadProgress progress) {
  15114. return send_with_content_provider_and_receiver(
  15115. "PATCH", path, headers, nullptr, content_length,
  15116. std::move(content_provider), nullptr, content_type, nullptr, progress);
  15117. }
  15118. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15119. size_t content_length,
  15120. ContentProvider content_provider,
  15121. const std::string &content_type,
  15122. ContentReceiver content_receiver,
  15123. UploadProgress progress) {
  15124. return send_with_content_provider_and_receiver(
  15125. "PATCH", path, headers, nullptr, content_length,
  15126. std::move(content_provider), nullptr, content_type,
  15127. std::move(content_receiver), progress);
  15128. }
  15129. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15130. ContentProviderWithoutLength content_provider,
  15131. const std::string &content_type,
  15132. UploadProgress progress) {
  15133. return send_with_content_provider_and_receiver(
  15134. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15135. content_type, nullptr, progress);
  15136. }
  15137. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15138. ContentProviderWithoutLength content_provider,
  15139. const std::string &content_type,
  15140. ContentReceiver content_receiver,
  15141. UploadProgress progress) {
  15142. return send_with_content_provider_and_receiver(
  15143. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15144. content_type, std::move(content_receiver), progress);
  15145. }
  15146. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15147. const UploadFormDataItems &items,
  15148. const FormDataProviderItems &provider_items,
  15149. UploadProgress progress) {
  15150. const auto &boundary = detail::make_multipart_data_boundary();
  15151. const auto &content_type =
  15152. detail::serialize_multipart_formdata_get_content_type(boundary);
  15153. return send_with_content_provider_and_receiver(
  15154. "PATCH", path, headers, nullptr, 0, nullptr,
  15155. get_multipart_content_provider(boundary, items, provider_items),
  15156. content_type, nullptr, progress);
  15157. }
  15158. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15159. const std::string &body,
  15160. const std::string &content_type,
  15161. ContentReceiver content_receiver,
  15162. DownloadProgress progress) {
  15163. Request req;
  15164. req.method = "PATCH";
  15165. req.path = path;
  15166. req.headers = headers;
  15167. req.body = body;
  15168. req.content_receiver =
  15169. [content_receiver](const char *data, size_t data_length,
  15170. size_t /*offset*/, size_t /*total_length*/) {
  15171. return content_receiver(data, data_length);
  15172. };
  15173. req.download_progress = std::move(progress);
  15174. if (max_timeout_msec_ > 0) {
  15175. req.start_time_ = std::chrono::steady_clock::now();
  15176. }
  15177. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15178. return send_(std::move(req));
  15179. }
  15180. inline Result ClientImpl::Delete(const std::string &path,
  15181. DownloadProgress progress) {
  15182. return Delete(path, Headers(), std::string(), std::string(), progress);
  15183. }
  15184. inline Result ClientImpl::Delete(const std::string &path,
  15185. const Headers &headers,
  15186. DownloadProgress progress) {
  15187. return Delete(path, headers, std::string(), std::string(), progress);
  15188. }
  15189. inline Result ClientImpl::Delete(const std::string &path, const char *body,
  15190. size_t content_length,
  15191. const std::string &content_type,
  15192. DownloadProgress progress) {
  15193. return Delete(path, Headers(), body, content_length, content_type, progress);
  15194. }
  15195. inline Result ClientImpl::Delete(const std::string &path,
  15196. const std::string &body,
  15197. const std::string &content_type,
  15198. DownloadProgress progress) {
  15199. return Delete(path, Headers(), body.data(), body.size(), content_type,
  15200. progress);
  15201. }
  15202. inline Result ClientImpl::Delete(const std::string &path,
  15203. const Headers &headers,
  15204. const std::string &body,
  15205. const std::string &content_type,
  15206. DownloadProgress progress) {
  15207. return Delete(path, headers, body.data(), body.size(), content_type,
  15208. progress);
  15209. }
  15210. inline Result ClientImpl::Delete(const std::string &path, const Params &params,
  15211. DownloadProgress progress) {
  15212. return Delete(path, Headers(), params, progress);
  15213. }
  15214. inline Result ClientImpl::Delete(const std::string &path,
  15215. const Headers &headers, const Params &params,
  15216. DownloadProgress progress) {
  15217. auto query = detail::params_to_query_str(params);
  15218. return Delete(path, headers, query, "application/x-www-form-urlencoded",
  15219. progress);
  15220. }
  15221. inline Result ClientImpl::Delete(const std::string &path,
  15222. const Headers &headers, const char *body,
  15223. size_t content_length,
  15224. const std::string &content_type,
  15225. DownloadProgress progress) {
  15226. Request req;
  15227. req.method = "DELETE";
  15228. req.headers = headers;
  15229. req.path = path;
  15230. req.download_progress = std::move(progress);
  15231. if (max_timeout_msec_ > 0) {
  15232. req.start_time_ = std::chrono::steady_clock::now();
  15233. }
  15234. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15235. req.body.assign(body, content_length);
  15236. return send_(std::move(req));
  15237. }
  15238. inline Result ClientImpl::Options(const std::string &path) {
  15239. return Options(path, Headers());
  15240. }
  15241. inline Result ClientImpl::Options(const std::string &path,
  15242. const Headers &headers) {
  15243. Request req;
  15244. req.method = "OPTIONS";
  15245. req.headers = headers;
  15246. req.path = path;
  15247. if (max_timeout_msec_ > 0) {
  15248. req.start_time_ = std::chrono::steady_clock::now();
  15249. }
  15250. return send_(std::move(req));
  15251. }
  15252. inline void ClientImpl::stop() {
  15253. std::lock_guard<std::mutex> guard(socket_mutex_);
  15254. // If there is anything ongoing right now, the ONLY thread-safe thing we can
  15255. // do is to shutdown_socket, so that threads using this socket suddenly
  15256. // discover they can't read/write any more and error out. Everything else
  15257. // (closing the socket, shutting ssl down) is unsafe because these actions
  15258. // are not thread-safe.
  15259. if (socket_requests_in_flight_ > 0) {
  15260. shutdown_socket(socket_);
  15261. // Aside from that, we set a flag for the socket to be closed when we're
  15262. // done.
  15263. socket_should_be_closed_when_request_is_done_ = true;
  15264. return;
  15265. }
  15266. disconnect(/*gracefully=*/true);
  15267. }
  15268. inline std::string ClientImpl::host() const { return host_; }
  15269. inline int ClientImpl::port() const { return port_; }
  15270. inline size_t ClientImpl::is_socket_open() const {
  15271. std::lock_guard<std::mutex> guard(socket_mutex_);
  15272. return socket_.is_open();
  15273. }
  15274. inline socket_t ClientImpl::socket() const { return socket_.sock; }
  15275. inline void ClientImpl::set_connection_timeout(time_t sec, time_t usec) {
  15276. connection_timeout_sec_ = sec;
  15277. connection_timeout_usec_ = usec;
  15278. }
  15279. inline void ClientImpl::set_read_timeout(time_t sec, time_t usec) {
  15280. read_timeout_sec_ = sec;
  15281. read_timeout_usec_ = usec;
  15282. }
  15283. inline void ClientImpl::set_write_timeout(time_t sec, time_t usec) {
  15284. write_timeout_sec_ = sec;
  15285. write_timeout_usec_ = usec;
  15286. }
  15287. inline void ClientImpl::set_max_timeout(time_t msec) {
  15288. max_timeout_msec_ = msec;
  15289. }
  15290. inline void ClientImpl::set_basic_auth(const std::string &username,
  15291. const std::string &password) {
  15292. basic_auth_username_ = username;
  15293. basic_auth_password_ = password;
  15294. }
  15295. inline void ClientImpl::set_bearer_token_auth(const std::string &token) {
  15296. bearer_token_auth_token_ = token;
  15297. }
  15298. inline void ClientImpl::set_keep_alive(bool on) { keep_alive_ = on; }
  15299. inline void ClientImpl::set_follow_location(bool on) { follow_location_ = on; }
  15300. inline void ClientImpl::set_path_encode(bool on) { path_encode_ = on; }
  15301. inline void
  15302. ClientImpl::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15303. addr_map_ = std::move(addr_map);
  15304. }
  15305. inline void ClientImpl::set_default_headers(Headers headers) {
  15306. default_headers_ = std::move(headers);
  15307. }
  15308. inline void ClientImpl::set_header_writer(
  15309. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15310. header_writer_ = writer;
  15311. }
  15312. inline void ClientImpl::set_address_family(int family) {
  15313. address_family_ = family;
  15314. }
  15315. inline void ClientImpl::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  15316. inline void ClientImpl::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  15317. inline void ClientImpl::set_socket_options(SocketOptions socket_options) {
  15318. socket_options_ = std::move(socket_options);
  15319. }
  15320. inline void ClientImpl::set_compress(bool on) { compress_ = on; }
  15321. inline void ClientImpl::set_decompress(bool on) { decompress_ = on; }
  15322. inline void ClientImpl::set_payload_max_length(size_t length) {
  15323. payload_max_length_ = length;
  15324. has_payload_max_length_ = true;
  15325. }
  15326. inline void ClientImpl::set_interface(const std::string &intf) {
  15327. interface_ = intf;
  15328. }
  15329. inline void ClientImpl::set_proxy(const std::string &host, int port) {
  15330. proxy_host_ = host;
  15331. proxy_port_ = port;
  15332. std::lock_guard<std::mutex> guard(socket_mutex_);
  15333. disconnect(/*gracefully=*/true);
  15334. }
  15335. inline void ClientImpl::set_proxy_basic_auth(const std::string &username,
  15336. const std::string &password) {
  15337. proxy_basic_auth_username_ = username;
  15338. proxy_basic_auth_password_ = password;
  15339. }
  15340. inline void ClientImpl::set_proxy_bearer_token_auth(const std::string &token) {
  15341. proxy_bearer_token_auth_token_ = token;
  15342. }
  15343. inline void ClientImpl::set_no_proxy(const std::vector<std::string> &patterns) {
  15344. no_proxy_entries_ = detail::parse_no_proxy_entries(patterns);
  15345. std::lock_guard<std::mutex> guard(socket_mutex_);
  15346. disconnect(/*gracefully=*/true);
  15347. }
  15348. #ifdef CPPHTTPLIB_SSL_ENABLED
  15349. inline void ClientImpl::set_digest_auth(const std::string &username,
  15350. const std::string &password) {
  15351. digest_auth_username_ = username;
  15352. digest_auth_password_ = password;
  15353. }
  15354. inline void ClientImpl::set_ca_cert_path(const std::string &ca_cert_file_path,
  15355. const std::string &ca_cert_dir_path) {
  15356. ca_cert_file_path_ = ca_cert_file_path;
  15357. ca_cert_dir_path_ = ca_cert_dir_path;
  15358. }
  15359. inline void ClientImpl::set_proxy_digest_auth(const std::string &username,
  15360. const std::string &password) {
  15361. proxy_digest_auth_username_ = username;
  15362. proxy_digest_auth_password_ = password;
  15363. }
  15364. inline void ClientImpl::enable_server_certificate_verification(bool enabled) {
  15365. server_certificate_verification_ = enabled;
  15366. }
  15367. inline void ClientImpl::enable_server_hostname_verification(bool enabled) {
  15368. server_hostname_verification_ = enabled;
  15369. }
  15370. inline void ClientImpl::enable_system_ca(bool enabled) {
  15371. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  15372. }
  15373. #endif
  15374. inline void ClientImpl::set_logger(Logger logger) {
  15375. logger_ = std::move(logger);
  15376. }
  15377. inline void ClientImpl::set_error_logger(ErrorLogger error_logger) {
  15378. error_logger_ = std::move(error_logger);
  15379. }
  15380. /*
  15381. * SSL/TLS Common Implementation
  15382. */
  15383. inline ClientConnection::~ClientConnection() {
  15384. #ifdef CPPHTTPLIB_SSL_ENABLED
  15385. if (session) {
  15386. tls::shutdown(session, true);
  15387. tls::free_session(session);
  15388. session = nullptr;
  15389. }
  15390. #endif
  15391. if (sock != INVALID_SOCKET) {
  15392. detail::close_socket(sock);
  15393. sock = INVALID_SOCKET;
  15394. }
  15395. }
  15396. // Universal client implementation
  15397. inline Client::Client(const std::string &scheme_host_port)
  15398. : Client(scheme_host_port, std::string(), std::string()) {}
  15399. inline Client::Client(const std::string &scheme_host_port,
  15400. const std::string &client_cert_path,
  15401. const std::string &client_key_path) {
  15402. detail::UrlComponents uc;
  15403. if (detail::parse_url(scheme_host_port, uc) && !uc.host.empty()) {
  15404. auto &scheme = uc.scheme;
  15405. #ifdef CPPHTTPLIB_SSL_ENABLED
  15406. if (!scheme.empty() && (scheme != "http" && scheme != "https")) {
  15407. #else
  15408. if (!scheme.empty() && scheme != "http") {
  15409. #endif
  15410. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  15411. std::string msg = "'" + scheme + "' scheme is not supported.";
  15412. throw std::invalid_argument(msg);
  15413. #endif
  15414. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15415. return;
  15416. }
  15417. auto is_ssl = scheme == "https";
  15418. auto host = std::move(uc.host);
  15419. auto port = is_ssl ? 443 : 80;
  15420. if (!uc.port.empty() && !detail::parse_port(uc.port, port)) {
  15421. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15422. return;
  15423. }
  15424. if (is_ssl) {
  15425. #ifdef CPPHTTPLIB_SSL_ENABLED
  15426. cli_ = detail::make_unique<SSLClient>(host, port, client_cert_path,
  15427. client_key_path);
  15428. is_ssl_ = is_ssl;
  15429. #endif
  15430. } else {
  15431. cli_ = detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15432. client_key_path);
  15433. }
  15434. } else if (scheme_host_port.compare(0, 2, "//") == 0 ||
  15435. scheme_host_port.find("://") < scheme_host_port.find('/')) {
  15436. // A URL, but not one this client can use, such as one with userinfo. A
  15437. // Unix socket path may have "//" further on.
  15438. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15439. } else {
  15440. // NOTE: Update TEST(UniversalClientImplTest, Ipv6LiteralAddress)
  15441. // if port param below changes.
  15442. cli_ = detail::make_unique<ClientImpl>(scheme_host_port, 80,
  15443. client_cert_path, client_key_path);
  15444. }
  15445. }
  15446. inline Client::Client(const std::string &host, int port)
  15447. : Client(host, port, std::string(), std::string()) {}
  15448. inline Client::Client(const std::string &host, int port,
  15449. const std::string &client_cert_path,
  15450. const std::string &client_key_path)
  15451. : cli_(detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15452. client_key_path)) {}
  15453. inline Client::~Client() = default;
  15454. inline bool Client::is_valid() const {
  15455. return cli_ != nullptr && cli_->is_valid();
  15456. }
  15457. inline Result Client::Get(const std::string &path, DownloadProgress progress) {
  15458. return cli_->Get(path, std::move(progress));
  15459. }
  15460. inline Result Client::Get(const std::string &path, const Headers &headers,
  15461. DownloadProgress progress) {
  15462. return cli_->Get(path, headers, std::move(progress));
  15463. }
  15464. inline Result Client::Get(const std::string &path,
  15465. ContentReceiver content_receiver,
  15466. DownloadProgress progress) {
  15467. return cli_->Get(path, std::move(content_receiver), std::move(progress));
  15468. }
  15469. inline Result Client::Get(const std::string &path, const Headers &headers,
  15470. ContentReceiver content_receiver,
  15471. DownloadProgress progress) {
  15472. return cli_->Get(path, headers, std::move(content_receiver),
  15473. std::move(progress));
  15474. }
  15475. inline Result Client::Get(const std::string &path,
  15476. ResponseHandler response_handler,
  15477. ContentReceiver content_receiver,
  15478. DownloadProgress progress) {
  15479. return cli_->Get(path, std::move(response_handler),
  15480. std::move(content_receiver), std::move(progress));
  15481. }
  15482. inline Result Client::Get(const std::string &path, const Headers &headers,
  15483. ResponseHandler response_handler,
  15484. ContentReceiver content_receiver,
  15485. DownloadProgress progress) {
  15486. return cli_->Get(path, headers, std::move(response_handler),
  15487. std::move(content_receiver), std::move(progress));
  15488. }
  15489. inline Result Client::Get(const std::string &path, const Params &params,
  15490. DownloadProgress progress) {
  15491. return cli_->Get(path, params, std::move(progress));
  15492. }
  15493. inline Result Client::Get(const std::string &path, const Params &params,
  15494. const Headers &headers, DownloadProgress progress) {
  15495. return cli_->Get(path, params, headers, std::move(progress));
  15496. }
  15497. inline Result Client::Get(const std::string &path, const Params &params,
  15498. const Headers &headers,
  15499. ContentReceiver content_receiver,
  15500. DownloadProgress progress) {
  15501. return cli_->Get(path, params, headers, std::move(content_receiver),
  15502. std::move(progress));
  15503. }
  15504. inline Result Client::Get(const std::string &path, const Params &params,
  15505. const Headers &headers,
  15506. ResponseHandler response_handler,
  15507. ContentReceiver content_receiver,
  15508. DownloadProgress progress) {
  15509. return cli_->Get(path, params, headers, std::move(response_handler),
  15510. std::move(content_receiver), std::move(progress));
  15511. }
  15512. inline Result Client::Head(const std::string &path) { return cli_->Head(path); }
  15513. inline Result Client::Head(const std::string &path, const Headers &headers) {
  15514. return cli_->Head(path, headers);
  15515. }
  15516. inline Result Client::Post(const std::string &path) { return cli_->Post(path); }
  15517. inline Result Client::Post(const std::string &path, const Headers &headers) {
  15518. return cli_->Post(path, headers);
  15519. }
  15520. inline Result Client::Post(const std::string &path, const char *body,
  15521. size_t content_length,
  15522. const std::string &content_type,
  15523. UploadProgress progress) {
  15524. return cli_->Post(path, body, content_length, content_type, progress);
  15525. }
  15526. inline Result Client::Post(const std::string &path, const Headers &headers,
  15527. const char *body, size_t content_length,
  15528. const std::string &content_type,
  15529. UploadProgress progress) {
  15530. return cli_->Post(path, headers, body, content_length, content_type,
  15531. progress);
  15532. }
  15533. inline Result Client::Post(const std::string &path, const std::string &body,
  15534. const std::string &content_type,
  15535. UploadProgress progress) {
  15536. return cli_->Post(path, body, content_type, progress);
  15537. }
  15538. inline Result Client::Post(const std::string &path, const Headers &headers,
  15539. const std::string &body,
  15540. const std::string &content_type,
  15541. UploadProgress progress) {
  15542. return cli_->Post(path, headers, body, content_type, progress);
  15543. }
  15544. inline Result Client::Post(const std::string &path, size_t content_length,
  15545. ContentProvider content_provider,
  15546. const std::string &content_type,
  15547. UploadProgress progress) {
  15548. return cli_->Post(path, content_length, std::move(content_provider),
  15549. content_type, progress);
  15550. }
  15551. inline Result Client::Post(const std::string &path, size_t content_length,
  15552. ContentProvider content_provider,
  15553. const std::string &content_type,
  15554. ContentReceiver content_receiver,
  15555. UploadProgress progress) {
  15556. return cli_->Post(path, content_length, std::move(content_provider),
  15557. content_type, std::move(content_receiver), progress);
  15558. }
  15559. inline Result Client::Post(const std::string &path,
  15560. ContentProviderWithoutLength content_provider,
  15561. const std::string &content_type,
  15562. UploadProgress progress) {
  15563. return cli_->Post(path, std::move(content_provider), content_type, progress);
  15564. }
  15565. inline Result Client::Post(const std::string &path,
  15566. ContentProviderWithoutLength content_provider,
  15567. const std::string &content_type,
  15568. ContentReceiver content_receiver,
  15569. UploadProgress progress) {
  15570. return cli_->Post(path, std::move(content_provider), content_type,
  15571. std::move(content_receiver), progress);
  15572. }
  15573. inline Result Client::Post(const std::string &path, const Headers &headers,
  15574. size_t content_length,
  15575. ContentProvider content_provider,
  15576. const std::string &content_type,
  15577. UploadProgress progress) {
  15578. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15579. content_type, progress);
  15580. }
  15581. inline Result Client::Post(const std::string &path, const Headers &headers,
  15582. size_t content_length,
  15583. ContentProvider content_provider,
  15584. const std::string &content_type,
  15585. ContentReceiver content_receiver,
  15586. DownloadProgress progress) {
  15587. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15588. content_type, std::move(content_receiver), progress);
  15589. }
  15590. inline Result Client::Post(const std::string &path, const Headers &headers,
  15591. ContentProviderWithoutLength content_provider,
  15592. const std::string &content_type,
  15593. UploadProgress progress) {
  15594. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15595. progress);
  15596. }
  15597. inline Result Client::Post(const std::string &path, const Headers &headers,
  15598. ContentProviderWithoutLength content_provider,
  15599. const std::string &content_type,
  15600. ContentReceiver content_receiver,
  15601. DownloadProgress progress) {
  15602. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15603. std::move(content_receiver), progress);
  15604. }
  15605. inline Result Client::Post(const std::string &path, const Params &params) {
  15606. return cli_->Post(path, params);
  15607. }
  15608. inline Result Client::Post(const std::string &path, const Headers &headers,
  15609. const Params &params) {
  15610. return cli_->Post(path, headers, params);
  15611. }
  15612. inline Result Client::Post(const std::string &path,
  15613. const UploadFormDataItems &items,
  15614. UploadProgress progress) {
  15615. return cli_->Post(path, items, progress);
  15616. }
  15617. inline Result Client::Post(const std::string &path, const Headers &headers,
  15618. const UploadFormDataItems &items,
  15619. UploadProgress progress) {
  15620. return cli_->Post(path, headers, items, progress);
  15621. }
  15622. inline Result Client::Post(const std::string &path, const Headers &headers,
  15623. const UploadFormDataItems &items,
  15624. const std::string &boundary,
  15625. UploadProgress progress) {
  15626. return cli_->Post(path, headers, items, boundary, progress);
  15627. }
  15628. inline Result Client::Post(const std::string &path, const Headers &headers,
  15629. const UploadFormDataItems &items,
  15630. const FormDataProviderItems &provider_items,
  15631. UploadProgress progress) {
  15632. return cli_->Post(path, headers, items, provider_items, progress);
  15633. }
  15634. inline Result Client::Post(const std::string &path, const Headers &headers,
  15635. const std::string &body,
  15636. const std::string &content_type,
  15637. ContentReceiver content_receiver,
  15638. DownloadProgress progress) {
  15639. return cli_->Post(path, headers, body, content_type,
  15640. std::move(content_receiver), progress);
  15641. }
  15642. inline Result Client::Put(const std::string &path) { return cli_->Put(path); }
  15643. inline Result Client::Put(const std::string &path, const Headers &headers) {
  15644. return cli_->Put(path, headers);
  15645. }
  15646. inline Result Client::Put(const std::string &path, const char *body,
  15647. size_t content_length,
  15648. const std::string &content_type,
  15649. UploadProgress progress) {
  15650. return cli_->Put(path, body, content_length, content_type, progress);
  15651. }
  15652. inline Result Client::Put(const std::string &path, const Headers &headers,
  15653. const char *body, size_t content_length,
  15654. const std::string &content_type,
  15655. UploadProgress progress) {
  15656. return cli_->Put(path, headers, body, content_length, content_type, progress);
  15657. }
  15658. inline Result Client::Put(const std::string &path, const std::string &body,
  15659. const std::string &content_type,
  15660. UploadProgress progress) {
  15661. return cli_->Put(path, body, content_type, progress);
  15662. }
  15663. inline Result Client::Put(const std::string &path, const Headers &headers,
  15664. const std::string &body,
  15665. const std::string &content_type,
  15666. UploadProgress progress) {
  15667. return cli_->Put(path, headers, body, content_type, progress);
  15668. }
  15669. inline Result Client::Put(const std::string &path, size_t content_length,
  15670. ContentProvider content_provider,
  15671. const std::string &content_type,
  15672. UploadProgress progress) {
  15673. return cli_->Put(path, content_length, std::move(content_provider),
  15674. content_type, progress);
  15675. }
  15676. inline Result Client::Put(const std::string &path, size_t content_length,
  15677. ContentProvider content_provider,
  15678. const std::string &content_type,
  15679. ContentReceiver content_receiver,
  15680. UploadProgress progress) {
  15681. return cli_->Put(path, content_length, std::move(content_provider),
  15682. content_type, std::move(content_receiver), progress);
  15683. }
  15684. inline Result Client::Put(const std::string &path,
  15685. ContentProviderWithoutLength content_provider,
  15686. const std::string &content_type,
  15687. UploadProgress progress) {
  15688. return cli_->Put(path, std::move(content_provider), content_type, progress);
  15689. }
  15690. inline Result Client::Put(const std::string &path,
  15691. ContentProviderWithoutLength content_provider,
  15692. const std::string &content_type,
  15693. ContentReceiver content_receiver,
  15694. UploadProgress progress) {
  15695. return cli_->Put(path, std::move(content_provider), content_type,
  15696. std::move(content_receiver), progress);
  15697. }
  15698. inline Result Client::Put(const std::string &path, const Headers &headers,
  15699. size_t content_length,
  15700. ContentProvider content_provider,
  15701. const std::string &content_type,
  15702. UploadProgress progress) {
  15703. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15704. content_type, progress);
  15705. }
  15706. inline Result Client::Put(const std::string &path, const Headers &headers,
  15707. size_t content_length,
  15708. ContentProvider content_provider,
  15709. const std::string &content_type,
  15710. ContentReceiver content_receiver,
  15711. UploadProgress progress) {
  15712. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15713. content_type, std::move(content_receiver), progress);
  15714. }
  15715. inline Result Client::Put(const std::string &path, const Headers &headers,
  15716. ContentProviderWithoutLength content_provider,
  15717. const std::string &content_type,
  15718. UploadProgress progress) {
  15719. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15720. progress);
  15721. }
  15722. inline Result Client::Put(const std::string &path, const Headers &headers,
  15723. ContentProviderWithoutLength content_provider,
  15724. const std::string &content_type,
  15725. ContentReceiver content_receiver,
  15726. UploadProgress progress) {
  15727. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15728. std::move(content_receiver), progress);
  15729. }
  15730. inline Result Client::Put(const std::string &path, const Params &params) {
  15731. return cli_->Put(path, params);
  15732. }
  15733. inline Result Client::Put(const std::string &path, const Headers &headers,
  15734. const Params &params) {
  15735. return cli_->Put(path, headers, params);
  15736. }
  15737. inline Result Client::Put(const std::string &path,
  15738. const UploadFormDataItems &items,
  15739. UploadProgress progress) {
  15740. return cli_->Put(path, items, progress);
  15741. }
  15742. inline Result Client::Put(const std::string &path, const Headers &headers,
  15743. const UploadFormDataItems &items,
  15744. UploadProgress progress) {
  15745. return cli_->Put(path, headers, items, progress);
  15746. }
  15747. inline Result Client::Put(const std::string &path, const Headers &headers,
  15748. const UploadFormDataItems &items,
  15749. const std::string &boundary,
  15750. UploadProgress progress) {
  15751. return cli_->Put(path, headers, items, boundary, progress);
  15752. }
  15753. inline Result Client::Put(const std::string &path, const Headers &headers,
  15754. const UploadFormDataItems &items,
  15755. const FormDataProviderItems &provider_items,
  15756. UploadProgress progress) {
  15757. return cli_->Put(path, headers, items, provider_items, progress);
  15758. }
  15759. inline Result Client::Put(const std::string &path, const Headers &headers,
  15760. const std::string &body,
  15761. const std::string &content_type,
  15762. ContentReceiver content_receiver,
  15763. DownloadProgress progress) {
  15764. return cli_->Put(path, headers, body, content_type, content_receiver,
  15765. progress);
  15766. }
  15767. inline Result Client::Patch(const std::string &path) {
  15768. return cli_->Patch(path);
  15769. }
  15770. inline Result Client::Patch(const std::string &path, const Headers &headers) {
  15771. return cli_->Patch(path, headers);
  15772. }
  15773. inline Result Client::Patch(const std::string &path, const char *body,
  15774. size_t content_length,
  15775. const std::string &content_type,
  15776. UploadProgress progress) {
  15777. return cli_->Patch(path, body, content_length, content_type, progress);
  15778. }
  15779. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15780. const char *body, size_t content_length,
  15781. const std::string &content_type,
  15782. UploadProgress progress) {
  15783. return cli_->Patch(path, headers, body, content_length, content_type,
  15784. progress);
  15785. }
  15786. inline Result Client::Patch(const std::string &path, const std::string &body,
  15787. const std::string &content_type,
  15788. UploadProgress progress) {
  15789. return cli_->Patch(path, body, content_type, progress);
  15790. }
  15791. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15792. const std::string &body,
  15793. const std::string &content_type,
  15794. UploadProgress progress) {
  15795. return cli_->Patch(path, headers, body, content_type, progress);
  15796. }
  15797. inline Result Client::Patch(const std::string &path, size_t content_length,
  15798. ContentProvider content_provider,
  15799. const std::string &content_type,
  15800. UploadProgress progress) {
  15801. return cli_->Patch(path, content_length, std::move(content_provider),
  15802. content_type, progress);
  15803. }
  15804. inline Result Client::Patch(const std::string &path, size_t content_length,
  15805. ContentProvider content_provider,
  15806. const std::string &content_type,
  15807. ContentReceiver content_receiver,
  15808. UploadProgress progress) {
  15809. return cli_->Patch(path, content_length, std::move(content_provider),
  15810. content_type, std::move(content_receiver), progress);
  15811. }
  15812. inline Result Client::Patch(const std::string &path,
  15813. ContentProviderWithoutLength content_provider,
  15814. const std::string &content_type,
  15815. UploadProgress progress) {
  15816. return cli_->Patch(path, std::move(content_provider), content_type, progress);
  15817. }
  15818. inline Result Client::Patch(const std::string &path,
  15819. ContentProviderWithoutLength content_provider,
  15820. const std::string &content_type,
  15821. ContentReceiver content_receiver,
  15822. UploadProgress progress) {
  15823. return cli_->Patch(path, std::move(content_provider), content_type,
  15824. std::move(content_receiver), progress);
  15825. }
  15826. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15827. size_t content_length,
  15828. ContentProvider content_provider,
  15829. const std::string &content_type,
  15830. UploadProgress progress) {
  15831. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15832. content_type, progress);
  15833. }
  15834. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15835. size_t content_length,
  15836. ContentProvider content_provider,
  15837. const std::string &content_type,
  15838. ContentReceiver content_receiver,
  15839. UploadProgress progress) {
  15840. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15841. content_type, std::move(content_receiver), progress);
  15842. }
  15843. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15844. ContentProviderWithoutLength content_provider,
  15845. const std::string &content_type,
  15846. UploadProgress progress) {
  15847. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15848. progress);
  15849. }
  15850. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15851. ContentProviderWithoutLength content_provider,
  15852. const std::string &content_type,
  15853. ContentReceiver content_receiver,
  15854. UploadProgress progress) {
  15855. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15856. std::move(content_receiver), progress);
  15857. }
  15858. inline Result Client::Patch(const std::string &path, const Params &params) {
  15859. return cli_->Patch(path, params);
  15860. }
  15861. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15862. const Params &params) {
  15863. return cli_->Patch(path, headers, params);
  15864. }
  15865. inline Result Client::Patch(const std::string &path,
  15866. const UploadFormDataItems &items,
  15867. UploadProgress progress) {
  15868. return cli_->Patch(path, items, progress);
  15869. }
  15870. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15871. const UploadFormDataItems &items,
  15872. UploadProgress progress) {
  15873. return cli_->Patch(path, headers, items, progress);
  15874. }
  15875. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15876. const UploadFormDataItems &items,
  15877. const std::string &boundary,
  15878. UploadProgress progress) {
  15879. return cli_->Patch(path, headers, items, boundary, progress);
  15880. }
  15881. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15882. const UploadFormDataItems &items,
  15883. const FormDataProviderItems &provider_items,
  15884. UploadProgress progress) {
  15885. return cli_->Patch(path, headers, items, provider_items, progress);
  15886. }
  15887. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15888. const std::string &body,
  15889. const std::string &content_type,
  15890. ContentReceiver content_receiver,
  15891. DownloadProgress progress) {
  15892. return cli_->Patch(path, headers, body, content_type, content_receiver,
  15893. progress);
  15894. }
  15895. inline Result Client::Delete(const std::string &path,
  15896. DownloadProgress progress) {
  15897. return cli_->Delete(path, progress);
  15898. }
  15899. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15900. DownloadProgress progress) {
  15901. return cli_->Delete(path, headers, progress);
  15902. }
  15903. inline Result Client::Delete(const std::string &path, const char *body,
  15904. size_t content_length,
  15905. const std::string &content_type,
  15906. DownloadProgress progress) {
  15907. return cli_->Delete(path, body, content_length, content_type, progress);
  15908. }
  15909. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15910. const char *body, size_t content_length,
  15911. const std::string &content_type,
  15912. DownloadProgress progress) {
  15913. return cli_->Delete(path, headers, body, content_length, content_type,
  15914. progress);
  15915. }
  15916. inline Result Client::Delete(const std::string &path, const std::string &body,
  15917. const std::string &content_type,
  15918. DownloadProgress progress) {
  15919. return cli_->Delete(path, body, content_type, progress);
  15920. }
  15921. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15922. const std::string &body,
  15923. const std::string &content_type,
  15924. DownloadProgress progress) {
  15925. return cli_->Delete(path, headers, body, content_type, progress);
  15926. }
  15927. inline Result Client::Delete(const std::string &path, const Params &params,
  15928. DownloadProgress progress) {
  15929. return cli_->Delete(path, params, progress);
  15930. }
  15931. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15932. const Params &params, DownloadProgress progress) {
  15933. return cli_->Delete(path, headers, params, progress);
  15934. }
  15935. inline Result Client::Options(const std::string &path) {
  15936. return cli_->Options(path);
  15937. }
  15938. inline Result Client::Options(const std::string &path, const Headers &headers) {
  15939. return cli_->Options(path, headers);
  15940. }
  15941. inline ClientImpl::StreamHandle
  15942. Client::open_stream(const std::string &method, const std::string &path,
  15943. const Params &params, const Headers &headers,
  15944. const std::string &body, const std::string &content_type) {
  15945. return cli_->open_stream(method, path, params, headers, body, content_type);
  15946. }
  15947. inline bool Client::send(Request &req, Response &res, Error &error) {
  15948. return cli_->send(req, res, error);
  15949. }
  15950. inline Result Client::send(const Request &req) { return cli_->send(req); }
  15951. inline void Client::stop() { cli_->stop(); }
  15952. inline std::string Client::host() const { return cli_->host(); }
  15953. inline int Client::port() const { return cli_->port(); }
  15954. inline size_t Client::is_socket_open() const { return cli_->is_socket_open(); }
  15955. inline socket_t Client::socket() const { return cli_->socket(); }
  15956. inline void
  15957. Client::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15958. cli_->set_hostname_addr_map(std::move(addr_map));
  15959. }
  15960. inline void Client::set_default_headers(Headers headers) {
  15961. cli_->set_default_headers(std::move(headers));
  15962. }
  15963. inline void Client::set_header_writer(
  15964. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15965. cli_->set_header_writer(writer);
  15966. }
  15967. inline void Client::set_address_family(int family) {
  15968. cli_->set_address_family(family);
  15969. }
  15970. inline void Client::set_tcp_nodelay(bool on) { cli_->set_tcp_nodelay(on); }
  15971. inline void Client::set_socket_options(SocketOptions socket_options) {
  15972. cli_->set_socket_options(std::move(socket_options));
  15973. }
  15974. inline void Client::set_connection_timeout(time_t sec, time_t usec) {
  15975. cli_->set_connection_timeout(sec, usec);
  15976. }
  15977. inline void Client::set_read_timeout(time_t sec, time_t usec) {
  15978. cli_->set_read_timeout(sec, usec);
  15979. }
  15980. inline void Client::set_write_timeout(time_t sec, time_t usec) {
  15981. cli_->set_write_timeout(sec, usec);
  15982. }
  15983. inline void Client::set_basic_auth(const std::string &username,
  15984. const std::string &password) {
  15985. cli_->set_basic_auth(username, password);
  15986. }
  15987. inline void Client::set_bearer_token_auth(const std::string &token) {
  15988. cli_->set_bearer_token_auth(token);
  15989. }
  15990. inline void Client::set_keep_alive(bool on) { cli_->set_keep_alive(on); }
  15991. inline void Client::set_follow_location(bool on) {
  15992. cli_->set_follow_location(on);
  15993. }
  15994. inline void Client::set_path_encode(bool on) { cli_->set_path_encode(on); }
  15995. inline void Client::set_compress(bool on) { cli_->set_compress(on); }
  15996. inline void Client::set_decompress(bool on) { cli_->set_decompress(on); }
  15997. inline void Client::set_payload_max_length(size_t length) {
  15998. cli_->set_payload_max_length(length);
  15999. }
  16000. inline void Client::set_interface(const std::string &intf) {
  16001. cli_->set_interface(intf);
  16002. }
  16003. inline void Client::set_proxy(const std::string &host, int port) {
  16004. cli_->set_proxy(host, port);
  16005. }
  16006. inline void Client::set_proxy_basic_auth(const std::string &username,
  16007. const std::string &password) {
  16008. cli_->set_proxy_basic_auth(username, password);
  16009. }
  16010. inline void Client::set_proxy_bearer_token_auth(const std::string &token) {
  16011. cli_->set_proxy_bearer_token_auth(token);
  16012. }
  16013. inline void Client::set_no_proxy(const std::vector<std::string> &patterns) {
  16014. cli_->set_no_proxy(patterns);
  16015. }
  16016. inline void Client::set_logger(Logger logger) {
  16017. cli_->set_logger(std::move(logger));
  16018. }
  16019. inline void Client::set_error_logger(ErrorLogger error_logger) {
  16020. cli_->set_error_logger(std::move(error_logger));
  16021. }
  16022. /*
  16023. * Group 6: SSL Server and Client implementation
  16024. */
  16025. #ifdef CPPHTTPLIB_SSL_ENABLED
  16026. // SSL HTTP server implementation
  16027. inline SSLServer::SSLServer(const char *cert_path, const char *private_key_path,
  16028. const char *client_ca_cert_file_path,
  16029. const char *client_ca_cert_dir_path,
  16030. const char *private_key_password) {
  16031. using namespace tls;
  16032. ctx_ = create_server_context();
  16033. if (!ctx_) { return; }
  16034. // Load server certificate and private key
  16035. if (!set_server_cert_file(ctx_, cert_path, private_key_path,
  16036. private_key_password)) {
  16037. last_ssl_error_ = static_cast<int>(get_error());
  16038. free_context(ctx_);
  16039. ctx_ = nullptr;
  16040. return;
  16041. }
  16042. // Load client CA certificates for client authentication
  16043. if (client_ca_cert_file_path || client_ca_cert_dir_path) {
  16044. if (!set_client_ca_file(ctx_, client_ca_cert_file_path,
  16045. client_ca_cert_dir_path)) {
  16046. last_ssl_error_ = static_cast<int>(get_error());
  16047. free_context(ctx_);
  16048. ctx_ = nullptr;
  16049. return;
  16050. }
  16051. // Enable client certificate verification
  16052. set_verify_client(ctx_, true);
  16053. }
  16054. }
  16055. inline SSLServer::SSLServer(const PemMemory &pem) {
  16056. using namespace tls;
  16057. ctx_ = create_server_context();
  16058. if (ctx_) {
  16059. std::string cert_buf, key_buf;
  16060. if (!set_server_cert_pem(
  16061. ctx_, detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  16062. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  16063. pem.private_key_password)) {
  16064. last_ssl_error_ = static_cast<int>(get_error());
  16065. free_context(ctx_);
  16066. ctx_ = nullptr;
  16067. } else if (pem.client_ca_pem) {
  16068. auto ca_len = pem.client_ca_pem_len ? pem.client_ca_pem_len
  16069. : strlen(pem.client_ca_pem);
  16070. if (!load_ca_pem(ctx_, pem.client_ca_pem, ca_len)) {
  16071. last_ssl_error_ = static_cast<int>(get_error());
  16072. free_context(ctx_);
  16073. ctx_ = nullptr;
  16074. } else {
  16075. set_verify_client(ctx_, true);
  16076. }
  16077. }
  16078. }
  16079. }
  16080. inline SSLServer::SSLServer(const tls::ContextSetupCallback &setup_callback) {
  16081. using namespace tls;
  16082. ctx_ = create_server_context();
  16083. if (ctx_) {
  16084. if (!setup_callback(ctx_)) {
  16085. free_context(ctx_);
  16086. ctx_ = nullptr;
  16087. }
  16088. }
  16089. }
  16090. inline SSLServer::~SSLServer() {
  16091. if (ctx_) { tls::free_context(ctx_); }
  16092. }
  16093. inline bool SSLServer::is_valid() const {
  16094. return ctx_ != nullptr && Server::is_valid();
  16095. }
  16096. inline bool SSLServer::process_and_close_socket(socket_t sock) {
  16097. using namespace tls;
  16098. session_t session = nullptr;
  16099. {
  16100. std::unique_lock<std::mutex> lock(ctx_mutex_);
  16101. ctx_cv_.wait(lock, [&] { return updates_pending_ == 0; });
  16102. session = create_session(static_cast<ctx_t>(ctx_), sock);
  16103. if (session) { handshakes_in_progress_++; }
  16104. }
  16105. if (!session) {
  16106. last_ssl_error_ = static_cast<int>(get_error());
  16107. detail::shutdown_socket(sock);
  16108. detail::close_socket(sock);
  16109. return false;
  16110. }
  16111. // Use scope_exit to ensure cleanup on all paths (including exceptions)
  16112. bool handshake_done = false;
  16113. bool ret = false;
  16114. bool websocket_upgraded = false;
  16115. auto cleanup = detail::scope_exit([&] {
  16116. if (handshake_done) { shutdown(session, !websocket_upgraded && ret); }
  16117. free_session(session);
  16118. detail::shutdown_socket(sock);
  16119. detail::close_socket(sock);
  16120. });
  16121. // Perform TLS accept handshake with timeout
  16122. TlsError tls_err;
  16123. auto accepted = false;
  16124. {
  16125. auto handshake_left = detail::scope_exit([&] {
  16126. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16127. if (--handshakes_in_progress_ == 0) { ctx_cv_.notify_all(); }
  16128. });
  16129. accepted = accept_nonblocking(session, sock, read_timeout_sec_,
  16130. read_timeout_usec_, &tls_err);
  16131. }
  16132. if (!accepted) {
  16133. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16134. // Map TlsError to legacy ssl_error for backward compatibility
  16135. if (tls_err.code == ErrorCode::WantRead) {
  16136. last_ssl_error_ = SSL_ERROR_WANT_READ;
  16137. } else if (tls_err.code == ErrorCode::WantWrite) {
  16138. last_ssl_error_ = SSL_ERROR_WANT_WRITE;
  16139. } else {
  16140. last_ssl_error_ = SSL_ERROR_SSL;
  16141. }
  16142. #else
  16143. last_ssl_error_ = static_cast<int>(get_error());
  16144. #endif
  16145. return false;
  16146. }
  16147. handshake_done = true;
  16148. std::string remote_addr;
  16149. int remote_port = 0;
  16150. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  16151. std::string local_addr;
  16152. int local_port = 0;
  16153. detail::get_local_ip_and_port(sock, local_addr, local_port);
  16154. ret = serve_guarded([&]() {
  16155. return detail::process_server_socket_ssl(
  16156. svr_sock_, session, sock, keep_alive_max_count_,
  16157. keep_alive_timeout_sec_, read_timeout_sec_, read_timeout_usec_,
  16158. write_timeout_sec_, write_timeout_usec_,
  16159. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  16160. return process_request(
  16161. strm, remote_addr, remote_port, local_addr, local_port,
  16162. close_connection, connection_closed,
  16163. [&](Request &req) { req.ssl = session; }, &websocket_upgraded);
  16164. });
  16165. });
  16166. return ret;
  16167. }
  16168. inline bool SSLServer::update_certs_pem(const char *cert_pem,
  16169. const char *key_pem,
  16170. const char *client_ca_pem,
  16171. const char *password) {
  16172. if (!ctx_) { return false; }
  16173. std::unique_lock<std::mutex> lock(ctx_mutex_);
  16174. updates_pending_++;
  16175. auto se = detail::scope_exit([&] {
  16176. if (--updates_pending_ == 0) { ctx_cv_.notify_all(); }
  16177. });
  16178. ctx_cv_.wait(lock, [&] { return handshakes_in_progress_ == 0; });
  16179. if (!tls::update_server_cert(ctx_, cert_pem, key_pem, password)) {
  16180. return false;
  16181. }
  16182. if (client_ca_pem) {
  16183. if (!tls::update_server_client_ca(ctx_, client_ca_pem)) { return false; }
  16184. // As in the constructors, a client CA makes client certificates required
  16185. tls::set_verify_client(ctx_, true);
  16186. }
  16187. return true;
  16188. }
  16189. // SSL HTTP client implementation
  16190. inline SSLClient::~SSLClient() {
  16191. // Make sure to shut down SSL since shutdown_ssl will resolve to the
  16192. // base function rather than the derived function once we get to the
  16193. // base class destructor, and won't free the SSL (causing a leak).
  16194. // This must happen before the context is freed below: some backends
  16195. // (e.g. mbedTLS) have the SSL session borrow a raw pointer into the
  16196. // context, so freeing the context first leaves close_notify reading
  16197. // freed memory.
  16198. shutdown_ssl_impl(socket_, true);
  16199. if (ctx_) {
  16200. tls::free_context(ctx_);
  16201. ctx_ = nullptr;
  16202. }
  16203. }
  16204. inline bool SSLClient::is_valid() const { return ctx_ != nullptr; }
  16205. inline void SSLClient::shutdown_ssl(Socket &socket, bool shutdown_gracefully) {
  16206. shutdown_ssl_impl(socket, shutdown_gracefully);
  16207. }
  16208. inline void SSLClient::shutdown_ssl_impl(Socket &socket,
  16209. bool shutdown_gracefully) {
  16210. if (socket.sock == INVALID_SOCKET) {
  16211. assert(socket.ssl == nullptr);
  16212. return;
  16213. }
  16214. if (socket.ssl) {
  16215. tls::shutdown(socket.ssl, shutdown_gracefully);
  16216. {
  16217. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16218. tls::free_session(socket.ssl);
  16219. }
  16220. socket.ssl = nullptr;
  16221. }
  16222. assert(socket.ssl == nullptr);
  16223. }
  16224. inline bool SSLClient::process_socket(
  16225. const Socket &socket,
  16226. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16227. std::function<bool(Stream &strm)> callback) {
  16228. assert(socket.ssl);
  16229. return detail::process_client_socket_ssl(
  16230. socket.ssl, socket.sock, read_timeout_sec_, read_timeout_usec_,
  16231. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_, start_time,
  16232. [&](detail::SSLSocketStream &strm) {
  16233. auto ret = callback(strm);
  16234. // A request that failed after the handshake reports Error::Read or
  16235. // Error::Write; keep the TLS error behind it, such as a fatal alert
  16236. // from the server, for Result::ssl_error() and ssl_backend_error()
  16237. const auto &tls_error = strm.tls_error();
  16238. if (!ret && tls_error.code != tls::ErrorCode::Success) {
  16239. last_ssl_error_ = static_cast<int>(tls_error.code);
  16240. last_backend_error_ = tls_error.backend_code;
  16241. }
  16242. return ret;
  16243. });
  16244. }
  16245. inline bool SSLClient::is_ssl() const { return true; }
  16246. inline bool SSLClient::create_and_connect_socket(Socket &socket, Error &error) {
  16247. if (!is_valid()) {
  16248. error = Error::SSLConnection;
  16249. return false;
  16250. }
  16251. return ClientImpl::create_and_connect_socket(socket, error);
  16252. }
  16253. inline bool SSLClient::setup_proxy_connection(
  16254. Socket &socket,
  16255. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16256. Response &res, bool &success, Error &error) {
  16257. if (!is_proxy_enabled_for_host(host_)) { return true; }
  16258. if (!connect_with_proxy(socket, start_time, res, success, error)) {
  16259. return false;
  16260. }
  16261. if (!initialize_ssl(socket, error)) {
  16262. success = false;
  16263. return false;
  16264. }
  16265. return true;
  16266. }
  16267. // Assumes that socket_mutex_ is locked and that there are no requests in
  16268. // flight
  16269. inline bool SSLClient::connect_with_proxy(
  16270. Socket &socket,
  16271. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16272. Response &res, bool &success, Error &error) {
  16273. success = true;
  16274. Response proxy_res;
  16275. if (!detail::process_client_socket(
  16276. socket.sock, read_timeout_sec_, read_timeout_usec_,
  16277. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  16278. start_time, [&](Stream &strm) {
  16279. Request req2;
  16280. req2.method = "CONNECT";
  16281. req2.path =
  16282. detail::make_host_and_port_string_always_port(host_, port_);
  16283. if (max_timeout_msec_ > 0) {
  16284. req2.start_time_ = std::chrono::steady_clock::now();
  16285. }
  16286. return process_request(strm, req2, proxy_res, false, error);
  16287. })) {
  16288. // Thread-safe to close everything because we are assuming there are no
  16289. // requests in flight
  16290. shutdown_ssl(socket, true);
  16291. shutdown_socket(socket);
  16292. close_socket(socket);
  16293. success = false;
  16294. return false;
  16295. }
  16296. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  16297. if (!proxy_digest_auth_username_.empty() &&
  16298. !proxy_digest_auth_password_.empty()) {
  16299. std::map<std::string, std::string> auth;
  16300. if (detail::parse_www_authenticate(proxy_res, auth, true)) {
  16301. // Close the current socket and create a new one for the authenticated
  16302. // request
  16303. shutdown_ssl(socket, true);
  16304. shutdown_socket(socket);
  16305. close_socket(socket);
  16306. // Create a new socket for the authenticated CONNECT request
  16307. if (!ensure_socket_connection(socket, error)) {
  16308. success = false;
  16309. return false;
  16310. }
  16311. proxy_res = Response();
  16312. if (!detail::process_client_socket(
  16313. socket.sock, read_timeout_sec_, read_timeout_usec_,
  16314. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  16315. start_time, [&](Stream &strm) {
  16316. Request req3;
  16317. req3.method = "CONNECT";
  16318. req3.path = detail::make_host_and_port_string_always_port(
  16319. host_, port_);
  16320. req3.headers.insert(detail::make_digest_authentication_header(
  16321. req3, make_request_target(req3), auth, 1,
  16322. detail::random_string(10), proxy_digest_auth_username_,
  16323. proxy_digest_auth_password_, true));
  16324. if (max_timeout_msec_ > 0) {
  16325. req3.start_time_ = std::chrono::steady_clock::now();
  16326. }
  16327. return process_request(strm, req3, proxy_res, false, error);
  16328. })) {
  16329. // Thread-safe to close everything because we are assuming there are
  16330. // no requests in flight
  16331. shutdown_ssl(socket, true);
  16332. shutdown_socket(socket);
  16333. close_socket(socket);
  16334. success = false;
  16335. return false;
  16336. }
  16337. }
  16338. }
  16339. }
  16340. // If status code is not 200, proxy request is failed.
  16341. // Set error to ProxyConnection. A 407 is returned as the response of the
  16342. // request, so the caller sees the proxy asks for credentials; any other
  16343. // status would read as the answer of the origin, which it never reached.
  16344. if (proxy_res.status != StatusCode::OK_200) {
  16345. error = Error::ProxyConnection;
  16346. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  16347. res = std::move(proxy_res);
  16348. } else {
  16349. success = false;
  16350. }
  16351. // Thread-safe to close everything because we are assuming there are
  16352. // no requests in flight
  16353. shutdown_ssl(socket, true);
  16354. shutdown_socket(socket);
  16355. close_socket(socket);
  16356. return false;
  16357. }
  16358. return true;
  16359. }
  16360. inline bool SSLClient::ensure_socket_connection(Socket &socket, Error &error) {
  16361. if (!ClientImpl::ensure_socket_connection(socket, error)) { return false; }
  16362. if (is_proxy_enabled_for_host(host_)) { return true; }
  16363. if (!initialize_ssl(socket, error)) {
  16364. shutdown_socket(socket);
  16365. close_socket(socket);
  16366. return false;
  16367. }
  16368. return true;
  16369. }
  16370. // SSL HTTP client implementation
  16371. inline SSLClient::SSLClient(const std::string &host)
  16372. : SSLClient(host, 443, std::string(), std::string()) {}
  16373. inline SSLClient::SSLClient(const std::string &host, int port)
  16374. : SSLClient(host, port, std::string(), std::string()) {}
  16375. inline void SSLClient::init_ctx() {
  16376. ctx_ = tls::create_client_context();
  16377. if (ctx_) { tls::set_min_version(ctx_, tls::Version::TLS1_2); }
  16378. }
  16379. inline void SSLClient::reset_ctx_on_error() {
  16380. last_backend_error_ = tls::get_error();
  16381. tls::free_context(ctx_);
  16382. ctx_ = nullptr;
  16383. }
  16384. inline SSLClient::SSLClient(const std::string &host, int port,
  16385. const std::string &client_cert_path,
  16386. const std::string &client_key_path,
  16387. const std::string &private_key_password)
  16388. : ClientImpl(host, port, client_cert_path, client_key_path) {
  16389. init_ctx();
  16390. if (!ctx_) { return; }
  16391. if (!client_cert_path.empty() && !client_key_path.empty()) {
  16392. const char *password =
  16393. private_key_password.empty() ? nullptr : private_key_password.c_str();
  16394. if (!tls::set_client_cert_file(ctx_, client_cert_path.c_str(),
  16395. client_key_path.c_str(), password)) {
  16396. reset_ctx_on_error();
  16397. }
  16398. }
  16399. }
  16400. inline SSLClient::SSLClient(const std::string &host, int port,
  16401. const PemMemory &pem)
  16402. : ClientImpl(host, port) {
  16403. init_ctx();
  16404. if (!ctx_) { return; }
  16405. if (pem.cert_pem && pem.key_pem) {
  16406. std::string cert_buf, key_buf;
  16407. if (!tls::set_client_cert_pem(
  16408. ctx_, detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  16409. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  16410. pem.private_key_password)) {
  16411. reset_ctx_on_error();
  16412. }
  16413. }
  16414. }
  16415. inline void SSLClient::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16416. if (ca_cert_store && ctx_) {
  16417. // set_ca_store takes ownership of ca_cert_store
  16418. tls::set_ca_store(ctx_, ca_cert_store);
  16419. ca_cert_store_set_ = true;
  16420. } else if (ca_cert_store) {
  16421. tls::free_ca_store(ca_cert_store);
  16422. }
  16423. }
  16424. inline void
  16425. SSLClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16426. if (!ctx_) { return; }
  16427. server_certificate_verifier_ = verifier;
  16428. // Under the lock that creating a session from ctx_ takes
  16429. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16430. tls::set_verify_callback(ctx_, std::move(verifier));
  16431. }
  16432. inline void SSLClient::set_session_verifier(
  16433. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16434. session_verifier_ = std::move(verifier);
  16435. }
  16436. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16437. inline void SSLClient::enable_windows_certificate_verification(bool enabled) {
  16438. enable_windows_cert_verification_ = enabled;
  16439. }
  16440. #endif
  16441. inline void SSLClient::load_ca_cert_store(const char *ca_cert,
  16442. std::size_t size) {
  16443. if (ctx_ && ca_cert && size > 0) {
  16444. // Every PEM loaded, for redirect transfer
  16445. if (!ca_cert_pem_.empty() && ca_cert_pem_.back() != '\n') {
  16446. ca_cert_pem_ += '\n';
  16447. }
  16448. ca_cert_pem_.append(ca_cert, size);
  16449. tls::load_ca_pem(ctx_, ca_cert, size);
  16450. }
  16451. }
  16452. inline bool SSLClient::load_certs() {
  16453. auto ret = true;
  16454. // call_once rather than the plain flag WebSocketClient::create_stream() uses:
  16455. // one client is shared across concurrent requests here.
  16456. std::call_once(initialize_cert_, [&]() {
  16457. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16458. ret = detail::load_client_ca_config(
  16459. ctx_, ca_cert_file_path_, ca_cert_dir_path_,
  16460. !ca_cert_pem_.empty() || ca_cert_store_set_, system_ca_mode_,
  16461. last_backend_error_);
  16462. });
  16463. return ret;
  16464. }
  16465. inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) {
  16466. // Load CA certificates if server verification is enabled
  16467. if (server_certificate_verification_) {
  16468. if (!load_certs()) {
  16469. error = Error::SSLLoadingCerts;
  16470. return false;
  16471. }
  16472. }
  16473. detail::ClientTlsSessionOptions options;
  16474. options.server_hostname_verification = server_hostname_verification_;
  16475. options.session_verifier = session_verifier_;
  16476. options.ctx_mutex = &ctx_mutex_;
  16477. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16478. // Skip Schannel when a custom CA cert is specified, as the Windows
  16479. // certificate store would not know about user-provided CA certificates.
  16480. // Also skip when system CA trust is explicitly disabled.
  16481. options.windows_cert_verification =
  16482. enable_windows_cert_verification_ &&
  16483. system_ca_mode_ != SystemCAMode::Disabled && ca_cert_file_path_.empty() &&
  16484. ca_cert_dir_path_.empty() && ca_cert_pem_.empty() && !ca_cert_store_set_;
  16485. // Only a verifier set through set_server_certificate_verifier() is seen
  16486. // here, not one installed with tls::set_verify_callback() directly.
  16487. options.server_certificate_verifier_set =
  16488. static_cast<bool>(server_certificate_verifier_);
  16489. #endif
  16490. tls::session_t session = nullptr;
  16491. // Use scope_exit to ensure session is freed on error paths
  16492. bool success = false;
  16493. auto session_guard = detail::scope_exit([&] {
  16494. if (!success) { tls::free_session(session); }
  16495. });
  16496. detail::ClientTlsSessionError tls_error;
  16497. if (!detail::setup_client_tls_session(
  16498. host_, ctx_, session, socket.sock, server_certificate_verification_,
  16499. connection_timeout_sec_, connection_timeout_usec_, &tls_error,
  16500. options)) {
  16501. error = tls_error.error;
  16502. last_ssl_error_ = tls_error.ssl_error;
  16503. last_backend_error_ = tls_error.backend_error;
  16504. return false;
  16505. }
  16506. success = true;
  16507. socket.ssl = session;
  16508. return true;
  16509. }
  16510. inline void Client::set_digest_auth(const std::string &username,
  16511. const std::string &password) {
  16512. cli_->set_digest_auth(username, password);
  16513. }
  16514. inline void Client::set_proxy_digest_auth(const std::string &username,
  16515. const std::string &password) {
  16516. cli_->set_proxy_digest_auth(username, password);
  16517. }
  16518. inline void Client::enable_server_certificate_verification(bool enabled) {
  16519. cli_->enable_server_certificate_verification(enabled);
  16520. }
  16521. inline void Client::enable_server_hostname_verification(bool enabled) {
  16522. cli_->enable_server_hostname_verification(enabled);
  16523. }
  16524. inline void Client::enable_system_ca(bool enabled) {
  16525. cli_->enable_system_ca(enabled);
  16526. }
  16527. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16528. inline void Client::enable_windows_certificate_verification(bool enabled) {
  16529. if (is_ssl_) {
  16530. static_cast<SSLClient &>(*cli_).enable_windows_certificate_verification(
  16531. enabled);
  16532. }
  16533. }
  16534. #endif
  16535. inline void Client::set_ca_cert_path(const std::string &ca_cert_file_path,
  16536. const std::string &ca_cert_dir_path) {
  16537. cli_->set_ca_cert_path(ca_cert_file_path, ca_cert_dir_path);
  16538. }
  16539. inline void Client::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16540. if (is_ssl_) {
  16541. static_cast<SSLClient &>(*cli_).set_ca_cert_store(ca_cert_store);
  16542. } else if (ca_cert_store) {
  16543. tls::free_ca_store(ca_cert_store);
  16544. }
  16545. }
  16546. inline void Client::load_ca_cert_store(const char *ca_cert, std::size_t size) {
  16547. if (is_ssl_) {
  16548. // Use the PEM-based path so the CA data is retained for redirect transfer
  16549. static_cast<SSLClient &>(*cli_).load_ca_cert_store(ca_cert, size);
  16550. }
  16551. }
  16552. inline void
  16553. Client::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16554. if (is_ssl_) {
  16555. static_cast<SSLClient &>(*cli_).set_server_certificate_verifier(
  16556. std::move(verifier));
  16557. }
  16558. }
  16559. inline void Client::set_session_verifier(
  16560. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16561. if (is_ssl_) {
  16562. static_cast<SSLClient &>(*cli_).set_session_verifier(std::move(verifier));
  16563. }
  16564. }
  16565. inline tls::ctx_t Client::tls_context() const {
  16566. if (is_ssl_) { return static_cast<SSLClient &>(*cli_).tls_context(); }
  16567. return nullptr;
  16568. }
  16569. #endif // CPPHTTPLIB_SSL_ENABLED
  16570. /*
  16571. * Group 7: TLS abstraction layer - Common API
  16572. */
  16573. #ifdef CPPHTTPLIB_SSL_ENABLED
  16574. namespace tls {
  16575. // Helper for PeerCert construction
  16576. inline PeerCert get_peer_cert_from_session(const_session_t session) {
  16577. return PeerCert(get_peer_cert(session));
  16578. }
  16579. namespace impl {
  16580. // set_verify_callback() can replace a callback while handshakes on other
  16581. // threads run it, so they share it, and take their reference under this lock.
  16582. inline std::mutex &verify_callback_mutex() {
  16583. static std::mutex mutex;
  16584. return mutex;
  16585. }
  16586. // The TLS libraries are C, so an exception from a verify callback must not
  16587. // unwind through them. It rejects the certificate instead.
  16588. inline bool run_verify_callback(const VerifyCallback &callback,
  16589. const VerifyContext &ctx) {
  16590. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  16591. return callback(ctx);
  16592. #else
  16593. try {
  16594. return callback(ctx);
  16595. } catch (...) { return false; }
  16596. #endif
  16597. }
  16598. // Check if a string is an IPv4 address
  16599. inline bool is_ipv4_address(const std::string &str) {
  16600. int dots = 0;
  16601. for (char c : str) {
  16602. if (c == '.') {
  16603. dots++;
  16604. } else if (!detail::is_ascii_digit(c)) {
  16605. return false;
  16606. }
  16607. }
  16608. return dots == 3;
  16609. }
  16610. // Parse IPv4 address string to bytes
  16611. inline bool parse_ipv4(const std::string &str, unsigned char *out) {
  16612. const char *p = str.c_str();
  16613. for (int i = 0; i < 4; i++) {
  16614. if (i > 0) {
  16615. if (*p != '.') { return false; }
  16616. p++;
  16617. }
  16618. int val = 0;
  16619. int digits = 0;
  16620. while (detail::is_ascii_digit(*p)) {
  16621. val = val * 10 + (*p - '0');
  16622. if (val > 255) { return false; }
  16623. p++;
  16624. digits++;
  16625. }
  16626. if (digits == 0) { return false; }
  16627. // Reject leading zeros (e.g., "01.002.03.04") to prevent ambiguity
  16628. if (digits > 1 && *(p - digits) == '0') { return false; }
  16629. out[i] = static_cast<unsigned char>(val);
  16630. }
  16631. return *p == '\0';
  16632. }
  16633. // Parse an IP literal (IPv4 or IPv6) into raw network-order bytes.
  16634. // `out` must have room for at least 16 bytes. Returns the address length
  16635. // (4 for IPv4, 16 for IPv6) on success, or 0 if the string is not an IP
  16636. // literal. Used to match a host against iPAddress SANs the same way the
  16637. // OpenSSL backend does via X509_check_ip.
  16638. inline size_t parse_ip_address(const std::string &str, unsigned char *out) {
  16639. if (is_ipv4_address(str)) { return parse_ipv4(str, out) ? 4 : 0; }
  16640. struct in6_addr addr6 = {};
  16641. if (inet_pton(AF_INET6, str.c_str(), &addr6) == 1) {
  16642. memcpy(out, &addr6, 16);
  16643. return 16;
  16644. }
  16645. return 0;
  16646. }
  16647. #ifdef _WIN32
  16648. // Enumerate Windows system certificates and call callback with DER data
  16649. template <typename Callback>
  16650. inline bool enumerate_windows_system_certs(Callback cb) {
  16651. bool loaded = false;
  16652. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16653. for (auto store_name : store_names) {
  16654. HCERTSTORE hStore = CertOpenSystemStoreW(0, store_name);
  16655. if (hStore) {
  16656. PCCERT_CONTEXT pContext = nullptr;
  16657. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16658. nullptr) {
  16659. if (cb(pContext->pbCertEncoded, pContext->cbCertEncoded)) {
  16660. loaded = true;
  16661. }
  16662. }
  16663. CertCloseStore(hStore, 0);
  16664. }
  16665. }
  16666. return loaded;
  16667. }
  16668. #endif
  16669. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16670. // Enumerate macOS Keychain certificates and call callback with DER data
  16671. template <typename Callback>
  16672. inline bool enumerate_macos_keychain_certs(Callback cb) {
  16673. bool loaded = false;
  16674. const SecTrustSettingsDomain domains[] = {
  16675. kSecTrustSettingsDomainSystem,
  16676. kSecTrustSettingsDomainAdmin,
  16677. kSecTrustSettingsDomainUser,
  16678. };
  16679. for (auto domain : domains) {
  16680. CFArrayRef certs = nullptr;
  16681. OSStatus status = SecTrustSettingsCopyCertificates(domain, &certs);
  16682. if (status != errSecSuccess || !certs) {
  16683. if (certs) CFRelease(certs);
  16684. continue;
  16685. }
  16686. CFIndex count = CFArrayGetCount(certs);
  16687. for (CFIndex i = 0; i < count; i++) {
  16688. SecCertificateRef cert =
  16689. (SecCertificateRef)CFArrayGetValueAtIndex(certs, i);
  16690. CFDataRef data = SecCertificateCopyData(cert);
  16691. if (data) {
  16692. if (cb(CFDataGetBytePtr(data),
  16693. static_cast<size_t>(CFDataGetLength(data)))) {
  16694. loaded = true;
  16695. }
  16696. CFRelease(data);
  16697. }
  16698. }
  16699. CFRelease(certs);
  16700. }
  16701. return loaded;
  16702. }
  16703. #endif
  16704. #if !defined(_WIN32) && !(defined(__APPLE__) && \
  16705. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN))
  16706. // Common CA certificate file paths on Linux/Unix
  16707. inline const char **system_ca_paths() {
  16708. static const char *paths[] = {
  16709. "/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu
  16710. "/etc/pki/tls/certs/ca-bundle.crt", // RHEL/CentOS
  16711. "/etc/ssl/ca-bundle.pem", // OpenSUSE
  16712. "/etc/pki/tls/cacert.pem", // OpenELEC
  16713. "/etc/ssl/cert.pem", // Alpine, FreeBSD
  16714. nullptr};
  16715. return paths;
  16716. }
  16717. // Common CA certificate directory paths on Linux/Unix
  16718. inline const char **system_ca_dirs() {
  16719. static const char *dirs[] = {"/etc/ssl/certs", // Debian/Ubuntu
  16720. "/etc/pki/tls/certs", // RHEL/CentOS
  16721. "/usr/share/ca-certificates", // Other
  16722. nullptr};
  16723. return dirs;
  16724. }
  16725. #endif
  16726. } // namespace impl
  16727. inline bool set_client_ca_file(ctx_t ctx, const char *ca_file,
  16728. const char *ca_dir) {
  16729. if (!ctx) { return false; }
  16730. bool success = true;
  16731. if (ca_file && *ca_file) {
  16732. if (!load_ca_file(ctx, ca_file)) { success = false; }
  16733. }
  16734. if (ca_dir && *ca_dir) {
  16735. if (!load_ca_dir(ctx, ca_dir)) { success = false; }
  16736. }
  16737. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16738. // Set CA list for client certificate request (CertificateRequest message)
  16739. if (ca_file && *ca_file) {
  16740. auto list = SSL_load_client_CA_file(ca_file);
  16741. if (list) { SSL_CTX_set_client_CA_list(static_cast<SSL_CTX *>(ctx), list); }
  16742. }
  16743. #endif
  16744. return success;
  16745. }
  16746. inline bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16747. const char *password) {
  16748. return set_client_cert_pem(ctx, cert, key, password);
  16749. }
  16750. inline bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  16751. const char *key_path, const char *password) {
  16752. return set_client_cert_file(ctx, cert_path, key_path, password);
  16753. }
  16754. // PeerCert implementation
  16755. inline PeerCert::PeerCert() = default;
  16756. inline PeerCert::PeerCert(cert_t cert) : cert_(cert) {}
  16757. inline PeerCert::PeerCert(PeerCert &&other) noexcept : cert_(other.cert_) {
  16758. other.cert_ = nullptr;
  16759. }
  16760. inline PeerCert &PeerCert::operator=(PeerCert &&other) noexcept {
  16761. if (this != &other) {
  16762. if (cert_) { free_cert(cert_); }
  16763. cert_ = other.cert_;
  16764. other.cert_ = nullptr;
  16765. }
  16766. return *this;
  16767. }
  16768. inline PeerCert::~PeerCert() {
  16769. if (cert_) { free_cert(cert_); }
  16770. }
  16771. inline PeerCert::operator bool() const { return cert_ != nullptr; }
  16772. inline std::string PeerCert::subject_cn() const {
  16773. return cert_ ? get_cert_subject_cn(cert_) : std::string();
  16774. }
  16775. inline std::string PeerCert::issuer_name() const {
  16776. return cert_ ? get_cert_issuer_name(cert_) : std::string();
  16777. }
  16778. inline bool PeerCert::check_hostname(const char *hostname) const {
  16779. return cert_ ? verify_hostname(cert_, hostname) : false;
  16780. }
  16781. inline std::vector<SanEntry> PeerCert::sans() const {
  16782. std::vector<SanEntry> result;
  16783. if (cert_) { get_cert_sans(cert_, result); }
  16784. return result;
  16785. }
  16786. inline bool PeerCert::validity(time_t &not_before, time_t &not_after) const {
  16787. return cert_ ? get_cert_validity(cert_, not_before, not_after) : false;
  16788. }
  16789. inline std::string PeerCert::serial() const {
  16790. return cert_ ? get_cert_serial(cert_) : std::string();
  16791. }
  16792. // VerifyContext method implementations
  16793. inline std::string VerifyContext::subject_cn() const {
  16794. return cert ? get_cert_subject_cn(cert) : std::string();
  16795. }
  16796. inline std::string VerifyContext::issuer_name() const {
  16797. return cert ? get_cert_issuer_name(cert) : std::string();
  16798. }
  16799. inline bool VerifyContext::check_hostname(const char *hostname) const {
  16800. return cert ? verify_hostname(cert, hostname) : false;
  16801. }
  16802. inline std::vector<SanEntry> VerifyContext::sans() const {
  16803. std::vector<SanEntry> result;
  16804. if (cert) { get_cert_sans(cert, result); }
  16805. return result;
  16806. }
  16807. inline bool VerifyContext::validity(time_t &not_before,
  16808. time_t &not_after) const {
  16809. return cert ? get_cert_validity(cert, not_before, not_after) : false;
  16810. }
  16811. inline std::string VerifyContext::serial() const {
  16812. return cert ? get_cert_serial(cert) : std::string();
  16813. }
  16814. // TlsError static method implementation
  16815. inline std::string TlsError::verify_error_to_string(long error_code) {
  16816. return verify_error_string(error_code);
  16817. }
  16818. } // namespace tls
  16819. // Request::peer_cert() implementation
  16820. inline tls::PeerCert Request::peer_cert() const {
  16821. return tls::get_peer_cert_from_session(ssl);
  16822. }
  16823. // Request::sni() implementation
  16824. inline std::string Request::sni() const {
  16825. if (!ssl) { return std::string(); }
  16826. const char *s = tls::get_sni(ssl);
  16827. return s ? std::string(s) : std::string();
  16828. }
  16829. #endif // CPPHTTPLIB_SSL_ENABLED
  16830. /*
  16831. * Group 8: TLS abstraction layer - OpenSSL backend
  16832. */
  16833. /*
  16834. * OpenSSL Backend Implementation
  16835. */
  16836. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16837. namespace tls {
  16838. namespace impl {
  16839. // Helper to map OpenSSL SSL_get_error to ErrorCode
  16840. inline ErrorCode map_ssl_error(int ssl_error, int &out_errno) {
  16841. switch (ssl_error) {
  16842. case SSL_ERROR_NONE: return ErrorCode::Success;
  16843. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  16844. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  16845. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  16846. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  16847. case SSL_ERROR_SSL:
  16848. default: return ErrorCode::Fatal;
  16849. }
  16850. }
  16851. // Helper: Create client CA list from PEM string
  16852. // Returns a new STACK_OF(X509_NAME)* or nullptr on failure
  16853. // Caller takes ownership of returned list
  16854. inline STACK_OF(X509_NAME) *
  16855. create_client_ca_list_from_pem(const char *ca_pem) {
  16856. if (!ca_pem) { return nullptr; }
  16857. auto ca_list = sk_X509_NAME_new_null();
  16858. if (!ca_list) { return nullptr; }
  16859. BIO *bio = BIO_new_mem_buf(ca_pem, -1);
  16860. if (!bio) {
  16861. sk_X509_NAME_pop_free(ca_list, X509_NAME_free);
  16862. return nullptr;
  16863. }
  16864. X509 *cert = nullptr;
  16865. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16866. nullptr) {
  16867. const X509_NAME *name = X509_get_subject_name(cert);
  16868. if (name) {
  16869. sk_X509_NAME_push(ca_list, X509_NAME_dup(const_cast<X509_NAME *>(name)));
  16870. }
  16871. X509_free(cert);
  16872. }
  16873. BIO_free(bio);
  16874. return ca_list;
  16875. }
  16876. inline void free_verify_callback(void * /*parent*/, void *ptr,
  16877. CRYPTO_EX_DATA * /*ad*/, int /*idx*/,
  16878. long /*argl*/, void * /*argp*/) {
  16879. delete static_cast<std::shared_ptr<VerifyCallback> *>(ptr);
  16880. }
  16881. // The SSL_CTX owns its verify callback, so each client or server sees only
  16882. // its own, on whichever thread runs the handshake.
  16883. inline int verify_callback_index() {
  16884. static const auto index = SSL_CTX_get_ex_new_index(
  16885. 0, nullptr, nullptr, nullptr, free_verify_callback);
  16886. return index;
  16887. }
  16888. // OpenSSL verify callback wrapper
  16889. inline int openssl_verify_callback(int preverify_ok, X509_STORE_CTX *ctx) {
  16890. // Get SSL object from X509_STORE_CTX
  16891. auto ssl = static_cast<SSL *>(
  16892. X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
  16893. if (!ssl) { return preverify_ok; }
  16894. std::shared_ptr<VerifyCallback> callback;
  16895. {
  16896. std::lock_guard<std::mutex> guard(verify_callback_mutex());
  16897. auto stored = static_cast<std::shared_ptr<VerifyCallback> *>(
  16898. SSL_CTX_get_ex_data(SSL_get_SSL_CTX(ssl), verify_callback_index()));
  16899. if (stored) { callback = *stored; }
  16900. }
  16901. if (!callback) { return preverify_ok; }
  16902. // Get current certificate and depth
  16903. auto cert = X509_STORE_CTX_get_current_cert(ctx);
  16904. int depth = X509_STORE_CTX_get_error_depth(ctx);
  16905. int error = X509_STORE_CTX_get_error(ctx);
  16906. // Build context
  16907. VerifyContext verify_ctx;
  16908. verify_ctx.session = static_cast<session_t>(ssl);
  16909. verify_ctx.cert = static_cast<cert_t>(cert);
  16910. verify_ctx.depth = depth;
  16911. verify_ctx.preverify_ok = (preverify_ok != 0);
  16912. verify_ctx.error_code = error;
  16913. verify_ctx.error_string =
  16914. (error != X509_V_OK) ? X509_verify_cert_error_string(error) : nullptr;
  16915. return run_verify_callback(*callback, verify_ctx) ? 1 : 0;
  16916. }
  16917. // Sets the verify mode from whether the peer's certificate is required and
  16918. // whether a verify callback is set.
  16919. inline void apply_verify_mode(SSL_CTX *ssl_ctx, bool require) {
  16920. auto has_callback =
  16921. SSL_CTX_get_ex_data(ssl_ctx, verify_callback_index()) != nullptr;
  16922. auto mode = require ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  16923. : (has_callback ? SSL_VERIFY_PEER : SSL_VERIFY_NONE);
  16924. SSL_CTX_set_verify(ssl_ctx, mode,
  16925. has_callback ? openssl_verify_callback : nullptr);
  16926. }
  16927. // X509_STORE_get0_objects is deprecated since OpenSSL 4.0 because it is not
  16928. // thread-safe; X509_STORE_get1_objects (OpenSSL 3.3+) returns a snapshot
  16929. // that must be released with release_store_objects
  16930. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER) && \
  16931. OPENSSL_VERSION_NUMBER >= 0x30300000L
  16932. #define CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16933. #endif
  16934. inline STACK_OF(X509_OBJECT) * get_store_objects(X509_STORE *store) {
  16935. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16936. return X509_STORE_get1_objects(store);
  16937. #else
  16938. return X509_STORE_get0_objects(store);
  16939. #endif
  16940. }
  16941. inline void release_store_objects(STACK_OF(X509_OBJECT) * objs) {
  16942. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16943. sk_X509_OBJECT_pop_free(objs, X509_OBJECT_free);
  16944. #else
  16945. (void)objs; // get0 variant returns an internal pointer; nothing to free
  16946. #endif
  16947. }
  16948. } // namespace impl
  16949. inline ctx_t create_client_context() {
  16950. SSL_CTX *ctx = SSL_CTX_new(TLS_client_method());
  16951. if (ctx) {
  16952. // Disable auto-retry to properly handle non-blocking I/O
  16953. SSL_CTX_clear_mode(ctx, SSL_MODE_AUTO_RETRY);
  16954. // Set minimum TLS version
  16955. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16956. }
  16957. return static_cast<ctx_t>(ctx);
  16958. }
  16959. inline void free_context(ctx_t ctx) {
  16960. if (ctx) { SSL_CTX_free(static_cast<SSL_CTX *>(ctx)); }
  16961. }
  16962. inline bool set_min_version(ctx_t ctx, Version version) {
  16963. if (!ctx) return false;
  16964. return SSL_CTX_set_min_proto_version(static_cast<SSL_CTX *>(ctx),
  16965. static_cast<uint16_t>(version)) == 1;
  16966. }
  16967. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  16968. if (!ctx || !pem || len == 0) return false;
  16969. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16970. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16971. if (!store) return false;
  16972. auto bio = BIO_new_mem_buf(pem, static_cast<int>(len));
  16973. if (!bio) return false;
  16974. bool ok = true;
  16975. X509 *cert = nullptr;
  16976. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16977. nullptr) {
  16978. if (X509_STORE_add_cert(store, cert) != 1) {
  16979. // Ignore duplicate errors
  16980. auto err = ERR_peek_last_error();
  16981. if (ERR_GET_REASON(err) != X509_R_CERT_ALREADY_IN_HASH_TABLE) {
  16982. ok = false;
  16983. }
  16984. }
  16985. X509_free(cert);
  16986. if (!ok) break;
  16987. }
  16988. BIO_free(bio);
  16989. // Clear any "no more certificates" errors
  16990. ERR_clear_error();
  16991. return ok;
  16992. }
  16993. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  16994. if (!ctx || !file_path) return false;
  16995. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), file_path,
  16996. nullptr) == 1;
  16997. }
  16998. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  16999. if (!ctx || !dir_path) return false;
  17000. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), nullptr,
  17001. dir_path) == 1;
  17002. }
  17003. inline bool load_system_certs(ctx_t ctx) {
  17004. if (!ctx) return false;
  17005. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17006. #ifdef _WIN32
  17007. // Windows: Load from system certificate store (ROOT and CA)
  17008. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17009. if (!store) return false;
  17010. bool loaded_any = false;
  17011. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  17012. for (auto store_name : store_names) {
  17013. auto hStore = CertOpenSystemStoreW(NULL, store_name);
  17014. if (!hStore) continue;
  17015. PCCERT_CONTEXT pContext = nullptr;
  17016. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  17017. nullptr) {
  17018. const unsigned char *data = pContext->pbCertEncoded;
  17019. auto x509 = d2i_X509(nullptr, &data, pContext->cbCertEncoded);
  17020. if (x509) {
  17021. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  17022. X509_free(x509);
  17023. }
  17024. }
  17025. CertCloseStore(hStore, 0);
  17026. }
  17027. return loaded_any;
  17028. #elif defined(__APPLE__)
  17029. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  17030. // macOS: Load from Keychain
  17031. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17032. if (!store) return false;
  17033. bool loaded_any = false;
  17034. const SecTrustSettingsDomain domains[] = {
  17035. kSecTrustSettingsDomainSystem,
  17036. kSecTrustSettingsDomainAdmin,
  17037. kSecTrustSettingsDomainUser,
  17038. };
  17039. for (auto domain : domains) {
  17040. CFArrayRef certs = nullptr;
  17041. if (SecTrustSettingsCopyCertificates(domain, &certs) != errSecSuccess ||
  17042. !certs) {
  17043. if (certs) CFRelease(certs);
  17044. continue;
  17045. }
  17046. auto count = CFArrayGetCount(certs);
  17047. for (CFIndex i = 0; i < count; i++) {
  17048. auto cert = reinterpret_cast<SecCertificateRef>(
  17049. const_cast<void *>(CFArrayGetValueAtIndex(certs, i)));
  17050. CFDataRef der = SecCertificateCopyData(cert);
  17051. if (der) {
  17052. const unsigned char *data = CFDataGetBytePtr(der);
  17053. auto x509 = d2i_X509(nullptr, &data, CFDataGetLength(der));
  17054. if (x509) {
  17055. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  17056. X509_free(x509);
  17057. }
  17058. CFRelease(der);
  17059. }
  17060. }
  17061. CFRelease(certs);
  17062. }
  17063. return loaded_any || SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17064. #else
  17065. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17066. #endif
  17067. #else
  17068. // Other Unix: use default verify paths
  17069. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17070. #endif
  17071. }
  17072. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17073. const char *password) {
  17074. if (!ctx || !cert || !key) return false;
  17075. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17076. // Load certificate
  17077. auto cert_bio = BIO_new_mem_buf(cert, -1);
  17078. if (!cert_bio) return false;
  17079. auto x509 = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  17080. BIO_free(cert_bio);
  17081. if (!x509) return false;
  17082. auto cert_ok = SSL_CTX_use_certificate(ssl_ctx, x509) == 1;
  17083. X509_free(x509);
  17084. if (!cert_ok) return false;
  17085. // Load private key
  17086. auto key_bio = BIO_new_mem_buf(key, -1);
  17087. if (!key_bio) return false;
  17088. auto pkey = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  17089. password ? const_cast<char *>(password)
  17090. : nullptr);
  17091. BIO_free(key_bio);
  17092. if (!pkey) return false;
  17093. auto key_ok = SSL_CTX_use_PrivateKey(ssl_ctx, pkey) == 1;
  17094. EVP_PKEY_free(pkey);
  17095. return key_ok && SSL_CTX_check_private_key(ssl_ctx) == 1;
  17096. }
  17097. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  17098. const char *key_path, const char *password) {
  17099. if (!ctx || !cert_path || !key_path) return false;
  17100. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17101. if (password && password[0] != '\0') {
  17102. SSL_CTX_set_default_passwd_cb_userdata(
  17103. ssl_ctx, reinterpret_cast<void *>(const_cast<char *>(password)));
  17104. }
  17105. return SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_path) == 1 &&
  17106. SSL_CTX_use_PrivateKey_file(ssl_ctx, key_path, SSL_FILETYPE_PEM) == 1;
  17107. }
  17108. inline ctx_t create_server_context() {
  17109. SSL_CTX *ctx = SSL_CTX_new(TLS_server_method());
  17110. if (ctx) {
  17111. // No renegotiation, as on the other backends: it would run a handshake
  17112. // that SSLServer::update_certs_pem() does not wait for
  17113. SSL_CTX_set_options(ctx, SSL_OP_NO_COMPRESSION |
  17114. SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION |
  17115. SSL_OP_NO_RENEGOTIATION);
  17116. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  17117. // Without one, a client resuming its session is sent a fatal alert once
  17118. // client certificates are verified.
  17119. static const unsigned char sid_ctx[] = "cpp-httplib";
  17120. SSL_CTX_set_session_id_context(ctx, sid_ctx, sizeof(sid_ctx) - 1);
  17121. }
  17122. return static_cast<ctx_t>(ctx);
  17123. }
  17124. inline void set_verify_client(ctx_t ctx, bool require) {
  17125. if (!ctx) return;
  17126. impl::apply_verify_mode(static_cast<SSL_CTX *>(ctx), require);
  17127. }
  17128. inline session_t create_session(ctx_t ctx, socket_t sock) {
  17129. if (!ctx || sock == INVALID_SOCKET) return nullptr;
  17130. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17131. SSL *ssl = SSL_new(ssl_ctx);
  17132. if (!ssl) return nullptr;
  17133. // Disable auto-retry for proper non-blocking I/O handling
  17134. SSL_clear_mode(ssl, SSL_MODE_AUTO_RETRY);
  17135. auto bio = BIO_new_socket(static_cast<int>(sock), BIO_NOCLOSE);
  17136. if (!bio) {
  17137. SSL_free(ssl);
  17138. return nullptr;
  17139. }
  17140. SSL_set_bio(ssl, bio, bio);
  17141. return static_cast<session_t>(ssl);
  17142. }
  17143. inline void free_session(session_t session) {
  17144. if (session) { SSL_free(static_cast<SSL *>(session)); }
  17145. }
  17146. inline bool set_sni(session_t session, const char *hostname,
  17147. bool /*verify_hostname*/) {
  17148. if (!session || !hostname) return false;
  17149. auto ssl = static_cast<SSL *>(session);
  17150. // Set SNI (Server Name Indication) only - does not enable verification.
  17151. // OpenSSL never binds identity checking to SNI (that happens post-
  17152. // handshake in setup_client_tls_session()), so verify_hostname is unused.
  17153. #if defined(OPENSSL_IS_BORINGSSL)
  17154. return SSL_set_tlsext_host_name(ssl, hostname) == 1;
  17155. #else
  17156. // Direct call instead of macro to suppress -Wold-style-cast warning
  17157. return SSL_ctrl(ssl, SSL_CTRL_SET_TLSEXT_HOSTNAME, TLSEXT_NAMETYPE_host_name,
  17158. static_cast<void *>(const_cast<char *>(hostname))) == 1;
  17159. #endif
  17160. }
  17161. inline TlsError connect(session_t session) {
  17162. if (!session) { return TlsError(); }
  17163. auto ssl = static_cast<SSL *>(session);
  17164. auto ret = SSL_connect(ssl);
  17165. TlsError err;
  17166. if (ret == 1) {
  17167. err.code = ErrorCode::Success;
  17168. } else {
  17169. auto ssl_err = SSL_get_error(ssl, ret);
  17170. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17171. err.backend_code = ERR_get_error();
  17172. }
  17173. return err;
  17174. }
  17175. inline TlsError accept(session_t session) {
  17176. if (!session) { return TlsError(); }
  17177. auto ssl = static_cast<SSL *>(session);
  17178. auto ret = SSL_accept(ssl);
  17179. TlsError err;
  17180. if (ret == 1) {
  17181. err.code = ErrorCode::Success;
  17182. } else {
  17183. auto ssl_err = SSL_get_error(ssl, ret);
  17184. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17185. err.backend_code = ERR_get_error();
  17186. }
  17187. return err;
  17188. }
  17189. inline bool connect_nonblocking(session_t session, socket_t sock,
  17190. time_t timeout_sec, time_t timeout_usec,
  17191. TlsError *err) {
  17192. if (!session) {
  17193. if (err) { err->code = ErrorCode::Fatal; }
  17194. return false;
  17195. }
  17196. auto ssl = static_cast<SSL *>(session);
  17197. auto bio = SSL_get_rbio(ssl);
  17198. // Set non-blocking mode for handshake
  17199. detail::set_nonblocking(sock, true);
  17200. if (bio) { BIO_set_nbio(bio, 1); }
  17201. auto cleanup = detail::scope_exit([&]() {
  17202. // Restore blocking mode after handshake
  17203. if (bio) { BIO_set_nbio(bio, 0); }
  17204. detail::set_nonblocking(sock, false);
  17205. });
  17206. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  17207. auto res = 0;
  17208. while ((res = SSL_connect(ssl)) != 1) {
  17209. auto ssl_err = SSL_get_error(ssl, res);
  17210. switch (ssl_err) {
  17211. case SSL_ERROR_WANT_READ:
  17212. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  17213. break;
  17214. case SSL_ERROR_WANT_WRITE:
  17215. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  17216. break;
  17217. default: break;
  17218. }
  17219. if (err) {
  17220. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  17221. err->backend_code = ERR_get_error();
  17222. }
  17223. return false;
  17224. }
  17225. if (err) { err->code = ErrorCode::Success; }
  17226. return true;
  17227. }
  17228. inline bool accept_nonblocking(session_t session, socket_t sock,
  17229. time_t timeout_sec, time_t timeout_usec,
  17230. TlsError *err) {
  17231. if (!session) {
  17232. if (err) { err->code = ErrorCode::Fatal; }
  17233. return false;
  17234. }
  17235. auto ssl = static_cast<SSL *>(session);
  17236. auto bio = SSL_get_rbio(ssl);
  17237. // Set non-blocking mode for handshake
  17238. detail::set_nonblocking(sock, true);
  17239. if (bio) { BIO_set_nbio(bio, 1); }
  17240. auto cleanup = detail::scope_exit([&]() {
  17241. // Restore blocking mode after handshake
  17242. if (bio) { BIO_set_nbio(bio, 0); }
  17243. detail::set_nonblocking(sock, false);
  17244. });
  17245. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  17246. auto res = 0;
  17247. while ((res = SSL_accept(ssl)) != 1) {
  17248. auto ssl_err = SSL_get_error(ssl, res);
  17249. switch (ssl_err) {
  17250. case SSL_ERROR_WANT_READ:
  17251. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  17252. break;
  17253. case SSL_ERROR_WANT_WRITE:
  17254. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  17255. break;
  17256. default: break;
  17257. }
  17258. if (err) {
  17259. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  17260. err->backend_code = ERR_get_error();
  17261. }
  17262. return false;
  17263. }
  17264. if (err) { err->code = ErrorCode::Success; }
  17265. return true;
  17266. }
  17267. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  17268. if (!session || !buf) {
  17269. err.code = ErrorCode::Fatal;
  17270. return -1;
  17271. }
  17272. auto ssl = static_cast<SSL *>(session);
  17273. constexpr auto max_len =
  17274. static_cast<size_t>((std::numeric_limits<int>::max)());
  17275. if (len > max_len) { len = max_len; }
  17276. auto ret = SSL_read(ssl, buf, static_cast<int>(len));
  17277. if (ret > 0) {
  17278. err.code = ErrorCode::Success;
  17279. return ret;
  17280. }
  17281. auto ssl_err = SSL_get_error(ssl, ret);
  17282. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17283. if (err.code == ErrorCode::PeerClosed) {
  17284. return 0;
  17285. } // Gracefully handle the peer closed state.
  17286. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  17287. return -1;
  17288. }
  17289. inline ssize_t write(session_t session, const void *buf, size_t len,
  17290. TlsError &err) {
  17291. if (!session || !buf) {
  17292. err.code = ErrorCode::Fatal;
  17293. return -1;
  17294. }
  17295. auto ssl = static_cast<SSL *>(session);
  17296. auto ret = SSL_write(ssl, buf, static_cast<int>(len));
  17297. if (ret > 0) {
  17298. err.code = ErrorCode::Success;
  17299. return ret;
  17300. }
  17301. auto ssl_err = SSL_get_error(ssl, ret);
  17302. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17303. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  17304. return -1;
  17305. }
  17306. inline int pending(const_session_t session) {
  17307. if (!session) return 0;
  17308. return SSL_pending(static_cast<SSL *>(const_cast<void *>(session)));
  17309. }
  17310. inline void shutdown(session_t session, bool graceful) {
  17311. if (!session) return;
  17312. auto ssl = static_cast<SSL *>(session);
  17313. if (graceful) {
  17314. // Send close_notify without waiting for the peer's. The connection is
  17315. // closed right after this, so a unidirectional shutdown is enough, and an
  17316. // idle peer that never answers would otherwise hold this thread until the
  17317. // read timeout. The other backends do not wait either.
  17318. SSL_shutdown(ssl);
  17319. }
  17320. }
  17321. inline bool is_peer_closed(session_t session, socket_t sock) {
  17322. if (!session) return true;
  17323. // Temporarily set socket to non-blocking to avoid blocking on SSL_peek
  17324. detail::set_nonblocking(sock, true);
  17325. auto se = detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17326. auto ssl = static_cast<SSL *>(session);
  17327. char buf;
  17328. auto ret = SSL_peek(ssl, &buf, 1);
  17329. if (ret > 0) return false;
  17330. auto err = SSL_get_error(ssl, ret);
  17331. return err == SSL_ERROR_ZERO_RETURN;
  17332. }
  17333. inline cert_t get_peer_cert(const_session_t session) {
  17334. if (!session) return nullptr;
  17335. return static_cast<cert_t>(SSL_get1_peer_certificate(
  17336. static_cast<SSL *>(const_cast<void *>(session))));
  17337. }
  17338. inline size_t get_peer_certs(const_session_t session,
  17339. std::vector<cert_t> &certs) {
  17340. certs.clear();
  17341. if (!session) { return 0; }
  17342. auto ssl = static_cast<const SSL *>(session);
  17343. // On the server side, the chain leaves out the peer's own certificate
  17344. if (SSL_is_server(ssl)) {
  17345. if (auto leaf = get_peer_cert(session)) { certs.push_back(leaf); }
  17346. }
  17347. if (auto sk = SSL_get_peer_cert_chain(ssl)) {
  17348. auto count = sk_X509_num(sk);
  17349. for (decltype(count) i = 0; i < count; i++) {
  17350. auto x509 = sk_X509_value(sk, i);
  17351. X509_up_ref(x509);
  17352. certs.push_back(static_cast<cert_t>(x509));
  17353. }
  17354. }
  17355. return certs.size();
  17356. }
  17357. inline void free_cert(cert_t cert) {
  17358. if (cert) { X509_free(static_cast<X509 *>(cert)); }
  17359. }
  17360. inline bool verify_hostname(cert_t cert, const char *hostname) {
  17361. if (!cert || !hostname) return false;
  17362. auto x509 = static_cast<X509 *>(cert);
  17363. // Use X509_check_ip_asc for IP addresses, X509_check_host for DNS names
  17364. if (detail::is_ip_address(hostname)) {
  17365. return X509_check_ip_asc(x509, hostname, 0) == 1;
  17366. }
  17367. return X509_check_host(x509, hostname, strlen(hostname), 0, nullptr) == 1;
  17368. }
  17369. inline uint64_t hostname_mismatch_code() {
  17370. return static_cast<uint64_t>(X509_V_ERR_HOSTNAME_MISMATCH);
  17371. }
  17372. inline long get_verify_result(const_session_t session) {
  17373. if (!session) return X509_V_ERR_UNSPECIFIED;
  17374. return SSL_get_verify_result(static_cast<SSL *>(const_cast<void *>(session)));
  17375. }
  17376. inline std::string get_cert_subject_cn(cert_t cert) {
  17377. if (!cert) return "";
  17378. auto x509 = static_cast<X509 *>(cert);
  17379. auto subject_name = X509_get_subject_name(x509);
  17380. if (!subject_name) return "";
  17381. // X509_NAME_get_text_by_NID is deprecated since OpenSSL 4.0
  17382. auto idx = X509_NAME_get_index_by_NID(subject_name, NID_commonName, -1);
  17383. if (idx < 0) return "";
  17384. auto entry = X509_NAME_get_entry(subject_name, idx);
  17385. if (!entry) return "";
  17386. auto data = X509_NAME_ENTRY_get_data(entry);
  17387. if (!data) return "";
  17388. return std::string(
  17389. reinterpret_cast<const char *>(ASN1_STRING_get0_data(data)),
  17390. static_cast<size_t>(ASN1_STRING_length(data)));
  17391. }
  17392. inline std::string get_cert_issuer_name(cert_t cert) {
  17393. if (!cert) return "";
  17394. auto x509 = static_cast<X509 *>(cert);
  17395. auto issuer_name = X509_get_issuer_name(x509);
  17396. if (!issuer_name) return "";
  17397. char buf[256];
  17398. X509_NAME_oneline(issuer_name, buf, sizeof(buf));
  17399. return std::string(buf);
  17400. }
  17401. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  17402. sans.clear();
  17403. if (!cert) return false;
  17404. auto x509 = static_cast<X509 *>(cert);
  17405. auto names = static_cast<GENERAL_NAMES *>(
  17406. X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  17407. if (!names) return true; // No SANs is valid
  17408. auto count = sk_GENERAL_NAME_num(names);
  17409. for (decltype(count) i = 0; i < count; i++) {
  17410. auto gen = sk_GENERAL_NAME_value(names, i);
  17411. if (!gen) continue;
  17412. SanEntry entry;
  17413. switch (gen->type) {
  17414. case GEN_DNS:
  17415. entry.type = SanType::DNS;
  17416. if (gen->d.dNSName) {
  17417. entry.value = std::string(
  17418. reinterpret_cast<const char *>(
  17419. ASN1_STRING_get0_data(gen->d.dNSName)),
  17420. static_cast<size_t>(ASN1_STRING_length(gen->d.dNSName)));
  17421. }
  17422. break;
  17423. case GEN_IPADD:
  17424. entry.type = SanType::IP;
  17425. if (gen->d.iPAddress) {
  17426. auto data = ASN1_STRING_get0_data(gen->d.iPAddress);
  17427. auto len = ASN1_STRING_length(gen->d.iPAddress);
  17428. if (len == 4) {
  17429. // IPv4
  17430. char buf[INET_ADDRSTRLEN];
  17431. inet_ntop(AF_INET, data, buf, sizeof(buf));
  17432. entry.value = buf;
  17433. } else if (len == 16) {
  17434. // IPv6
  17435. char buf[INET6_ADDRSTRLEN];
  17436. inet_ntop(AF_INET6, data, buf, sizeof(buf));
  17437. entry.value = buf;
  17438. }
  17439. }
  17440. break;
  17441. case GEN_EMAIL:
  17442. entry.type = SanType::EMAIL;
  17443. if (gen->d.rfc822Name) {
  17444. entry.value = std::string(
  17445. reinterpret_cast<const char *>(
  17446. ASN1_STRING_get0_data(gen->d.rfc822Name)),
  17447. static_cast<size_t>(ASN1_STRING_length(gen->d.rfc822Name)));
  17448. }
  17449. break;
  17450. case GEN_URI:
  17451. entry.type = SanType::URI;
  17452. if (gen->d.uniformResourceIdentifier) {
  17453. entry.value = std::string(
  17454. reinterpret_cast<const char *>(
  17455. ASN1_STRING_get0_data(gen->d.uniformResourceIdentifier)),
  17456. static_cast<size_t>(
  17457. ASN1_STRING_length(gen->d.uniformResourceIdentifier)));
  17458. }
  17459. break;
  17460. default: entry.type = SanType::OTHER; break;
  17461. }
  17462. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  17463. }
  17464. GENERAL_NAMES_free(names);
  17465. return true;
  17466. }
  17467. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  17468. time_t &not_after) {
  17469. if (!cert) return false;
  17470. auto x509 = static_cast<X509 *>(cert);
  17471. auto nb = X509_get0_notBefore(x509);
  17472. auto na = X509_get0_notAfter(x509);
  17473. if (!nb || !na) return false;
  17474. ASN1_TIME *epoch = ASN1_TIME_new();
  17475. if (!epoch) return false;
  17476. auto se = detail::scope_exit([&] { ASN1_TIME_free(epoch); });
  17477. if (!ASN1_TIME_set(epoch, 0)) return false;
  17478. int pday, psec;
  17479. if (!ASN1_TIME_diff(&pday, &psec, epoch, nb)) return false;
  17480. not_before = 86400 * (time_t)pday + psec;
  17481. if (!ASN1_TIME_diff(&pday, &psec, epoch, na)) return false;
  17482. not_after = 86400 * (time_t)pday + psec;
  17483. return true;
  17484. }
  17485. inline std::string get_cert_serial(cert_t cert) {
  17486. if (!cert) return "";
  17487. auto x509 = static_cast<X509 *>(cert);
  17488. auto serial = X509_get_serialNumber(x509);
  17489. if (!serial) return "";
  17490. auto bn = ASN1_INTEGER_to_BN(serial, nullptr);
  17491. if (!bn) return "";
  17492. auto hex = BN_bn2hex(bn);
  17493. BN_free(bn);
  17494. if (!hex) return "";
  17495. std::string result(hex);
  17496. OPENSSL_free(hex);
  17497. return result;
  17498. }
  17499. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  17500. if (!cert) return false;
  17501. auto x509 = static_cast<X509 *>(cert);
  17502. auto len = i2d_X509(x509, nullptr);
  17503. if (len < 0) return false;
  17504. der.resize(static_cast<size_t>(len));
  17505. auto p = der.data();
  17506. i2d_X509(x509, &p);
  17507. return true;
  17508. }
  17509. inline const char *get_sni(const_session_t session) {
  17510. if (!session) return nullptr;
  17511. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17512. return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
  17513. }
  17514. inline uint64_t peek_error() { return ERR_peek_last_error(); }
  17515. inline uint64_t get_error() { return ERR_get_error(); }
  17516. inline std::string error_string(uint64_t code) {
  17517. char buf[256];
  17518. ERR_error_string_n(static_cast<decltype(ERR_get_error())>(code), buf,
  17519. sizeof(buf));
  17520. return std::string(buf);
  17521. }
  17522. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  17523. auto mem = BIO_new_mem_buf(pem, static_cast<int>(len));
  17524. if (!mem) { return nullptr; }
  17525. auto mem_guard = detail::scope_exit([&] { BIO_free_all(mem); });
  17526. auto inf = PEM_X509_INFO_read_bio(mem, nullptr, nullptr, nullptr);
  17527. if (!inf) { return nullptr; }
  17528. auto store = X509_STORE_new();
  17529. if (store) {
  17530. auto count = sk_X509_INFO_num(inf);
  17531. for (decltype(count) i = 0; i < count; i++) {
  17532. auto itmp = sk_X509_INFO_value(inf, i);
  17533. if (!itmp) { continue; }
  17534. if (itmp->x509) { X509_STORE_add_cert(store, itmp->x509); }
  17535. if (itmp->crl) { X509_STORE_add_crl(store, itmp->crl); }
  17536. }
  17537. }
  17538. sk_X509_INFO_pop_free(inf, X509_INFO_free);
  17539. return static_cast<ca_store_t>(store);
  17540. }
  17541. inline void free_ca_store(ca_store_t store) {
  17542. if (store) { X509_STORE_free(static_cast<X509_STORE *>(store)); }
  17543. }
  17544. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  17545. if (!ctx || !store) { return false; }
  17546. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17547. auto x509_store = static_cast<X509_STORE *>(store);
  17548. // Check if same store is already set
  17549. if (SSL_CTX_get_cert_store(ssl_ctx) == x509_store) { return true; }
  17550. // SSL_CTX_set_cert_store takes ownership and frees the old store
  17551. SSL_CTX_set_cert_store(ssl_ctx, x509_store);
  17552. return true;
  17553. }
  17554. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  17555. certs.clear();
  17556. if (!ctx) { return 0; }
  17557. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17558. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17559. if (!store) { return 0; }
  17560. auto objs = impl::get_store_objects(store);
  17561. if (!objs) { return 0; }
  17562. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  17563. auto count = sk_X509_OBJECT_num(objs);
  17564. for (decltype(count) i = 0; i < count; i++) {
  17565. auto obj = sk_X509_OBJECT_value(objs, i);
  17566. if (!obj) { continue; }
  17567. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  17568. auto x509 = X509_OBJECT_get0_X509(obj);
  17569. if (x509) {
  17570. // Increment reference count so caller can free it
  17571. X509_up_ref(x509);
  17572. certs.push_back(static_cast<cert_t>(x509));
  17573. }
  17574. }
  17575. }
  17576. return certs.size();
  17577. }
  17578. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  17579. std::vector<std::string> names;
  17580. if (!ctx) { return names; }
  17581. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17582. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17583. if (!store) { return names; }
  17584. auto objs = impl::get_store_objects(store);
  17585. if (!objs) { return names; }
  17586. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  17587. auto count = sk_X509_OBJECT_num(objs);
  17588. for (decltype(count) i = 0; i < count; i++) {
  17589. auto obj = sk_X509_OBJECT_value(objs, i);
  17590. if (!obj) { continue; }
  17591. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  17592. auto x509 = X509_OBJECT_get0_X509(obj);
  17593. if (x509) {
  17594. auto subject = X509_get_subject_name(x509);
  17595. if (subject) {
  17596. char buf[512];
  17597. X509_NAME_oneline(subject, buf, sizeof(buf));
  17598. names.push_back(buf);
  17599. }
  17600. }
  17601. }
  17602. }
  17603. return names;
  17604. }
  17605. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  17606. const char *key_pem, const char *password) {
  17607. if (!ctx || !cert_pem || !key_pem) { return false; }
  17608. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17609. // Load certificate from PEM
  17610. auto cert_bio = BIO_new_mem_buf(cert_pem, -1);
  17611. if (!cert_bio) { return false; }
  17612. auto cert = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  17613. BIO_free(cert_bio);
  17614. if (!cert) { return false; }
  17615. // Load private key from PEM
  17616. auto key_bio = BIO_new_mem_buf(key_pem, -1);
  17617. if (!key_bio) {
  17618. X509_free(cert);
  17619. return false;
  17620. }
  17621. auto key = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  17622. password ? const_cast<char *>(password)
  17623. : nullptr);
  17624. BIO_free(key_bio);
  17625. if (!key) {
  17626. X509_free(cert);
  17627. return false;
  17628. }
  17629. // Update certificate and key
  17630. auto ret = SSL_CTX_use_certificate(ssl_ctx, cert) == 1 &&
  17631. SSL_CTX_use_PrivateKey(ssl_ctx, key) == 1;
  17632. X509_free(cert);
  17633. EVP_PKEY_free(key);
  17634. return ret;
  17635. }
  17636. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  17637. if (!ctx || !ca_pem) { return false; }
  17638. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17639. // Create new X509_STORE from PEM
  17640. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  17641. if (!store) { return false; }
  17642. // A resumed session is not verified again, so the ticket keys from before
  17643. // go, or a client verified under the old CAs could go on resuming.
  17644. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  17645. unsigned char ticket_keys[48];
  17646. #else
  17647. unsigned char ticket_keys[80];
  17648. #endif
  17649. if (RAND_bytes(ticket_keys, sizeof(ticket_keys)) != 1 ||
  17650. SSL_CTX_set_tlsext_ticket_keys(ssl_ctx, ticket_keys,
  17651. sizeof(ticket_keys)) != 1) {
  17652. free_ca_store(store);
  17653. return false;
  17654. }
  17655. // SSL_CTX_set_cert_store takes ownership
  17656. SSL_CTX_set_cert_store(ssl_ctx, static_cast<X509_STORE *>(store));
  17657. // Set client CA list for client certificate request
  17658. auto ca_list = impl::create_client_ca_list_from_pem(ca_pem);
  17659. if (ca_list) {
  17660. // SSL_CTX_set_client_CA_list takes ownership of ca_list
  17661. SSL_CTX_set_client_CA_list(ssl_ctx, ca_list);
  17662. }
  17663. // The cached sessions go for the same reason.
  17664. #if OPENSSL_VERSION_NUMBER >= 0x30400000L
  17665. SSL_CTX_flush_sessions_ex(ssl_ctx, (std::numeric_limits<time_t>::max)());
  17666. #else
  17667. SSL_CTX_flush_sessions(ssl_ctx, (std::numeric_limits<long>::max)());
  17668. #endif
  17669. return true;
  17670. }
  17671. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  17672. if (!ctx) { return false; }
  17673. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17674. auto index = impl::verify_callback_index();
  17675. if (index < 0) { return false; }
  17676. std::shared_ptr<VerifyCallback> *stored = nullptr;
  17677. if (callback) {
  17678. stored = new std::shared_ptr<VerifyCallback>(
  17679. std::make_shared<VerifyCallback>(std::move(callback)));
  17680. }
  17681. std::shared_ptr<VerifyCallback> *previous = nullptr;
  17682. {
  17683. std::lock_guard<std::mutex> guard(impl::verify_callback_mutex());
  17684. previous = static_cast<std::shared_ptr<VerifyCallback> *>(
  17685. SSL_CTX_get_ex_data(ssl_ctx, index));
  17686. if (SSL_CTX_set_ex_data(ssl_ctx, index, stored) != 1) {
  17687. delete stored;
  17688. return false;
  17689. }
  17690. }
  17691. // A handshake running the previous callback keeps it until it returns.
  17692. delete previous;
  17693. // A resumed handshake shows no certificate to run the callback on.
  17694. if (stored) {
  17695. SSL_CTX_set_options(ssl_ctx, SSL_OP_NO_TICKET);
  17696. SSL_CTX_set_session_cache_mode(ssl_ctx, SSL_SESS_CACHE_OFF);
  17697. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER)
  17698. // TLS 1.3 tickets, which SSL_OP_NO_TICKET leaves on
  17699. SSL_CTX_set_num_tickets(ssl_ctx, 0);
  17700. #endif
  17701. }
  17702. // Keep requiring the peer's certificate if set_verify_client() asked for it
  17703. auto require =
  17704. (SSL_CTX_get_verify_mode(ssl_ctx) & SSL_VERIFY_FAIL_IF_NO_PEER_CERT) != 0;
  17705. impl::apply_verify_mode(ssl_ctx, require);
  17706. return true;
  17707. }
  17708. inline long get_verify_error(const_session_t session) {
  17709. if (!session) { return -1; }
  17710. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17711. return SSL_get_verify_result(ssl);
  17712. }
  17713. inline std::string verify_error_string(long error_code) {
  17714. if (error_code == X509_V_OK) { return ""; }
  17715. const char *str = X509_verify_cert_error_string(static_cast<int>(error_code));
  17716. return str ? str : "unknown error";
  17717. }
  17718. } // namespace tls
  17719. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  17720. /*
  17721. * Group 9: TLS abstraction layer - Mbed TLS backend
  17722. */
  17723. /*
  17724. * Mbed TLS Backend Implementation
  17725. */
  17726. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  17727. namespace tls {
  17728. namespace impl {
  17729. // Mbed TLS session wrapper
  17730. struct MbedTlsSession {
  17731. mbedtls_ssl_context ssl;
  17732. socket_t sock = INVALID_SOCKET;
  17733. std::string hostname; // For client: set via set_sni
  17734. std::string sni_hostname; // For server: received from client via SNI callback
  17735. // Mbed TLS has no SSL_peek() equivalent, so is_peer_closed() must probe with
  17736. // a real 1-byte mbedtls_ssl_read(). If that probe lands on application data
  17737. // (e.g. a response that arrived while this side was still in its post-write
  17738. // check), the byte is pushed back here and served by the next read().
  17739. unsigned char peeked_byte = 0;
  17740. bool has_peeked_byte = false;
  17741. // Set by set_sni() when the caller disabled hostname verification, so the
  17742. // verify callback can clear the CN/SAN mismatch flag while still enforcing
  17743. // the rest of the chain (Mbed TLS ties SNI and identity checking together;
  17744. // OpenSSL and wolfSSL keep them independent).
  17745. bool suppress_hostname_mismatch = false;
  17746. // Copied from the owning MbedTlsContext at creation, so a handshake only
  17747. // ever runs the callback of its own context.
  17748. VerifyCallback verify_callback;
  17749. bool is_server = false;
  17750. MbedTlsSession() { mbedtls_ssl_init(&ssl); }
  17751. ~MbedTlsSession() { mbedtls_ssl_free(&ssl); }
  17752. MbedTlsSession(const MbedTlsSession &) = delete;
  17753. MbedTlsSession &operator=(const MbedTlsSession &) = delete;
  17754. };
  17755. // Thread-local error code accessor for Mbed TLS (since it doesn't have an error
  17756. // queue)
  17757. inline int &mbedtls_last_error() {
  17758. static thread_local int err = 0;
  17759. return err;
  17760. }
  17761. // Helper to map Mbed TLS error to ErrorCode
  17762. inline ErrorCode map_mbedtls_error(int ret, int &out_errno,
  17763. uint32_t verify_flags) {
  17764. if (ret == 0) { return ErrorCode::Success; }
  17765. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return ErrorCode::WantRead; }
  17766. if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) { return ErrorCode::WantWrite; }
  17767. if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
  17768. return ErrorCode::PeerClosed;
  17769. }
  17770. if (ret == MBEDTLS_ERR_NET_CONN_RESET || ret == MBEDTLS_ERR_NET_SEND_FAILED ||
  17771. ret == MBEDTLS_ERR_NET_RECV_FAILED) {
  17772. out_errno = errno;
  17773. return ErrorCode::SyscallError;
  17774. }
  17775. if (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED) {
  17776. // Unlike OpenSSL/wolfSSL, Mbed TLS folds the CN/SAN identity check into
  17777. // the handshake's chain verification (see set_sni()); a mismatch there
  17778. // is reported the same way as any other verify_flags bit. Report it as
  17779. // HostnameMismatch, matching the other backends and the post-handshake
  17780. // identity check below, but only when naming is the sole problem -
  17781. // if the chain itself is also untrusted/expired/etc., that takes
  17782. // priority over the naming detail.
  17783. if (verify_flags == static_cast<uint32_t>(hostname_mismatch_code())) {
  17784. return ErrorCode::HostnameMismatch;
  17785. }
  17786. return ErrorCode::CertVerifyFailed;
  17787. }
  17788. return ErrorCode::Fatal;
  17789. }
  17790. // Populates a TlsError from a failed (non-zero) mbedtls_ssl_handshake()
  17791. // return value, including the verify-flags-dependent HostnameMismatch
  17792. // mapping; shared by connect() and connect_nonblocking() so the
  17793. // backend_code policy for that mapping only lives in one place.
  17794. inline void fill_mbedtls_tls_error(TlsError &err, mbedtls_ssl_context &ssl,
  17795. int ret) {
  17796. auto verify_flags = mbedtls_ssl_get_verify_result(&ssl);
  17797. err.code = map_mbedtls_error(ret, err.sys_errno, verify_flags);
  17798. err.backend_code = err.code == ErrorCode::HostnameMismatch
  17799. ? static_cast<uint64_t>(verify_flags)
  17800. : static_cast<uint64_t>(-ret);
  17801. }
  17802. // A TLS 1.3 NewSessionTicket (signaled by default on Mbed TLS 4.x) is a
  17803. // non-fatal notification delivered between records, not an error and not
  17804. // application data, so I/O calls that see it should just be retried. Kept in
  17805. // one helper so the retry loops keep an intact "do { } while (...)" instead of
  17806. // splitting the closing brace across an #if.
  17807. inline bool mbedtls_is_session_ticket(int ret) {
  17808. #if defined(MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET)
  17809. return ret == MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
  17810. #else
  17811. (void)ret;
  17812. return false;
  17813. #endif
  17814. }
  17815. // BIO-like send callback for Mbed TLS
  17816. inline int mbedtls_net_send_cb(void *ctx, const unsigned char *buf,
  17817. size_t len) {
  17818. auto sock = *static_cast<socket_t *>(ctx);
  17819. #ifdef _WIN32
  17820. auto ret =
  17821. send(sock, reinterpret_cast<const char *>(buf), static_cast<int>(len), 0);
  17822. if (ret == SOCKET_ERROR) {
  17823. int err = WSAGetLastError();
  17824. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_WRITE; }
  17825. return MBEDTLS_ERR_NET_SEND_FAILED;
  17826. }
  17827. #else
  17828. auto ret = send(sock, buf, len, 0);
  17829. if (ret < 0) {
  17830. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17831. return MBEDTLS_ERR_SSL_WANT_WRITE;
  17832. }
  17833. return MBEDTLS_ERR_NET_SEND_FAILED;
  17834. }
  17835. #endif
  17836. return static_cast<int>(ret);
  17837. }
  17838. // BIO-like recv callback for Mbed TLS
  17839. inline int mbedtls_net_recv_cb(void *ctx, unsigned char *buf, size_t len) {
  17840. auto sock = *static_cast<socket_t *>(ctx);
  17841. #ifdef _WIN32
  17842. auto ret =
  17843. recv(sock, reinterpret_cast<char *>(buf), static_cast<int>(len), 0);
  17844. if (ret == SOCKET_ERROR) {
  17845. int err = WSAGetLastError();
  17846. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_READ; }
  17847. return MBEDTLS_ERR_NET_RECV_FAILED;
  17848. }
  17849. #else
  17850. auto ret = recv(sock, buf, len, 0);
  17851. if (ret < 0) {
  17852. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17853. return MBEDTLS_ERR_SSL_WANT_READ;
  17854. }
  17855. return MBEDTLS_ERR_NET_RECV_FAILED;
  17856. }
  17857. #endif
  17858. if (ret == 0) { return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY; }
  17859. return static_cast<int>(ret);
  17860. }
  17861. // MbedTlsContext constructor/destructor implementations
  17862. inline MbedTlsContext::MbedTlsContext() {
  17863. mbedtls_ssl_config_init(&conf);
  17864. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17865. mbedtls_entropy_init(&entropy);
  17866. mbedtls_ctr_drbg_init(&ctr_drbg);
  17867. #endif
  17868. mbedtls_x509_crt_init(&ca_chain);
  17869. mbedtls_x509_crt_init(&own_cert);
  17870. mbedtls_pk_init(&own_key);
  17871. }
  17872. inline MbedTlsContext::~MbedTlsContext() {
  17873. mbedtls_pk_free(&own_key);
  17874. mbedtls_x509_crt_free(&own_cert);
  17875. mbedtls_x509_crt_free(&ca_chain);
  17876. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17877. mbedtls_ctr_drbg_free(&ctr_drbg);
  17878. mbedtls_entropy_free(&entropy);
  17879. #endif
  17880. mbedtls_ssl_config_free(&conf);
  17881. }
  17882. // Thread-local storage for SNI captured during handshake
  17883. // This is needed because the SNI callback doesn't have a way to pass
  17884. // session-specific data before the session is fully set up
  17885. inline std::string &mbedpending_sni() {
  17886. static thread_local std::string sni;
  17887. return sni;
  17888. }
  17889. // SNI callback for Mbed TLS server to capture client's SNI hostname
  17890. inline int mbedtls_sni_callback(void *p_ctx, mbedtls_ssl_context *ssl,
  17891. const unsigned char *name, size_t name_len) {
  17892. (void)p_ctx;
  17893. (void)ssl;
  17894. // Store SNI name in thread-local storage
  17895. // It will be retrieved and stored in the session after handshake
  17896. if (name && name_len > 0) {
  17897. mbedpending_sni().assign(reinterpret_cast<const char *>(name), name_len);
  17898. } else {
  17899. mbedpending_sni().clear();
  17900. }
  17901. return 0; // Accept any SNI
  17902. }
  17903. inline void mbedtls_clear_cn_mismatch(uint32_t *flags) {
  17904. *flags &= ~static_cast<uint32_t>(hostname_mismatch_code());
  17905. }
  17906. // MbedTLS verify callback wrapper
  17907. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  17908. int cert_depth, uint32_t *flags) {
  17909. // data points to the MbedTlsSession
  17910. auto *session = static_cast<MbedTlsSession *>(data);
  17911. // set_sni() disabled hostname verification for this session: ignore the
  17912. // CN/SAN mismatch flag, as the OpenSSL/wolfSSL backends do. The final
  17913. // pass/fail decision still comes from the remaining flags (and, below, from
  17914. // the user's own verify callback).
  17915. if (session->suppress_hostname_mismatch) { mbedtls_clear_cn_mismatch(flags); }
  17916. const auto &callback = session->verify_callback;
  17917. if (!callback) { return 0; } // Continue with default verification
  17918. // Build context
  17919. VerifyContext verify_ctx;
  17920. verify_ctx.session = static_cast<session_t>(session);
  17921. verify_ctx.cert = static_cast<cert_t>(crt);
  17922. verify_ctx.depth = cert_depth;
  17923. verify_ctx.preverify_ok = (*flags == 0);
  17924. verify_ctx.error_code = static_cast<long>(*flags);
  17925. // Convert Mbed TLS flags to error string
  17926. static thread_local char error_buf[256];
  17927. if (*flags != 0) {
  17928. mbedtls_x509_crt_verify_info(error_buf, sizeof(error_buf), "", *flags);
  17929. verify_ctx.error_string = error_buf;
  17930. } else {
  17931. verify_ctx.error_string = nullptr;
  17932. }
  17933. bool accepted = run_verify_callback(callback, verify_ctx);
  17934. if (accepted) {
  17935. // Overrides the built-in verification only on a server, as on OpenSSL and
  17936. // wolfSSL, whose clients check the verify result after the handshake
  17937. if (session->is_server) { *flags = 0; }
  17938. return 0;
  17939. }
  17940. return MBEDTLS_ERR_X509_CERT_VERIFY_FAILED;
  17941. }
  17942. // Sets the authentication mode from whether the peer's certificate is required
  17943. // and whether a verify callback is set. OPTIONAL lets the callback run even if
  17944. // verification is not required (matching OpenSSL's SSL_VERIFY_PEER).
  17945. inline void apply_verify_mode(MbedTlsContext &mctx) {
  17946. auto mode = MBEDTLS_SSL_VERIFY_NONE;
  17947. if (mctx.verify_client) {
  17948. mode = MBEDTLS_SSL_VERIFY_REQUIRED;
  17949. } else if (mctx.verify_callback) {
  17950. mode = MBEDTLS_SSL_VERIFY_OPTIONAL;
  17951. }
  17952. mbedtls_ssl_conf_authmode(&mctx.conf, mode);
  17953. }
  17954. } // namespace impl
  17955. inline ctx_t create_client_context() {
  17956. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17957. if (!ctx) { return nullptr; }
  17958. ctx->is_server = false;
  17959. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17960. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17961. if (!detail::ensure_mbedtls_psa_crypto()) {
  17962. delete ctx;
  17963. return nullptr;
  17964. }
  17965. int ret;
  17966. #else
  17967. // Seed the random number generator
  17968. const char *pers = "httplib_client";
  17969. int ret = mbedtls_ctr_drbg_seed(
  17970. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  17971. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  17972. if (ret != 0) {
  17973. impl::mbedtls_last_error() = ret;
  17974. delete ctx;
  17975. return nullptr;
  17976. }
  17977. #endif
  17978. // Set up SSL config for client
  17979. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_CLIENT,
  17980. MBEDTLS_SSL_TRANSPORT_STREAM,
  17981. MBEDTLS_SSL_PRESET_DEFAULT);
  17982. if (ret != 0) {
  17983. impl::mbedtls_last_error() = ret;
  17984. delete ctx;
  17985. return nullptr;
  17986. }
  17987. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17988. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17989. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17990. #endif
  17991. // Default: verify peer certificate
  17992. ctx->verify_client = true;
  17993. impl::apply_verify_mode(*ctx);
  17994. // Set minimum TLS version to 1.2
  17995. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17996. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17997. #else
  17998. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17999. MBEDTLS_SSL_MINOR_VERSION_3);
  18000. #endif
  18001. return static_cast<ctx_t>(ctx);
  18002. }
  18003. inline ctx_t create_server_context() {
  18004. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  18005. if (!ctx) { return nullptr; }
  18006. ctx->is_server = true;
  18007. #ifdef CPPHTTPLIB_MBEDTLS_V4
  18008. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  18009. if (!detail::ensure_mbedtls_psa_crypto()) {
  18010. delete ctx;
  18011. return nullptr;
  18012. }
  18013. int ret;
  18014. #else
  18015. // Seed the random number generator
  18016. const char *pers = "httplib_server";
  18017. int ret = mbedtls_ctr_drbg_seed(
  18018. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  18019. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  18020. if (ret != 0) {
  18021. impl::mbedtls_last_error() = ret;
  18022. delete ctx;
  18023. return nullptr;
  18024. }
  18025. #endif
  18026. // Set up SSL config for server
  18027. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_SERVER,
  18028. MBEDTLS_SSL_TRANSPORT_STREAM,
  18029. MBEDTLS_SSL_PRESET_DEFAULT);
  18030. if (ret != 0) {
  18031. impl::mbedtls_last_error() = ret;
  18032. delete ctx;
  18033. return nullptr;
  18034. }
  18035. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18036. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  18037. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  18038. #endif
  18039. // Default: don't verify client
  18040. impl::apply_verify_mode(*ctx);
  18041. // Set minimum TLS version to 1.2
  18042. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18043. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  18044. #else
  18045. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  18046. MBEDTLS_SSL_MINOR_VERSION_3);
  18047. #endif
  18048. // Set SNI callback to capture client's SNI hostname
  18049. mbedtls_ssl_conf_sni(&ctx->conf, impl::mbedtls_sni_callback, nullptr);
  18050. return static_cast<ctx_t>(ctx);
  18051. }
  18052. inline void free_context(ctx_t ctx) {
  18053. if (ctx) { delete static_cast<impl::MbedTlsContext *>(ctx); }
  18054. }
  18055. inline bool set_min_version(ctx_t ctx, Version version) {
  18056. if (!ctx) { return false; }
  18057. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18058. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18059. // Mbed TLS 3.x uses mbedtls_ssl_protocol_version enum
  18060. mbedtls_ssl_protocol_version min_ver = MBEDTLS_SSL_VERSION_TLS1_2;
  18061. if (version >= Version::TLS1_3) {
  18062. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  18063. min_ver = MBEDTLS_SSL_VERSION_TLS1_3;
  18064. #endif
  18065. }
  18066. mbedtls_ssl_conf_min_tls_version(&mctx->conf, min_ver);
  18067. #else
  18068. // Mbed TLS 2.x uses major/minor version numbers
  18069. int major = MBEDTLS_SSL_MAJOR_VERSION_3;
  18070. int minor = MBEDTLS_SSL_MINOR_VERSION_3; // TLS 1.2
  18071. if (version >= Version::TLS1_3) {
  18072. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  18073. minor = MBEDTLS_SSL_MINOR_VERSION_4; // TLS 1.3
  18074. #else
  18075. minor = MBEDTLS_SSL_MINOR_VERSION_3; // Fall back to TLS 1.2
  18076. #endif
  18077. }
  18078. mbedtls_ssl_conf_min_version(&mctx->conf, major, minor);
  18079. #endif
  18080. return true;
  18081. }
  18082. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  18083. if (!ctx || !pem) { return false; }
  18084. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18085. // mbedtls_x509_crt_parse expects null-terminated string for PEM
  18086. // Add null terminator if not present
  18087. std::string pem_str(pem, len);
  18088. int ret = mbedtls_x509_crt_parse(
  18089. &mctx->ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  18090. pem_str.size() + 1);
  18091. if (ret != 0) {
  18092. impl::mbedtls_last_error() = ret;
  18093. return false;
  18094. }
  18095. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18096. return true;
  18097. }
  18098. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  18099. if (!ctx || !file_path) { return false; }
  18100. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18101. int ret = mbedtls_x509_crt_parse_file(&mctx->ca_chain, file_path);
  18102. if (ret != 0) {
  18103. impl::mbedtls_last_error() = ret;
  18104. return false;
  18105. }
  18106. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18107. return true;
  18108. }
  18109. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  18110. if (!ctx || !dir_path) { return false; }
  18111. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18112. int ret = mbedtls_x509_crt_parse_path(&mctx->ca_chain, dir_path);
  18113. if (ret < 0) { // Returns number of certs on success, negative on error
  18114. impl::mbedtls_last_error() = ret;
  18115. return false;
  18116. }
  18117. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18118. return true;
  18119. }
  18120. inline bool load_system_certs(ctx_t ctx) {
  18121. if (!ctx) { return false; }
  18122. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18123. bool loaded = false;
  18124. #ifdef _WIN32
  18125. loaded = impl::enumerate_windows_system_certs(
  18126. [&](const unsigned char *data, size_t len) {
  18127. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  18128. });
  18129. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  18130. loaded = impl::enumerate_macos_keychain_certs(
  18131. [&](const unsigned char *data, size_t len) {
  18132. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  18133. });
  18134. #else
  18135. for (auto path = impl::system_ca_paths(); *path; ++path) {
  18136. if (mbedtls_x509_crt_parse_file(&mctx->ca_chain, *path) >= 0) {
  18137. loaded = true;
  18138. break;
  18139. }
  18140. }
  18141. if (!loaded) {
  18142. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  18143. if (mbedtls_x509_crt_parse_path(&mctx->ca_chain, *dir) >= 0) {
  18144. loaded = true;
  18145. break;
  18146. }
  18147. }
  18148. }
  18149. #endif
  18150. if (loaded) {
  18151. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18152. }
  18153. return loaded;
  18154. }
  18155. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  18156. const char *password) {
  18157. if (!ctx || !cert || !key) { return false; }
  18158. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18159. // Parse certificate
  18160. std::string cert_str(cert);
  18161. int ret = mbedtls_x509_crt_parse(
  18162. &mctx->own_cert,
  18163. reinterpret_cast<const unsigned char *>(cert_str.c_str()),
  18164. cert_str.size() + 1);
  18165. if (ret != 0) {
  18166. impl::mbedtls_last_error() = ret;
  18167. return false;
  18168. }
  18169. // Parse private key
  18170. std::string key_str(key);
  18171. const unsigned char *pwd =
  18172. password ? reinterpret_cast<const unsigned char *>(password) : nullptr;
  18173. size_t pwd_len = password ? strlen(password) : 0;
  18174. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18175. ret = mbedtls_pk_parse_key(
  18176. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  18177. key_str.size() + 1, pwd, pwd_len, mbedtls_ctr_drbg_random,
  18178. &mctx->ctr_drbg);
  18179. #else
  18180. ret = mbedtls_pk_parse_key(
  18181. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  18182. key_str.size() + 1, pwd, pwd_len);
  18183. #endif
  18184. if (ret != 0) {
  18185. impl::mbedtls_last_error() = ret;
  18186. return false;
  18187. }
  18188. // Verify that the certificate and private key match.
  18189. // Mbed TLS 4.x: mbedtls_pk_check_pair() reports a spurious mismatch for
  18190. // PSA-backed keys, so skip it and let the handshake surface a real mismatch.
  18191. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18192. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18193. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  18194. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18195. #else
  18196. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  18197. #endif
  18198. if (ret != 0) {
  18199. impl::mbedtls_last_error() = ret;
  18200. return false;
  18201. }
  18202. #endif
  18203. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  18204. if (ret != 0) {
  18205. impl::mbedtls_last_error() = ret;
  18206. return false;
  18207. }
  18208. return true;
  18209. }
  18210. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  18211. const char *key_path, const char *password) {
  18212. if (!ctx || !cert_path || !key_path) { return false; }
  18213. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18214. // Parse certificate file
  18215. int ret = mbedtls_x509_crt_parse_file(&mctx->own_cert, cert_path);
  18216. if (ret != 0) {
  18217. impl::mbedtls_last_error() = ret;
  18218. return false;
  18219. }
  18220. // Parse private key file
  18221. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18222. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password,
  18223. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18224. #else
  18225. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password);
  18226. #endif
  18227. if (ret != 0) {
  18228. impl::mbedtls_last_error() = ret;
  18229. return false;
  18230. }
  18231. // Verify that the certificate and private key match.
  18232. // Mbed TLS 4.x: see set_client_cert() — skip the spurious check_pair.
  18233. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18234. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18235. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  18236. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18237. #else
  18238. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  18239. #endif
  18240. if (ret != 0) {
  18241. impl::mbedtls_last_error() = ret;
  18242. return false;
  18243. }
  18244. #endif
  18245. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  18246. if (ret != 0) {
  18247. impl::mbedtls_last_error() = ret;
  18248. return false;
  18249. }
  18250. return true;
  18251. }
  18252. inline void set_verify_client(ctx_t ctx, bool require) {
  18253. if (!ctx) { return; }
  18254. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18255. mctx->verify_client = require;
  18256. impl::apply_verify_mode(*mctx);
  18257. }
  18258. inline session_t create_session(ctx_t ctx, socket_t sock) {
  18259. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  18260. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18261. auto session = new (std::nothrow) impl::MbedTlsSession();
  18262. if (!session) { return nullptr; }
  18263. session->sock = sock;
  18264. int ret = mbedtls_ssl_setup(&session->ssl, &mctx->conf);
  18265. if (ret != 0) {
  18266. impl::mbedtls_last_error() = ret;
  18267. delete session;
  18268. return nullptr;
  18269. }
  18270. // Explicitly opt out of in-handshake hostname verification by default;
  18271. // since Mbed TLS 3.6.4 a client handshake with certificate verification
  18272. // fails outright when no hostname was set. set_sni() installs the real
  18273. // hostname for DNS hosts; for IP hosts (where SNI must not be set) the
  18274. // caller verifies the certificate identity post-handshake via
  18275. // verify_hostname().
  18276. mbedtls_ssl_set_hostname(&session->ssl, nullptr);
  18277. // Set BIO callbacks
  18278. mbedtls_ssl_set_bio(&session->ssl, &session->sock, impl::mbedtls_net_send_cb,
  18279. impl::mbedtls_net_recv_cb, nullptr);
  18280. // Installed always, as it also masks the hostname mismatch that set_sni()
  18281. // may ask for. The session runs its own copy of the user's callback, which
  18282. // set_verify_callback() cannot replace under a handshake.
  18283. session->verify_callback = mctx->verify_callback;
  18284. session->is_server = mctx->is_server;
  18285. mbedtls_ssl_set_verify(&session->ssl, impl::mbedtls_verify_callback, session);
  18286. return static_cast<session_t>(session);
  18287. }
  18288. inline void free_session(session_t session) {
  18289. if (session) { delete static_cast<impl::MbedTlsSession *>(session); }
  18290. }
  18291. inline bool set_sni(session_t session, const char *hostname,
  18292. bool verify_hostname) {
  18293. if (!session || !hostname) { return false; }
  18294. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18295. // mbedtls_ssl_set_hostname() both sends the SNI extension and binds the
  18296. // handshake-time CN/SAN check to `hostname`; the two can't be requested
  18297. // independently, so a disabled hostname check is handled below by masking
  18298. // the resulting mismatch flag instead of skipping this call.
  18299. int ret = mbedtls_ssl_set_hostname(&msession->ssl, hostname);
  18300. if (ret != 0) {
  18301. impl::mbedtls_last_error() = ret;
  18302. return false;
  18303. }
  18304. msession->hostname = hostname;
  18305. if (!verify_hostname) { msession->suppress_hostname_mismatch = true; }
  18306. return true;
  18307. }
  18308. inline TlsError connect(session_t session) {
  18309. TlsError err;
  18310. if (!session) {
  18311. err.code = ErrorCode::Fatal;
  18312. return err;
  18313. }
  18314. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18315. int ret;
  18316. do {
  18317. ret = mbedtls_ssl_handshake(&msession->ssl);
  18318. } while (impl::mbedtls_is_session_ticket(ret));
  18319. if (ret == 0) {
  18320. err.code = ErrorCode::Success;
  18321. } else {
  18322. impl::fill_mbedtls_tls_error(err, msession->ssl, ret);
  18323. impl::mbedtls_last_error() = ret;
  18324. }
  18325. return err;
  18326. }
  18327. inline TlsError accept(session_t session) {
  18328. // A failed handshake leaves its SNI behind, so start without it
  18329. impl::mbedpending_sni().clear();
  18330. // Same as connect for Mbed TLS - handshake works for both client and server
  18331. auto result = connect(session);
  18332. // After successful handshake, capture SNI from thread-local storage
  18333. if (result.code == ErrorCode::Success && session) {
  18334. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18335. msession->sni_hostname = std::move(impl::mbedpending_sni());
  18336. }
  18337. return result;
  18338. }
  18339. inline bool connect_nonblocking(session_t session, socket_t sock,
  18340. time_t timeout_sec, time_t timeout_usec,
  18341. TlsError *err) {
  18342. if (!session) {
  18343. if (err) { err->code = ErrorCode::Fatal; }
  18344. return false;
  18345. }
  18346. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18347. // Set socket to non-blocking mode
  18348. detail::set_nonblocking(sock, true);
  18349. auto cleanup =
  18350. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18351. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  18352. int ret;
  18353. while ((ret = mbedtls_ssl_handshake(&msession->ssl)) != 0) {
  18354. // Non-fatal TLS 1.3 ticket; retry immediately.
  18355. if (impl::mbedtls_is_session_ticket(ret)) { continue; }
  18356. if (ret == MBEDTLS_ERR_SSL_WANT_READ) {
  18357. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  18358. } else if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) {
  18359. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  18360. }
  18361. // TlsError or timeout
  18362. if (err) { impl::fill_mbedtls_tls_error(*err, msession->ssl, ret); }
  18363. impl::mbedtls_last_error() = ret;
  18364. return false;
  18365. }
  18366. if (err) { err->code = ErrorCode::Success; }
  18367. return true;
  18368. }
  18369. inline bool accept_nonblocking(session_t session, socket_t sock,
  18370. time_t timeout_sec, time_t timeout_usec,
  18371. TlsError *err) {
  18372. // A failed handshake leaves its SNI behind, so start without it
  18373. impl::mbedpending_sni().clear();
  18374. // Same implementation as connect for Mbed TLS
  18375. bool result =
  18376. connect_nonblocking(session, sock, timeout_sec, timeout_usec, err);
  18377. // After successful handshake, capture SNI from thread-local storage
  18378. if (result && session) {
  18379. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18380. msession->sni_hostname = std::move(impl::mbedpending_sni());
  18381. }
  18382. return result;
  18383. }
  18384. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  18385. if (!session || !buf) {
  18386. err.code = ErrorCode::Fatal;
  18387. return -1;
  18388. }
  18389. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18390. // Serve a byte consumed by the is_peer_closed() probe before reading more.
  18391. if (msession->has_peeked_byte) {
  18392. if (len == 0) { return 0; }
  18393. auto p = static_cast<unsigned char *>(buf);
  18394. p[0] = msession->peeked_byte;
  18395. msession->has_peeked_byte = false;
  18396. size_t n = 1;
  18397. // Top up with any already-decrypted bytes without risking a block.
  18398. if (len > 1 && mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  18399. int extra = mbedtls_ssl_read(&msession->ssl, p + 1, len - 1);
  18400. if (extra > 0) { n += static_cast<size_t>(extra); }
  18401. }
  18402. err.code = ErrorCode::Success;
  18403. return static_cast<ssize_t>(n);
  18404. }
  18405. int ret;
  18406. do {
  18407. ret = mbedtls_ssl_read(&msession->ssl, static_cast<unsigned char *>(buf),
  18408. len);
  18409. } while (impl::mbedtls_is_session_ticket(ret));
  18410. if (ret > 0) {
  18411. err.code = ErrorCode::Success;
  18412. return static_cast<ssize_t>(ret);
  18413. }
  18414. if (ret == 0) {
  18415. err.code = ErrorCode::PeerClosed;
  18416. return 0;
  18417. }
  18418. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  18419. err.backend_code = static_cast<uint64_t>(-ret);
  18420. impl::mbedtls_last_error() = ret;
  18421. // mbedTLS signals a clean close_notify via a negative error code rather
  18422. // than 0; surface it as a clean EOF the way OpenSSL/wolfSSL do.
  18423. if (err.code == ErrorCode::PeerClosed) { return 0; }
  18424. return -1;
  18425. }
  18426. inline ssize_t write(session_t session, const void *buf, size_t len,
  18427. TlsError &err) {
  18428. if (!session || !buf) {
  18429. err.code = ErrorCode::Fatal;
  18430. return -1;
  18431. }
  18432. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18433. int ret;
  18434. do {
  18435. ret = mbedtls_ssl_write(&msession->ssl,
  18436. static_cast<const unsigned char *>(buf), len);
  18437. } while (impl::mbedtls_is_session_ticket(ret));
  18438. if (ret > 0) {
  18439. err.code = ErrorCode::Success;
  18440. return static_cast<ssize_t>(ret);
  18441. }
  18442. if (ret == 0) {
  18443. err.code = ErrorCode::PeerClosed;
  18444. return 0;
  18445. }
  18446. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  18447. err.backend_code = static_cast<uint64_t>(-ret);
  18448. impl::mbedtls_last_error() = ret;
  18449. return -1;
  18450. }
  18451. inline int pending(const_session_t session) {
  18452. if (!session) { return 0; }
  18453. auto msession =
  18454. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18455. return static_cast<int>(mbedtls_ssl_get_bytes_avail(&msession->ssl)) +
  18456. (msession->has_peeked_byte ? 1 : 0);
  18457. }
  18458. inline void shutdown(session_t session, bool graceful) {
  18459. if (!session) { return; }
  18460. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18461. if (graceful) {
  18462. // Try to send close_notify, but don't block forever
  18463. int ret;
  18464. int attempts = 0;
  18465. while ((ret = mbedtls_ssl_close_notify(&msession->ssl)) != 0 &&
  18466. attempts < 3) {
  18467. if (ret != MBEDTLS_ERR_SSL_WANT_READ &&
  18468. ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
  18469. break;
  18470. }
  18471. attempts++;
  18472. }
  18473. }
  18474. }
  18475. inline bool is_peer_closed(session_t session, socket_t sock) {
  18476. if (!session || sock == INVALID_SOCKET) { return true; }
  18477. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18478. // Check if there's already decrypted or pushed-back data available.
  18479. // If so, the connection is definitely alive.
  18480. if (msession->has_peeked_byte ||
  18481. mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  18482. return false;
  18483. }
  18484. // Set socket to non-blocking to avoid blocking on read
  18485. detail::set_nonblocking(sock, true);
  18486. auto cleanup =
  18487. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18488. // Probe with a 1-byte read (Mbed TLS has no peek API). If the probe lands
  18489. // on application data — e.g. a response that already arrived — push the
  18490. // byte back so the next read() delivers it instead of losing it.
  18491. unsigned char buf;
  18492. int ret;
  18493. do {
  18494. ret = mbedtls_ssl_read(&msession->ssl, &buf, 1);
  18495. } while (impl::mbedtls_is_session_ticket(ret));
  18496. // If we got data or WANT_READ (would block), connection is alive
  18497. if (ret > 0) {
  18498. msession->peeked_byte = buf;
  18499. msession->has_peeked_byte = true;
  18500. return false;
  18501. }
  18502. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return false; }
  18503. // If we get a peer close notify or a connection reset, the peer is closed
  18504. return ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY ||
  18505. ret == MBEDTLS_ERR_NET_CONN_RESET || ret == 0;
  18506. }
  18507. inline cert_t get_peer_cert(const_session_t session) {
  18508. if (!session) { return nullptr; }
  18509. auto msession =
  18510. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18511. // Mbed TLS returns a pointer to the internal peer cert chain.
  18512. // WARNING: This pointer is only valid while the session is active.
  18513. // Do not use the certificate after calling free_session().
  18514. const mbedtls_x509_crt *cert = mbedtls_ssl_get_peer_cert(&msession->ssl);
  18515. return const_cast<mbedtls_x509_crt *>(cert);
  18516. }
  18517. inline size_t get_peer_certs(const_session_t session,
  18518. std::vector<cert_t> &certs) {
  18519. certs.clear();
  18520. // Mbed TLS parses the whole received chain into a list headed by the peer
  18521. // certificate, owned by the session like get_peer_cert()'s result
  18522. for (auto crt = static_cast<mbedtls_x509_crt *>(get_peer_cert(session));
  18523. crt && crt->raw.len > 0; crt = crt->next) {
  18524. certs.push_back(static_cast<cert_t>(crt));
  18525. }
  18526. return certs.size();
  18527. }
  18528. inline void free_cert(cert_t cert) {
  18529. // Mbed TLS: every cert_t handed out points into a session's or a context's
  18530. // chain, so there is nothing to free. Callers still call this for the other
  18531. // backends.
  18532. (void)cert;
  18533. }
  18534. inline bool verify_hostname(cert_t cert, const char *hostname) {
  18535. if (!cert || !hostname) { return false; }
  18536. auto mcert = static_cast<const mbedtls_x509_crt *>(cert);
  18537. std::string host_str(hostname);
  18538. // Check if hostname is an IP address (IPv4 or IPv6)
  18539. unsigned char ip_bytes[16];
  18540. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  18541. auto is_ip = ip_len > 0;
  18542. // Check Subject Alternative Names (SAN). Mbed TLS keeps the GeneralName type
  18543. // in buf.tag and the raw value in buf.p / buf.len.
  18544. auto has_dns_san = false;
  18545. for (auto san = &mcert->subject_alt_names; san; san = san->next) {
  18546. if (!san->buf.p || san->buf.len == 0) { continue; }
  18547. const unsigned char *p = san->buf.p;
  18548. size_t len = san->buf.len;
  18549. auto san_type = san->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK;
  18550. if (is_ip) {
  18551. // For an IP host, only a matching iPAddress SAN of the same family
  18552. // (4 bytes for IPv4, 16 bytes for IPv6) may authenticate it.
  18553. if (san_type == MBEDTLS_X509_SAN_IP_ADDRESS && len == ip_len &&
  18554. memcmp(p, ip_bytes, ip_len) == 0) {
  18555. return true;
  18556. }
  18557. } else if (san_type == MBEDTLS_X509_SAN_DNS_NAME) {
  18558. has_dns_san = true;
  18559. std::string san_name(reinterpret_cast<const char *>(p), len);
  18560. if (detail::match_hostname(san_name, host_str)) { return true; }
  18561. }
  18562. }
  18563. // Fallback: the Common Names (CN) in the subject, as X509_check_host does it:
  18564. // never for an IP host, which only an iPAddress SAN names, and never next to
  18565. // a DNS SAN (RFC 6125 6.4.4).
  18566. if (is_ip || has_dns_san) { return false; }
  18567. for (auto name = &mcert->subject; name; name = name->next) {
  18568. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  18569. std::string cn(reinterpret_cast<const char *>(name->val.p),
  18570. name->val.len);
  18571. if (detail::match_hostname(cn, host_str)) { return true; }
  18572. }
  18573. }
  18574. return false;
  18575. }
  18576. inline uint64_t hostname_mismatch_code() {
  18577. return static_cast<uint64_t>(MBEDTLS_X509_BADCERT_CN_MISMATCH);
  18578. }
  18579. inline long get_verify_result(const_session_t session) {
  18580. if (!session) { return -1; }
  18581. auto msession =
  18582. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18583. uint32_t flags = mbedtls_ssl_get_verify_result(&msession->ssl);
  18584. // Return 0 (X509_V_OK equivalent) if verification passed
  18585. return flags == 0 ? 0 : static_cast<long>(flags);
  18586. }
  18587. inline std::string get_cert_subject_cn(cert_t cert) {
  18588. if (!cert) return "";
  18589. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18590. // Find the CN in the subject
  18591. const mbedtls_x509_name *name = &x509->subject;
  18592. while (name != nullptr) {
  18593. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  18594. return std::string(reinterpret_cast<const char *>(name->val.p),
  18595. name->val.len);
  18596. }
  18597. name = name->next;
  18598. }
  18599. return "";
  18600. }
  18601. inline std::string get_cert_issuer_name(cert_t cert) {
  18602. if (!cert) return "";
  18603. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18604. // Build a human-readable issuer name string
  18605. char buf[512];
  18606. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &x509->issuer);
  18607. if (ret < 0) return "";
  18608. return std::string(buf);
  18609. }
  18610. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  18611. sans.clear();
  18612. if (!cert) return false;
  18613. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18614. // Parse the Subject Alternative Name extension
  18615. const mbedtls_x509_sequence *cur = &x509->subject_alt_names;
  18616. while (cur != nullptr) {
  18617. if (cur->buf.len > 0) {
  18618. const unsigned char *p = cur->buf.p;
  18619. size_t value_len = cur->buf.len;
  18620. SanEntry entry;
  18621. switch (cur->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK) {
  18622. case MBEDTLS_X509_SAN_DNS_NAME:
  18623. entry.type = SanType::DNS;
  18624. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18625. break;
  18626. case MBEDTLS_X509_SAN_IP_ADDRESS:
  18627. entry.type = SanType::IP;
  18628. if (value_len == 4) {
  18629. // IPv4
  18630. char buf[16];
  18631. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", p[0], p[1], p[2], p[3]);
  18632. entry.value = buf;
  18633. } else if (value_len == 16) {
  18634. // IPv6
  18635. char buf[64];
  18636. snprintf(buf, sizeof(buf),
  18637. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  18638. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  18639. p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8], p[9],
  18640. p[10], p[11], p[12], p[13], p[14], p[15]);
  18641. entry.value = buf;
  18642. }
  18643. break;
  18644. case MBEDTLS_X509_SAN_RFC822_NAME:
  18645. entry.type = SanType::EMAIL;
  18646. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18647. break;
  18648. case MBEDTLS_X509_SAN_UNIFORM_RESOURCE_IDENTIFIER:
  18649. entry.type = SanType::URI;
  18650. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18651. break;
  18652. default: entry.type = SanType::OTHER; break;
  18653. }
  18654. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  18655. }
  18656. cur = cur->next;
  18657. }
  18658. return true;
  18659. }
  18660. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  18661. time_t &not_after) {
  18662. if (!cert) return false;
  18663. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18664. // Convert mbedtls_x509_time to time_t
  18665. auto to_time_t = [](const mbedtls_x509_time &t) -> time_t {
  18666. struct tm tm_time = {};
  18667. tm_time.tm_year = t.year - 1900;
  18668. tm_time.tm_mon = t.mon - 1;
  18669. tm_time.tm_mday = t.day;
  18670. tm_time.tm_hour = t.hour;
  18671. tm_time.tm_min = t.min;
  18672. tm_time.tm_sec = t.sec;
  18673. #ifdef _WIN32
  18674. return _mkgmtime(&tm_time);
  18675. #else
  18676. return timegm(&tm_time);
  18677. #endif
  18678. };
  18679. not_before = to_time_t(x509->valid_from);
  18680. not_after = to_time_t(x509->valid_to);
  18681. return true;
  18682. }
  18683. inline std::string get_cert_serial(cert_t cert) {
  18684. if (!cert) return "";
  18685. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18686. // Convert serial number to hex string
  18687. std::string result;
  18688. result.reserve(x509->serial.len * 2);
  18689. for (size_t i = 0; i < x509->serial.len; i++) {
  18690. char hex[3];
  18691. snprintf(hex, sizeof(hex), "%02X", x509->serial.p[i]);
  18692. result += hex;
  18693. }
  18694. return result;
  18695. }
  18696. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  18697. if (!cert) return false;
  18698. auto crt = static_cast<mbedtls_x509_crt *>(cert);
  18699. if (!crt->raw.p || crt->raw.len == 0) return false;
  18700. der.assign(crt->raw.p, crt->raw.p + crt->raw.len);
  18701. return true;
  18702. }
  18703. inline const char *get_sni(const_session_t session) {
  18704. if (!session) return nullptr;
  18705. auto msession = static_cast<const impl::MbedTlsSession *>(session);
  18706. // For server: return SNI received from client during handshake
  18707. if (!msession->sni_hostname.empty()) {
  18708. return msession->sni_hostname.c_str();
  18709. }
  18710. // For client: return the hostname set via set_sni
  18711. if (!msession->hostname.empty()) { return msession->hostname.c_str(); }
  18712. return nullptr;
  18713. }
  18714. inline uint64_t peek_error() {
  18715. // Mbed TLS doesn't have an error queue, return the last error
  18716. return static_cast<uint64_t>(-impl::mbedtls_last_error());
  18717. }
  18718. inline uint64_t get_error() {
  18719. // Mbed TLS doesn't have an error queue, return and clear the last error
  18720. uint64_t err = static_cast<uint64_t>(-impl::mbedtls_last_error());
  18721. impl::mbedtls_last_error() = 0;
  18722. return err;
  18723. }
  18724. inline std::string error_string(uint64_t code) {
  18725. char buf[256];
  18726. mbedtls_strerror(-static_cast<int>(code), buf, sizeof(buf));
  18727. return std::string(buf);
  18728. }
  18729. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  18730. auto *ca_chain = new (std::nothrow) mbedtls_x509_crt;
  18731. if (!ca_chain) { return nullptr; }
  18732. mbedtls_x509_crt_init(ca_chain);
  18733. // mbedtls_x509_crt_parse expects null-terminated PEM
  18734. int ret = mbedtls_x509_crt_parse(ca_chain,
  18735. reinterpret_cast<const unsigned char *>(pem),
  18736. len + 1); // +1 for null terminator
  18737. if (ret != 0) {
  18738. // Try without +1 in case PEM is already null-terminated
  18739. ret = mbedtls_x509_crt_parse(
  18740. ca_chain, reinterpret_cast<const unsigned char *>(pem), len);
  18741. if (ret != 0) {
  18742. mbedtls_x509_crt_free(ca_chain);
  18743. delete ca_chain;
  18744. return nullptr;
  18745. }
  18746. }
  18747. return static_cast<ca_store_t>(ca_chain);
  18748. }
  18749. inline void free_ca_store(ca_store_t store) {
  18750. if (store) {
  18751. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18752. mbedtls_x509_crt_free(ca_chain);
  18753. delete ca_chain;
  18754. }
  18755. }
  18756. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  18757. if (!ctx || !store) { return false; }
  18758. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18759. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18760. // Free existing CA chain
  18761. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  18762. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  18763. // Copy the CA chain (deep copy)
  18764. // Parse from the raw data of the source cert
  18765. mbedtls_x509_crt *src = ca_chain;
  18766. while (src != nullptr) {
  18767. int ret = mbedtls_x509_crt_parse_der(&mbed_ctx->ca_chain, src->raw.p,
  18768. src->raw.len);
  18769. if (ret != 0) {
  18770. free_ca_store(store);
  18771. return false;
  18772. }
  18773. src = src->next;
  18774. }
  18775. // This function takes ownership of the store; the chain was deep-copied
  18776. // above, so release the source
  18777. free_ca_store(store);
  18778. // Update the SSL config to use the new CA chain
  18779. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18780. return true;
  18781. }
  18782. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  18783. certs.clear();
  18784. if (!ctx) { return 0; }
  18785. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18786. // Owned by the context; see free_cert()
  18787. for (auto cert = &mbed_ctx->ca_chain; cert && cert->raw.len > 0;
  18788. cert = cert->next) {
  18789. certs.push_back(static_cast<cert_t>(cert));
  18790. }
  18791. return certs.size();
  18792. }
  18793. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  18794. std::vector<std::string> names;
  18795. if (!ctx) { return names; }
  18796. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18797. // Iterate through the CA chain
  18798. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  18799. while (cert != nullptr && cert->raw.len > 0) {
  18800. char buf[512];
  18801. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &cert->subject);
  18802. if (ret > 0) { names.push_back(buf); }
  18803. cert = cert->next;
  18804. }
  18805. return names;
  18806. }
  18807. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  18808. const char *key_pem, const char *password) {
  18809. if (!ctx || !cert_pem || !key_pem) { return false; }
  18810. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18811. // Parse into new objects first, so that a bad pair leaves the old one in
  18812. // place, and swap them in after; the old ones are freed on the way out.
  18813. mbedtls_x509_crt cert;
  18814. mbedtls_pk_context key;
  18815. mbedtls_x509_crt_init(&cert);
  18816. mbedtls_pk_init(&key);
  18817. auto se = detail::scope_exit([&] {
  18818. mbedtls_x509_crt_free(&cert);
  18819. mbedtls_pk_free(&key);
  18820. });
  18821. // Parse certificate PEM
  18822. int ret = mbedtls_x509_crt_parse(
  18823. &cert, reinterpret_cast<const unsigned char *>(cert_pem),
  18824. strlen(cert_pem) + 1);
  18825. if (ret != 0) {
  18826. impl::mbedtls_last_error() = ret;
  18827. return false;
  18828. }
  18829. // Parse private key PEM
  18830. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18831. ret = mbedtls_pk_parse_key(
  18832. &key, reinterpret_cast<const unsigned char *>(key_pem),
  18833. strlen(key_pem) + 1,
  18834. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18835. password ? strlen(password) : 0, mbedtls_ctr_drbg_random,
  18836. &mbed_ctx->ctr_drbg);
  18837. #else
  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);
  18843. #endif
  18844. if (ret != 0) {
  18845. impl::mbedtls_last_error() = ret;
  18846. return false;
  18847. }
  18848. std::swap(mbed_ctx->own_cert, cert);
  18849. std::swap(mbed_ctx->own_key, key);
  18850. // Configure SSL to use the new certificate and key
  18851. ret = mbedtls_ssl_conf_own_cert(&mbed_ctx->conf, &mbed_ctx->own_cert,
  18852. &mbed_ctx->own_key);
  18853. if (ret != 0) {
  18854. impl::mbedtls_last_error() = ret;
  18855. return false;
  18856. }
  18857. return true;
  18858. }
  18859. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  18860. if (!ctx || !ca_pem) { return false; }
  18861. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18862. // Parse into a new chain first, so that a bad one leaves the old in place
  18863. mbedtls_x509_crt chain;
  18864. mbedtls_x509_crt_init(&chain);
  18865. auto se = detail::scope_exit([&] { mbedtls_x509_crt_free(&chain); });
  18866. // Parse CA PEM
  18867. int ret = mbedtls_x509_crt_parse(
  18868. &chain, reinterpret_cast<const unsigned char *>(ca_pem),
  18869. strlen(ca_pem) + 1);
  18870. if (ret != 0) {
  18871. impl::mbedtls_last_error() = ret;
  18872. return false;
  18873. }
  18874. std::swap(mbed_ctx->ca_chain, chain);
  18875. // Update SSL config to use new CA chain
  18876. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18877. return true;
  18878. }
  18879. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  18880. if (!ctx) { return false; }
  18881. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18882. // create_session() hands each session its own copy to run.
  18883. mbed_ctx->verify_callback = std::move(callback);
  18884. impl::apply_verify_mode(*mbed_ctx);
  18885. return true;
  18886. }
  18887. inline long get_verify_error(const_session_t session) {
  18888. if (!session) { return -1; }
  18889. auto *msession =
  18890. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18891. return static_cast<long>(mbedtls_ssl_get_verify_result(&msession->ssl));
  18892. }
  18893. inline std::string verify_error_string(long error_code) {
  18894. if (error_code == 0) { return ""; }
  18895. char buf[256];
  18896. mbedtls_x509_crt_verify_info(buf, sizeof(buf), "",
  18897. static_cast<uint32_t>(error_code));
  18898. // Remove trailing newline if present
  18899. std::string result(buf);
  18900. while (!result.empty() && (result.back() == '\n' || result.back() == ' ')) {
  18901. result.pop_back();
  18902. }
  18903. return result;
  18904. }
  18905. } // namespace tls
  18906. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  18907. /*
  18908. * Group 10: TLS abstraction layer - wolfSSL backend
  18909. */
  18910. /*
  18911. * wolfSSL Backend Implementation
  18912. */
  18913. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  18914. namespace tls {
  18915. namespace impl {
  18916. // wolfSSL session wrapper
  18917. struct WolfSSLSession {
  18918. WOLFSSL *ssl = nullptr;
  18919. socket_t sock = INVALID_SOCKET;
  18920. std::string hostname; // For client: set via set_sni
  18921. std::string sni_hostname; // For server: received from client via SNI callback
  18922. WolfSSLSession() = default;
  18923. ~WolfSSLSession() {
  18924. if (ssl) { wolfSSL_free(ssl); }
  18925. }
  18926. WolfSSLSession(const WolfSSLSession &) = delete;
  18927. WolfSSLSession &operator=(const WolfSSLSession &) = delete;
  18928. };
  18929. // Thread-local error code accessor for wolfSSL
  18930. inline uint64_t &wolfssl_last_error() {
  18931. static thread_local uint64_t err = 0;
  18932. return err;
  18933. }
  18934. // Helper to map wolfSSL error to ErrorCode.
  18935. // ssl_error is the value from wolfSSL_get_error().
  18936. // raw_ret is the raw return value from the wolfSSL call (for low-level error).
  18937. inline ErrorCode map_wolfssl_error(WOLFSSL *ssl, int ssl_error,
  18938. int &out_errno) {
  18939. switch (ssl_error) {
  18940. case SSL_ERROR_NONE: return ErrorCode::Success;
  18941. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  18942. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  18943. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  18944. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  18945. default:
  18946. if (ssl) {
  18947. // wolfSSL stores the low-level error code as a negative value.
  18948. // DOMAIN_NAME_MISMATCH (-322) indicates hostname verification failure.
  18949. int low_err = ssl_error; // wolfSSL_get_error returns the low-level code
  18950. if (low_err == DOMAIN_NAME_MISMATCH) {
  18951. return ErrorCode::HostnameMismatch;
  18952. }
  18953. // Check verify result to distinguish cert verification from generic SSL
  18954. // errors.
  18955. long vr = wolfSSL_get_verify_result(ssl);
  18956. if (vr != 0) { return ErrorCode::CertVerifyFailed; }
  18957. }
  18958. return ErrorCode::Fatal;
  18959. }
  18960. }
  18961. // WolfSSLContext constructor/destructor implementations
  18962. inline WolfSSLContext::WolfSSLContext() { wolfSSL_Init(); }
  18963. inline WolfSSLContext::~WolfSSLContext() {
  18964. if (ctx) { wolfSSL_CTX_free(ctx); }
  18965. }
  18966. // Thread-local storage for SNI captured during handshake
  18967. inline std::string &wolfssl_pending_sni() {
  18968. static thread_local std::string sni;
  18969. return sni;
  18970. }
  18971. // SNI callback for wolfSSL server to capture client's SNI hostname
  18972. inline int wolfssl_sni_callback(WOLFSSL *ssl, int *ret, void *exArg) {
  18973. (void)ret;
  18974. (void)exArg;
  18975. void *name_data = nullptr;
  18976. unsigned short name_len =
  18977. wolfSSL_SNI_GetRequest(ssl, WOLFSSL_SNI_HOST_NAME, &name_data);
  18978. if (name_data && name_len > 0) {
  18979. wolfssl_pending_sni().assign(static_cast<const char *>(name_data),
  18980. name_len);
  18981. } else {
  18982. wolfssl_pending_sni().clear();
  18983. }
  18984. return 0; // Continue regardless
  18985. }
  18986. // The WOLFSSL_CTX points back to its WolfSSLContext, so a handshake only ever
  18987. // runs the verify callback of its own context.
  18988. inline int context_ex_data_index() {
  18989. static const auto index =
  18990. wolfSSL_CTX_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  18991. return index;
  18992. }
  18993. // Each WOLFSSL points back to its WolfSSLSession, the session_t that every
  18994. // other tls:: function takes.
  18995. inline int session_ex_data_index() {
  18996. static const auto index =
  18997. wolfSSL_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  18998. return index;
  18999. }
  19000. // A resumed session skips the client's certificate, so a server that checks
  19001. // one would let in a certificate checked against another server's CA, as
  19002. // wolfSSL shares its session cache between contexts, or against a CA since
  19003. // replaced by update_server_client_ca().
  19004. inline void disable_server_resumption(WolfSSLContext *wctx) {
  19005. if (!wctx->is_server) { return; }
  19006. wolfSSL_CTX_set_session_cache_mode(wctx->ctx, WOLFSSL_SESS_CACHE_OFF);
  19007. #ifdef HAVE_SESSION_TICKET
  19008. wolfSSL_CTX_NoTicketTLSv12(wctx->ctx);
  19009. #endif
  19010. }
  19011. // wolfSSL verify callback wrapper
  19012. inline int wolfssl_verify_callback(int preverify_ok,
  19013. WOLFSSL_X509_STORE_CTX *x509_ctx) {
  19014. // Get the WOLFSSL object from the X509_STORE_CTX
  19015. WOLFSSL *ssl = static_cast<WOLFSSL *>(wolfSSL_X509_STORE_CTX_get_ex_data(
  19016. x509_ctx, wolfSSL_get_ex_data_X509_STORE_CTX_idx()));
  19017. if (!ssl) { return preverify_ok; }
  19018. auto wctx = static_cast<WolfSSLContext *>(wolfSSL_CTX_get_ex_data(
  19019. wolfSSL_get_SSL_CTX(ssl), context_ex_data_index()));
  19020. if (!wctx) { return preverify_ok; }
  19021. std::shared_ptr<VerifyCallback> callback;
  19022. {
  19023. std::lock_guard<std::mutex> guard(verify_callback_mutex());
  19024. callback = wctx->verify_callback;
  19025. }
  19026. if (!callback) { return preverify_ok; }
  19027. WOLFSSL_X509 *cert = wolfSSL_X509_STORE_CTX_get_current_cert(x509_ctx);
  19028. int depth = wolfSSL_X509_STORE_CTX_get_error_depth(x509_ctx);
  19029. int err = wolfSSL_X509_STORE_CTX_get_error(x509_ctx);
  19030. VerifyContext verify_ctx;
  19031. verify_ctx.session = wolfSSL_get_ex_data(ssl, session_ex_data_index());
  19032. verify_ctx.cert = static_cast<cert_t>(cert);
  19033. verify_ctx.depth = depth;
  19034. verify_ctx.preverify_ok = (preverify_ok != 0);
  19035. verify_ctx.error_code = static_cast<long>(err);
  19036. if (err != 0) {
  19037. verify_ctx.error_string = wolfSSL_X509_verify_cert_error_string(err);
  19038. } else {
  19039. verify_ctx.error_string = nullptr;
  19040. }
  19041. bool accepted = run_verify_callback(*callback, verify_ctx);
  19042. return accepted ? 1 : 0;
  19043. }
  19044. // Sets the verify mode from whether the peer's certificate is required and
  19045. // whether a verify callback is set.
  19046. inline void apply_verify_mode(WolfSSLContext &wctx) {
  19047. auto has_callback = static_cast<bool>(wctx.verify_callback);
  19048. if (wctx.verify_client || has_callback) { disable_server_resumption(&wctx); }
  19049. auto mode = wctx.verify_client
  19050. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  19051. : (has_callback ? SSL_VERIFY_PEER : SSL_VERIFY_NONE);
  19052. wolfSSL_CTX_set_verify(wctx.ctx, mode,
  19053. has_callback ? wolfssl_verify_callback : nullptr);
  19054. }
  19055. inline void set_wolfssl_password_cb(WOLFSSL_CTX *ctx, const char *password) {
  19056. wolfSSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char *>(password));
  19057. wolfSSL_CTX_set_default_passwd_cb(
  19058. ctx, [](char *buf, int size, int /*rwflag*/, void *userdata) -> int {
  19059. auto *pwd = static_cast<const char *>(userdata);
  19060. if (!pwd) return 0;
  19061. auto len = static_cast<int>(strlen(pwd));
  19062. if (len > size) len = size;
  19063. memcpy(buf, pwd, static_cast<size_t>(len));
  19064. return len;
  19065. });
  19066. }
  19067. } // namespace impl
  19068. inline ctx_t create_client_context() {
  19069. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  19070. if (!ctx) { return nullptr; }
  19071. ctx->is_server = false;
  19072. WOLFSSL_METHOD *method = wolfTLSv1_2_client_method();
  19073. if (!method) {
  19074. delete ctx;
  19075. return nullptr;
  19076. }
  19077. ctx->ctx = wolfSSL_CTX_new(method);
  19078. if (!ctx->ctx ||
  19079. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  19080. WOLFSSL_SUCCESS) {
  19081. delete ctx;
  19082. return nullptr;
  19083. }
  19084. // Default: verify peer certificate
  19085. ctx->verify_client = true;
  19086. impl::apply_verify_mode(*ctx);
  19087. return static_cast<ctx_t>(ctx);
  19088. }
  19089. inline ctx_t create_server_context() {
  19090. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  19091. if (!ctx) { return nullptr; }
  19092. ctx->is_server = true;
  19093. WOLFSSL_METHOD *method = wolfTLSv1_2_server_method();
  19094. if (!method) {
  19095. delete ctx;
  19096. return nullptr;
  19097. }
  19098. ctx->ctx = wolfSSL_CTX_new(method);
  19099. if (!ctx->ctx ||
  19100. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  19101. WOLFSSL_SUCCESS) {
  19102. delete ctx;
  19103. return nullptr;
  19104. }
  19105. // Default: don't verify client
  19106. impl::apply_verify_mode(*ctx);
  19107. // Enable SNI on server
  19108. wolfSSL_CTX_SNI_SetOptions(ctx->ctx, WOLFSSL_SNI_HOST_NAME,
  19109. WOLFSSL_SNI_CONTINUE_ON_MISMATCH);
  19110. wolfSSL_CTX_set_servername_callback(ctx->ctx, impl::wolfssl_sni_callback);
  19111. return static_cast<ctx_t>(ctx);
  19112. }
  19113. inline void free_context(ctx_t ctx) {
  19114. if (ctx) { delete static_cast<impl::WolfSSLContext *>(ctx); }
  19115. }
  19116. inline bool set_min_version(ctx_t ctx, Version version) {
  19117. if (!ctx) { return false; }
  19118. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19119. int min_ver = WOLFSSL_TLSV1_2;
  19120. if (version >= Version::TLS1_3) { min_ver = WOLFSSL_TLSV1_3; }
  19121. return wolfSSL_CTX_SetMinVersion(wctx->ctx, min_ver) == WOLFSSL_SUCCESS;
  19122. }
  19123. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  19124. if (!ctx || !pem) { return false; }
  19125. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19126. int ret = wolfSSL_CTX_load_verify_buffer(
  19127. wctx->ctx, reinterpret_cast<const unsigned char *>(pem),
  19128. static_cast<long>(len), SSL_FILETYPE_PEM);
  19129. if (ret != SSL_SUCCESS) {
  19130. impl::wolfssl_last_error() =
  19131. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19132. return false;
  19133. }
  19134. wctx->ca_pem_data_.append(pem, len);
  19135. return true;
  19136. }
  19137. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  19138. if (!ctx || !file_path) { return false; }
  19139. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19140. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, file_path, nullptr);
  19141. if (ret != SSL_SUCCESS) {
  19142. impl::wolfssl_last_error() =
  19143. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19144. return false;
  19145. }
  19146. return true;
  19147. }
  19148. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  19149. if (!ctx || !dir_path) { return false; }
  19150. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19151. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, dir_path);
  19152. // wolfSSL may fail if the directory doesn't contain properly hashed certs.
  19153. // Unlike OpenSSL which lazily loads certs from directories, wolfSSL scans
  19154. // immediately. Return true even on failure since the CA file may have
  19155. // already been loaded, matching OpenSSL's lenient behavior.
  19156. (void)ret;
  19157. return true;
  19158. }
  19159. inline bool load_system_certs(ctx_t ctx) {
  19160. if (!ctx) { return false; }
  19161. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19162. bool loaded = false;
  19163. #ifdef _WIN32
  19164. loaded = impl::enumerate_windows_system_certs(
  19165. [&](const unsigned char *data, size_t len) {
  19166. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  19167. static_cast<long>(len),
  19168. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  19169. });
  19170. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  19171. loaded = impl::enumerate_macos_keychain_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. #else
  19178. for (auto path = impl::system_ca_paths(); *path; ++path) {
  19179. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, *path, nullptr) ==
  19180. SSL_SUCCESS) {
  19181. loaded = true;
  19182. break;
  19183. }
  19184. }
  19185. if (!loaded) {
  19186. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  19187. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, *dir) ==
  19188. SSL_SUCCESS) {
  19189. loaded = true;
  19190. break;
  19191. }
  19192. }
  19193. }
  19194. #endif
  19195. return loaded;
  19196. }
  19197. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  19198. const char *password) {
  19199. if (!ctx || !cert || !key) { return false; }
  19200. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19201. // Load certificate
  19202. int ret = wolfSSL_CTX_use_certificate_buffer(
  19203. wctx->ctx, reinterpret_cast<const unsigned char *>(cert),
  19204. static_cast<long>(strlen(cert)), SSL_FILETYPE_PEM);
  19205. if (ret != SSL_SUCCESS) {
  19206. impl::wolfssl_last_error() =
  19207. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19208. return false;
  19209. }
  19210. // Set password callback if password is provided
  19211. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19212. // Load private key
  19213. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  19214. wctx->ctx, reinterpret_cast<const unsigned char *>(key),
  19215. static_cast<long>(strlen(key)), SSL_FILETYPE_PEM);
  19216. if (ret != SSL_SUCCESS) {
  19217. impl::wolfssl_last_error() =
  19218. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19219. return false;
  19220. }
  19221. // Verify that the certificate and private key match
  19222. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  19223. }
  19224. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  19225. const char *key_path, const char *password) {
  19226. if (!ctx || !cert_path || !key_path) { return false; }
  19227. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19228. // Load certificate file
  19229. int ret =
  19230. wolfSSL_CTX_use_certificate_file(wctx->ctx, cert_path, SSL_FILETYPE_PEM);
  19231. if (ret != SSL_SUCCESS) {
  19232. impl::wolfssl_last_error() =
  19233. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19234. return false;
  19235. }
  19236. // Set password callback if password is provided
  19237. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19238. // Load private key file
  19239. ret = wolfSSL_CTX_use_PrivateKey_file(wctx->ctx, key_path, SSL_FILETYPE_PEM);
  19240. if (ret != SSL_SUCCESS) {
  19241. impl::wolfssl_last_error() =
  19242. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19243. return false;
  19244. }
  19245. // Verify that the certificate and private key match
  19246. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  19247. }
  19248. inline void set_verify_client(ctx_t ctx, bool require) {
  19249. if (!ctx) { return; }
  19250. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19251. wctx->verify_client = require;
  19252. impl::apply_verify_mode(*wctx);
  19253. }
  19254. inline session_t create_session(ctx_t ctx, socket_t sock) {
  19255. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  19256. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19257. auto session = new (std::nothrow) impl::WolfSSLSession();
  19258. if (!session) { return nullptr; }
  19259. session->sock = sock;
  19260. session->ssl = wolfSSL_new(wctx->ctx);
  19261. if (!session->ssl) {
  19262. impl::wolfssl_last_error() =
  19263. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19264. delete session;
  19265. return nullptr;
  19266. }
  19267. if (wolfSSL_set_ex_data(session->ssl, impl::session_ex_data_index(),
  19268. session) != WOLFSSL_SUCCESS) {
  19269. delete session;
  19270. return nullptr;
  19271. }
  19272. wolfSSL_set_fd(session->ssl, static_cast<int>(sock));
  19273. return static_cast<session_t>(session);
  19274. }
  19275. inline void free_session(session_t session) {
  19276. if (session) { delete static_cast<impl::WolfSSLSession *>(session); }
  19277. }
  19278. inline bool set_sni(session_t session, const char *hostname,
  19279. bool verify_hostname) {
  19280. if (!session || !hostname) { return false; }
  19281. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19282. int ret = wolfSSL_UseSNI(wsession->ssl, WOLFSSL_SNI_HOST_NAME, hostname,
  19283. static_cast<word16>(strlen(hostname)));
  19284. if (ret != WOLFSSL_SUCCESS) {
  19285. impl::wolfssl_last_error() =
  19286. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19287. return false;
  19288. }
  19289. // wolfSSL_check_domain_name binds identity checking to the handshake,
  19290. // separately from the SNI extension sent above; skip it when hostname
  19291. // verification is disabled so only the chain is checked, matching OpenSSL.
  19292. if (verify_hostname) { wolfSSL_check_domain_name(wsession->ssl, hostname); }
  19293. wsession->hostname = hostname;
  19294. return true;
  19295. }
  19296. inline TlsError connect(session_t session) {
  19297. TlsError err;
  19298. if (!session) {
  19299. err.code = ErrorCode::Fatal;
  19300. return err;
  19301. }
  19302. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19303. int ret = wolfSSL_connect(wsession->ssl);
  19304. if (ret == SSL_SUCCESS) {
  19305. err.code = ErrorCode::Success;
  19306. } else {
  19307. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19308. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19309. err.backend_code = static_cast<uint64_t>(ssl_error);
  19310. impl::wolfssl_last_error() = err.backend_code;
  19311. }
  19312. return err;
  19313. }
  19314. inline TlsError accept(session_t session) {
  19315. TlsError err;
  19316. if (!session) {
  19317. err.code = ErrorCode::Fatal;
  19318. return err;
  19319. }
  19320. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19321. int ret = wolfSSL_accept(wsession->ssl);
  19322. if (ret == SSL_SUCCESS) {
  19323. err.code = ErrorCode::Success;
  19324. // Capture SNI from thread-local storage after successful handshake
  19325. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  19326. impl::wolfssl_pending_sni().clear();
  19327. } else {
  19328. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19329. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19330. err.backend_code = static_cast<uint64_t>(ssl_error);
  19331. impl::wolfssl_last_error() = err.backend_code;
  19332. }
  19333. return err;
  19334. }
  19335. inline bool connect_nonblocking(session_t session, socket_t sock,
  19336. time_t timeout_sec, time_t timeout_usec,
  19337. TlsError *err) {
  19338. if (!session) {
  19339. if (err) { err->code = ErrorCode::Fatal; }
  19340. return false;
  19341. }
  19342. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19343. // Set socket to non-blocking mode
  19344. detail::set_nonblocking(sock, true);
  19345. auto cleanup =
  19346. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19347. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  19348. int ret;
  19349. while ((ret = wolfSSL_connect(wsession->ssl)) != SSL_SUCCESS) {
  19350. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19351. if (ssl_error == SSL_ERROR_WANT_READ) {
  19352. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  19353. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  19354. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  19355. }
  19356. // Error or timeout
  19357. if (err) {
  19358. err->code =
  19359. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  19360. err->backend_code = static_cast<uint64_t>(ssl_error);
  19361. }
  19362. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  19363. return false;
  19364. }
  19365. if (err) { err->code = ErrorCode::Success; }
  19366. return true;
  19367. }
  19368. inline bool accept_nonblocking(session_t session, socket_t sock,
  19369. time_t timeout_sec, time_t timeout_usec,
  19370. TlsError *err) {
  19371. if (!session) {
  19372. if (err) { err->code = ErrorCode::Fatal; }
  19373. return false;
  19374. }
  19375. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19376. // Set socket to non-blocking mode
  19377. detail::set_nonblocking(sock, true);
  19378. auto cleanup =
  19379. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19380. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  19381. int ret;
  19382. while ((ret = wolfSSL_accept(wsession->ssl)) != SSL_SUCCESS) {
  19383. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19384. if (ssl_error == SSL_ERROR_WANT_READ) {
  19385. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  19386. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  19387. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  19388. }
  19389. // Error or timeout
  19390. if (err) {
  19391. err->code =
  19392. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  19393. err->backend_code = static_cast<uint64_t>(ssl_error);
  19394. }
  19395. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  19396. return false;
  19397. }
  19398. if (err) { err->code = ErrorCode::Success; }
  19399. // Capture SNI from thread-local storage after successful handshake
  19400. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  19401. impl::wolfssl_pending_sni().clear();
  19402. return true;
  19403. }
  19404. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  19405. if (!session || !buf) {
  19406. err.code = ErrorCode::Fatal;
  19407. return -1;
  19408. }
  19409. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19410. int ret = wolfSSL_read(wsession->ssl, buf, static_cast<int>(len));
  19411. if (ret > 0) {
  19412. err.code = ErrorCode::Success;
  19413. return static_cast<ssize_t>(ret);
  19414. }
  19415. if (ret == 0) {
  19416. err.code = ErrorCode::PeerClosed;
  19417. return 0;
  19418. }
  19419. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19420. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19421. err.backend_code = static_cast<uint64_t>(ssl_error);
  19422. impl::wolfssl_last_error() = err.backend_code;
  19423. return -1;
  19424. }
  19425. inline ssize_t write(session_t session, const void *buf, size_t len,
  19426. TlsError &err) {
  19427. if (!session || !buf) {
  19428. err.code = ErrorCode::Fatal;
  19429. return -1;
  19430. }
  19431. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19432. int ret = wolfSSL_write(wsession->ssl, buf, static_cast<int>(len));
  19433. if (ret > 0) {
  19434. err.code = ErrorCode::Success;
  19435. return static_cast<ssize_t>(ret);
  19436. }
  19437. // wolfSSL_write returns 0 when the peer has sent a close_notify.
  19438. // Treat this as an error (return -1) so callers don't spin in a
  19439. // write loop adding zero to the offset.
  19440. if (ret == 0) {
  19441. err.code = ErrorCode::PeerClosed;
  19442. return -1;
  19443. }
  19444. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19445. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19446. err.backend_code = static_cast<uint64_t>(ssl_error);
  19447. impl::wolfssl_last_error() = err.backend_code;
  19448. return -1;
  19449. }
  19450. inline int pending(const_session_t session) {
  19451. if (!session) { return 0; }
  19452. auto wsession =
  19453. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19454. return wolfSSL_pending(wsession->ssl);
  19455. }
  19456. inline void shutdown(session_t session, bool graceful) {
  19457. if (!session) { return; }
  19458. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19459. if (graceful) {
  19460. int ret;
  19461. int attempts = 0;
  19462. while ((ret = wolfSSL_shutdown(wsession->ssl)) != SSL_SUCCESS &&
  19463. attempts < 3) {
  19464. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19465. if (ssl_error != SSL_ERROR_WANT_READ &&
  19466. ssl_error != SSL_ERROR_WANT_WRITE) {
  19467. break;
  19468. }
  19469. attempts++;
  19470. }
  19471. } else {
  19472. wolfSSL_shutdown(wsession->ssl);
  19473. }
  19474. }
  19475. inline bool is_peer_closed(session_t session, socket_t sock) {
  19476. if (!session || sock == INVALID_SOCKET) { return true; }
  19477. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19478. // Check if there's already decrypted data available
  19479. if (wolfSSL_pending(wsession->ssl) > 0) { return false; }
  19480. // Set socket to non-blocking to avoid blocking on read
  19481. detail::set_nonblocking(sock, true);
  19482. auto cleanup =
  19483. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19484. // Peek 1 byte to check connection status without consuming data
  19485. unsigned char buf;
  19486. int ret = wolfSSL_peek(wsession->ssl, &buf, 1);
  19487. // If we got data or WANT_READ (would block), connection is alive
  19488. if (ret > 0) { return false; }
  19489. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19490. if (ssl_error == SSL_ERROR_WANT_READ) { return false; }
  19491. return ssl_error == SSL_ERROR_ZERO_RETURN || ssl_error == SSL_ERROR_SYSCALL ||
  19492. ret == 0;
  19493. }
  19494. inline cert_t get_peer_cert(const_session_t session) {
  19495. if (!session) { return nullptr; }
  19496. auto wsession =
  19497. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19498. WOLFSSL_X509 *cert = wolfSSL_get_peer_certificate(wsession->ssl);
  19499. return static_cast<cert_t>(cert);
  19500. }
  19501. inline size_t get_peer_certs(const_session_t session,
  19502. std::vector<cert_t> &certs) {
  19503. certs.clear();
  19504. if (!session) { return 0; }
  19505. // wolfSSL keeps the received chain only when built with SESSION_CERTS
  19506. #ifdef SESSION_CERTS
  19507. auto wsession =
  19508. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19509. auto chain = wolfSSL_get_peer_chain(wsession->ssl);
  19510. auto count = chain ? wolfSSL_get_chain_count(chain) : 0;
  19511. for (int i = 0; i < count; i++) {
  19512. auto x509 = wolfSSL_get_chain_X509(chain, i);
  19513. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19514. }
  19515. #endif
  19516. return certs.size();
  19517. }
  19518. inline void free_cert(cert_t cert) {
  19519. if (cert) { wolfSSL_X509_free(static_cast<WOLFSSL_X509 *>(cert)); }
  19520. }
  19521. inline bool verify_hostname(cert_t cert, const char *hostname) {
  19522. if (!cert || !hostname) { return false; }
  19523. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19524. std::string host_str(hostname);
  19525. // Check if hostname is an IP address (IPv4 or IPv6)
  19526. unsigned char ip_bytes[16];
  19527. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  19528. auto is_ip = ip_len > 0;
  19529. // Check Subject Alternative Names
  19530. auto has_dns_san = false;
  19531. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  19532. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  19533. if (san_names) {
  19534. int san_count = wolfSSL_sk_num(san_names);
  19535. for (int i = 0; i < san_count; i++) {
  19536. auto *names =
  19537. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  19538. if (!names) continue;
  19539. if (!is_ip && names->type == WOLFSSL_GEN_DNS) {
  19540. // DNS name
  19541. has_dns_san = true;
  19542. unsigned char *dns_name = nullptr;
  19543. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, names->d.dNSName);
  19544. if (dns_name && dns_len > 0) {
  19545. std::string san_name(reinterpret_cast<char *>(dns_name),
  19546. static_cast<size_t>(dns_len));
  19547. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  19548. if (detail::match_hostname(san_name, host_str)) {
  19549. wolfSSL_sk_free(san_names);
  19550. return true;
  19551. }
  19552. }
  19553. } else if (is_ip && names->type == WOLFSSL_GEN_IPADD) {
  19554. // IP address: only an iPAddress SAN of the same family (4 bytes for
  19555. // IPv4, 16 bytes for IPv6) may authenticate the host.
  19556. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(names->d.iPAddress);
  19557. auto san_ip_len = wolfSSL_ASN1_STRING_length(names->d.iPAddress);
  19558. if (ip_data && san_ip_len == static_cast<int>(ip_len) &&
  19559. memcmp(ip_data, ip_bytes, ip_len) == 0) {
  19560. wolfSSL_sk_free(san_names);
  19561. return true;
  19562. }
  19563. }
  19564. }
  19565. wolfSSL_sk_free(san_names);
  19566. }
  19567. // Fallback: the Common Name (CN) in the subject, as X509_check_host does it:
  19568. // never for an IP host, which only an iPAddress SAN names, and never next to
  19569. // a DNS SAN (RFC 6125 6.4.4).
  19570. if (is_ip || has_dns_san) { return false; }
  19571. auto cn = get_cert_subject_cn(cert);
  19572. return !cn.empty() && detail::match_hostname(cn, host_str);
  19573. }
  19574. inline uint64_t hostname_mismatch_code() {
  19575. return static_cast<uint64_t>(DOMAIN_NAME_MISMATCH);
  19576. }
  19577. inline long get_verify_result(const_session_t session) {
  19578. if (!session) { return -1; }
  19579. auto wsession =
  19580. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19581. long result = wolfSSL_get_verify_result(wsession->ssl);
  19582. return result;
  19583. }
  19584. inline std::string get_cert_subject_cn(cert_t cert) {
  19585. if (!cert) return "";
  19586. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19587. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19588. if (!subject) return "";
  19589. char cn[256] = {};
  19590. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  19591. sizeof(cn));
  19592. if (cn_len <= 0) return "";
  19593. return std::string(cn, static_cast<size_t>(cn_len));
  19594. }
  19595. inline std::string get_cert_issuer_name(cert_t cert) {
  19596. if (!cert) return "";
  19597. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19598. WOLFSSL_X509_NAME *issuer = wolfSSL_X509_get_issuer_name(x509);
  19599. if (!issuer) return "";
  19600. char *name_str = wolfSSL_X509_NAME_oneline(issuer, nullptr, 0);
  19601. if (!name_str) return "";
  19602. std::string result(name_str);
  19603. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19604. return result;
  19605. }
  19606. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  19607. sans.clear();
  19608. if (!cert) return false;
  19609. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19610. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  19611. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  19612. if (!san_names) return true; // No SANs is not an error
  19613. int count = wolfSSL_sk_num(san_names);
  19614. for (int i = 0; i < count; i++) {
  19615. auto *name =
  19616. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  19617. if (!name) continue;
  19618. SanEntry entry;
  19619. switch (name->type) {
  19620. case WOLFSSL_GEN_DNS: {
  19621. entry.type = SanType::DNS;
  19622. unsigned char *dns_name = nullptr;
  19623. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, name->d.dNSName);
  19624. if (dns_name && dns_len > 0) {
  19625. entry.value = std::string(reinterpret_cast<char *>(dns_name),
  19626. static_cast<size_t>(dns_len));
  19627. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  19628. }
  19629. break;
  19630. }
  19631. case WOLFSSL_GEN_IPADD: {
  19632. entry.type = SanType::IP;
  19633. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(name->d.iPAddress);
  19634. int ip_len = wolfSSL_ASN1_STRING_length(name->d.iPAddress);
  19635. if (ip_data && ip_len == 4) {
  19636. char buf[16];
  19637. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", ip_data[0], ip_data[1],
  19638. ip_data[2], ip_data[3]);
  19639. entry.value = buf;
  19640. } else if (ip_data && ip_len == 16) {
  19641. char buf[64];
  19642. snprintf(buf, sizeof(buf),
  19643. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  19644. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  19645. ip_data[0], ip_data[1], ip_data[2], ip_data[3], ip_data[4],
  19646. ip_data[5], ip_data[6], ip_data[7], ip_data[8], ip_data[9],
  19647. ip_data[10], ip_data[11], ip_data[12], ip_data[13],
  19648. ip_data[14], ip_data[15]);
  19649. entry.value = buf;
  19650. }
  19651. break;
  19652. }
  19653. case WOLFSSL_GEN_EMAIL:
  19654. entry.type = SanType::EMAIL;
  19655. {
  19656. unsigned char *email = nullptr;
  19657. int email_len = wolfSSL_ASN1_STRING_to_UTF8(&email, name->d.rfc822Name);
  19658. if (email && email_len > 0) {
  19659. entry.value = std::string(reinterpret_cast<char *>(email),
  19660. static_cast<size_t>(email_len));
  19661. XFREE(email, nullptr, DYNAMIC_TYPE_OPENSSL);
  19662. }
  19663. }
  19664. break;
  19665. case WOLFSSL_GEN_URI:
  19666. entry.type = SanType::URI;
  19667. {
  19668. unsigned char *uri = nullptr;
  19669. int uri_len = wolfSSL_ASN1_STRING_to_UTF8(
  19670. &uri, name->d.uniformResourceIdentifier);
  19671. if (uri && uri_len > 0) {
  19672. entry.value = std::string(reinterpret_cast<char *>(uri),
  19673. static_cast<size_t>(uri_len));
  19674. XFREE(uri, nullptr, DYNAMIC_TYPE_OPENSSL);
  19675. }
  19676. }
  19677. break;
  19678. default: entry.type = SanType::OTHER; break;
  19679. }
  19680. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  19681. }
  19682. wolfSSL_sk_free(san_names);
  19683. return true;
  19684. }
  19685. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  19686. time_t &not_after) {
  19687. if (!cert) return false;
  19688. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19689. const WOLFSSL_ASN1_TIME *nb = wolfSSL_X509_get_notBefore(x509);
  19690. const WOLFSSL_ASN1_TIME *na = wolfSSL_X509_get_notAfter(x509);
  19691. if (!nb || !na) return false;
  19692. // wolfSSL_ASN1_TIME_to_tm is available
  19693. struct tm tm_nb = {}, tm_na = {};
  19694. if (wolfSSL_ASN1_TIME_to_tm(nb, &tm_nb) != WOLFSSL_SUCCESS) return false;
  19695. if (wolfSSL_ASN1_TIME_to_tm(na, &tm_na) != WOLFSSL_SUCCESS) return false;
  19696. #ifdef _WIN32
  19697. not_before = _mkgmtime(&tm_nb);
  19698. not_after = _mkgmtime(&tm_na);
  19699. #else
  19700. not_before = timegm(&tm_nb);
  19701. not_after = timegm(&tm_na);
  19702. #endif
  19703. return true;
  19704. }
  19705. inline std::string get_cert_serial(cert_t cert) {
  19706. if (!cert) return "";
  19707. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19708. WOLFSSL_ASN1_INTEGER *serial_asn1 = wolfSSL_X509_get_serialNumber(x509);
  19709. if (!serial_asn1) return "";
  19710. // Get the serial number data
  19711. int len = serial_asn1->length;
  19712. unsigned char *data = serial_asn1->data;
  19713. if (!data || len <= 0) return "";
  19714. std::string result;
  19715. result.reserve(static_cast<size_t>(len) * 2);
  19716. for (int i = 0; i < len; i++) {
  19717. char hex[3];
  19718. snprintf(hex, sizeof(hex), "%02X", data[i]);
  19719. result += hex;
  19720. }
  19721. return result;
  19722. }
  19723. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  19724. if (!cert) return false;
  19725. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19726. int der_len = 0;
  19727. const unsigned char *der_data = wolfSSL_X509_get_der(x509, &der_len);
  19728. if (!der_data || der_len <= 0) return false;
  19729. der.assign(der_data, der_data + der_len);
  19730. return true;
  19731. }
  19732. inline const char *get_sni(const_session_t session) {
  19733. if (!session) return nullptr;
  19734. auto wsession = static_cast<const impl::WolfSSLSession *>(session);
  19735. // For server: return SNI received from client during handshake
  19736. if (!wsession->sni_hostname.empty()) {
  19737. return wsession->sni_hostname.c_str();
  19738. }
  19739. // For client: return the hostname set via set_sni
  19740. if (!wsession->hostname.empty()) { return wsession->hostname.c_str(); }
  19741. return nullptr;
  19742. }
  19743. inline uint64_t peek_error() {
  19744. return static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19745. }
  19746. inline uint64_t get_error() {
  19747. uint64_t err = impl::wolfssl_last_error();
  19748. impl::wolfssl_last_error() = 0;
  19749. return err;
  19750. }
  19751. inline std::string error_string(uint64_t code) {
  19752. char buf[256];
  19753. wolfSSL_ERR_error_string(static_cast<unsigned long>(code), buf);
  19754. return std::string(buf);
  19755. }
  19756. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  19757. if (!pem || len == 0) { return nullptr; }
  19758. // Validate by attempting to load into a temporary ctx
  19759. WOLFSSL_CTX *tmp_ctx = wolfSSL_CTX_new(wolfTLSv1_2_client_method());
  19760. if (!tmp_ctx) { return nullptr; }
  19761. int ret = wolfSSL_CTX_load_verify_buffer(
  19762. tmp_ctx, reinterpret_cast<const unsigned char *>(pem),
  19763. static_cast<long>(len), SSL_FILETYPE_PEM);
  19764. wolfSSL_CTX_free(tmp_ctx);
  19765. if (ret != SSL_SUCCESS) { return nullptr; }
  19766. return static_cast<ca_store_t>(
  19767. new impl::WolfSSLCAStore{std::string(pem, len)});
  19768. }
  19769. inline void free_ca_store(ca_store_t store) {
  19770. delete static_cast<impl::WolfSSLCAStore *>(store);
  19771. }
  19772. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  19773. if (!ctx || !store) { return false; }
  19774. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19775. auto *ca = static_cast<impl::WolfSSLCAStore *>(store);
  19776. int ret = wolfSSL_CTX_load_verify_buffer(
  19777. wctx->ctx, reinterpret_cast<const unsigned char *>(ca->pem_data.data()),
  19778. static_cast<long>(ca->pem_data.size()), SSL_FILETYPE_PEM);
  19779. if (ret == SSL_SUCCESS) { wctx->ca_pem_data_ += ca->pem_data; }
  19780. // This function takes ownership of the store; the PEM data was copied into
  19781. // the context, so release the source
  19782. free_ca_store(store);
  19783. return ret == SSL_SUCCESS;
  19784. }
  19785. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  19786. certs.clear();
  19787. if (!ctx) { return 0; }
  19788. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19789. if (wctx->ca_pem_data_.empty()) { return 0; }
  19790. const std::string &pem = wctx->ca_pem_data_;
  19791. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19792. const std::string end_marker = "-----END CERTIFICATE-----";
  19793. size_t pos = 0;
  19794. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19795. size_t end_pos = pem.find(end_marker, pos);
  19796. if (end_pos == std::string::npos) { break; }
  19797. end_pos += end_marker.size();
  19798. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19799. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19800. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19801. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19802. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19803. pos = end_pos;
  19804. }
  19805. return certs.size();
  19806. }
  19807. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  19808. std::vector<std::string> names;
  19809. if (!ctx) { return names; }
  19810. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19811. if (wctx->ca_pem_data_.empty()) { return names; }
  19812. const std::string &pem = wctx->ca_pem_data_;
  19813. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19814. const std::string end_marker = "-----END CERTIFICATE-----";
  19815. size_t pos = 0;
  19816. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19817. size_t end_pos = pem.find(end_marker, pos);
  19818. if (end_pos == std::string::npos) { break; }
  19819. end_pos += end_marker.size();
  19820. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19821. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19822. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19823. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19824. if (x509) {
  19825. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19826. if (subject) {
  19827. char *name_str = wolfSSL_X509_NAME_oneline(subject, nullptr, 0);
  19828. if (name_str) {
  19829. names.push_back(name_str);
  19830. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19831. }
  19832. }
  19833. wolfSSL_X509_free(x509);
  19834. }
  19835. pos = end_pos;
  19836. }
  19837. return names;
  19838. }
  19839. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  19840. const char *key_pem, const char *password) {
  19841. if (!ctx || !cert_pem || !key_pem) { return false; }
  19842. // Try the pair on a scratch context first, so that a bad one leaves the
  19843. // server's certificate and key as they were
  19844. auto tmp = create_server_context();
  19845. if (!tmp) { return false; }
  19846. auto se = detail::scope_exit([&] { free_context(tmp); });
  19847. if (!set_client_cert_pem(tmp, cert_pem, key_pem, password)) { return false; }
  19848. return set_client_cert_pem(ctx, cert_pem, key_pem, password);
  19849. }
  19850. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  19851. if (!ctx || !ca_pem) { return false; }
  19852. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19853. // Replace the CAs rather than add to them, as the other backends do, once
  19854. // the new ones are known to load
  19855. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  19856. if (!store) { return false; }
  19857. free_ca_store(store);
  19858. wolfSSL_CTX_UnloadCAs(wctx->ctx);
  19859. wctx->ca_pem_data_.clear();
  19860. return load_ca_pem(ctx, ca_pem, strlen(ca_pem));
  19861. }
  19862. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  19863. if (!ctx) { return false; }
  19864. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19865. auto stored = callback ? std::make_shared<VerifyCallback>(std::move(callback))
  19866. : nullptr;
  19867. {
  19868. std::lock_guard<std::mutex> guard(impl::verify_callback_mutex());
  19869. // A handshake running the previous callback keeps it until it returns.
  19870. wctx->verify_callback.swap(stored);
  19871. }
  19872. impl::apply_verify_mode(*wctx);
  19873. return true;
  19874. }
  19875. inline long get_verify_error(const_session_t session) {
  19876. if (!session) { return -1; }
  19877. auto *wsession =
  19878. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19879. return wolfSSL_get_verify_result(wsession->ssl);
  19880. }
  19881. inline std::string verify_error_string(long error_code) {
  19882. if (error_code == 0) { return ""; }
  19883. const char *str =
  19884. wolfSSL_X509_verify_cert_error_string(static_cast<int>(error_code));
  19885. return str ? std::string(str) : std::string();
  19886. }
  19887. } // namespace tls
  19888. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  19889. // WebSocket implementation
  19890. namespace ws {
  19891. inline bool WebSocket::send_frame(Opcode op, const char *data, size_t len,
  19892. bool fin) {
  19893. std::lock_guard<std::mutex> lock(write_mutex_);
  19894. if (closed_) { return false; }
  19895. return detail::write_websocket_frame(strm_, op, data, len, fin, !is_server_);
  19896. }
  19897. inline ReadResult WebSocket::read(std::string &msg) {
  19898. // Answers a control frame; any other opcode here is a protocol error.
  19899. // Returns false when the connection is done.
  19900. auto handle_control = [&](Opcode op, const std::string &payload) -> bool {
  19901. switch (op) {
  19902. case Opcode::Ping: {
  19903. std::lock_guard<std::mutex> lock(write_mutex_);
  19904. detail::write_websocket_frame(strm_, Opcode::Pong, payload.data(),
  19905. payload.size(), true, !is_server_);
  19906. return true;
  19907. }
  19908. case Opcode::Pong: {
  19909. std::lock_guard<std::mutex> lock(ping_mutex_);
  19910. unacked_pings_ = 0;
  19911. return true;
  19912. }
  19913. case Opcode::Close: {
  19914. // RFC 6455 §5.5.1: a Close is echoed back, unless its payload is
  19915. // malformed, which is answered with a protocol error instead.
  19916. if (closed_.exchange(true)) { return false; }
  19917. auto reply = payload;
  19918. if (!impl::is_valid_close_payload(payload)) {
  19919. auto code = static_cast<uint16_t>(CloseStatus::ProtocolError);
  19920. reply = {static_cast<char>(code >> 8), static_cast<char>(code & 0xff)};
  19921. }
  19922. std::lock_guard<std::mutex> lock(write_mutex_);
  19923. detail::write_websocket_frame(strm_, Opcode::Close, reply.data(),
  19924. reply.size(), true, !is_server_);
  19925. return false;
  19926. }
  19927. default: closed_ = true; return false;
  19928. }
  19929. };
  19930. std::unique_lock<std::mutex> read_lock(read_mutex_);
  19931. while (!closed_) {
  19932. Opcode opcode;
  19933. std::string payload;
  19934. bool fin;
  19935. impl::FrameRead r =
  19936. impl::read_websocket_frame(strm_, opcode, payload, fin, is_server_,
  19937. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH);
  19938. // A timeout landed on a frame boundary of an open connection: it is
  19939. // untouched and still usable, so hand control back without closing it.
  19940. // That is only useful to a caller who asked for the timeout; the
  19941. // compile-time default is a backstop against a peer gone quiet, and
  19942. // elapsing it closes the connection so a plain `while (ws.read(msg))` loop
  19943. // ends. A wait that a pong timeout cut short finds the connection closed.
  19944. if (r == impl::FrameRead::Timeout && read_timeout_set_ && !closed_) {
  19945. return Timeout;
  19946. }
  19947. if (r != impl::FrameRead::Ok) {
  19948. closed_ = true;
  19949. return Fail;
  19950. }
  19951. switch (opcode) {
  19952. case Opcode::Text:
  19953. case Opcode::Binary: {
  19954. auto result = opcode == Opcode::Text ? Text : Binary;
  19955. msg = std::move(payload);
  19956. // Handle fragmentation
  19957. if (!fin) {
  19958. while (true) {
  19959. Opcode cont_opcode;
  19960. std::string cont_payload;
  19961. bool cont_fin;
  19962. // Only what is left of the limit, but room for a control frame,
  19963. // which may come between the fragments.
  19964. auto max_len =
  19965. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH == 0
  19966. ? size_t(0)
  19967. : (std::max)(size_t(125),
  19968. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH -
  19969. msg.size());
  19970. // A timeout is not reportable here: half of a fragmented message is
  19971. // already in `msg` and read() has no way to resume it, so it is a
  19972. // failure like any other. Timeouts are only ever seen on a message
  19973. // boundary.
  19974. if (impl::read_websocket_frame(strm_, cont_opcode, cont_payload,
  19975. cont_fin, is_server_,
  19976. max_len) != impl::FrameRead::Ok) {
  19977. closed_ = true;
  19978. return Fail;
  19979. }
  19980. // RFC 6455 5.4: the fragments are continuation frames, with only
  19981. // control frames between them.
  19982. if (cont_opcode != Opcode::Continuation) {
  19983. if (handle_control(cont_opcode, cont_payload)) { continue; }
  19984. return Fail;
  19985. }
  19986. msg += cont_payload;
  19987. if (CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH > 0 &&
  19988. msg.size() > CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) {
  19989. closed_ = true;
  19990. return Fail;
  19991. }
  19992. if (cont_fin) { break; }
  19993. }
  19994. }
  19995. // RFC 6455 Section 5.6: text frames must contain valid UTF-8
  19996. if (result == Text && !impl::is_valid_utf8(msg)) {
  19997. // close() takes the read lock to wait for the peer's Close reply, so
  19998. // it must not run while this thread still holds it.
  19999. read_lock.unlock();
  20000. close(CloseStatus::InvalidPayload, "invalid UTF-8");
  20001. return Fail;
  20002. }
  20003. return result;
  20004. }
  20005. default:
  20006. if (handle_control(opcode, payload)) { continue; }
  20007. return Fail;
  20008. }
  20009. }
  20010. return Fail;
  20011. }
  20012. inline bool WebSocket::send(const std::string &data) {
  20013. return send_frame(Opcode::Text, data.data(), data.size());
  20014. }
  20015. inline bool WebSocket::send(const char *data, size_t len) {
  20016. return send_frame(Opcode::Binary, data, len);
  20017. }
  20018. inline void WebSocket::close(CloseStatus status, const std::string &reason) {
  20019. if (closed_.exchange(true)) { return; }
  20020. ping_cv_.notify_all();
  20021. std::string payload;
  20022. auto code = static_cast<uint16_t>(status);
  20023. payload.push_back(static_cast<char>((code >> 8) & 0xFF));
  20024. payload.push_back(static_cast<char>(code & 0xFF));
  20025. // RFC 6455 Section 5.5: control frame payload must not exceed 125 bytes
  20026. // Close frame has 2-byte status code, so reason is limited to 123 bytes,
  20027. // cut back to a whole UTF-8 character
  20028. auto short_reason = reason.substr(0, 123);
  20029. while (!short_reason.empty() && !impl::is_valid_utf8(short_reason)) {
  20030. short_reason.pop_back();
  20031. }
  20032. payload += short_reason;
  20033. // A code that may not be sent, such as NoStatus, goes without a payload
  20034. if (!impl::is_valid_close_payload(payload)) { payload.clear(); }
  20035. {
  20036. std::lock_guard<std::mutex> lock(write_mutex_);
  20037. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  20038. payload.size(), true, !is_server_);
  20039. }
  20040. // RFC 6455 Section 7.1.1: after sending a Close frame, wait for the peer's
  20041. // Close response before closing the TCP connection.
  20042. //
  20043. // Wait only when no other thread is parsing frames. When one is, it is the
  20044. // thread positioned to see the peer's reply, and reading here would take
  20045. // bytes out of the message it is assembling. Bailing out also leaves the
  20046. // stream, including its read timeout, entirely to that thread.
  20047. std::unique_lock<std::mutex> read_lock(read_mutex_, std::try_to_lock);
  20048. if (!read_lock.owns_lock()) { return; }
  20049. // Use a short timeout to avoid hanging if the peer doesn't respond.
  20050. strm_.set_read_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  20051. Opcode op;
  20052. std::string resp;
  20053. bool fin;
  20054. while (impl::read_websocket_frame(strm_, op, resp, fin, is_server_, 125) ==
  20055. impl::FrameRead::Ok) {
  20056. if (op == Opcode::Close) { break; }
  20057. }
  20058. }
  20059. inline WebSocket::~WebSocket() {
  20060. {
  20061. std::lock_guard<std::mutex> lock(ping_mutex_);
  20062. closed_ = true;
  20063. }
  20064. ping_cv_.notify_all();
  20065. if (ping_thread_.joinable()) { ping_thread_.join(); }
  20066. // A server's stream outlives this object
  20067. strm_.set_read_interrupt(nullptr);
  20068. }
  20069. inline void WebSocket::start_heartbeat() {
  20070. if (ping_interval_sec_ <= 0) { return; }
  20071. // A pong timeout ends a read() blocked on the silent peer
  20072. if (max_missed_pongs_ > 0) {
  20073. strm_.set_read_interrupt([this] { return pong_timed_out_.load(); });
  20074. }
  20075. ping_thread_ = std::thread([this]() {
  20076. std::unique_lock<std::mutex> lock(ping_mutex_);
  20077. // The predicate keeps a spurious wakeup from sending a ping early
  20078. while (!ping_cv_.wait_for(lock, std::chrono::seconds(ping_interval_sec_),
  20079. [this]() { return closed_.load(); })) {
  20080. // If the peer has failed to respond to the previous pings, give up.
  20081. // RFC 6455 does not define a pong-timeout mechanism; this is an
  20082. // opt-in liveness check controlled by max_missed_pongs_.
  20083. if (max_missed_pongs_ > 0 && unacked_pings_ >= max_missed_pongs_) {
  20084. lock.unlock();
  20085. close(CloseStatus::GoingAway, "pong timeout");
  20086. pong_timed_out_ = true;
  20087. return;
  20088. }
  20089. lock.unlock();
  20090. if (!send_frame(Opcode::Ping, nullptr, 0)) {
  20091. lock.lock();
  20092. closed_ = true;
  20093. break;
  20094. }
  20095. lock.lock();
  20096. unacked_pings_++;
  20097. }
  20098. });
  20099. }
  20100. inline const Request &WebSocket::request() const { return req_; }
  20101. inline bool WebSocket::is_open() const { return !closed_; }
  20102. inline void WebSocket::set_read_timeout(time_t sec, time_t usec) {
  20103. // 0 waits forever here, as it does for SO_RCVTIMEO. The stream waits with
  20104. // poll(), where 0 would instead mean "return immediately", so hand it the
  20105. // negative poll uses for an unbounded wait.
  20106. if (sec == 0 && usec == 0) { sec = -1; }
  20107. strm_.set_read_timeout(sec, usec);
  20108. read_timeout_set_ = true;
  20109. }
  20110. // WebSocketClient implementation
  20111. inline WebSocketClient::WebSocketClient(
  20112. const std::string &scheme_host_port_path, const Headers &headers)
  20113. : headers_(headers) {
  20114. detail::UrlComponents uc;
  20115. if (detail::parse_url(scheme_host_port_path, uc) && !uc.scheme.empty() &&
  20116. !uc.host.empty() && !uc.path.empty()) {
  20117. auto &scheme = uc.scheme;
  20118. #ifdef CPPHTTPLIB_SSL_ENABLED
  20119. if (scheme != "ws" && scheme != "wss") {
  20120. #else
  20121. if (scheme != "ws") {
  20122. #endif
  20123. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  20124. std::string msg = "'" + scheme + "' scheme is not supported.";
  20125. throw std::invalid_argument(msg);
  20126. #endif
  20127. return;
  20128. }
  20129. auto is_ssl = scheme == "wss";
  20130. host_ = std::move(uc.host);
  20131. port_ = is_ssl ? 443 : 80;
  20132. if (!uc.port.empty() && !detail::parse_port(uc.port, port_)) { return; }
  20133. path_ = std::move(uc.path);
  20134. if (!uc.query.empty()) { path_ += uc.query; }
  20135. #ifdef CPPHTTPLIB_SSL_ENABLED
  20136. is_ssl_ = is_ssl;
  20137. if (is_ssl_) {
  20138. // The context lives as long as the client so that CA configuration
  20139. // survives reconnects; sessions are created per connection.
  20140. tls_ctx_ = tls::create_client_context();
  20141. if (!tls_ctx_) { return; }
  20142. }
  20143. #else
  20144. if (is_ssl) { return; }
  20145. #endif
  20146. is_valid_ = true;
  20147. }
  20148. }
  20149. #ifdef CPPHTTPLIB_SSL_ENABLED
  20150. inline WebSocketClient::WebSocketClient(
  20151. const std::string &scheme_host_port_path, const PemMemory &pem,
  20152. const Headers &headers)
  20153. : WebSocketClient(scheme_host_port_path, headers) {
  20154. // For ws:// URLs the client certificate is silently ignored, consistent
  20155. // with the TLS-only setters such as set_ca_cert_path().
  20156. if (is_valid_ && is_ssl_ && pem.cert_pem && pem.key_pem) {
  20157. std::string cert_buf, key_buf;
  20158. if (!tls::set_client_cert_pem(
  20159. tls_ctx_,
  20160. detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  20161. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  20162. pem.private_key_password)) {
  20163. tls::free_context(tls_ctx_);
  20164. tls_ctx_ = nullptr;
  20165. is_valid_ = false;
  20166. }
  20167. }
  20168. }
  20169. #endif
  20170. inline WebSocketClient::~WebSocketClient() {
  20171. shutdown_and_close();
  20172. #ifdef CPPHTTPLIB_SSL_ENABLED
  20173. if (tls_ctx_) {
  20174. tls::free_context(tls_ctx_);
  20175. tls_ctx_ = nullptr;
  20176. }
  20177. #endif
  20178. }
  20179. inline bool WebSocketClient::is_valid() const { return is_valid_; }
  20180. inline void WebSocketClient::shutdown_and_close() {
  20181. // Send the close frame while the TLS session is still alive: ws_ holds an
  20182. // SSLSocketStream that keeps a raw pointer to tls_session_, so the session
  20183. // must outlive ws_->close() and ws_.reset() to avoid a use-after-free.
  20184. if (ws_ && ws_->is_open()) { ws_->close(); }
  20185. ws_.reset();
  20186. #ifdef CPPHTTPLIB_SSL_ENABLED
  20187. if (is_ssl_) {
  20188. if (tls_session_) {
  20189. tls::shutdown(tls_session_, true);
  20190. tls::free_session(tls_session_);
  20191. tls_session_ = nullptr;
  20192. }
  20193. }
  20194. #endif
  20195. if (sock_ != INVALID_SOCKET) {
  20196. detail::shutdown_socket(sock_);
  20197. detail::close_socket(sock_);
  20198. sock_ = INVALID_SOCKET;
  20199. }
  20200. }
  20201. // The handshakes belong to establishing the connection, so an unset read
  20202. // timeout leaves them bounded by the connection timeout instead of forever.
  20203. inline std::pair<time_t, time_t> WebSocketClient::handshake_timeout() const {
  20204. if (read_timeout_sec_ == 0 && read_timeout_usec_ == 0) {
  20205. return {connection_timeout_sec_, connection_timeout_usec_};
  20206. }
  20207. return {read_timeout_sec_, read_timeout_usec_};
  20208. }
  20209. inline bool WebSocketClient::create_stream(std::unique_ptr<Stream> &strm,
  20210. Error &error, int &ssl_error,
  20211. uint64_t &ssl_backend_error) {
  20212. // A read timeout of 0 means "wait forever", the way SO_RCVTIMEO reads it.
  20213. // The streams wait with poll(), where 0 instead means "return immediately",
  20214. // so they are given the negative poll uses for an unbounded wait.
  20215. auto unbounded = read_timeout_sec_ == 0 && read_timeout_usec_ == 0;
  20216. time_t strm_read_sec = unbounded ? -1 : read_timeout_sec_;
  20217. time_t strm_read_usec = unbounded ? 0 : read_timeout_usec_;
  20218. #ifdef CPPHTTPLIB_SSL_ENABLED
  20219. if (is_ssl_) {
  20220. // A plain flag rather than SSLClient::load_certs()'s call_once: connect()
  20221. // is not safe to call concurrently on one client to begin with, since
  20222. // nothing else here is guarded either.
  20223. if (server_certificate_verification_ && !certs_loaded_) {
  20224. uint64_t backend_error = 0;
  20225. detail::load_client_ca_config(tls_ctx_, ca_cert_file_path_,
  20226. ca_cert_dir_path_, custom_ca_loaded_,
  20227. system_ca_mode_, backend_error);
  20228. certs_loaded_ = true;
  20229. }
  20230. detail::ClientTlsSessionOptions options;
  20231. options.server_hostname_verification = server_hostname_verification_;
  20232. options.session_verifier = session_verifier_;
  20233. auto timeout = handshake_timeout();
  20234. detail::ClientTlsSessionError tls_error;
  20235. if (!detail::setup_client_tls_session(host_, tls_ctx_, tls_session_, sock_,
  20236. server_certificate_verification_,
  20237. timeout.first, timeout.second,
  20238. &tls_error, options)) {
  20239. error = tls_error.error;
  20240. ssl_error = tls_error.ssl_error;
  20241. ssl_backend_error = tls_error.backend_error;
  20242. return false;
  20243. }
  20244. strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  20245. sock_, tls_session_, strm_read_sec, strm_read_usec, write_timeout_sec_,
  20246. write_timeout_usec_));
  20247. return true;
  20248. }
  20249. #else
  20250. (void)error;
  20251. (void)ssl_error;
  20252. (void)ssl_backend_error;
  20253. #endif
  20254. strm = std::unique_ptr<Stream>(
  20255. new detail::SocketStream(sock_, strm_read_sec, strm_read_usec,
  20256. write_timeout_sec_, write_timeout_usec_));
  20257. return true;
  20258. }
  20259. inline void WebSocketClient::prepare_default_headers(Request &req) {
  20260. #ifdef CPPHTTPLIB_SSL_ENABLED
  20261. auto is_ssl = is_ssl_;
  20262. #else
  20263. auto is_ssl = false;
  20264. #endif
  20265. if (!req.has_header("Host")) {
  20266. req.headers.emplace("Host", detail::make_default_host_header_value(
  20267. host_, port_, is_ssl, address_family_));
  20268. }
  20269. detail::add_default_user_agent_header(req);
  20270. }
  20271. inline Result WebSocketClient::connect() {
  20272. if (!is_valid_) { return Result{Error::Connection, -1, Headers{}}; }
  20273. shutdown_and_close();
  20274. auto error = Error::Success;
  20275. if (!create_and_connect_socket(error)) {
  20276. return Result{error, -1, Headers{}};
  20277. }
  20278. if (is_proxy_enabled()) {
  20279. Response proxy_res;
  20280. if (!connect_with_proxy(proxy_res, error)) {
  20281. shutdown_and_close();
  20282. return Result{error, proxy_res.status, std::move(proxy_res.headers)};
  20283. }
  20284. }
  20285. std::unique_ptr<Stream> strm;
  20286. auto stream_error = Error::SSLConnection;
  20287. int ssl_error = 0;
  20288. uint64_t ssl_backend_error = 0;
  20289. if (!create_stream(strm, stream_error, ssl_error, ssl_backend_error)) {
  20290. shutdown_and_close();
  20291. #ifdef CPPHTTPLIB_SSL_ENABLED
  20292. return Result{stream_error, -1, Headers{}, ssl_error, ssl_backend_error};
  20293. #else
  20294. return Result{stream_error, -1, Headers{}};
  20295. #endif
  20296. }
  20297. Request req;
  20298. req.method = "GET";
  20299. req.path = path_;
  20300. req.headers = headers_;
  20301. prepare_default_headers(req);
  20302. detail::WebSocketUpgradeResponse upgrade;
  20303. if (!detail::perform_websocket_handshake(*strm, req, upgrade)) {
  20304. shutdown_and_close();
  20305. return Result{upgrade.error, upgrade.status, std::move(upgrade.headers)};
  20306. }
  20307. subprotocol_ = std::move(upgrade.selected_subprotocol);
  20308. ws_ = std::unique_ptr<WebSocket>(new WebSocket(std::move(strm), req, false,
  20309. websocket_ping_interval_sec_,
  20310. websocket_max_missed_pongs_));
  20311. // The stream was created with the timeout already; tell the WebSocket
  20312. // whether it came from the caller, so read() knows to report it as Timeout.
  20313. ws_->read_timeout_set_ = read_timeout_set_;
  20314. return Result{Error::Success, upgrade.status, std::move(upgrade.headers)};
  20315. }
  20316. inline ReadResult WebSocketClient::read(std::string &msg) {
  20317. if (!ws_) { return Fail; }
  20318. return ws_->read(msg);
  20319. }
  20320. inline bool WebSocketClient::send(const std::string &data) {
  20321. if (!ws_) { return false; }
  20322. return ws_->send(data);
  20323. }
  20324. inline bool WebSocketClient::send(const char *data, size_t len) {
  20325. if (!ws_) { return false; }
  20326. return ws_->send(data, len);
  20327. }
  20328. inline void WebSocketClient::close(CloseStatus status,
  20329. const std::string &reason) {
  20330. if (ws_) { ws_->close(status, reason); }
  20331. }
  20332. inline bool WebSocketClient::is_open() const { return ws_ && ws_->is_open(); }
  20333. inline const std::string &WebSocketClient::subprotocol() const {
  20334. return subprotocol_;
  20335. }
  20336. inline void WebSocketClient::set_read_timeout(time_t sec, time_t usec) {
  20337. read_timeout_sec_ = sec;
  20338. read_timeout_usec_ = usec;
  20339. read_timeout_set_ = true;
  20340. // The members above only seed the next connect(); read() consults the
  20341. // stream, so an already-open connection has to be told directly.
  20342. if (ws_) { ws_->set_read_timeout(sec, usec); }
  20343. }
  20344. inline void WebSocketClient::set_write_timeout(time_t sec, time_t usec) {
  20345. write_timeout_sec_ = sec;
  20346. write_timeout_usec_ = usec;
  20347. }
  20348. inline void WebSocketClient::set_websocket_ping_interval(time_t sec) {
  20349. websocket_ping_interval_sec_ = sec;
  20350. }
  20351. inline void WebSocketClient::set_websocket_max_missed_pongs(int count) {
  20352. websocket_max_missed_pongs_ = count;
  20353. }
  20354. inline void WebSocketClient::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  20355. inline void WebSocketClient::set_address_family(int family) {
  20356. address_family_ = family;
  20357. }
  20358. inline void WebSocketClient::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  20359. inline void WebSocketClient::set_socket_options(SocketOptions socket_options) {
  20360. socket_options_ = std::move(socket_options);
  20361. }
  20362. inline void WebSocketClient::set_connection_timeout(time_t sec, time_t usec) {
  20363. connection_timeout_sec_ = sec;
  20364. connection_timeout_usec_ = usec;
  20365. }
  20366. inline void WebSocketClient::set_interface(const std::string &intf) {
  20367. interface_ = intf;
  20368. }
  20369. inline void WebSocketClient::set_hostname_addr_map(
  20370. std::map<std::string, std::string> addr_map) {
  20371. addr_map_ = std::move(addr_map);
  20372. }
  20373. inline bool WebSocketClient::is_proxy_enabled() const {
  20374. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  20375. if (no_proxy_entries_.empty()) { return true; }
  20376. return !detail::host_matches_no_proxy(detail::normalize_target(host_),
  20377. no_proxy_entries_);
  20378. }
  20379. inline bool WebSocketClient::create_and_connect_socket(Error &error) {
  20380. std::string connect_host;
  20381. std::string ip;
  20382. auto port = port_;
  20383. if (is_proxy_enabled()) {
  20384. connect_host = proxy_host_;
  20385. port = proxy_port_;
  20386. } else {
  20387. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  20388. }
  20389. sock_ = detail::create_client_socket(
  20390. connect_host, ip, port, address_family_, tcp_nodelay_, ipv6_v6only_,
  20391. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  20392. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  20393. write_timeout_usec_, interface_, error);
  20394. if (sock_ != INVALID_SOCKET) { return true; }
  20395. if (error == Error::Success) { error = Error::Connection; }
  20396. return false;
  20397. }
  20398. inline bool WebSocketClient::send_proxy_connect(Request &req,
  20399. Response &proxy_res,
  20400. Error &error) {
  20401. auto timeout = handshake_timeout();
  20402. detail::SocketStream strm(sock_, timeout.first, timeout.second,
  20403. write_timeout_sec_, write_timeout_usec_);
  20404. if (!detail::write_request_head(strm, req, error)) { return false; }
  20405. if (!detail::read_response_head(strm, proxy_res.status, proxy_res.headers)) {
  20406. error = Error::Read;
  20407. return false;
  20408. }
  20409. return true;
  20410. }
  20411. // RFC 6455 4.1: ws:// is tunnelled with CONNECT as well, since a proxy need not
  20412. // forward an Upgrade request.
  20413. inline bool WebSocketClient::connect_with_proxy(Response &proxy_res,
  20414. Error &error) {
  20415. Request req;
  20416. req.method = "CONNECT";
  20417. req.path = detail::make_host_and_port_string_always_port(host_, port_);
  20418. req.headers.emplace("Host", req.path);
  20419. detail::add_default_user_agent_header(req);
  20420. detail::add_authorization_header(req, proxy_basic_auth_username_,
  20421. proxy_basic_auth_password_,
  20422. proxy_bearer_token_auth_token_, true);
  20423. if (!send_proxy_connect(req, proxy_res, error)) { return false; }
  20424. #ifdef CPPHTTPLIB_SSL_ENABLED
  20425. // A Digest challenge gets one retry on a fresh connection, like SSLClient.
  20426. std::map<std::string, std::string> auth;
  20427. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407 &&
  20428. !proxy_digest_auth_username_.empty() &&
  20429. !proxy_digest_auth_password_.empty() &&
  20430. detail::parse_www_authenticate(proxy_res, auth, true)) {
  20431. proxy_res = Response();
  20432. shutdown_and_close();
  20433. if (!create_and_connect_socket(error)) { return false; }
  20434. req.headers.erase("Proxy-Authorization");
  20435. req.headers.insert(detail::make_digest_authentication_header(
  20436. req, req.path, auth, 1, detail::random_string(10),
  20437. proxy_digest_auth_username_, proxy_digest_auth_password_, true));
  20438. if (!send_proxy_connect(req, proxy_res, error)) { return false; }
  20439. }
  20440. #endif
  20441. if (proxy_res.status != StatusCode::OK_200) {
  20442. error = Error::ProxyConnection;
  20443. return false;
  20444. }
  20445. return true;
  20446. }
  20447. inline void WebSocketClient::set_proxy(const std::string &host, int port) {
  20448. proxy_host_ = host;
  20449. proxy_port_ = port;
  20450. }
  20451. inline void WebSocketClient::set_proxy_basic_auth(const std::string &username,
  20452. const std::string &password) {
  20453. proxy_basic_auth_username_ = username;
  20454. proxy_basic_auth_password_ = password;
  20455. }
  20456. inline void
  20457. WebSocketClient::set_proxy_bearer_token_auth(const std::string &token) {
  20458. proxy_bearer_token_auth_token_ = token;
  20459. }
  20460. inline void
  20461. WebSocketClient::set_no_proxy(const std::vector<std::string> &patterns) {
  20462. no_proxy_entries_ = detail::parse_no_proxy_entries(patterns);
  20463. }
  20464. #ifdef CPPHTTPLIB_SSL_ENABLED
  20465. inline void
  20466. WebSocketClient::set_ca_cert_path(const std::string &ca_cert_file_path,
  20467. const std::string &ca_cert_dir_path) {
  20468. ca_cert_file_path_ = ca_cert_file_path;
  20469. ca_cert_dir_path_ = ca_cert_dir_path;
  20470. }
  20471. inline void
  20472. WebSocketClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  20473. if (tls_ctx_) { tls::set_verify_callback(tls_ctx_, std::move(verifier)); }
  20474. }
  20475. inline void WebSocketClient::set_session_verifier(
  20476. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  20477. session_verifier_ = std::move(verifier);
  20478. }
  20479. inline void WebSocketClient::set_ca_cert_store(tls::ca_store_t store) {
  20480. if (store && tls_ctx_) {
  20481. // set_ca_store takes ownership of store
  20482. tls::set_ca_store(tls_ctx_, store);
  20483. custom_ca_loaded_ = true;
  20484. } else if (store) {
  20485. tls::free_ca_store(store);
  20486. }
  20487. }
  20488. inline void WebSocketClient::load_ca_cert_store(const char *ca_cert,
  20489. std::size_t size) {
  20490. if (tls_ctx_ && ca_cert && size > 0) {
  20491. tls::load_ca_pem(tls_ctx_, ca_cert, size);
  20492. custom_ca_loaded_ = true;
  20493. }
  20494. }
  20495. inline void
  20496. WebSocketClient::enable_server_certificate_verification(bool enabled) {
  20497. server_certificate_verification_ = enabled;
  20498. }
  20499. inline void WebSocketClient::enable_server_hostname_verification(bool enabled) {
  20500. server_hostname_verification_ = enabled;
  20501. }
  20502. inline void WebSocketClient::enable_system_ca(bool enabled) {
  20503. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  20504. }
  20505. inline void
  20506. WebSocketClient::set_proxy_digest_auth(const std::string &username,
  20507. const std::string &password) {
  20508. proxy_digest_auth_username_ = username;
  20509. proxy_digest_auth_password_ = password;
  20510. }
  20511. #endif // CPPHTTPLIB_SSL_ENABLED
  20512. } // namespace ws
  20513. // ----------------------------------------------------------------------------
  20514. } // namespace httplib
  20515. #endif // CPPHTTPLIB_HTTPLIB_H